com.sun.webui.jsf.component
Class OrderableList

java.lang.Object
  extended by javax.faces.component.UIComponent
      extended by javax.faces.component.UIComponentBase
          extended by javax.faces.component.UIOutput
              extended by javax.faces.component.UIInput
                  extended by com.sun.webui.jsf.component.WebuiInput
                      extended by com.sun.webui.jsf.component.OrderableList
All Implemented Interfaces:
com.sun.webui.jsf.component.ComplexComponent, com.sun.webui.jsf.component.ListManager, com.sun.webui.jsf.component.SelectorManager, javax.faces.component.EditableValueHolder, javax.faces.component.NamingContainer, javax.faces.component.StateHolder, javax.faces.component.ValueHolder

public class OrderableList
extends WebuiInput
implements com.sun.webui.jsf.component.ListManager, javax.faces.component.NamingContainer

The OrderableList component creates a list with buttons allowing the user to change the order of the list items.

This tag renders an OrderableList component. Use this component when web application users need to create and modify a list of strings. The application user can add new strings by typing them into the textfield and clicking the "moveUp" button, and remove them by selecting one or more items from the list and clicking the "Remove" button.

Configuring the listbox tag

Use the list attribute to bind the component to a model. The value must be an EL expression that corresponds to a managed bean or a property of a managed bean, and it must evaluate to an array of java.lang.String.

To set the label of the textfield, use the fieldLabel attribute. To set the label of the textfield, use the listLabel attribute. To validate new items, use the fieldValidator attribute; to validate the contents of the list once the user has finished adding and removing items, specify a labelValidator.

Facets

Client-side JavaScript functions


Field Summary
static java.lang.String FOOTER_FACET
          The name for the footer facet.
static java.lang.String LABEL_FACET
          The facet name for the label.
static java.lang.String LABEL_ID
          The component ID for the label.
static java.lang.String LABEL_TEXT_KEY
          The default label text message key.
static java.lang.String MOVEBOTTOM_BUTTON_FACET
          The facet name for the moveBottom button.
static java.lang.String MOVEBOTTOM_BUTTON_ID
          The component id for the moveBottom button.
static java.lang.String MOVEBOTTOM_FUNCTION
          Name of the JavaScript function which moves elements to the bottom.
static java.lang.String MOVEBOTTOM_TEXT_KEY
          The move bottom button text key.
static java.lang.String MOVEDOWN_BUTTON_FACET
          The facet name for the moveDown button.
static java.lang.String MOVEDOWN_BUTTON_ID
          The component id for the moveDown button.
static java.lang.String MOVEDOWN_FUNCTION
          Name of the JavaScript function which moves elements down.
static java.lang.String MOVEDOWN_TEXT_KEY
          The move down button text key.
static java.lang.String MOVETOP_BUTTON_FACET
          The facet name for the moveTop button.
static java.lang.String MOVETOP_BUTTON_ID
          The component id for the moveTop button.
static java.lang.String MOVETOP_FUNCTION
          Name of the JavaScript function which moves elements to the top.
static java.lang.String MOVETOP_TEXT_KEY
          The move top button text key.
static java.lang.String MOVEUP_BUTTON_FACET
          The facet name for the moveUp button.
static java.lang.String MOVEUP_BUTTON_ID
          The component id for the moveUp button.
static java.lang.String MOVEUP_FUNCTION
          Name of the JavaScript function which moves elements up.
static java.lang.String MOVEUP_TEXT_KEY
          The move up button text key.
static java.lang.String ONCHANGE_FUNCTION
          Name of the JavaScript function that handles changes on the available list.
static java.lang.String READ_ONLY_FACET
          The facet name for the readOnly text field.
static java.lang.String READ_ONLY_ID
          The component ID for the read only text field.
static java.lang.String RETURN
          String representing "return false" printed at the end of the javascript event handlers.
static java.lang.String UPDATEBUTTONS_FUNCTION
          Name of the JavaScript function that updates the buttons.
 
Fields inherited from class javax.faces.component.UIInput
COMPONENT_FAMILY, COMPONENT_TYPE, CONVERSION_MESSAGE_ID, REQUIRED_MESSAGE_ID, UPDATE_MESSAGE_ID
 
