org.apache.wicket.markup

Interface IMarkupFragment

All Superinterfaces:

Iterable<MarkupElement>

All Known Implementing Classes:

AbstractMarkupFragment, Markup, MarkupFragment, MergedMarkup

public interface IMarkupFragment
extends Iterable<MarkupElement>

Any list of MarkupElements. May be the content of complete markup file or just a portion of it.

Author:

Juergen Donnerstag

See Also:

Markup, MarkupFragment, MarkupElement

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.
int	size() The number of markup elements.
String	toString(boolean markupOnly)

Methods inherited from interface java.lang.Iterable

iterator

Method Detail

get

MarkupElement get(int index)

Get the MarkupElement at the index provided.

Parameters:

index - Index into markup list

Returns:

Markup element

Throws:

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

getMarkupResourceStream

MarkupResourceStream getMarkupResourceStream()

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

int size()

The number of markup elements.

Returns:

Number of markup elements

find

IMarkupFragment find(String id)

Find the markup fragment of the component with 'path'

Parameters:

id - The component's id to search for

Returns:

-1, if not found

toString

String toString(boolean markupOnly)

Parameters:

markupOnly - True if only the markup shall be returned

Returns:

markup string