|
RichFaces UI Components UI 4.2.1.CR1 | |||||||||
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
javax.faces.component.UIOutput
javax.faces.component.UIInput
org.richfaces.component.AbstractAutocomplete
public abstract class AbstractAutocomplete
The <rich:autocomplete> component is an auto-completing input-box with built-in Ajax capabilities. It supports client-side suggestions, browser-like selection, and customization of the look and feel.
Field Summary | |
---|---|
static String |
COMPONENT_FAMILY
|
static String |
COMPONENT_TYPE
|
static String |
ITEMS_META_COMPONENT_ID
|
Fields inherited from class javax.faces.component.UIInput |
---|
CONVERSION_MESSAGE_ID, REQUIRED_MESSAGE_ID, UPDATE_MESSAGE_ID, VALIDATE_EMPTY_FIELDS_PARAM_NAME |
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 |
Fields inherited from interface org.richfaces.component.MetaComponentResolver |
---|
META_COMPONENT_SEPARATOR_CHAR |
Constructor Summary | |
---|---|
AbstractAutocomplete()
|
Method Summary | |
---|---|
void |
encodeMetaComponent(javax.faces.context.FacesContext context,
String metaComponentId)
|
abstract Object |
getAutocompleteList()
A collection of suggestions that will be resented to the user |
abstract javax.el.MethodExpression |
getAutocompleteMethod()
A method which returns a list of suggestions according to a supplied prefix |
abstract String |
getClientFilterFunction()
A javascript function used to filter the result list returned from the ajax call to the server. |
abstract Object |
getFetchValue()
A value to set in the target input element on a choice suggestion that isn't shown in the suggestion table. |
abstract String |
getInputClass()
Assigns one or more space-separated CSS class names to the input element |
abstract String |
getLayout()
Type of the layout encoded using nested components should be defined using layout attribute. |
abstract int |
getMinChars()
Minimal number of chars in input to activate suggestion popup |
abstract org.richfaces.component.AutocompleteMode |
getMode()
Determine how the suggestion list is requested: |
abstract String |
getOnbeforedomupdate()
The client-side script method to be called after the ajax response comes back, but before the DOM is updated |
abstract String |
getOnbegin()
The client-side script method to be called before an ajax request. |
abstract String |
getOnblur()
|
abstract String |
getOnchange()
Javascript code executed when this element loses focus and its value has been modified since gaining focus. |
abstract String |
getOnclick()
|
abstract String |
getOncomplete()
The client-side script method to be called after the DOM is updated |
abstract String |
getOndblclick()
|
abstract String |
getOnerror()
The client-side script method to be called when an error has occurred during Ajax communications |
abstract String |
getOnfocus()
|
abstract String |
getOnkeydown()
|
abstract String |
getOnkeypress()
|
abstract String |
getOnkeyup()
|
abstract String |
getOnlistclick()
Javascript code executed when a pointer button is clicked over the popup list element. |
abstract String |
getOnlistdblclick()
Javascript code executed when a pointer button is double clicked over this element. |
abstract String |
getOnlistkeydown()
Javascript code executed when a key is pressed down over this element. |
abstract String |
getOnlistkeypress()
Javascript code executed when a key is pressed and released over this element. |
abstract String |
getOnlistkeyup()
Javascript code executed when a key is released over this element. |
abstract String |
getOnlistmousedown()
Javascript code executed when a pointer button is pressed down over this element. |
abstract String |
getOnlistmousemove()
Javascript code executed when a pointer button is moved within this element. |
abstract String |
getOnlistmouseout()
Javascript code executed when a pointer button is moved away from this element. |
abstract String |
getOnlistmouseover()
Javascript code executed when a pointer button is moved onto this element. |
abstract String |
getOnlistmouseup()
Javascript code executed when a pointer button is released over this element. |
abstract String |
getOnmousedown()
|
abstract String |
getOnmousemove()
|
abstract String |
getOnmouseout()
|
abstract String |
getOnmouseover()
|
abstract String |
getOnmouseup()
|
abstract String |
getOnselectitem()
Javascript code executed when an item is selected |
abstract String |
getPopupClass()
Assigns one or more space-separated CSS class names to the content of the popup suggestion element |
abstract String |
getSelectedItemClass()
Assigns one or more space-separated CSS class names to the selected suggestion entry |
abstract String |
getStyle()
CSS style(s) to be applied when this component is rendered. |
abstract String |
getStyleClass()
Space-separated list of CSS style class(es) to be applied when this element is rendered. |
abstract int |
getTabindex()
|
abstract String |
getTokens()
Allow a user to enter multiple values separated by specific characters. |
abstract String |
getVar()
A request-scope attribute via which the data object for the current row will be used when iterating |
abstract boolean |
isAutofill()
Causes the combo-box to fill the text field box with a matching suggestion as the user types |
abstract boolean |
isDisabled()
Boolean value indicating whether this component is disabled |
abstract boolean |
isSelectFirst()
Boolean value indicating whether the first suggestion item is selected as the user types |
abstract boolean |
isShowButton()
Boolean value indicating whether to display a button to expand the popup suggestion element |
String |
resolveClientId(javax.faces.context.FacesContext facesContext,
javax.faces.component.UIComponent contextComponent,
String metaComponentId)
|
abstract void |
setAutocompleteMethod(javax.el.MethodExpression expression)
|
String |
substituteUnresolvedClientId(javax.faces.context.FacesContext facesContext,
javax.faces.component.UIComponent contextComponent,
String metaComponentId)
|
boolean |
visitTree(javax.faces.component.visit.VisitContext context,
javax.faces.component.visit.VisitCallback callback)
|
Methods inherited from class javax.faces.component.UIInput |
---|
addValidator, addValueChangeListener, clearInitialState, compareValues, decode, getConvertedValue, getConverterMessage, getFamily, getRequiredMessage, getSubmittedValue, getValidator, getValidatorMessage, getValidators, getValueChangeListener, getValueChangeListeners, isEmpty, isImmediate, isLocalValueSet, isRequired, isValid, markInitialState, processDecodes, processUpdates, processValidators, removeValidator, removeValueChangeListener, resetValue, restoreState, saveState, setConverterMessage, setImmediate, setLocalValueSet, setRequired, setRequiredMessage, setSubmittedValue, setValid, setValidator, setValidatorMessage, setValue, setValueChangeListener, updateModel, validate, validateValue |
Methods inherited from class javax.faces.component.UIOutput |
---|
getConverter, getLocalValue, getValue, setConverter |
Methods inherited from class javax.faces.component.UIComponentBase |
---|
addClientBehavior, addFacesListener, broadcast, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientBehaviors, getClientId, getDefaultEventName, getEventNames, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getListenersForEventClass, getParent, getRenderer, getRendererType, getRendersChildren, getValueBinding, invokeOnComponent, isRendered, isTransient, processRestoreState, processSaveState, queueEvent, removeFacesListener, restoreAttachedState, saveAttachedState, setId, setParent, setRendered, setRendererType, setTransient, setValueBinding, subscribeToEvent, unsubscribeFromEvent |
Methods inherited from class javax.faces.component.UIComponent |
---|
encodeAll, getClientId, getCompositeComponentParent, getContainerClientId, getCurrentComponent, getCurrentCompositeComponent, getNamingContainer, getResourceBundleMap, getStateHelper, getStateHelper, getTransientStateHelper, getTransientStateHelper, getValueExpression, initialStateMarked, isCompositeComponent, isInView, isVisitable, popComponentFromEL, processEvent, pushComponentToEL, restoreTransientState, saveTransientState, setInView, setValueExpression |
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.ValueHolder |
---|
getConverter, getLocalValue, getValue, setConverter |
Field Detail |
---|
public static final String ITEMS_META_COMPONENT_ID
public static final String COMPONENT_TYPE
public static final String COMPONENT_FAMILY
Constructor Detail |
---|
public AbstractAutocomplete()
Method Detail |
---|
public abstract Object getAutocompleteList()
public abstract javax.el.MethodExpression getAutocompleteMethod()
public abstract void setAutocompleteMethod(javax.el.MethodExpression expression)
public abstract String getVar()
public abstract Object getFetchValue()
public abstract int getMinChars()
public abstract String getSelectedItemClass()
public abstract String getPopupClass()
public abstract String getInputClass()
public abstract org.richfaces.component.AutocompleteMode getMode()
Determine how the suggestion list is requested:
Default: cachedAjax
public abstract String getLayout()
Type of the layout encoded using nested components should be defined using layout attribute. Possible values are:
Default: div
public abstract String getTokens()
public abstract boolean isAutofill()
public abstract boolean isDisabled()
Default: false
public abstract boolean isShowButton()
Boolean value indicating whether to display a button to expand the popup suggestion element
Default: false
public abstract boolean isSelectFirst()
Default: true
public abstract String getClientFilterFunction()
A javascript function used to filter the result list returned from the ajax call to the server. This function should have two parameters; subString(current input value considering tokens) and value (currently iterated item value) and return boolean flag which means if the value satisfies the substring passed. The function will be called for every available suggestion in order to construct a new list of suggestions.
Default: A javascript method called startsWith
public abstract String getStyle()
public abstract String getStyleClass()
public abstract int getTabindex()
public abstract String getOnselectitem()
public abstract String getOnchange()
public abstract String getOnlistclick()
public abstract String getOnlistdblclick()
public abstract String getOnlistmousedown()
public abstract String getOnlistmouseup()
public abstract String getOnlistmouseover()
public abstract String getOnlistmousemove()
public abstract String getOnlistmouseout()
public abstract String getOnlistkeypress()
public abstract String getOnlistkeydown()
public abstract String getOnlistkeyup()
public abstract String getOnclick()
public abstract String getOndblclick()
public abstract String getOnmousedown()
public abstract String getOnmouseup()
public abstract String getOnmouseover()
public abstract String getOnmousemove()
public abstract String getOnmouseout()
public abstract String getOnkeypress()
public abstract String getOnkeydown()
public abstract String getOnkeyup()
public abstract String getOnblur()
public abstract String getOnfocus()
public abstract String getOnbegin()
public abstract String getOnerror()
public abstract String getOncomplete()
public abstract String getOnbeforedomupdate()
public String resolveClientId(javax.faces.context.FacesContext facesContext, javax.faces.component.UIComponent contextComponent, String metaComponentId)
resolveClientId
in interface org.richfaces.component.MetaComponentResolver
public String substituteUnresolvedClientId(javax.faces.context.FacesContext facesContext, javax.faces.component.UIComponent contextComponent, String metaComponentId)
substituteUnresolvedClientId
in interface org.richfaces.component.MetaComponentResolver
public boolean visitTree(javax.faces.component.visit.VisitContext context, javax.faces.component.visit.VisitCallback callback)
visitTree
in class javax.faces.component.UIComponent
public void encodeMetaComponent(javax.faces.context.FacesContext context, String metaComponentId) throws IOException
encodeMetaComponent
in interface org.richfaces.component.MetaComponentEncoder
IOException
|
RichFaces UI Components UI 4.2.1.CR1 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |