org.hippoecm.frontend.plugins.standards.tabs

Class TabsPlugin

java.lang.Object

org.apache.wicket.Component

org.apache.wicket.MarkupContainer

org.apache.wicket.markup.html.WebMarkupContainer

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

org.hippoecm.frontend.service.render.AbstractRenderService<T>

org.hippoecm.frontend.service.render.RenderService<T>

org.hippoecm.frontend.service.render.RenderPlugin

org.hippoecm.frontend.plugins.standards.tabs.TabsPlugin

All Implemented Interfaces:

Serializable, Iterable<org.apache.wicket.Component>, EventListener, 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, IObserver, IPlugin, IRenderService

public class TabsPlugin
extends RenderPlugin

Plugin that manages a number of IRenderServices using a tabbing interface.

Configuration:

• title.maxlength
  The maximum length (in characters) of the title. When exceeded, the title will be shown truncated with ellipses. The title attribute will contain the full title.
• icon.size
  The size of the icon in the tab. Can be one of the IconSize sizes. By default, 'm' will be used.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	TabsPlugin.Tab

Nested classes/interfaces inherited from class org.hippoecm.frontend.service.render.RenderService

RenderService.ExtensionPoint

Field Summary

Fields

Modifier and Type	Field and Description
static String	MAX_TAB_TITLE_LENGTH
static String	TAB_ICON_SIZE
static String	TAB_ID

Fields inherited from class org.hippoecm.frontend.service.render.AbstractRenderService

BEHAVIOR, children, CSS_ID, DEFAULT_LOCALE, EXTENSIONS_ID, FEEDBACK, MODEL_ID, SKIN_ID, VARIANT_ID, VISIBLE, WICKET_ID

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

Fields inherited from interface org.hippoecm.frontend.plugin.IPlugin

CLASSNAME

Constructor Summary

Constructors

Constructor and Description
TabsPlugin(IPluginContext context, IPluginConfig properties)

Method Summary

Modifier and Type	Method and Description
void	blurTabs()
void	disableTabRefocus()
void	focus(IRenderService child) Set focus on the specified child.
void	focusRecentTab()
void	focusRecentTabUnlessHidden()
protected TabbedPanel	getTabbedPanel()
String	getVariation()
boolean	hasOpenTabs()
void	hide()
protected TabbedPanel	newTabbedPanel(String id, List<TabsPlugin.Tab> tabs, org.apache.wicket.MarkupContainer tabsContainer)
void	onDetach()
protected void	onSelectTab(int index) Template method for subclasses.
protected void	onTabActivated(TabsPlugin.Tab tab)
protected void	onTabDeactivated(TabsPlugin.Tab tab)
void	render(PluginRequestTarget target) Called after user events and JCR events have been handled, but before the rendering has started.
void	renderHead(org.apache.wicket.markup.head.IHeaderResponse response)
void	show() Deprecated. use focusRecentTab() or focusRecentTabUnlessHidden() instead.

Methods inherited from class org.hippoecm.frontend.service.render.RenderPlugin

newPlugin, newPlugin, onStart, onStop, start, stop

Methods inherited from class org.hippoecm.frontend.service.render.RenderService

createExtensionPoint

Methods inherited from class org.hippoecm.frontend.service.render.AbstractRenderService

