<w:TabSet>

Provides a set of "tabs" which can be clicked to change what is viewed. This is a stateful component so it can remember what tab is currently selected even though the tab isn't clicked. You may determine what tab is selected externally by providing the (optional) "index" binding and setting it to one of the tabs (zero-based indexing).

An example of the usage is as follows:

<w:TabSet index="$selectedTabIndex">
    <w:Tab label="Alpha">
        This will show when Alpha is clicked
    </w:Tab>

    <w:Tab label="Beta" isVisible="$isBetaVisible">
        This will show when Beta is clicked
    </w:Tab>

    <w:Tab label="Delta">
        This will show when Delta is clicked
    </w:Tab>
</w:TabSet>

Bindings

index	The index of the currently selected tab. This will be set when the user clicks on a tab, and will be retrieved when the tabset is to be displayed again in renderResponse. By implementing the setIndex() method in your component, you may prevent the tab from changing in the event some content of the tab is invalid.	int (both)
action	Fired when tab clicked	AWResponseGenerating (get)
submitForm	If true, will respond to all clicks on tabs themselves by submitting the enclosing form. Note that, if the enclosing form tag itself has submitFormDefault=true, then this tabset will automatically submit the form -- no need to specify this binding. However, if you want to guarantee that this TabSet cannot submit its enclosing form, you can set this to false. [A rare case, indeed]	boolean (get)
class	For default style tabs this is null. For override, this specifies the CSS style to use to create the tab look ("tabWrapper" is the option defined in ariba.css).	String (get)
contentClass	If you want a box around the content of the tab, then use "tabContentWrapper".	String (get)
vertical	Render as a vertical stack	boolean (get)
actionMenuId	If specified, a type of PulldownButton will be rendered within the tab bar.	String (get)
actionMenuLabel	If actionMenuId specified, this is the label for the Actions button. Default is "Actions".	String (get)

ariba.ui.widgets
Class TabSet

java.lang.Object
  ariba.ui.aribaweb.util.AWBaseObject
      ariba.ui.aribaweb.core.AWComponent
          ariba.ui.widgets.TabSet

All Implemented Interfaces:

AWCycleable, AWCycleableReference, AWResponseGenerating, AWResponseGenerating.ResponseSubstitution, AWObject

Direct Known Subclasses:

ValidatingTabSet

public class TabSet
extends AWComponent

Nested Class Summary

Nested classes/interfaces inherited from class ariba.ui.aribaweb.core.AWComponent

AWComponent.RenderingFilter, AWComponent.RenderingListener

Nested classes/interfaces inherited from interface ariba.ui.aribaweb.core.AWResponseGenerating

AWResponseGenerating.ResponseSubstitution

Constructor Summary

TabSet()

Method Summary

