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.IClusterable, org.apache.wicket.IConverterLocator

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 if getHTMLFragment(MarkupStream, ComponentTag) returns a AppendingStringBuffer, it will prevent the call to Object.toString(), and the allocation of another string of the length of the HTML fragment.

Since:

6.0.0

Version:

$Revision: 13093 $ $Date: 2011-05-28 21:40:18 +0000 (Sat, 28 May 2011) $

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.wicket.Component

org.apache.wicket.Component.ComponentModelChange, org.apache.wicket.Component.EnabledChange, org.apache.wicket.Component.IVisitor<T extends org.apache.wicket.Component>, org.apache.wicket.Component.VisibilityChange

Field Summary

Fields inherited from class org.apache.wicket.Component

ENABLE, FLAG_REMOVING_FROM_HIERARCHY, FLAG_RESERVED1, FLAG_RESERVED2, FLAG_RESERVED3, FLAG_RESERVED4, FLAG_RESERVED5, FLAG_RESERVED6, FLAG_RESERVED7, FLAG_RESERVED8, PATH_SEPARATOR, RENDER

Constructor Summary

Constructors

Constructor and Description
HTMLFragmentComponent(String id)
HTMLFragmentComponent(String id, boolean autoRenderBodyOnly) Creates a new HTMLFragmentComponent.

Method Summary

Modifier and Type	Method and 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)
protected void	onComponentTagBody(org.apache.wicket.markup.MarkupStream markupStream, org.apache.wicket.markup.ComponentTag openTag)

Methods inherited from class org.apache.wicket.markup.html.WebComponent

onRender

Methods inherited from class org.apache.wicket.Component

add, addStateChange, afterRender, beforeRender, callOnBeforeRenderIfNotVisible, checkComponentTag, checkComponentTagAttribute, checkHierarchyChange, continueToOriginalDestination, debug, detach, detachBehaviors, detachModel, detachModels, determineVisibility, error, exceptionMessage, fatal, findMarkupStream, findPage, findParent, findParentWithAssociatedMarkup, getApplication, getBehaviors, getBehaviors, getBehaviorsRawList, getClassRelativePath, getComponentBorder, getConverter, getConverter, getDefaultModel, getDefaultModelObject, getDefaultModelObjectAsString, getDefaultModelObjectAsString, getEscapeModelStrings, getFeedbackMessage, getFlag, getFlag, getId, getInnermostModel, getInnermostModel, getLocale, getLocalizer, getMarkupAttributes, getMarkupId, getMarkupId, getMarkupIdImpl, getMetaData, getModelComparator, getOutputMarkupId, getOutputMarkupPlaceholderTag, getPage, getPageRelativePath, getParent, getPath, getRenderBodyOnly, getRequest, getRequestCycle, getResponse, getSession, getSizeInBytes, getStatelessHint, getString, getString, getString, getStyle, getVariation, hasBeenRendered, hasErrorMessage, hasFeedbackMessage, info, initModel, internalAttach, internalDetach, internalOnAttach, internalOnDetach, internalOnModelChanged, isActionAuthorized, isAncestorOf, isAttached, isBehaviorAccepted, isEnableAllowed, isEnabled, isEnabledInHierarchy, isIgnoreAttributeModifier, isRenderAllowed, isStateless, isVersioned, isVisibilityAllowed, isVisible, isVisibleInHierarchy, locateMarkupStream, markAttached, markRendering, modelChanged, modelChanging, onAfterRender, onAttach, onBeforeRender, onBeginRequest, onDetach, onEndRequest, onModelChanged, onModelChanging, onRemove, prepareForRender, prepareForRender, redirectToInterceptPage, remove, remove, render, render, renderComponent, renderComponent, renderComponentTag, rendered, renderHead, renderPlaceholderTag, replaceComponentTagBody, replaceWith, sameInnermostModel, sameInnermostModel, setAuto, setComponentBorder, setDefaultModel, setDefaultModelObject, setEnabled, setEscapeModelStrings, setFlag, setFlag, setIgnoreAttributeModifier, setMarkupId, setMarkupIdImpl, setMarkupStream, setMetaData, setOutputMarkupId, setOutputMarkupPlaceholderTag, setRedirect, setRenderBodyOnly, setResponsePage, setResponsePage, setResponsePage, setVersioned, setVisibilityAllowed, setVisible, toString, toString, urlFor, urlFor, urlFor, urlFor, urlFor, urlFor, visitParents, warn, wrap

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

HTMLFragmentComponent

public HTMLFragmentComponent(String id)

HTMLFragmentComponent

public HTMLFragmentComponent(String id,
                             boolean autoRenderBodyOnly)

Creates a new HTMLFragmentComponent.

Parameters:

id - the component identifier.

autoRenderBodyOnly - if Component.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 class org.apache.wicket.Component

onComponentTagBody

protected void onComponentTagBody(org.apache.wicket.markup.MarkupStream markupStream,
                                  org.apache.wicket.markup.ComponentTag openTag)

Overrides:

onComponentTagBody in class org.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 during onComponentTagBody(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