org.richfaces.ui.select.orderingList

## Class UIOrderingList

- java.lang.Object
- - javax.faces.component.UIComponent
  - - javax.faces.component.UIComponentBase
    - - javax.faces.component.UIOutput
      - - javax.faces.component.UIInput
        - - javax.faces.component.UISelectMany
          - - org.richfaces.ui.select.AbstractSelectManyComponent
            - - org.richfaces.ui.select.AbstractOrderingComponent
              - - org.richfaces.ui.select.orderingList.AbstractOrderingList
                - - org.richfaces.ui.select.orderingList.UIOrderingList

- All Implemented Interfaces:
    EventListener, javax.faces.component.behavior.ClientBehaviorHolder, javax.faces.component.EditableValueHolder, javax.faces.component.PartialStateHolder, javax.faces.component.StateHolder, javax.faces.component.TransientStateHolder, javax.faces.component.ValueHolder, javax.faces.event.ComponentSystemEventListener, javax.faces.event.FacesListener, javax.faces.event.SystemEventListenerHolder, DisabledProps, EventsKeyProps, EventsMouseProps, MultiSelectProps, StyleClassProps, StyleProps, SelectItemsInterface

      @Generated(value={"RichFaces CDK","4.5.0-SNAPSHOT"})
      public class UIOrderingList
      extends AbstractOrderingList
      implements javax.faces.component.behavior.ClientBehaviorHolder, EventsKeyProps, EventsMouseProps, MultiSelectProps, SelectItemsInterface

  The <r:orderingList> is a component for ordering items in a list (client-side).

  Author:
    Brian Leathem

- - ### Nested Class Summary

    Nested Classes
    Modifier and Type | Class and Description
    --- | ---
    `protected static class` | `UIOrderingList.Properties`

  - ### Field Summary

    Fields
    Modifier and Type | Field and Description
    --- | ---
    `static String` | `COMPONENT_FAMILY`
    `static String` | `COMPONENT_TYPE`

    - ### Fields inherited from class javax.faces.component.UISelectMany

      `INVALID_MESSAGE_ID`

    - ### Fields inherited from class javax.faces.component.UIInput

      `CONVERSION_MESSAGE_ID, REQUIRED_MESSAGE_ID, UPDATE_MESSAGE_ID, VALIDATE_EMPTY_FIELDS_PARAM_NAME`

    - ### Fields inherited from class javax.faces.component.UIComponent

      `ATTRS_WITH_DECLARED_DEFAULT_VALUES, BEANINFO_KEY, bindings, COMPOSITE_COMPONENT_TYPE_KEY, COMPOSITE_FACET_NAME, CURRENT_COMPONENT, CURRENT_COMPOSITE_COMPONENT, FACETS_KEY, HONOR_CURRENT_COMPONENT_ATTRIBUTES_PARAM_NAME, VIEW_LOCATION_KEY`

  - ### Constructor Summary

    Constructors
    Constructor and Description
    `UIOrderingList()`

  - ### Method Summary

    Methods
    Modifier and Type | Method and Description
    --- | ---
    `String` | `getCaption()` The text placed above the list of items
    `String` | `getCollectionType()` Optional attribute that is a literal string that is the fully qualified class name of a concrete class that implements java.util.Collection, or an EL expression that evaluates to either 1.
    `String` | `getColumnClasses()` columnClasses specifies a comma-delimited list of CSS style classes to apply to each column.
    `String` | `getDefaultEventName()`
    `String` | `getDownBottomText()` The text to display in the move-to-bottom button
    `String` | `getDownText()` The text to display in the move-down button
    `Collection<String>` | `getEventNames()`
    `String` | `getFamily()`
    `Object` | `getItemLabel()` Label to be displayed to the user for the corresponding option.
    `Object` | `getItemValue()` Value to be returned to the server if the corresponding option is selected by the user.
    `String` | `getListHeight()` The height of the list element (in pixels)
    `String` | `getMaxListHeight()` The maximum height of the item list (in pixels).
    `String` | `getMinListHeight()` The minimum height of the item list (in pixels).
    `String` | `getOnblur()` Javascript code executed when this element loses focus.
    `String` | `getOnchange()` Javascript code executed when the list element loses focus and its value has been modified since gaining focus.
    `String` | `getOnclick()` Javascript code executed when a pointer button is clicked over this element.
    `String` | `getOndblclick()` Javascript code executed when a pointer button is double clicked over this element.
    `String` | `getOnfocus()` Javascript code executed when this element receives focus
    `String` | `getOnkeydown()` Javascript code executed when a key is pressed down over this element.
    `String` | `getOnkeypress()` Javascript code executed when a key is pressed and released over this element.
    `String` | `getOnkeyup()` Javascript code executed when a key is released over this element.
    `String` | `getOnmousedown()` Javascript code executed when a pointer button is pressed down over this element.
    `String` | `getOnmousemove()` Javascript code executed when a pointer button is moved within this element.
    `String` | `getOnmouseout()` Javascript code executed when a pointer button is moved away from this element.
    `String` | `getOnmouseover()` Javascript code executed when a pointer button is moved onto this element.
    `String` | `getOnmouseup()` Javascript code executed when a pointer button is released over this element.
    `String` | `getStyle()` CSS style(s) to be applied when this component is rendered.
    `String` | `getStyleClass()` Space-separated list of CSS style class(es) to be applied when this element is rendered.
    `String` | `getUpText()` The text to display in the move-up button
    `String` | `getUpTopText()` The text to display in the move-to-top button
    `String` | `getVar()` Expose the value from the value attribute under this request scoped key so that it may be referred to in EL for the value of other attributes.
    `boolean` | `isDisabled()` Flag indicating that this element must never receive focus or be included in a subsequent submit.
    `boolean` | `isShowButton()`
    `void` | `setCaption(String caption)`
    `void` | `setCollectionType(String collectionType)`
    `void` | `setColumnClasses(String columnClasses)`
    `void` | `setDisabled(boolean disabled)`
    `void` | `setDownBottomText(String downBottomText)`
    `void` | `setDownText(String downText)`
    `void` | `setItemLabel(Object itemLabel)`
    `void` | `setItemValue(Object itemValue)`
    `void` | `setListHeight(String listHeight)`
    `void` | `setMaxListHeight(String maxListHeight)`
    `void` | `setMinListHeight(String minListHeight)`
    `void` | `setOnblur(String onblur)`
    `void` | `setOnchange(String onchange)`
    `void` | `setOnclick(String onclick)`
    `void` | `setOndblclick(String ondblclick)`
    `void` | `setOnfocus(String onfocus)`
    `void` | `setOnkeydown(String onkeydown)`
    `void` | `setOnkeypress(String onkeypress)`
    `void` | `setOnkeyup(String onkeyup)`
    `void` | `setOnmousedown(String onmousedown)`
    `void` | `setOnmousemove(String onmousemove)`
    `void` | `setOnmouseout(String onmouseout)`
    `void` | `setOnmouseover(String onmouseover)`
    `void` | `setOnmouseup(String onmouseup)`
    `void` | `setShowButton(boolean showButton)`
    `void` | `setStyle(String style)`
    `void` | `setStyleClass(String styleClass)`
    `void` | `setUpText(String upText)`
    `void` | `setUpTopText(String upTopText)`
    `void` | `setVar(String var)`

    - ### Methods inherited from class org.richfaces.ui.select.orderingList.AbstractOrderingList

      `getItemValues`

    - ### Methods inherited from class org.richfaces.ui.select.AbstractOrderingComponent

      `compareValues, getOrderButtonsText`

    - ### Methods inherited from class org.richfaces.ui.select.AbstractSelectManyComponent

      `columns, validateValue`

    - ### Methods inherited from class javax.faces.component.UISelectMany

      `getSelectedValues, getValueBinding, getValueExpression, setSelectedValues, setValueBinding, setValueExpression`

    - ### Methods inherited from class javax.faces.component.UIInput

      `addValidator, addValueChangeListener, clearInitialState, decode, getConvertedValue, getConverterMessage, getRequiredMessage, getSubmittedValue, getValidator, getValidatorMessage, getValidators, getValue, getValueChangeListener, getValueChangeListeners, isEmpty, isImmediate, isLocalValueSet, isRequired, isValid, markInitialState, processDecodes, processUpdates, processValidators, removeValidator, removeValueChangeListener, resetValue, restoreState, saveState, setConverterMessage, setImmediate, setLocalValueSet, setRequired, setRequiredMessage, setSubmittedValue, setValid, setValidator, setValidatorMessage, setValue, setValueChangeListener, updateModel, validate`

    - ### Methods inherited from class javax.faces.component.UIOutput

      `getConverter, getLocalValue, setConverter`

    - ### Methods inherited from class javax.faces.component.UIComponentBase

      `addClientBehavior, addFacesListener, broadcast, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientBehaviors, getClientId, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getListenersForEventClass, getParent, getPassThroughAttributes, getRenderer, getRendererType, getRendersChildren, invokeOnComponent, isRendered, isTransient, processRestoreState, processSaveState, queueEvent, removeFacesListener, restoreAttachedState, saveAttachedState, setId, setParent, setRendered, setRendererType, setTransient, subscribeToEvent, unsubscribeFromEvent`

    - ### Methods inherited from class javax.faces.component.UIComponent

      `encodeAll, getClientId, getCompositeComponentParent, getContainerClientId, getCurrentComponent, getCurrentCompositeComponent, getNamingContainer, getPassThroughAttributes, getResourceBundleMap, getStateHelper, getStateHelper, getTransientStateHelper, getTransientStateHelper, initialStateMarked, isCompositeComponent, isInView, isVisitable, popComponentFromEL, processEvent, pushComponentToEL, restoreTransientState, saveTransientState, setInView, visitTree`

    - ### 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.behavior.ClientBehaviorHolder

      `addClientBehavior, getClientBehaviors`

    - ### Methods inherited from interface org.richfaces.ui.select.SelectItemsInterface

      `getItemValues`

    - ### Methods inherited from interface javax.faces.component.ValueHolder

      `getConverter, getLocalValue, setConverter`

