org.apache.wicket.ajax

Class AjaxClientInfoBehavior

java.lang.Object

org.apache.wicket.behavior.Behavior

org.apache.wicket.behavior.AbstractAjaxBehavior

org.apache.wicket.ajax.AbstractDefaultAjaxBehavior

org.apache.wicket.ajax.AbstractAjaxTimerBehavior

org.apache.wicket.ajax.AjaxClientInfoBehavior

All Implemented Interfaces:

Serializable, IComponentAwareEventSink, IRequestListener, IComponentAwareHeaderContributor, IClusterable

public class AjaxClientInfoBehavior
extends AbstractAjaxTimerBehavior

An behavior that collects the information to populate WebClientInfo's ClientProperties by using Ajax

See Also:

onClientInfo(AjaxRequestTarget, org.apache.wicket.protocol.http.request.WebClientInfo), Serialized Form

Field Summary

Fields inherited from class org.apache.wicket.ajax.AbstractDefaultAjaxBehavior

INDICATOR

Constructor Summary

Constructors

Constructor and Description
AjaxClientInfoBehavior() Constructor.
AjaxClientInfoBehavior(Duration duration) Constructor.

Method Summary

Modifier and Type	Method and Description
protected WebClientInfo	newWebClientInfo(RequestCycle requestCycle)
protected void	onClientInfo(AjaxRequestTarget target, WebClientInfo clientInfo) A callback method invoked when the client info is collected.
static AjaxClientInfoBehavior	onClientInfo(org.danekja.java.util.function.serializable.SerializableBiConsumer<AjaxRequestTarget,WebClientInfo> onClientInfo) Creates an AjaxClientInfoBehavior based on lambda expressions
protected void	onTimer(AjaxRequestTarget target) Listener method for the AJAX timer event.
void	renderHead(Component component, IHeaderResponse response) Render to the web response whatever the component wants to contribute to the head section.
protected void	updateAjaxAttributes(AjaxRequestAttributes attributes) Gives a chance to the specializations to modify the attributes.

Methods inherited from class org.apache.wicket.ajax.AbstractAjaxTimerBehavior

getTimerId, getUpdateInterval, isStopped, onRemove, onTimer, onUnbind, respond, restart, setUpdateInterval, shouldTrigger, stop

Methods inherited from class org.apache.wicket.ajax.AbstractDefaultAjaxBehavior

findIndicatorId, getAttributes, getCallbackFunction, getCallbackFunctionBody, getCallbackScript, getCallbackScript, onBind, onMethodMismatch, onRequest, postprocessConfiguration, renderAjaxAttributes, renderAjaxAttributes

Methods inherited from class org.apache.wicket.behavior.AbstractAjaxBehavior

afterRender, bind, getCallbackUrl, getComponent, onComponentRendered, onComponentTag, onComponentTag, unbind

Methods inherited from class org.apache.wicket.behavior.Behavior

beforeRender, canCallListener, detach, getStatelessHint, isEnabled, isTemporary, onAttribute, onConfigure, onEvent, onException, onTag

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.apache.wicket.IRequestListener

rendersPage

Constructor Detail

AjaxClientInfoBehavior

public AjaxClientInfoBehavior()

Constructor. Auto fires after 50 millis.

AjaxClientInfoBehavior

public AjaxClientInfoBehavior(Duration duration)

Constructor. Auto fires after duration.

Parameters:

duration - the duration of the client info behavior

Method Detail

onTimer

protected final void onTimer(AjaxRequestTarget target)

Description copied from class: AbstractAjaxTimerBehavior

Listener method for the AJAX timer event.

Specified by:

onTimer in class AbstractAjaxTimerBehavior

Parameters:

target - The request target

newWebClientInfo

protected WebClientInfo newWebClientInfo(RequestCycle requestCycle)

onClientInfo

protected void onClientInfo(AjaxRequestTarget target,
                            WebClientInfo clientInfo)

A callback method invoked when the client info is collected.

Parameters:

target - The Ajax request handler

clientInfo - The collected info for the client

updateAjaxAttributes

protected void updateAjaxAttributes(AjaxRequestAttributes attributes)

Description copied from class: AbstractDefaultAjaxBehavior

Gives a chance to the specializations to modify the attributes.

Overrides:

updateAjaxAttributes in class AbstractDefaultAjaxBehavior

renderHead

public void renderHead(Component component,
                       IHeaderResponse response)

Description copied from class: Behavior

Render to the web response whatever the component wants to contribute to the head section.

Specified by:

renderHead in interface IComponentAwareHeaderContributor

Overrides:

renderHead in class AbstractAjaxTimerBehavior

Parameters:

component - component which is contributing to the response. This parameter is here to give the component as the context for component-awares implementing this interface

response - Response object

See Also:

Behavior.renderHead(Component, org.apache.wicket.markup.head.IHeaderResponse)

onClientInfo

public static AjaxClientInfoBehavior onClientInfo(org.danekja.java.util.function.serializable.SerializableBiConsumer<AjaxRequestTarget,WebClientInfo> onClientInfo)

Creates an AjaxClientInfoBehavior based on lambda expressions

Parameters:

onClientInfo - the SerializableBiConsumer which accepts the AjaxRequestTarget and the WebClientInfo

Returns:

the AjaxClientInfoBehavior