com.googlecode.wicket.kendo.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.core.JQueryGenericPanel<List<org.apache.wicket.extensions.markup.html.tabs.ITab>>

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

All Implemented Interfaces:

com.googlecode.wicket.jquery.core.IJQueryWidget, ITabsListener, Serializable, Iterable<org.apache.wicket.Component>, org.apache.wicket.event.IEventSink, org.apache.wicket.event.IEventSource, org.apache.wicket.IConverterLocator, org.apache.wicket.IGenericComponent<List<org.apache.wicket.extensions.markup.html.tabs.ITab>>, org.apache.wicket.IQueueRegion, 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 com.googlecode.wicket.jquery.core.JQueryGenericPanel<List<org.apache.wicket.extensions.markup.html.tabs.ITab>>
implements ITabsListener

Provides Kendo UI tabs based on a JQueryGenericPanel

Since:

6.19.0, 7.0.0

Author:

Sebastien Briquet - sebfz1

See Also:

Serialized Form

Nested Class Summary

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

com.googlecode.wicket.jquery.core.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_AFTER_RENDERING, FLAG_INITIALIZED, FLAG_PREPARED_FOR_RENDER, FLAG_REMOVING_FROM_HIERARCHY, FLAG_RENDERING, FLAG_RESERVED1, FLAG_RESERVED2, FLAG_RESERVED3, FLAG_RESERVED4, FLAG_RESERVED5, FLAG_RESERVED8, PARENT_PATH, PATH_SEPARATOR, RENDER, RFLAG_CONTAINER_DEQUEING

Constructor Summary

Constructors

Constructor and Description
TabbedPanel(String id) Constructor with empty list of Tabs.
TabbedPanel(String id, org.apache.wicket.model.IModel<List<org.apache.wicket.extensions.markup.html.tabs.ITab>> model) Constructor
TabbedPanel(String id, org.apache.wicket.model.IModel<List<org.apache.wicket.extensions.markup.html.tabs.ITab>> model, com.googlecode.wicket.jquery.core.Options options) Constructor
TabbedPanel(String id, List<org.apache.wicket.extensions.markup.html.tabs.ITab> tabs) Constructor
TabbedPanel(String id, List<org.apache.wicket.extensions.markup.html.tabs.ITab> tabs, com.googlecode.wicket.jquery.core.Options options) Constructor
TabbedPanel(String id, com.googlecode.wicket.jquery.core.Options options) Constructor with empty list of Tabs.
TabbedPanel(String id, TabListModel model) Constructor
TabbedPanel(String id, TabListModel model, com.googlecode.wicket.jquery.core.Options options) Constructor

Method Summary

Modifier and Type	Method and Description
boolean	add(org.apache.wicket.extensions.markup.html.tabs.ITab tab) Helper method.
int	getLastTabIndex() Gets the last visible tab index
List<org.apache.wicket.extensions.markup.html.tabs.ITab>	getModelObject()
String	getSelector()
boolean	isActivateEventEnabled() Indicates whether the 'activate' event is enabled. If true, the ITabsListener.onActivate(AjaxRequestTarget, int, ITab) event will be triggered.
boolean	isSelectEventEnabled() Indicates whether the 'select' event is enabled. If true, the ITabsListener.onSelect(AjaxRequestTarget, int, ITab) event will be triggered.
boolean	isShowEventEnabled() Indicates whether the 'show' event is enabled. If true, the ITabsListener.onShow(AjaxRequestTarget, int, ITab) event will be triggered.
protected org.apache.wicket.Component	newTitleLabel(String id, org.apache.wicket.model.IModel<String> title) Gets a new Label for the tab's title
TabsBehavior	newWidgetBehavior(String selector)
void	onActivate(org.apache.wicket.ajax.AjaxRequestTarget target, int index, org.apache.wicket.extensions.markup.html.tabs.ITab tab) Triggered after a tab is being made visible and its animation complete
protected void	onInitialize()
void	onSelect(org.apache.wicket.ajax.AjaxRequestTarget target, int index, org.apache.wicket.extensions.markup.html.tabs.ITab tab) Triggered before a tab is selected.
void	onShow(org.apache.wicket.ajax.AjaxRequestTarget target, int index, org.apache.wicket.extensions.markup.html.tabs.ITab tab) Triggered just after a tab is being made visible, but before the end of the animation.
TabbedPanel	setTabIndex(int index) Sets the current tab index Warning: the index is relative to visible tabs only
void	setTabIndex(int index, org.apache.wicket.core.request.handler.IPartialPageRequestHandler handler) Sets and activates the current tab index Warning: invoking this method results to a dual client-server round-trip.

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

getModel, setModel, setModelObject

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

onBeforeRender, onConfigure

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

getRegionMarkup, newMarkupSourcingStrategy

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

getWebApplication, getWebPage, getWebRequest, getWebResponse, getWebSession

Methods inherited from class org.apache.wicket.MarkupContainer

add, addDequeuedComponent, addOrReplace, autoAdd, canDequeueTag, contains, dequeue, dequeue, dequeuePreamble, findChildComponent, findComponentToDequeue, get, get, getAssociatedMarkup, getAssociatedMarkupStream, getMarkup, getMarkupType, internalAdd, internalInitialize, iterator, iterator, newDequeueContext, onAfterRenderChildren, onComponentTagBody, onDetach, onRender, queue, 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, canCallListenerInterfaceAfterExpiry, checkComponentTag, checkComponentTagAttribute, checkHierarchyChange, clearOriginalDestination, configure, continueToOriginalDestination, createConverter, 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, internalRenderHead, isActionAuthorized, isAuto, isBehaviorAccepted, isEnableAllowed, isEnabled, isEnabledInHierarchy, isIgnoreAttributeModifier, isRenderAllowed, isRendering, isStateless, isVersioned, isVisibilityAllowed, isVisible, isVisibleInHierarchy, markRendering, modelChanged, modelChanging, onAfterRender, onBeforeRender, onComponentTag, onConfigure, onEvent, onModelChanged, onModelChanging, onReAdd, onRemove, prepareForRender, redirectToInterceptPage, remove, remove, render, renderComponentTag, rendered, 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

