org.apache.wicket.behavior
Class AbstractAjaxBehavior

java.lang.Object
  extended by org.apache.wicket.behavior.Behavior
      extended by org.apache.wicket.behavior.AbstractAjaxBehavior
All Implemented Interfaces:
Serializable, IBehaviorListener, IComponentAwareEventSink, IRequestListener, IComponentAwareHeaderContributor, IClusterable
Direct Known Subclasses:
AbstractDefaultAjaxBehavior, AtmosphereBehavior

public abstract class AbstractAjaxBehavior
extends Behavior
implements IBehaviorListener

Abstract class for handling Ajax roundtrips. This class serves as a base for javascript specific implementations, like ones based on Dojo or Scriptaculous, or Wicket's default.

Author:
Eelco Hillenius, Ralf Ebert, Igor Vaynberg
See Also:
Serialized Form

Field Summary
 
Fields inherited from interface org.apache.wicket.behavior.IBehaviorListener
INTERFACE
 
Constructor Summary
AbstractAjaxBehavior()
          Constructor.
 
Method Summary
 void afterRender(Component hostComponent)
          Called when a component that has this behavior coupled was rendered.
 void bind(Component hostComponent)
          Bind this handler to the given component.
 CharSequence getCallbackUrl()
          Gets the url that references this handler.
protected  Component getComponent()
          Gets the component that this handler is bound to.
protected  void onBind()
          Called when the component was bound to it's host component.
protected  void onComponentRendered()
          Called to indicate that the component that has this handler registered has been rendered.
 void onComponentTag(Component component, ComponentTag tag)
          Called any time a component that has this behavior registered is rendering the component tag.
protected  void onComponentTag(ComponentTag tag)
          Called any time a component that has this handler registered is rendering the component tag.
protected  void onUnbind()
          Called when the behavior is removed from its component.
 void unbind(Component component)
          Notifies the behavior it is removed from the specified component
 
Methods inherited from class org.apache.wicket.behavior.Behavior
beforeRender, canCallListenerInterface, detach, getStatelessHint, isEnabled, isTemporary, onConfigure, onEvent, onException, onRemove, renderHead
 
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.behavior.IBehaviorListener
onRequest
 

Constructor Detail

AbstractAjaxBehavior

public AbstractAjaxBehavior()
Constructor.

Method Detail

bind

public final void bind(Component hostComponent)
Bind this handler to the given component.

Overrides:
bind in class Behavior
Parameters:
hostComponent - the component to bind to

getCallbackUrl

public CharSequence getCallbackUrl()
Gets the url that references this handler.

Returns:
the url that references this handler

onComponentTag

public final void onComponentTag(Component component,
                                 ComponentTag tag)
Description copied from class: Behavior
Called any time a component that has this behavior registered is rendering the component tag.

Overrides:
onComponentTag in class Behavior
Parameters:
component - the component that renders this tag currently
tag - the tag that is rendered
See Also:
Behavior.onComponentTag(org.apache.wicket.Component, org.apache.wicket.markup.ComponentTag)

afterRender

public final void afterRender(Component hostComponent)
Description copied from class: Behavior
Called when a component that has this behavior coupled was rendered.

Overrides:
afterRender in class Behavior
Parameters:
hostComponent - the component that has this behavior coupled
See Also:
Behavior.afterRender(org.apache.wicket.Component)

getComponent

protected final Component getComponent()
Gets the component that this handler is bound to.

Returns:
the component that this handler is bound to

onComponentTag

protected void onComponentTag(ComponentTag tag)
Called any time a component that has this handler registered is rendering the component tag. Use this method e.g. to bind to javascript event handlers of the tag

Parameters:
tag - the tag that is rendered

onBind

protected void onBind()
Called when the component was bound to it's host component. You can get the bound host component by calling getComponent.


onComponentRendered

protected void onComponentRendered()
Called to indicate that the component that has this handler registered has been rendered. Use this method to do any cleaning up of temporary state


unbind

public final void unbind(Component component)
Description copied from class: Behavior
Notifies the behavior it is removed from the specified component

Overrides:
unbind in class Behavior
Parameters:
component - the component this behavior is unbound from

onUnbind

protected void onUnbind()
Called when the behavior is removed from its component. The bound host component is still available through getComponent(). The relation to it will be removed right after the finish of the execution of this method.



Copyright © 2006–2017 Apache Software Foundation. All rights reserved.