Базовая схема, методы, сообщения

Общие сведения

Детали предназначены для отображения дополнительных данных для основного объекта раздела. Детали раздела отображаются на вкладках страницы раздела в контейнере вкладок.

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

• деталь с полями редактирования;
• деталь со страницей добавления;
• деталь с редактируемым реестром;
• деталь с выбором из справочника.

Подробное описание деталей в зависимости от их типа представлено в статье "Деталь".

Создание детали

Для того чтобы мастер деталей мог корректно работать с созданной разработчиком деталью, ее необходимо зарегистрировать. Для регистрации детали необходимо в таблицу SysDetail добавить запись с указанием заголовка детали, идентификатора схемы детали DetailSchemaUid (колонка UId таблицы SysSchema) и идентификатора схемы объекта детали EntitySchemaUId (колонка UId таблицы SysSchema).

Подробно процесс создания деталей разных типов изложен в разделе "Создание деталей".

Базовая схема детали BaseDetailV2

Все схемы деталей должны быть наследниками базовой схемы детали BaseDetailV2. В схеме реализована базовая логика инициализации данных и общения со страницей редактирования.

Класс базовой схемы детали содержит такие свойства:

Сообщения BaseDetailV2

Сообщения предназначены для общения детали со страницей редактирования. Полный перечень сообщений, их режим вещания и направление приведены в таблице 1.

Табл. 1. — Сообщения базовой детали

Виды режимов сообщений определены в перечислении Terrasoft.core.enums.MessageMode, а направление сообщений — в перечислении Terrasoft.core.enums.MessageDirectionType. Подробнее о них можно узнать из "Библиотеки классов клиентской части ядра платформы".

Атрибуты BaseDetailV2

Свойство attributes содержит атрибуты модели представления детали. Атрибуты, определенные в классе базовой детали, представлены в таблице 2.

Табл. 2. — Атрибуты базовой детали

Возможные типы данных атрибутов представлены перечислением Terrasoft.DataValueType. Подробнее о типах данных можно узнать из "Библиотеки классов клиентской части ядра платформы".

Методы BaseDetailV2

Методы, определенные в классе базовой детали, представлены в таблице 3.

Табл. 3. — Методы базовой детали

Массив модификаций BaseDetailV2

В массиве модификаций diff базовой детали определен только базовый контейнер для представления детали:

diff: /**SCHEMA_DIFF*/[
  // Базовый контейнер для представления детали.
  {
     "operation": "insert",
     "name": "Detail",
     "values": {...}
  }
]/**SCHEMA_DIFF*/

Базовый класс детали с реестром BaseGridDetailV2

Является наследником BaseDetailV2. Все детали с реестром должны быть наследниками BaseGridDetailV2. В схеме BaseGridDetailV2 реализована базовая логика работы с реестром (загрузка, фильтрация), удаление, добавление и редактирование записей на детали.

Процесс создания пользовательской детали с реестром подробно изложен в статье "Создание детали с редактируемым реестром".

Сообщения BaseGridDetailV2

Основные сообщения схемы BaseGridDetailV2 приведены в таблице 4.

Табл. 4. — Сообщения базовой детали с реестром

Виды режимов сообщений определены в перечислении Terrasoft.core.enums.MessageMode, а направление сообщений — в перечислении Terrasoft.core.enums.MessageDirectionType. Подробнее о них можно узнать из "Библиотеки классов клиентской части ядра платформы".

Атрибуты BaseGridDetailV2

Основные атрибуты класса BaseGridDetailV2 приведены в таблице 5.

Табл. 5. — Атрибуты базовой детали с реестром

Возможные типы данных атрибутов представлены перечислением Terrasoft.DataValueType. Подробнее о типах данных детали можно узнать из "Библиотеки классов клиентской части ядра платформы".

Миксины BaseGridDetailV2

Основные миксины, используемые классом BaseGridDetailV2, приведены в таблице 6.

Табл. 6. — Миксины базовой детали с реестром

Подробнее миксин GridUtilities описан ниже.

Методы BaseGridDetailV2

Методы, используемые классом BaseGridDetailV2, приведены в таблице 7.

Табл. 7. — Методы базовой детали с реестром

Массив модификаций BaseGridDetailV2

В массиве модификаций diff базовой детали определен только базовый контейнер для представления детали:

diff: /**SCHEMA_DIFF*/ [
  {
    // Элемент для отображения реестра.
    "operation": "insert",
    "name": "DataGrid",
    "parentName": "Detail",
    "propertyName": "items",
    "values": {
      "itemType": Terrasoft.ViewItemType.GRID,
      …
    }
  },
  {
    // Кнопка дозагрузки реестра.
    "operation": "insert",
    "parentName": "Detail",
    "propertyName": "items",
    "name": "loadMore",
    "values": {
      "itemType": Terrasoft.ViewItemType.BUTTON,
      …
    }
  },
  {
    // Кнопка добавления записи.
    "operation": "insert",
    "name": "AddRecordButton",
    "parentName": "Detail",
    "propertyName": "tools",
    "values": {
      "itemType": Terrasoft.ViewItemType.BUTTON,
      …
    }
  },
  {
    // Кнопка добавления типизированной записи.
    "operation": "insert",
    "name": "AddTypedRecordButton",
    "parentName": "Detail",
    "propertyName": "tools",
    "values": {
      "itemType": Terrasoft.ViewItemType.BUTTON,
      …
    }
  },
  {
    // Меню детали.
    "operation": "insert",
    "name": "ToolsButton",
    "parentName": "Detail",
    "propertyName": "tools",
    "values": {
      "itemType": Terrasoft.ViewItemType.BUTTON,
      …
    }
  }
] /**SCHEMA_DIFF*/

Миксин GridUtilitiesV2

GridUtilitiesV2 — миксин, реализующий логику работы с элементом управления "реестр". В классе Terrasoft.configuration.mixins.GridUtilities реализованы:

1. Подписка на сообщения.
2. Загрузка данных.
3. Работа с реестром:
   • выбор записей (поиск активных);
   • добавление, удаление, редактирование записей;
   • установка фильтров;
   • сортировка;
   • экспорт в файл;
   • проверка прав доступа к записям реестра.

Методы GridUtilitiesV2

Основные методы класса GridUtilitiesV2 представлены в таблице 8.

Табл. 8. — Методы базовой детали с реестром

Деталь с редактируемым реестром

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

1. Добавить зависимости от модулей ConfigurationGrid, ConfigurationGridGenerator, ConfigurationGridUtilities.
2. Подключить миксины ConfigurationGridUtilites и OrderUtilities.
3. Установить атрибут IsEditable в значение true.
4. В массив модификаций добавить конфигурационный объект, в котором устанавливаются свойства и выполняется привязка методов-обработчиков событий реестра детали.

Кейс создания детали с редактируемым реестром подробно рассмотрен в статье "Создание детали с редактируемым реестром".

Модуль ConfigurationGrid

Модуль ConfigurationGrid содержит реализацию элемента управления "Конфигурационный реестр". Класс Terrasoft.ConfigurationGrid является наследником класса Terrasoft.Grid. Основные методы класса Terrasoft.ConfigurationGrid представлены в таблице 9.

Табл. 9. — Методы конфигурационного реестра

Модуль ConfigurationGridGenerator

Класс Terrasoft.ConfigurationGridGenerator генерирует конфигурацию реестра и является наследником класса Terrasoft.ViewGenerator. Методы, реализованные в классе Terrasoft.ConfigurationGridGenerator, представлены в таблице 10.

Табл. 10. — Методы генератора конфигурационного реестра

Модуль ConfigurationGridUtilities

Класс Terrasoft.ConfigurationGridUtilities содержит методы инициализации модели представления строки реестра, обработки действий активной записи и обработки горячих клавиш.

Основные свойства класса Terrasoft.ConfigurationGridUtilities представлены в таблице 11, а его методы — в таблице 12.

Табл. 11. — Свойства класса Terrasoft.ConfigurationGridUtilities

Табл. 12. — Методы класса Terrasoft.ConfigurationGridUtilities