m-select-d-box.md

MSelectDBox

Kind: global class
Author: Eugene Gantz (EG) EugenGantz@gmail.com

• MSelectDBox
  • new MSelectDBox(arg)
  • instance
    • ._coldInit
    • .get(key, [arg], [e]) ⇒ *
    • .set(key, [value], [arg], [e]) ⇒ MSelectDBox
    • .trigger(eventName, e)
    • .on(eventName, fx) ⇒ MSelectDBox
    • .detectLanguage() ⇒ String
    • .getText(key, [lang]) ⇒ String
    • .setText(key, lang, text) ⇒ MSelectDBox
    • ._applyLang(lang)
    • .calcPosition()
    • .calcScrollBarPosition()
    • .getHoveredItems() ⇒ Array
    • .getSelectedKeys() ⇒ Array
    • .getSelectedValues() ⇒ Array
    • .getSelectedLabels() ⇒ Array
    • .getSelectedItems() ⇒ Array
    • .hasValue(value) ⇒ Boolean
    • .hasLabel(label) ⇒ Boolean
    • .applySelectedToList([list]) ⇒ MSelectDBox
    • .applySelectedToInput() ⇒ MSelectDBox
    • .select(arg)
    • ._selectByValue(value, reset)
    • ._selectByLabel(label, reset)
    • .deselect(arg)
    • ._deselect(arg)
    • ._deselectByValue(argVal)
    • ._deselectByLabel(argLab)
    • ._getItemsByID(ids) ⇒ Object
    • .hideItem(item) ⇒ MSelectDBox
    • .unhideItem(item) ⇒ MSelectDBox
    • .unhideAllItems()
    • .isVisibleItem(item) ⇒ Boolean
    • .hoverItem(item) ⇒ MSelectDBox
    • .unhoverItem(item) ⇒ MSelectDBox
    • .unhoverAllItems() ⇒ MSelectDBox
    • .hoverNextVisibleItem(item) ⇒ MSelectDBox
    • .hoverPrevVisibleItem(item) ⇒ MSelectDBox
    • .getNextVisibleItem() ⇒ Object | Object | undefined
    • .getPrevVisibleItem(item) ⇒ Object | undefined
    • .selectNextVisibleItem(item) ⇒ Object
    • .selectPrevVisibleItem(item) ⇒ Object
    • .getLastVisibleItem() ⇒ Object
    • .getFirstVisibleItem() ⇒ Object
    • ._selectByID(ids, reset)
    • ._deselectByID(ids)
    • .applyAutoComplete(value) ⇒
    • .deselectAll() ⇒ MSelectDBox
    • .selectAll() ⇒ MSelectDBox
    • .isActive() ⇒ Boolean
    • .close() ⇒
    • .open() ⇒ MSelectDBox
  • static
    • ._globalElems
    • ._globalStyles
    • .defaultOptionFilters
    • .getInstances() ⇒ Array
    • .removeInstances(arg)

new MSelectDBox(arg)

Param	Type	Description
arg	Object
[arg.name]	String	instance name
arg.list	Array	list options
[arg.autoComplete]	Boolean
[arg.multiple]	Boolean
[arg.zIndex]	Number
arg.width	String | Number
[arg.optionFilters]	Array
arg.freeWrite	Boolean

mSelectDBox._coldInit

Индикатор холодной загрузки. После первой загрузки класса становится true

Kind: instance property of MSelectDBox

mSelectDBox.get(key, [arg], [e]) ⇒ *

Get instance property

Kind: instance method of MSelectDBox

Param	Type	Description
key	String	key
[arg]	Object	optional arguments (deprecated),
[e]	Boolean	event trigger on

mSelectDBox.set(key, [value], [arg], [e]) ⇒ MSelectDBox

Set instance property

Kind: instance method of MSelectDBox

Param	Type	Description
key	String | Object	key or hash of key-value
[value]	*
[arg]	Object	optional arguments (deprecated),
[e]	Boolean	event trigger on

mSelectDBox.trigger(eventName, e)

Fire specified event

Kind: instance method of MSelectDBox

Param	Type	Description
eventName	String	event name
e	Event | Object	event or data object

mSelectDBox.on(eventName, fx) ⇒ MSelectDBox

Attach specified event listener

Kind: instance method of MSelectDBox

Param	Type	Description
eventName	String	event name
fx	function	event handler

