class Controls/menu:Control

Контрол меню.

Примеры

Пример
Исходный код

Опции

Имя свойства, содержащего информацию о дополнительном пункте выпадающего меню.

Подробное описание здесь.

IMenuControl

Цвет фона для меню.

IBackgroundStyle

Функция, которая вызывается каждый раз непосредственно после загрузки данных из источника контрола.

Функцию можно использовать для изменения данных еще до того, как они будут отображены в контроле.

ISource

Функция обратного вызова для определения сбоя загрузки данных из источника.

ISource

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

IMenuBase

Первичный ключ для пункта выпадающего списка, который создаётся при установке опции emptyText.

IMenuBase

Добавляет пустой элемент в список с заданным текстом.

Ключ пустого элемента по умолчанию null, для изменения значения ключа используйте emptyKey.

IMenuBase

Конфигурация объекта фильтра. Фильтр отправляется в запрос к источнику для получения данных.

IFilter

Стиль цвета текста контрола.

IFontColorStyle

Имя свойства, содержащего идентификатор группы элемента списка.

IGrouped

Шаблон отображения заголовка группы.

IGrouped

Режим отображения иерархии.

IMenuControl

Цвет фона для пункта меню при наведении.

IMenuControl

Размер иконки.

IIconSize

Стиль отображения иконки.

IIconStyle

Конфигурация опций записи.

IMenuControl

Вид отображения элемента

IMenuControl

Устанавливает шаблон отображения элемента в выпадающем списке. Подробнее про настройку шаблона здесь.

Для контролов из библиотеки dropdown используйте в качестве шаблона Controls/dropdown:ItemTemplate для ленивой загрузки библиотеки menu.

IMenuBase

Устанавливает имя поля, которое содержит имя шаблона отображения элемента. Подробнее про настройку шаблона здесь.

Для контролов из библиотеки dropdown используйте в качестве шаблона Controls/dropdown:ItemTemplate для ленивой загрузки библиотеки menu.

IMenuBase

Резмер отступа между пунктами меню.

IMenuControl
protected

Название свойства записи, содержащего первичный ключ.

ISource

Идентификатор элемента, который выделен маркером.

IMarkerList

Режим отображения маркера.

IMarkerList
protected

Метаданные

protected

Формат всех полей метаданных.

protected

Конструктор записей, порождаемых рекордсетом. По умолчанию Types/entity:Model.

Конфигурация навигации по списку.

INavigation

Шаблон подвала, отображающийся для всех подменю.

В шаблон передается объект itemData со следующими полями:

  • key — ключ родительского элемента;

  • item — родительский элемент.

IMenuControl

Имя свойства, содержащего информацию о типе элемента (лист, узел, скрытый узел).

IMenuControl

Флаг, который отключает загрузку переменных тем оформления для контролов.

isWasabyControl

Имя свойства, содержащего информацию о родительском элементе.

IMenuControl

Определяет, может ли пользователь изменить значение контрола.

(или взаимодействовать с контролом, если его значение не редактируется).

isWasabyControl

Настройки окна выбора.

ISelectorDialog

Объект реализующий интерфейс Types/source:ICrud, необходимый для работы с источником данных.

ISource

Имя свойства, которое содержит источник или

конфигурацию для создания класса для загрузки данных подменю.

IMenuControl

Имя свойства, отвечающего за то, как будут раскрываться подуровни меню.

IMenuControl

Название темы оформления. В зависимости от темы загружаются различные таблицы стилей и применяются различные стили к контролу.

isWasabyControl

Поля

protected

Модель по умолчанию

protected

Метаданные - локальная обработанная копия _$metaData

подмешивается в совместимости. нужно для совместимости с ws3.

Определяет значения опций для декорирования.

Control

Логический родитель. То есть тот, в шаблоне которого лежит данный экземпляр.

В идеале отказаться, но пока что есть использования.

Control

Название контрола.

Control

Опции, который были до рендера контрола, передаются как параметр в хуки

жизненного цикла _afterRender и _afterUpdate

Control
deprecated

Массив имен нетемизированных стилей, необходимых контролу.

Все стили будут скачаны при создании

Control
deprecated

Массив имен темизированных стилей, необходимых контролу.

Все стили будут скачаны при создании

Control

Нужно для переноса _children родителя из оберток над чистым реактом, чтобы работал вызов методов с инстанса контрола

Control
protected

Набор детей контрола, для которых задан атрибут name.

Control

Контекст с опциями readOnly и theme

Control
protected

Реальные опции контрола. Туда собираются значения из props и context.

ВАЖНО: значения могут не совпадать с props в некоторые моменты времени,

чтобы в хуках были правильные значения.

Control
protected

Шаблон контрола.

Control

Методы

Вставляет сырые данные записей в сырые данные рекордсета

protected

Хук жизненного цикла контрола. Вызывается сразу после установки контрола в DOM-окружение.

Control
protected
Control
protected

Асинхронный хук жизненного цикла контрола. Вызывается после обновления контрола.

