com.googlecode.wicket.jquery.ui.widget.tabs

Class TabsBehavior

java.lang.Object

org.apache.wicket.behavior.Behavior

com.googlecode.wicket.jquery.core.JQueryAbstractBehavior

com.googlecode.wicket.jquery.core.JQueryBehavior

com.googlecode.wicket.jquery.ui.JQueryUIBehavior

com.googlecode.wicket.jquery.ui.widget.tabs.TabsBehavior

All Implemented Interfaces:

IJQueryAjaxAware, java.io.Serializable, org.apache.wicket.IComponentAwareEventSink, org.apache.wicket.markup.html.IComponentAwareHeaderContributor, org.apache.wicket.util.io.IClusterable

public abstract class TabsBehavior
extends JQueryUIBehavior
implements IJQueryAjaxAware

Provides a jQuery tabs behavior.
Note, this class has almost the same code as AccordionBehavior

Since:

1.2.1

Author:

Sebastien Briquet - sebfz1

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	TabsBehavior.ActivateEvent Provides an event object that will be broadcasted by the JQueryAjaxBehavior 'activate' callback
protected static class	TabsBehavior.ActivatingEvent Provides an event object that will be broadcasted by the JQueryAjaxBehavior 'beforeActivate' callback

Field Summary

Fields inherited from class com.googlecode.wicket.jquery.core.JQueryBehavior

method, options, selector

Constructor Summary

Constructors

Constructor and Description
TabsBehavior(java.lang.String selector) Constructor
TabsBehavior(java.lang.String selector, Options options) Constructor

Method Summary

Methods

Modifier and Type	Method and Description
void	activate(int index, org.apache.wicket.ajax.AjaxRequestTarget target) Activates the selected tab, identified by the index
void	bind(org.apache.wicket.Component component)
protected abstract java.util.List<org.apache.wicket.extensions.markup.html.tabs.ITab>	getTabs() Gets the reference List of ITabs. Usually the model object of the component on which this TabsBehavior is bound to.
protected java.util.List<org.apache.wicket.extensions.markup.html.tabs.ITab>	getVisibleTabs() Gets a read-only ITab List having its visible flag set to true.
boolean	isActivateEventEnabled() Indicates whether the 'activate' event is enabled. If true, the onActivate(AjaxRequestTarget, int, ITab) event will be triggered on 'activate' Warning: 'activate' event is required to be enabled for the AjaxTab to load
boolean	isActivatingEventEnabled() Indicates whether the 'beforeActivate' event is enabled. If true, the onActivating(AjaxRequestTarget, int, ITab) event will be triggered.
boolean	isCreateEventEnabled() Indicates whether the 'create' event is enabled. If true, the onActivate(AjaxRequestTarget, int, ITab) event will be triggered on 'create' Warning: 'create' event is required to be enabled for the AjaxTab to load
protected JQueryAjaxBehavior	newActivateEventBehavior() Gets a new JQueryAjaxBehavior that acts as the 'activate' javascript callback
protected JQueryAjaxBehavior	newActivatingEventBehavior() Gets a new JQueryAjaxBehavior that acts as the 'beforeActivate' javascript callback
void	onActivate(org.apache.wicket.ajax.AjaxRequestTarget target, int index, org.apache.wicket.extensions.markup.html.tabs.ITab tab) Triggered when a tab has been activated ('activate' event).
void	onActivating(org.apache.wicket.ajax.AjaxRequestTarget target, int index, org.apache.wicket.extensions.markup.html.tabs.ITab tab) Triggered when a tab is being activated ('beforeActivate' event).
void	onAjax(org.apache.wicket.ajax.AjaxRequestTarget target, JQueryEvent event)
void	onConfigure(org.apache.wicket.Component component)

Methods inherited from class com.googlecode.wicket.jquery.core.JQueryBehavior

$, $, $, beforeRender, getMethod, getOption, getOptions, getSelector, on, on, on, renderHead, setOption, setOption, setOption, setOptions, setSelector

