undefined: PickList

API Docs for: undefined
Show:

PickList Class

Extends Widget
Defined in: js/picklist.js:11

Methods

_clearOptions

() protected

Defined in js/picklist.js:697

Method to clear the right-hand side "selections" OPTIONS completely.

Returns:

true

_createALinkButton

(
  • subname,
  • content,
)
HTML protected

Defined in js/picklist.js:873

Creates an HTML link object that will be inserted into the template. The "subname" is a sub-class name to be appended to the class to identify it. Uses the internal "TMPL_alink" property as a template for the HTML.

Parameters:

Returns:

HTML: code for element

_createCssButton

(
  • subname,
  • lcontent,
  • rcontent,
)
HTML protected

Defined in js/picklist.js:824

Creates an HTML object that can be used with the "cssbutton" module of 3.5.0. Uses the internal "TMPL_cssbtn" property as a template for the HTML.

The cssButton design uses a to specify the location of the IMG, on either the right or left side of the button contents (i.e. "Click Me").

So this method defines either lcontent or rcontent to specify which side of the "content" the IMG is defined on.

Parameters:

  • subname, String

    The sub-class name to be added to the button class

  • lcontent, String

    The sub-class name to add to the left-hand side IMG span class

  • rcontent, String

    The sub-class name to add to the right-hand side IMG span class

Returns:

HTML: code for element

_createHtmlButton

(
  • subname,
  • content,
)
HTML protected

Defined in js/picklist.js:854

Creates an HTML object that will be inserted into the template. The "subname" is a sub-class name to be appended to the class to identify it. Uses the internal "TMPL_button" property as a template for the HTML.

Parameters:

  • subname, String

    The sub-class name to be appended to the "class" for this button

  • content, String

    The contents of the button face (i.e. "Click Me")

Returns:

HTML: code for element

_createYButtonNode

(
  • bnode,
)
Y.Button protected

Defined in js/picklist.js:808

Creates a Y.Button object by using the input "bnode" as the srcNode of the Button.

Parameters:

  • bnode, String | | Node

    The Node of the HTML to use to create Y.Button

Returns:

Y.Button: object

_getSelectedOptions

(
  • sel_node,
)
Array protected

Defined in js/picklist.js:892

Returns all of the HTML OPTIONS, as an array of objects containing an index, optionObject format. This is really intended to return the right-hand side "selections" Options element, irregardless of whether an Option is "selected" / highlighted or not.

Parameters:

  • sel_node, String

    The SELECT object to get all options of (whether "selected" flag is set or not)

Returns:

Array: of Object containing the right-option elements as {index, optionObj} format

_loadOptions

() Number protected

Defined in js/picklist.js:646

Method to load the left-hand side "options" HTML element with the user-defined options array.

Returns:

Number: options.length

_loadSelections

() Number protected

Defined in js/picklist.js:712

Method to load the right-hand side "selections" HTML element with the user-defined selections array.

Returns:

Number: selections.length

_onButtonAll

(
  • e,
)
protected

Defined in js/picklist.js:938

The "Add All" button click handler. Adds all of the "Available" options to the "selected" Options, checking to avoid duplicates. This method checks if the Widget is a "stack", if so, it moves the Option from left to right.

Parameters:

  • e, EventHandle

    The button's Eventhandle from the button .on "click" event

Returns:

nothing

_onButtonAllBack

(
  • e,
)
protected

Defined in js/picklist.js:1031

The "Remove All" button click handler. Removes all of the option(s) from the "Selections" right-side options. This method checks if the Widget is a "stack", if so, it moves the Option from right to left, otherwise it destroys it.

Parameters:

  • e, EventHandle

    The button's Eventhandle from the button .on "click" event

Returns:

nothing

_onButtonBack

(
  • e,
)
protected

Defined in js/picklist.js:1001

The "Remove One" button click handler. Removes the DOM selected option(s) from the "Selections" right-side options. This method checks if the Widget is a "stack", if so, it moves the Option from right to left, otherwise it destroys it.

