new PickList(id, options)
Backing object for rich:pickList
Parameters:
| Name | Type | Description |
|---|---|---|
id |
||
options |
- Source:
Extends
Members
name :string
Component name.
Type:
- string
- Inherited From:
- Source:
Methods
add()
Move selected items from source list to target list
- Source:
addAll()
Move all items from source list to target list
- Source:
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:
focus()
Focus the source 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
getSourceList() → {ListMulti}
Get the backing object of the source list
- Source:
Returns:
source list
- Type
- ListMulti
getTargetList() → {ListMulti}
Get the backing object of the target list
- Source:
Returns:
target 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
remove()
Move selected items from target list to source list
- Source:
removeAll()
Move all items from target list to source list
- Source:
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