Fields inherited from interface javax.faces.component.NamingContainer
SEPARATOR_CHAR
 
Constructor Summary
OrderableList()
          Default constructor.
 
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.String getFocusElementId(javax.faces.context.FacesContext context)
          Returns the id of an HTML element suitable to receive the focus.
 javax.faces.component.UIComponent getHeaderComponent()
          Return a component that implements the header label.
 javax.faces.component.UIComponent getIndicatorComponent(javax.faces.context.FacesContext context, Label label)
          Return a component instance that can be referenced by a Label in order to evaluate the required and valid states of this component.
 java.lang.String getLabel()
          If set, a label is rendered adjacent to the component with the value of this attribute as the label text.
 java.lang.String getLabeledElementId(javax.faces.context.FacesContext context)
          Returns the absolute ID of an HTML element suitable for use as the value of an HTML LABEL element's for attribute.
 int getLabelLevel()
          Sets the style level for the generated labels.
 java.lang.Object getList()
           The object that represents the list of items.
 java.util.Iterator getListItems(javax.faces.context.FacesContext context, boolean ruler)
          Retrieve an Iterator of ListSelector.ListItem, to be used by the renderer.
 javax.faces.component.UIComponent getMoveBottomButtonComponent(javax.faces.context.FacesContext context)
          Return a component that implements the move to bottom button.
 javax.faces.component.UIComponent getMoveDownButtonComponent(javax.faces.context.FacesContext context)
          Return a component that implements the move down button.
 javax.faces.component.UIComponent getMoveTopButtonComponent(javax.faces.context.FacesContext context)
          Return a component that implements the move to top button.
 javax.faces.component.UIComponent getMoveUpButtonComponent(javax.faces.context.FacesContext context)
          Return a component that implements the move up button.
 java.lang.String getOnChange()
           
 java.lang.String getPrimaryElementID(javax.faces.context.FacesContext context)
          Deprecated.  
 javax.faces.component.UIComponent getReadOnlyValueComponent()
          Return a component that implements the read only value of this OrderableList.
 int getRows()
          The number of rows to display, which determines the length of the rendered listbox.
 java.lang.String getStyle()
          CSS style(s) to be applied to the outermost HTML element when this component is rendered.
 java.lang.String getStyleClass()
          CSS style class(es) to be applied to the outermost HTML element when this component is rendered.
 int getTabIndex()
          Position of this element in the tabbing order for the current document.
 java.lang.String getToolTip()
          Sets the value of the title attribute for the HTML element.
 java.lang.Object getValue()
           
 java.lang.String[] getValueAsStringArray(javax.faces.context.FacesContext context)
           
 javax.el.ValueExpression getValueExpression(java.lang.String name)
          Return the ValueExpression stored for the specified name (if any), respecting any property aliases.
 java.lang.String getWidth()
          Return a value suitable for the CSS width property to be applied to an HTML select element or null.
 boolean isDisabled()
          Flag indicating that activation of this component by the user is not currently permitted.
 boolean isLabelOnTop()
          If this attribute is true, the label is rendered above the component.
 boolean isMoveTopBottom()
          If this attribute is true, the Move to Top and Move to Bottom buttons are shown.
 boolean isMultiple()
          Flag indicating that the application user can make select more than one option from the listbox.
 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.
 boolean mainListSubmits()
           
 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 activation of this component by the user is not currently permitted.
 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 labels.
 void setLabelOnTop(boolean labelOnTop)
          If this attribute is true, the label is rendered above the component.
 void setList(java.lang.Object list)
           The object that represents the list of items.
 void setMoveTopBottom(boolean moveTopBottom)
          If this attribute is true, the Move to Top and Move to Bottom buttons are shown.
 void setMultiple(boolean multiple)
          Flag indicating that the application user can make select more than one option from the listbox.
 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 setRows(int rows)
          The number of rows to display, which determines the length of the rendered listbox.
 void setStyle(java.lang.String style)
          CSS style(s) to be applied to the outermost HTML element when this component is rendered.
 void setStyleClass(java.lang.String styleClass)
          CSS style class(es) 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 for 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.
 void setWidth(java.lang.String width)
          width is a value for the CSS width property suitable for the select HTML element.
 
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
 
