control.ListBoxItem

Расширяет ICustomizable, ISelectableControl.

Элемент раскрывающегося списка.

Конструктор | Поля | События | Методы

Конструктор

control.ListBoxItem([params[, options]])

Параметры:

Параметр Значение по умолчанию Описание
params —

Тип: Object|String

Параметры элемента либо строка - контент элемента.
params.data —

Тип: Object

Данные элемента.
params.data.content —

Тип: String

Содержимое элемента.
options —

Тип: Object

Опции элемента управления.
options.checkbox false

Тип: Boolean

Опция, которая определяет внешний вид стандартного макета.
  • true - слева от содержимого элемента отображается чекбокс;
  • false - элемент выделяется галочкой справа от содержимого.
options.layout —

Тип: Function|String

Макет элемента управления. В конструктор макета передается объект, содержащий поля:
  • control - ссылка на элемент управления;
  • options - менеджер опций элемента управления control.ListBoxItem.options;
  • data - менеджер данных элемента управления control.ListBoxItem.data;
  • state - менеджер состояния элемента управления control.ListBoxItem.state.
Макет меняет свой внешний вид на основе данных, состояния и опций элемента управления. Элемент управления, в свою очередь, реагирует на интерфейсные события макета и меняет значения полей control.ListBoxItem.state в зависимости от полученных команд. (Тип: конструктор объекта с интерфейсом ISelectableControlLayout или ключ макета).
options.selectOnClick false

Тип: Boolean

Флаг, разрешающий автоматическое выделение элемента списка по клику.
  • true - элемент списка выделяется после клика;
  • false - элемент списка не меняет свой внешний вид после клика.
options.visible true

Тип: Boolean

Признак того, что элемент управления отображается.
Параметр Значение по умолчанию Описание
params —

Тип: Object|String

Параметры элемента либо строка - контент элемента.
params.data —

Тип: Object

Данные элемента.
params.data.content —

Тип: String

Содержимое элемента.
options —

Тип: Object

Опции элемента управления.
options.checkbox false

Тип: Boolean

Опция, которая определяет внешний вид стандартного макета.
  • true - слева от содержимого элемента отображается чекбокс;
  • false - элемент выделяется галочкой справа от содержимого.
options.layout —

Тип: Function|String

Макет элемента управления. В конструктор макета передается объект, содержащий поля:
  • control - ссылка на элемент управления;
  • options - менеджер опций элемента управления control.ListBoxItem.options;
  • data - менеджер данных элемента управления control.ListBoxItem.data;
  • state - менеджер состояния элемента управления control.ListBoxItem.state.
Макет меняет свой внешний вид на основе данных, состояния и опций элемента управления. Элемент управления, в свою очередь, реагирует на интерфейсные события макета и меняет значения полей control.ListBoxItem.state в зависимости от полученных команд. (Тип: конструктор объекта с интерфейсом ISelectableControlLayout или ключ макета).
options.selectOnClick false

Тип: Boolean

Флаг, разрешающий автоматическое выделение элемента списка по клику.
  • true - элемент списка выделяется после клика;
  • false - элемент списка не меняет свой внешний вид после клика.
options.visible true

Тип: Boolean

Признак того, что элемент управления отображается.

Поля

Имя Тип Описание
data data.Manager
Данные элемента списка. Имена полей, доступных через метод data.Manager.get:
  • content - cодержимое элемента списка в виде HTML.
events IEventManager

Менеджер событий.

Унаследовано от IEventEmitter.
options IOptionManager

Менеджер опций.

Унаследовано от ICustomizable.
state data.Manager
Состояние элемента списка. Имена полей, доступных через метод data.Manager.get:
  • selected - признак, выбран ли элемент списка;
  • enabled - признак, активен ли элемент списка.
Имя Тип Описание
data data.Manager
Данные элемента списка. Имена полей, доступных через метод data.Manager.get:
  • content - cодержимое элемента списка в виде HTML.
events IEventManager

Менеджер событий.

Унаследовано от IEventEmitter.
options IOptionManager

