@Generated(value={"RichFaces CDK","4.5.0-SNAPSHOT"}) public class UISelect extends AbstractSelect implements javax.faces.component.behavior.ClientBehaviorHolder, MetaComponentEncoder, MetaComponentResolver, AutocompleteProps, CoreProps, DisabledProps, EventsKeyProps, EventsMouseProps, SelectItemsProps, SelectProps, SelectItemsInterface
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 | Class and Description |
|---|---|
protected static class |
UISelect.Properties |
| Modifier and Type | Field and Description |
|---|---|
static String |
COMPONENT_FAMILY |
static String |
COMPONENT_TYPE |
ITEMS_META_COMPONENT_IDCONVERSION_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 |
|---|
UISelect() |
| Modifier and Type | Method and Description |
|---|---|
String |
getActiveClass()
Space-separated list of CSS style class(es) to be applied to the list element when it is in the "active" state.
|
Object |
getAutocompleteList()
A collection of suggestions that will be provided to the user
|
javax.el.MethodExpression |
getAutocompleteMethod()
A method which provides a list of suggestions according to a user-provided filtering value
|
javax.el.MethodExpression |
getAutocompleteMethodWithOneParameter()
Workaround for RF-11469
|
String |
getChangedClass()
Space-separated list of CSS style class(es) to be applied to the list element when it is in the "changed" state.
|
String |
getClientFilterFunction()
A javascript function used to filter the list of items in the select popup
|
String |
getDefaultEventName() |
String |
getDefaultLabel()
Used to set the display text when value is undefined
|
String |
getDisabledClass()
Space-separated list of CSS style class(es) to be applied to the list element when it is disabled.
|
Collection<String> |
getEventNames() |
String |
getFamily() |
String |
getItemClass()
Space-separated list of CSS style class(es) to be applied to the list items.
|
Object |
getItemLabel()
Label to be displayed to the user for the corresponding option.
|
Object |
getItemValue()
Value to be returned to the server if the corresponding option is selected by the user.
|
String |
getListClass()
Space-separated list of CSS style class(es) to be applied to the list element.
|
String |
getListHeight()
The height of the list element (in pixels)
|
String |
getListWidth()
The width of the list element (in pixels)
|
String |
getMaxListHeight()
The maximum height of the list
|
int |
getMinChars()
Minimal number of chars in input to activate suggestion popup
|
String |
getMinListHeight()
The minimum height ot the list
|
AutocompleteMode |
getMode()
Determine how the suggestion list is requested:
|
String |
getOnblur()
Javascript code executed when this element loses focus.
|
String |
getOnchange()
Javascript code executed when the list element loses focus and its value has been modified since gaining focus.
|
String |
getOnclick()
Javascript code executed when a pointer button is clicked over this element.
|
String |
getOndblclick()
Javascript code executed when a pointer button is double clicked over this element.
|
String |
getOnfocus()
Javascript code executed when this element receives focus.
|
String |
getOnkeydown()
Javascript code executed when a key is pressed down over this element.
|
String |
getOnkeypress()
Javascript code executed when a key is pressed and released over this element.
|
String |
getOnkeyup()
Javascript code executed when a key is released over this element.
|
String |
getOnlistclick()
Javascript code executed when a pointer button is clicked over the list element.
|
String |
getOnlistdblclick()
Javascript code executed when a pointer button is double clicked over the list element.
|
String |
getOnlisthide()
Javascript code executed when the list element is hidden
|
String |
getOnlistkeydown()
Javascript code executed when a key is pressed down over the list element.
|
String |
getOnlistkeypress()
Javascript code executed when a key is pressed and released over the list element.
|
String |
getOnlistkeyup()
Javascript code executed when a key is released over the list element.
|
String |
getOnlistmousedown()
Javascript code executed when a pointer button is pressed down over the list element.
|
String |
getOnlistmousemove()
Javascript code executed when a pointer button is moved within the list element.
|
String |
getOnlistmouseout()
Javascript code executed when a pointer button is moved away from the list element.
|
String |
getOnlistmouseover()
Javascript code executed when a pointer button is moved onto the list element.
|
String |
getOnlistmouseup()
Javascript code executed when a pointer button is released over the list element.
|
String |
getOnlistshow()
Javascript code executed when the list element is shown
|
String |
getOnmousedown()
Javascript code executed when a pointer button is pressed down over this element.
|
String |
getOnmousemove()
Javascript code executed when a pointer button is moved within this element.
|
String |
getOnmouseout()
Javascript code executed when a pointer button is moved away from this element.
|
String |
getOnmouseover()
Javascript code executed when a pointer button is moved onto this element.
|
String |
getOnmouseup()
Javascript code executed when a pointer button is released over this element.
|
String |
getOnselectitem()
Javascript code executed when an item is selected
|
String |
getSelectItemClass()
Space-separated list of CSS style class(es) to be applied to the selected list item.
|
String |
getStyle()
CSS style(s) to be applied when this component is rendered.
|
String |
getStyleClass()
Space-separated list of CSS style class(es) to be applied when this element is rendered.
|
String |
getTabindex()
Position of this element in the tabbing order for the current document.
|
String |
getTitle()
Advisory title information about markup elements generated for this component.
|
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.
|
boolean |
isDisabled()
Flag indicating that this element must never receive focus or be included in a subsequent submit.
|
boolean |
isEnableManualInput()
If "true" Allows the user to type into a text field to scroll through or filter the list.
|
boolean |
isSelectFirst()
If "true" as the user types to narrow the list, automatically select the first element in the list.
|
boolean |
isShowButton()
When "true" display a button to expand the popup list
|
void |
setActiveClass(String activeClass) |
void |
setAutocompleteList(Object autocompleteList) |
void |
setAutocompleteMethod(javax.el.MethodExpression autocompleteMethod) |
void |
setAutocompleteMethodWithOneParameter(javax.el.MethodExpression autocompleteMethodWithOneParameter) |
void |
setChangedClass(String changedClass) |
void |
setClientFilterFunction(String clientFilterFunction) |
void |
setDefaultLabel(String defaultLabel) |
void |
setDisabled(boolean disabled) |
void |
setDisabledClass(String disabledClass) |
void |
setEnableManualInput(boolean enableManualInput) |
void |
setItemClass(String itemClass) |
void |
setItemLabel(Object itemLabel) |
void |
setItemValue(Object itemValue) |
void |
setListClass(String listClass) |
void |
setListHeight(String listHeight) |
void |
setListWidth(String listWidth) |
void |
setMaxListHeight(String maxListHeight) |
void |
setMinChars(int minChars) |
void |
setMinListHeight(String minListHeight) |
void |
setMode(AutocompleteMode mode) |
void |
setOnblur(String onblur) |
void |
setOnchange(String onchange) |
void |
setOnclick(String onclick) |
void |
setOndblclick(String ondblclick) |
void |
setOnfocus(String onfocus) |
void |
setOnkeydown(String onkeydown) |
void |
setOnkeypress(String onkeypress) |
void |
setOnkeyup(String onkeyup) |
void |
setOnlistclick(String onlistclick) |
void |
setOnlistdblclick(String onlistdblclick) |
void |
setOnlisthide(String onlisthide) |
void |
setOnlistkeydown(String onlistkeydown) |
void |
setOnlistkeypress(String onlistkeypress) |
void |
setOnlistkeyup(String onlistkeyup) |
void |
setOnlistmousedown(String onlistmousedown) |
void |
setOnlistmousemove(String onlistmousemove) |
void |
setOnlistmouseout(String onlistmouseout) |
void |
setOnlistmouseover(String onlistmouseover) |
void |
setOnlistmouseup(String onlistmouseup) |
void |
setOnlistshow(String onlistshow) |
void |
setOnmousedown(String onmousedown) |
void |
setOnmousemove(String onmousemove) |
void |
setOnmouseout(String onmouseout) |
void |
setOnmouseover(String onmouseover) |
void |
setOnmouseup(String onmouseup) |
void |
setOnselectitem(String onselectitem) |
void |
setSelectFirst(boolean selectFirst) |
void |
setSelectItemClass(String selectItemClass) |
void |
setShowButton(boolean showButton) |
void |
setStyle(String style) |
void |
setStyleClass(String styleClass) |
void |
setTabindex(String tabindex) |
void |
setTitle(String title) |
void |
setVar(String var) |
encodeMetaComponent, getItemValues, processEvent, resolveClientId, substituteUnresolvedClientId, validateValue, visitTreeaddValidator, 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, 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, waitaddClientBehavior, getClientBehaviorsencodeMetaComponentresolveClientId, substituteUnresolvedClientIdgetItemValuespublic static final String COMPONENT_TYPE
public static final String COMPONENT_FAMILY
public String getFamily()
getFamily in class javax.faces.component.UISelectOnepublic Collection<String> getEventNames()
getEventNames in interface javax.faces.component.behavior.ClientBehaviorHoldergetEventNames in class javax.faces.component.UIComponentBasepublic String getDefaultEventName()
getDefaultEventName in interface javax.faces.component.behavior.ClientBehaviorHoldergetDefaultEventName in class javax.faces.component.UIComponentBasepublic String getActiveClass()
SelectPropsgetActiveClass in interface SelectPropsgetActiveClass in class AbstractSelectpublic void setActiveClass(String activeClass)
public Object getAutocompleteList()
AutocompletePropsgetAutocompleteList in interface AutocompletePropspublic void setAutocompleteList(Object autocompleteList)
public javax.el.MethodExpression getAutocompleteMethod()
AutocompletePropsgetAutocompleteMethod in interface AutocompletePropspublic void setAutocompleteMethod(javax.el.MethodExpression autocompleteMethod)
setAutocompleteMethod in interface AutocompletePropspublic javax.el.MethodExpression getAutocompleteMethodWithOneParameter()
AutocompletePropsgetAutocompleteMethodWithOneParameter in interface AutocompletePropspublic void setAutocompleteMethodWithOneParameter(javax.el.MethodExpression autocompleteMethodWithOneParameter)
setAutocompleteMethodWithOneParameter in interface AutocompletePropspublic String getChangedClass()
SelectPropsgetChangedClass in interface SelectPropsgetChangedClass in class AbstractSelectpublic void setChangedClass(String changedClass)
public String getClientFilterFunction()
AbstractSelectgetClientFilterFunction in class AbstractSelectpublic void setClientFilterFunction(String clientFilterFunction)
public String getDefaultLabel()
SelectPropsgetDefaultLabel in interface SelectPropspublic void setDefaultLabel(String defaultLabel)
public boolean isDisabled()
DisabledPropsisDisabled in interface DisabledPropspublic void setDisabled(boolean disabled)
public String getDisabledClass()
SelectPropsgetDisabledClass in interface SelectPropsgetDisabledClass in class AbstractSelectpublic void setDisabledClass(String disabledClass)
public boolean isEnableManualInput()
AbstractSelectIf "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"
isEnableManualInput in class AbstractSelectpublic void setEnableManualInput(boolean enableManualInput)
public String getItemClass()
SelectPropsgetItemClass in interface SelectPropspublic void setItemClass(String itemClass)
public Object getItemLabel()
AbstractSelectgetItemLabel in interface SelectItemsPropsgetItemLabel in class AbstractSelectpublic void setItemLabel(Object itemLabel)
public Object getItemValue()
AbstractSelectgetItemValue in interface SelectItemsPropsgetItemValue in class AbstractSelectpublic void setItemValue(Object itemValue)
public String getListClass()
SelectPropsgetListClass in interface SelectPropspublic void setListClass(String listClass)
public String getListHeight()
SelectPropsgetListHeight in interface SelectPropspublic void setListHeight(String listHeight)
public String getListWidth()
SelectPropsgetListWidth in interface SelectPropspublic void setListWidth(String listWidth)
public String getMaxListHeight()
AbstractSelectgetMaxListHeight in class AbstractSelectpublic void setMaxListHeight(String maxListHeight)
public int getMinChars()
AutocompletePropsgetMinChars in interface AutocompletePropspublic void setMinChars(int minChars)
public String getMinListHeight()
AbstractSelectgetMinListHeight in class AbstractSelectpublic void setMinListHeight(String minListHeight)
public AutocompleteMode getMode()
AutocompletePropsDetermine how the suggestion list is requested:
Default: cachedAjax
getMode in interface AutocompletePropspublic void setMode(AutocompleteMode mode)
public String getOnblur()
FocusPropsgetOnblur in interface FocusPropspublic void setOnblur(String onblur)
public String getOnchange()
AbstractSelectComponentgetOnchange in class AbstractSelectComponentpublic void setOnchange(String onchange)
public String getOnclick()
EventsMousePropsgetOnclick in interface EventsMousePropspublic void setOnclick(String onclick)
public String getOndblclick()
EventsMousePropsgetOndblclick in interface EventsMousePropspublic void setOndblclick(String ondblclick)
public String getOnfocus()
FocusPropsgetOnfocus in interface FocusPropspublic void setOnfocus(String onfocus)
public String getOnkeydown()
EventsKeyPropsgetOnkeydown in interface EventsKeyPropspublic void setOnkeydown(String onkeydown)
public String getOnkeypress()
EventsKeyPropsgetOnkeypress in interface EventsKeyPropspublic void setOnkeypress(String onkeypress)
public String getOnkeyup()
EventsKeyPropsgetOnkeyup in interface EventsKeyPropspublic void setOnkeyup(String onkeyup)
public String getOnlistclick()
AbstractSelectComponentgetOnlistclick in class AbstractSelectComponentpublic void setOnlistclick(String onlistclick)
public String getOnlistdblclick()
AbstractSelectComponentgetOnlistdblclick in class AbstractSelectComponentpublic void setOnlistdblclick(String onlistdblclick)
public String getOnlisthide()
AbstractSelectComponentgetOnlisthide in class AbstractSelectComponentpublic void setOnlisthide(String onlisthide)
public String getOnlistkeydown()
AbstractSelectComponentgetOnlistkeydown in class AbstractSelectComponentpublic void setOnlistkeydown(String onlistkeydown)
public String getOnlistkeypress()
AbstractSelectComponentgetOnlistkeypress in class AbstractSelectComponentpublic void setOnlistkeypress(String onlistkeypress)
public String getOnlistkeyup()
AbstractSelectComponentgetOnlistkeyup in class AbstractSelectComponentpublic void setOnlistkeyup(String onlistkeyup)
public String getOnlistmousedown()
AbstractSelectComponentgetOnlistmousedown in class AbstractSelectComponentpublic void setOnlistmousedown(String onlistmousedown)
public String getOnlistmousemove()
AbstractSelectComponentgetOnlistmousemove in class AbstractSelectComponentpublic void setOnlistmousemove(String onlistmousemove)
public String getOnlistmouseout()
AbstractSelectComponentgetOnlistmouseout in class AbstractSelectComponentpublic void setOnlistmouseout(String onlistmouseout)
public String getOnlistmouseover()
AbstractSelectComponentgetOnlistmouseover in class AbstractSelectComponentpublic void setOnlistmouseover(String onlistmouseover)
public String getOnlistmouseup()
AbstractSelectComponentgetOnlistmouseup in class AbstractSelectComponentpublic void setOnlistmouseup(String onlistmouseup)
public String getOnlistshow()
AbstractSelectComponentgetOnlistshow in class AbstractSelectComponentpublic void setOnlistshow(String onlistshow)
public String getOnmousedown()
EventsMousePropsgetOnmousedown in interface EventsMousePropspublic void setOnmousedown(String onmousedown)
public String getOnmousemove()
EventsMousePropsgetOnmousemove in interface EventsMousePropspublic void setOnmousemove(String onmousemove)
public String getOnmouseout()
EventsMousePropsgetOnmouseout in interface EventsMousePropspublic void setOnmouseout(String onmouseout)
public String getOnmouseover()
EventsMousePropsgetOnmouseover in interface EventsMousePropspublic void setOnmouseover(String onmouseover)
public String getOnmouseup()
EventsMousePropsgetOnmouseup in interface EventsMousePropspublic void setOnmouseup(String onmouseup)
public String getOnselectitem()
AbstractSelectComponentgetOnselectitem in class AbstractSelectComponentpublic void setOnselectitem(String onselectitem)
public boolean isSelectFirst()
AbstractSelectIf "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"
isSelectFirst in class AbstractSelectpublic void setSelectFirst(boolean selectFirst)
public String getSelectItemClass()
SelectPropsgetSelectItemClass in interface SelectPropspublic void setSelectItemClass(String selectItemClass)
public boolean isShowButton()
AbstractSelectWhen "true" display a button to expand the popup list
Default is "true"
isShowButton in class AbstractSelectpublic void setShowButton(boolean showButton)
public String getStyle()
CorePropspublic void setStyle(String style)
public String getStyleClass()
CorePropsgetStyleClass in interface CorePropspublic void setStyleClass(String styleClass)
public String getTabindex()
FocusPropsgetTabindex in interface FocusPropspublic void setTabindex(String tabindex)
public String getTitle()
CorePropspublic void setTitle(String title)
public String getVar()
AbstractSelectgetVar in interface AutocompletePropsgetVar in interface SelectItemsPropsgetVar in class AbstractSelectpublic void setVar(String var)
Copyright © 2014 JBoss by Red Hat. All Rights Reserved.