<w:MRUTabList>

A tab list that displays the "highest ranked" (most recently used) tabs inline and renders the others via a "More..." popup menu.

The visible subset is displayed in the order they appear in the list returned by the list binding.

Bindings
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.

List
(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)
label

The string to display on each label. The string is html-escaped before rendering.

String
(get)
rank

The rank (e.g. MRU position) of the tab. If there are many tabs, only those with the highest rank are displayed (and the others are in the More... menu).

If the rank binding is not provided, then a session-level MRU is maintained (and initial rank defaults to index in the the list array)

int
(get)
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)
maxWidthChars

How many characters wide (in aggregate label width) to render the tabs. When determining how many tabs will "fit" the tab list counts the string length of the labels, plus 4 for each tab separator. As many high ranked tabs as possible will be rendered until this total is reached.

int
(get)
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

Probably ignored. Just make sure to wrap your tab list in a TD or div with a class like "pageTabWrapper"

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)
disabled

Render as (and behave as) disabled.

boolean
(get)

ariba.ui.widgets
Class MRUTabList

java.lang.Object
  extended by ariba.ui.aribaweb.util.AWBaseObject
      extended by ariba.ui.aribaweb.core.AWComponent
          extended by ariba.ui.widgets.MRUTabList
All Implemented Interfaces:
AWCycleable, AWCycleableReference, AWResponseGenerating, AWResponseGenerating.ResponseSubstitution, AWObject

public class MRUTabList
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
MRUTabList()
           
 
Method Summary
 void checkTabInfo()
           
 java.lang.String currentTabLabel()
           
 java.lang.String currentTabSemanticKey()
           
 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)
           
 java.lang.Object selectedTab()
           
 void setSelectedTab(ariba.ui.widgets.MRUTabList.Tab selected)
           
 AWResponseGenerating tabSelected()
           
 
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, 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

_visibles

public java.util.List<ariba.ui.widgets.MRUTabList.Tab> _visibles

_all

public java.util.List<ariba.ui.widgets.MRUTabList.Tab> _all

_currentTab

public ariba.ui.widgets.MRUTabList.Tab _currentTab
Constructor Detail

MRUTabList

public MRUTabList()
Method Detail

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

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

checkTabInfo

public void checkTabInfo()

currentTabSemanticKey

public java.lang.String currentTabSemanticKey()

currentTabLabel

public java.lang.String currentTabLabel()

selectedTab

public java.lang.Object selectedTab()

setSelectedTab

public void setSelectedTab(ariba.ui.widgets.MRUTabList.Tab selected)

tabSelected

public AWResponseGenerating tabSelected()

restoreFromBacktrackState

public java.lang.Object restoreFromBacktrackState(java.lang.Object backtrackState)
Overrides:
restoreFromBacktrackState in class AWComponent


AribaWeb User Interface Development Framework
Copyright © 2000-2014 Ariba, Inc. All Rights Reserved.