Package org.apache.myfaces.tobago.component

Klasse 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

Alle implementierten Schnittstellen:

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.

Feldübersicht

Felder

Modifizierer und Typ	Feld	Beschreibung
static final String	COMPONENT_FAMILY
static final String	COMPONENT_TYPE

Von Klasse geerbte Felder 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

Konstruktorübersicht

Konstruktoren

Konstruktor	Beschreibung
UISuggest()

Methodenübersicht

Modifizierer und Typ	Methode	Beschreibung
Integer	getDelay()	Time in milliseconds before the list will be requested (by AJAX).
String	getFamily()
SuggestFilter	getFilter()	Additional client side filtering of the result list.
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.
Integer	getTotalCount()	The real size of the result list.
boolean	isLocalMenu()	If a suggest menu is available, it will be rendered on the component, not in the '.tobago-page-menuStore'.
boolean	isUpdate()	Should the list be updated while typing (via AJAX).
void	restoreState(javax.faces.context.FacesContext context, Object state)
void	setDelay(Integer delay)
void	setFilter(SuggestFilter filter)
void	setLocalMenu(boolean localMenu)
void	setMaximumItems(Integer maximumItems)
void	setMinimumCharacters(Integer minimumCharacters)
void	setTotalCount(Integer totalCount)
void	setUpdate(boolean update)

Von Klasse geerbte Methoden org.apache.myfaces.tobago.internal.component.AbstractUISuggest

getQuery, setQuery

Von Klasse geerbte Methoden 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

Von Klasse geerbte Methoden 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

Von Klasse geerbte Methoden java.lang.Object

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

Von Schnittstelle geerbte Methoden javax.faces.component.behavior.ClientBehaviorHolder

addClientBehavior, getClientBehaviors, getDefaultEventName, getEventNames

Felddetails

COMPONENT_TYPE

public static final String COMPONENT_TYPE

COMPONENT_FAMILY

public static final String COMPONENT_FAMILY

Siehe auch:

• Konstantenfeldwerte

Konstruktordetails

UISuggest

public UISuggest()

Methodendetails

getFamily

public String getFamily()

Setzt außer Kraft:

getFamily in Klasse 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

Angegeben von:

getFilter in Klasse AbstractUISuggest

setFilter

public void setFilter(SuggestFilter filter)

Angegeben von:

setFilter in Klasse AbstractUISuggest

getDelay

public Integer getDelay()

Time in milliseconds before the list will be requested (by AJAX).
Default: 200

Angegeben von:

getDelay in Klasse AbstractUISuggest

setDelay

public void setDelay(Integer delay)

Angegeben von:

setDelay in Klasse 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

Angegeben von:

getMinimumCharacters in Klasse AbstractUISuggest

setMinimumCharacters

public void setMinimumCharacters(Integer minimumCharacters)

Angegeben von:

setMinimumCharacters in Klasse AbstractUISuggest

isUpdate

public boolean isUpdate()

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

Default: true

Angegeben von:

isUpdate in Klasse 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

Angegeben von:

getTotalCount in Klasse 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

Angegeben von:

isLocalMenu in Klasse 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

Angegeben von:

getMaximumItems in Klasse AbstractUISuggest

setMaximumItems

public void setMaximumItems(Integer maximumItems)

restoreState

public void restoreState(javax.faces.context.FacesContext context,
 Object state)

Angegeben von:

restoreState in Schnittstelle javax.faces.component.StateHolder

Setzt außer Kraft:

restoreState in Klasse javax.faces.component.UIComponentBase