com.sun.rave.web.ui.component
Class SelectorBase

java.lang.Object
  javax.faces.component.UIComponent
      javax.faces.component.UIComponentBase
          javax.faces.component.UIOutput
              javax.faces.component.UIInput
                  com.sun.rave.web.ui.component.SelectorBase

All Implemented Interfaces:

javax.faces.component.EditableValueHolder, javax.faces.component.StateHolder, javax.faces.component.ValueHolder

Direct Known Subclasses:

Selector

public abstract class SelectorBase

extends javax.faces.component.UIInput

Base component for UI components that allow the user to make a selection from a set of options.

Auto-generated component class. Do NOT modify; all changes will be lost!

Field Summary

Fields inherited from class javax.faces.component.UIInput

COMPONENT_FAMILY, COMPONENT_TYPE, CONVERSION_MESSAGE_ID, REQUIRED_MESSAGE_ID

Constructor Summary

SelectorBase()
Construct a new SelectorBase.

Method Summary

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() Sets the style level for the generated label, provided the label attribute has been set.
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.
java.lang.Object	getSelected() The object that represents the selections made from the available options.
java.lang.String	getStyle() CSS style(s) to be applied when this component is rendered.
java.lang.String	getStyleClass() CSS style class(es) to be applied when this component is rendered.
int	getTabIndex() The position of this component in the tabbing order sequence
java.lang.String	getToolTip() Display the text as a tooltip for this component
javax.faces.el.ValueBinding	getValueBinding(java.lang.String name) Return the ValueBinding 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	isReadOnly() If this attribute is set to true, the value of the component is rendered as text, preceded by the label if one was defined.
boolean	isVisible() Use the visible attribute to indicate 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	setOnBlur(java.lang.String onBlur) Scripting code executed when this element loses focus.
void	setOnChange(java.lang.String onChange) Scripting code 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 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) If this attribute is set to true, the value of the component is rendered as text, preceded by the label if one was defined.
void	setSelected(java.lang.Object selected) The object that represents the selections made from the available options.
void	setStyle(java.lang.String style) CSS style(s) to be applied when this component is rendered.
void	setStyleClass(java.lang.String styleClass) CSS style class(es) to be applied when this component is rendered.
void	setTabIndex(int tabIndex) The position of this component in the tabbing order sequence
void	setToolTip(java.lang.String toolTip) Display the text as a tooltip for this component
void	setValueBinding(java.lang.String name, javax.faces.el.ValueBinding binding) Set the ValueBinding 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.

Methods inherited from class javax.faces.component.UIInput

addValidator, addValueChangeListener, broadcast, compareValues, decode, getConvertedValue, getSubmittedValue, getValidator, getValidators, getValueChangeListener, getValueChangeListeners, isImmediate, isLocalValueSet, isRequired, isValid, processDecodes, processUpdates, processValidators, removeValidator, removeValueChangeListener, setImmediate, setLocalValueSet, setRequired, setSubmittedValue, setValid, setValidator, 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

addFacesListener, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientId, getFacesContext, getFacesListeners, getFacet, getFacets, getFacetsAndChildren, getId, getParent, getRenderer, getRendererType, getRendersChildren, isRendered, isTransient, processRestoreState, processSaveState, queueEvent, removeFacesListener, restoreAttachedState, saveAttachedState, setId, setParent, setRendered, setRendererType, setTransient

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

Constructor Detail

SelectorBase

public SelectorBase()

Construct a new SelectorBase.

Method Detail

getFamily

public java.lang.String getFamily()

Return the family for this component.

getValueBinding

public javax.faces.el.ValueBinding getValueBinding(java.lang.String name)

Return the ValueBinding stored for the specified name (if any), respecting any property aliases.

Parameters:

name - Name of value binding to retrieve

setValueBinding

public void setValueBinding(java.lang.String name,
                            javax.faces.el.ValueBinding binding)

Set the ValueBinding stored for the specified name (if any), respecting any property aliases.

Parameters:

name - Name of value binding to set

binding - ValueBinding to set, or null to remove

isDisabled

public 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.

setDisabled

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.

See Also:

isDisabled()

getItems

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 of com.sun.rave.web.ui.model.Option.

setItems

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 of com.sun.rave.web.ui.model.Option.

See Also:

getItems()

getLabel

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.

setLabel

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.

See Also:

getLabel()

getLabelLevel

public int getLabelLevel()

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.

setLabelLevel

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.

See Also:

getLabelLevel()

getOnBlur

public java.lang.String getOnBlur()

Scripting code executed when this element loses focus.

setOnBlur

public void setOnBlur(java.lang.String onBlur)

Scripting code executed when this element loses focus.

See Also:

getOnBlur()

getOnChange

public java.lang.String getOnChange()

Scripting code executed when the element value of this component is changed.

setOnChange

public void setOnChange(java.lang.String onChange)

Scripting code executed when the element value of this component is changed.

See Also:

getOnChange()

getOnClick

public java.lang.String getOnClick()

