o
Tag suggestionField


Renders the SuggestionField component that represents a text field with a set of predefined values in the drop-down list.
There are two ways to specify items in the drop-down list: These two approaches can be combined in any order.


Tag Information
Tag Classorg.openfaces.taglib.jsp.input.SuggestionFieldJspTag
TagExtraInfo ClassNone
Body ContentJSP
Display NameNone

Attributes
NameRequiredBinding TypeELDefaultDescription
accesskeyfalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
truenullAn access key for the SuggestionField component.
autoCompletefalsejavax.el.ValueExpression
(must evaluate to boolean)
truetrueSpecifies whether the field completes incompletely entered text as the user types it. The text is completed to the first drop-down item that starts with the typed text. The part that was added as a result of auto-completion is marked as selected. See also the suggestionMinChars and suggestionDelay attributes which define when auto-completion starts.
bindingfalsejavax.el.ValueExpression
(must evaluate to org.openfaces.component.input.SuggestionField)
onlynullA value-binding expression that associates the SuggestionField with a backing bean property.
converterfalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
truenullA converter for the SuggestionField's value. Should be specified as a value-binding expression or converter identifier.
customValueAllowedfalsejavax.el.ValueExpression
(must evaluate to boolean)
truetrueA flag that indicates whether it is possible to specify only a value that exists in the list of this component's drop-down items ("false"), or whether it is possible to enter any value ("true").
disabledfalsejavax.el.ValueExpression
(must evaluate to boolean)
truefalseA flag that enables or disables the component.
disabledClassfalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
truenullA CSS class name for the entire SuggestionField component in the disabled state.
disabledStylefalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
truenullA style for the entire SuggestionField component in the disabled state.
focusedClassfalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
truenullA CSS class name of the SuggestionField component when it is focused.
focusedStylefalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
truenullA style of the SuggestionField component when it is focused.
footerHorizSeparatorfalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
truenullA style for a line that separates the footer from the drop-down items. Should be specified as the CSS "border" property but without the prefix "border:".
footerVertSeparatorfalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
truenullA style for vertical lines between column footers. Should be specified as the CSS "border" property but without the prefix "border:".
headerHorizSeparatorfalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
truenullA style for a line that separates the header from the drop-down items. Should be specified as the CSS "border" property but without the prefix "border:".
headerVertSeparatorfalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
truenullA style for vertical lines between column headers. Should be specified as the CSS "border" property but without the prefix "border:".
horizontalGridLinesfalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
truenullA style for horizontal lines in the drop-down list. Should be specified as the CSS "border" property but without the prefix "border:".
idfalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
falsenullThe component identifier.
immediatefalsejavax.el.ValueExpression
(must evaluate to boolean)
truefalseA flag that indicates whether or not valueChangeListener should be executed immediately (during the Apply Request Values phase of the request processing lifecycle instead of Process Validations phase) and the component's input should be converted and validated immediately (during the Apply Request Values phase of the request processing lifecycle instead of the Process Validations phase).
labelfalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
truenullA localized user presentable name for this component. Used when constructing validation messages for this component in the same way as for the standard component.
listAlignmentfalsejavax.el.ValueExpression
(must evaluate to java.lang.Object)
true"left"Defines how items in the drop-down list are aligned.
Available values are:
"left"
"right"
listClassfalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
truenullA CSS class name for the drop-down list.
listFooterRowClassfalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
truenullA CSS class name for the footer row in the drop-down list.
listFooterRowStylefalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
truenullA style for the footer row in the drop-down list.
listHeaderRowClassfalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
truenullA CSS class name for the header row in the drop-down list.
listHeaderRowStylefalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
truenullA style for the header row in the drop-down list.
listItemClassfalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
truenullA CSS class name for a list item.
listItemStylefalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
truenullA style for a list item.
listStylefalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
truenullA style for the drop-down list.
manualListOpeningAllowedfalsejavax.el.ValueExpression
(must evaluate to boolean)
truefalseA flag that indicates whether a drop-down suggestion list can be opened using the "Down Arrow" key.
maxlengthfalsejavax.el.ValueExpression
(must evaluate to int)
trueInteger.MIN_VALUEThe maximum number of characters that can be entered in the SuggestionField. It is still possible to select any text from the drop-down list no matter how long it is
multiFooterSeparatorfalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
truenullA style for a line that separates multiple footer rows when column groups are used.
multiHeaderSeparatorfalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
truenullA style for a line that separates multiple header rows when column groups are used.
oddListItemClassfalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
truenullA CSS class name for an odd list item, if different from listItemClass.
oddListItemStylefalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
truenullA style for an odd list item, if different from listItemStyle.
onblurfalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
truenullJavaScript code that should be executed when the SuggestionField loses focus.
onchangefalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
truenullJavaScript code that should be executed on the client when the SuggestionField's value has changed.
onclickfalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
truenullJavaScript code that should be executed on the client when the user clicks the left mouse button over the SuggestionField.
oncloseupfalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
truenullJavaScript code that should be executed on the client when the drop-down list has closed.
oncontextmenufalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
truenullJavaScript code that should be executed when the user presses right mouse button over the component (or performs the other context menu invocation action depending on the platform).
ondblclickfalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
truenullJavaScript code that should be executed on the client when the user double-clicks the left mouse button over the SuggestionField.
ondropdownfalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
truenullJavaScript code that should be executed on the client when the drop-down list has opened.
onfocusfalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
truenullJavaScript code that should be executed when the SuggestionField receives focus.
onkeydownfalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
truenullJavaScript code that should be executed when the user presses a key over the SuggestionField.
onkeypressfalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
truenullJavaScript code that should be executed on the client when the user presses and releases a key over the SuggestionField.
onkeyupfalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
truenullJavaScript code that should be executed when the user releases a key over the SuggestionField.
onmousedownfalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
truenullJavaScript code that should be executed when the user clicks over the SuggestionField with either mouse button.
onmousemovefalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
truenullJavaScript code that should be executed when the user moves the mouse pointer over the SuggestionField.
onmouseoutfalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
truenullJavaScript code that should be executed when the user moves the mouse pointer away from the SuggestionField.
onmouseoverfalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
truenullJavaScript code that should be executed when the user moves the mouse pointer onto the SuggestionField.
onmouseupfalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
truenullJavaScript code that should be executed when the user releases the mouse button over the SuggestionField.
promptTextfalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
truenullThis prompt text will be shown when value of component is empty.
promptTextClassfalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
truenullA CSS class name for the prompt text.
promptTextStylefalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
truenullA style for the prompt text.
renderedfalsejavax.el.ValueExpression
(must evaluate to boolean)
truefalseA flag that indicates whether or not the component is visible.
requiredfalsejavax.el.ValueExpression
(must evaluate to boolean)
truefalseA flag that indicates whether or not the SuggestionField requires a value.
rolloverClassfalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
truenullA CSS class name for the entire SuggestionField component in the rollover state.
rolloverListClassfalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
truenullA CSS class name for the drop-down list in the rollover state.
rolloverListItemClassfalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
truenullA CSS class name for a list item in the rollover state.
rolloverListItemStylefalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
truenullA style for a list item in the rollover state.
rolloverListStylefalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
truenullA style for the drop-down list in the rollover state.
rolloverStylefalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
truenullA style for the entire SuggestionField component in the rollover state.
sizefalsejavax.el.ValueExpression
(must evaluate to int)
trueInteger.MIN_VALUEThe width of the SuggestionField component in characters.
stylefalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
truenullA style for the entire SuggestionField component.
styleClassfalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
truenullA CSS class name for the entire SuggestionField component.
suggestionDelayfalsejavax.el.ValueExpression
(must evaluate to int)
true350The time period in milliseconds that specifies the delay after the last key press that should pass before starting auto-completion or auto-suggestion. This delay can be used to avoid too much Ajax requests to be sent to the server when the user is typing text, and only send one request when the user has stopped typing.
suggestionMinCharsfalsejavax.el.ValueExpression
(must evaluate to int)
true2The minimal number of characters that should be typed for auto-completion and auto-suggestion features to be activated.
suggestionModefalsejavax.el.ValueExpression
(must evaluate to java.lang.Object)
true"stringStart"Specifies whether and how the drop-down list with suggestions should be shown when typing in the field. Any value except "none" means that suggestions are displayed. See also the suggestionMinChars and suggestionDelay attributes which define when auto-suggestion starts.
Available values are:
"stringStart" — works on the client side. Shows suggestions that begin with the entered value
"substring" — works on the client side. Shows suggestions that contain the entered value
"stringEnd" — works on the client side. Shows suggestions that end with the entered value
"custom" — works on the server side using Ajax. Sends an Ajax request when entering a value and returns a list of suggestions from the server
"all" — works on the client side. Shows all drop-down items in the list of suggestions
"none" — suggestion mode is turned off
tabindexfalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
truenullPosition of the component in the focus transition chain for the current document.
timeoutfalsejavax.el.ValueExpression
(must evaluate to int)
true-1A time period after which the drop-down list is closed automatically. The value "-1" means that the list does not close automatically.
titlefalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
truenullAn advisory title for the SuggestionField component.
validatorfalsejavax.el.MethodExpression
(signature must match void validate(javax.faces.context.FacesContext, javax.faces.component.UIComponent, java.lang.Object))
onlynullA MethodBinding that should point to the method in the backing bean that is called to validate the SuggestionField's value.
valuefalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
truenullThe value of the suggestionField component that is displayed in the text field.
valueChangeListenerfalsejavax.el.MethodExpression
(signature must match void valueChange(javax.faces.event.ValueChangeEvent))
onlynullA MethodBinding that should point to the method that accepts a ValueChangeEvent. If the value of the SuggestionField changes, this method is executed.
varfalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
falsenullThe name of a request-scope variable under which the current item object is available when specifying child components.
verticalGridLinesfalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
truenullA style for vertical lines in the drop-down list. Should be specified as the CSS "border" property but without the prefix "border:".

Variables
No Variables Defined.


Output Generated by Tag Library Documentation Generator. Java, JSP, and JavaServer Pages are trademarks or registered trademarks of Sun Microsystems, Inc. in the US and other countries. Copyright 2002-4 Sun Microsystems, Inc. 4150 Network Circle Santa Clara, CA 95054, U.S.A. All Rights Reserved.