org.apache.wicket.markup.parser
Interface IMarkupFilter

All Known Implementing Classes:

AbstractMarkupFilter, AutoLabelTagHandler, ConditionalCommentFilter, EnclosureHandler, HeadForceTagIdHandler, HtmlHandler, HtmlHeaderSectionHandler, HtmlProblemFinder, InlineEnclosureHandler, OpenCloseTagExpander, RelativePathPrefixHandler, RootMarkupFilter, StyleAndScriptIdentifier, WicketLinkTagHandler, WicketMessageTagHandler, WicketNamespaceHandler, WicketRemoveTagHandler, WicketTagIdentifier

public interface IMarkupFilter

Wicket uses a streaming XML parser to read the markup. A chain of IMarkupFilters is used e.g. to remove comments, allow for html typical markup (some tags don't need to be closed explicitly), etc.

Author:

Juergen Donnerstag

See Also:

MarkupParser, MarkupFactory

Method Summary

IMarkupFilter	getNextFilter() IMarkupFilters are usually chained with the last filter retrieving the elements from the XML parser.
MarkupElement	nextElement() Get the next MarkupElement from the parent MarkupFilter and handle it if the specific filter criteria are met.
void	postProcess(Markup markup) Called after all filters have been processed.
void	setNextFilter(IMarkupFilter parent) Set parent filter.

Method Detail

getNextFilter

IMarkupFilter getNextFilter()

IMarkupFilters are usually chained with the last filter retrieving the elements from the XML parser.

Returns:

The next filter in the chain, or null if the last one.

setNextFilter

void setNextFilter(IMarkupFilter parent)

Set parent filter.

Parameters:

parent - The next element in the chain

nextElement

MarkupElement nextElement()
                          throws java.text.ParseException

Get the next MarkupElement from the parent MarkupFilter and handle it if the specific filter criteria are met. Depending on the filter, it may return the MarkupElement unchanged, modified or remove it by asking the parent handler for the next tag.

Returns:

Return the next eligible MarkupElement. Null, if no more found.

Throws:

java.text.ParseException

postProcess

void postProcess(Markup markup)

Called after all filters have been processed.

Parameters:

markup -