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

Class TabbedPanel

java.lang.Object

org.apache.wicket.Component

org.apache.wicket.MarkupContainer

org.apache.wicket.markup.html.WebMarkupContainer

org.apache.wicket.markup.html.panel.Panel

com.googlecode.wicket.jquery.core.JQueryPanel

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

All Implemented Interfaces:

IJQueryWidget, java.io.Serializable, java.lang.Iterable<org.apache.wicket.Component>, org.apache.wicket.event.IEventSink, org.apache.wicket.event.IEventSource, org.apache.wicket.IConverterLocator, org.apache.wicket.markup.html.IHeaderContributor, org.apache.wicket.request.component.IRequestableComponent, org.apache.wicket.util.IHierarchical<org.apache.wicket.Component>, org.apache.wicket.util.io.IClusterable

public class TabbedPanel
extends JQueryPanel

Provides jQuery tabs based on a JQueryPanel

Author:

Sebastien Briquet - sebfz1

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface com.googlecode.wicket.jquery.core.IJQueryWidget

IJQueryWidget.JQueryWidget

Field Summary

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

options

Fields inherited from class org.apache.wicket.markup.html.panel.Panel

PANEL

Fields inherited from class org.apache.wicket.Component

ENABLE, FLAG_INITIALIZED, FLAG_REMOVING_FROM_HIERARCHY, FLAG_RESERVED1, FLAG_RESERVED2, FLAG_RESERVED3, FLAG_RESERVED4, FLAG_RESERVED5, FLAG_RESERVED8, PARENT_PATH, PATH_SEPARATOR, RENDER

Constructor Summary

Constructors

Constructor and Description
TabbedPanel(java.lang.String id, org.apache.wicket.model.IModel<java.util.List<org.apache.wicket.extensions.markup.html.tabs.ITab>> model, Options options) Constructor
TabbedPanel(java.lang.String id, java.util.List<org.apache.wicket.extensions.markup.html.tabs.ITab> tabs) Constructor
TabbedPanel(java.lang.String id, java.util.List<org.apache.wicket.extensions.markup.html.tabs.ITab> tabs, Options options) Constructor

Method Summary

Methods

Modifier and Type	Method and Description
boolean	add(org.apache.wicket.extensions.markup.html.tabs.ITab tab) Helper method.
java.util.List<org.apache.wicket.extensions.markup.html.tabs.ITab>	getModelObject()
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 org.apache.wicket.markup.html.basic.Label	newTitleLabel(java.lang.String id, org.apache.wicket.model.IModel<java.lang.String> title) Gets a new Label for the tab's title
TabsBehavior	newWidgetBehavior(java.lang.String selector)
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).
protected void	onInitialize()
TabbedPanel	setActiveTab(int index) Activates the selected tab
void	setActiveTab(int index, org.apache.wicket.ajax.AjaxRequestTarget target) Activates the selected tab Warning: invoking this method results to a dual client-server round-trip.

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

onBeforeRender, onConfigure

Methods inherited from class org.apache.wicket.markup.html.panel.Panel

newMarkupSourcingStrategy

Methods inherited from class org.apache.wicket.markup.html.WebMarkupContainer

getWebPage, getWebRequest, getWebResponse, getWebSession

Methods inherited from class org.apache.wicket.MarkupContainer

add, addOrReplace, autoAdd, contains, get, get, getAssociatedMarkup, getAssociatedMarkupStream, getMarkup, getMarkupType, internalAdd, internalInitialize, iterator, iterator, onAfterRenderChildren, onComponentTagBody, onRender, remove, remove, removeAll, renderAll, renderAssociatedMarkup, renderNext, replace, setDefaultModel, size, swap, toString, toString, visitChildren, visitChildren, visitChildren, visitChildren

Methods inherited from class org.apache.wicket.Component

