org.apache.wicket.extensions.ajax.markup.html
Class WicketAjaxIndicatorAppender

java.lang.Object
  extended by org.apache.wicket.behavior.AbstractBehavior
      extended by org.apache.wicket.extensions.ajax.markup.html.WicketAjaxIndicatorAppender
All Implemented Interfaces:
java.io.Serializable, org.apache.wicket.behavior.IBehavior, org.apache.wicket.IClusterable, org.apache.wicket.markup.html.IHeaderContributor

public class WicketAjaxIndicatorAppender
extends org.apache.wicket.behavior.AbstractBehavior

A behavior that adds a span with wicket's default indicator gif to the end of the component's markup. This span can be used as an ajax busy indicator. For an example usage see IndicatingAjaxLink

Instances of this behavior must not be shared between components.

Since:
1.2
Author:
Igor Vaynberg (ivaynberg)
See Also:
IndicatingAjaxLink, IAjaxIndicatorAware, Serialized Form

Constructor Summary
WicketAjaxIndicatorAppender()
          Construct.
 
Method Summary
 void bind(org.apache.wicket.Component component)
           
protected  java.lang.CharSequence getIndicatorUrl()
           
 java.lang.String getMarkupId()
          Returns the markup id attribute of the outer most span of this indicator.
protected  java.lang.String getSpanClass()
           
 void onRendered(org.apache.wicket.Component component)
           
 void renderHead(org.apache.wicket.markup.html.IHeaderResponse response)
           
 
Methods inherited from class org.apache.wicket.behavior.AbstractBehavior
afterRender, beforeRender, cleanup, detach, detachModel, exception, getStatelessHint, isEnabled, isTemporary, onComponentTag, onException, rendered
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

WicketAjaxIndicatorAppender

public WicketAjaxIndicatorAppender()
Construct.

Method Detail

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 org.apache.wicket.behavior.AbstractBehavior
See Also:
AbstractBehavior.renderHead(IHeaderResponse)

onRendered

public void onRendered(org.apache.wicket.Component component)
Overrides:
onRendered in class org.apache.wicket.behavior.AbstractBehavior
See Also:
AbstractBehavior.onRendered(org.apache.wicket.Component)

getIndicatorUrl

protected java.lang.CharSequence getIndicatorUrl()
Returns:
url of the animated indicator image

getSpanClass

protected java.lang.String getSpanClass()
Returns:
css class name of the generated outer span

getMarkupId

public java.lang.String getMarkupId()
Returns the markup id attribute of the outer most span of this indicator. This is the id of the span that should be hidden or show to hide or show the indicator.

Returns:
markup id of outer most span

bind

public final void bind(org.apache.wicket.Component component)
Specified by:
bind in interface org.apache.wicket.behavior.IBehavior
Overrides:
bind in class org.apache.wicket.behavior.AbstractBehavior
See Also:
AbstractBehavior.bind(org.apache.wicket.Component)


Copyright © 2004-2007 Apache Software Foundation. All Rights Reserved.