addExtensionPoint, bind, getBundleName, getComponent, getDialogService, getId, getMarkupId, getModel, getModelObject, getObservable, getParentService, getPluginConfig, getPluginContext, getResourceBundleModel, getSession, isActive, onAfterRender, onBeforeRender, onComponentTag, onComponentTagBody, onEvent, redraw, removeExtensionPoint, setDefaultModel, setModel, setModelObject, unbind, updateModel

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

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, addOrReplace, autoAdd, contains, get, get, getAssociatedMarkup, getAssociatedMarkupStream, getMarkup, getMarkupType, internalAdd, internalInitialize, iterator, iterator, onAfterRenderChildren, onRender, remove, remove, removeAll, renderAll, renderAssociatedMarkup, renderNext, replace, 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, getInnermostModel, getInnermostModel, getLocale, getLocalizer, getMarkup, getMarkupAttributes, getMarkupId, getMarkupIdFromMarkup, getMarkupIdImpl, getMarkupSourcingStrategy, getMetaData, getModelComparator, getOutputMarkupId, getOutputMarkupPlaceholderTag, getPage, getPageRelativePath, getParent, getPath, getRenderBodyOnly, getRequest, getRequestCycle, getRequestFlag, getResponse, getSizeInBytes, getStatelessHint, getString, getString, getString, getStyle, hasBeenRendered, hasErrorMessage, hasFeedbackMessage, info, initModel, internalOnModelChanged, internalPrepareForRender, internalRenderComponent, isActionAuthorized, isAuto, isBehaviorAccepted, isEnableAllowed, isEnabled, isEnabledInHierarchy, isIgnoreAttributeModifier, isRenderAllowed, isRendering, isStateless, isVersioned, isVisibilityAllowed, isVisible, isVisibleInHierarchy, markRendering, modelChanged, modelChanging, onConfigure, onEvent, onInitialize, 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 java.lang.Iterable

forEach, spliterator

Field Detail

TAB_ID

public static final String TAB_ID

See Also:

Constant Field Values

MAX_TAB_TITLE_LENGTH

public static final String MAX_TAB_TITLE_LENGTH

See Also:

Constant Field Values

TAB_ICON_SIZE

public static final String TAB_ICON_SIZE

See Also:

Constant Field Values

Constructor Detail

TabsPlugin

public TabsPlugin(IPluginContext context,
                  IPluginConfig properties)

Method Detail

newTabbedPanel

protected TabbedPanel newTabbedPanel(String id,
                                     List<TabsPlugin.Tab> tabs,
                                     org.apache.wicket.MarkupContainer tabsContainer)

renderHead

public void renderHead(org.apache.wicket.markup.head.IHeaderResponse response)

Specified by:

renderHead in interface org.apache.wicket.markup.html.IHeaderContributor

Overrides:

renderHead in class org.apache.wicket.Component

render

public void render(PluginRequestTarget target)

Description copied from class: AbstractRenderService

Called after user events and JCR events have been handled, but before the rendering has started. Plugins can register Components with the request target to enlist in the rendering phase.

Implementations that use extensions must call the same method on those.

Specified by:

render in interface IRenderService

Overrides:

render in class RenderPlugin

focus

public void focus(IRenderService child)

Description copied from class: AbstractRenderService

Set focus on the specified child. Implementations should make the child visible when they themselves are visible, or become visible later.

Specified by:

focus in interface IRenderService

Overrides:

focus in class AbstractRenderService

Parameters:

child - The extension that requests focus. This parameter can be null, in which case the Component should set focus to itself.

onDetach

public void onDetach()

Overrides:

onDetach in class org.apache.wicket.Component

getVariation

public String getVariation()

Overrides:

getVariation in class AbstractRenderService

hasOpenTabs

public boolean hasOpenTabs()

onSelectTab

protected void onSelectTab(int index)

Template method for subclasses. Called when a tab is selected, either explicitly (user clicks tab) or implicitly (tab requests focus).

Parameters:

index - Index of the tab

hide

public void hide()

blurTabs

public void blurTabs()

disableTabRefocus

public void disableTabRefocus()

show

@Deprecated
public void show()

Deprecated. use focusRecentTab() or focusRecentTabUnlessHidden() instead.

focusRecentTabUnlessHidden

public void focusRecentTabUnlessHidden()

focusRecentTab

public void focusRecentTab()

getTabbedPanel

protected final TabbedPanel getTabbedPanel()

onTabActivated

protected void onTabActivated(TabsPlugin.Tab tab)

onTabDeactivated

protected void onTabDeactivated(TabsPlugin.Tab tab)