AWResponseGenerating	currentTabDropAction()
java.lang.Object	currentTabDropType()
java.lang.Object	currentTabLabel()
java.lang.Object	currentTabSemanticKey()
void	init()
AWResponseGenerating	invokeAction(AWRequestContext requestContext, AWComponent component) The receiver should determine if it is the intended recipient of the current action (by checking the AWRequestContext.request() AWRequest.senderId()) and, if so, handle the action and return the result.
boolean	isStateless() Overridden by AWComponent subclasses to indicate whether component instances should be preserved with the page/session (i.e.
void	renderResponse(AWRequestContext requestContext, AWComponent component) The receiver should render its content to the AWRequestContext.response()
java.lang.Object	restoreFromBacktrackState(java.lang.Object backtrackState)
void	setSelectedTab(AWComponentReference tab)
AWComponentReference[]	tabs()

Methods inherited from class ariba.ui.aribaweb.core.AWComponent

_topLevelApplyValues, _topLevelInvokeAction, _topLevelRenderResponse, allowEmbeddedKeyPaths, allowsWhitespaceCompression, application, applyValues, awcyclePageAndLog, bindingForName, bindingForName, bindings, booleanValueForBinding, booleanValueForBinding, booleanValueForBinding, booleanValueForBinding, browserMaxWidth, browserMinWidth, characterEncoding, clearValidationError, clientTimeZone, componentConfiguration, componentDefinition, componentPath, componentReference, createPageWithName, defaultTemplateParser, determineInstance, determineInstance, dict, dict, dict, doubleValueForBinding, doubleValueForBinding, doubleValueForBinding, encodedStringValueForBinding, encodedStringValueForBinding, ensureAwake, ensureFieldValuesClear, env, errorManager, escapeAttribute, escapeString, escapeUnsafeString, extendedFields, formValueManager, generateResponse, generateResponse, generateResponse, generateStringContents, getAWParameter, getDrivingBusinessObject, getFoldInSituOnWindowSizeParam, getPageRenderVersion, getThis, hasBinding, hasBinding, hasContentForTagName, hasContentNamed, hasMultipleTemplates, hasSubTemplateNamed, httpSession, init, initTemplateResourceManager, intValueForBinding, intValueForBinding, intValueForBinding, isBidirectional, isBrowserMicrosoft, isClientPanel, isMacintosh, isRenderAW5, isStrictTagNaming, isUserCommunityEnabled, isValidationEnabled, languageDirection, languageLeft, languageRight, loadTemplate, localizedJavaString, markBacktrackState, name, namePath, notifyChange, otherBindings, otherBindingsValues, page, pageComponent, pageWithClass, pageWithClass, pageWithName, pageWithName, parent, postTakeValueActions, preferredLocale, recordBacktrackState, recordBacktrackState, recordValidationError, recordValidationError, recordValidationError, recordValidationErrors, recordValidationWarning, redirectToPage, registerRenderingListener, registerXmlNodeWithName, removeBacktrackState, replacementResponse, request, requestContext, requiresPreGlidCompatibility, resourceClassName, resourceManager, response, session, session, setCharacterEncoding, setClientPanel, setClientTimeZone, setComponentConfiguration, setDefaultTemplateParser, setEnv, setPerfDestinationInfo, setPreferredLocale, setResourceManager, setTemplateParser, setupForNextCycle, setValueForBinding, setValueForBinding, setValueForBinding, setValueForBinding, setValueForBinding, setValueForBinding, shouldCachePage, shouldCloseElements, strings, stringValueForBinding, stringValueForBinding, stringValueForBinding, supportedBindingNames, template, templateName, templateParser, templateResource, templateResourceManager, truncateBacktrackState, truncateBacktrackState, urlForResourceNamed, urlForResourceNamed, urlForResourceNamed, useXmlEscaping, valueForBinding, valueForBinding, valueForBinding, xml

Methods inherited from class ariba.ui.aribaweb.util.AWBaseObject

debugString, getFieldValue, isKindOfClass, localizedJavaString, logString, logWarning, setFieldValue

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface ariba.ui.aribaweb.util.AWObject

getFieldValue, isKindOfClass, setFieldValue

Field Detail

_currentIndex

public int _currentIndex

_currentTab

public AWComponentReference _currentTab

_selectedTab

public AWComponentReference _selectedTab

Constructor Detail

TabSet

public TabSet()

Method Detail

init

public void init()

Specified by:

init in interface AWObject

Overrides:

init in class AWComponent

isStateless

public boolean isStateless()

Description copied from class: AWComponent

Overridden by AWComponent subclasses to indicate whether component instances should be preserved with the page/session (i.e. are "stateful") or can be pooled and reused for each phase of request processing (i.e. are stateless) Default is to be stateless unless the component is used as the top-level (page) component.

Overrides:

isStateless in class AWComponent

tabs

public AWComponentReference[] tabs()

currentTabLabel

public java.lang.Object currentTabLabel()

currentTabSemanticKey

public java.lang.Object currentTabSemanticKey()

currentTabDropType

public java.lang.Object currentTabDropType()

currentTabDropAction

public AWResponseGenerating currentTabDropAction()

setSelectedTab

public void setSelectedTab(AWComponentReference tab)

renderResponse

public void renderResponse(AWRequestContext requestContext,
                           AWComponent component)

Description copied from interface: AWCycleable

The receiver should render its content to the AWRequestContext.response()

Specified by:

renderResponse in interface AWCycleable

Overrides:

renderResponse in class AWComponent

Parameters:

requestContext - the context for the current request.

component - the current parent component

invokeAction

public AWResponseGenerating invokeAction(AWRequestContext requestContext,
                                         AWComponent component)

Description copied from interface: AWCycleable

The receiver should determine if it is the intended recipient of the current action (by checking the AWRequestContext.request() AWRequest.senderId()) and, if so, handle the action and return the result.

Specified by:

invokeAction in interface AWCycleable

Overrides:

invokeAction in class AWComponent

Parameters:

requestContext - the context for the current request.

component - the current parent component

Returns:

the response for the action

restoreFromBacktrackState

public java.lang.Object restoreFromBacktrackState(java.lang.Object backtrackState)

Overrides:

restoreFromBacktrackState in class AWComponent