Tag suggest

Renders a list of suggested texts for a given input field. Basic features:

UIComponentClass: org.apache.myfaces.tobago.component.UISuggest

RendererType: Suggest

Tag Information
Tag Classorg.apache.myfaces.tobago.internal.taglib.SuggestTag
TagExtraInfo ClassNone
Body ContentJSP
Display NameNone

(must evaluate to javax.faces.component.UIComponent)
The value binding expression linking this component to a property in a backing bean.

Warning: For the tobago extension library tx the binding differs from JSP and Facelets:

  • JSP: The component is the inner main control (e. g. UIInput).
  • Facelets: The component is the outer UIPanel.

Type: javax.faces.component.UIComponent
(must evaluate to java.lang.Integer)
Time in milli seconds before the list will be requested (by AJAX).
Type: java.lang.Integer
Default: 300
(must evaluate to java.lang.Object)
TODO: not implemented yet

Additional client side filtering of the result list. This is useful when sending the full list initially to the client and setting update=false.

Possible values are:

no filtering
checks if the suggested string starts with the typed text
checks if the typed text is inside of the suggested string

The filter will only applied on the client side and only if server updated (by AJAX) are turned off (update=false);
Type: org.apache.myfaces.tobago.model.SuggestFilter
Default: SuggestFilter.ALL
Allowed Values: [all, prefix, contains]

idfalsetruejava.lang.StringThe component identifier for this component. This value must be unique within the closest parent component that is a naming container.
Type: java.lang.String
(must evaluate to org.apache.myfaces.tobago.context.Markup)
Indicate markup of this component. The allowed markups can be defined or overridden in the theme. The value 'none' should not be used any longer. Just leave the attribute empty, or use a NULL pointer.
Type: org.apache.myfaces.tobago.context.Markup
(must evaluate to java.lang.Integer)
The maximum number of item to display in the drop down list.
Type: java.lang.Integer
Default: 10
(must evaluate to java.lang.Integer)
Minimum number of characters to type before the list will be requested. If the value is 0, there will be send an initial list to the client. So, if you set
this value should be 0.
Type: java.lang.Integer
Default: 1
(must evaluate to java.lang.Boolean)
Flag indicating whether or not this component should be rendered (during Render Response Phase), or processed on any subsequent form submit.
Type: boolean
Default: true
(signature must match java.lang.Object suggestMethod(javax.faces.component.UIInput))

**** @deprecated. Will be removed in a future version ****

Please use an <tc:selectItems> tag or a list of <tc:selectItem> tags (TODO: not implemented yet).

MethodBinding which generates a list of suggested input values based on the currently entered text, which could be retrieved via getSubmittedValue() on the UIIn. The expression has to evaluate to a public method which has a javax.faces.component.UIInput parameter and returns a List<String>, a List<org.apache.myfaces.tobago.model.AutoSuggestItem> or a org.apache.myfaces.tobago.model.AutoSuggestItems.
(must evaluate to java.lang.Integer)
The real size of the result list. Typically the result list will be cropped (in the backend) to save memory. This value can be set, to show the user there are more results for the given string. If the value is -1, no hint will be displayed.
Type: java.lang.Integer
Default: -1
(must evaluate to java.lang.Boolean)
TODO: not implemented yet

Should the list be updated while typing (via AJAX). This is the default behaviour. If you set this value to false, please set the minimumCharacters="0".
Type: boolean
Default: true

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.