Package lumis.portal.presentation.core
Class HTMLFragmentComponent
- java.lang.Object
-
- org.apache.wicket.Component
-
- org.apache.wicket.markup.html.WebComponent
-
- lumis.portal.presentation.core.HTMLFragmentComponent
-
- All Implemented Interfaces:
Serializable
,org.apache.wicket.event.IEventSink
,org.apache.wicket.event.IEventSource
,org.apache.wicket.feedback.IFeedbackContributor
,org.apache.wicket.IConverterLocator
,org.apache.wicket.IMetadataContext<Serializable,org.apache.wicket.Component>
,org.apache.wicket.markup.html.IHeaderContributor
,org.apache.wicket.request.component.IRequestableComponent
,org.apache.wicket.util.IHierarchical<org.apache.wicket.Component>
,org.apache.wicket.util.io.IClusterable
- Direct Known Subclasses:
AbstractPageBodyMiddleComponent
,AbstractSubHeader
,EmptySubHeader
,HolderIdComponent
,OutComponent
,PageBodyFooterComponent
,PageBodyHeaderComponent
,PageHeadScriptsComponent
,PageLinksComponent
,PageMetaTagsComponent
,PageTitleComponent
,PortalAdministrationFooterComponent
,PortalAdministrationHeaderComponent
,PortalSettingsNavigationComponent
,PublisherFancyBoxScriptInjectorComponent
,PublisherLumItemIdInjectorComponent
,RenderPortalSettingsWorkPaneHeaderComponent
,RenderWorkPaneHeaderComponent
public abstract class HTMLFragmentComponent extends org.apache.wicket.markup.html.WebComponent
An abstract component to be used as a base for rendering a HTML fragment.The method
getHTMLFragment(MarkupStream, ComponentTag)
must be implemented returning the HTML fragment to be used.This class has better performance than a
Label
, because it doesn't have models and converters overhead. And ifgetHTMLFragment(MarkupStream, ComponentTag)
returns aAppendingStringBuffer
, it will prevent the call toObject.toString()
, and the allocation of another string of the length of the HTML fragment.- Since:
- 6.0.0
- Version:
- $Revision: 24950 $ $Date: 2022-04-14 13:57:29 -0300 (Thu, 14 Apr 2022) $
- See Also:
- Serialized Form
-
-
Constructor Summary
Constructors Constructor Description HTMLFragmentComponent(String id)
HTMLFragmentComponent(String id, boolean autoRenderBodyOnly)
Creates a new HTMLFragmentComponent.
-
Method Summary
All Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description protected abstract CharSequence
getHTMLFragment(org.apache.wicket.markup.MarkupStream markupStream, org.apache.wicket.markup.ComponentTag openTag)
Returns the HTML code fragment to be output by this component.protected void
onComponentTag(org.apache.wicket.markup.ComponentTag tag)
void
onComponentTagBody(org.apache.wicket.markup.MarkupStream markupStream, org.apache.wicket.markup.ComponentTag openTag)
-
Methods inherited from class org.apache.wicket.markup.html.WebComponent
getWebApplication, getWebPage, getWebRequest, getWebResponse, getWebSession, onRender
-
Methods inherited from class org.apache.wicket.Component
add, addStateChange, beforeRender, canCallListener, canCallListenerAfterExpiry, checkComponentTag, checkComponentTagAttribute, checkHierarchyChange, clearOriginalDestination, configure, continueToOriginalDestination, createConverter, debug, detach, detachModel, detachModels, determineVisibility, error, exceptionMessage, fatal, findMarkupStream, findPage, findParent, findParentWithAssociatedMarkup, get, getAjaxRegionMarkupId, getApplication, getBehaviorById, getBehaviorId, getBehaviors, getBehaviors, getClassRelativePath, getConverter, getDefaultModel, getDefaultModelObject, getDefaultModelObjectAsString, getDefaultModelObjectAsString, getEscapeModelStrings, getFeedbackMessages, getFlag, getId, getInnermostModel, getInnermostModel, getLocale, getLocalizer, getMarkup, getMarkupAttributes, getMarkupId, getMarkupId, getMarkupIdFromMarkup, getMarkupIdImpl, getMarkupSourcingStrategy, getMarkupTag, getMetaData, getModelComparator, getOutputMarkupId, getOutputMarkupPlaceholderTag, getPage, getPageRelativePath, getParent, getPath, getRenderBodyOnly, getRequest, getRequestCycle, getRequestFlag, getResponse, getSession, getSizeInBytes, getStatelessHint, getString, getString, getString, getStyle, getVariation, hasBeenRendered, hasErrorMessage, hasFeedbackMessage, info, initModel, internalInitialize, internalOnModelChanged, internalRenderComponent, internalRenderHead, isActionAuthorized, isAuto, isBehaviorAccepted, isEnableAllowed, isEnabled, isEnabledInHierarchy, isIgnoreAttributeModifier, isInitialized, isRenderAllowed, isRendering, isStateless, isVersioned, isVisibilityAllowed, isVisible, isVisibleInHierarchy, markRendering, modelChanged, modelChanging, newMarkupSourcingStrategy, onAfterRender, onBeforeRender, onConfigure, onDetach, onEvent, onInitialize, onModelChanged, onModelChanging, onReAdd, onRemove, redirectToInterceptPage, remove, remove, render, renderComponentTag, rendered, renderHead, renderPart, renderPlaceholderTag, replaceComponentTagBody, replaceWith, sameInnermostModel, sameInnermostModel, send, setAuto, setDefaultModel, setDefaultModelObject, setEnabled, setEscapeModelStrings, setFlag, setIgnoreAttributeModifier, setMarkup, setMarkupId, setMarkupIdImpl, setMetaData, setOutputMarkupId, setOutputMarkupPlaceholderTag, setParent, setRenderBodyOnly, setResponsePage, setResponsePage, setResponsePage, setVersioned, setVisibilityAllowed, setVisible, success, toString, toString, urlFor, urlFor, urlFor, urlForListener, urlForListener, visitParents, visitParents, warn, wrap
-
-
-
-
Constructor Detail
-
HTMLFragmentComponent
public HTMLFragmentComponent(String id)
-
HTMLFragmentComponent
public HTMLFragmentComponent(String id, boolean autoRenderBodyOnly)
Creates a new HTMLFragmentComponent.- Parameters:
id
- the component identifier.autoRenderBodyOnly
- ifComponent.setRenderBodyOnly(boolean)
should automatically be set in case of layout file tags are to be stripped.- Since:
- 6.0.0
-
-
Method Detail
-
onComponentTag
protected void onComponentTag(org.apache.wicket.markup.ComponentTag tag)
- Overrides:
onComponentTag
in classorg.apache.wicket.Component
-
onComponentTagBody
public void onComponentTagBody(org.apache.wicket.markup.MarkupStream markupStream, org.apache.wicket.markup.ComponentTag openTag)
- Overrides:
onComponentTagBody
in classorg.apache.wicket.Component
-
getHTMLFragment
protected abstract CharSequence getHTMLFragment(org.apache.wicket.markup.MarkupStream markupStream, org.apache.wicket.markup.ComponentTag openTag)
Returns the HTML code fragment to be output by this component. Called duringonComponentTagBody(MarkupStream, ComponentTag)
.A return type of
AppendingStringBuffer
prevents the allocation of another HTML fragment string instance.- Parameters:
markupStream
- the markup stream.openTag
- the open tag for the body.- Returns:
- the HTML code fragment. A
null
return value will leave the body empty. - Since:
- 6.0.0
-
-