- - ### Field Detail

    - #### COMPONENT_TYPE

          public static final String COMPONENT_TYPE

      See Also:
        Constant Field Values

    - #### COMPONENT_FAMILY

          public static final String COMPONENT_FAMILY

      See Also:
        Constant Field Values

  - ### Constructor Detail

    - #### UIOrderingList

          public UIOrderingList()

  - ### Method Detail

    - #### getFamily

          public String getFamily()

      Overrides:
        `getFamily` in class `javax.faces.component.UISelectMany`

    - #### getEventNames

          public Collection<String> getEventNames()

      Specified by:
        `getEventNames` in interface `javax.faces.component.behavior.ClientBehaviorHolder`
      Overrides:
        `getEventNames` in class `javax.faces.component.UIComponentBase`

    - #### getDefaultEventName

          public String getDefaultEventName()

      Specified by:
        `getDefaultEventName` in interface `javax.faces.component.behavior.ClientBehaviorHolder`
      Overrides:
        `getDefaultEventName` in class `javax.faces.component.UIComponentBase`

    - #### getCaption

          public String getCaption()

      Description copied from class: `AbstractOrderingComponent`
      The text placed above the list of items
      Specified by:
        `getCaption` in class `AbstractOrderingComponent`

    - #### setCaption

          public void setCaption(String caption)

    - #### getCollectionType

          public String getCollectionType()

      Description copied from interface: `MultiSelectProps`
      Optional attribute that is a literal string that is the fully qualified class name of a concrete class that implements java.util.Collection, or an EL expression that evaluates to either 1. such a String, or 2. the Class object itself.
      Specified by:
        `getCollectionType` in interface `MultiSelectProps`

    - #### setCollectionType

          public void setCollectionType(String collectionType)

    - #### getColumnClasses

          public String getColumnClasses()

      Description copied from interface: `MultiSelectProps`
      columnClasses specifies a comma-delimited list of CSS style classes to apply to each column. A space separated list of classes may be specified for an individual column. If the number of classes in this list is less than the number of column children, then no class will be applied to the columns greater than the number of classes. If however the final class in the list is the `*` character, the classes will instead be applied in a repeating manner every n-fold column, where n is the order the class in this list. If there are more class names than columns, the overflow ones are ignored.
      Specified by:
        `getColumnClasses` in interface `MultiSelectProps`

    - #### setColumnClasses

          public void setColumnClasses(String columnClasses)

    - #### isDisabled

          public boolean isDisabled()

      Description copied from interface: `DisabledProps`
      Flag indicating that this element must never receive focus or be included in a subsequent submit.
      Specified by:
        `isDisabled` in interface `DisabledProps`

    - #### setDisabled

          public void setDisabled(boolean disabled)

    - #### getDownBottomText

          public String getDownBottomText()

      Description copied from class: `AbstractOrderingComponent`
      The text to display in the move-to-bottom button
      Specified by:
        `getDownBottomText` in class `AbstractOrderingComponent`

    - #### setDownBottomText

          public void setDownBottomText(String downBottomText)

    - #### getDownText

          public String getDownText()

      Description copied from class: `AbstractOrderingComponent`
      The text to display in the move-down button
      Specified by:
        `getDownText` in class `AbstractOrderingComponent`

    - #### setDownText

          public void setDownText(String downText)

    - #### getItemLabel

          public Object getItemLabel()

      Description copied from class: `AbstractOrderingList`
      Label to be displayed to the user for the corresponding option.
      Specified by:
        `getItemLabel` in interface `SelectItemsInterface`
      Specified by:
        `getItemLabel` in class `AbstractOrderingList`

    - #### setItemLabel

          public void setItemLabel(Object itemLabel)

    - #### getItemValue

          public Object getItemValue()

      Description copied from class: `AbstractOrderingList`
      Value to be returned to the server if the corresponding option is selected by the user.
      Specified by:
        `getItemValue` in interface `SelectItemsInterface`
      Specified by:
        `getItemValue` in class `AbstractOrderingList`

    - #### setItemValue

          public void setItemValue(Object itemValue)

    - #### getListHeight

          public String getListHeight()

      Description copied from interface: `MultiSelectProps`
      The height of the list element (in pixels)
      Specified by:
        `getListHeight` in interface `MultiSelectProps`

    - #### setListHeight

          public void setListHeight(String listHeight)

    - #### getMaxListHeight

          public String getMaxListHeight()

      Description copied from interface: `MultiSelectProps`
      The maximum height of the item list (in pixels).
      Specified by:
        `getMaxListHeight` in interface `MultiSelectProps`

    - #### setMaxListHeight

          public void setMaxListHeight(String maxListHeight)

    - #### getMinListHeight

          public String getMinListHeight()

      Description copied from interface: `MultiSelectProps`
      The minimum height of the item list (in pixels).
      Specified by:
        `getMinListHeight` in interface `MultiSelectProps`

    - #### setMinListHeight

          public void setMinListHeight(String minListHeight)

    - #### getOnblur

          public String getOnblur()

      Description copied from interface: `MultiSelectProps`
      Javascript code executed when this element loses focus.
      Specified by:
        `getOnblur` in interface `MultiSelectProps`

    - #### setOnblur

          public void setOnblur(String onblur)

    - #### getOnchange

          public String getOnchange()

      Description copied from interface: `MultiSelectProps`
      Javascript code executed when the list element loses focus and its value has been modified since gaining focus.
      Specified by:
        `getOnchange` in interface `MultiSelectProps`

    - #### setOnchange

          public void setOnchange(String onchange)

    - #### getOnclick

          public String getOnclick()

      Description copied from interface: `EventsMouseProps`
      Javascript code executed when a pointer button is clicked over this element.
      Specified by:
        `getOnclick` in interface `EventsMouseProps`

    - #### setOnclick

          public void setOnclick(String onclick)

    - #### getOndblclick

          public String getOndblclick()

      Description copied from interface: `EventsMouseProps`
      Javascript code executed when a pointer button is double clicked over this element.
      Specified by:
        `getOndblclick` in interface `EventsMouseProps`

    - #### setOndblclick

          public void setOndblclick(String ondblclick)

    - #### getOnfocus

          public String getOnfocus()

      Description copied from interface: `MultiSelectProps`
      Javascript code executed when this element receives focus
      Specified by:
        `getOnfocus` in interface `MultiSelectProps`

    - #### setOnfocus

          public void setOnfocus(String onfocus)

    - #### getOnkeydown

          public String getOnkeydown()

      Description copied from interface: `EventsKeyProps`
      Javascript code executed when a key is pressed down over this element.
      Specified by:
        `getOnkeydown` in interface `EventsKeyProps`

    - #### setOnkeydown

          public void setOnkeydown(String onkeydown)

    - #### getOnkeypress

          public String getOnkeypress()

      Description copied from interface: `EventsKeyProps`
      Javascript code executed when a key is pressed and released over this element.
      Specified by:
        `getOnkeypress` in interface `EventsKeyProps`

    - #### setOnkeypress

          public void setOnkeypress(String onkeypress)

    - #### getOnkeyup

          public String getOnkeyup()

      Description copied from interface: `EventsKeyProps`
      Javascript code executed when a key is released over this element.
      Specified by:
        `getOnkeyup` in interface `EventsKeyProps`

    - #### setOnkeyup

          public void setOnkeyup(String onkeyup)

    - #### getOnmousedown

          public String getOnmousedown()

      Description copied from interface: `EventsMouseProps`
      Javascript code executed when a pointer button is pressed down over this element.
      Specified by:
        `getOnmousedown` in interface `EventsMouseProps`

    - #### setOnmousedown

          public void setOnmousedown(String onmousedown)

    - #### getOnmousemove

          public String getOnmousemove()

      Description copied from interface: `EventsMouseProps`
      Javascript code executed when a pointer button is moved within this element.
      Specified by:
        `getOnmousemove` in interface `EventsMouseProps`

    - #### setOnmousemove

          public void setOnmousemove(String onmousemove)

    - #### getOnmouseout

          public String getOnmouseout()

      Description copied from interface: `EventsMouseProps`
      Javascript code executed when a pointer button is moved away from this element.
      Specified by:
        `getOnmouseout` in interface `EventsMouseProps`

    - #### setOnmouseout

          public void setOnmouseout(String onmouseout)

    - #### getOnmouseover

          public String getOnmouseover()

      Description copied from interface: `EventsMouseProps`
      Javascript code executed when a pointer button is moved onto this element.
      Specified by:
        `getOnmouseover` in interface `EventsMouseProps`

    - #### setOnmouseover

          public void setOnmouseover(String onmouseover)

    - #### getOnmouseup

          public String getOnmouseup()

      Description copied from interface: `EventsMouseProps`
      Javascript code executed when a pointer button is released over this element.
      Specified by:
        `getOnmouseup` in interface `EventsMouseProps`

    - #### setOnmouseup

          public void setOnmouseup(String onmouseup)

    - #### isShowButton

          public boolean isShowButton()

      Specified by:
        `isShowButton` in class `AbstractOrderingComponent`

    - #### setShowButton

          public void setShowButton(boolean showButton)

    - #### getStyle

          public String getStyle()

      Description copied from interface: `StyleProps`
      CSS style(s) to be applied when this component is rendered.
      Specified by:
        `getStyle` in interface `StyleProps`

    - #### setStyle

          public void setStyle(String style)

    - #### getStyleClass

          public String getStyleClass()

      Description copied from interface: `StyleClassProps`
      Space-separated list of CSS style class(es) to be applied when this element is rendered. This value must be passed through as the "class" attribute on generated markup.
      Specified by:
        `getStyleClass` in interface `StyleClassProps`

    - #### setStyleClass

          public void setStyleClass(String styleClass)

    - #### getUpText

          public String getUpText()

      Description copied from class: `AbstractOrderingComponent`
      The text to display in the move-up button
      Specified by:
        `getUpText` in class `AbstractOrderingComponent`

    - #### setUpText

          public void setUpText(String upText)

    - #### getUpTopText

          public String getUpTopText()

      Description copied from class: `AbstractOrderingComponent`
      The text to display in the move-to-top button
      Specified by:
        `getUpTopText` in class `AbstractOrderingComponent`

    - #### setUpTopText

          public void setUpTopText(String upTopText)

    - #### getVar

          public String getVar()

      Description copied from interface: `MultiSelectProps`
      Expose the value from the value attribute under this request scoped key so that it may be referred to in EL for the value of other attributes.
      Specified by:
        `getVar` in interface `MultiSelectProps`
      Specified by:
        `getVar` in interface `SelectItemsInterface`

    - #### setVar

          public void setVar(String var)

Copyright © 2014 JBoss by Red Hat. All rights reserved.