public abstract class AbstractSelect extends AbstractSelectComponent implements SelectItemsInterface, MetaComponentResolver, MetaComponentEncoder, CoreProps, DisabledProps, EventsKeyProps, EventsMouseProps, SelectProps, AutocompleteProps, SelectItemsProps
The <rich:select> component provides a drop-down list box for selecting a single value from multiple options. The <rich:select> component can be configured as a combo-box, where it will accept typed input. The component also supports keyboard navigation. The <rich:select> component functions similarly to the JSF UISelectOne component.
The <rich:select> can optionally be used in an auto-completing mode, where the values in the drop-down list are provided dynamically using either the autocompleteMethod or autocompleteList attributes. If these attributes are omitted, the component operates in the traditional non-auto-completing mode. Refer to the individual attribute documentation to see which attributes are applicable only with an auto-completing select list.
| Modifier and Type | Field and Description |
|---|---|
static String |
COMPONENT_FAMILY |
static String |
COMPONENT_TYPE |
static String |
ITEMS_META_COMPONENT_ID |
CONVERSION_MESSAGE_ID, REQUIRED_MESSAGE_ID, UPDATE_MESSAGE_ID, VALIDATE_EMPTY_FIELDS_PARAM_NAMEATTRS_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_KEYMETA_COMPONENT_SEPARATOR_CHAR| Constructor and Description |
|---|
AbstractSelect() |
| Modifier and Type | Method and Description |
|---|---|
void |
encodeMetaComponent(javax.faces.context.FacesContext context,
String metaComponentId) |
abstract String |
getActiveClass()
Space-separated list of CSS style class(es) to be applied to the list element when it is in the "active" state.
|
abstract String |
getChangedClass()
Space-separated list of CSS style class(es) to be applied to the list element when it is in the "changed" state.
|
abstract String |
getClientFilterFunction()
A javascript function used to filter the list of items in the select popup
|
abstract String |
getDisabledClass()
Space-separated list of CSS style class(es) to be applied to the list element when it is disabled.
|
abstract Object |
getItemLabel()
Label to be displayed to the user for the corresponding option.
|
abstract Object |
getItemValue()
Value to be returned to the server if the corresponding option is selected by the user.
|
Object |
getItemValues() |
abstract String |
getMaxListHeight()
The maximum height of the list
|
abstract String |
getMinListHeight()
The minimum height ot the list
|
abstract String |
getVar()
Expose the values from either the autocompleteList or autocompleteMethod attributes under a request scoped key so that the values may be referred to in an EL expression while rendering this component.
|
abstract boolean |
isEnableManualInput()
If "true" Allows the user to type into a text field to scroll through or filter the list.
|
abstract boolean |
isSelectFirst()
If "true" as the user types to narrow the list, automatically select the first element in the list.
|
abstract boolean |
isShowButton()
When "true" display a button to expand the popup list
|
void |
processEvent(javax.faces.event.ComponentSystemEvent event) |
String |
resolveClientId(javax.faces.context.FacesContext facesContext,
javax.faces.component.UIComponent contextComponent,
String metaComponentId)
Resolves and returns string identifying supported meta-component or
null if provided meta-component name is
not a supported one. |
String |
substituteUnresolvedClientId(javax.faces.context.FacesContext facesContext,
javax.faces.component.UIComponent contextComponent,
String metaComponentId)
Provides replacement for unresolved meta-component names.
|
protected void |
validateValue(javax.faces.context.FacesContext facesContext,
Object value)
Override the validateValue method in cases where the component implements SelectItemsInterface
|
boolean |
visitTree(javax.faces.component.visit.VisitContext context,
javax.faces.component.visit.VisitCallback callback) |
getOnchange, getOnlistclick, getOnlistdblclick, getOnlisthide, getOnlistkeydown, getOnlistkeypress, getOnlistkeyup, getOnlistmousedown, getOnlistmousemove, getOnlistmouseout, getOnlistmouseover, getOnlistmouseup, getOnlistshow, getOnselectitemaddValidator, addValueChangeListener, clearInitialState, compareValues, decode, getConvertedValue, getConverterMessage, getRequiredMessage, getSubmittedValue, getValidator, getValidatorMessage, getValidators, getValue, 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, validategetConverter, getLocalValue, setConverteraddClientBehavior, addFacesListener, broadcast, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientBehaviors, getClientId, getDefaultEventName, getEventNames, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getListenersForEventClass, getParent, getPassThroughAttributes, getRenderer, getRendererType, getRendersChildren, getValueBinding, invokeOnComponent, isRendered, isTransient, processRestoreState, processSaveState, queueEvent, removeFacesListener, restoreAttachedState, saveAttachedState, setId, setParent, setRendered, setRendererType, setTransient, setValueBinding, subscribeToEvent, unsubscribeFromEventencodeAll, getClientId, getCompositeComponentParent, getContainerClientId, getCurrentComponent, getCurrentCompositeComponent, getNamingContainer, getPassThroughAttributes, getResourceBundleMap, getStateHelper, getStateHelper, getTransientStateHelper, getTransientStateHelper, getValueExpression, initialStateMarked, isCompositeComponent, isInView, isVisitable, popComponentFromEL, pushComponentToEL, restoreTransientState, saveTransientState, setInView, setValueExpressionclone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitgetStyle, getStyleClass, getTitleisDisabledgetOnkeydown, getOnkeypress, getOnkeyupgetOnclick, getOndblclick, getOnmousedown, getOnmousemove, getOnmouseout, getOnmouseover, getOnmouseupgetDefaultLabel, getItemClass, getListClass, getListHeight, getListWidth, getSelectItemClassgetAutocompleteList, getAutocompleteMethod, getAutocompleteMethodWithOneParameter, getMinChars, getMode, setAutocompleteMethod, setAutocompleteMethodWithOneParametergetOnblur, getOnfocus, getTabindexpublic static final String ITEMS_META_COMPONENT_ID
public static final String COMPONENT_TYPE
public static final String COMPONENT_FAMILY
public Object getItemValues()
getItemValues in interface SelectItemsInterfacepublic abstract boolean isEnableManualInput()
If "true" Allows the user to type into a text field to scroll through or filter the list. Implicitly true when using an auto-completing select list.
Default is "false"
public abstract boolean isSelectFirst()
If "true" as the user types to narrow the list, automatically select the first element in the list. Applicable only when enableManualInput is "true".
Default is "true"
public abstract boolean isShowButton()
When "true" display a button to expand the popup list
Default is "true"
public abstract String getMinListHeight()
public abstract String getMaxListHeight()
public abstract String getClientFilterFunction()
public abstract String getActiveClass()
SelectPropsgetActiveClass in interface SelectPropspublic abstract String getChangedClass()
SelectPropsgetChangedClass in interface SelectPropspublic abstract String getDisabledClass()
SelectPropsgetDisabledClass in interface SelectPropspublic abstract Object getItemValue()
getItemValue in interface SelectItemsPropspublic abstract Object getItemLabel()
getItemLabel in interface SelectItemsPropspublic abstract String getVar()
getVar in interface AutocompletePropsgetVar in interface SelectItemsPropsprotected void validateValue(javax.faces.context.FacesContext facesContext,
Object value)
validateValue in class javax.faces.component.UISelectOnefacesContext - value - public void processEvent(javax.faces.event.ComponentSystemEvent event)
throws javax.faces.event.AbortProcessingException
processEvent in interface javax.faces.event.ComponentSystemEventListenerprocessEvent in class javax.faces.component.UIComponentjavax.faces.event.AbortProcessingExceptionpublic String resolveClientId(javax.faces.context.FacesContext facesContext, javax.faces.component.UIComponent contextComponent, String metaComponentId)
MetaComponentResolvernull if provided meta-component name is
not a supported one.resolveClientId in interface MetaComponentResolverfacesContext - - current instance of FacesContextcontextComponent - - instance of UIComponent that requested resolution of meta-componentmetaComponentId - - name of meta-component (without leading '@' sign)nullpublic boolean visitTree(javax.faces.component.visit.VisitContext context,
javax.faces.component.visit.VisitCallback callback)
visitTree in class javax.faces.component.UIComponentpublic void encodeMetaComponent(javax.faces.context.FacesContext context,
String metaComponentId)
throws IOException
encodeMetaComponent in interface MetaComponentEncoderIOExceptionpublic String substituteUnresolvedClientId(javax.faces.context.FacesContext facesContext, javax.faces.component.UIComponent contextComponent, String metaComponentId)
MetaComponentResolvernullsubstituteUnresolvedClientId in interface MetaComponentResolverfacesContext - - current instance of FacesContextcontextComponent - - instance of UIComponent that requested resolution of meta-componentmetaComponentId - - name of meta-component (without leading '@' sign)nullCopyright © 2014 JBoss by Red Hat. All Rights Reserved.