wicket.markup.transformer
Class XsltOutputTransformerContainer

java.lang.Object
  wicket.Component
      wicket.MarkupContainer
          wicket.markup.transformer.AbstractOutputTransformerContainer
              wicket.markup.transformer.XsltOutputTransformerContainer

All Implemented Interfaces:

java.io.Serializable, ITransformer

public class XsltOutputTransformerContainer
extends AbstractOutputTransformerContainer

A container which output markup will be processes by a XSLT processor prior to writing the output into the web response. The *.xsl resource must be located in the same path as the nearest parent with an associated markup and must have a filename equal to the component's id.

The containers tag will be the root element of the xml data applied for transformation to ensure the xml data are well formed (single root element). In addition the attribute xmlns:wicket="http://wicket.sourceforge.net" is added to the root element to allow the XSL processor to handle the wicket namespace.

Similar to this container, a IBehavior is available which does the same, but does not require an additional Container.

Author:

Juergen Donnerstag

See Also:

XsltTransfomerBehavior, Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class wicket.Component

Component.ComponentModelChange, Component.EnabledChange, Component.IVisitor, Component.VisibilityChange

Field Summary

Fields inherited from class wicket.Component

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

Constructor Summary

XsltOutputTransformerContainer(java.lang.String id)
Construct

XsltOutputTransformerContainer(java.lang.String id, IModel model)
Construct

XsltOutputTransformerContainer(java.lang.String id, IModel model, java.lang.String xslFilePath)
Instead of using the default mechanism to determine the associated XSL file, it is given by the user.

Method Summary

java.lang.String	getMarkupType() Get the type of associated markup for this component.
java.lang.CharSequence	transform(Component component, java.lang.String output) Will be invoked after all child components have been processed to allow for transforming the markup generated.

Methods inherited from class wicket.markup.transformer.AbstractOutputTransformerContainer

newResponse, onComponentTagBody, onRender, setTransformBodyOnly

Methods inherited from class wicket.MarkupContainer

add, autoAdd, contains, findMarkupStream, get, getAssociatedMarkupStream, getMarkupStream, internalAdd, internalAttach, internalDetach, isTransparentResolver, iterator, iterator, newMarkupResourceStream, remove, remove, removeAll, renderAll, renderAssociatedMarkup, renderComponentTagBody, replace, setMarkupStream, setModel, size, toString, toString, visitChildren, visitChildren

Methods inherited from class wicket.Component

add, addStateChange, checkComponentTag, checkComponentTagAttribute, continueToOriginalDestination, debug, detachBehaviors, detachModel, detachModels, error, exceptionMessage, fatal, findPage, findParent, findParentWithAssociatedMarkup, getApplication, getApplicationPages, getApplicationSettings, getBehaviors, getBehaviors, getClassRelativePath, getConverter, getEscapeModelStrings, getFeedbackMessage, getFlag, getFlag, getId, getLocale, getLocalizer, getMarkupAttributes, getMarkupId, getMetaData, getModel, getModelComparator, getModelObject, getModelObjectAsString, getOutputMarkupId, getPage, getPageFactory, getPageRelativePath, getParent, getPath, getRenderBodyOnly, getRequest, getRequestCycle, getResponse, getSession, getSizeInBytes, getString, getString, getString, getStyle, getVariation, hasErrorMessage, hasFeedbackMessage, info, initModel, internalOnAttach, internalOnDetach, internalOnModelChanged, isActionAuthorized, isAncestorOf, isBehaviorAccepted, isEnableAllowed, isEnabled, isHeadRendered, isIgnoreAttributeModifier, isRenderAllowed, isVersioned, isVisible, isVisibleInHierarchy, modelChanged, modelChanging, newPage, newPage, onAfterRender, onAttach, onBeforeRender, onBeginRequest, onComponentTag, onDetach, onEndRequest, onModelChanged, onModelChanging, onRender, redirectToInterceptPage, remove, render, render, renderComponent, renderComponent, renderComponentTag, rendered, renderedBehaviors, renderHead, replaceComponentTagBody, replaceWith, resetHeadRendered, sameRootModel, sameRootModel, setAuto, setEnabled, setEscapeModelStrings, setFlag, setFlag, setIgnoreAttributeModifier, setMetaData, setModelObject, setOutputMarkupId, setRedirect, setRenderBodyOnly, setResponsePage, setResponsePage, setResponsePage, setVersioned, setVisible, urlFor, urlFor, urlFor, urlFor, urlFor, visitParents, warn

Methods inherited from class java.lang.Object

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

Constructor Detail

XsltOutputTransformerContainer

public XsltOutputTransformerContainer(java.lang.String id,
                                      IModel model,
                                      java.lang.String xslFilePath)

Instead of using the default mechanism to determine the associated XSL file, it is given by the user.

Parameters:

xslFilePath - XSL input file path

See Also:

Component.Component(String, IModel)

XsltOutputTransformerContainer

public XsltOutputTransformerContainer(java.lang.String id,
                                      IModel model)

Construct

See Also:

Component.Component(String, IModel)

XsltOutputTransformerContainer

public XsltOutputTransformerContainer(java.lang.String id)

Construct

See Also:

Component.Component(String)

Method Detail

getMarkupType

public java.lang.String getMarkupType()

Description copied from class: MarkupContainer

Get the type of associated markup for this component.

Overrides:

getMarkupType in class MarkupContainer

Returns:

The type of associated markup for this component (for example, "html", "wml" or "vxml"). The markup type for a component is independent of whether or not the component actually has an associated markup resource file (which is determined at runtime). If there is no markup type for a component, null may be returned, but this means that no markup can be loaded for the class.

See Also:

MarkupContainer.getMarkupType()

transform

public java.lang.CharSequence transform(Component component,
                                        java.lang.String output)
                                 throws java.lang.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

Specified by:

transform in class AbstractOutputTransformerContainer

Parameters:

component - The associated Wicket component

output - The markup generated by the child components

Returns:

The output which will be appended to the orginal response

Throws:

java.lang.Exception

See Also:

ITransformer.transform(wicket.Component, java.lang.String)