de.alpharogroup.wicket.components.ajax.editable.tabs

Class AjaxCloseableTabbedPanel<T extends ICloseableTab>

java.lang.Object

org.apache.wicket.Component

org.apache.wicket.MarkupContainer

org.apache.wicket.markup.html.WebMarkupContainer

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

de.alpharogroup.wicket.components.ajax.editable.tabs.AjaxCloseableTabbedPanel<T>

Type Parameters:

T - the generic type

All Implemented Interfaces:

Serializable, Iterable<org.apache.wicket.Component>, org.apache.wicket.event.IEventSink, org.apache.wicket.event.IEventSource, org.apache.wicket.IConverterLocator, 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 AjaxCloseableTabbedPanel<T extends ICloseableTab>
extends org.apache.wicket.markup.html.panel.Panel

The Class AjaxCloseableTabbedPanel adds functionality to add or remove tabs from the TabbedPanel.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static String	TAB_PANEL_ID id used for child panels

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
AjaxCloseableTabbedPanel(String id, List<T> tabs) Instantiates a new AjaxCloseableTabbedPanel.
AjaxCloseableTabbedPanel(String id, List<T> tabs, org.apache.wicket.model.IModel<Integer> model) Instantiates a new AjaxCloseableTabbedPanel.

Method Summary

Modifier and Type	Method and Description
protected String	getLastTabCssClass() Get the css class of the last tab.
int	getSelectedTab() Get the selected tab.
protected String	getSelectedTabCssClass() Get the css class of the selected tab.
protected String	getTabContainerCssClass() Get the css class of the tab container.
List<T>	getTabs() Gets the list of tabs that can be used by the user to add/remove/reorder tabs in the panel.
protected org.apache.wicket.model.IModel<?>	initModel() Override of the default initModel behaviour.
protected org.apache.wicket.markup.html.WebMarkupContainer	newCloseLink(String linkId, int index) Factory method for links used to close the selected tab.
protected org.apache.wicket.Component	newCloseTitle(String titleId, org.apache.wicket.model.IModel<?> titleModel, int index) Factory method for tab titles.
protected org.apache.wicket.markup.html.WebMarkupContainer	newLink(String linkId, int index) Factory method for links used to switch between tabs.
protected org.apache.wicket.markup.html.list.LoopItem	newTabContainer(int tabIndex) Generates a loop item used to represent a specific tab's li element.
protected org.apache.wicket.markup.html.WebMarkupContainer	newTabsContainer(String id) Generates the container for all tabs.
protected org.apache.wicket.markup.html.list.Loop	newTabsLoop(String id, org.apache.wicket.model.IModel<Integer> model) Factory method for creating a new Loop for the tabs.
protected org.apache.wicket.Component	newTitle(String titleId, org.apache.wicket.model.IModel<?> titleModel, int index) Factory method for tab titles.
protected void	onAjaxUpdate(org.apache.wicket.ajax.AjaxRequestTarget target) A template method that lets users add additional behavior when ajax update occurs.
protected void	onBeforeRender()
protected void	onDetach()
void	onNewTab(org.apache.wicket.ajax.AjaxRequestTarget target, T tab) On new tab.
void	onNewTab(org.apache.wicket.ajax.AjaxRequestTarget target, T tab, int index) On new tab.
void	onRemoveTab(org.apache.wicket.ajax.AjaxRequestTarget target, int index) On remove tab removes the tab of the given index.
void	onRemoveTab(org.apache.wicket.ajax.AjaxRequestTarget target, T tab) On remove tab removes the given tab if it does exists.
AjaxCloseableTabbedPanel<T>	setSelectedTab(int index) sets the selected tab

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, findComponentToDequeue, get, get, getAssociatedMarkup, getAssociatedMarkupStream, getMarkup, getMarkupType, internalAdd, internalInitialize, iterator, iterator, newDequeueContext, onAfterRenderChildren, onComponentTagBody, onInitialize, 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, 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, internalOnModelChanged, internalPrepareForRender, internalRenderComponent, internalRenderHead, isActionAuthorized, isAuto, isBehaviorAccepted, isEnableAllowed, isEnabled, isEnabledInHierarchy, isIgnoreAttributeModifier, isRenderAllowed, isRendering, isStateless, isVersioned, isVisibilityAllowed, isVisible, isVisibleInHierarchy, markRendering, modelChanged, modelChanging, onAfterRender, 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

Field Detail

TAB_PANEL_ID

public static final String TAB_PANEL_ID

