q
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 Classteamdev.jsf.taglib.SuggestionFieldJspTag
TagExtraInfo ClassNone
Body ContentJSP
Display NameNone

Attributes
NameRequiredBinding TypeELDefaultDescription
autoCompletefalsebooleantruetrueSpecifies 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.
bindingfalseteamdev.jsf.component.suggestionfield.SuggestionFieldonlynullA value-binding expression that associates the SuggestionField with a backing bean property.
converterfalsejava.lang.StringtruenullA converter for the SuggestionField's value. Should be specified as a value-binding expression or converter identifier.
customValueAllowedfalsebooleantruetrueA 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").
footerHorizSeparatorfalsejava.lang.StringtruenullA 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:".
footerVertSeparatorfalsejava.lang.StringtruenullA style for vertical lines between column footers. Should be specified as the CSS "border" property but without the prefix "border:".
headerHorizSeparatorfalsejava.lang.StringtruenullA 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:".
headerVertSeparatorfalsejava.lang.StringtruenullA style for vertical lines between column headers. Should be specified as the CSS "border" property but without the prefix "border:".
horizontalGridLinesfalsejava.lang.StringtruenullA style for horizontal lines in the drop-down list. Should be specified as the CSS "border" property but without the prefix "border:".
idfalsejava.lang.StringfalsenullThe component identifier.
immediatefalsebooleantruefalseA 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).
listAlignmentfalseteamdev.jsf.component.dropdown.HorizontalAlignmenttrue"left"Defines how items in the drop-down list are aligned.
Available values are:
"left"
"right"
listClassfalsejava.lang.StringtruenullA CSS class name for the drop-down list.
listFooterRowClassfalsejava.lang.StringtruenullA CSS class name for the footer row in the drop-down list.
listFooterRowStylefalsejava.lang.StringtruenullA style for the footer row in the drop-down list.
listHeaderRowClassfalsejava.lang.StringtruenullA CSS class name for the header row in the drop-down list.
listHeaderRowStylefalsejava.lang.StringtruenullA style for the header row in the drop-down list.
listItemClassfalsejava.lang.StringtruenullA CSS class name for a list item.
listItemStylefalsejava.lang.StringtruenullA style for a list item.
listStylefalsejava.lang.StringtruenullA style for the drop-down list.
manualListOpeningAllowedfalsebooleantruefalseA flag that indicates whether a drop-down suggestion list can be opened using the "Down Arrow" key.
oddListItemClassfalsejava.lang.StringtruenullA CSS class name for an odd list item, if different from listItemClass.
oddListItemStylefalsejava.lang.StringtruenullA style for an odd list item, if different from listItemStyle.
onblurfalsejava.lang.StringtruenullJavaScript code that should be executed when the SuggestionField loses focus.
onchangefalsejava.lang.StringtruenullJavaScript code that should be executed on the client when the SuggestionField's value has changed.
onclickfalsejava.lang.StringtruenullJavaScript code that should be executed on the client when the user clicks the left mouse button over the SuggestionField.
oncloseupfalsejava.lang.StringtruenullJavaScript code that should be executed on the client when the drop-down list has closed.
ondblclickfalsejava.lang.StringtruenullJavaScript code that should be executed on the client when the user double-clicks the left mouse button over the SuggestionField.
ondropdownfalsejava.lang.StringtruenullJavaScript code that should be executed on the client when the drop-down list has opened.
onfocusfalsejava.lang.StringtruenullJavaScript code that should be executed when the SuggestionField receives focus.
onkeydownfalsejava.lang.StringnonenoneJavaScript code that should be executed when the user presses a key over the SuggestionField.
onkeypressfalsejava.lang.StringtruenullJavaScript code that should be executed on the client when the user presses and releases a key over the SuggestionField.
onkeyupfalsejava.lang.StringtruenullJavaScript code that should be executed when the user releases a key over the SuggestionField.
onmousedownfalsejava.lang.StringtruenullJavaScript code that should be executed when the user clicks over the SuggestionField with either mouse button.
onmousemovefalsejava.lang.StringtruenullJavaScript code that should be executed when the user moves the mouse pointer over the SuggestionField.
onmouseoutfalsejava.lang.StringtruenullJavaScript code that should be executed when the user moves the mouse pointer away from the SuggestionField.
onmouseoverfalsejava.lang.StringtruenullJavaScript code that should be executed when the user moves the mouse pointer onto the SuggestionField.
onmouseupfalsejava.lang.StringtruenullJavaScript code that should be executed when the user releases the mouse button over the SuggestionField.
renderedfalsebooleantruefalseA flag that indicates whether or not the component is visible.
requiredfalsebooleantruefalseA flag that indicates whether or not the SuggestionField requires a value.
rolloverClassfalsejava.lang.StringtruenullA CSS class name for the entire SuggestionField component in the rollover state.
rolloverListClassfalsejava.lang.StringtruenullA CSS class name for the drop-down list in the rollover state.
rolloverListItemClassfalsejava.lang.StringtruenullA CSS class name for a list item in the rollover state.
rolloverListItemStylefalsejava.lang.StringtruenullA style for a list item in the rollover state.
rolloverListStylefalsejava.lang.StringtruenullA style for the drop-down list in the rollover state.
rolloverStylefalsejava.lang.StringtruenullA style for the entire SuggestionField component in the rollover state.
stylefalsejava.lang.StringtruenullA style for the entire SuggestionField component.
styleClassfalsejava.lang.StringtruenullA CSS class name for the entire SuggestionField component.
suggestionDelayfalseinttrue350The 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.
suggestionMinCharsfalseinttrue2The minimal number of characters that should be typed for auto-completion and auto-suggestion features to be activated.
suggestionModefalseteamdev.jsf.component.dropdown.SuggestionModetrue"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
timeoutfalseinttrue-1A time period after which the drop-down list is closed automatically. The value "-1" means that the list will not close automatically.
validatorfalsejavax.faces.el.MethodBindingonlynullA MethodBinding that should point to the method in the backing bean that is called to validate the SuggestionField's value.
valuefalsejava.lang.StringtruenullThe value of the suggestionField component that is displayed in the text field.
valueChangeListenerfalsejavax.faces.el.MethodBindingonlynullA MethodBinding that should point to the method that accepts a ValueChangeEvent. If the value of the SuggestionField changes, this method is executed.
varfalsejava.lang.StringfalsenullThe name of a request-scope variable under which the current item object is available when specifying child components.
verticalGridLinesfalsejava.lang.StringtruenullA 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.