# Class: PickList

## RichFaces.ui. PickList

#### new PickList(id, options)

Backing object for rich:pickList

##### Parameters:

Name | Type | Description
--- | --- | ---
`id` |  |
`options` |  |

Source:
  - pickList.js, line 15

### Extends

- RichFaces.BaseComponent

### Members

#### name :string

Component name.

##### Type:

- string

Inherited From:
  - RichFaces.BaseComponent#name
Source:
  - richfaces-base-component.js, line 195

### Methods

#### add()

Move selected items from source list to target list

Source:
  - pickList.js, line 214

#### addAll()

Move all items from source list to target list

Source:
  - pickList.js, line 244

#### 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:
  - RichFaces.BaseComponent#attachToDom
Source:
  - richfaces-base-component.js, line 237

##### Returns:

Type
  DOMElement

#### destroy()

Destroy method. Will be called before remove component from the page

Inherited From:
  - RichFaces.BaseComponent#destroy
Source:
  - richfaces-base-component.js, line 313

#### 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:
  - RichFaces.BaseComponent#detach
Source:
  - richfaces-base-component.js, line 258

#### focus()

Focus the source list

Source:
  - pickList.js, line 300

#### 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:
  - RichFaces.BaseComponent#getEventElement
Source:
  - richfaces-base-component.js, line 224

##### Returns:

Type
  string

#### getSourceList() → {ListMulti}

Get the backing object of the source list

Source:
  - pickList.js, line 162

##### Returns:

source list

Type
  ListMulti

#### getTargetList() → {ListMulti}

Get the backing object of the target list

Source:
  - pickList.js, line 173

##### 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:
  - RichFaces.BaseComponent#invokeEvent
Source:
  - richfaces-base-component.js, line 272

##### Returns:

true if an event is successfully invoked

Type
  boolean

#### remove()

Move selected items from target list to source list

Source:
  - pickList.js, line 227

#### removeAll()

Move all items from target list to source list

Source:
  - pickList.js, line 258

#### toggleButtons()

Update the state of the buttons based on the current state

Source:
  - pickList.js, line 284

#### toString() → {string}

Method for converting object to string

Inherited From:
  - RichFaces.BaseComponent#toString
Source:
  - richfaces-base-component.js, line 203

##### Returns:

Type
  string