Klasse UISuggest
java.lang.Object
jakarta.faces.component.UIComponent
jakarta.faces.component.UIComponentBase
org.apache.myfaces.tobago.internal.component.AbstractUISuggest
org.apache.myfaces.tobago.component.UISuggest
- Alle implementierten Schnittstellen:
- jakarta.faces.component.behavior.ClientBehaviorHolder,- jakarta.faces.component.PartialStateHolder,- jakarta.faces.component.StateHolder,- jakarta.faces.component.TransientStateHolder,- jakarta.faces.event.ComponentSystemEventListener,- jakarta.faces.event.FacesListener,- jakarta.faces.event.SystemEventListenerHolder,- EventListener
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.stg with class
 SuggestTagDeclaration.- 
FeldübersichtFelderVon Klasse geerbte Felder jakarta.faces.component.UIComponentATTRS_WITH_DECLARED_DEFAULT_VALUES, BEANINFO_KEY, bindings, COMPOSITE_COMPONENT_TYPE_KEY, COMPOSITE_FACET_NAME, FACETS_KEY, VIEW_LOCATION_KEY
- 
KonstruktorübersichtKonstruktoren
- 
MethodenübersichtModifizierer und TypMethodeBeschreibunggetDelay()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.booleanIf 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(jakarta.faces.context.FacesContext context, Object state) voidvoidsetFilter(SuggestFilter filter) voidsetLocalMenu(boolean localMenu) voidsetMaximumItems(Integer maximumItems) voidsetMinimumCharacters(Integer minimumCharacters) voidsetTotalCount(Integer totalCount) voidsetUpdate(boolean update) Von Klasse geerbte Methoden org.apache.myfaces.tobago.internal.component.AbstractUISuggestgetQuery, setQueryVon Klasse geerbte Methoden jakarta.faces.component.UIComponentBaseaddClientBehavior, 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, invokeOnComponent, isRendered, isTransient, markInitialState, processDecodes, processRestoreState, processSaveState, processUpdates, processValidators, queueEvent, removeFacesListener, restoreAttachedState, saveAttachedState, saveState, setId, setParent, setRendered, setRendererType, setTransient, visitTreeVon Klasse geerbte Methoden jakarta.faces.component.UIComponentgetClientId, 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, unsubscribeFromEventVon Klasse geerbte Methoden java.lang.Objectclone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitVon Schnittstelle geerbte Methoden jakarta.faces.component.behavior.ClientBehaviorHolderaddClientBehavior, getClientBehaviors, getDefaultEventName, getEventNames
- 
Felddetails- 
COMPONENT_TYPE
- 
COMPONENT_FAMILY- Siehe auch:
 
 
- 
- 
Konstruktordetails- 
UISuggestpublic UISuggest()
 
- 
- 
Methodendetails- 
getFamily- Setzt außer Kraft:
- getFamilyin Klasse- AbstractUISuggest
 
- 
getFilterAdditional 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- Angegeben von:
- getFilterin Klasse- AbstractUISuggest
 
- 
setFilter- Angegeben von:
- setFilterin Klasse- AbstractUISuggest
 
- 
getDelayTime in milliseconds before the list will be requested (by AJAX).
 Default:200- Angegeben von:
- getDelayin Klasse- AbstractUISuggest
 
- 
setDelay- Angegeben von:
- setDelayin Klasse- AbstractUISuggest
 
- 
getMinimumCharactersMinimum 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- Angegeben von:
- getMinimumCharactersin Klasse- AbstractUISuggest
 
- 
setMinimumCharacters- Angegeben von:
- setMinimumCharactersin Klasse- AbstractUISuggest
 
- 
isUpdatepublic boolean isUpdate()Should the list be updated while typing (via AJAX). This is the default behavior. 
 Default:true- Angegeben von:
- isUpdatein Klasse- AbstractUISuggest
 
- 
setUpdatepublic void setUpdate(boolean update) 
- 
getTotalCountThe 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- Angegeben von:
- getTotalCountin Klasse- AbstractUISuggest
 
- 
setTotalCount
- 
isLocalMenupublic boolean isLocalMenu()If a suggest menu is available, it will be rendered on the component, not in the '.tobago-page-menuStore'. 
 Default:false- Angegeben von:
- isLocalMenuin Klasse- AbstractUISuggest
 
- 
setLocalMenupublic void setLocalMenu(boolean localMenu) 
- 
getMaximumItemsThe maximum number of item to display in the drop-down list.
 Default:10- Angegeben von:
- getMaximumItemsin Klasse- AbstractUISuggest
 
- 
setMaximumItems
- 
restoreState- Angegeben von:
- restoreStatein Schnittstelle- jakarta.faces.component.StateHolder
- Setzt außer Kraft:
- restoreStatein Klasse- jakarta.faces.component.UIComponentBase
 
 
-