Methods inherited from class javax.faces.component.UIComponentBase
encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientId, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getParent, getRendererType, getRendersChildren, 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, toString, wait, wait, wait
 
Methods inherited from interface javax.faces.component.EditableValueHolder
addValidator, addValueChangeListener, getSubmittedValue, getValidator, getValidators, getValueChangeListener, getValueChangeListeners, isImmediate, isLocalValueSet, isRequired, isValid, removeValidator, removeValueChangeListener, setImmediate, setLocalValueSet, setRequired, setSubmittedValue, setValid, setValidator, setValueChangeListener
 
Methods inherited from interface javax.faces.component.ValueHolder
getConverter, getLocalValue, setConverter, setValue
 
Methods inherited from interface com.sun.webui.jsf.component.SelectorManager
getClientId
 

Field Detail

MOVEUP_BUTTON_ID

public static final java.lang.String MOVEUP_BUTTON_ID
The component id for the moveUp button.

See Also:
Constant Field Values

MOVEUP_BUTTON_FACET

public static final java.lang.String MOVEUP_BUTTON_FACET
The facet name for the moveUp button.

See Also:
Constant Field Values

MOVEUP_TEXT_KEY

public static final java.lang.String MOVEUP_TEXT_KEY
The move up button text key.

See Also:
Constant Field Values

MOVEDOWN_BUTTON_ID

public static final java.lang.String MOVEDOWN_BUTTON_ID
The component id for the moveDown button.

See Also:
Constant Field Values

MOVEDOWN_BUTTON_FACET

public static final java.lang.String MOVEDOWN_BUTTON_FACET
The facet name for the moveDown button.

See Also:
Constant Field Values

MOVEDOWN_TEXT_KEY

public static final java.lang.String MOVEDOWN_TEXT_KEY
The move down button text key.

See Also:
Constant Field Values

MOVETOP_BUTTON_ID

public static final java.lang.String MOVETOP_BUTTON_ID
The component id for the moveTop button.

See Also:
Constant Field Values

MOVETOP_BUTTON_FACET

public static final java.lang.String MOVETOP_BUTTON_FACET
The facet name for the moveTop button.

See Also:
Constant Field Values

MOVETOP_TEXT_KEY

public static final java.lang.String MOVETOP_TEXT_KEY
The move top button text key.

See Also:
Constant Field Values

MOVEBOTTOM_BUTTON_ID

public static final java.lang.String MOVEBOTTOM_BUTTON_ID
The component id for the moveBottom button.

See Also:
Constant Field Values

MOVEBOTTOM_BUTTON_FACET

public static final java.lang.String MOVEBOTTOM_BUTTON_FACET
The facet name for the moveBottom button.

See Also:
Constant Field Values

MOVEBOTTOM_TEXT_KEY

public static final java.lang.String MOVEBOTTOM_TEXT_KEY
The move bottom button text key.

See Also:
Constant Field Values

LABEL_ID

public static final java.lang.String LABEL_ID
The component ID for the label.

See Also:
Constant Field Values

LABEL_FACET

public static final java.lang.String LABEL_FACET
The facet name for the label.

See Also:
Constant Field Values

LABEL_TEXT_KEY

public static final java.lang.String LABEL_TEXT_KEY
The default label text message key.

See Also:
Constant Field Values

READ_ONLY_ID

public static final java.lang.String READ_ONLY_ID
The component ID for the read only text field.

See Also:
Constant Field Values

READ_ONLY_FACET

public static final java.lang.String READ_ONLY_FACET
The facet name for the readOnly text field.

See Also:
Constant Field Values

FOOTER_FACET

public static final java.lang.String FOOTER_FACET
The name for the footer facet.

See Also:
Constant Field Values

RETURN

public static final java.lang.String RETURN
String representing "return false" printed at the end of the javascript event handlers.

See Also:
Constant Field Values

MOVEUP_FUNCTION

public static final java.lang.String MOVEUP_FUNCTION
Name of the JavaScript function which moves elements up.

See Also:
Constant Field Values

MOVEDOWN_FUNCTION

public static final java.lang.String MOVEDOWN_FUNCTION
Name of the JavaScript function which moves elements down.

See Also:
Constant Field Values

