org.apache.wicket.markup
Class MarkupParser

java.lang.Object
  org.apache.wicket.markup.AbstractMarkupParser
      org.apache.wicket.markup.MarkupParser

public class MarkupParser
extends AbstractMarkupParser

This is Wicket's default markup parser. It gets pre-configured with Wicket's default wicket filters.

Author:

Juergen Donnerstag

See Also:

MarkupFactory

Nested Class Summary

class

MarkupParser.MarkupFilterList A simple extension to ArrayList to manage Wicket MarkupFilter's more easily

Field Summary

static java.lang.String

WICKET "wicket"

Fields inherited from class org.apache.wicket.markup.AbstractMarkupParser

CONDITIONAL_COMMENT_OPENING

Constructor Summary

MarkupParser(IXmlPullParser xmlParser, MarkupResourceStream resource)
Constructor.

MarkupParser(MarkupResourceStream resource)
Constructor.

MarkupParser(java.lang.String markup)
Constructor.

Method Summary

boolean	add(IMarkupFilter filter) Add a markup filter
boolean	add(IMarkupFilter filter, java.lang.Class<? extends IMarkupFilter> beforeFilter) Add a markup filter before the 'beforeFilter'
MarkupParser.MarkupFilterList	getMarkupFilters()
protected MarkupParser.MarkupFilterList	initializeMarkupFilters(Markup markup) Initialize Wicket's MarkupParser with all necessary markup filters.
protected IMarkupFilter	onAppendMarkupFilter(IMarkupFilter filter) a) Allow subclasses to configure individual Wicket filters

Methods inherited from class org.apache.wicket.markup.AbstractMarkupParser

compressWhitespace, getMarkupResourceStream, handleRawText, parse, postProcess, setWicketNamespace, toString

Methods inherited from class java.lang.Object

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

Field Detail

WICKET

public static final java.lang.String WICKET

"wicket"

See Also:

Constant Field Values

Constructor Detail

MarkupParser

public MarkupParser(MarkupResourceStream resource)

Constructor.

Parameters:

resource - The markup resource (file)

MarkupParser

public MarkupParser(java.lang.String markup)

Constructor. Usually for testing purposes only

Parameters:

markup - The markup resource.

MarkupParser

public MarkupParser(IXmlPullParser xmlParser,
                    MarkupResourceStream resource)

Constructor.

Parameters:

xmlParser - The streaming xml parser to read and parse the markup

resource - The markup resource (file)

Method Detail

getMarkupFilters

public MarkupParser.MarkupFilterList getMarkupFilters()

Overrides:

getMarkupFilters in class AbstractMarkupParser

Returns:

Gets the list of markup filters

add

public final boolean add(IMarkupFilter filter)

Add a markup filter

Parameters:

filter -

Returns:

true, if successful

add

public final boolean add(IMarkupFilter filter,
                         java.lang.Class<? extends IMarkupFilter> beforeFilter)

Add a markup filter before the 'beforeFilter'

Parameters:

filter -

beforeFilter -

Returns:

true, if successful

onAppendMarkupFilter

protected IMarkupFilter onAppendMarkupFilter(IMarkupFilter filter)

a) Allow subclasses to configure individual Wicket filters

b) Allows to disable Wicket filters via returning false

Parameters:

filter -

Returns:

The filter to be added. Null to ignore.

initializeMarkupFilters

protected MarkupParser.MarkupFilterList initializeMarkupFilters(Markup markup)

Initialize Wicket's MarkupParser with all necessary markup filters. You may subclass this method, to add your own filters to the list.

Specified by:

initializeMarkupFilters in class AbstractMarkupParser

Parameters:

markup -

Returns:

The list of markup filter