java.lang.Object
org.apache.wicket.markup.head.HeaderItem
org.apache.wicket.markup.head.AbstractCspHeaderItem
org.apache.wicket.markup.head.OnEventHeaderItem
- All Implemented Interfaces:
Serializable
,IClusterable
HeaderItem
for event triggered scripts.- Author:
- papegaaij
- See Also:
-
Constructor Summary
ConstructorDescriptionOnEventHeaderItem
(String target, String event) Constructor.OnEventHeaderItem
(String target, String event, CharSequence javaScript) Construct. -
Method Summary
Modifier and TypeMethodDescriptionboolean
static OnEventHeaderItem
forComponent
(Component target, String event, CharSequence javaScript) Creates aOnEventHeaderItem
for the given parameters.static OnEventHeaderItem
forMarkupId
(String id, String event, CharSequence javaScript) Creates aOnEventHeaderItem
for the given parameters.static OnEventHeaderItem
forScript
(String literalTarget, String event, CharSequence javaScript) Creates aOnEventHeaderItem
for the given parameters.getEvent()
Iterable<?>
int
hashCode()
void
Renders theHeaderItem
to the response.toString()
Methods inherited from class org.apache.wicket.markup.head.AbstractCspHeaderItem
getNonce, setNonce
Methods inherited from class org.apache.wicket.markup.head.HeaderItem
getProvidedResources
-
Constructor Details
-
OnEventHeaderItem
Constructor. The JavaScript should be provided by overloaded #getJavaScript- Parameters:
target
-event
-
-
OnEventHeaderItem
Construct.- Parameters:
target
-event
-javaScript
-
-
-
Method Details
-
forScript
public static OnEventHeaderItem forScript(String literalTarget, String event, CharSequence javaScript) Creates aOnEventHeaderItem
for the given parameters.- Parameters:
literalTarget
- The target of the event handler, for example 'window' or 'document'. Note that this parameter is a literal and will be rendered unquoted.event
- The event itself, for example 'click'.javaScript
- The script to execute on the event.- Returns:
- A newly created
OnEventHeaderItem
. - See Also:
-
forComponent
public static OnEventHeaderItem forComponent(Component target, String event, CharSequence javaScript) Creates aOnEventHeaderItem
for the given parameters.- Parameters:
target
- The target component of the event handler.event
- The event itself, for example 'click'.javaScript
- The script to execute on the event.- Returns:
- A newly created
OnEventHeaderItem
.
-
forMarkupId
Creates aOnEventHeaderItem
for the given parameters.- Parameters:
id
- The id of the component to bind the handler to.event
- The event itself, for example 'click'.javaScript
- The script to execute on the event.- Returns:
- A newly created
OnEventHeaderItem
.
-
getTarget
- Returns:
- The target of the event handler, for example 'window' or 'document'.
-
getEvent
- Returns:
- The event itself, for example 'onclick'.
-
getJavaScript
- Returns:
- The script to execute on the event.
-
render
Description copied from class:HeaderItem
Renders theHeaderItem
to the response.- Specified by:
render
in classHeaderItem
-
getCompleteJavaScript
- Returns:
- The JavaScript that registers the event handler.
-
getRenderTokens
- Specified by:
getRenderTokens
in classHeaderItem
- Returns:
- The tokens this
HeaderItem
can be identified by. If any of the tokens has already been rendered, thisHeaderItem
will not be rendered.
-
toString
-
hashCode
-
equals
-
getDependencies
- Overrides:
getDependencies
in classHeaderItem
- Returns:
- The dependencies this
HeaderItem
has. Dependencies will always be rendered before the item itself.
-