wicket.ajax
Class AbstractAjaxTimerBehavior

java.lang.Object
  wicket.behavior.AbstractBehavior
      wicket.behavior.AbstractAjaxBehavior
          wicket.ajax.AbstractDefaultAjaxBehavior
              wicket.ajax.AbstractAjaxTimerBehavior

All Implemented Interfaces:

java.io.Serializable, IBehavior, IBehaviorListener, IRequestListener, IHeaderContributor

Direct Known Subclasses:

AjaxSelfUpdatingTimerBehavior

public abstract class AbstractAjaxTimerBehavior
extends AbstractDefaultAjaxBehavior

A behavior that generates an AJAX update callback at a regular interval.

Since:

1.2

Author:

Igor Vaynberg (ivaynberg)

See Also:

Serialized Form

Field Summary

Fields inherited from class wicket.ajax.AbstractDefaultAjaxBehavior

INDICATOR

Fields inherited from interface wicket.behavior.IBehaviorListener

INTERFACE

Constructor Summary

AbstractAjaxTimerBehavior(Duration updateInterval)
Construct.

Method Summary

protected java.lang.String	getJsTimeoutCall(Duration updateInterval)
protected void	onBind() Subclasses should call super.onBind()
protected void	onRenderHeadContribution(Response response) Let this handler print out the needed header contributions.
protected abstract void	onTimer(AjaxRequestTarget target) Listener method for the AJAX timer event.
protected void	respond(AjaxRequestTarget target)

Methods inherited from class wicket.ajax.AbstractDefaultAjaxBehavior

getAjaxCallDecorator, getCallbackScript, getCallbackScript, getCallbackScript, getImplementationId, onRenderHeadInitContribution, onRequest, throttleScript

Methods inherited from class wicket.behavior.AbstractAjaxBehavior

bind, cleanup, getCallbackUrl, getCallbackUrl, getComponent, onComponentRendered, onComponentTag, onComponentTag, onRendered, renderHead, writeJsReference, writeJsReference

Methods inherited from class wicket.behavior.AbstractBehavior

detachModel, exception, onException, rendered

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractAjaxTimerBehavior

public AbstractAjaxTimerBehavior(Duration updateInterval)

Construct.

Parameters:

updateInterval - Duration between AJAX callbacks

Method Detail

onBind

protected void onBind()

Subclasses should call super.onBind()

Overrides:

onBind in class AbstractDefaultAjaxBehavior

See Also:

AbstractDefaultAjaxBehavior.onBind()

onRenderHeadContribution

protected void onRenderHeadContribution(Response response)

Description copied from class: AbstractAjaxBehavior

Let this handler print out the needed header contributions. This implementation does nothing.

Overrides:

onRenderHeadContribution in class AbstractAjaxBehavior

Parameters:

response - head container

See Also:

AbstractAjaxBehavior.onRenderHeadContribution(wicket.Response)

getJsTimeoutCall

protected final java.lang.String getJsTimeoutCall(Duration updateInterval)

Parameters:

updateInterval - Duration between AJAX callbacks

Returns:

JS script

respond

protected final void respond(AjaxRequestTarget target)

Specified by:

respond in class AbstractDefaultAjaxBehavior

Parameters:

target - The AJAX target

See Also:

AbstractDefaultAjaxBehavior.respond(wicket.ajax.AjaxRequestTarget)

onTimer

protected abstract void onTimer(AjaxRequestTarget target)

Listener method for the AJAX timer event.

Parameters:

target - The request target