MOVETOP_FUNCTION

public static final java.lang.String MOVETOP_FUNCTION
Name of the JavaScript function which moves elements to the top.

See Also:
Constant Field Values

MOVEBOTTOM_FUNCTION

public static final java.lang.String MOVEBOTTOM_FUNCTION
Name of the JavaScript function which moves elements to the bottom.

See Also:
Constant Field Values

UPDATEBUTTONS_FUNCTION

public static final java.lang.String UPDATEBUTTONS_FUNCTION
Name of the JavaScript function that updates the buttons.

See Also:
Constant Field Values

ONCHANGE_FUNCTION

public static final java.lang.String ONCHANGE_FUNCTION
Name of the JavaScript function that handles changes on the available list.

See Also:
Constant Field Values
Constructor Detail

OrderableList

public OrderableList()
Default constructor.

Construct a new OrderableListBase.

Method Detail

getFamily

public java.lang.String getFamily()

Return the family for this component.

Overrides:
getFamily in class javax.faces.component.UIInput

getMoveUpButtonComponent

public javax.faces.component.UIComponent getMoveUpButtonComponent(javax.faces.context.FacesContext context)
Return a component that implements the move up button. If a facet named moveUpButton is found that component is returned. Otherwise a Button component is returned. It is assigned the id
getId() + "_moveUpButton"

If the facet is not defined then the returned Button component is re-intialized every time this method is called.

Returns:
a move up button component

getMoveDownButtonComponent

public javax.faces.component.UIComponent getMoveDownButtonComponent(javax.faces.context.FacesContext context)
Return a component that implements the move down button. If a facet named moveDownButton is found that component is returned. Otherwise a Button component is returned. It is assigned the id
getId() + "_moveDownButton"

If the facet is not defined then the returned Button component is re-intialized every time this method is called.

Returns:
a move down button component

getMoveTopButtonComponent

public javax.faces.component.UIComponent getMoveTopButtonComponent(javax.faces.context.FacesContext context)
Return a component that implements the move to top button. If a facet named moveToTop is found that component is returned. Otherwise a Button component is returned. It is assigned the id
getId() + "_moveToTop"

If the facet is not defined then the returned Button component is re-intialized every time this method is called.

Returns:
a move to top button component

getMoveBottomButtonComponent

public javax.faces.component.UIComponent getMoveBottomButtonComponent(javax.faces.context.FacesContext context)
Return a component that implements the move to bottom button. If a facet named moveToBottom is found that component is returned. Otherwise a Button component is returned. It is assigned the id
getId() + "_moveToBottom"

If the facet is not defined then the returned Button component is re-intialized every time this method is called.

Returns:
a move to bottom button component

getHeaderComponent

public javax.faces.component.UIComponent getHeaderComponent()
Return a component that implements the header label. If a facet named label is found that component is returned. Otherwise a Label component is returned. It is assigned the id
getId() + "_label"

If the facet is not defined then the returned Label component is re-intialized every time this method is called.

Returns:
a header label component

getPrimaryElementID

public java.lang.String getPrimaryElementID(javax.faces.context.FacesContext context)
Deprecated. 

Implement this method so that it returns the DOM ID of the HTML element which should receive focus when the component receives focus, and to which a component label should apply. Usually, this is the first element that accepts input.

Specified by:
getPrimaryElementID in interface com.sun.webui.jsf.component.ComplexComponent
Parameters:
context - The FacesContext for the request
Returns:
The client id, also the JavaScript element id
See Also:
getLabeledElementId(javax.faces.context.FacesContext), getFocusElementId(javax.faces.context.FacesContext)

getLabeledElementId

public java.lang.String getLabeledElementId(javax.faces.context.FacesContext context)
Returns the absolute ID of an HTML element suitable for use as the value of an HTML LABEL element's for attribute. If the ComplexComponent has sub-compoents, and one of the sub-components is the target of a label, if that sub-component is a ComplexComponent, then getLabeledElementId must called on the sub-component and the value returned. The value returned by this method call may or may not resolve to a component instance.

If isReadOnly returns true, then the getReadOnlyValueComponent method is called. If the component instance returned is a ComplexComponent then getLabeledElementId is called on it and the value returned, else its client id is returned.

