<w:StepByStepTOC>

TBD

Bindings

label *	TBD	String (get)
steps *	TBD	AWOrdererdList (get)
step *	TBD	Object (set)
stepLabel *	TBD	String (get)
stepIsNumbered	TBD	boolean (get)
stepIsVisible	TBD	boolean (get)
stepIndex *	TBD	int (get)
visibleStepCount *	TBD	int (get)
isClickable	TBD	boolean (get)
stepAction *	TBD	AWResponseGenerating (get)
selectionsLabel *	TBD	String (get)
showSelections	TBD	boolean (get)
selectionsIcon	Note: Although this is declared to be require=false, this is required iff showSelections is true.	String (get)
selectionsAction	Note: Although this is declared to be require=false, this is required iff showSelections is true.	AWResponseGenerating (get)
selectedStep *	TBD	Object (both)
selectionsAlt	TBD	String (get)
navigateStepIndexMax	Only effective when isClickable=$false. When isClickable=$false, this binding can be used to pass in the index of the max step which is clickable. NOTE: if isClickable="$false" and navigateStepIndexMax is not specified, then none of the steps will be clickable.	int (get)

ariba.ui.widgets
Class StepByStepTOC

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

All Implemented Interfaces:

AWCycleable, AWCycleableReference, AWResponseGenerating, AWResponseGenerating.ResponseSubstitution, AWObject

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

StepByStepTOC()

Method Summary

java.lang.String	awname()
boolean	curIsClickable()
AWEncodedString	currentMouseOut()
AWEncodedString	currentMouseOver()
java.lang.Boolean	currentStepIsVisible()
AWEncodedString	currentStepLabel()
java.lang.String	currentStepNumberHint()
java.lang.String	currentStepNumberImageName()
boolean	currentStepSelected()
AWEncodedString	currentStyle()
void	renderResponse(AWRequestContext requestContext, AWComponent component) The receiver should render its content to the AWRequestContext.response()
void	setCurrentStep(java.lang.Object step)
AWResponseGenerating	stepClicked()
java.lang.String	verticalLineImageName()

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

_showSelections

public java.lang.Object _showSelections

_isClickable

public boolean _isClickable

Constructor Detail

StepByStepTOC

public StepByStepTOC()

Method Detail

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

setCurrentStep

public void setCurrentStep(java.lang.Object step)

currentStyle

public AWEncodedString currentStyle()

currentMouseOver

public AWEncodedString currentMouseOver()

currentMouseOut

public AWEncodedString currentMouseOut()

verticalLineImageName

public java.lang.String verticalLineImageName()

currentStepLabel

public AWEncodedString currentStepLabel()

currentStepNumberImageName

public java.lang.String currentStepNumberImageName()

currentStepNumberHint

public java.lang.String currentStepNumberHint()

currentStepIsVisible

public java.lang.Boolean currentStepIsVisible()

stepClicked

public AWResponseGenerating stepClicked()

curIsClickable

public boolean curIsClickable()

currentStepSelected

public boolean currentStepSelected()

awname

public java.lang.String awname()