Control

Переустанавливает сырые данные

protected

Хук жизненного цикла контрола. Вызывается непосредственно перед установкой контрола в DOM-окружение.

Control
protected

Хук жизненного цикла контрола. Вызывается перед обновлением контрола.

Control

Хук жизненного цикла контрола. Вызывается до удаления контрола.

Control
protected

Хук жизненного цикла контрола. Вызывается перед обновлением контрола.

Control
protected

Создает новый экземпляр модели

protected

Проверяет, что переданный элемент - это запись с идентичным форматом

Синхронный хук жизненного цикла контрола. Вызывается сразу после установки контрола в DOM-окружение.

Control
protected

Возвращает индексатор коллекции

protected

Возвращает запись по индексу

Пересоздает элементы из сырых данных

Returns record copy with target format

Normalizes given records by producing their copies with recordset's format

protected

Определяет, должен ли контрол обновляться. Вызывается каждый раз перед обновлением контрола.

Control

Подтверждает изменения всех записей с момента предыдущего вызова acceptChanges().

Обрабатывает состояние записей следующим образом:

  • Changed и Added - меняют state на Unchanged;
  • Deleted - удаляются из рекордсета, а их state становится Detached;
  • остальные не меняются.

Активирует контрол.

isWasabyControl

Добавляет запись в рекордсет путем создания новой записи, в качестве сырых данных для которой будут взяты сырые данные аргумента item.

Если формат созданной записи не совпадает с форматом рекордсета, то он будет приведен к нему принудительно:

лишние поля будут отброшены, недостающие - проинициализированы значениями по умолчанию.

При недопустимом at генерируется исключение.

Добавляет копии записей другой коллекции в конец рекордсета.

Если формат созданных копий не совпадает с форматом рекордсета, то он будет приведен к нему принудительно: лишние поля будут отброшены, недостающие - проинициализированы значениями по умолчанию.

Заменяет записи рекордсета копиями записей другой коллекции.

Если формат созданных копий не совпадает с форматом рекордсета, то он будет приведен к нему принудительно: лишние поля будут отброшены, недостающие - проинициализированы значениями по умолчанию.

Возвращает запись по позиции.

При недопустимом index возвращает undefined.

Конструктор RecordSet, принимающий набор опций в качестве первого аргумента

Создаёт и монтирует контрол на элемент

Control

Перебирает записи рекордсета.

Старый способ наследоваться

Control

Возвращает энумератор для перебора записей рекордсета.

Пример использования можно посмотреть в модуле Types/collection:IEnumerable.

Возвращает название свойства записи, содержащего первичный ключ

Возвращает метаданные RecordSet'а.

Подробнее о метаданных смотрите в описании опции metaData.

Возвращает конструктор записей, порождаемых рекордсетом.

Возвращает запись по ключу.

Если записи с таким ключом нет - возвращает undefined.

Возвращает признак, что изменено хотя бы одно поле, хотя бы в одном элементе.

Загрузка стилей и тем контрола

Control

Объединяет два рекордсета.

Для обратной совместимости

Control

Создает из рекордсета патч - запись с измененными, добавленными записями и ключами удаленных записей.

Добавляет копии записей другой коллекции в начало рекордсета.

Если формат созданных копий не совпадает с форматом рекордсета, то он будет приведен к нему принудительно:

лишние поля будут отброшены, недостающие - проинициализированы значениями по умолчанию.

Откатывает изменения всех записей к состоянию на момент после предыдущего вызова acceptChanges().

Обрабатывает состояние записей следующим образом:

  • Changed - меняет state на Unchanged; значения внутренних полей откатываются
  • Added - меняет state на Detached;
  • Deleted - меняет state на Unchanged, значения внутренних полей откатываются;
  • Detached - возвращает запись в рекордсет, меняет state на Unchanged, значения внутренних полей откатываются;

Заменяет запись в указанной позиции через создание новой записи, в качестве сырых данных для которой будут взяты сырые данные аргумента item.

Если формат созданной записи не совпадает с форматом рекордсета, то он будет приведен к нему принудительно: лишние поля будут отброшены, недостающие - проинициализированы значениями по умолчанию.

При недопустимом at генерируется исключение.

Для обратной совместимости

Control

Устанавливает название свойства записи, содержащего первичный ключ

Устанавливает метаданные RecordSet'а.

Подробнее о метаданных смотрите в описании опции metaData.

  • path - путь для хлебных крошек, возвращается как Types/collection:RecordSet;
  • results - строка итогов, возвращается как Types/entity:Record. Подробнее о конфигурации списков для отображения строки итогов читайте в этом разделе;
  • more - Boolean - есть ли записи для подгрузки (используется для постраничной навигации).

События

Происходит при активации контрола.

isWasabyControl

Происходит до изменения ключа маркера.

IMarkerList

Происходит при деактивации контрола.

isWasabyControl

Происходит при выделении пользователем элемента списка.

IMarkerList

Происходит при выборе элементов из справочника.

ISelectorDialog