Class XsltTransformerBehavior

  extended by org.apache.wicket.behavior.AbstractBehavior
      extended by org.apache.wicket.markup.transformer.AbstractTransformerBehavior
          extended by org.apache.wicket.markup.transformer.XsltTransformerBehavior
All Implemented Interfaces:
Serializable, IBehavior, IComponentConfigurationBehavior, IClusterable, IHeaderContributor, ITransformer

public class XsltTransformerBehavior
extends AbstractTransformerBehavior

An IBehavior which can be added to any component except ListView. It allows to post-process (XSLT) the markup generated by the component. 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=" is added to the root element to allow the XSL processor to handle the wicket namespace.

The reason why the transformer can not be used to XSLT the ListViews output is because of the ListViews markup being reused for each ListItem. Please use a XsltOutputTransformerContainer instead. Note: if the ListView is used to print a list of <tr> tags, than the transformer container must enclose the <table> tag as well to be HTML compliant.

Juergen Donnerstag
See Also:
AbstractOutputTransformerContainer, XsltOutputTransformerContainer, Serialized Form

Constructor Summary
XsltTransformerBehavior(String xslFilePath)
Method Summary
 void bind(Component component)
          Bind this handler to the given component.
 void onComponentTag(Component component, ComponentTag tag)
          Called any time a component that has this behavior registered is rendering the component tag.
 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.markup.transformer.AbstractTransformerBehavior
beforeRender, cleanup, newResponse, onException, onRendered
Methods inherited from class org.apache.wicket.behavior.AbstractBehavior
afterRender, detach, detachModel, exception, getStatelessHint, isEnabled, isTemporary, onConfigure, rendered, renderHead
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail


public XsltTransformerBehavior()


public XsltTransformerBehavior(String xslFilePath)
xslFilePath -
See Also:
Method Detail


public void onComponentTag(Component component,
                           ComponentTag tag)
Description copied from interface: IBehavior
Called any time a component that has this behavior registered is rendering the component tag.

Specified by:
onComponentTag in interface IBehavior
onComponentTag in class AbstractTransformerBehavior
component - the component that renders this tag currently
tag - the tag that is rendered
See Also:
IBehavior.onComponentTag(org.apache.wicket.Component, org.apache.wicket.markup.ComponentTag)


public 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
Specified by:
transform in class AbstractTransformerBehavior
component - The associated Wicket component
output - The markup generated by the child components
The output which will be appended to the original response
See Also:
ITransformer.transform(org.apache.wicket.Component, CharSequence)


public void bind(Component component)
Description copied from interface: IBehavior
Bind this handler to the given component. This method is called by the host component immediately after this behavior is added to it. This method is useful if you need to do initialization based on the component it is attached and you can't wait to do it at render time. Keep in mind that if you decide to keep a reference to the host component, it is not thread safe anymore, and should thus only be used in situations where you do not reuse the behavior for multiple components.

Specified by:
bind in interface IBehavior
bind in class AbstractBehavior
component - the component to bind to
See Also:

Copyright © 2004-2011 Apache Software Foundation. All Rights Reserved.