Parameters:

  • e, EventHandle

    The button's Eventhandle from the button .on "click" event

Returns:

nothing

_onButtonOne

(
  • e,
)
protected

Defined in js/picklist.js:968

The "Add One" button click handler. Adds the DOM selected option(s) from the "Available" options to the right-hand side HTML , checking to avoid duplicates. This method checks if the Widget is a "stack", if so, it moves the Option from left to right.

Parameters:

  • e, EventHandle

    The button's Eventhandle from the button .on "click" event

Returns:

nothing

_optStdFormat

() Object protected

Defined in js/picklist.js:751

Internal method to normalize the 'text', 'value', and 'title' data based upon the input "optionsMap" of the "options" attribute. Returns an object that can be used directly by the JS new Option( text, value ) command.

Returns:

Object: An object that contains { value, text, title } for defining the JS Option

_renderInput

() protected

Defined in js/picklist.js:545

Method to create the DOM elements for this Widget, including two HTML elements, and four BUTTONS to operate on the Widget.

The method uses the "template" attribute if set for positioning of the above UI elements, if none is provided a default template is used.

Returns:

true

_returnOptionPerOrder

() protected

Defined in js/picklist.js:783

Internal method intended to return the provided opt_node object back to the "options" SELECT OPTION in the original defined order. This would only be used for "stackMode" and "preserveOrder" true.

Returns:

_selOptionExists

(
  • opt_node,
)
protected

Defined in js/picklist.js:912

Utility function to avoid duplicate adding an option to the right-hand side "selections" Options element. This method checks if the "opt_node" already exists in the "selections" Options, if so it returns TRUE, if not it returns FALSE.

Parameters:

  • opt_node, Node

    The Option node to check for existence.

Returns:

true or false, If the opt_node already exists in the Options array

bindUI

() public

Defined in js/picklist.js:458

Method that binds the button pushes to their handlers. Keep a reference to the handler in this._eventHandles so we can detach them later.

clearOptions

() public

Defined in js/picklist.js:498

Method to clear the left-hand side "options" SELECT OPTIONS completely.

Returns:

true

clearSelections

() public

Defined in js/picklist.js:510

Method to clear the right-hand side "selections" SELECT OPTIONS completely.

Returns:

true

getSelections

() Array public

Defined in js/picklist.js:521

Returns the current items in the "right side" SELECT OPTIONS box.

Returns:

Array: An array of options Objects, members are { value, text, title };

Properties

_eventHandles

Array private

Defined in js/picklist.js:372

Holder for the "action" click event handlers

_optionNode

Object private

Defined in js/picklist.js:356

Holder for the Y.Node of the SELECT left-hand side "available" options.

_optOrder

Array private

Defined in js/picklist.js:387

Holder for the original OPTIONS order, to be used with "preserveOrder" (NOT IMPLEMENTED)

_selectNode

Object private

Defined in js/picklist.js:364

Holder for the Y.Node of the SELECT right-hand side "selected" or chosen options

_ybuttons

Array private

Defined in js/picklist.js:380

Holder for the Y.Button Widget instances (if "buttonType" === "ybutton" )

CLASS_ACTION

Object private

Defined in js/picklist.js:349

TMPL_button

String protected

Defined in js/picklist.js:321

The template to use for constructing the HTML elements within the widget (for buttonType='htmlbutton' or 'ybutton')

TMPL_control

String protected

Defined in js/picklist.js:303

The default "template" to use for rendering of this widget.

TMPL_cssbtn

String protected

Defined in js/picklist.js:330

The template to use for constructing the HTML elements within the widget (for buttonType='cssbutton')

TMPL_inputs

String protected

Defined in js/picklist.js:313

The template to use for constructing the HTML elements for left/right side

Attributes

actionLabelAll

String

Defined in js/picklist.js:247

The label to be used for the BUTTON face for "Add All" action.

Default: 'Add All'

actionLabelOne

String

Defined in js/picklist.js:259

The label to be used for the BUTTON face for "Add One" action.

Default: 'Add'

actionLabelRmv

String