mSelectDBox.detectLanguage() ⇒ String

Detect user language

Kind: instance method of MSelectDBox

mSelectDBox.getText(key, [lang]) ⇒ String

Returns text by specified key and language

Kind: instance method of MSelectDBox

Param	Type	Description
key	String
[lang]	String	язык выбираемого текста

mSelectDBox.setText(key, lang, text) ⇒ MSelectDBox

Set text to specified language

Kind: instance method of MSelectDBox

Param	Type	Description
key	String
lang	String	language
text	String	text key

mSelectDBox._applyLang(lang)

Применяет языковые настройки к глобальным (общим) элементам имеющие подписи

Kind: instance method of MSelectDBox

Param	Type	Description
lang	String	устанавливаемый язык

mSelectDBox.calcPosition()

Calculate position of list container

Kind: instance method of MSelectDBox

mSelectDBox.calcScrollBarPosition()

Calc and apply scrollbar position of list container

Kind: instance method of MSelectDBox

mSelectDBox.getHoveredItems() ⇒ Array

Returns hovered options (Array of objects)

Kind: instance method of MSelectDBox

mSelectDBox.getSelectedKeys() ⇒ Array

Return keys of selected options

Kind: instance method of MSelectDBox

mSelectDBox.getSelectedValues() ⇒ Array

Return values of selected options

Kind: instance method of MSelectDBox

mSelectDBox.getSelectedLabels() ⇒ Array

Return labels of selected options

Kind: instance method of MSelectDBox

mSelectDBox.getSelectedItems() ⇒ Array

Returns selected list options (Array of object)

Kind: instance method of MSelectDBox

mSelectDBox.hasValue(value) ⇒ Boolean

Check existence of value in list

Kind: instance method of MSelectDBox

Param	Type
value	String

mSelectDBox.hasLabel(label) ⇒ Boolean

Check existence of label in list

Kind: instance method of MSelectDBox

Param	Type
label	String

mSelectDBox.applySelectedToList([list]) ⇒ MSelectDBox

Apply selected options to list container

Kind: instance method of MSelectDBox

Param	Type	Description
[list]	Array	in purpose of optimisation (performance) you can use specific list options. By default method uses all list options

mSelectDBox.applySelectedToInput() ⇒ MSelectDBox

Apply selected options to control

Kind: instance method of MSelectDBox

mSelectDBox.select(arg)

Select specified option in list

Kind: instance method of MSelectDBox

Param	Type	Description
arg	Object
arg.value	String | Array	select by value
arg.label	String | Array	select by label
arg.id	Number	select by id
arg.blank	Boolean	reset previous selected options

mSelectDBox._selectByValue(value, reset)

Выбрать по значению в списке

Kind: instance method of MSelectDBox

Param	Type	Description
value	Array
reset	Boolean	обнуть ранее выбранные строки

mSelectDBox._selectByLabel(label, reset)

Выбрать по названию строки

Kind: instance method of MSelectDBox
Access: protected

Param	Type	Description
label	Array
reset	Boolean	обнуть ранее выбранные строки

mSelectDBox.deselect(arg)

Снять выделение с указанного элемента

Kind: instance method of MSelectDBox

Param	Type	Description
arg	Object
arg.value	String | Array	deselect by value
arg.label	String | Array	deselect by label
arg.id	Number | String | Array	deselect by id

mSelectDBox._deselect(arg)

Снять выделение

Kind: instance method of MSelectDBox
Access: protected

Param	Type
arg	Object
arg.value	Array | String
arg.label	Array | String
arg.id	Array | String | Number

mSelectDBox._deselectByValue(argVal)

Снять выделение по значению

Kind: instance method of MSelectDBox
Access: protected

Param	Type
argVal	Array | String

mSelectDBox._deselectByLabel(argLab)

Снять выделение по label строки списка

Kind: instance method of MSelectDBox
Access: protected

Param	Type	Description
argLab	Array | String	заголовки строк списка

mSelectDBox._getItemsByID(ids) ⇒ Object

Получить элементы списка по ключам (id)

Kind: instance method of MSelectDBox
Access: protected

Param	Type	Description
ids	Array	ключи списка

mSelectDBox.hideItem(item) ⇒ MSelectDBox

Hide specific list option

Kind: instance method of MSelectDBox

Param	Type	Description
item	Object	list option

