org.apache.wicket.markup.transformer

Class AbstractOutputTransformerContainer

java.lang.Object

org.apache.wicket.Component

org.apache.wicket.MarkupContainer

org.apache.wicket.markup.transformer.AbstractOutputTransformerContainer

All Implemented Interfaces:

Serializable, Iterable<Component>, IEventSink, IEventSource, IConverterLocator, IHeaderContributor, ITransformer, IRequestableComponent, IHierarchical<Component>, IClusterable

Direct Known Subclasses:

NoopOutputTransformerContainer, XsltOutputTransformerContainer

public abstract class AbstractOutputTransformerContainer
extends MarkupContainer
implements ITransformer

This abstract container provides the means to post-process the markup generated by its child components (excluding the containers tag)

Please see AbstractTransformerBehavior for an alternative based on Behavior

Author:

Juergen Donnerstag

See Also:

AbstractTransformerBehavior, ITransformer, Serialized Form

Field Summary

Fields inherited from class org.apache.wicket.Component

ENABLE, FLAG_AFTER_RENDERING, FLAG_INITIALIZED, FLAG_PREPARED_FOR_RENDER, FLAG_REMOVING_FROM_HIERARCHY, FLAG_RENDERING, FLAG_RESERVED1, FLAG_RESERVED2, FLAG_RESERVED3, FLAG_RESERVED4, FLAG_RESERVED5, FLAG_RESERVED8, PARENT_PATH, PATH_SEPARATOR, RENDER, RFLAG_CONTAINER_DEQUEING

Constructor Summary

Constructors

Constructor and Description
AbstractOutputTransformerContainer(String id) Construct
AbstractOutputTransformerContainer(String id, IModel<?> model) Construct

Method Summary

Methods

Modifier and Type	Method and Description
protected Response	newResponse() Create a new response object which is used to store the markup generated by the child objects.
void	onComponentTagBody(MarkupStream markupStream, ComponentTag openTag) Handle the container's body.
protected void	onRender() Implementation that renders this component.
MarkupContainer	setTransformBodyOnly(boolean value) You can choose whether the body of the tag excluding the tag shall be transformed or including the tag.
abstract CharSequence	transform(Component component, CharSequence output) Will be invoked after all child components have been processed to allow for transforming the markup generated.

Methods inherited from class org.apache.wicket.MarkupContainer

add, addDequeuedComponent, addOrReplace, autoAdd, canDequeueTag, contains, dequeue, dequeue, dequeuePreamble, findComponentToDequeue, get, get, getAssociatedMarkup, getAssociatedMarkupStream, getMarkup, getMarkupType, getRegionMarkup, internalAdd, internalInitialize, iterator, iterator, newDequeueContext, onAfterRenderChildren, onDetach, queue, remove, remove, removeAll, renderAll, renderAssociatedMarkup, renderNext, replace, setDefaultModel, size, swap, toString, toString, visitChildren, visitChildren, visitChildren, visitChildren

Methods inherited from class org.apache.wicket.Component

add, addStateChange, afterRender, beforeRender, canCallListenerInterface, canCallListenerInterfaceAfterExpiry, checkComponentTag, checkComponentTagAttribute, checkHierarchyChange, clearOriginalDestination, configure, continueToOriginalDestination, createConverter, debug, detach, detachModel, detachModels, determineVisibility, error, exceptionMessage, fatal, findMarkupStream, findPage, findParent, findParentWithAssociatedMarkup, 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, 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, internalOnModelChanged, internalPrepareForRender, internalRenderComponent, internalRenderHead, isActionAuthorized, isAuto, isBehaviorAccepted, isEnableAllowed, isEnabled, isEnabledInHierarchy, isIgnoreAttributeModifier, isRenderAllowed, isRendering, isStateless, isVersioned, isVisibilityAllowed, isVisible, isVisibleInHierarchy, markRendering, modelChanged, modelChanging, newMarkupSourcingStrategy, onAfterRender, onBeforeRender, onComponentTag, onConfigure, onEvent, onInitialize, onModelChanged, onModelChanging, onReAdd, onRemove, prepareForRender, redirectToInterceptPage, remove, remove, render, renderComponentTag, rendered, renderHead, renderHead, renderPlaceholderTag, replaceComponentTagBody, replaceWith, sameInnermostModel, sameInnermostModel, send, setAuto, setDefaultModelObject, setEnabled, setEscapeModelStrings, setFlag, setIgnoreAttributeModifier, setMarkup, setMarkupId, setMarkupIdImpl, setMetaData, setOutputMarkupId, setOutputMarkupPlaceholderTag, setParent, setRenderBodyOnly, setRequestFlag, setResponsePage, setResponsePage, setResponsePage, setVersioned, setVisibilityAllowed, setVisible, success, urlFor, urlFor, urlFor, urlFor, urlFor, visitParents, visitParents, warn, wrap

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractOutputTransformerContainer

public AbstractOutputTransformerContainer(String id)

Construct

See Also:

Component.Component(String)

AbstractOutputTransformerContainer

public AbstractOutputTransformerContainer(String id,
                                  IModel<?> model)

Construct

See Also:

Component.Component(String, IModel)

Method Detail

setTransformBodyOnly

public MarkupContainer setTransformBodyOnly(boolean value)

You can choose whether the body of the tag excluding the tag shall be transformed or including the tag.

Parameters:

value - If true, only the body is applied to transformation.

Returns:

this

newResponse

protected Response newResponse()

Create a new response object which is used to store the markup generated by the child objects.

Returns:

Response object. Must not be null

transform

public abstract CharSequence transform(Component component,
                     CharSequence output)
                                throws Exception

Description copied from interface: ITransformer

Will be invoked after all child components have been processed to allow for transforming the markup generated.

Specified by:

transform in interface ITransformer

Parameters:

component - The associated Wicket component

output - The markup generated by the child components

Returns:

The output which will be appended to the original response

Throws:

Exception

onComponentTagBody

public final void onComponentTagBody(MarkupStream markupStream,
                      ComponentTag openTag)

Description copied from class: MarkupContainer

Handle the container's body. If your override of this method does not advance the markup stream to the close tag for the openTag, a runtime exception will be thrown by the framework.

Overrides:

onComponentTagBody in class MarkupContainer

Parameters:

markupStream - The markup stream

openTag - The open tag for the body

onRender

protected final void onRender()

Description copied from class: Component

Implementation that renders this component.

Overrides:

onRender in class MarkupContainer

See Also:

Component.onRender()