<w:OutlineControl>

AWXOutlineControl renders the indentation, arrow, and text for a node in an outline. It should be used either in the body of an AWXOutlineRepetition, or in the first column of an AWTDataTable (that set to act as an outline via the children binding).

AWComponentContent is supported as an alternative to the title. The named template "icon" can be provided for an icon image to be rendering between the outline arrow and the title text (or rest of component content).

Bindings

renderAsTable	Should the control (arrow, icon (if any) and title) be rendered as a nested HTML table. This is (sadly) often necessary to force a wrapping title to wrap under the start of the text from the line abover (i.e. the the right of the indented arrow) instead of left justified.	boolean (get)
title	The title (label) on the node.	String (get)
action	Seldom used: fired whenever and outline node is expanded/collapsed.	AWResponseGenerating (get)
selectAction	If allowSelection=$true, this action is fired when a node is "selected" (i.e. the title text was clicked on).	AWResponseGenerating (get)
indentationPerLevel	Number of pixels to indent each level of the outline.	int (get)
allowSelection	Allow clicking on the title string to "select" a node (and visually reflect that selection).	boolean (get)
expansionLinkAction	If allowSelection=$false, this action is fired when a node is "expanded" (i.e. the title text is clicked on).	AWResponseGenerating (get)
addSelectionPadding	Whether to wrap the title of the selected item with a span that includes a padded highlight box.	boolean (get)
style	TBD	String (get)
valign	TBD	String (get)

Named Content

icon

TBD

ariba.ui.outline
Class OutlineControl

java.lang.Object
  ariba.ui.aribaweb.util.AWBaseObject
      ariba.ui.aribaweb.core.AWComponent
          ariba.ui.outline.OutlineControl

All Implemented Interfaces:

AWCycleable, AWCycleableReference, AWResponseGenerating, AWResponseGenerating.ResponseSubstitution, AWObject

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

OutlineControl()

Method Summary

void	awake()
java.lang.String	currentToggleImageName()
boolean	divWrapTitle()
int	indentation()
int	indentationWithControl()
java.lang.String	indentationWithControlStyle()
int	indentationWithoutControl()
java.lang.String	indentationWithoutControlStyle()
boolean	isSelected()
boolean	noLinkOnTitle()
boolean	renderInTable()
void	renderResponse(AWRequestContext requestContext, AWComponent component) The receiver should render its content to the AWRequestContext.response()
AWComponent	select()
boolean	showExpansionControl()
void	sleep()
java.lang.String	spacePadding()
java.lang.String	title()
AWComponent	toggleExpansion()

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

FourNBSPs

public static final AWEncodedString FourNBSPs

_currentRepetition

public OutlineRepetition _currentRepetition

_hasTitle

public boolean _hasTitle

Constructor Detail

OutlineControl

public OutlineControl()

Method Detail

awake

public void awake()

sleep

public void sleep()

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

indentation

public int indentation()

indentationWithoutControl

public int indentationWithoutControl()

indentationWithControl

public int indentationWithControl()

indentationWithControlStyle

public java.lang.String indentationWithControlStyle()

indentationWithoutControlStyle

public java.lang.String indentationWithoutControlStyle()

spacePadding

public java.lang.String spacePadding()

showExpansionControl

public boolean showExpansionControl()

currentToggleImageName

public java.lang.String currentToggleImageName()

toggleExpansion

public AWComponent toggleExpansion()

isSelected

public boolean isSelected()

select

public AWComponent select()

noLinkOnTitle

public boolean noLinkOnTitle()

divWrapTitle

public boolean divWrapTitle()

title

public java.lang.String title()

renderInTable

public boolean renderInTable()