org.apache.wicket.markup.head.filter
Class FilteredHeaderItem

java.lang.Object
  org.apache.wicket.markup.head.HeaderItem
      org.apache.wicket.markup.head.filter.FilteredHeaderItem

All Implemented Interfaces:

Serializable, IHeaderItemWrapper, IWrappedHeaderItem, IClusterable

public class FilteredHeaderItem
extends HeaderItem
implements IHeaderItemWrapper

HeaderItem that specifies the filter it belongs to. Dependencies of a FilteredHeaderItem belong to the same filter. If used in conjunction with JavaScriptFilteredIntoFooterHeaderResponse, use HEADER_FILTER_NAME to render items in the header.

Author:

papegaaij

See Also:

Serialized Form

Constructor Summary

FilteredHeaderItem(HeaderItem wrapped, String filterName)
Construct.

Method Summary

boolean	equals(Object obj)
Iterable<? extends HeaderItem>	getDependencies()
String	getFilterName()
Iterable<? extends HeaderItem>	getProvidedResources()
Iterable<?>	getRenderTokens()
HeaderItem	getWrapped()
int	hashCode()
void	render(Response response) Renders the HeaderItem to the response.
String	toString()
FilteredHeaderItem	wrap(HeaderItem item) Wraps an existing HeaderItem

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

FilteredHeaderItem

public FilteredHeaderItem(HeaderItem wrapped,
                          String filterName)

Construct.

Parameters:

wrapped - the actual HeaderItem

filterName - the name of the filter this item belongs to

Method Detail

getWrapped

public HeaderItem getWrapped()

Specified by:

getWrapped in interface IWrappedHeaderItem

Returns:

the actual HeaderItem

wrap

public FilteredHeaderItem wrap(HeaderItem item)

Description copied from interface: IHeaderItemWrapper

Wraps an existing HeaderItem

Specified by:

wrap in interface IHeaderItemWrapper

Parameters:

item - The item to wrap

Returns:

the wrapped header item

getFilterName

public String getFilterName()

Returns:

the name of the filter this item belongs to

getRenderTokens

public Iterable<?> getRenderTokens()

Specified by:

getRenderTokens in class HeaderItem

Returns:

The tokens this HeaderItem can be identified by. If any of the tokens has already been rendered, this HeaderItem will not be rendered.

render

public void render(Response response)

Description copied from class: HeaderItem

Renders the HeaderItem to the response.

Specified by:

render in class HeaderItem

getDependencies

public Iterable<? extends HeaderItem> getDependencies()

Overrides:

getDependencies in class HeaderItem

Returns:

The dependencies this HeaderItem has. Dependencies will always be rendered before the item itself.

getProvidedResources

public Iterable<? extends HeaderItem> getProvidedResources()

Overrides:

getProvidedResources in class HeaderItem

Returns:

The resources this HeaderItem provides. As these resources are provided by this item, they will no longer be rendered.

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object