|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectjavax.faces.component.UIComponent
javax.faces.component.UIComponentBase
org.apache.myfaces.tobago.internal.component.AbstractUISuggest
org.apache.myfaces.tobago.component.UISuggest
public class UISuggest
Renders a list of suggested texts for a given input field. Basic features:
component2.0.stg
with class
SuggestTagDeclaration
.
Field Summary | |
---|---|
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 | |
---|---|
UISuggest()
|
Method Summary | |
---|---|
Markup |
getCurrentMarkup()
|
Integer |
getDelay()
Time in milli seconds before the list will be requested (by AJAX). |
String |
getFamily()
|
SuggestFilter |
getFilter()
TODO: not implemented yet Additional client side filtering of the result list. |
Markup |
getMarkup()
|
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.faces.el.MethodBinding |
getSuggestMethod()
Deprecated. since 2.0.0 |
javax.el.MethodExpression |
getSuggestMethodExpression()
|
Integer |
getTotalCount()
The real size of the result list. |
boolean |
isUpdate()
TODO: not implemented yet Should the list be updated while typing (via AJAX). |
Object |
saveState(javax.faces.context.FacesContext context)
|
void |
setCurrentMarkup(Markup currentMarkup)
|
void |
setDelay(Integer delay)
|
void |
setFilter(SuggestFilter filter)
|
void |
setMarkup(Markup markup)
|
void |
setMaximumItems(Integer maximumItems)
|
void |
setMinimumCharacters(Integer minimumCharacters)
|
void |
setSuggestMethod(javax.faces.el.MethodBinding suggestMethod)
Deprecated. since 2.0.0 |
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, restoreState, saveAttachedState, 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 class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final String COMPONENT_TYPE
public static final String COMPONENT_FAMILY
Constructor Detail |
---|
public UISuggest()
Method Detail |
---|
public String getFamily()
getFamily
in class AbstractUISuggest
public boolean isUpdate()
false
, please set the minimumCharacters="0".
Default: true
public void setUpdate(boolean update)
public Integer getMaximumItems()
10
public void setMaximumItems(Integer maximumItems)
@Deprecated public javax.faces.el.MethodBinding getSuggestMethod()
getSuggestMethod
in interface InputSuggest
@Deprecated public void setSuggestMethod(javax.faces.el.MethodBinding suggestMethod)
setSuggestMethod
in interface InputSuggest
public javax.el.MethodExpression getSuggestMethodExpression()
getSuggestMethodExpression
in interface InputSuggest2
public void setSuggestMethodExpression(javax.el.MethodExpression suggestMethod)
setSuggestMethodExpression
in interface InputSuggest2
public Markup getMarkup()
getMarkup
in interface SupportsMarkup
public void setMarkup(Markup markup)
setMarkup
in interface SupportsMarkup
public Integer getTotalCount()
-1
public void setTotalCount(Integer totalCount)
public Markup getCurrentMarkup()
getCurrentMarkup
in interface SupportsMarkup
public void setCurrentMarkup(Markup currentMarkup)
setCurrentMarkup
in interface SupportsMarkup
public Integer getMinimumCharacters()
update="false"this value should be 0.
1
public void setMinimumCharacters(Integer minimumCharacters)
setMinimumCharacters
in class AbstractUISuggest
public Integer getDelay()
300
public void setDelay(Integer delay)
setDelay
in class AbstractUISuggest
public SuggestFilter getFilter()
update=false
.
Possible values are:
update=false
);
SuggestFilter.ALL
all,prefix,contains
public void setFilter(SuggestFilter filter)
setFilter
in class AbstractUISuggest
public Object saveState(javax.faces.context.FacesContext context)
saveState
in interface javax.faces.component.StateHolder
saveState
in class javax.faces.component.UIComponentBase
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |