public class Tabs extends org.apache.wicket.markup.html.WebMarkupContainer implements IWiQueryPlugin
Create a tab panel.
| Modifier and Type | Field and Description |
|---|---|
static String |
UI_INDEX
Properties on the ui parameter (use it into callback functions) :
zero-based index of the selected tab
|
static String |
UI_PANEL
Properties on the ui parameter (use it into callback functions) :
element, that contains the selected tab contents
|
static String |
UI_TAB
Properties on the ui parameter (use it into callback functions) :
anchor element of the selected tab
|
| Constructor and Description |
|---|
Tabs(String id)
Builds a new tabs container with the given wicket id.
|
| Modifier and Type | Method and Description |
|---|---|
JsStatement |
abort()
Method to terminate all running tab ajax requests and animations
This will return the element back to its pre-init state.
|
void |
abort(org.apache.wicket.ajax.AjaxRequestTarget ajaxRequestTarget)
Method to terminate all running tab ajax requests and animations within
the ajax request
|
void |
add(org.apache.wicket.ajax.AjaxRequestTarget ajaxRequestTarget,
int index,
String title,
org.apache.wicket.Component contentToAdd)
Add the given component in the tab
panel.
|
void |
add(org.apache.wicket.ajax.AjaxRequestTarget ajaxRequestTarget,
String title,
org.apache.wicket.Component contentToAdd)
Add the given component in the tab
panel.
|
void |
add(org.apache.wicket.ajax.AjaxRequestTarget ajaxRequestTarget,
String url,
String label)
Method to add a new tab within the ajax request
|
void |
add(org.apache.wicket.ajax.AjaxRequestTarget ajaxRequestTarget,
String url,
String label,
int index)
Method to add a new tab within the ajax request
|
JsStatement |
add(int index,
String title,
org.apache.wicket.Component contentToAdd)
Returns the
JsStatement to add the given component in the tab
panel. |
JsStatement |
add(String title,
org.apache.wicket.Component contentToAdd)
Returns the
JsStatement to add the given component at the end of
the tab panel. |
JsStatement |
add(String url,
String label)
Method to add a new tab
This will return the element back to its pre-init state.
|
JsStatement |
add(String url,
String label,
int index)
Method to add a new tab
This will return the element back to its pre-init state.
|
void |
contribute(WiQueryResourceManager wiQueryResourceManager)
Declares resources (JavaScript and CSS files) to import.
|
JsStatement |
destroy()
Method to destroy the tabs
This will return the element back to its pre-init state.
|
void |
destroy(org.apache.wicket.ajax.AjaxRequestTarget ajaxRequestTarget)
Method to destroy the tabs within the ajax request
|
protected void |
detachModel() |
JsStatement |
disable()
Method to disable the tabs
|
void |
disable(org.apache.wicket.ajax.AjaxRequestTarget ajaxRequestTarget)
Method to disable the tabs within the ajax request
|
void |
disable(org.apache.wicket.ajax.AjaxRequestTarget ajaxRequestTarget,
int index)
Method to disable a tab within the ajax request
|
JsStatement |
disable(int index)
Method to disable a tab
|
JsStatement |
enable()
Method to enable the tabs
|
void |
enable(org.apache.wicket.ajax.AjaxRequestTarget ajaxRequestTarget)
Method to enable the tabs within the ajax request
|
void |
enable(org.apache.wicket.ajax.AjaxRequestTarget ajaxRequestTarget,
int index)
Method to enable a tab within the ajax request
|
JsStatement |
enable(int index)
Method to enable a tab
|
JQueryAjaxOption |
getAjaxOptions() |
JQueryCookieOption |
getCookie() |
int |
getDefaultSelectedTabIndex()
Returns the which tab is selected by default.
|
ICollectionItemOptions |
getDisabled() |
EventLabelOptions |
getEvent() |
ICollectionItemOptions |
getFx() |
String |
getIdPrefix() |
protected Options |
getOptions()
Method retrieving the options of the component
|
String |
getPanelTemplate() |
String |
getSpinner() |
String |
getTabTemplate() |
boolean |
isCache() |
boolean |
isCollapsible() |
boolean |
isDisabled() |
JsStatement |
length()
Method retrieving the number of tabs of the first matched tab pane
|
void |
load(org.apache.wicket.ajax.AjaxRequestTarget ajaxRequestTarget,
int index)
Method to reload the content of an Ajax tab programmatically within the ajax request
|
JsStatement |
load(int index)
Method to reload the content of an Ajax tab programmatically
|
void |
remove(org.apache.wicket.ajax.AjaxRequestTarget ajaxRequestTarget,
int index)
Method to remove a tab within the ajax request
|
JsStatement |
remove(int index)
Returns the
JsStatement to remove the tab at the given index. |
void |
rotate(org.apache.wicket.ajax.AjaxRequestTarget ajaxRequestTarget,
int ms)
Method to set up an automatic rotation through tabs of a tab pane within
the ajax request
|
void |
rotate(org.apache.wicket.ajax.AjaxRequestTarget ajaxRequestTarget,
int ms,
boolean continuing)
Method to set up an automatic rotation through tabs of a tab pane within
the ajax request
|
JsStatement |
rotate(int ms)
Method to set up an automatic rotation through tabs of a tab pane
|
JsStatement |
rotate(int ms,
boolean continuing)
Method to set up an automatic rotation through tabs of a tab pane
|
void |
select(org.apache.wicket.ajax.AjaxRequestTarget ajaxRequestTarget,
int index)
Method to select a tab within the ajax request
|
JsStatement |
select(int index)
Method to select a tab
|
Tabs |
setAddEvent(JsScopeUiEvent add)
Set the callback when a tab is added
|
Tabs |
setAjaxOptions(JQueryAjaxOption ajaxOptions)
Additional Ajax options to consider when loading tab content (see $.ajax).
|
Tabs |
setCache(boolean cache)
Whether or not to cache remote tabs content, e.g.
|
Tabs |
setCollapsible(boolean collapsible)
Set to true to allow an already selected tab to become unselected again
upon reselection.
|
Tabs |
setCookie(JQueryCookieOption cookie)
Method to store the latest selected tab in a cookie.
|
Tabs |
setDefaultSelectedTabIndex(int selectedTabIndex)
Sets which tab is displayed.
|
Tabs |
setDisabled(ArrayItemOptions<IntegerItemOptions> disabled)
Set an array containing the position of the tabs (zero-based index) that
should be disabled on initialization
|
Tabs |
setDisabled(boolean disabled)
Disables (true) or enables (false) the tabs.
|
Tabs |
setDisableEvent(JsScopeUiEvent disable)
Set the callback when a tab is disabled
|
Tabs |
setEnableEvent(JsScopeUiEvent enable)
Set the callback when a tab is enabled
|
Tabs |
setEvent(EventLabelOptions event)
Set the type of event to be used for selecting a tab
|
Tabs |
setFx(ListItemOptions<IListItemOption> fx)
Enable animations for hiding and showing tab panels.
|
Tabs |
setIdPrefix(String idPrefix)
If the remote tab, its anchor element that is, has no title attribute to
generate an id from, an id/fragment identifier is created from this
prefix and a unique id returned by $.data(el), for example "ui-tabs-54".
|
Tabs |
setLoadEvent(JsScopeUiEvent load)
Set the callback when the content of a remote tab has been loaded
|
Tabs |
setPanelTemplate(String panelTemplate)
Set the HTML template from which a new tab panel is created in case of
adding a tab with the add method or when creating a panel for a remote
tab on the fly.
|
Tabs |
setRemoveEvent(JsScopeUiEvent remove)
Set the callback when a tab is removed
|
Tabs |
setSelectEvent(JsScopeUiEvent select)
Set the callback when the user is clicking the tab
|
Tabs |
setShowEvent(JsScopeUiEvent show)
Set the callback when a tab is shown
|
Tabs |
setSpinner(String spinner)
Set the HTML content of this string is shown in a tab title while remote
content is loading.
|
Tabs |
setTabTemplate(String tabTemplate)
Set the HTML template from which a new tab is created and added.
|
JsStatement |
statement()
Returns the main
JsStatement used to create the plugin. |
void |
url(org.apache.wicket.ajax.AjaxRequestTarget ajaxRequestTarget,
int index,
String url)
Method to change the url from which an Ajax (remote) tab will be loaded
within the ajax request
|
JsStatement |
url(int index,
String url)
Method to change the url from which an Ajax (remote) tab will be loaded
|
JsStatement |
widget()
Method to returns the .ui-slider element
|
void |
widget(org.apache.wicket.ajax.AjaxRequestTarget ajaxRequestTarget)
Method to returns the .ui-slider element within the ajax request
|
getMarkupType, getWebPage, getWebRequestadd, addOrReplace, autoAdd, autoAdd, contains, findMarkupStream, get, get, getAssociatedMarkupStream, getMarkupStream, hasAssociatedMarkup, internalAdd, isTransparentResolver, iterator, iterator, newMarkupResourceStream, onAfterRenderChildren, onComponentTagBody, onRender, remove, remove, removeAll, renderAll, renderAssociatedMarkup, renderComponentTagBody, renderNext, replace, setDefaultModel, setMarkupStream, size, swap, toString, toString, visitChildren, visitChildrenadd, addStateChange, afterRender, beforeRender, callOnBeforeRenderIfNotVisible, checkComponentTag, checkComponentTagAttribute, checkHierarchyChange, configure, continueToOriginalDestination, debug, detach, detachBehaviors, detachModels, determineVisibility, error, exceptionMessage, fatal, findPage, findParent, findParentWithAssociatedMarkup, getAjaxRegionMarkupId, getApplication, getBehaviors, getBehaviors, getBehaviorsRawList, getClassRelativePath, getComponentBorder, getConverter, getConverter, getDefaultModel, getDefaultModelObject, getDefaultModelObjectAsString, getDefaultModelObjectAsString, getEscapeModelStrings, getFeedbackMessage, getFlag, getFlag, getId, getInnermostModel, getInnermostModel, getLocale, getLocalizer, getMarkupAttributes, getMarkupId, getMarkupId, getMarkupIdImpl, getMetaData, getModelComparator, getOutputMarkupId, getOutputMarkupPlaceholderTag, getPage, 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, isEnabledInHierarchy, isIgnoreAttributeModifier, isRenderAllowed, isStateless, isVersioned, isVisibilityAllowed, isVisible, isVisibleInHierarchy, locateMarkupStream, markAttached, markRendering, modelChanged, modelChanging, onAfterRender, onAttach, onBeforeRender, onBeginRequest, onComponentTag, onConfigure, onDetach, onEndRequest, onInitialize, onModelChanged, onModelChanging, onRemove, prepareForRender, prepareForRender, redirectToInterceptPage, remove, remove, render, render, renderComponent, renderComponent, renderComponentTag, rendered, renderHead, renderPlaceholderTag, replaceComponentTagBody, replaceWith, sameInnermostModel, sameInnermostModel, setAuto, setComponentBorder, setDefaultModelObject, setEnabled, setEscapeModelStrings, setFlag, setFlag, setIgnoreAttributeModifier, setMarkupId, setMarkupIdImpl, setMetaData, setOutputMarkupId, setOutputMarkupPlaceholderTag, setRedirect, setRenderBodyOnly, setResponsePage, setResponsePage, setResponsePage, setVersioned, setVisibilityAllowed, setVisible, urlFor, urlFor, urlFor, urlFor, urlFor, urlFor, visitParents, warn, wrappublic static final String UI_TAB
public static final String UI_PANEL
public static final String UI_INDEX
public Tabs(String id)
protected void detachModel()
detachModel in class org.apache.wicket.Componentpublic void contribute(WiQueryResourceManager wiQueryResourceManager)
contribute in interface IWiQueryPluginwiQueryResourceManager - The WiQueryResourceManager instance managing this
component resources.IWiQueryPlugin.contribute(org.odlabs.wiquery.core.commons.WiQueryResourceManager)public JsStatement statement()
IWiQueryPluginJsStatement used to create the plugin.statement in interface IWiQueryPluginJsStatement corresponding to this component.protected Options getOptions()
public Tabs setAjaxOptions(JQueryAjaxOption ajaxOptions)
ajaxOptions - public JQueryAjaxOption getAjaxOptions()
public Tabs setCookie(JQueryCookieOption cookie)
cookie - public JQueryCookieOption getCookie()
public Tabs setCache(boolean cache)
cache - public boolean isCache()
public Tabs setCollapsible(boolean collapsible)
collapsible - public boolean isCollapsible()
public Tabs setDefaultSelectedTabIndex(int selectedTabIndex)
public int getDefaultSelectedTabIndex()
public Tabs setDisabled(boolean disabled)
disabled - public boolean isDisabled()
public Tabs setDisabled(ArrayItemOptions<IntegerItemOptions> disabled)
disabled - public ICollectionItemOptions getDisabled()
public Tabs setEvent(EventLabelOptions event)
event - public EventLabelOptions getEvent()
public Tabs setFx(ListItemOptions<IListItemOption> fx)
fx - public ICollectionItemOptions getFx()
public Tabs setIdPrefix(String idPrefix)
idPrefix - public String getIdPrefix()
public Tabs setPanelTemplate(String panelTemplate)
panelTemplate - public String getPanelTemplate()
public Tabs setSpinner(String spinner)
spinner - public String getSpinner()
public Tabs setTabTemplate(String tabTemplate)
tabTemplate - public String getTabTemplate()
public Tabs setAddEvent(JsScopeUiEvent add)
add - public Tabs setDisableEvent(JsScopeUiEvent disable)
disable - public Tabs setEnableEvent(JsScopeUiEvent enable)
enable - public Tabs setLoadEvent(JsScopeUiEvent load)
load - public Tabs setRemoveEvent(JsScopeUiEvent remove)
remove - public Tabs setSelectEvent(JsScopeUiEvent select)
select - public Tabs setShowEvent(JsScopeUiEvent show)
show - public JsStatement add(int index, String title, org.apache.wicket.Component contentToAdd)
JsStatement to add the given component in the tab
panel.index - the insertion index.title - the tab title.contentToAdd - the Component to add.JsStatement.public void add(org.apache.wicket.ajax.AjaxRequestTarget ajaxRequestTarget,
int index,
String title,
org.apache.wicket.Component contentToAdd)
ajaxRequestTarget - index - the insertion index.title - the tab title.contentToAdd - the Component to add.public JsStatement add(String title, org.apache.wicket.Component contentToAdd)
JsStatement to add the given component at the end of
the tab panel.title - the tab title.contentToAdd - the Component to add.JsStatement.public void add(org.apache.wicket.ajax.AjaxRequestTarget ajaxRequestTarget,
String title,
org.apache.wicket.Component contentToAdd)
ajaxRequestTarget - title - the tab title.contentToAdd - the Component to add.public JsStatement add(String url, String label)
url - URLlabel - Label of the tabpublic void add(org.apache.wicket.ajax.AjaxRequestTarget ajaxRequestTarget,
String url,
String label)
ajaxRequestTarget - url - URLlabel - Label of the tabpublic JsStatement add(String url, String label, int index)
url - URLlabel - Label of the tabindex - Index of insertionpublic void add(org.apache.wicket.ajax.AjaxRequestTarget ajaxRequestTarget,
String url,
String label,
int index)
ajaxRequestTarget - url - URLlabel - Label of the tabindex - Index of insertionpublic JsStatement abort()
public void abort(org.apache.wicket.ajax.AjaxRequestTarget ajaxRequestTarget)
ajaxRequestTarget - public JsStatement destroy()
public void destroy(org.apache.wicket.ajax.AjaxRequestTarget ajaxRequestTarget)
ajaxRequestTarget - public JsStatement disable()
public void disable(org.apache.wicket.ajax.AjaxRequestTarget ajaxRequestTarget)
ajaxRequestTarget - public JsStatement disable(int index)
index - Index tab to disablepublic void disable(org.apache.wicket.ajax.AjaxRequestTarget ajaxRequestTarget,
int index)
index - Index tab to disableajaxRequestTarget - public JsStatement enable()
public void enable(org.apache.wicket.ajax.AjaxRequestTarget ajaxRequestTarget)
ajaxRequestTarget - public JsStatement enable(int index)
index - Index tab to enablepublic void enable(org.apache.wicket.ajax.AjaxRequestTarget ajaxRequestTarget,
int index)
index - Index tab to enableajaxRequestTarget - public JsStatement length()
public JsStatement load(int index)
index - Index tab to selectpublic void load(org.apache.wicket.ajax.AjaxRequestTarget ajaxRequestTarget,
int index)
index - Index tab to selectajaxRequestTarget - public JsStatement remove(int index)
JsStatement to remove the tab at the given index.index - the remove index.JsStatement.public void remove(org.apache.wicket.ajax.AjaxRequestTarget ajaxRequestTarget,
int index)
index - the remove indexajaxRequestTarget - public JsStatement rotate(int ms)
ms - Amount of time in millisecondspublic void rotate(org.apache.wicket.ajax.AjaxRequestTarget ajaxRequestTarget,
int ms)
ms - Amount of time in millisecondsajaxRequestTarget - public JsStatement rotate(int ms, boolean continuing)
ms - Amount of time in millisecondscontinuing - Continue the rotation after a tab has been selected by a userpublic void rotate(org.apache.wicket.ajax.AjaxRequestTarget ajaxRequestTarget,
int ms,
boolean continuing)
ms - Amount of time in millisecondscontinuing - Continue the rotation after a tab has been selected by a userajaxRequestTarget - public JsStatement select(int index)
index - Index tab to selectpublic void select(org.apache.wicket.ajax.AjaxRequestTarget ajaxRequestTarget,
int index)
index - Index tab to selectajaxRequestTarget - public JsStatement url(int index, String url)
index - Index tab to selecturl - URLpublic void url(org.apache.wicket.ajax.AjaxRequestTarget ajaxRequestTarget,
int index,
String url)
index - Index tab to selecturl - URLajaxRequestTarget - public JsStatement widget()
public void widget(org.apache.wicket.ajax.AjaxRequestTarget ajaxRequestTarget)
ajaxRequestTarget - Copyright © 2009-2012. All Rights Reserved.