Package org.apache.wicket.markup.parser.filter

Class RelativePathPrefixHandler

java.lang.Object

org.apache.wicket.markup.parser.AbstractMarkupFilter

org.apache.wicket.markup.parser.filter.RelativePathPrefixHandler

All Implemented Interfaces:

Serializable, IMarkupFilter, IComponentResolver, IClusterable

public final class RelativePathPrefixHandler
extends AbstractMarkupFilter
implements IComponentResolver

The purpose of this filter is to make all "href", "src" and "background" attributes found in the markup which contain a relative URL like "myDir/myPage.gif" actually resolve in the output HTML, by prefixing them with with an appropriate path to make the link work properly, even if the current page is being displayed at a mounted URL or whatever. It is applied to all non wicket component tags, except for auto-linked tags. It achieves this by being both an IMarkupFilter and IComponentResolver, and works similarly to the <wicket:message> code. For each tag, we look to see if the path in "href", "src" and "background" attributes is relative. If it is, we assume it's relative to the context path and we should prefix it appropriately so that it resolves correctly for the current request, even if that's for something that's not at the context root. This is done for ServletWebRequests by prepending with "../" tokens, for example.

Author:

Al Maw

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static Behavior	RELATIVE_PATH_BEHAVIOR	Behavior that adds a prefix to src, href and background attributes to make them context-relative
static String	WICKET_RELATIVE_PATH_PREFIX_CONTAINER_ID	The id automatically assigned to tags without an id which we need to prepend a relative path to.

Fields inherited from class org.apache.wicket.markup.parser.AbstractMarkupFilter

REQUEST_COUNTER_KEY

Constructor Summary

Constructors

Constructor	Description
RelativePathPrefixHandler()	Constructor for the IComponentResolver role.
RelativePathPrefixHandler(MarkupResourceStream markup)	Constructor for the IMarkupFilter role

Method Summary

Modifier and Type	Method	Description
protected MarkupElement	onComponentTag(ComponentTag tag)	Invoked when a ComponentTag was found.
void	postProcess(Markup markup)	Called after all filters have been processed.
Component	resolve(MarkupContainer container, MarkupStream markupStream, ComponentTag tag)	Try to resolve a component.

Methods inherited from class org.apache.wicket.markup.parser.AbstractMarkupFilter

getMarkupResourceStream, getNextFilter, getRequestUniqueId, getWicketNamespace, getWicketNamespace, nextElement, onSpecialTag, setNextFilter

Methods inherited from class java.lang.Object

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

Field Detail

WICKET_RELATIVE_PATH_PREFIX_CONTAINER_ID

public static final String WICKET_RELATIVE_PATH_PREFIX_CONTAINER_ID

The id automatically assigned to tags without an id which we need to prepend a relative path to.

See Also:

Constant Field Values

RELATIVE_PATH_BEHAVIOR

public static final Behavior RELATIVE_PATH_BEHAVIOR

Behavior that adds a prefix to src, href and background attributes to make them context-relative

Constructor Detail

RelativePathPrefixHandler

public RelativePathPrefixHandler()

Constructor for the IComponentResolver role.

RelativePathPrefixHandler

public RelativePathPrefixHandler(MarkupResourceStream markup)

Constructor for the IMarkupFilter role

Parameters:

markup - The markup created by reading the markup file

Method Detail

onComponentTag

protected final MarkupElement onComponentTag(ComponentTag tag)
                                      throws ParseException

Description copied from class: AbstractMarkupFilter

Invoked when a ComponentTag was found.

By default this method is also called for WicketTags.

Specified by:

onComponentTag in class AbstractMarkupFilter

Returns:

Usually the same as the tag attribute

Throws:

ParseException

resolve

public Component resolve(MarkupContainer container,
                         MarkupStream markupStream,
                         ComponentTag tag)

Description copied from interface: IComponentResolver

Try to resolve a component.

Specified by:

resolve in interface IComponentResolver

Parameters:

container - The container parsing its markup

markupStream - The current markupStream

tag - The current component tag while parsing the markup

Returns:

component or null if not found

postProcess

public void postProcess(Markup markup)

Description copied from interface: IMarkupFilter

Called after all filters have been processed.

Specified by:

postProcess in interface IMarkupFilter

Overrides:

postProcess in class AbstractMarkupFilter