org.wicketstuff.push.cometd
Class CometdBehavior

java.lang.Object
  org.apache.wicket.behavior.AbstractBehavior
      org.apache.wicket.behavior.AbstractAjaxBehavior
          org.apache.wicket.ajax.AbstractDefaultAjaxBehavior
              org.wicketstuff.push.dojo.AbstractDefaultDojoBehavior
                  org.wicketstuff.push.dojo.AbstractRequireDojoBehavior
                      org.wicketstuff.push.cometd.CometdAbstractBehavior
                          org.wicketstuff.push.cometd.CometdBehavior

All Implemented Interfaces:

java.io.Serializable, org.apache.wicket.behavior.IBehavior, org.apache.wicket.behavior.IBehaviorListener, org.apache.wicket.IClusterable, org.apache.wicket.IRequestListener, org.apache.wicket.markup.html.IHeaderContributor

public class CometdBehavior
extends CometdAbstractBehavior

See Also:

Serialized Form

Field Summary

Fields inherited from class org.wicketstuff.push.dojo.AbstractDefaultDojoBehavior

DOJO, USE_CUSTOM_DOJO_DIST

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

INDICATOR

Fields inherited from interface org.apache.wicket.behavior.IBehaviorListener

INTERFACE

Constructor Summary

CometdBehavior(java.lang.String channelId, IChannelListener listener)

Method Summary

java.lang.String	getCometdInterceptorScript() Return the string containing the client side logic when a new event comes into the channel.
java.lang.CharSequence	getPartialSubscriber() this method should return a part of javascript (String) allowing to give code to execute when a cometd event is triggered in client side.
protected void	respond(org.apache.wicket.ajax.AjaxRequestTarget target)

Methods inherited from class org.wicketstuff.push.cometd.CometdAbstractBehavior

getBehaviorMarkupId, getChannelId, getCometdServletPath, getInitCometdScript, getSubscriberScript, getUnsuscribeScript, renderHead, setChannelId, setRequire

Methods inherited from class org.wicketstuff.push.dojo.AbstractRequireDojoBehavior

getRequire, onComponentRendered, onComponentReRendered

Methods inherited from class org.wicketstuff.push.dojo.AbstractDefaultDojoBehavior

getDojoResourceReference

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

findIndicatorId, generateCallbackScript, getAjaxCallDecorator, getCallbackScript, getCallbackScript, getChannelName, getFailureScript, getPreconditionScript, getSuccessScript, onBind, onRequest, throttleScript

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

bind, getCallbackUrl, getCallbackUrl, getComponent, getImplementationId, getStatelessHint, onComponentTag, onComponentTag, onRendered, onRenderHeadContribution, onRenderHeadInitContribution

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

afterRender, beforeRender, cleanup, detach, detachModel, exception, isEnabled, isTemporary, onException, rendered

Methods inherited from class java.lang.Object

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

Constructor Detail

CometdBehavior

public CometdBehavior(java.lang.String channelId,
                      IChannelListener listener)

Method Detail

getCometdInterceptorScript

public final java.lang.String getCometdInterceptorScript()

Description copied from class: CometdAbstractBehavior

Return the string containing the client side logic when a new event comes into the channel.

see CharSequence getSubscriberScript(String javascriptObject, String javascriptMethod)

This script should contain an object javascriptObject having a method javascriptMethod

Specified by:

getCometdInterceptorScript in class CometdAbstractBehavior

Returns:

getPartialSubscriber

public final java.lang.CharSequence getPartialSubscriber()

Description copied from class: CometdAbstractBehavior

this method should return a part of javascript (String) allowing to give code to execute when a cometd event is triggered in client side.

It can be a single function name comming form the DojoPackagesTextTemplate such as 'MyFunction' or an objectInstance and one of its function, i.e, 'MyObject','OneFunctionOfMyObject'

Specified by:

getPartialSubscriber in class CometdAbstractBehavior

Returns:

part of javascript (String) allowing to give code to execute when a cometd event is triggered in client side.

respond

protected final void respond(org.apache.wicket.ajax.AjaxRequestTarget target)

Specified by:

respond in class org.apache.wicket.ajax.AbstractDefaultAjaxBehavior