Менеджер опций.

Унаследовано от ICustomizable.
state data.Manager
Состояние элемента списка. Имена полей, доступных через метод data.Manager.get:
  • selected - признак, выбран ли элемент списка;
  • enabled - признак, активен ли элемент списка.

События

Имя Описание
click

Выбор элемента списка.
deselect

Элемент управления не выбран.

Унаследовано от ISelectableControl.
disable

Элемент управления стал недоступным.

Унаследовано от ISelectableControl.
enable

Элемент управления стал доступным.

Унаследовано от ISelectableControl.
mapchange
Сменилась карта. Поля данных:
  • oldMap - старая карта;
  • newMap - новая карта.

Унаследовано от IChildOnMap.
optionschange

Изменение в опциях объекта.

Унаследовано от ICustomizable.
parentchange

Сменился родительский объект.

Поля данных:

  • oldParent - старый родитель;
  • newParent - новый родитель.

Унаследовано от IChild.
select

Элемент управления выбран.

Унаследовано от ISelectableControl.
Имя Описание
click

Выбор элемента списка.
deselect

Элемент управления не выбран.

Унаследовано от ISelectableControl.
disable

Элемент управления стал недоступным.

Унаследовано от ISelectableControl.
enable

Элемент управления стал доступным.

Унаследовано от ISelectableControl.
mapchange
Сменилась карта. Поля данных:
  • oldMap - старая карта;
  • newMap - новая карта.

Унаследовано от IChildOnMap.
optionschange

Изменение в опциях объекта.

Унаследовано от ICustomizable.
parentchange

Сменился родительский объект.

Поля данных:

  • oldParent - старый родитель;
  • newParent - новый родитель.

Унаследовано от IChild.
select

Элемент управления выбран.

Унаследовано от ISelectableControl.

Методы

Имя Возвращает Описание
deselect()

Отменяет выбор элемента управления (выключает).

Унаследован от ISelectableControl.
disable()

Делает элемент управления недоступным (запрещены пользовательские действия).

Унаследован от ISelectableControl.
enable()

Делает элемент управления доступным (разрешены пользовательские действия).

Унаследован от ISelectableControl.
getParent()

IControlParent

Returns ссылку на родительский объект.

Унаследован от IControl.
isEnabled()

Boolean

Returns true - элемент управления доступен, false - недоступен.

Унаследован от ISelectableControl.
isSelected()

Boolean

Returns true - элемент управления выбран, false - не выбран.

Унаследован от ISelectableControl.
select()

Выбирает (включает) элемент управления.

Унаследован от ISelectableControl.
setParent(parent)

IChildOnMap

Устанавливает родительский объект.

Унаследован от IControl.
Имя Возвращает Описание
deselect()

Отменяет выбор элемента управления (выключает).

Унаследован от ISelectableControl.
disable()

Делает элемент управления недоступным (запрещены пользовательские действия).

Унаследован от ISelectableControl.
enable()

Делает элемент управления доступным (разрешены пользовательские действия).

Унаследован от ISelectableControl.
getParent()

IControlParent

Returns ссылку на родительский объект.

Унаследован от IControl.
isEnabled()

Boolean

Returns true - элемент управления доступен, false - недоступен.

Унаследован от ISelectableControl.
isSelected()

Boolean

Returns true - элемент управления выбран, false - не выбран.

Унаследован от ISelectableControl.
select()

Выбирает (включает) элемент управления.

Унаследован от ISelectableControl.
setParent(parent)

IChildOnMap

Устанавливает родительский объект.

Унаследован от IControl.

Описание полей

data

{data.Manager} data
Данные элемента списка. Имена полей, доступных через метод data.Manager.get:
  • content - cодержимое элемента списка в виде HTML.

state

{data.Manager} state
Состояние элемента списка. Имена полей, доступных через метод data.Manager.get:
  • selected - признак, выбран ли элемент списка;
  • enabled - признак, активен ли элемент списка.

Описание событий

click

Выбор элемента списка.