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

    Fields
    Modifier and Type
    Field
    Description
    static final String
     
    static final String
     

    Fields inherited from class javax.faces.component.UIComponent

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

    Constructors
    Constructor
    Description
     
  • Method Summary

    Modifier and Type
    Method
    Description
    Time in milliseconds before the list will be requested (by AJAX).
     
    Additional client side filtering of the result list.
    The maximum number of item to display in the drop-down list.
    Minimum number of characters to type before the list will be requested.
    The real size of the result list.
    boolean
    If a suggest menu is available, it will be rendered on the component, not in the '.tobago-page-menuStore'.
    boolean
    Should the list be updated while typing (via AJAX).
    void
    restoreState(javax.faces.context.FacesContext context, Object state)
     
    void
     
    void
     
    void
    setLocalMenu(boolean localMenu)
     
    void
    setMaximumItems(Integer maximumItems)
     
    void
    setMinimumCharacters(Integer minimumCharacters)
     
    void
    setTotalCount(Integer totalCount)
     
    void
    setUpdate(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

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    Methods inherited from interface javax.faces.component.behavior.ClientBehaviorHolder

    addClientBehavior, getClientBehaviors, getDefaultEventName, getEventNames
  • Field Details

  • Constructor Details

    • UISuggest

      public UISuggest()
  • Method Details

    • getFamily

      public String getFamily()
      Overrides:
      getFamily in class AbstractUISuggest
    • 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:
      getFilter in class AbstractUISuggest
    • setFilter

      public void setFilter(SuggestFilter filter)
      Specified by:
      setFilter in class AbstractUISuggest
    • getDelay

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

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

      public void setMinimumCharacters(Integer minimumCharacters)
      Specified by:
      setMinimumCharacters in class AbstractUISuggest
    • isUpdate

      public boolean isUpdate()

      Should the list be updated while typing (via AJAX). This is the default behavior.


      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)
    • 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:
      isLocalMenu in class AbstractUISuggest
    • 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:
      getMaximumItems in class AbstractUISuggest
    • 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