Methods inherited from interface org.apache.wicket.IQueueRegion

dequeue, newDequeueContext

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

TabbedPanel

public TabbedPanel(String id)

Constructor with empty list of Tabs.

Parameters:

id - the markup id

See Also:

add(ITab)

TabbedPanel

public TabbedPanel(String id,
                   com.googlecode.wicket.jquery.core.Options options)

Constructor with empty list of Tabs.

Parameters:

id - the markup id

options - the Options

See Also:

add(ITab)

TabbedPanel

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

Constructor

Parameters:

id - the markup id

tabs - the list of ITabs

TabbedPanel

public TabbedPanel(String id,
                   List<org.apache.wicket.extensions.markup.html.tabs.ITab> tabs,
                   com.googlecode.wicket.jquery.core.Options options)

Constructor

Parameters:

id - the markup id

tabs - the list of ITabs

options - the Options

TabbedPanel

public TabbedPanel(String id,
                   TabListModel model)

Constructor

Parameters:

id - the markup id

model - the TabListModel

TabbedPanel

public TabbedPanel(String id,
                   TabListModel model,
                   com.googlecode.wicket.jquery.core.Options options)

Constructor

Parameters:

id - the markup id

model - the TabListModel

options - the Options

TabbedPanel

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

Constructor

Parameters:

id - the markup id

model - the list model of ITabs

TabbedPanel

public TabbedPanel(String id,
                   org.apache.wicket.model.IModel<List<org.apache.wicket.extensions.markup.html.tabs.ITab>> model,
                   com.googlecode.wicket.jquery.core.Options options)

Constructor

Parameters:

id - the markup id

model - the list model of ITabs

options - the Options

Method Detail

getSelector

public String getSelector()

Specified by:

getSelector in class com.googlecode.wicket.jquery.core.JQueryGenericPanel<List<org.apache.wicket.extensions.markup.html.tabs.ITab>>

getModelObject

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

Specified by:

getModelObject in interface org.apache.wicket.IGenericComponent<List<org.apache.wicket.extensions.markup.html.tabs.ITab>>

Overrides:

getModelObject in class com.googlecode.wicket.jquery.core.JQueryGenericPanel<List<org.apache.wicket.extensions.markup.html.tabs.ITab>>

setTabIndex

public TabbedPanel setTabIndex(int index)

Sets the current tab index
Warning: the index is relative to visible tabs only

Parameters:

index - the visible tab's index to activate

Returns:

this, for chaining

setTabIndex

public void setTabIndex(int index,
                        org.apache.wicket.core.request.handler.IPartialPageRequestHandler handler)

Sets and activates the current tab index
Warning: invoking this method results to a dual client-server round-trip.

Parameters:

index - the tab's index to activate

handler - the IPartialPageRequestHandler

getLastTabIndex

public int getLastTabIndex()

Gets the last visible tab index

Returns:

the tab index, or -1 if none

isSelectEventEnabled

public boolean isSelectEventEnabled()

Description copied from interface: ITabsListener

Indicates whether the 'select' event is enabled.
If true, the ITabsListener.onSelect(AjaxRequestTarget, int, ITab) event will be triggered.

Specified by:

isSelectEventEnabled in interface ITabsListener

Returns:

true by default

isShowEventEnabled

public boolean isShowEventEnabled()

Description copied from interface: ITabsListener

Indicates whether the 'show' event is enabled.
If true, the ITabsListener.onShow(AjaxRequestTarget, int, ITab) event will be triggered.

Specified by:

isShowEventEnabled in interface ITabsListener

Returns:

false by default

isActivateEventEnabled

public boolean isActivateEventEnabled()

Description copied from interface: ITabsListener

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

Specified by:

isActivateEventEnabled in interface ITabsListener

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.MarkupContainer

onSelect

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

Description copied from interface: ITabsListener

Triggered before a tab is selected.

Specified by:

onSelect in interface ITabsListener

Parameters:

target - the AjaxRequestTarget

index - the tab index that triggered this event

tab - the ITab that corresponds to the index

See Also:

ITabsListener.isSelectEventEnabled()

onShow

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

Description copied from interface: ITabsListener

Triggered just after a tab is being made visible, but before the end of the animation.

Specified by:

onShow in interface ITabsListener

Parameters:

target - the AjaxRequestTarget

index - the tab index that triggered this event

tab - the ITab that corresponds to the index

See Also:

ITabsListener.isShowEventEnabled()

onActivate

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

Description copied from interface: ITabsListener

Triggered after a tab is being made visible and its animation complete

Specified by:

onActivate in interface ITabsListener

Parameters:

target - the AjaxRequestTarget

index - the tab index that triggered this event

tab - the ITab that corresponds to the index

See Also:

ITabsListener.isActivateEventEnabled()

newTitleLabel

protected org.apache.wicket.Component newTitleLabel(String id,
                                                    org.apache.wicket.model.IModel<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(String selector)

Specified by:

newWidgetBehavior in interface com.googlecode.wicket.jquery.core.IJQueryWidget