id used for child panels

See Also:

Constant Field Values

Constructor Detail

AjaxCloseableTabbedPanel

public AjaxCloseableTabbedPanel(String id,
                                List<T> tabs)

Instantiates a new AjaxCloseableTabbedPanel.

Parameters:

id - component id

tabs - list of ITab objects used to represent tabs

AjaxCloseableTabbedPanel

public AjaxCloseableTabbedPanel(String id,
                                List<T> tabs,
                                org.apache.wicket.model.IModel<Integer> model)

Instantiates a new AjaxCloseableTabbedPanel.

Parameters:

id - component id

tabs - list of ITab objects used to represent tabs

model - model holding the index of the selected tab

Method Detail

getLastTabCssClass

protected String getLastTabCssClass()

Get the css class of the last tab.

Returns:

the value of css class attribute that will be added to last tab. The default value is last

getSelectedTab

public final int getSelectedTab()

Get the selected tab.

Returns:

index of the selected tab

getSelectedTabCssClass

protected String getSelectedTabCssClass()

Get the css class of the selected tab.

Returns:

the value of css class attribute that will be added to selected tab. The default value is selected

getTabContainerCssClass

protected String getTabContainerCssClass()

Get the css class of the tab container.

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 List<T> getTabs()

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

Returns:

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

initModel

protected org.apache.wicket.model.IModel<?> initModel()

Override of the default initModel behaviour. This component will not use any compound model of a parent.

Overrides:

initModel in class org.apache.wicket.Component

See Also:

Component.initModel()

newCloseLink

protected org.apache.wicket.markup.html.WebMarkupContainer newCloseLink(String linkId,
                                                                        int index)

Factory method for links used to close the selected tab. 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 newCloseLink(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

newCloseTitle

protected org.apache.wicket.Component newCloseTitle(String titleId,
                                                    org.apache.wicket.model.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 org.apache.wicket.markup.html.WebMarkupContainer newLink(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

newTabContainer

protected org.apache.wicket.markup.html.list.LoopItem newTabContainer(int tabIndex)

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

Parameters:

tabIndex - the tab index

Returns:

new loop item

newTabsContainer

protected org.apache.wicket.markup.html.WebMarkupContainer newTabsContainer(String id)

Generates the container for all tabs. The default container automatically adds the css class attribute based on the return value of getTabContainerCssClass()

Parameters:

id - container id

Returns:

container

newTabsLoop

protected org.apache.wicket.markup.html.list.Loop newTabsLoop(String id,
                                                              org.apache.wicket.model.IModel<Integer> model)

Factory method for creating a new Loop for the tabs.

Parameters:

id - the id

model - the model

Returns:

the new Loop for the tabs.

newTitle

protected org.apache.wicket.Component newTitle(String titleId,
                                               org.apache.wicket.model.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

onAjaxUpdate

protected void onAjaxUpdate(org.apache.wicket.ajax.AjaxRequestTarget target)

A template method that lets users add additional behavior when ajax update occurs. This method is called after the current tab has been set so access to it can be obtained via getSelectedTab().

Note Since an AjaxFallbackLink is used to back the ajax update the target argument can be null when the client browser does not support ajax and the fallback mode is used. See AjaxFallbackLink for details.

Parameters:

target - ajax target used to update this component

onBeforeRender

protected void onBeforeRender()

Overrides:

onBeforeRender in class org.apache.wicket.Component

onDetach

protected void onDetach()

Overrides:

onDetach in class org.apache.wicket.MarkupContainer

onNewTab

public void onNewTab(org.apache.wicket.ajax.AjaxRequestTarget target,
                     T tab)

On new tab.

Parameters:

target - the target

tab - the tab

onNewTab

public void onNewTab(org.apache.wicket.ajax.AjaxRequestTarget target,
                     T tab,
                     int index)

On new tab.

Parameters:

target - the target

tab - the tab

index - the index

onRemoveTab

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

On remove tab removes the tab of the given index.

Parameters:

target - the target

index - the index

onRemoveTab

public void onRemoveTab(org.apache.wicket.ajax.AjaxRequestTarget target,
                        T tab)

On remove tab removes the given tab if it does exists.

Parameters:

target - the target

tab - the tab

setSelectedTab

public AjaxCloseableTabbedPanel<T> setSelectedTab(int index)

sets the selected tab

Parameters:

index - index of the tab to select

Returns:

this for chaining

Throws:

IndexOutOfBoundsException - if index is not in the range of available tabs