<w:GenericChooser>

Renders some form of chooser control (Popup, Radio Buttons, Checkboxes, Chooser). The type of chooser may be determined dynamically based on the number of items in the choice list, or can be specified explicitly via the "type" binding.

Bindings

object	The object being assigned to. Defaults to the curent component instance.	Object (get)
key	The object key(path) being assigned to.	Object (get)
list	List of choice objects assignable to the key of the object.	AWOrderedList (get)
destinationClass	Can be used in place of "list" to trigger obtaining the list of choices by was of the ChoiceSource class extension.	String (get)
choiceProviderParams	See ChoiceSourceRegistry... (Optional) map of params for the provider.	Map (get)
multiSelect	Is this a List property, or a to-one.	boolean (get)
type	The style of chooser to use (Radio, Checkbox, Popup, PopupControl, Chooser) Defaults based on cardinality of the list and whether it's multiSelect.	String (get)
displayKey	The key(path) of the choice objects to get the property to display (uses choice object directly if null).	String (get)
action	The action invoked when a popup menu item is changed. Note that action="$null" is different from no action binding at all. If you have action="$null", it will submit the form and cycle the page upon change to the popup, while no action at all makes the popup passive (ie. user must click a button to submt the form).	AWResponseGenerating (get)
noSelectionString	TBD	String (get)
isRefresh	Convenience binding that is the same as action="$null". See action binding for more information on action="$null".	boolean (get)
disabled	Disables the popup menu if true.	boolean (get)
size	TBD	int (get)
allowFullMatchOnInput	Should we attempt a match as they type (against the full list)	boolean (get)

ariba.ui.validation
Class GenericChooser

java.lang.Object
  ariba.ui.aribaweb.util.AWBaseObject
      ariba.ui.aribaweb.core.AWComponent
          ariba.ui.validation.GenericChooser

All Implemented Interfaces:

AWCycleable, AWCycleableReference, AWResponseGenerating, AWResponseGenerating.ResponseSubstitution, AWObject, ChooserSelectionState

public class GenericChooser
extends AWComponent
implements ChooserSelectionState

Nested Class Summary

static class

GenericChooser.FieldPathFormatter

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

GenericChooser()

Method Summary

java.lang.Object	displayValue()
void	init()
boolean	isSelected(java.lang.Object selection)
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	selectedObject()
java.util.List	selectedObjects()
java.lang.Object	selection()
void	setSelection(java.lang.Object value)
void	setSelectionState(java.lang.Object selection, boolean selected)

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, 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, 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

_item

public java.lang.Object _item

_list

public java.util.List _list

_chooserSource

public ChooserSelectionSource _chooserSource

_chooserState

public ChooserState _chooserState

_type

public ariba.ui.validation.GenericChooser.ChooserType _type

_isMulti

public boolean _isMulti

_displayKey

public java.lang.String _displayKey

_formatter

public java.lang.Object _formatter

_chooserFormatter

public java.lang.Object _chooserFormatter

Constructor Detail

GenericChooser

public GenericChooser()

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

init

public void init()

Specified by:

init in interface AWObject

Overrides:

init 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

displayValue

public java.lang.Object displayValue()

selection

public java.lang.Object selection()

setSelection

public void setSelection(java.lang.Object value)

setSelectionState

public void setSelectionState(java.lang.Object selection,
                              boolean selected)

Specified by:

setSelectionState in interface ChooserSelectionState

selectedObject

public java.lang.Object selectedObject()

Specified by:

selectedObject in interface ChooserSelectionState

selectedObjects

public java.util.List selectedObjects()

Specified by:

selectedObjects in interface ChooserSelectionState

isSelected

public boolean isSelected(java.lang.Object selection)

Specified by:

isSelected in interface ChooserSelectionState