<w:Chooser>

An AJAX auto-completion chooser. Supports both single and multi-select.

Bindings

selections	Short list of available selections.	AWOrderedList (get)
selectionSource	Interface responsible for returning matches given a pattern. See ChooserSelectionSource.	ChooserSelectionSource (get)
state	The object holding all the UI state including the current selected objects. See ChooserState and ChooserSelectionState.	ChooserState (both)
noSelectionString	TBD	String (get)
formatter	Formatter used to format each selection and selected object for display.	AWFormatting (get)
disabled	TBD	boolean (get)
size	TBD	int (get)
multiSelect	TBD	boolean (get)
searchAction	TBD	AWResponseGenerating (get)
maxLength	TBD	int (get)
errorKey	TBD	Object (get)
basic	If true, the chooser will run in the basic mode with the following: Search for more link hidden Multi selection hidden Pick list hidden No validation chooserState.pattern() should be used instead of chooserState.selectedObject() searchAction is required	boolean (get)
class	CSS class for wrapper and match menu element. "Menu" will be appended for the menu class name. Example: .foo { // style wrapper } .foo input { // style text field } .fooMenu { // style menu }	String (get)
allowFullMatchOnInput	Temp binding to allow full match on input. Later it will be true always.	boolean (get)

ariba.ui.widgets
Class Chooser

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

All Implemented Interfaces:

AWCycleable, AWCycleableReference, AWResponseGenerating, AWResponseGenerating.ResponseSubstitution, AWObject

public class Chooser
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

Chooser()

Method Summary

void	applyValues(AWRequestContext requestContext, AWComponent component) The receiver should take any form values (or query string parameters) that it owns from the AWRequestContext.request().
java.lang.String	behavior()
boolean	canAdd()
java.lang.String	chooserAddLinkSemanticKey()
java.lang.String	chooserDropDownSemanticKey() Method used to set the semantic key on the drop down image of the chooser.
java.lang.String	chooserRemoveLinkSemanticKey()
ChooserState	chooserState()
java.lang.String	cssClass()
java.lang.String	currentItemHighlightedString()
java.lang.String	currentItemString()
boolean	displayRecentlyViewed()
java.lang.String	displayValue()
boolean	getFullMatchValue()
boolean	getRemoveValue()
java.lang.String	getSelectionList()
AWResponseGenerating	invokeAction(AWRequestContext requestContext, AWComponent component) The receiver should determine if it is the intended recipient of the current action (by checking the AWRequestContext.request() AWRequest.senderId()) and, if so, handle the action and return the result.
boolean	isDisabled()
boolean	isInvalid()
boolean	isReadOnly()
boolean	isSender()
boolean	itemCountChanged() The size of multi-select choosers can change based on user selections.
AWResponse	matchAction()
int	maxRecentSelected()
java.lang.String	menuClass()
java.lang.String	moreSelectedString()
java.lang.String	moreSelectedStringPlusOne()
java.lang.String	moreSelectedStringPlusTwo()
java.lang.String	noSelectionString()
java.lang.String	recentSelectedStyle()
void	renderResponse(AWRequestContext requestContext, AWComponent component) The receiver should render its content to the AWRequestContext.response()
AWResponseGenerating	searchAction()
java.lang.String	selectValue()
void	setChooserId(AWEncodedString chooserId)
void	setDisplayValue(java.lang.String displayValue) we only do a match if the incoming strings differs from the previous value - if the underlying selected object has changed we don't rematch
void	setFullMatchValue(boolean fullMatchValue)
void	setRemoveValue(boolean removeValue)
void	setSelectionList(java.lang.String listId)
void	setSelectValue(java.lang.String selectionIndexValue)
void	setToggleValue(java.lang.String selectionIndexValue)
boolean	showBullet()
boolean	showCheck()
boolean	showMoreSelected()
java.lang.String[]	supportedBindingNames()
AWResponseGenerating	textAction()
java.lang.String	toggleValue()
java.lang.String	wrapperClass()

Methods inherited from class ariba.ui.aribaweb.core.AWComponent

_topLevelApplyValues, _topLevelInvokeAction, _topLevelRenderResponse, allowEmbeddedKeyPaths, allowsWhitespaceCompression, application, 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, 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, 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

MaxRecentSelected

public static int MaxRecentSelected

Matches

public static java.lang.String Matches

FilteredSelections

public static java.lang.String FilteredSelections

NoSelectionString

public static java.lang.String NoSelectionString

MoreSelectedString

public static java.lang.String MoreSelectedString

NoMatchFoundString

public static java.lang.String NoMatchFoundString

_chooserId

public AWEncodedString _chooserId

_menuId

public AWEncodedString _menuId

_basic

public boolean _basic

Constructor Detail

Chooser

public Chooser()

Method Detail

supportedBindingNames

public java.lang.String[] supportedBindingNames()

Overrides:

supportedBindingNames in class AWComponent

noSelectionString

public java.lang.String noSelectionString()

behavior

public java.lang.String behavior()

setChooserId

public void setChooserId(AWEncodedString chooserId)

chooserState

public ChooserState chooserState()

currentItemString

public java.lang.String currentItemString()

chooserDropDownSemanticKey

public java.lang.String chooserDropDownSemanticKey()

Method used to set the semantic key on the drop down image of the chooser. This allows the recorder identify the image that the user clicks on.

chooserAddLinkSemanticKey

public java.lang.String chooserAddLinkSemanticKey()

chooserRemoveLinkSemanticKey

public java.lang.String chooserRemoveLinkSemanticKey()

currentItemHighlightedString

public java.lang.String currentItemHighlightedString()

displayValue

public java.lang.String displayValue()

setDisplayValue

public void setDisplayValue(java.lang.String displayValue)

we only do a match if the incoming strings differs from the previous value - if the underlying selected object has changed we don't rematch

isReadOnly

public boolean isReadOnly()

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

isInvalid

public boolean isInvalid()

showBullet

public boolean showBullet()

showCheck

public boolean showCheck()

recentSelectedStyle

public java.lang.String recentSelectedStyle()

maxRecentSelected

public int maxRecentSelected()

showMoreSelected

public boolean showMoreSelected()

moreSelectedString

public java.lang.String moreSelectedString()

moreSelectedStringPlusOne

public java.lang.String moreSelectedStringPlusOne()

moreSelectedStringPlusTwo

public java.lang.String moreSelectedStringPlusTwo()

applyValues

public void applyValues(AWRequestContext requestContext,
                        AWComponent component)

Description copied from interface: AWCycleable

The receiver should take any form values (or query string parameters) that it owns from the AWRequestContext.request().

Specified by:

applyValues in interface AWCycleable

Overrides:

applyValues in class AWComponent

Parameters:

requestContext - the context for the current request.

component - the current parent component

isSender

public boolean isSender()

invokeAction

public AWResponseGenerating invokeAction(AWRequestContext requestContext,
                                         AWComponent component)

Description copied from interface: AWCycleable

The receiver should determine if it is the intended recipient of the current action (by checking the AWRequestContext.request() AWRequest.senderId()) and, if so, handle the action and return the result.

Specified by:

invokeAction in interface AWCycleable

Overrides:

invokeAction in class AWComponent

Parameters:

requestContext - the context for the current request.

component - the current parent component

Returns:

the response for the action

selectValue

public java.lang.String selectValue()

toggleValue

public java.lang.String toggleValue()

getRemoveValue

public boolean getRemoveValue()

getSelectionList

public java.lang.String getSelectionList()

displayRecentlyViewed

public boolean displayRecentlyViewed()

setSelectionList

public void setSelectionList(java.lang.String listId)

setSelectValue

public void setSelectValue(java.lang.String selectionIndexValue)

setToggleValue

public void setToggleValue(java.lang.String selectionIndexValue)

itemCountChanged

public boolean itemCountChanged()

The size of multi-select choosers can change based on user selections. When the chooser is embedded inside a table, the table's size is dependent on the size of the chooser and it needs to be notified when there is a change. We track changes by capturing the size of the selected objects on each request.

setRemoveValue

public void setRemoveValue(boolean removeValue)

getFullMatchValue

public boolean getFullMatchValue()

setFullMatchValue

public void setFullMatchValue(boolean fullMatchValue)

matchAction

public AWResponse matchAction()

canAdd

public boolean canAdd()

textAction

public AWResponseGenerating textAction()

searchAction

public AWResponseGenerating searchAction()

isDisabled

public boolean isDisabled()

wrapperClass

public java.lang.String wrapperClass()

menuClass

public java.lang.String menuClass()

cssClass

public java.lang.String cssClass()