Class HtmlSelectOneListbox
- All Implemented Interfaces:
EventListener,ClientBehaviorHolder,EditableValueHolder,PartialStateHolder,StateHolder,TransientStateHolder,ValueHolder,ComponentSystemEventListener,FacesListener,SystemEventListenerHolder
Represents a single-selection component that is rendered
as an HTML select element, showing either all
available options or the specified number of options.
By default, the rendererType property must be set to "javax.faces.Listbox".
This value can be changed by calling the setRendererType() method.
-
Nested Class Summary
Nested Classes -
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final StringThe standard component type for this component.Fields inherited from class javax.faces.component.UISelectOne
COMPONENT_FAMILY, INVALID_MESSAGE_IDFields inherited from class javax.faces.component.UIInput
CONVERSION_MESSAGE_ID, REQUIRED_MESSAGE_ID, UPDATE_MESSAGE_ID, VALIDATE_EMPTY_FIELDS_PARAM_NAMEFields 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 -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionReturn the value of theaccesskeyproperty.This is a default implementation ofClientBehaviorHolder.getDefaultEventName().getDir()Return the value of thedirproperty.Return the value of thedisabledClassproperty.Return the value of theenabledClassproperty.This is a default implementation ofClientBehaviorHolder.getEventNames().getLabel()Return the value of thelabelproperty.getLang()Return the value of thelangproperty.Return the value of theonblurproperty.Return the value of theonchangeproperty.Return the value of theonclickproperty.Return the value of theondblclickproperty.Return the value of theonfocusproperty.Return the value of theonkeydownproperty.Return the value of theonkeypressproperty.Return the value of theonkeyupproperty.Return the value of theonmousedownproperty.Return the value of theonmousemoveproperty.Return the value of theonmouseoutproperty.Return the value of theonmouseoverproperty.Return the value of theonmouseupproperty.Return the value of theonselectproperty.getRole()Return the value of theroleproperty.intgetSize()Return the value of thesizeproperty.getStyle()Return the value of thestyleproperty.Return the value of thestyleClassproperty.Return the value of thetabindexproperty.getTitle()Return the value of thetitleproperty.booleanReturn the value of thedisabledproperty.booleanReturn the value of thereadonlyproperty.voidsetAccesskey(String accesskey) Set the value of theaccesskeyproperty.voidSet the value of thedirproperty.voidsetDisabled(boolean disabled) Set the value of thedisabledproperty.voidsetDisabledClass(String disabledClass) Set the value of thedisabledClassproperty.voidsetEnabledClass(String enabledClass) Set the value of theenabledClassproperty.voidSet the value of thelabelproperty.voidSet the value of thelangproperty.voidSet the value of theonblurproperty.voidsetOnchange(String onchange) Set the value of theonchangeproperty.voidsetOnclick(String onclick) Set the value of theonclickproperty.voidsetOndblclick(String ondblclick) Set the value of theondblclickproperty.voidsetOnfocus(String onfocus) Set the value of theonfocusproperty.voidsetOnkeydown(String onkeydown) Set the value of theonkeydownproperty.voidsetOnkeypress(String onkeypress) Set the value of theonkeypressproperty.voidsetOnkeyup(String onkeyup) Set the value of theonkeyupproperty.voidsetOnmousedown(String onmousedown) Set the value of theonmousedownproperty.voidsetOnmousemove(String onmousemove) Set the value of theonmousemoveproperty.voidsetOnmouseout(String onmouseout) Set the value of theonmouseoutproperty.voidsetOnmouseover(String onmouseover) Set the value of theonmouseoverproperty.voidsetOnmouseup(String onmouseup) Set the value of theonmouseupproperty.voidsetOnselect(String onselect) Set the value of theonselectproperty.voidsetReadonly(boolean readonly) Set the value of thereadonlyproperty.voidSet the value of theroleproperty.voidsetSize(int size) Set the value of thesizeproperty.voidSet the value of thestyleproperty.voidsetStyleClass(String styleClass) Set the value of thestyleClassproperty.voidsetTabindex(String tabindex) Set the value of thetabindexproperty.voidSet the value of thetitleproperty.Methods inherited from class javax.faces.component.UISelectOne
getFamily, validateValueMethods inherited from class javax.faces.component.UIInput
addValidator, 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, validateMethods inherited from class javax.faces.component.UIOutput
getConverter, getLocalValue, setConverterMethods inherited from class javax.faces.component.UIComponentBase
addClientBehavior, 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, unsubscribeFromEventMethods inherited from class javax.faces.component.UIComponent
encodeAll, getClientId, getCompositeComponentParent, getContainerClientId, getCurrentComponent, getCurrentCompositeComponent, getNamingContainer, getPassThroughAttributes, getResourceBundleMap, getStateHelper, getStateHelper, getTransientStateHelper, getTransientStateHelper, getValueExpression, initialStateMarked, isCompositeComponent, isInView, isVisitable, popComponentFromEL, processEvent, pushComponentToEL, restoreTransientState, saveTransientState, setInView, setValueExpression, visitTreeMethods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface javax.faces.component.behavior.ClientBehaviorHolder
addClientBehavior, getClientBehaviorsMethods inherited from interface javax.faces.component.ValueHolder
getConverter, getLocalValue, setConverter
-
Field Details
-
COMPONENT_TYPE
The standard component type for this component.
- See Also:
-
-
Constructor Details
-
HtmlSelectOneListbox
public HtmlSelectOneListbox()
-
-
Method Details
-
getAccesskey
Return the value of the
accesskeyproperty.Contents: Access key that, when pressed, transfers focus to this element.
-
setAccesskey
Set the value of the
accesskeyproperty. -
getDir
Return the value of the
dirproperty.Contents: Direction indication for text that does not inherit directionality. Valid values are "LTR" (left-to-right) and "RTL" (right-to-left). These attributes are case sensitive when rendering to XHTML, so care must be taken to have the correct case.
-
setDir
Set the value of the
dirproperty. -
isDisabled
public boolean isDisabled()Return the value of the
disabledproperty.Contents: Flag indicating that this element must never receive focus or be included in a subsequent submit. A value of false causes no attribute to be rendered, while a value of true causes the attribute to be rendered as disabled="disabled".
-
setDisabled
public void setDisabled(boolean disabled) Set the value of the
disabledproperty. -
getDisabledClass
Return the value of the
disabledClassproperty.Contents: CSS style class to apply to the rendered label on disabled options.
-
setDisabledClass
Set the value of the
disabledClassproperty. -
getEnabledClass
Return the value of the
enabledClassproperty.Contents: CSS style class to apply to the rendered label on enabled options.
-
setEnabledClass
Set the value of the
enabledClassproperty. -
getLabel
Return the value of the
labelproperty.Contents: A localized user presentable name for this component.
-
setLabel
Set the value of the
labelproperty. -
getLang
Return the value of the
langproperty.Contents: Code describing the language used in the generated markup for this component.
-
setLang
Set the value of the
langproperty. -
getOnblur
Return the value of the
onblurproperty.Contents: Javascript code executed when this element loses focus.
-
setOnblur
Set the value of the
onblurproperty. -
getOnchange
Return the value of the
onchangeproperty.Contents: Javascript code executed when this element loses focus and its value has been modified since gaining focus.
-
setOnchange
Set the value of the
onchangeproperty. -
getOnclick
Return the value of the
onclickproperty.Contents: Javascript code executed when a pointer button is clicked over this element.
-
setOnclick
Set the value of the
onclickproperty. -
getOndblclick
Return the value of the
ondblclickproperty.Contents: Javascript code executed when a pointer button is double clicked over this element.
-
setOndblclick
Set the value of the
ondblclickproperty. -
getOnfocus
Return the value of the
onfocusproperty.Contents: Javascript code executed when this element receives focus.
-
setOnfocus
Set the value of the
onfocusproperty. -
getOnkeydown
Return the value of the
onkeydownproperty.Contents: Javascript code executed when a key is pressed down over this element.
-
setOnkeydown
Set the value of the
onkeydownproperty. -
getOnkeypress
Return the value of the
onkeypressproperty.Contents: Javascript code executed when a key is pressed and released over this element.
-
setOnkeypress
Set the value of the
onkeypressproperty. -
getOnkeyup
Return the value of the
onkeyupproperty.Contents: Javascript code executed when a key is released over this element.
-
setOnkeyup
Set the value of the
onkeyupproperty. -
getOnmousedown
Return the value of the
onmousedownproperty.Contents: Javascript code executed when a pointer button is pressed down over this element.
-
setOnmousedown
Set the value of the
onmousedownproperty. -
getOnmousemove
Return the value of the
onmousemoveproperty.Contents: Javascript code executed when a pointer button is moved within this element.
-
setOnmousemove
Set the value of the
onmousemoveproperty. -
getOnmouseout
Return the value of the
onmouseoutproperty.Contents: Javascript code executed when a pointer button is moved away from this element.
-
setOnmouseout
Set the value of the
onmouseoutproperty. -
getOnmouseover
Return the value of the
onmouseoverproperty.Contents: Javascript code executed when a pointer button is moved onto this element.
-
setOnmouseover
Set the value of the
onmouseoverproperty. -
getOnmouseup
Return the value of the
onmouseupproperty.Contents: Javascript code executed when a pointer button is released over this element.
-
setOnmouseup
Set the value of the
onmouseupproperty. -
getOnselect
Return the value of the
onselectproperty.Contents: Javascript code executed when text within this element is selected by the user.
-
setOnselect
Set the value of the
onselectproperty. -
isReadonly
public boolean isReadonly()Return the value of the
readonlyproperty.Contents: Flag indicating that this component will prohibit changes by the user. The element may receive focus unless it has also been disabled. A value of false causes no attribute to be rendered, while a value of true causes the attribute to be rendered as readonly="readonly".
-
setReadonly
public void setReadonly(boolean readonly) Set the value of the
readonlyproperty. -
getRole
Return the value of the
roleproperty.Contents:
Per the WAI-ARIA spec and its relationship to HTML5 (Section title ARIA Role Attriubute), every HTML element may have a "role" attribute whose value must be passed through unmodified on the element on which it is declared in the final rendered markup. The attribute, if specified, must have a value that is a string literal that is, or an EL Expression that evaluates to, a set of space-separated tokens representing the various WAI-ARIA roles that the element belongs to.
It is the page author's responsibility to ensure that the user agent is capable of correctly interpreting the value of this attribute.
-
setRole
Set the value of the
roleproperty. -
getSize
public int getSize()Return the value of the
sizeproperty.Contents: Number of available options to be shown at all times. If not specified, all available options are shown.
-
setSize
public void setSize(int size) Set the value of the
sizeproperty. -
getStyle
Return the value of the
styleproperty.Contents: CSS style(s) to be applied when this component is rendered.
-
setStyle
Set the value of the
styleproperty. -
getStyleClass
Return the value of the
styleClassproperty.Contents: Space-separated list of CSS style class(es) to be applied when this element is rendered. This value must be passed through as the "class" attribute on generated markup.
-
setStyleClass
Set the value of the
styleClassproperty. -
getTabindex
Return the value of the
tabindexproperty.Contents: Position of this element in the tabbing order for the current document. This value must be an integer between 0 and 32767.
-
setTabindex
Set the value of the
tabindexproperty. -
getTitle
Return the value of the
titleproperty.Contents: Advisory title information about markup elements generated for this component.
-
setTitle
Set the value of the
titleproperty. -
getEventNames
Description copied from class:UIComponentBaseThis is a default implementation of
ClientBehaviorHolder.getEventNames().UIComponentdoes not implement theClientBehaviorHolderinterface, but provides default implementations for the methods defined byClientBehaviorHolderto simplify subclass implementations. Subclasses that wish to support theClientBehaviorHoldercontract must declare that the subclass implementsClientBehaviorHolder, and must override this method to return a non-EmptyCollectionof the client event names that the component supports.- Specified by:
getEventNamesin interfaceClientBehaviorHolder- Overrides:
getEventNamesin classUIComponentBase
-
getDefaultEventName
Description copied from class:UIComponentBaseThis is a default implementation of
ClientBehaviorHolder.getDefaultEventName().UIComponentdoes not implement theClientBehaviorHolderinterface, but provides default implementations for the methods defined byClientBehaviorHolderto simplify subclass implementations. Subclasses that wish to support theClientBehaviorHoldercontract must declare that the subclass implementsClientBehaviorHolder, and must provide an implementation ofClientBehaviorHolder.getEventNames().- Specified by:
getDefaultEventNamein interfaceClientBehaviorHolder- Overrides:
getDefaultEventNamein classUIComponentBase
-