|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectorg.apache.wicket.behavior.Behavior
org.apache.wicket.behavior.AbstractAjaxBehavior
org.apache.wicket.ajax.AbstractDefaultAjaxBehavior
org.apache.wicket.ajax.AbstractAjaxTimerBehavior
public abstract class AbstractAjaxTimerBehavior
A behavior that generates an AJAX update callback at a regular interval.
| Field Summary |
|---|
| Fields inherited from class org.apache.wicket.ajax.AbstractDefaultAjaxBehavior |
|---|
INDICATOR |
| Fields inherited from interface org.apache.wicket.behavior.IBehaviorListener |
|---|
INTERFACE |
| Constructor Summary | |
|---|---|
AbstractAjaxTimerBehavior(Duration updateInterval)
Construct. |
|
| Method Summary | |
|---|---|
protected CharSequence |
getCallbackScript()
|
protected String |
getJsTimeoutCall(Duration updateInterval)
|
protected CharSequence |
getPreconditionScript()
|
Duration |
getUpdateInterval()
Returns the update interval |
boolean |
isStopped()
|
protected abstract 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 |
respond(AjaxRequestTarget target)
|
protected void |
setUpdateInterval(Duration updateInterval)
Sets the update interval duration. |
void |
stop()
Stops the timer |
| Methods inherited from class org.apache.wicket.ajax.AbstractDefaultAjaxBehavior |
|---|
findIndicatorId, generateCallbackScript, getAjaxCallDecorator, getChannel, getChannelName, getFailureScript, getSuccessScript, onBind, onRequest, throttleScript |
| Methods inherited from class org.apache.wicket.behavior.AbstractAjaxBehavior |
|---|
afterRender, bind, getCallbackUrl, getComponent, getStatelessHint, onComponentRendered, onComponentTag, onComponentTag, onUnbind, unbind |
| Methods inherited from class org.apache.wicket.behavior.Behavior |
|---|
beforeRender, canCallListenerInterface, canCallListenerInterface, detach, isEnabled, isTemporary, onConfigure, onEvent, onException |
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Constructor Detail |
|---|
public AbstractAjaxTimerBehavior(Duration updateInterval)
updateInterval - Duration between AJAX callbacks| Method Detail |
|---|
public final void stop()
protected final void setUpdateInterval(Duration updateInterval)
onTimer(AjaxRequestTarget) method.
updateInterval - public final Duration getUpdateInterval()
public void renderHead(Component component,
IHeaderResponse response)
Behavior
renderHead in interface IComponentAwareHeaderContributorrenderHead in class AbstractDefaultAjaxBehaviorcomponent - component which is contributing to the response. This parameter is here to give
the component as the context for component-awares implementing this interfaceresponse - Response objectBehavior.renderHead(Component,org.apache.wicket.markup.html.IHeaderResponse)protected final String getJsTimeoutCall(Duration updateInterval)
updateInterval - Duration between AJAX callbacks
protected CharSequence getCallbackScript()
getCallbackScript in class AbstractDefaultAjaxBehaviorprotected CharSequence getPreconditionScript()
getPreconditionScript in class AbstractDefaultAjaxBehaviorAbstractDefaultAjaxBehavior.getPreconditionScript()protected final void respond(AjaxRequestTarget target)
respond in class AbstractDefaultAjaxBehaviortarget - The AJAX targetAbstractDefaultAjaxBehavior.respond(org.apache.wicket.ajax.AjaxRequestTarget)protected abstract void onTimer(AjaxRequestTarget target)
target - The request targetpublic final boolean isStopped()
true if has been stopped via stop()
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||