mSelectDBox.unhideItem(item) ⇒ MSelectDBox

Make visible specific list option

Kind: instance method of MSelectDBox

Param	Type	Description
item	Object	list option

mSelectDBox.unhideAllItems()

Make visible all list options

Kind: instance method of MSelectDBox

mSelectDBox.isVisibleItem(item) ⇒ Boolean

Check visibility of list option

Kind: instance method of MSelectDBox

Param	Type	Description
item	Object	строка в списке

mSelectDBox.hoverItem(item) ⇒ MSelectDBox

Apply hover to specified option in list

Kind: instance method of MSelectDBox

Param	Type	Description
item	Object	list option

mSelectDBox.unhoverItem(item) ⇒ MSelectDBox

Take off hover to specified option in list

Kind: instance method of MSelectDBox

Param	Type	Description
item	Object	list option

mSelectDBox.unhoverAllItems() ⇒ MSelectDBox

Take off hover to all options in list

Kind: instance method of MSelectDBox

mSelectDBox.hoverNextVisibleItem(item) ⇒ MSelectDBox

Hover next option in list

Kind: instance method of MSelectDBox

Param	Type	Description
item	Object	current (relative) list option

mSelectDBox.hoverPrevVisibleItem(item) ⇒ MSelectDBox

Hover previous option in list

Kind: instance method of MSelectDBox

Param	Type	Description
item	Object	current (relative) list option

mSelectDBox.getNextVisibleItem() ⇒ Object | Object | undefined

Get next visible option in list

Kind: instance method of MSelectDBox
Returns: Object - item - current (relative) list optionObject | undefined

mSelectDBox.getPrevVisibleItem(item) ⇒ Object | undefined

Get previous visible option in list

Kind: instance method of MSelectDBox

Param	Type	Description
item	Object	current (relative) list option

mSelectDBox.selectNextVisibleItem(item) ⇒ Object

Select next visible option in list

Kind: instance method of MSelectDBox

Param	Type	Description
item	Object	current (relative) list option

mSelectDBox.selectPrevVisibleItem(item) ⇒ Object

Select previous visible option in list

Kind: instance method of MSelectDBox

Param	Type	Description
item	Object	current (relative) list option

mSelectDBox.getLastVisibleItem() ⇒ Object

Get last visible option in list

Kind: instance method of MSelectDBox

mSelectDBox.getFirstVisibleItem() ⇒ Object

Get first visible option in list

Kind: instance method of MSelectDBox

mSelectDBox._selectByID(ids, reset)

Выделяет пункт из списка по ключу. Каждый раз определяет новую выборку.

Kind: instance method of MSelectDBox
Access: protected

Param	Type	Description
ids	Array | Number | String	ключи строк списка
reset	Boolean	сбросить уже выбранные строки

mSelectDBox._deselectByID(ids)

Сниманиет выделение только с указанной выборки, не затрагивая остальные

Kind: instance method of MSelectDBox
Access: protected

Param	Type	Description
ids	Array | Number | String	ключи списка

mSelectDBox.applyAutoComplete(value) ⇒

Apply autocomplete to list

Kind: instance method of MSelectDBox
Returns: MSelectDBox

Param	Type
value	String

mSelectDBox.deselectAll() ⇒ MSelectDBox

Deselect all options in list

Kind: instance method of MSelectDBox

mSelectDBox.selectAll() ⇒ MSelectDBox

Select all options in list

Kind: instance method of MSelectDBox

mSelectDBox.isActive() ⇒ Boolean

Check visible state of list

Kind: instance method of MSelectDBox

mSelectDBox.close() ⇒

Hide list

Kind: instance method of MSelectDBox
Returns: MSelectDBox

mSelectDBox.open() ⇒ MSelectDBox

show list

Kind: instance method of MSelectDBox

MSelectDBox._globalElems

Global elements

Kind: static property of MSelectDBox

MSelectDBox._globalStyles

Global styles by selectors

Kind: static property of MSelectDBox

MSelectDBox.defaultOptionFilters

default autoComplete filters

Kind: static property of MSelectDBox

MSelectDBox.getInstances() ⇒ Array

Return instance of class

Kind: static method of MSelectDBox

MSelectDBox.removeInstances(arg)

Remove instances

Kind: static method of MSelectDBox

Param	Type	Description
arg	Object	arguments
arg.name	String	Instance name // msdb.get("name")