|
||||||||||
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
com.sun.webui.jsf.component.WebuiInput
com.sun.webui.jsf.component.Selector
public class Selector
Base component for UI components that allow the user to make a selection from a set of options.
Field Summary |
---|
Fields inherited from class javax.faces.component.UIInput |
---|
COMPONENT_FAMILY, COMPONENT_TYPE, CONVERSION_MESSAGE_ID, REQUIRED_MESSAGE_ID, UPDATE_MESSAGE_ID |
Constructor Summary | |
---|---|
Selector()
|
Method Summary | |
---|---|
java.lang.Object |
getConvertedValue(javax.faces.context.FacesContext context,
java.lang.Object submittedValue)
Retrieve the value of this component (the "selected" property) as an object. |
java.lang.String |
getFamily()
Return the family for this component. |
java.lang.Object |
getItems()
Specifies the options that the web application user can choose from. |
java.lang.String |
getLabel()
If set, a label is rendered adjacent to the component with the value of this attribute as the label text. |
int |
getLabelLevel()
|
java.lang.String |
getOnBlur()
Scripting code executed when this element loses focus. |
java.lang.String |
getOnChange()
Scripting code executed when the element value of this component is changed. |
java.lang.String |
getOnClick()
Scripting code executed when a mouse click occurs over this component. |
java.lang.String |
getOnDblClick()
Scripting code executed when a mouse double click occurs over this component. |
java.lang.String |
getOnFocus()
Scripting code executed when this component receives focus. |
java.lang.String |
getOnKeyDown()
Scripting code executed when the user presses down on a key while the component has focus. |
java.lang.String |
getOnKeyPress()
Scripting code executed when the user presses and releases a key while the component has focus. |
java.lang.String |
getOnKeyUp()
Scripting code executed when the user releases a key while the component has focus. |
java.lang.String |
getOnMouseDown()
Scripting code executed when the user presses a mouse button while the mouse pointer is on the component. |
java.lang.String |
getOnMouseMove()
Scripting code executed when the user moves the mouse pointer while over the component. |
java.lang.String |
getOnMouseOut()
Scripting code executed when a mouse out movement occurs over this component. |
java.lang.String |
getOnMouseOver()
Scripting code executed when the user moves the mouse pointer into the boundary of this component. |
java.lang.String |
getOnMouseUp()
Scripting code executed when the user releases a mouse button while the mouse pointer is on the component. |
java.lang.String |
getOnSelect()
Scripting code executed when some text in this component value is selected. |
boolean |
getRendersChildren()
Return a flag indicating whether this component is responsible for rendering its child components. |
java.lang.Object |
getSelected()
The object that represents the selections made from the available options. |
java.lang.String |
getStyle()
CSS style or styles to be applied to the outermost HTML element when this component is rendered. |
java.lang.String |
getStyleClass()
CSS style class or classes to be applied to the outermost HTML element when this component is rendered. |
int |
getTabIndex()
Position of this element in the tabbing order of the current document. |
java.lang.String |
getToolTip()
Sets the value of the title attribute for the HTML element. |
javax.el.ValueExpression |
getValueExpression(java.lang.String name)
Return the ValueExpression stored for the
specified name (if any), respecting any property aliases. |
boolean |
isDisabled()
Flag indicating that the user is not permitted to activate this component, and that the component's value will not be submitted with the form. |
boolean |
isMultiple()
Getter for property multiple. |
boolean |
isReadOnly()
Deprecated. The attribute is deprected starting from version 4.1 |
boolean |
isVisible()
Indicates whether the component should be viewable by the user in the rendered HTML page. |
void |
restoreState(javax.faces.context.FacesContext _context,
java.lang.Object _state)
Restore the state of this component. |
java.lang.Object |
saveState(javax.faces.context.FacesContext _context)
Save the state of this component. |
void |
setDisabled(boolean disabled)
Flag indicating that the user is not permitted to activate this component, and that the component's value will not be submitted with the form. |
void |
setItems(java.lang.Object items)
Specifies the options that the web application user can choose from. |
void |
setLabel(java.lang.String label)
If set, a label is rendered adjacent to the component with the value of this attribute as the label text. |
void |
setLabelLevel(int labelLevel)
Sets the style level for the generated label, provided the label attribute has been set. |
void |
setMultiple(boolean multiple)
Setter for property multiple. |
void |
setOnBlur(java.lang.String onBlur)
Scripting code executed when this element loses focus. |
void |
setOnChange(java.lang.String onChange)
Scripting code that is executed when the element value of this component is changed. |
void |
setOnClick(java.lang.String onClick)
Scripting code executed when a mouse click occurs over this component. |
void |
setOnDblClick(java.lang.String onDblClick)
Scripting code executed when a mouse double click occurs over this component. |
void |
setOnFocus(java.lang.String onFocus)
Scripting code executed when this component receives focus. |
void |
setOnKeyDown(java.lang.String onKeyDown)
Scripting code executed when the user presses down on a key while the component has focus. |
void |
setOnKeyPress(java.lang.String onKeyPress)
Scripting code executed when the user presses and releases a key while the component has focus. |
void |
setOnKeyUp(java.lang.String onKeyUp)
Scripting code executed when the user releases a key while the component has focus. |
void |
setOnMouseDown(java.lang.String onMouseDown)
Scripting code executed when the user presses a mouse button while the mouse pointer is on the component. |
void |
setOnMouseMove(java.lang.String onMouseMove)
Scripting code that is executed when the user moves the mouse pointer while over the component. |
void |
setOnMouseOut(java.lang.String onMouseOut)
Scripting code executed when a mouse out movement occurs over this component. |
void |
setOnMouseOver(java.lang.String onMouseOver)
Scripting code executed when the user moves the mouse pointer into the boundary of this component. |
void |
setOnMouseUp(java.lang.String onMouseUp)
Scripting code executed when the user releases a mouse button while the mouse pointer is on the component. |
void |
setOnSelect(java.lang.String onSelect)
Scripting code executed when some text in this component value is selected. |
void |
setReadOnly(boolean readOnly)
Deprecated. The attribute is deprected starting from version 4.1 |
void |
setSelected(java.lang.Object selected)
|
void |
setStyle(java.lang.String style)
CSS style or styles that are applied to the outermost HTML element when this component is rendered. |
void |
setStyleClass(java.lang.String styleClass)
CSS style class or classes to be applied to the outermost HTML element when this component is rendered. |
void |
setTabIndex(int tabIndex)
Position of this element in the tabbing order of the current document. |
void |
setToolTip(java.lang.String toolTip)
Sets the value of the title attribute for the HTML element. |
void |
setValueExpression(java.lang.String name,
javax.el.ValueExpression binding)
Set the ValueExpression stored for the
specified name (if any), respecting any property
aliases. |
void |
setVisible(boolean visible)
Use the visible attribute to indicate whether the component should be viewable by the user in the rendered HTML page. |
java.lang.String |
toString()
Public method toString() |
Methods inherited from class com.sun.webui.jsf.component.WebuiInput |
---|
broadcast, getValidator, getValidatorExpression, getValueChangeListener, getValueChangeListenerExpression, processDecodes, processUpdates, processValidators, setConverter, setId, setImmediate, setRendered, setRequired, setValidatorExpression, setValueChangeListenerExpression |
Methods inherited from class javax.faces.component.UIInput |
---|
addValidator, addValueChangeListener, decode, getConverterMessage, getRequiredMessage, getSubmittedValue, getValidatorMessage, getValidators, getValueChangeListeners, isImmediate, isLocalValueSet, isRequired, isValid, removeValidator, removeValueChangeListener, resetValue, setConverterMessage, setLocalValueSet, setRequiredMessage, setSubmittedValue, setValid, setValidator, setValidatorMessage, setValue, setValueChangeListener, updateModel, validate |
Methods inherited from class javax.faces.component.UIOutput |
---|
getConverter, getLocalValue, getValue |
Methods inherited from class javax.faces.component.UIComponentBase |
---|
encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientId, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getParent, getRendererType, getValueBinding, invokeOnComponent, isRendered, isTransient, processRestoreState, processSaveState, queueEvent, restoreAttachedState, saveAttachedState, setParent, setRendererType, setTransient, setValueBinding |
Methods inherited from class javax.faces.component.UIComponent |
---|
encodeAll, getContainerClientId |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Methods inherited from interface com.sun.webui.jsf.component.SelectorManager |
---|
getClientId |
Methods inherited from interface javax.faces.component.ValueHolder |
---|
getConverter, getLocalValue, getValue |
Constructor Detail |
---|
public Selector()
Method Detail |
---|
public java.lang.String getFamily()
Return the family for this component.
getFamily
in class javax.faces.component.UIInput
public boolean getRendersChildren()
Return a flag indicating whether this component is responsible
for rendering its child components. The default implementation
in UIComponentBase.getRendersChildren()
tries to find the
renderer for this component. If it does, it calls Renderer.getRendersChildren()
and returns the result. If it
doesn't, it returns false. As of version 1.2 of the JavaServer
Faces Specification, component authors are encouraged to return
true
from this method and rely on UIComponentBase.encodeChildren(javax.faces.context.FacesContext)
.
getRendersChildren
in class javax.faces.component.UIComponentBase
public java.lang.Object getConvertedValue(javax.faces.context.FacesContext context, java.lang.Object submittedValue) throws javax.faces.convert.ConverterException
getConvertedValue
in class javax.faces.component.UIInput
context
- The FacesContext of the requestsubmittedValue
- The submitted value of the component
javax.faces.convert.ConverterException
public int getLabelLevel()
public boolean isMultiple()
isMultiple
in interface com.sun.webui.jsf.component.SelectorManager
public void setMultiple(boolean multiple)
multiple
- New value of property multiple.public java.lang.String toString()
toString
in class java.lang.Object
public void setSelected(java.lang.Object selected)
public javax.el.ValueExpression getValueExpression(java.lang.String name)
Return the ValueExpression
stored for the
specified name (if any), respecting any property aliases.
getValueExpression
in class javax.faces.component.UIComponentBase
name
- Name of value binding expression to retrievepublic void setValueExpression(java.lang.String name, javax.el.ValueExpression binding)
Set the ValueExpression
stored for the
specified name (if any), respecting any property
aliases.
setValueExpression
in class javax.faces.component.UIComponentBase
name
- Name of value binding to setbinding
- ValueExpression to set, or null to removepublic boolean isDisabled()
Flag indicating that the user is not permitted to activate this component, and that the component's value will not be submitted with the form.
isDisabled
in interface com.sun.webui.jsf.component.SelectorManager
public void setDisabled(boolean disabled)
Flag indicating that the user is not permitted to activate this component, and that the component's value will not be submitted with the form.
isDisabled()
public java.lang.Object getItems()
Specifies the options that the web application user can choose
from. The value must be one of an array, Map or Collection
whose members are all subclasses ofcom.sun.webui.jsf.model.Option
.
public void setItems(java.lang.Object items)
Specifies the options that the web application user can choose
from. The value must be one of an array, Map or Collection
whose members are all subclasses ofcom.sun.webui.jsf.model.Option
.
getItems()
public java.lang.String getLabel()
If set, a label is rendered adjacent to the component with the value of this attribute as the label text.
public void setLabel(java.lang.String label)
If set, a label is rendered adjacent to the component with the value of this attribute as the label text.
getLabel()
public void setLabelLevel(int labelLevel)
Sets the style level for the generated label, provided the label attribute has been set. Valid values are 1 (largest), 2 and 3 (smallest). The default value is 2.
getLabelLevel()
public java.lang.String getOnBlur()
Scripting code executed when this element loses focus.
public void setOnBlur(java.lang.String onBlur)
Scripting code executed when this element loses focus.
getOnBlur()
public java.lang.String getOnChange()
Scripting code executed when the element value of this component is changed.
getOnChange
in interface com.sun.webui.jsf.component.SelectorManager
public void setOnChange(java.lang.String onChange)
Scripting code that is executed when the element value of this component is changed.
getOnChange()
public java.lang.String getOnClick()
Scripting code executed when a mouse click occurs over this component.
public void setOnClick(java.lang.String onClick)
Scripting code executed when a mouse click occurs over this component.
getOnClick()
public java.lang.String getOnDblClick()
Scripting code executed when a mouse double click occurs over this component.
public void setOnDblClick(java.lang.String onDblClick)
Scripting code executed when a mouse double click occurs over this component.
getOnDblClick()
public java.lang.String getOnFocus()
Scripting code executed when this component receives focus. An element receives focus when the user selects the element by pressing the tab key or clicking the mouse.
public void setOnFocus(java.lang.String onFocus)
Scripting code executed when this component receives focus. An element receives focus when the user selects the element by pressing the tab key or clicking the mouse.
getOnFocus()
public java.lang.String getOnKeyDown()
Scripting code executed when the user presses down on a key while the component has focus.
public void setOnKeyDown(java.lang.String onKeyDown)
Scripting code executed when the user presses down on a key while the component has focus.
getOnKeyDown()
public java.lang.String getOnKeyPress()
Scripting code executed when the user presses and releases a key while the component has focus.
public void setOnKeyPress(java.lang.String onKeyPress)
Scripting code executed when the user presses and releases a key while the component has focus.
getOnKeyPress()
public java.lang.String getOnKeyUp()
Scripting code executed when the user releases a key while the component has focus.
public void setOnKeyUp(java.lang.String onKeyUp)
Scripting code executed when the user releases a key while the component has focus.
getOnKeyUp()
public java.lang.String getOnMouseDown()
Scripting code executed when the user presses a mouse button while the mouse pointer is on the component.
public void setOnMouseDown(java.lang.String onMouseDown)
Scripting code executed when the user presses a mouse button while the mouse pointer is on the component.
getOnMouseDown()
public java.lang.String getOnMouseMove()
Scripting code executed when the user moves the mouse pointer while over the component.
public void setOnMouseMove(java.lang.String onMouseMove)
Scripting code that is executed when the user moves the mouse pointer while over the component.
getOnMouseMove()
public java.lang.String getOnMouseOut()
Scripting code executed when a mouse out movement occurs over this component.
public void setOnMouseOut(java.lang.String onMouseOut)
Scripting code executed when a mouse out movement occurs over this component.
getOnMouseOut()
public java.lang.String getOnMouseOver()
Scripting code executed when the user moves the mouse pointer into the boundary of this component.
public void setOnMouseOver(java.lang.String onMouseOver)
Scripting code executed when the user moves the mouse pointer into the boundary of this component.
getOnMouseOver()
public java.lang.String getOnMouseUp()
Scripting code executed when the user releases a mouse button while the mouse pointer is on the component.
public void setOnMouseUp(java.lang.String onMouseUp)
Scripting code executed when the user releases a mouse button while the mouse pointer is on the component.
getOnMouseUp()
public java.lang.String getOnSelect()
Scripting code executed when some text in this component value is selected.
public void setOnSelect(java.lang.String onSelect)
Scripting code executed when some text in this component value is selected.
getOnSelect()
public boolean isReadOnly()
If true, the value of the component is rendered as text, preceded by the label if one was defined.
isReadOnly
in interface com.sun.webui.jsf.component.SelectorManager
public void setReadOnly(boolean readOnly)
If true, the value of the component is rendered as text, preceded by the label if one was defined.
isReadOnly()
public java.lang.Object getSelected()
The object that represents the selections made from the available options. If multiple selections are allowed, this must be bound to an Object array, or an array of primitives.
public java.lang.String getStyle()
CSS style or styles to be applied to the outermost HTML element when this component is rendered.
getStyle
in interface com.sun.webui.jsf.component.SelectorManager
public void setStyle(java.lang.String style)
CSS style or styles that are applied to the outermost HTML element when this component is rendered.
getStyle()
public java.lang.String getStyleClass()
CSS style class or classes to be applied to the outermost HTML element when this component is rendered.
getStyleClass
in interface com.sun.webui.jsf.component.SelectorManager
public void setStyleClass(java.lang.String styleClass)
CSS style class or classes to be applied to the outermost HTML element when this component is rendered.
getStyleClass()
public int getTabIndex()
Position of this element in the tabbing order of the current document. Tabbing order determines the sequence in which elements receive focus when the tab key is pressed. The value must be an integer between 0 and 32767.
getTabIndex
in interface com.sun.webui.jsf.component.SelectorManager
public void setTabIndex(int tabIndex)
Position of this element in the tabbing order of the current document. Tabbing order determines the sequence in which elements receive focus when the tab key is pressed. The value must be an integer between 0 and 32767.
getTabIndex()
public java.lang.String getToolTip()
Sets the value of the title attribute for the HTML element. The specified text will display as a tooltip if the mouse cursor hovers over the HTML element.
public void setToolTip(java.lang.String toolTip)
Sets the value of the title attribute for the HTML element. The specified text will display as a tooltip if the mouse cursor hovers over the HTML element.
getToolTip()
public boolean isVisible()
Indicates whether the component should be viewable by the user in the rendered HTML page. If false, the HTML code for the component is present in the page, but the component is hidden with style attributes. By default, visible is true, so HTML for the component HTML is included and visible to the user. If the component is not visible, it can still be processed on subsequent form submissions because the HTML is present.
public void setVisible(boolean visible)
Use the visible attribute to indicate whether the component should be viewable by the user in the rendered HTML page. If set to false, the HTML code for the component is present in the page, but the component is hidden with style attributes. By default, visible is set to true, so HTML for the component HTML is included and visible to the user. If the component is not visible, it can still be processed on subsequent form submissions because the HTML is present.
isVisible()
public void restoreState(javax.faces.context.FacesContext _context, java.lang.Object _state)
Restore the state of this component.
restoreState
in interface javax.faces.component.StateHolder
restoreState
in class WebuiInput
public java.lang.Object saveState(javax.faces.context.FacesContext _context)
Save the state of this component.
saveState
in interface javax.faces.component.StateHolder
saveState
in class WebuiInput
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |