org.apache.myfaces.trinidad.component.core.input
Class CoreSelectOrderShuttle

java.lang.Object
  extended by javax.faces.component.UIComponent
      extended by org.apache.myfaces.trinidad.component.UIXComponent
          extended by org.apache.myfaces.trinidad.component.UIXComponentBase
              extended by org.apache.myfaces.trinidad.component.UIXValue
                  extended by org.apache.myfaces.trinidad.component.UIXEditableValue
                      extended by org.apache.myfaces.trinidad.component.UIXSelectMany
                          extended by org.apache.myfaces.trinidad.component.UIXSelectOrder
                              extended by org.apache.myfaces.trinidad.component.core.input.CoreSelectOrderShuttle
All Implemented Interfaces:
javax.faces.component.EditableValueHolder, javax.faces.component.StateHolder, javax.faces.component.ValueHolder

public class CoreSelectOrderShuttle
extends UIXSelectOrder

The selectOrderShuttle component provides a mechanism for selecting multiple values from a list of values by allowing the user to move items between two lists, and reordering that list of values. It includes all the functionality of selectManyShuttle, and has an equivalent API. The only functional difference is that selectOrderShuttle will present the user with the ability to reorder the list of selected values, and will deliver ValueChangeEvents when the order changes. (selectMany components do not consider changes in order relevant to the value of that component.) See the documentation for selectManyShuttle for further information on using the shuttle.

Events:

Type Phases Description
javax.faces.event.ValueChangeEvent Apply Request Values The valueChange event is delivered when the value attribute is changed.
org.apache.myfaces.trinidad.event.AttributeChangeEvent Apply Request Values Event delivered to describe an attribute change. Attribute change events are not delivered for any programmatic change to a property. They are only delivered when a renderer changes a property without the application's specific request. An example of an attribute change events might include the width of a column that supported client-side resizing.


Field Summary
static java.lang.String COMPONENT_FAMILY
           
static java.lang.String COMPONENT_TYPE
           
static PropertyKey DISABLED_KEY
           
static java.lang.String FILTER_FACET
           
static PropertyKey INLINE_STYLE_KEY
           
static PropertyKey LABEL_KEY
           
static PropertyKey LEADING_DESC_SHOWN_KEY
           
static java.lang.String LEADING_FOOTER_FACET
           
static PropertyKey LEADING_HEADER_KEY
           
static PropertyKey ONBLUR_KEY
           
static PropertyKey ONCHANGE_KEY
           
static PropertyKey ONCLICK_KEY
           
static PropertyKey ONDBLCLICK_KEY
           
static PropertyKey ONFOCUS_KEY
           
static PropertyKey ONKEYDOWN_KEY
           
static PropertyKey ONKEYPRESS_KEY
           
static PropertyKey ONKEYUP_KEY
           
static PropertyKey ONMOUSEDOWN_KEY
           
static PropertyKey ONMOUSEMOVE_KEY
           
static PropertyKey ONMOUSEOUT_KEY
           
static PropertyKey ONMOUSEOVER_KEY
           
static PropertyKey ONMOUSEUP_KEY
           
static PropertyKey PARTIAL_TRIGGERS_KEY
           
static PropertyKey READ_ONLY_KEY
           
static PropertyKey REORDER_ONLY_KEY
           
static PropertyKey SHORT_DESC_KEY
           
static PropertyKey SIZE_KEY
           
static PropertyKey STYLE_CLASS_KEY
           
static PropertyKey TRAILING_DESC_SHOWN_KEY
           
static java.lang.String TRAILING_FOOTER_FACET
           
static PropertyKey TRAILING_HEADER_KEY
           
static FacesBean.Type TYPE
           
static PropertyKey VALUE_PASS_THRU_KEY
           
 
Fields inherited from class org.apache.myfaces.trinidad.component.UIXSelectMany
REQUIRED_MESSAGE_ID, UNSUPPORTED_MODEL_TYPE_MESSAGE_ID
 
Fields inherited from class org.apache.myfaces.trinidad.component.UIXEditableValue
CONVERSION_MESSAGE_ID, IMMEDIATE_KEY, LOCAL_VALUE_SET_KEY, REQUIRED_KEY, REQUIRED_MESSAGE_DETAIL_KEY, SUBMITTED_VALUE_KEY, VALID_KEY, VALIDATOR_KEY, VALIDATORS_KEY, VALUE_CHANGE_LISTENER_KEY
 
Fields inherited from class org.apache.myfaces.trinidad.component.UIXValue
CONVERTER_KEY, VALUE_KEY
 
Fields inherited from class org.apache.myfaces.trinidad.component.UIXComponentBase
BINDING_KEY, ID_KEY, RENDERED_KEY, RENDERER_TYPE_KEY, TRANSIENT_KEY
 
Fields inherited from class javax.faces.component.UIComponent
bindings
 
Constructor Summary
  CoreSelectOrderShuttle()
          Construct an instance of the CoreSelectOrderShuttle.
protected CoreSelectOrderShuttle(java.lang.String rendererType)
          Construct an instance of the CoreSelectOrderShuttle.
 
Method Summary
protected  FacesBean.Type getBeanType()
           
 java.lang.String getFamily()
           
 javax.faces.component.UIComponent getFilter()
          the filter above the leading list.
 java.lang.String getInlineStyle()
          Gets the inline CSS style for this element
 java.lang.String getLabel()
          Gets the label for the shuttle that is used to identify the component only when displaying error messages.
 javax.faces.component.UIComponent getLeadingFooter()
          the footer of buttons/images under the leading list.
 java.lang.String getLeadingHeader()
          Gets the header of the leading list of the shuttle.
 java.lang.String getOnblur()
          Gets the event handler for when the element loses focus.
 java.lang.String getOnchange()
          Gets event handler for when the value is changed.
 java.lang.String getOnclick()
          Gets an onclick Javascript handler.
 java.lang.String getOndblclick()
          Gets an ondblclick Javascript handler.
 java.lang.String getOnfocus()
          Gets the event handler for when the element receives focus.
 java.lang.String getOnkeydown()
          Gets an onkeydown Javascript handler.
 java.lang.String getOnkeypress()
          Gets an onkeypress Javascript handler.
 java.lang.String getOnkeyup()
          Gets an onkeyup Javascript handler.
 java.lang.String getOnmousedown()
          Gets an onmousedown Javascript handler.
 java.lang.String getOnmousemove()
          Gets an onmousemove Javascript handler.
 java.lang.String getOnmouseout()
          Gets an onmouseout Javascript handler.
 java.lang.String getOnmouseover()
          Gets an onmouseover Javascript handler.
 java.lang.String getOnmouseup()
          Gets an onmouseup Javascript handler.
 java.lang.String[] getPartialTriggers()
          Gets the IDs of the components that should trigger a partial update.
 java.lang.String getShortDesc()
          Gets the short description of the bean.
 int getSize()
          Gets the display size(number of items) of the lists.
 java.lang.String getStyleClass()
          Gets the CSS style class of the bean.
 javax.faces.component.UIComponent getTrailingFooter()
          the footer of buttons/images under the trailing list.
 java.lang.String getTrailingHeader()
          Gets the header of the trailing list of the shuttle.
 boolean isDisabled()
          Gets whether the element is disabled.
 boolean isLeadingDescShown()
          Gets whether or not the leading list has an area to display descriptions.
 boolean isReadOnly()
          Gets whether the element is read-only.
 boolean isReorderOnly()
          Gets whether the shuttle is in "reorder only" mode, where the user can reorder the list of values, but cannot add or remove them.
 boolean isTrailingDescShown()
          Gets whether or not the trailing list has an area to display descriptions.
 boolean isValuePassThru()
          Gets whether or not the values are passed through to the client.
 void setDisabled(boolean disabled)
          Sets whether the element is disabled.
 void setFilter(javax.faces.component.UIComponent filterFacet)
          the filter above the leading list.
 void setInlineStyle(java.lang.String inlineStyle)
          Sets the inline CSS style for this element
 void setLabel(java.lang.String label)
          Sets the label for the shuttle that is used to identify the component only when displaying error messages.
 void setLeadingDescShown(boolean leadingDescShown)
          Sets whether or not the leading list has an area to display descriptions.
 void setLeadingFooter(javax.faces.component.UIComponent leadingFooterFacet)
          the footer of buttons/images under the leading list.
 void setLeadingHeader(java.lang.String leadingHeader)
          Sets the header of the leading list of the shuttle.
 void setOnblur(java.lang.String onblur)
          Sets the event handler for when the element loses focus.
 void setOnchange(java.lang.String onchange)
          Sets event handler for when the value is changed.
 void setOnclick(java.lang.String onclick)
          Sets an onclick Javascript handler.
 void setOndblclick(java.lang.String ondblclick)
          Sets an ondblclick Javascript handler.
 void setOnfocus(java.lang.String onfocus)
          Sets the event handler for when the element receives focus.
 void setOnkeydown(java.lang.String onkeydown)
          Sets an onkeydown Javascript handler.
 void setOnkeypress(java.lang.String onkeypress)
          Sets an onkeypress Javascript handler.
 void setOnkeyup(java.lang.String onkeyup)
          Sets an onkeyup Javascript handler.
 void setOnmousedown(java.lang.String onmousedown)
          Sets an onmousedown Javascript handler.
 void setOnmousemove(java.lang.String onmousemove)
          Sets an onmousemove Javascript handler.
 void setOnmouseout(java.lang.String onmouseout)
          Sets an onmouseout Javascript handler.
 void setOnmouseover(java.lang.String onmouseover)
          Sets an onmouseover Javascript handler.
 void setOnmouseup(java.lang.String onmouseup)
          Sets an onmouseup Javascript handler.
 void setPartialTriggers(java.lang.String[] partialTriggers)
          Sets the IDs of the components that should trigger a partial update.
 void setReadOnly(boolean readOnly)
          Sets whether the element is read-only.
 void setReorderOnly(boolean reorderOnly)
          Sets whether the shuttle is in "reorder only" mode, where the user can reorder the list of values, but cannot add or remove them.
 void setShortDesc(java.lang.String shortDesc)
          Sets the short description of the bean.
 void setSize(int size)
          Sets the display size(number of items) of the lists.
 void setStyleClass(java.lang.String styleClass)
          Sets the CSS style class of the bean.
 void setTrailingDescShown(boolean trailingDescShown)
          Sets whether or not the trailing list has an area to display descriptions.
 void setTrailingFooter(javax.faces.component.UIComponent trailingFooterFacet)
          the footer of buttons/images under the trailing list.
 void setTrailingHeader(java.lang.String trailingHeader)
          Sets the header of the trailing list of the shuttle.
 void setValuePassThru(boolean valuePassThru)
          Sets whether or not the values are passed through to the client.
 
Methods inherited from class org.apache.myfaces.trinidad.component.UIXSelectOrder
compareValues
 
Methods inherited from class org.apache.myfaces.trinidad.component.UIXSelectMany
getRequiredMessageKey, isEmpty, validateValue
 
Methods inherited from class org.apache.myfaces.trinidad.component.UIXEditableValue
addValidator, addValueChangeListener, broadcast, getConvertedValue, getRequiredMessageDetail, getSubmittedValue, getValidator, getValidators, getValueChangeListener, getValueChangeListeners, isImmediate, isLocalValueSet, isRequired, isValid, processDecodes, processUpdates, processValidators, removeValidator, removeValueChangeListener, resetValue, setImmediate, setLocalValueSet, setRequired, setRequiredMessageDetail, setSubmittedValue, setValid, setValidator, setValueChangeListener, updateModel, validate
 
Methods inherited from class org.apache.myfaces.trinidad.component.UIXValue
getConverter, getLocalValue, getValue, setConverter, setValue
 
Methods inherited from class org.apache.myfaces.trinidad.component.UIXComponentBase
adaptMethodBinding, addAttributeChange, addAttributeChangeListener, addFacesListener, broadcastToMethodBinding, broadcastToMethodExpression, createFacesBean, decode, decodeChildren, decodeChildrenImpl, encodeAll, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributeChangeListener, getAttributeChangeListeners, getAttributes, getBooleanProperty, getChildCount, getChildren, getClientId, getFacesBean, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacetNames, getFacets, getFacetsAndChildren, getId, getIntProperty, getLifecycleRenderer, getParent, getProperty, getPropertyKey, getRenderer, getRendererType, getRendersChildren, getValueBinding, getValueExpression, isRendered, isTransient, markInitialState, processRestoreState, processSaveState, queueEvent, removeAttributeChangeListener, removeFacesListener, restoreState, saveState, setAttributeChangeListener, setAttributeChangeListener, setBooleanProperty, setId, setIntProperty, setParent, setProperty, setRendered, setRendererType, setTransient, setValueBinding, setValueExpression, toString, updateChildren, updateChildrenImpl, validateChildren, validateChildrenImpl
 
Methods inherited from class javax.faces.component.UIComponent
getContainerClientId, invokeOnComponent
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface javax.faces.component.ValueHolder
getConverter, getLocalValue, getValue, setConverter, setValue
 

Field Detail

TYPE

public static final FacesBean.Type TYPE

REORDER_ONLY_KEY

public static final PropertyKey REORDER_ONLY_KEY

VALUE_PASS_THRU_KEY

public static final PropertyKey VALUE_PASS_THRU_KEY

READ_ONLY_KEY

public static final PropertyKey READ_ONLY_KEY

DISABLED_KEY

public static final PropertyKey DISABLED_KEY

SHORT_DESC_KEY

public static final PropertyKey SHORT_DESC_KEY

PARTIAL_TRIGGERS_KEY

public static final PropertyKey PARTIAL_TRIGGERS_KEY

ONFOCUS_KEY

public static final PropertyKey ONFOCUS_KEY

ONBLUR_KEY

public static final PropertyKey ONBLUR_KEY

ONCHANGE_KEY

public static final PropertyKey ONCHANGE_KEY

ONCLICK_KEY

public static final PropertyKey ONCLICK_KEY

ONDBLCLICK_KEY

public static final PropertyKey ONDBLCLICK_KEY

ONMOUSEDOWN_KEY

public static final PropertyKey ONMOUSEDOWN_KEY

ONMOUSEUP_KEY

public static final PropertyKey ONMOUSEUP_KEY

ONMOUSEOVER_KEY

public static final PropertyKey ONMOUSEOVER_KEY

ONMOUSEMOVE_KEY

public static final PropertyKey ONMOUSEMOVE_KEY

ONMOUSEOUT_KEY

public static final PropertyKey ONMOUSEOUT_KEY

ONKEYPRESS_KEY

public static final PropertyKey ONKEYPRESS_KEY

ONKEYDOWN_KEY

public static final PropertyKey ONKEYDOWN_KEY

ONKEYUP_KEY

public static final PropertyKey ONKEYUP_KEY

STYLE_CLASS_KEY

public static final PropertyKey STYLE_CLASS_KEY

INLINE_STYLE_KEY

public static final PropertyKey INLINE_STYLE_KEY

SIZE_KEY

public static final PropertyKey SIZE_KEY

LEADING_HEADER_KEY

public static final PropertyKey LEADING_HEADER_KEY

TRAILING_HEADER_KEY

public static final PropertyKey TRAILING_HEADER_KEY

LEADING_DESC_SHOWN_KEY

public static final PropertyKey LEADING_DESC_SHOWN_KEY

TRAILING_DESC_SHOWN_KEY

public static final PropertyKey TRAILING_DESC_SHOWN_KEY

LABEL_KEY

public static final PropertyKey LABEL_KEY

FILTER_FACET

public static final java.lang.String FILTER_FACET
See Also:
Constant Field Values

LEADING_FOOTER_FACET

public static final java.lang.String LEADING_FOOTER_FACET
See Also:
Constant Field Values

TRAILING_FOOTER_FACET

public static final java.lang.String TRAILING_FOOTER_FACET
See Also:
Constant Field Values

COMPONENT_FAMILY

public static final java.lang.String COMPONENT_FAMILY
See Also:
Constant Field Values

COMPONENT_TYPE

public static final java.lang.String COMPONENT_TYPE
See Also:
Constant Field Values
Constructor Detail

CoreSelectOrderShuttle

public CoreSelectOrderShuttle()
Construct an instance of the CoreSelectOrderShuttle.


CoreSelectOrderShuttle

protected CoreSelectOrderShuttle(java.lang.String rendererType)
Construct an instance of the CoreSelectOrderShuttle.

Method Detail

getFilter

public final javax.faces.component.UIComponent getFilter()
the filter above the leading list.


setFilter

public final void setFilter(javax.faces.component.UIComponent filterFacet)
the filter above the leading list.


getLeadingFooter

public final javax.faces.component.UIComponent getLeadingFooter()
the footer of buttons/images under the leading list.


setLeadingFooter

public final void setLeadingFooter(javax.faces.component.UIComponent leadingFooterFacet)
the footer of buttons/images under the leading list.


getTrailingFooter

public final javax.faces.component.UIComponent getTrailingFooter()
the footer of buttons/images under the trailing list.


setTrailingFooter

public final void setTrailingFooter(javax.faces.component.UIComponent trailingFooterFacet)
the footer of buttons/images under the trailing list.


isReorderOnly

public final boolean isReorderOnly()
Gets whether the shuttle is in "reorder only" mode, where the user can reorder the list of values, but cannot add or remove them.

Returns:
the new reorderOnly value

setReorderOnly

public final void setReorderOnly(boolean reorderOnly)
Sets whether the shuttle is in "reorder only" mode, where the user can reorder the list of values, but cannot add or remove them.

Parameters:
reorderOnly - the new reorderOnly value

isValuePassThru

public final boolean isValuePassThru()
Gets whether or not the values are passed through to the client. When valuePassThru is false the value and the options' values are converted to indexes before being sent to the client. Therefore, when valuePassThru is false, there is no need to write your own converter when you are using custom Objects as your values and/or options. If you need to know the actual values on the client-side, then you can set valuePassThru to true. This will pass the values through to the client, using your custom converter if it is available; a custom converter is needed if you are using custom objects. The default is false.

Returns:
the new valuePassThru value

setValuePassThru

public final void setValuePassThru(boolean valuePassThru)
Sets whether or not the values are passed through to the client. When valuePassThru is false the value and the options' values are converted to indexes before being sent to the client. Therefore, when valuePassThru is false, there is no need to write your own converter when you are using custom Objects as your values and/or options. If you need to know the actual values on the client-side, then you can set valuePassThru to true. This will pass the values through to the client, using your custom converter if it is available; a custom converter is needed if you are using custom objects. The default is false.

Parameters:
valuePassThru - the new valuePassThru value

isReadOnly

public final boolean isReadOnly()
Gets whether the element is read-only.

Returns:
the new readOnly value

setReadOnly

public final void setReadOnly(boolean readOnly)
Sets whether the element is read-only.

Parameters:
readOnly - the new readOnly value

isDisabled

public final boolean isDisabled()
Gets whether the element is disabled.

Returns:
the new disabled value

setDisabled

public final void setDisabled(boolean disabled)
Sets whether the element is disabled.

Parameters:
disabled - the new disabled value

getShortDesc

public final java.lang.String getShortDesc()
Gets the short description of the bean. This text is commonly used by user agents to display tooltip help text.

Returns:
the new shortDesc value

setShortDesc

public final void setShortDesc(java.lang.String shortDesc)
Sets the short description of the bean. This text is commonly used by user agents to display tooltip help text.

