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

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
                      com.sun.rave.web.ui.component.Selector
                          com.sun.rave.web.ui.component.ListSelectorBase

All Implemented Interfaces:

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

Direct Known Subclasses:

ListSelector

public abstract class ListSelectorBase

extends Selector

Base component for UI components that allow the user to make a selection from a list of options using an HTML select element.

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

Field Summary

Fields inherited from class com.sun.rave.web.ui.component.Selector

valueTypeEvaluator

Fields inherited from class javax.faces.component.UIInput

COMPONENT_FAMILY, COMPONENT_TYPE, CONVERSION_MESSAGE_ID, REQUIRED_MESSAGE_ID

Constructor Summary

ListSelectorBase()
Construct a new ListSelectorBase.

Method Summary

java.lang.String	getFamily() Return the family for this component.
int	getRows() The number of items to display.
boolean	isLabelOnTop() If this attribute is true, the label is rendered above the component.
boolean	isSeparators() Flag indicating that items corresponding to com.sun.rave.web.ui.model.Option that are defined inside a com.sun.rave.web.ui.model.OptionGroup should be surrounded by separators inside the list.
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	setLabelOnTop(boolean labelOnTop) If this attribute is true, the label is rendered above the component.
void	setRows(int rows) The number of items to display.
void	setSeparators(boolean separators) Flag indicating that items corresponding to com.sun.rave.web.ui.model.Option that are defined inside a com.sun.rave.web.ui.model.OptionGroup should be surrounded by separators inside the list.
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 com.sun.rave.web.ui.component.Selector

compareValues, getConvertedValue, getLabelLevel, getRendersChildren, getValueAsReadOnly, isMultiple, setMultiple, setSelected, toString

Methods inherited from class com.sun.rave.web.ui.component.SelectorBase

getItems, getLabel, getOnBlur, getOnChange, getOnClick, getOnDblClick, getOnFocus, getOnKeyDown, getOnKeyPress, getOnKeyUp, getOnMouseDown, getOnMouseMove, getOnMouseOut, getOnMouseOver, getOnMouseUp, getOnSelect, getSelected, getStyle, getStyleClass, getTabIndex, getToolTip, getValueBinding, isDisabled, isReadOnly, setDisabled, setItems, setLabel, setLabelLevel, setOnBlur, setOnChange, setOnClick, setOnDblClick, setOnFocus, setOnKeyDown, setOnKeyPress, setOnKeyUp, setOnMouseDown, setOnMouseMove, setOnMouseOut, setOnMouseOver, setOnMouseUp, setOnSelect, setReadOnly, setStyle, setStyleClass, setTabIndex, setToolTip, setValueBinding

Methods inherited from class javax.faces.component.UIInput

addValidator, addValueChangeListener, broadcast, decode, 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, 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, wait, wait, wait

Methods inherited from interface com.sun.rave.web.ui.component.SelectorManager

getClientId, getOnChange, getStyle, getStyleClass, getTabIndex, isDisabled, isReadOnly

Methods inherited from interface javax.faces.component.ValueHolder

getConverter, getLocalValue, getValue, setConverter

Constructor Detail

ListSelectorBase

public ListSelectorBase()

Construct a new ListSelectorBase.

Method Detail

getFamily

public java.lang.String getFamily()

Return the family for this component.

Overrides:

getFamily in class SelectorBase

isLabelOnTop

public boolean isLabelOnTop()

If this attribute is true, the label is rendered above the component. If it is false, the label is rendered next to the component. The default is false.

setLabelOnTop

public void setLabelOnTop(boolean labelOnTop)

If this attribute is true, the label is rendered above the component. If it is false, the label is rendered next to the component. The default is false.

See Also:

isLabelOnTop()

getRows

public int getRows()

The number of items to display. The default value is 12.

setRows

public void setRows(int rows)

The number of items to display. The default value is 12.

See Also:

getRows()

isSeparators

public boolean isSeparators()

Flag indicating that items corresponding to com.sun.rave.web.ui.model.Option that are defined inside a com.sun.rave.web.ui.model.OptionGroup should be surrounded by separators inside the list. The default value is true. If false, no separators are shown. To manually specify the location of separators, set this flag to false and place instances of com.sun.rave.web.ui.model.Separator between the relevant com.sun.rave.web.ui.model.Option instances when specifying the items attribute.

setSeparators

public void setSeparators(boolean separators)

Flag indicating that items corresponding to com.sun.rave.web.ui.model.Option that are defined inside a com.sun.rave.web.ui.model.OptionGroup should be surrounded by separators inside the list. The default value is true. If false, no separators are shown. To manually specify the location of separators, set this flag to false and place instances of com.sun.rave.web.ui.model.Separator between the relevant com.sun.rave.web.ui.model.Option instances when specifying the items attribute.

See Also:

isSeparators()

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.

Overrides:

isVisible in class SelectorBase

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.

Overrides:

setVisible in class SelectorBase

See Also:

isVisible()

restoreState

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

Restore the state of this component.

Specified by:

restoreState in interface javax.faces.component.StateHolder

Overrides:

restoreState in class SelectorBase

saveState

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

Save the state of this component.

Specified by:

saveState in interface javax.faces.component.StateHolder

Overrides:

saveState in class SelectorBase