Package org.apache.wicket.ajax

Class AjaxSelfUpdatingTimerBehavior

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.AjaxSelfUpdatingTimerBehavior

All Implemented Interfaces:

Serializable, IComponentAwareEventSink, IRequestListener, IComponentAwareHeaderContributor, org.apache.wicket.util.io.IClusterable

public class AjaxSelfUpdatingTimerBehavior
extends AbstractAjaxTimerBehavior

Automatically re-renders the component it is attached to via AJAX at a regular interval.

Since:

1.2

Author:

Igor Vaynberg (ivaynberg)

See Also:

onTimer(AjaxRequestTarget), onPostProcessTarget(AjaxRequestTarget), Serialized Form

Field Summary

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

INDICATOR

Constructor Summary

Constructors

Constructor	Description
AjaxSelfUpdatingTimerBehavior(Duration updateInterval)	Construct.
AjaxSelfUpdatingTimerBehavior(org.apache.wicket.util.time.Duration updateInterval)	Deprecated. Since Wicket 9 this constructor is deprecated.

Method Summary

Modifier and Type	Method	Description
protected void	onPostProcessTarget(AjaxRequestTarget target)	Give the subclass a chance to add something to the target, like a javascript effect call.
static AjaxSelfUpdatingTimerBehavior	onSelfUpdate(Duration interval, org.danekja.java.util.function.serializable.SerializableConsumer<AjaxRequestTarget> onTimer)	Creates an AbstractAjaxTimerBehavior based on lambda expressions
protected void	onTimer(AjaxRequestTarget target)	Listener method for the AJAX timer event.

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

getTimerId, getUpdateInterval, isStopped, onRemove, onTimer, onUnbind, renderHead, 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, updateAjaxAttributes

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

AjaxSelfUpdatingTimerBehavior

@Deprecated
public AjaxSelfUpdatingTimerBehavior(org.apache.wicket.util.time.Duration updateInterval)

Deprecated.

Since Wicket 9 this constructor is deprecated. It will be removed in Wicket 10. Use AjaxSelfUpdatingTimerBehavior(Duration) instead

Construct.

Parameters:

updateInterval - Duration between AJAX callbacks

AjaxSelfUpdatingTimerBehavior

public AjaxSelfUpdatingTimerBehavior(Duration updateInterval)

Construct.

Parameters:

updateInterval - Duration between AJAX callbacks

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

onPostProcessTarget

protected void onPostProcessTarget(AjaxRequestTarget target)

Give the subclass a chance to add something to the target, like a javascript effect call. Called after the hosting component has been added to the target.

Parameters:

target - The AJAX target

onSelfUpdate

public static AjaxSelfUpdatingTimerBehavior onSelfUpdate(Duration interval,
                                                         org.danekja.java.util.function.serializable.SerializableConsumer<AjaxRequestTarget> onTimer)

Creates an AbstractAjaxTimerBehavior based on lambda expressions

Parameters:

interval - the interval for the self update

onTimer - the SerializableConsumer which accepts the AjaxRequestTarget

Returns:

the AbstractAjaxTimerBehavior