org.apache.wicket.markup.head
Class OnDomReadyHeaderItem

java.lang.Object
  org.apache.wicket.markup.head.HeaderItem
      org.apache.wicket.markup.head.OnDomReadyHeaderItem

All Implemented Interfaces:

Serializable, IClusterable

public class OnDomReadyHeaderItem
extends HeaderItem

HeaderItem for scripts that need to be executed directly after the DOM has been built, but before external resources, such as images, are loaded.

Author:

papegaaij

See Also:

Serialized Form

Constructor Summary

OnDomReadyHeaderItem()
Constructor.

OnDomReadyHeaderItem(CharSequence javaScript)
Construct.

Method Summary

boolean	equals(Object obj)
static OnDomReadyHeaderItem	forScript(CharSequence javaScript) Creates a OnDomReadyHeaderItem for the script.
Iterable<? extends HeaderItem>	getDependencies()
CharSequence	getJavaScript()
Iterable<?>	getRenderTokens()
int	hashCode()
void	render(Response response) Renders the HeaderItem to the response.
String	toString()

Methods inherited from class org.apache.wicket.markup.head.HeaderItem

getProvidedResources

Methods inherited from class java.lang.Object

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

Constructor Detail

OnDomReadyHeaderItem

public OnDomReadyHeaderItem()

Constructor. The JavaScript should be provided by overloaded #getJavaScript

OnDomReadyHeaderItem

public OnDomReadyHeaderItem(CharSequence javaScript)

Construct.

Parameters:

javaScript -

Method Detail

forScript

public static OnDomReadyHeaderItem forScript(CharSequence javaScript)

Creates a OnDomReadyHeaderItem for the script.

Parameters:

javaScript - The script to execute on the DOM ready event.

Returns:

A newly created OnDomReadyHeaderItem.

getJavaScript

public CharSequence getJavaScript()

Returns:

the script that gets executed on the DOM ready event.

render

public void render(Response response)

Description copied from class: HeaderItem

Renders the HeaderItem to the response.

Specified by:

render in class HeaderItem

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.

toString

public String toString()

Overrides:

toString in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

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.