suggest (Tobago Core VDL Documentation)

All Tags

Description:
Renders a list of suggested texts for a given input field. Basic features:
- provide a list directly while rendering (not AJAX needed) [todo]
- update by typing (AJAX)
- minimum number of typed characters (to avoid useless requests)
- update delay (useful for optimization)
- filter on client side (useful for optimization) [todo]
UIComponentClass: org.apache.myfaces.tobago.component.UISuggest
RendererType:
- Suggest (default)

Component Information
Info	Value
Component Type	`org.apache.myfaces.tobago.Suggest`
Handler Class	`org.apache.myfaces.tobago.facelets.TobagoComponentHandler`
Renderer Type	`Suggest`
Description	None

Attributes
Name	Required	Type	Description
`binding`	`false`	`javax.el.ValueExpression` (must evaluate to `jakarta.faces.component.UIComponent`)	The value binding expression linking this component to a property in a backing bean. For Facelets, the component is the outer UIPanel, not the input control. Type: `jakarta.faces.component.UIComponent`
`delay`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.Integer`)	Time in milliseconds before the list will be requested (by AJAX). Type: `java.lang.Integer` Default: `200`
`filter`	`false`	`javax.el.ValueExpression` (must evaluate to `org.apache.myfaces.tobago.model.SuggestFilter`)	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: all no filtering prefix checks if the suggested string starts with the typed text contains 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: `contains` Allowed Values: `[all, prefix, contains]`
`id`	`false`	`java.lang.String`	The component identifier for this component. This value must be unique within the closest parent component that is a naming container. Type: `java.lang.String`
`localMenu`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.Boolean`)	If a suggest menu is available, it will be rendered on the component, not in the '.tobago-page-menuStore'. Type: `boolean` Default: `false`
`maximumItems`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.Integer`)	The maximum number of item to display in the drop-down list. Type: `java.lang.Integer` Default: `10`
`minimumCharacters`	`false`	`javax.el.ValueExpression` (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 sent an initial list to the client. So, if you set update="false" this value should be 0. Type: `java.lang.Integer` Default: `1`
`query`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	The query is the string typed by the user. Type: `java.lang.String`
`rendered`	`false`	`javax.el.ValueExpression` (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`
`totalCount`	`false`	`javax.el.ValueExpression` (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`
`update`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.Boolean`)	Should the list be updated while typing (via AJAX). This is the default behavior. Type: `boolean` Default: `true`

All Tags

Output generated by Vdldoc View Declaration Language Documentation Generator.