Defined in js/picklist.js:271

The label to be used for the BUTTON face for "Remove" action.

Default: 'Remove'

actionLabelRmvAll

String

Defined in js/picklist.js:283

The label to be used for the BUTTON face for "Remove All" action.

Default: 'Remove All'

buttonType

String

Defined in js/picklist.js:141

Attribute allows specifying the "button" type to be used during construction of the Widget template. Currently supported are HTML , a Y.Button object, a Y.Button CSSButton, and a simple HTML link.

Recognized settings are 'htmlbutton', 'ybutton', 'cssbutton', 'link'

Default: 'htmlbutton'

optClassName

String

Defined in js/picklist.js:90

Classname to be applied to the "options" element, usually used to specify the "width" of the element.

Default: ''

options

Array

Defined in js/picklist.js:23

The Array to populate the SELECT / OPTIONS on the left-side, herein referred to as "options" in this widget.

Elements of this array aren't required to have members { text:'', value:''}, if the members are different they can be mapped to the expected settings using the "optionsMap" attribute.

If the members of this array are non-object single-items, they are assumed to be the "text" item, and the "value" will also be set to this item.

Default: []

optionsMap

Object

Defined in js/picklist.js:66

An object having members "value, text, title" that defines the mapping between the provided "options" array data and the expected parameters of the JavaScript new Option('text', 'value').

Default: { value:'value', text:'text', title:'title' }

preserveOrder

Boolean

Defined in js/picklist.js:225

NOT IMPLEMENTED AT THIS TIME

     A flag setting for preserving the original order of the options, when add or 
     remove actions are taken.   With "preserveOrder" false, all items are added to the 
     bottom of the left / right side HTML SELECT / OPTIONS.  If set to TRUE, the 
     options are returned to proper order from the original "options" setting.

     This only has relevance when "stackMode" is TRUE.

Default: false

selClassName

String

Defined in js/picklist.js:104

Classname to be applied to the "selected" element, usually used to specify the "width" of the element.

Default: ''

selected

Array

Defined in js/picklist.js:44

The Array to populate the SELECT / OPTIONS on the right-side, herein referred to as "selected" in this widget. For example, if a FORM is opened with default multi-selected items, they would be provided in this attribute as an array.

Elements of this array aren't required to have members { text:'', value:''}, if the members are different they can be mapped to the expected settings using the "optionsMap" attribute.

If the members of this array are non-object single-items, they are assumed to be the "text" item, and the "value" will also be set to this item.

Default: []

selectSize

String

Defined in js/picklist.js:191

The default "width" style of the left and right side SELECT / OPTIONS control.

Default: '9em'

selectSize

Int

Defined in js/picklist.js:178

The number of options to display in the left and right side SELECT / OPTIONS control.

Default: 10

srcNode

String

Defined in js/picklist.js:165

The source "ID" of the container for this widget, REQUIRED.

Default: null

stackMode

Boolean

Defined in js/picklist.js:204

A flag setting for enabling "stack" mode of this widget. In "stack" mode the JS Options are moved from left-to-right individually, so that they can't be re-used inadvertantly.

For example, "Add One" from the left option MOVES the option to the right-side "selections". If "Remove One" is chosen, the right-side selected item is returned to the bottom of the left-hand side options. (Can't currently return it to the index of where it came from ... see "preserveOrder").

Default: false

template

String

Defined in js/picklist.js:118

The DOM ID element of the "template" to be used for defining the OPTIONS, SELECTIONS, and the BUTTONS.

Expected replacable placeholder tokens positioned within the "template" are identified as;

{OPTIONS_CONTAINER}     :  Left-hand side "Options" <select> placeholder
{SELECTIONS_CONTAINER}  :  Right-hand side "Selected" <select> placeholder
{ACTION_ALL}            :  Placeholder for the "Add All" button
         {ACTION_ONE}            :  Placeholder for the "Add One" button
{ACTION_BACK}           :  Placeholder for the "Remove One" button
{ACTION_ALLBACK}        :  Placeholder for the "Remove All" button

Default: ''