Parameters:
shortDesc - the new shortDesc value

getPartialTriggers

public final java.lang.String[] getPartialTriggers()
Gets the IDs of the components that should trigger a partial update. This component will listen on the trigger components. If one of the trigger components receives an event that will cause it to update in some way, this component will request to be updated too.

Returns:
the new partialTriggers value

setPartialTriggers

public final void setPartialTriggers(java.lang.String[] partialTriggers)
Sets the IDs of the components that should trigger a partial update. This component will listen on the trigger components. If one of the trigger components receives an event that will cause it to update in some way, this component will request to be updated too.

Parameters:
partialTriggers - the new partialTriggers value

getOnfocus

public final java.lang.String getOnfocus()
Gets the event handler for when the element receives focus.

Returns:
the new onfocus value

setOnfocus

public final void setOnfocus(java.lang.String onfocus)
Sets the event handler for when the element receives focus.

Parameters:
onfocus - the new onfocus value

getOnblur

public final java.lang.String getOnblur()
Gets the event handler for when the element loses focus.

Returns:
the new onblur value

setOnblur

public final void setOnblur(java.lang.String onblur)
Sets the event handler for when the element loses focus.

Parameters:
onblur - the new onblur value

getOnchange

public final java.lang.String getOnchange()
Gets event handler for when the value is changed.

Returns:
the new onchange value

setOnchange

public final void setOnchange(java.lang.String onchange)
Sets event handler for when the value is changed.

Parameters:
onchange - the new onchange value

getOnclick

public final java.lang.String getOnclick()
Gets an onclick Javascript handler.

Returns:
the new onclick value

setOnclick

public final void setOnclick(java.lang.String onclick)
Sets an onclick Javascript handler.

Parameters:
onclick - the new onclick value

getOndblclick

public final java.lang.String getOndblclick()
Gets an ondblclick Javascript handler.

Returns:
the new ondblclick value

setOndblclick

public final void setOndblclick(java.lang.String ondblclick)
Sets an ondblclick Javascript handler.

Parameters:
ondblclick - the new ondblclick value

getOnmousedown

public final java.lang.String getOnmousedown()
Gets an onmousedown Javascript handler.

Returns:
the new onmousedown value

setOnmousedown

public final void setOnmousedown(java.lang.String onmousedown)
Sets an onmousedown Javascript handler.

Parameters:
onmousedown - the new onmousedown value

getOnmouseup

public final java.lang.String getOnmouseup()
Gets an onmouseup Javascript handler.

Returns:
the new onmouseup value

setOnmouseup

public final void setOnmouseup(java.lang.String onmouseup)
Sets an onmouseup Javascript handler.

Parameters:
onmouseup - the new onmouseup value

getOnmouseover

public final java.lang.String getOnmouseover()
Gets an onmouseover Javascript handler.

Returns:
the new onmouseover value

setOnmouseover

public final void setOnmouseover(java.lang.String onmouseover)
Sets an onmouseover Javascript handler.

Parameters:
onmouseover - the new onmouseover value

getOnmousemove

public final java.lang.String getOnmousemove()
Gets an onmousemove Javascript handler.

Returns:
the new onmousemove value

setOnmousemove

public final void setOnmousemove(java.lang.String onmousemove)
Sets an onmousemove Javascript handler.

Parameters:
onmousemove - the new onmousemove value

getOnmouseout

public final java.lang.String getOnmouseout()
Gets an onmouseout Javascript handler.

Returns:
the new onmouseout value

setOnmouseout

public final void setOnmouseout(java.lang.String onmouseout)
Sets an onmouseout Javascript handler.

Parameters:
onmouseout - the new onmouseout value

getOnkeypress

public final java.lang.String getOnkeypress()
Gets an onkeypress Javascript handler.

Returns:
the new onkeypress value

setOnkeypress

public final void setOnkeypress(java.lang.String onkeypress)
Sets an onkeypress Javascript handler.

