org.apache.wicket.markup

Class MarkupFragment

java.lang.Object

org.apache.wicket.markup.AbstractMarkupFragment

org.apache.wicket.markup.MarkupFragment

All Implemented Interfaces:

Iterable<MarkupElement>, IMarkupFragment

public class MarkupFragment
extends AbstractMarkupFragment

Represents a portion of a markup file, but always spans a complete tag. E.g.

 open-body-close: <span>body</span>
 open-close:      <span/>
 open-no-close:   <input ...>body
 

Author:

Juergen Donnerstag

See Also:

Markup, MarkupElement

Constructor Summary

Constructors

Constructor and Description
MarkupFragment(IMarkupFragment markup, int startIndex) Construct.

Method Summary

Methods

Modifier and Type	Method and Description
IMarkupFragment	find(String id) Find the markup fragment of the component with 'path'
MarkupElement	get(int index) Get the MarkupElement at the index provided.
MarkupResourceStream	getMarkupResourceStream() Get the underlying markup resource stream, which might contain more than just the markup portion represented by the IMarkupFragment.
Markup	getRootMarkup()
Iterator<MarkupElement>	iterator()
int	size() The number of markup elements.
String	toString(boolean markupOnly)

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

find, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

MarkupFragment

public MarkupFragment(IMarkupFragment markup,
              int startIndex)

Construct.

Parameters:

markup - The parent markup. May not be null.

startIndex - The start index of the child markup

Throws:

IndexOutOfBoundsException - if the index is out of range (index < 0 || index >= size())

Method Detail

get

public final MarkupElement get(int index)

Description copied from interface: IMarkupFragment

Get the MarkupElement at the index provided.

Parameters:

index - Index into markup list

Returns:

Markup element

find

public final IMarkupFragment find(String id)

Description copied from interface: IMarkupFragment

Find the markup fragment of the component with 'path'

Parameters:

id - The component's id to search for

Returns:

-1, if not found

getMarkupResourceStream

public final MarkupResourceStream getMarkupResourceStream()

Description copied from interface: IMarkupFragment

Get the underlying markup resource stream, which might contain more than just the markup portion represented by the IMarkupFragment.

Returns:

The underlying markup resource stream

size

public final int size()

Description copied from interface: IMarkupFragment

The number of markup elements.

Returns:

Number of markup elements

getRootMarkup

public final Markup getRootMarkup()

Returns:

The Markup representing the underlying markup file with all its content

toString

public String toString(boolean markupOnly)

Parameters:

markupOnly - True if only the markup shall be returned

Returns:

markup string

iterator

public Iterator<MarkupElement> iterator()

See Also:

Iterable.iterator()