org.apache.wicket.markup.head
Class HeaderItem

java.lang.Object
  extended by org.apache.wicket.markup.head.HeaderItem
Direct Known Subclasses:
CssHeaderItem, FilteredHeaderItem, JavaScriptHeaderItem, NoHeaderItem, OnDomReadyHeaderItem, OnEventHeaderItem, OnLoadHeaderItem, PriorityHeaderItem, StringHeaderItem

public abstract class HeaderItem
extends Object

HeaderItem represents anything that can be rendered into the header. This can, for example, be a script or a stylesheet , but also event triggers or free form text. HeaderItems are used by ResourceAggregator to be able to collect all header sections in a uniform way. All HeaderItems are expected to have decent equals, hashCode and toString (for debugging).

Author:
papegaaij

Constructor Summary
HeaderItem()
           
 
Method Summary
 Iterable<? extends HeaderItem> getDependencies()
           
 Iterable<? extends HeaderItem> getProvidedResources()
           
abstract  Iterable<?> getRenderTokens()
           
abstract  void render(Response response)
          Renders the HeaderItem to the response.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

HeaderItem

public HeaderItem()
Method Detail

getDependencies

public Iterable<? extends HeaderItem> getDependencies()
Returns:
The dependencies this HeaderItem has. Dependencies will always be rendered before the item itself.

getProvidedResources

public Iterable<? extends HeaderItem> getProvidedResources()
Returns:
The resources this HeaderItem provides. As these resources are provided by this item, they will no longer be rendered.

getRenderTokens

public abstract Iterable<?> getRenderTokens()
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 abstract void render(Response response)
Renders the HeaderItem to the response.

Parameters:
response -


Copyright © 2006-2013 Apache Software Foundation. All Rights Reserved.