Class UISuggest
- java.lang.Object
-
- javax.faces.component.UIComponent
-
- javax.faces.component.UIComponentBase
-
- org.apache.myfaces.tobago.internal.component.AbstractUISuggest
-
- org.apache.myfaces.tobago.component.UISuggest
-
- All Implemented Interfaces:
EventListener,javax.faces.component.behavior.ClientBehaviorHolder,javax.faces.component.PartialStateHolder,javax.faces.component.StateHolder,javax.faces.component.TransientStateHolder,javax.faces.event.ComponentSystemEventListener,javax.faces.event.FacesListener,javax.faces.event.SystemEventListenerHolder
@Generated("component.stg") public class UISuggest extends AbstractUISuggest
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]
component.stgwith classSuggestTagDeclaration.
-
-
Field Summary
Fields Modifier and Type Field Description static StringCOMPONENT_FAMILYstatic StringCOMPONENT_TYPE
-
Constructor Summary
Constructors Constructor Description UISuggest()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description IntegergetDelay()Time in milliseconds before the list will be requested (by AJAX).StringgetFamily()SuggestFiltergetFilter()Additional client side filtering of the result list.IntegergetMaximumItems()The maximum number of item to display in the drop-down list.IntegergetMinimumCharacters()Minimum number of characters to type before the list will be requested.IntegergetTotalCount()The real size of the result list.booleanisLocalMenu()If a suggest menu is available, it will be rendered on the component, not in the '.tobago-page-menuStore'.booleanisUpdate()Should the list be updated while typing (via AJAX).voidrestoreState(javax.faces.context.FacesContext context, Object state)voidsetDelay(Integer delay)voidsetFilter(SuggestFilter filter)voidsetLocalMenu(boolean localMenu)voidsetMaximumItems(Integer maximumItems)voidsetMinimumCharacters(Integer minimumCharacters)voidsetTotalCount(Integer totalCount)voidsetUpdate(boolean update)-
Methods inherited from class org.apache.myfaces.tobago.internal.component.AbstractUISuggest
getQuery, setQuery
-
Methods inherited from class javax.faces.component.UIComponentBase
addClientBehavior, addFacesListener, broadcast, clearInitialState, decode, encodeAll, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientBehaviors, getClientId, getDefaultEventName, getEventNames, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getParent, getPassThroughAttributes, getRenderer, getRendererType, getRendersChildren, getValueBinding, invokeOnComponent, isRendered, isTransient, markInitialState, processDecodes, processRestoreState, processSaveState, processUpdates, processValidators, queueEvent, removeFacesListener, restoreAttachedState, saveAttachedState, saveState, setId, setParent, setRendered, setRendererType, setTransient, setValueBinding, visitTree
-
Methods inherited from class javax.faces.component.UIComponent
getClientId, getCompositeComponentParent, getContainerClientId, getCurrentComponent, getCurrentCompositeComponent, getListenersForEventClass, getNamingContainer, getPassThroughAttributes, getResourceBundleMap, getStateHelper, getStateHelper, getTransientStateHelper, getTransientStateHelper, getValueExpression, initialStateMarked, isCompositeComponent, isInView, isVisitable, popComponentFromEL, processEvent, pushComponentToEL, restoreTransientState, saveTransientState, setInView, setValueExpression, subscribeToEvent, unsubscribeFromEvent
-
-
-
-
Field Detail
-
COMPONENT_TYPE
public static final String COMPONENT_TYPE
-
COMPONENT_FAMILY
public static final String COMPONENT_FAMILY
- See Also:
- Constant Field Values
-
-
Method Detail
-
getFamily
public String getFamily()
- Overrides:
getFamilyin classAbstractUISuggest
-
getFilter
public SuggestFilter getFilter()
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);
Default:contains
Allowed Values:all,prefix,contains- Specified by:
getFilterin classAbstractUISuggest
-
setFilter
public void setFilter(SuggestFilter filter)
- Specified by:
setFilterin classAbstractUISuggest
-
getDelay
public Integer getDelay()
Time in milliseconds before the list will be requested (by AJAX).
Default:200- Specified by:
getDelayin classAbstractUISuggest
-
setDelay
public void setDelay(Integer delay)
- Specified by:
setDelayin classAbstractUISuggest
-
getMinimumCharacters
public Integer getMinimumCharacters()
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.
Default:1- Specified by:
getMinimumCharactersin classAbstractUISuggest
-
setMinimumCharacters
public void setMinimumCharacters(Integer minimumCharacters)
- Specified by:
setMinimumCharactersin classAbstractUISuggest
-
isUpdate
public boolean isUpdate()
Should the list be updated while typing (via AJAX). This is the default behavior.
Default:true- Specified by:
isUpdatein classAbstractUISuggest
-
setUpdate
public void setUpdate(boolean update)
-
getTotalCount
public Integer getTotalCount()
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.
Default:-1- Specified by:
getTotalCountin classAbstractUISuggest
-
setTotalCount
public void setTotalCount(Integer totalCount)
-
isLocalMenu
public boolean isLocalMenu()
If a suggest menu is available, it will be rendered on the component, not in the '.tobago-page-menuStore'.
Default:false- Specified by:
isLocalMenuin classAbstractUISuggest
-
setLocalMenu
public void setLocalMenu(boolean localMenu)
-
getMaximumItems
public Integer getMaximumItems()
The maximum number of item to display in the drop-down list.
Default:10- Specified by:
getMaximumItemsin classAbstractUISuggest
-
setMaximumItems
public void setMaximumItems(Integer maximumItems)
-
restoreState
public void restoreState(javax.faces.context.FacesContext context, Object state)- Specified by:
restoreStatein interfacejavax.faces.component.StateHolder- Overrides:
restoreStatein classjavax.faces.component.UIComponentBase
-
-