org.apache.wicket.extensions.markup.html.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.WebMarkupContainerWithAssociatedMarkup
                  org.apache.wicket.markup.html.panel.Panel
                      org.apache.wicket.extensions.markup.html.tabs.TabbedPanel

All Implemented Interfaces:

java.io.Serializable, IClusterable, IConverterLocator, IHeaderPartContainerProvider

Direct Known Subclasses:

AjaxTabbedPanel

public class TabbedPanel
extends Panel

TabbedPanel component represets a panel with tabs that are used to switch between different content panels inside the TabbedPanel panel.

Note: When the currently selected tab is replaced by changing the underlying list of tabs, the change is not picked up unless a call is made to setSelectedTab(int).

Example:

 
 List tabs=new ArrayList();
 
 tabs.add(new AbstractTab(new Model("first tab")) {
 
   public Panel getPanel(String panelId)
   {
     return new TabPanel1(panelId);
   }
 
 });
 
 tabs.add(new AbstractTab(new Model("second tab")) {
 
   public Panel getPanel(String panelId)
   {
     return new TabPanel2(panelId);
   }
 
 });
 
 add(new TabbedPanel("tabs", tabs));
 
 
 <span wicket:id="tabs" class="tabpanel">[tabbed panel will be here]</span>
 
 
 

For a complete example see the component references in wicket-examples project

Author:

Igor Vaynberg (ivaynberg at apache dot org)

See Also:

ITab, Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.wicket.Component

Component.ComponentModelChange, Component.EnabledChange, Component.IVisitor, Component.VisibilityChange

Field Summary

static java.lang.String

TAB_PANEL_ID id used for child panels

Fields inherited from class org.apache.wicket.Component

ENABLE, FLAG_RESERVED1, FLAG_RESERVED2, FLAG_RESERVED3, FLAG_RESERVED4, FLAG_RESERVED5, FLAG_RESERVED6, FLAG_RESERVED7, FLAG_RESERVED8, PATH_SEPARATOR, RENDER

Constructor Summary

TabbedPanel(java.lang.String id, java.util.List tabs)
Constructor

Method Summary

int	getSelectedTab()
protected java.lang.String	getTabContainerCssClass()
java.util.List	getTabs()
protected WebMarkupContainer	newLink(java.lang.String linkId, int index) Factory method for links used to switch between tabs.
protected Loop.LoopItem	newTabContainer(int tabIndex) Generates a loop item used to represent a specific tab's li element.
protected Component	newTitle(java.lang.String titleId, IModel titleModel, int index) Factory method for tab titles.
protected void	onBeforeRender() Called just before a component is rendered.
void	setSelectedTab(int index) sets the selected tab

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

onComponentTag, onComponentTagBody, renderHead

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

newHeaderPartContainer, renderHeadFromAssociatedMarkupFile

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

getMarkupType, getWebPage

Methods inherited from class org.apache.wicket.MarkupContainer

add, addOrReplace, autoAdd, autoAdd, contains, findMarkupStream, get, getAssociatedMarkupStream, getMarkupStream, hasAssociatedMarkup, internalAdd, isTransparentResolver, iterator, iterator, newMarkupResourceStream, onRender, remove, remove, removeAll, renderAll, renderAssociatedMarkup, renderComponentTagBody, replace, setMarkupStream, setModel, size, toString, toString, visitChildren, visitChildren

Methods inherited from class org.apache.wicket.Component

