Schnittstelle SuggestTagDeclaration
- Alle Superschnittstellen:
HasBinding
,HasId
,HasIdBindingAndRendered
,IsRendered
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]
- Seit:
- 2.0.0
-
Methodenübersicht
Modifizierer und TypMethodeBeschreibungvoid
Time in milliseconds before the list will be requested (by AJAX).void
Additional client side filtering of the result list.void
setLocalMenu
(String localMenu) If a suggest menu is available, it will be rendered on the component, not in the '.tobago-page-menuStore'.void
setMaximumItems
(String maximumItems) The maximum number of item to display in the drop-down list.void
setMinimumCharacters
(String minimumCharacters) Minimum number of characters to type before the list will be requested.void
The query is the string typed by the user.void
setTotalCount
(String totalCount) The real size of the result list.void
Should the list be updated while typing (via AJAX).Von Schnittstelle geerbte Methoden org.apache.myfaces.tobago.internal.taglib.declaration.HasBinding
setBinding
Von Schnittstelle geerbte Methoden org.apache.myfaces.tobago.internal.taglib.declaration.HasId
setId
Von Schnittstelle geerbte Methoden org.apache.myfaces.tobago.internal.taglib.declaration.IsRendered
setRendered
-
Methodendetails
-
setMinimumCharacters
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 setupdate="false"
this value should be 0. -
setDelay
Time in milliseconds before the list will be requested (by AJAX). -
setMaximumItems
The maximum number of item to display in the drop-down list. -
setTotalCount
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. -
setFilter
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
); -
setUpdate
Should the list be updated while typing (via AJAX). This is the default behavior.
-
setLocalMenu
If a suggest menu is available, it will be rendered on the component, not in the '.tobago-page-menuStore'.
-
setQuery
The query is the string typed by the user.
-