Specified by:
getLabeledElementId in interface com.sun.webui.jsf.component.ComplexComponent
Parameters:
context - The FacesContext used for the request
Returns:
An abolute id suitable for the value of an HTML LABEL element's for attribute.

getFocusElementId

public java.lang.String getFocusElementId(javax.faces.context.FacesContext context)
Returns the id of an HTML element suitable to receive the focus. If the ComplexComponent has sub-compoents, and one of the sub-components is to reveive the focus, if that sub-component is a ComplexComponent, then getFocusElementId must called on the sub-component and the value returned. The value returned by this method call may or may not resolve to a component instance.

Specified by:
getFocusElementId in interface com.sun.webui.jsf.component.ComplexComponent
Parameters:
context - The FacesContext used for the request

getIndicatorComponent

public javax.faces.component.UIComponent getIndicatorComponent(javax.faces.context.FacesContext context,
                                                               Label label)
Return a component instance that can be referenced by a Label in order to evaluate the required and valid states of this component.

Specified by:
getIndicatorComponent in interface com.sun.webui.jsf.component.ComplexComponent
Parameters:
context - The current FacesContext instance
label - The Label that labels this component.
Returns:
a UIComponent in order to evaluate the required and valid states.

getListItems

public java.util.Iterator getListItems(javax.faces.context.FacesContext context,
                                       boolean ruler)
                                throws javax.faces.FacesException
Retrieve an Iterator of ListSelector.ListItem, to be used by the renderer.

Specified by:
getListItems in interface com.sun.webui.jsf.component.ListManager
Returns:
an Iterator over ListItem.
Throws:
javax.faces.FacesException

getValueAsStringArray

public java.lang.String[] getValueAsStringArray(javax.faces.context.FacesContext context)
Specified by:
getValueAsStringArray in interface com.sun.webui.jsf.component.ListManager

getConvertedValue

public java.lang.Object getConvertedValue(javax.faces.context.FacesContext context,
                                          java.lang.Object submittedValue)
                                   throws javax.faces.convert.ConverterException
Retrieve the value of this component (the "selected" property) as an object. This method is invoked by the JSF engine during the validation phase. The JSF default behaviour is for components to defer the conversion and validation to the renderer, but for the Selector based components, the renderers do not share as much functionality as the components do, so it is more efficient to do it here.

Overrides:
getConvertedValue in class javax.faces.component.UIInput
Parameters:
context - The FacesContext of the request
submittedValue - The submitted value of the component
Throws:
javax.faces.convert.ConverterException

getReadOnlyValueComponent

public javax.faces.component.UIComponent getReadOnlyValueComponent()
Return a component that implements the read only value of this OrderableList. If a facet named readOnly is found that component is returned. Otherwise a StaticText component is returned. It is assigned the id
getId() + "_readOnly"

If the facet is not defined then the returned StaticText component is re-intialized every time this method is called.

Specified by:
getReadOnlyValueComponent in interface com.sun.webui.jsf.component.ListManager
Returns:
a component that represents the read only value of this OrderableList

getOnChange

public java.lang.String getOnChange()
Specified by:
getOnChange in interface com.sun.webui.jsf.component.SelectorManager

mainListSubmits

public boolean mainListSubmits()
Specified by:
mainListSubmits in interface com.sun.webui.jsf.component.ListManager

getValueExpression

public javax.el.ValueExpression getValueExpression(java.lang.String name)

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

Overrides:
getValueExpression in class javax.faces.component.UIComponentBase
Parameters:
name - Name of value binding expression to retrieve

setValueExpression

public void setValueExpression(java.lang.String name,
                               javax.el.ValueExpression binding)

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

Overrides:
setValueExpression in class javax.faces.component.UIComponentBase
Parameters:
name - Name of value binding to set
binding - ValueExpression to set, or null to remove

getValue

public java.lang.Object getValue()
Specified by:
getValue in interface javax.faces.component.ValueHolder
Overrides:
getValue in class javax.faces.component.UIOutput

isDisabled

public boolean isDisabled()

Flag indicating that activation of this component by the user is not currently permitted.

Specified by:
isDisabled in interface com.sun.webui.jsf.component.SelectorManager

setDisabled

public void setDisabled(boolean disabled)