Scripting code executed when a mouse click occurs over this component.

setOnClick

public void setOnClick(java.lang.String onClick)

Scripting code executed when a mouse click occurs over this component.

See Also:

getOnClick()

getOnDblClick

public java.lang.String getOnDblClick()

Scripting code executed when a mouse double click occurs over this component.

setOnDblClick

public void setOnDblClick(java.lang.String onDblClick)

Scripting code executed when a mouse double click occurs over this component.

See Also:

getOnDblClick()

getOnFocus

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.

setOnFocus

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.

See Also:

getOnFocus()

getOnKeyDown

public java.lang.String getOnKeyDown()

Scripting code executed when the user presses down on a key while the component has focus.

setOnKeyDown

public void setOnKeyDown(java.lang.String onKeyDown)

Scripting code executed when the user presses down on a key while the component has focus.

See Also:

getOnKeyDown()

getOnKeyPress

public java.lang.String getOnKeyPress()

Scripting code executed when the user presses and releases a key while the component has focus.

setOnKeyPress

public void setOnKeyPress(java.lang.String onKeyPress)

Scripting code executed when the user presses and releases a key while the component has focus.

See Also:

getOnKeyPress()

getOnKeyUp

public java.lang.String getOnKeyUp()

Scripting code executed when the user releases a key while the component has focus.

setOnKeyUp

public void setOnKeyUp(java.lang.String onKeyUp)

Scripting code executed when the user releases a key while the component has focus.

See Also:

getOnKeyUp()

getOnMouseDown

public java.lang.String getOnMouseDown()

Scripting code executed when the user presses a mouse button while the mouse pointer is on the component.

setOnMouseDown

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.

See Also:

getOnMouseDown()

getOnMouseMove

public java.lang.String getOnMouseMove()

Scripting code executed when the user moves the mouse pointer while over the component.

setOnMouseMove

public void setOnMouseMove(java.lang.String onMouseMove)

Scripting code executed when the user moves the mouse pointer while over the component.

See Also:

getOnMouseMove()

getOnMouseOut

public java.lang.String getOnMouseOut()

Scripting code executed when a mouse out movement occurs over this component.

setOnMouseOut

public void setOnMouseOut(java.lang.String onMouseOut)

Scripting code executed when a mouse out movement occurs over this component.

See Also:

getOnMouseOut()

getOnMouseOver

public java.lang.String getOnMouseOver()

Scripting code executed when the user moves the mouse pointer into the boundary of this component.

setOnMouseOver

public void setOnMouseOver(java.lang.String onMouseOver)

Scripting code executed when the user moves the mouse pointer into the boundary of this component.

See Also:

getOnMouseOver()

getOnMouseUp

public java.lang.String getOnMouseUp()

Scripting code executed when the user releases a mouse button while the mouse pointer is on the component.

setOnMouseUp

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.

See Also:

getOnMouseUp()

getOnSelect

public java.lang.String getOnSelect()

Scripting code executed when some text in this component value is selected.

setOnSelect

public void setOnSelect(java.lang.String onSelect)

Scripting code executed when some text in this component value is selected.

See Also:

getOnSelect()

isReadOnly

public boolean isReadOnly()

If this attribute is set to true, the value of the component is rendered as text, preceded by the label if one was defined.

setReadOnly

public void setReadOnly(boolean readOnly)

If this attribute is set to true, the value of the component is rendered as text, preceded by the label if one was defined.

See Also:

isReadOnly()

getSelected

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 ArrayList, an Object array, or an array of primitives.

setSelected

public void setSelected(java.lang.Object selected)

The object that represents the selections made from the available options. If multiple selections are allowed, this must be bound to ArrayList, an Object array, or an array of primitives.

See Also:

getSelected()

getStyle

public java.lang.String getStyle()

CSS style(s) to be applied when this component is rendered.

setStyle

public void setStyle(java.lang.String style)

CSS style(s) to be applied when this component is rendered.

See Also:

getStyle()

getStyleClass

public java.lang.String getStyleClass()

CSS style class(es) to be applied when this component is rendered.

setStyleClass

public void setStyleClass(java.lang.String styleClass)

CSS style class(es) to be applied when this component is rendered.

See Also:

getStyleClass()

getTabIndex

public int getTabIndex()

The position of this component in the tabbing order sequence

setTabIndex

public void setTabIndex(int tabIndex)

The position of this component in the tabbing order sequence

See Also:

getTabIndex()

getToolTip

public java.lang.String getToolTip()

Display the text as a tooltip for this component

setToolTip

public void setToolTip(java.lang.String toolTip)

Display the text as a tooltip for this component

See Also:

getToolTip()

isVisible

public boolean isVisible()

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.

setVisible

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.

See Also:

isVisible()

restoreState

public void restoreState(javax.faces.context.FacesContext _context,
                         java.lang.Object _state)

Restore the state of this component.

saveState

public java.lang.Object saveState(javax.faces.context.FacesContext _context)

Save the state of this component.