<w:TabList>

This is the core of the TabSet suite of components. This renders a list of overlapping tab cells with labels and, when clicked, tells the developer which tab was clicked/selected. This is not a container-type component, but can be used within container type components (such as AWXBaseTabSet) to render the tabs themselves.

Bindings

actionMenuId	Id for an action menu. If this exists, an Action Menu Button will be displayed. The button uses the optional label actionMenuLabel or "Actions" by default.	String (get)
actionMenuLabel	Optional label for the Action Menu Button.	String (get)
class	Note: it appears the value of this binding is ignored -- only used to determine if using classic look or square tabs?	String (get)
vertical	Render as a vertical stack	boolean (get)
dropType	see AWDropContainer's "type" binding.	String (get)
dropAction	see AWDropContainer's "dropAction" binding.	AWResponseGenerating (get)
list *	The list of items over which to iterate. Each item in the list represents one tab in the tabset. The items in the list may be of any type. The list itself can be any of the supported classes which has a class extension of type AWOrderedList. By default, this includes all primitive arrays, java.util.List, java.util.Vector, and all implementations of List-like classes which Ariba has implemented.	ariba.util.fieldvalue.OrderedList (get)
visibles	If specified, tabs in this list will be be displayed. Others will be under the "More..." menu tab.	ariba.util.fieldvalue.OrderedList (get)
submitForm	see AWHyperlink's submitForm attribute.	boolean (get)
item *	For each item in the "list", this is pushed into the referring component's scope. It can then be used for dereferencing things like the label of the tab.	java.lang.Object (set)
selection	During renderResponse, the selection is used to determine which tab to display as selected. When the user clicks an unselected tab, we set the selection in the referring component's context. This is a stateless component, so the referring component (or a parent thereof) must maintain the selection for subsequent requests.	java.lang.Object (both)
action	Fired when tab clicked	AWResponseGenerating (get)
index	The index of the current tab. While rendering the list of tabs, we push the index into the referring parent's context in case its useful in that context.	int (set)
label	The string to display on each label. The string is html-escaped before rendering.	String (get)
disabled	Render as (and behave as) disabled.	boolean (get)

ariba.ui.widgets
Class TabList

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

All Implemented Interfaces:

AWCycleable, AWCycleableReference, AWResponseGenerating, AWResponseGenerating.ResponseSubstitution, AWObject

public final class TabList
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

TabList()

Method Summary

AWResponseGenerating	closeTabTip()
AWEncodedString	currentLabel()
java.lang.String	currentTabCssClass()
java.lang.Object	currentTabDefinition()
java.lang.String	currentTabMenuItemStyle()
boolean	currentTabSelected()
AWEncodedString	currentTabSemanticKey()
AWEncodedString	currentTip()
boolean	hasHiddenTabs()
boolean	isNotDropTarget()
void	renderResponse(AWRequestContext requestContext, AWComponent component) The receiver should render its content to the AWRequestContext.response()
void	setCurrentIndex(int index)
void	setCurrentTabDefinition(java.lang.Object currentTabDefinition)
static void	setTabTextStyle(java.lang.String styleString)
boolean	showTip()
AWResponseGenerating	tabClicked()
AWEncodedString	tabTextStyle()

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, init, initTemplateResourceManager, intValueForBinding, intValueForBinding, intValueForBinding, invokeAction, isBidirectional, isBrowserMicrosoft, isClientPanel, isMacintosh, isRenderAW5, isStateless, 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, restoreFromBacktrackState, 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

_tabDefinitions

public java.lang.Object _tabDefinitions

_visibleTabDefinitions

public java.lang.Object _visibleTabDefinitions

_barExtensionBackground

public java.lang.String _barExtensionBackground

_elementId

public AWEncodedString _elementId

_isSubmitForm

public boolean _isSubmitForm

_allTabsMenuId

public AWEncodedString _allTabsMenuId

Constructor Detail

TabList

public TabList()

Method Detail

setTabTextStyle

public static void setTabTextStyle(java.lang.String styleString)

tabTextStyle

public AWEncodedString tabTextStyle()

setCurrentTabDefinition

public void setCurrentTabDefinition(java.lang.Object currentTabDefinition)

currentTabDefinition

public java.lang.Object currentTabDefinition()

currentLabel

public AWEncodedString currentLabel()

currentTip

public AWEncodedString currentTip()

showTip

public boolean showTip()

closeTabTip

public AWResponseGenerating closeTabTip()

setCurrentIndex

public void setCurrentIndex(int index)

currentTabSelected

public boolean currentTabSelected()

currentTabCssClass

public java.lang.String currentTabCssClass()

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

tabClicked

public AWResponseGenerating tabClicked()

currentTabSemanticKey

public AWEncodedString currentTabSemanticKey()

isNotDropTarget

public boolean isNotDropTarget()

hasHiddenTabs

public boolean hasHiddenTabs()

currentTabMenuItemStyle

public java.lang.String currentTabMenuItemStyle()