Methods inherited from class com.googlecode.wicket.jquery.core.JQueryAbstractBehavior

add, getJQueryLibrarySettings, getToken, renderScript, toString

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

afterRender, canCallListenerInterface, detach, getStatelessHint, isEnabled, isTemporary, onComponentTag, onEvent, onException, onRemove, unbind

Methods inherited from class java.lang.Object

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

Constructor Detail

TabsBehavior

public TabsBehavior(java.lang.String selector)

Constructor

Parameters:

selector - the html selector (ie: "#myId")

TabsBehavior

public TabsBehavior(java.lang.String selector,
            Options options)

Constructor

Parameters:

selector - the html selector (ie: "#myId")

options - the Options

Method Detail

getTabs

protected abstract java.util.List<org.apache.wicket.extensions.markup.html.tabs.ITab> getTabs()

Gets the reference List of ITabs.
Usually the model object of the component on which this TabsBehavior is bound to.

Returns:

a non-null List

getVisibleTabs

protected java.util.List<org.apache.wicket.extensions.markup.html.tabs.ITab> getVisibleTabs()

Gets a read-only ITab List having its visible flag set to true.

Returns:

a List of ITabs

bind

public void bind(org.apache.wicket.Component component)

Overrides:

bind in class org.apache.wicket.behavior.Behavior

activate

public void activate(int index,
            org.apache.wicket.ajax.AjaxRequestTarget target)

Activates the selected tab, identified by the index

Parameters:

target - the AjaxRequestTarget

index - the tab's index

onConfigure

public void onConfigure(org.apache.wicket.Component component)

Overrides:

onConfigure in class JQueryUIBehavior

onAjax

public void onAjax(org.apache.wicket.ajax.AjaxRequestTarget target,
          JQueryEvent event)

Specified by:

onAjax in interface IJQueryAjaxAware

newActivateEventBehavior

protected JQueryAjaxBehavior newActivateEventBehavior()

Gets a new JQueryAjaxBehavior that acts as the 'activate' javascript callback

Returns:

the JQueryAjaxBehavior

newActivatingEventBehavior

protected JQueryAjaxBehavior newActivatingEventBehavior()

Gets a new JQueryAjaxBehavior that acts as the 'beforeActivate' javascript callback

Returns:

the JQueryAjaxBehavior

isCreateEventEnabled

public boolean isCreateEventEnabled()

Indicates whether the 'create' event is enabled.
If true, the onActivate(AjaxRequestTarget, int, ITab) event will be triggered on 'create'

Warning: 'create' event is required to be enabled for the AjaxTab to load

Returns:

true by default

isActivateEventEnabled

public boolean isActivateEventEnabled()

Indicates whether the 'activate' event is enabled.
If true, the onActivate(AjaxRequestTarget, int, ITab) event will be triggered on 'activate'

Warning: 'activate' event is required to be enabled for the AjaxTab to load

Returns:

true by default

isActivatingEventEnabled

public boolean isActivatingEventEnabled()

Indicates whether the 'beforeActivate' event is enabled.
If true, the onActivating(AjaxRequestTarget, int, ITab) event will be triggered.

Returns:

false by default

onActivate

public void onActivate(org.apache.wicket.ajax.AjaxRequestTarget target,
              int index,
              org.apache.wicket.extensions.markup.html.tabs.ITab tab)

Triggered when a tab has been activated ('activate' event).

Parameters:

target - the AjaxRequestTarget

index - the tab index that triggered this event

tab - the ITab that corresponds to the index

onActivating

public void onActivating(org.apache.wicket.ajax.AjaxRequestTarget target,
                int index,
                org.apache.wicket.extensions.markup.html.tabs.ITab tab)

Triggered when a tab is being activated ('beforeActivate' event).

Parameters:

target - the AjaxRequestTarget

index - the previously selected tab index

tab - the ITab that corresponds to the index