add, addStateChange, afterRender, beforeRender, callOnBeforeRenderIfNotVisible, checkComponentTag, checkComponentTagAttribute, checkHierarchyChange, continueToOriginalDestination, debug, detach, detachBehaviors, detachModel, detachModels, determineVisibility, error, exceptionMessage, fatal, findPage, findParent, findParentWithAssociatedMarkup, getApplication, getBehaviors, getBehaviors, getBehaviorsRawList, getClassRelativePath, getComponentBorder, getConverter, getConverter, getEscapeModelStrings, getFeedbackMessage, getFlag, getFlag, getId, getInnermostModel, getInnermostModel, getLocale, getLocalizer, getMarkupAttributes, getMarkupId, getMarkupId, getMetaData, getModel, getModelComparator, getModelObject, getModelObjectAsString, getModelObjectAsString, getOutputMarkupId, getOutputMarkupPlaceholderTag, getPage, getPageFactory, getPageRelativePath, getParent, getPath, getRenderBodyOnly, getRequest, getRequestCycle, getResponse, getSession, getSizeInBytes, getStatelessHint, getString, getString, getString, getStyle, getVariation, hasBeenRendered, hasErrorMessage, hasFeedbackMessage, info, initModel, internalAttach, internalDetach, internalOnAttach, internalOnDetach, internalOnModelChanged, isActionAuthorized, isAncestorOf, isAttached, isBehaviorAccepted, isEnableAllowed, isEnabled, isIgnoreAttributeModifier, isRenderAllowed, isStateless, isVersioned, isVisibilityAllowed, isVisible, isVisibleInHierarchy, locateMarkupStream, markAttached, markRendering, modelChanged, modelChanging, newPage, newPage, onAfterRender, onAttach, onBeginRequest, onDetach, onEndRequest, onModelChanged, onModelChanging, prepareForRender, redirectToInterceptPage, remove, remove, render, render, renderComponent, renderComponent, renderComponentTag, rendered, replaceComponentTagBody, replaceWith, sameInnermostModel, sameInnermostModel, setAuto, setComponentBorder, setEnabled, setEscapeModelStrings, setFlag, setFlag, setIgnoreAttributeModifier, setMarkupId, setMetaData, setModelObject, setOutputMarkupId, setOutputMarkupPlaceholderTag, setRedirect, setRenderBodyOnly, setResponsePage, setResponsePage, setResponsePage, setVersioned, setVisibilityAllowed, setVisible, urlFor, urlFor, urlFor, urlFor, urlFor, urlFor, visitParents, warn, wrap

Methods inherited from class java.lang.Object

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

Field Detail

TAB_PANEL_ID

public static final java.lang.String TAB_PANEL_ID

id used for child panels

See Also:

Constant Field Values

Constructor Detail

TabbedPanel

public TabbedPanel(java.lang.String id,
                   java.util.List tabs)

Constructor

Parameters:

id - component id

tabs - list of ITab objects used to represent tabs

Method Detail

newTabContainer

protected Loop.LoopItem newTabContainer(int tabIndex)

Generates a loop item used to represent a specific tab's li element.

Parameters:

tabIndex -

Returns:

new loop item

onBeforeRender

protected void onBeforeRender()

Description copied from class: Component

Called just before a component is rendered.

NOTE* If you override this, you *must* call super.onBeforeRender() within your implementation. Because this method is responsible for cascading Component.onBeforeRender() call to its children it is strongly recommended that super call is made at the end of the override.

Overrides:

onBeforeRender in class Component

See Also:

Component.callOnBeforeRenderIfNotVisible()

getTabContainerCssClass

protected java.lang.String getTabContainerCssClass()

Returns:

the value of css class attribute that will be added to a div containing the tabs. The default value is tab-row

getTabs

public final java.util.List getTabs()

Returns:

list of tabs that can be used by the user to add/remove/reorder tabs in the panel

newTitle

protected Component newTitle(java.lang.String titleId,
                             IModel titleModel,
                             int index)

Factory method for tab titles. Returned component can be anything that can attach to span tags such as a fragment, panel, or a label

Parameters:

titleId - id of title component

titleModel - model containing tab title

index - index of tab

Returns:

title component

newLink

protected WebMarkupContainer newLink(java.lang.String linkId,
                                     int index)

Factory method for links used to switch between tabs. The created component is attached to the following markup. Label component with id: title will be added for you by the tabbed panel.

            <a href="#" wicket:id="link"><span wicket:id="title">[[tab title]]</span></a>
 

Example implementation:

 protected WebMarkupContainer newLink(String linkId, final int index)
 {
        return new Link(linkId)
        {
                private static final long serialVersionUID = 1L;
 
                public void onClick()
                {
                        setSelectedTab(index);
                }
        };
 }
 

Parameters:

linkId - component id with which the link should be created

index - index of the tab that should be activated when this link is clicked. See setSelectedTab(int).

Returns:

created link component

setSelectedTab

public void setSelectedTab(int index)

sets the selected tab

Parameters:

index - index of the tab to select

getSelectedTab

public final int getSelectedTab()

Returns:

index of the selected tab