Package 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:

com.googlecode.wicket.jquery.core.ajax.IJQueryAjaxAware, JQueryDestroyListener.IDestroyable, Serializable, IComponentAwareEventSink, IComponentAwareHeaderContributor, IClusterable

public abstract class TabsBehavior
extends JQueryUIBehavior
implements com.googlecode.wicket.jquery.core.ajax.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	Description
protected static class	TabsBehavior.ActivateEvent	Provides an event object that will be broadcasted by the TabsBehavior.OnActivateAjaxBehavior callback
protected static class	TabsBehavior.ActivatingEvent	Provides an event object that will be broadcasted by the TabsBehavior.OnActivatingAjaxBehavior callback
protected static class	TabsBehavior.OnActivateAjaxBehavior	Provides a JQueryAjaxBehavior that aims to be wired to the 'activate' event
protected static class	TabsBehavior.OnActivatingAjaxBehavior	Provides a JQueryAjaxBehavior that aims to be wired to the 'beforeActivate' event

Field Summary

Fields

Modifier and Type	Field	Description
static String	METHOD

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

method, options, selector

Constructor Summary

Constructors

Constructor	Description
TabsBehavior(String selector, com.googlecode.wicket.jquery.core.Options options, ITabsListener listener)	Constructor
TabsBehavior(String selector, ITabsListener listener)	Constructor

Method Summary

Modifier and Type	Method	Description
void	activate(int index, IPartialPageRequestHandler handler)	Activates the selected tab, identified by the index
void	bind(Component component)
void	disable(int index, IPartialPageRequestHandler handler)	Disables a tab, identified by its index.
void	disable(IPartialPageRequestHandler handler)	Disables all tabs
void	enable(int index, IPartialPageRequestHandler handler)	Enables a tab, identified by its index
void	enable(IPartialPageRequestHandler handler)	Enables all tabs
protected abstract List<ITab>	getTabs()	Gets the reference List of ITabs. Usually the model object of the component on which this TabsBehavior is bound to.
protected List<ITab>	getVisibleTabs()	Gets a read-only ITab List having its visible flag set to true.
protected com.googlecode.wicket.jquery.core.ajax.JQueryAjaxBehavior	newOnActivateAjaxBehavior(com.googlecode.wicket.jquery.core.ajax.IJQueryAjaxAware source)	Gets a new JQueryAjaxBehavior that will be wired to the 'activate' event
protected com.googlecode.wicket.jquery.core.ajax.JQueryAjaxBehavior	newOnActivatingAjaxBehavior(com.googlecode.wicket.jquery.core.ajax.IJQueryAjaxAware source)	Gets a new JQueryAjaxBehavior that will be wired to the 'beforeActivate' event
void	onAjax(AjaxRequestTarget target, com.googlecode.wicket.jquery.core.JQueryEvent event)
void	onConfigure(Component component)

Methods inherited from class com.googlecode.wicket.jquery.ui.JQueryUIBehavior

destroy, onDestroy, widget, widget, widget, widget

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

$, $, $, $, beforeRender, detach, getMethod, getOption, getOptions, getSelector, off, on, on, register, remove, renderHead, setOption, setOption, setOption, setOptions, setSelector

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

add, getJQueryLibrarySettings, renderOnDomReadyScript, renderPriorityHeaderItem, toString

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

afterRender, canCallListener, detach, getStatelessHint, isEnabled, isTemporary, onAttribute, onComponentTag, onEvent, onException, onRemove, onTag, unbind

Methods inherited from class java.lang.Object

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

Field Detail

METHOD

public static final String METHOD

See Also:

Constant Field Values

Constructor Detail

TabsBehavior

public TabsBehavior(String selector,
                    ITabsListener listener)

Constructor

Parameters:

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

listener - the ITabsListener

TabsBehavior

public TabsBehavior(String selector,
                    com.googlecode.wicket.jquery.core.Options options,
                    ITabsListener listener)

Constructor

Parameters:

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

options - the Options

listener - the ITabsListener

Method Detail

getTabs

protected abstract List<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 List<ITab> getVisibleTabs()

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

Returns:

a List of ITabs

bind

public void bind(Component component)

Overrides:

bind in class Behavior

activate

public void activate(int index,
                     IPartialPageRequestHandler handler)

Activates the selected tab, identified by the index

Parameters:

index - the tab's index

handler - the IPartialPageRequestHandler

enable

public void enable(IPartialPageRequestHandler handler)

Enables all tabs

Parameters:

handler - the IPartialPageRequestHandler

enable

public void enable(int index,
                   IPartialPageRequestHandler handler)

Enables a tab, identified by its index

Parameters:

index - the tab's index

handler - the IPartialPageRequestHandler

disable

public void disable(IPartialPageRequestHandler handler)

Disables all tabs

Parameters:

handler - the IPartialPageRequestHandler

disable

public void disable(int index,
                    IPartialPageRequestHandler handler)

Disables a tab, identified by its index. The selected tab cannot be disabled.

Parameters:

index - the tab's index

handler - the IPartialPageRequestHandler

onConfigure

public void onConfigure(Component component)

Overrides:

onConfigure in class JQueryUIBehavior

onAjax

public void onAjax(AjaxRequestTarget target,
                   com.googlecode.wicket.jquery.core.JQueryEvent event)

Specified by:

onAjax in interface com.googlecode.wicket.jquery.core.ajax.IJQueryAjaxAware

newOnActivateAjaxBehavior

protected com.googlecode.wicket.jquery.core.ajax.JQueryAjaxBehavior newOnActivateAjaxBehavior(com.googlecode.wicket.jquery.core.ajax.IJQueryAjaxAware source)

Gets a new JQueryAjaxBehavior that will be wired to the 'activate' event

Parameters:

source - the IJQueryAjaxAware

Returns:

a new OnActivateAjaxBehavior by default

newOnActivatingAjaxBehavior

protected com.googlecode.wicket.jquery.core.ajax.JQueryAjaxBehavior newOnActivatingAjaxBehavior(com.googlecode.wicket.jquery.core.ajax.IJQueryAjaxAware source)

Gets a new JQueryAjaxBehavior that will be wired to the 'beforeActivate' event

Parameters:

source - the IJQueryAjaxAware

Returns:

a new OnActivateAjaxBehavior by default