Class UISuggest

  • All Implemented Interfaces:
    EventListener, javax.faces.component.behavior.ClientBehaviorHolder, javax.faces.component.PartialStateHolder, javax.faces.component.StateHolder, javax.faces.event.ComponentSystemEventListener, javax.faces.event.FacesListener, javax.faces.event.SystemEventListenerHolder, InputSuggest

    @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]
    UIComponent class, generated from template component.stg with class SuggestTagDeclaration.
    • Field Summary

      Fields 
      Modifier and Type Field Description
      static String COMPONENT_FAMILY  
      static String COMPONENT_TYPE  
      • Fields inherited from class javax.faces.component.UIComponent

        BEANINFO_KEY, bindings, COMPOSITE_COMPONENT_TYPE_KEY, COMPOSITE_FACET_NAME, CURRENT_COMPONENT, CURRENT_COMPOSITE_COMPONENT, FACETS_KEY, VIEW_LOCATION_KEY
    • Constructor Summary

      Constructors 
      Constructor Description
      UISuggest()  
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      Integer getDelay()
      Time in milli seconds before the list will be requested (by AJAX).
      String getFamily()  
      SuggestFilter getFilter()
      TODO: not implemented yet
      Integer getMaximumItems()
      The maximum number of item to display in the drop down list.
      Integer getMinimumCharacters()
      Minimum number of characters to type before the list will be requested.
      javax.el.MethodExpression getSuggestMethodExpression()  
      Integer getTotalCount()
      The real size of the result list.
      boolean isUpdate()
      TODO: not implemented yet
      void restoreState​(javax.faces.context.FacesContext context, Object state)  
      void setDelay​(Integer delay)  
      void setFilter​(SuggestFilter filter)  
      void setMaximumItems​(Integer maximumItems)  
      void setMinimumCharacters​(Integer minimumCharacters)  
      void setSuggestMethodExpression​(javax.el.MethodExpression suggestMethod)  
      void setTotalCount​(Integer totalCount)  
      void setUpdate​(boolean update)  
      • 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, getRenderer, getRendererType, getRendersChildren, getValueBinding, initialStateMarked, 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, getResourceBundleMap, getStateHelper, getStateHelper, getValueExpression, isCompositeComponent, isInView, isVisitable, popComponentFromEL, processEvent, pushComponentToEL, setInView, setValueExpression, subscribeToEvent, unsubscribeFromEvent
      • Methods inherited from interface javax.faces.component.behavior.ClientBehaviorHolder

        addClientBehavior, getClientBehaviors, getDefaultEventName, getEventNames
    • Constructor Detail

      • UISuggest

        public UISuggest()
    • Method Detail

      • getFilter

        public SuggestFilter getFilter()
        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:

        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: SuggestFilter.ALL
        Allowed Values: all,prefix,contains
      • getDelay

        public Integer getDelay()
        Time in milli seconds before the list will be requested (by AJAX).
        Default: 200
        Specified by:
        getDelay in class AbstractUISuggest
      • getSuggestMethodExpression

        public javax.el.MethodExpression getSuggestMethodExpression()
      • setSuggestMethodExpression

        public void setSuggestMethodExpression​(javax.el.MethodExpression suggestMethod)
      • getMinimumCharacters

        public Integer getMinimumCharacters()
        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
        update="false"
        this value should be 0.
        Default: 1
        Specified by:
        getMinimumCharacters in class AbstractUISuggest
      • isUpdate

        public boolean isUpdate()
        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".


        Default: true
        Specified by:
        isUpdate in class AbstractUISuggest
      • 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:
        getTotalCount in class AbstractUISuggest
      • setTotalCount

        public void setTotalCount​(Integer totalCount)
      • setMaximumItems

        public void setMaximumItems​(Integer maximumItems)
      • restoreState

        public void restoreState​(javax.faces.context.FacesContext context,
                                 Object state)
        Specified by:
        restoreState in interface javax.faces.component.StateHolder
        Overrides:
        restoreState in class javax.faces.component.UIComponentBase