Flag indicating that activation of this component by the user is not currently permitted.

See Also:
isDisabled()

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 labels. 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 labels. Valid values are 1 (largest), 2 and 3 (smallest). The default value is 2.

See Also:
getLabelLevel()

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()

getList

public java.lang.Object getList()

The object that represents the list of items. The attribute's value must be a JavaServer Faces EL expression that evaluates to an array of Objects or to a java.util.List.


setList

public void setList(java.lang.Object list)

The object that represents the list of items. The attribute's value must be a JavaServer Faces EL expression that evaluates to an array of Objects or to a java.util.List.

See Also:
getList()

isMoveTopBottom

public boolean isMoveTopBottom()

If this attribute is true, the Move to Top and Move to Bottom buttons are shown. The default is false.


setMoveTopBottom

public void setMoveTopBottom(boolean moveTopBottom)

If this attribute is true, the Move to Top and Move to Bottom buttons are shown. The default is false.

See Also:
isMoveTopBottom()

isMultiple

public boolean isMultiple()

Flag indicating that the application user can make select more than one option from the listbox.

Specified by:
isMultiple in interface com.sun.webui.jsf.component.SelectorManager

setMultiple

public void setMultiple(boolean multiple)

Flag indicating that the application user can make select more than one option from the listbox.

See Also:
isMultiple()

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.

Specified by:
isReadOnly in interface com.sun.webui.jsf.component.SelectorManager

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()

getRows

public int getRows()

The number of rows to display, which determines the length of the rendered listbox. The default value is 12.

Specified by:
getRows in interface com.sun.webui.jsf.component.ListManager

setRows

public void setRows(int rows)

The number of rows to display, which determines the length of the rendered listbox. The default value is 12.

See Also:
getRows()

getStyle

public java.lang.String getStyle()

CSS style(s) to be applied to the outermost HTML element when this component is rendered.

Specified by:
getStyle in interface com.sun.webui.jsf.component.SelectorManager

setStyle

public void setStyle(java.lang.String style)

CSS style(s) to be applied to the outermost HTML element when this component is rendered.

See Also:
getStyle()

getStyleClass

public java.lang.String getStyleClass()

CSS style class(es) to be applied to the outermost HTML element when this component is rendered.

Specified by:
getStyleClass in interface com.sun.webui.jsf.component.SelectorManager

setStyleClass

public void setStyleClass(java.lang.String styleClass)

CSS style class(es) to be applied to the outermost HTML element when this component is rendered.

See Also:
getStyleClass()

getTabIndex

public int getTabIndex()

Position of this element in the tabbing order for the current document. The tabbing order determines the sequence in which elements receive focus when the tab key is pressed. The tabIndex value must be an integer between 0 and 32767.

Specified by:
getTabIndex in interface com.sun.webui.jsf.component.SelectorManager

setTabIndex

public void setTabIndex(int tabIndex)

Position of this element in the tabbing order for the current document. The tabbing order determines the sequence in which elements receive focus when the tab key is pressed. The tabIndex value must be an integer between 0 and 32767.

See Also:
getTabIndex()

getToolTip

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.

Specified by:
getToolTip in interface com.sun.webui.jsf.component.ListManager

setToolTip

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.

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.

Specified by:
isVisible in interface com.sun.webui.jsf.component.ListManager

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()

getWidth

public java.lang.String getWidth()
Return a value suitable for the CSS width property to be applied to an HTML select element or null.

If no value has been set, a default value is determined from the theme property orderableList.width defined in the messages theme category. If this theme property is not defined, the width is determined by the longest option element of the rendered select element.

Specified by:
getWidth in interface com.sun.webui.jsf.component.ListManager
Returns:
The value used to determine the width of a select HTML element.

setWidth

public void setWidth(java.lang.String width)
width is a value for the CSS width property suitable for the select HTML element. As a CSS string property value, width is assumed to contain the units. For example:

The value is not parsed by OrderableList and is intended to be applied directly to the style attribute of the select element. If width is null, OrderableList behavior will assume the size of the select element will be based on the length of the longest option in the select element.

See Also:
getWidth()

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 WebuiInput

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 WebuiInput


Copyright © 2008 Sun Microsystems, Inc. All Rights Reserved.