org.wicketstuff.push.cometd
Class CometdAbstractBehavior

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

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

Direct Known Subclasses:

CometdBehavior

public abstract class CometdAbstractBehavior
extends AbstractRequireDojoBehavior

This behavior will be asked by client side when it will receive a cometd event associated with the kind of event

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

CometdAbstractBehavior(java.lang.String channelId)
Construct a commetd Behavior

Method Summary

java.lang.CharSequence	getBehaviorMarkupId() Returns the id string
java.lang.String	getChannelId() get the channel where this behavior will wait for event
abstract java.lang.String	getCometdInterceptorScript() Return the string containing the client side logic when a new event comes into the channel.
protected static java.lang.String	getCometdServletPath() Parse the web.xml to find cometd context Path.
protected java.lang.CharSequence	getInitCometdScript() Javascript allowing cometd to be initialized on commetd
abstract 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.
java.lang.CharSequence	getSubscriberScript() Javascript allowing cometd to subscribe to a channel Channel to subscribe comes from getChannelId method, Merthod or object to invoke when a event is triggered on client side is given by getPartialSubscriber() method
java.lang.CharSequence	getUnsuscribeScript() return the javascript to unsuscribe to th channel
void	renderHead(org.apache.wicket.markup.html.IHeaderResponse response)
void	setChannelId(java.lang.String channelId) Set the channel where this behavior will wait for event
void	setRequire(java.util.Set<java.lang.String> libs) allow subclass to register new Dojo require libs

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, respond, 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

CometdAbstractBehavior

public CometdAbstractBehavior(java.lang.String channelId)

Construct a commetd Behavior

Parameters:

channelId -

Method Detail

setRequire

public void setRequire(java.util.Set<java.lang.String> libs)

Description copied from class: AbstractRequireDojoBehavior

allow subclass to register new Dojo require libs

Specified by:

setRequire in class AbstractRequireDojoBehavior

renderHead

public void renderHead(org.apache.wicket.markup.html.IHeaderResponse response)

Specified by:

renderHead in interface org.apache.wicket.markup.html.IHeaderContributor

Overrides:

renderHead in class AbstractRequireDojoBehavior

See Also:

wicket.ajax.AbstractDefaultAjaxBehavior#renderHead(wicket.markup.html.IHeaderResponse)

getCometdInterceptorScript

public abstract java.lang.String getCometdInterceptorScript()

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

Returns:

getPartialSubscriber

public abstract 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.

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'

Returns:

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

getInitCometdScript

protected final java.lang.CharSequence getInitCometdScript()

Javascript allowing cometd to be initialized on commetd

Returns:

javascript to initialize cometd on client Side

getSubscriberScript

public final java.lang.CharSequence getSubscriberScript()

Javascript allowing cometd to subscribe to a channel
Channel to subscribe comes from getChannelId method, Merthod or object to invoke when a event is triggered on client side is given by getPartialSubscriber() method

see also getCometdIntercepteur method and getPartialSubscriber method

Returns:

Javascript allowing cometd to subscribe to a channel and intercept event

getUnsuscribeScript

public final java.lang.CharSequence getUnsuscribeScript()

return the javascript to unsuscribe to th channel

Returns:

javascript to unsuscribe to the channel

getChannelId

public java.lang.String getChannelId()

get the channel where this behavior will wait for event

Returns:

channelId channel where this behavior will wait for event

setChannelId

public void setChannelId(java.lang.String channelId)

Set the channel where this behavior will wait for event

Parameters:

channelId - channel where this behavior will wait for event

getBehaviorMarkupId

public final java.lang.CharSequence getBehaviorMarkupId()

Returns the id string

Returns:

getCometdServletPath

protected static java.lang.String getCometdServletPath()

Parse the web.xml to find cometd context Path. This context path will be cache for all the application

Returns:

commetd context path