<w:BucketHeading>

A BucketHeading is a row in a BucketsTOC table which provides a toggle image, label, and optional count field.

The toggle image is used to control the display of the BucketItems which fall under this BucketHeading. When the user clicks the toggle image, it toggles between showing/hiding the BucketItems.

The label always displays for the heading.

The optional labelRight is used to indicate how many items appear under this heading. The true meaning of this is application defined.

See Also BucketsTOC and BucketItem.

Bindings

isExternal	See AWToggleImage	boolean (get)
initState	See AWToggleImage	boolean (get)
state	See AWToggleImage	boolean (set)
submitForm	If you do not provide this binding, we determine if the current BucketHeading is within an AWForm and, if so, we submit the submit automatically. If you do specify this binding, your value takes precedence.	boolean (get)
action	The action to take when the label of the BucketHeading is clicked. If you do not specify this binding, the label will not be clickable.	AWResponseGenerating (get)
label	The strings that displays in the BucketHeading. This string forms a hyperlink when the action binding is provided.	String (get)
isSelected	TBD	boolean (get)
labelRight	The strings that displays on the right side of the BucketHeading. This is often used to display counts of items under this heading.	String (get)

ariba.ui.widgets
Class BucketHeading

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

All Implemented Interfaces:

AWCycleable, AWCycleableReference, AWResponseGenerating, AWResponseGenerating.ResponseSubstitution, AWObject

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

BucketHeading()

Method Summary

void	awake()
boolean	hasForm()
boolean	isNotHyperlink()
boolean	isOpenState()
AWEncodedString	onMouseOut()
AWEncodedString	onMouseOver()
void	renderResponse(AWRequestContext requestContext, AWComponent component) The receiver should render its content to the AWRequestContext.response()
AWEncodedString	styleClass()

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

_labelRight

public AWEncodedString _labelRight

_spaceRight

public AWEncodedString _spaceRight

_isOpen

public boolean _isOpen

Constructor Detail

BucketHeading

public BucketHeading()

Method Detail

awake

public void awake()

isOpenState

public boolean isOpenState()

isNotHyperlink

public boolean isNotHyperlink()

hasForm

public boolean hasForm()

styleClass

public AWEncodedString styleClass()

onMouseOver

public AWEncodedString onMouseOver()

onMouseOut

public AWEncodedString onMouseOut()

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