Class UISuggest

java.lang.Object
org.apache.myfaces.tobago.internal.component.AbstractUISuggest
org.apache.myfaces.tobago.component.UISuggest
All Implemented Interfaces:
EventListener
@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 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)

    • isLocalMenu

      public boolean isLocalMenu()

      By default, dropdown menus are rendered in the '.tobago-page-menuStore'. If localMenu=true, the dropdown menu is rendered on the component.


      Default: false
      Specified by:
      isLocalMenu in class AbstractUISuggest

    • setLocalMenu

      public void setLocalMenu(boolean localMenu)

    • 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)

    • 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(jakarta.faces.context.FacesContext context, Object state)

    • addClientBehavior

      void addClientBehavior(String arg0, jakarta.faces.component.behavior.ClientBehavior arg1)

    • getClientBehaviors

      Map<String, List<jakarta.faces.component.behavior.ClientBehavior>> getClientBehaviors()

    • getDefaultEventName

      String getDefaultEventName()

    • getEventNames

      Collection<String> getEventNames()

    • setId

      public void setId(String arg0)

    • setParent

      public void setParent(jakarta.faces.component.UIComponent arg0)

    • addClientBehavior

      public void addClientBehavior(String arg0, jakarta.faces.component.behavior.ClientBehavior arg1)

    • broadcast

      public void broadcast(jakarta.faces.event.FacesEvent arg0) throws jakarta.faces.event.AbortProcessingException
      Throws:
      jakarta.faces.event.AbortProcessingException

    • clearInitialState

      public void clearInitialState()

    • decode

      public void decode(jakarta.faces.context.FacesContext arg0)

    • encodeAll

      public void encodeAll(jakarta.faces.context.FacesContext arg0) throws IOException
      Throws:
      IOException

    • encodeBegin

      public void encodeBegin(jakarta.faces.context.FacesContext arg0) throws IOException
      Throws:
      IOException

    • encodeChildren

      public void encodeChildren(jakarta.faces.context.FacesContext arg0) throws IOException
      Throws:
      IOException

    • encodeEnd

      public void encodeEnd(jakarta.faces.context.FacesContext arg0) throws IOException
      Throws:
      IOException

    • findComponent

      public jakarta.faces.component.UIComponent findComponent(String arg0)

    • getAttributes

      public Map<String,Object> getAttributes()

    • getPassThroughAttributes

      public Map<String,Object> getPassThroughAttributes(boolean arg0)

    • getChildCount

      public int getChildCount()

    • getChildren

      public List<jakarta.faces.component.UIComponent> getChildren()

    • getClientBehaviors

      public Map<String, List<jakarta.faces.component.behavior.ClientBehavior>> getClientBehaviors()

    • getClientId

      public String getClientId(jakarta.faces.context.FacesContext arg0)

    • getDefaultEventName

      public String getDefaultEventName()

    • getEventNames

      public Collection<String> getEventNames()

    • getFacet

      public jakarta.faces.component.UIComponent getFacet(String arg0)

    • getFacetCount

      public int getFacetCount()

    • getFacets

      public Map<String, jakarta.faces.component.UIComponent> getFacets()

    • getFacetsAndChildren

      public Iterator<jakarta.faces.component.UIComponent> getFacetsAndChildren()

    • getId

      public String getId()

    • getParent

      public jakarta.faces.component.UIComponent getParent()

    • getRendererType

      public String getRendererType()

    • getRendersChildren

      public boolean getRendersChildren()

    • invokeOnComponent

      public boolean invokeOnComponent(jakarta.faces.context.FacesContext arg0, String arg1, jakarta.faces.component.ContextCallback arg2) throws jakarta.faces.FacesException
      Throws:
      jakarta.faces.FacesException

    • visitTree

      public boolean visitTree(jakarta.faces.component.visit.VisitContext arg0, jakarta.faces.component.visit.VisitCallback arg1)

    • isRendered

      public boolean isRendered()

    • isTransient

      public boolean isTransient()

    • markInitialState

      public void markInitialState()

    • addFacesListener

      protected void addFacesListener(jakarta.faces.event.FacesListener arg0)

    • getFacesContext

      protected jakarta.faces.context.FacesContext getFacesContext()

    • getFacesListeners

      protected jakarta.faces.event.FacesListener[] getFacesListeners(Class arg0)

    • getRenderer

      protected jakarta.faces.render.Renderer getRenderer(jakarta.faces.context.FacesContext arg0)

    • removeFacesListener

      protected void removeFacesListener(jakarta.faces.event.FacesListener arg0)

    • queueEvent

      public void queueEvent(jakarta.faces.event.FacesEvent arg0)

    • processDecodes

      public void processDecodes(jakarta.faces.context.FacesContext arg0)

    • processValidators

      public void processValidators(jakarta.faces.context.FacesContext arg0)

    • processUpdates

      public void processUpdates(jakarta.faces.context.FacesContext arg0)

    • processSaveState

      public Object processSaveState(jakarta.faces.context.FacesContext arg0)

    • processRestoreState

      public void processRestoreState(jakarta.faces.context.FacesContext arg0, Object arg1)

    • setTransient

      public void setTransient(boolean arg0)

    • saveAttachedState

      public static Object saveAttachedState(jakarta.faces.context.FacesContext arg0, Object arg1)

    • restoreAttachedState

      public static Object restoreAttachedState(jakarta.faces.context.FacesContext arg0, Object arg1) throws IllegalStateException
      Throws:
      IllegalStateException

    • saveState

      public Object saveState(jakarta.faces.context.FacesContext arg0)

    • setRendered

      public void setRendered(boolean arg0)

    • setRendererType

      public void setRendererType(String arg0)

    • getPassThroughAttributes

      public Map<String,Object> getPassThroughAttributes()

    • initialStateMarked

      public boolean initialStateMarked()

    • isCompositeComponent

      public static boolean isCompositeComponent(jakarta.faces.component.UIComponent arg0)

    • isInView

      public boolean isInView()

    • isVisitable

      protected boolean isVisitable(jakarta.faces.component.visit.VisitContext arg0)

    • setValueExpression

      public void setValueExpression(String arg0, jakarta.el.ValueExpression arg1)

    • getClientId

      public String getClientId()

    • getCompositeComponentParent

      public static jakarta.faces.component.UIComponent getCompositeComponentParent(jakarta.faces.component.UIComponent arg0)

    • getContainerClientId

      public String getContainerClientId(jakarta.faces.context.FacesContext arg0)

    • getCurrentComponent

      public static jakarta.faces.component.UIComponent getCurrentComponent(jakarta.faces.context.FacesContext arg0)

    • getCurrentCompositeComponent

      public static jakarta.faces.component.UIComponent getCurrentCompositeComponent(jakarta.faces.context.FacesContext arg0)

    • getListenersForEventClass

      public List<jakarta.faces.event.SystemEventListener> getListenersForEventClass(Class<? extends jakarta.faces.event.SystemEvent> arg0)

    • getNamingContainer

      public jakarta.faces.component.UIComponent getNamingContainer()

    • setInView

      public void setInView(boolean arg0)

    • getResourceBundleMap

      public Map<String,String> getResourceBundleMap()

    • getValueExpression

      public jakarta.el.ValueExpression getValueExpression(String arg0)

    • processEvent

      public void processEvent(jakarta.faces.event.ComponentSystemEvent arg0) throws jakarta.faces.event.AbortProcessingException
      Throws:
      jakarta.faces.event.AbortProcessingException

    • subscribeToEvent

      public void subscribeToEvent(Class<? extends jakarta.faces.event.SystemEvent> arg0, jakarta.faces.event.ComponentSystemEventListener arg1)

    • unsubscribeFromEvent

      public void unsubscribeFromEvent(Class<? extends jakarta.faces.event.SystemEvent> arg0, jakarta.faces.event.ComponentSystemEventListener arg1)

    • getStateHelper

      protected jakarta.faces.component.StateHelper getStateHelper()

    • getStateHelper

      protected jakarta.faces.component.StateHelper getStateHelper(boolean arg0)

    • getTransientStateHelper

      public jakarta.faces.component.TransientStateHelper getTransientStateHelper()

    • getTransientStateHelper

      public jakarta.faces.component.TransientStateHelper getTransientStateHelper(boolean arg0)

    • restoreTransientState

      public void restoreTransientState(jakarta.faces.context.FacesContext arg0, Object arg1)

    • saveTransientState

      public Object saveTransientState(jakarta.faces.context.FacesContext arg0)

    • popComponentFromEL

      public void popComponentFromEL(jakarta.faces.context.FacesContext arg0)

    • pushComponentToEL

      public void pushComponentToEL(jakarta.faces.context.FacesContext arg0, jakarta.faces.component.UIComponent arg1)