Parameters:
onkeypress - the new onkeypress value

getOnkeydown

public final java.lang.String getOnkeydown()
Gets an onkeydown Javascript handler.

Returns:
the new onkeydown value

setOnkeydown

public final void setOnkeydown(java.lang.String onkeydown)
Sets an onkeydown Javascript handler.

Parameters:
onkeydown - the new onkeydown value

getOnkeyup

public final java.lang.String getOnkeyup()
Gets an onkeyup Javascript handler.

Returns:
the new onkeyup value

setOnkeyup

public final void setOnkeyup(java.lang.String onkeyup)
Sets an onkeyup Javascript handler.

Parameters:
onkeyup - the new onkeyup value

getStyleClass

public final java.lang.String getStyleClass()
Gets the CSS style class of the bean.

Returns:
the new styleClass value

setStyleClass

public final void setStyleClass(java.lang.String styleClass)
Sets the CSS style class of the bean.

Parameters:
styleClass - the new styleClass value

getInlineStyle

public final java.lang.String getInlineStyle()
Gets the inline CSS style for this element

Returns:
the new inlineStyle value

setInlineStyle

public final void setInlineStyle(java.lang.String inlineStyle)
Sets the inline CSS style for this element

Parameters:
inlineStyle - the new inlineStyle value

getSize

public final int getSize()
Gets the display size(number of items) of the lists. The size specified must be between 10 and 20 items. If the attribute is not set or has a value less than 10, the size would have a default or minimum value of 10. If the attribute value specified is more than 20 items, the size would have the maximum value of 20.

Returns:
the new size value

setSize

public final void setSize(int size)
Sets the display size(number of items) of the lists. The size specified must be between 10 and 20 items. If the attribute is not set or has a value less than 10, the size would have a default or minimum value of 10. If the attribute value specified is more than 20 items, the size would have the maximum value of 20.

Parameters:
size - the new size value

getLeadingHeader

public final java.lang.String getLeadingHeader()
Gets the header of the leading list of the shuttle.

Returns:
the new leadingHeader value

setLeadingHeader

public final void setLeadingHeader(java.lang.String leadingHeader)
Sets the header of the leading list of the shuttle.

Parameters:
leadingHeader - the new leadingHeader value

getTrailingHeader

public final java.lang.String getTrailingHeader()
Gets the header of the trailing list of the shuttle.

Returns:
the new trailingHeader value

setTrailingHeader

public final void setTrailingHeader(java.lang.String trailingHeader)
Sets the header of the trailing list of the shuttle.

Parameters:
trailingHeader - the new trailingHeader value

isLeadingDescShown

public final boolean isLeadingDescShown()
Gets whether or not the leading list has an area to display descriptions.

Returns:
the new leadingDescShown value

setLeadingDescShown

public final void setLeadingDescShown(boolean leadingDescShown)
Sets whether or not the leading list has an area to display descriptions.

Parameters:
leadingDescShown - the new leadingDescShown value

isTrailingDescShown

public final boolean isTrailingDescShown()
Gets whether or not the trailing list has an area to display descriptions.

Returns:
the new trailingDescShown value

setTrailingDescShown

public final void setTrailingDescShown(boolean trailingDescShown)
Sets whether or not the trailing list has an area to display descriptions.

Parameters:
trailingDescShown - the new trailingDescShown value

getLabel

public final java.lang.String getLabel()
Gets the label for the shuttle that is used to identify the component only when displaying error messages. The label specified does not otherwise appear on the page.

Returns:
the new label value

setLabel

public final void setLabel(java.lang.String label)
Sets the label for the shuttle that is used to identify the component only when displaying error messages. The label specified does not otherwise appear on the page.

Parameters:
label - the new label value

getFamily

public java.lang.String getFamily()
Overrides:
getFamily in class UIXSelectOrder

getBeanType

protected FacesBean.Type getBeanType()
Overrides:
getBeanType in class UIXSelectOrder


Copyright © 2001-2007 Apache Software Foundation. All Rights Reserved.