add, addStateChange, afterRender, beforeRender, canCallListenerInterface, checkComponentTag, checkComponentTagAttribute, checkHierarchyChange, clearOriginalDestination, configure, continueToOriginalDestination, debug, detach, detachModel, detachModels, determineVisibility, error, exceptionMessage, fatal, findMarkupStream, findPage, findParent, findParentWithAssociatedMarkup, getAjaxRegionMarkupId, getApplication, getBehaviorById, getBehaviorId, getBehaviors, getBehaviors, getClassRelativePath, getConverter, getDefaultModel, getDefaultModelObject, getDefaultModelObjectAsString, getDefaultModelObjectAsString, getEscapeModelStrings, getFeedbackMessages, getFlag, getId, getInnermostModel, getInnermostModel, getLocale, getLocalizer, getMarkup, getMarkupAttributes, getMarkupId, getMarkupId, getMarkupIdFromMarkup, getMarkupIdImpl, getMarkupSourcingStrategy, getMetaData, getModelComparator, getOutputMarkupId, getOutputMarkupPlaceholderTag, getPage, getPageRelativePath, getParent, getPath, getRenderBodyOnly, getRequest, getRequestCycle, getRequestFlag, getResponse, getSession, getSizeInBytes, getStatelessHint, getString, getString, getString, getStyle, getVariation, hasBeenRendered, hasErrorMessage, hasFeedbackMessage, info, initModel, internalOnModelChanged, internalPrepareForRender, internalRenderComponent, isActionAuthorized, isAuto, isBehaviorAccepted, isEnableAllowed, isEnabled, isEnabledInHierarchy, isIgnoreAttributeModifier, isRenderAllowed, isStateless, isVersioned, isVisibilityAllowed, isVisible, isVisibleInHierarchy, markRendering, modelChanged, modelChanging, onAfterRender, onBeforeRender, onComponentTag, onConfigure, onDetach, onEvent, onModelChanged, onModelChanging, onReAdd, onRemove, prepareForRender, redirectToInterceptPage, remove, remove, render, renderComponentTag, rendered, renderHead, renderHead, renderHead, renderPlaceholderTag, replaceComponentTagBody, replaceWith, sameInnermostModel, sameInnermostModel, send, setAuto, setDefaultModelObject, setEnabled, setEscapeModelStrings, setFlag, setIgnoreAttributeModifier, setMarkup, setMarkupId, setMarkupIdImpl, setMetaData, setOutputMarkupId, setOutputMarkupPlaceholderTag, setParent, setRenderBodyOnly, setRequestFlag, setResponsePage, setResponsePage, setResponsePage, setVersioned, setVisibilityAllowed, setVisible, success, urlFor, urlFor, urlFor, urlFor, urlFor, visitParents, visitParents, warn, wrap

Methods inherited from class java.lang.Object

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

Constructor Detail

TabbedPanel

public TabbedPanel(java.lang.String id,
           java.util.List<org.apache.wicket.extensions.markup.html.tabs.ITab> tabs)

Constructor

Parameters:

id - the markup id

tabs - the list of ITabs

TabbedPanel

public TabbedPanel(java.lang.String id,
           java.util.List<org.apache.wicket.extensions.markup.html.tabs.ITab> tabs,
           Options options)

Constructor

Parameters:

id - the markup id

tabs - the list of ITabs

options - Options

TabbedPanel

public TabbedPanel(java.lang.String id,
           org.apache.wicket.model.IModel<java.util.List<org.apache.wicket.extensions.markup.html.tabs.ITab>> model,
           Options options)

Constructor

Parameters:

id - the markup id

model - the list model of ITabs

options - Options

Method Detail

getModelObject

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

setActiveTab

public TabbedPanel setActiveTab(int index)

Activates the selected tab

Parameters:

index - the tab's index to activate

Returns:

this, for chaining

setActiveTab

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

Activates the selected tab
Warning: invoking this method results to a dual client-server round-trip. Use this method if you cannot use setActiveTab(int) followed by target.add(myTabbedPannel)

Parameters:

target - the AjaxRequestTarget

index - the tab's index to activate

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

add

public boolean add(org.apache.wicket.extensions.markup.html.tabs.ITab tab)

Helper method. Adds an ITab to the list of tabs.

Parameters:

tab - the ITab to be added

Returns:

true (as specified by Collection.add)

onInitialize

protected void onInitialize()

Overrides:

onInitialize in class org.apache.wicket.Component

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

newTitleLabel

protected org.apache.wicket.markup.html.basic.Label newTitleLabel(java.lang.String id,
                                                      org.apache.wicket.model.IModel<java.lang.String> title)

Gets a new Label for the tab's title

Parameters:

id - the markup id

title - the tab's title model

Returns:

a new Label

newWidgetBehavior

public TabsBehavior newWidgetBehavior(java.lang.String selector)

Specified by:

newWidgetBehavior in interface IJQueryWidget