Class: OrderingList

RichFaces.ui. OrderingList

new OrderingList(id, options)

Backing object for rich:orderingList
Parameters:
Name Type Description
id
options
Source:

Extends

Members

name :string

Component name.
Type:
  • string
Inherited From:
Source:

Methods

attachToDom(source) → {DOMElement}

Attach component object to DOM element by component id, DOM element or jQuery object and returns the element Its required for the client side API calls and to clean up after ajax request or document unload by calling destroy method
Parameters:
Name Type Description
source string | DOMElement | jQuery component id, DOM element or DOM elements wrapped by jQuery
Inherited From:
Source:
Returns:
Type
DOMElement

destroy()

Destroy method. Will be called before remove component from the page
Inherited From:
Source:

detach(source)

Detach component object from DOM element by component id, DOM element or jQuery object
Parameters:
Name Type Description
source string | DOMElement | jQuery component id, DOM element or DOM elements wrapped by jQuery
Inherited From:
Source:

down()

Move the selected elements one step down
Source:

downBottom()

Move the selected elements to the bottom of the list
Source:

focus()

Focus the list
Source:

getEventElement() → {string}

Method returns element's id for event handlers binding. Event API calls this method when binding by component object as selector was used.
Inherited From:
Source:
Returns:
Type
string

getList() → {ListMulti}

Get the backing object of the list
Source:
Returns:
list
Type
ListMulti

invokeEvent(eventType, element, event, data) → {boolean}

Invokes event on on the DOM element
Parameters:
Name Type Description
eventType string event type, e.g. "click"
element DOMElement DOM element object
event Event jQuery Event
data Object additional data used for event handler
Inherited From:
Source:
Returns:
true if an event is successfully invoked
Type
boolean

toggleButtons()

Update the state of the buttons based on the current state
Source:

toString() → {string}

Method for converting object to string
Inherited From:
Source:
Returns:
Type
string

up()

Move the selected elements one step up
Source:

upTop()

Move the selected elements to the top of the list
Source: