Графическая схема. Управление при помощи XDTO.

Графическая схема. Управление при помощи XDTO.

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

Как правило, в этих публикациях графическая схема либо сохраняется в файл GRS, который может быть программно изменен, либо используется XML-, JSON- сериализация, конвертация в платформенные структуры и массивы. К сожалению, ни в одной публикации не был упомянут самый простой и логичный (на мой взгляд) способ - использование механизма XDTO. Этот способ имеет много общего с использованием XML-сериализации, но гораздо удобнее в изучении и реализации, а также позволяет получить более понятный код.

Описание механизма

Несколько слов о механизме XDTO. Я не буду останавливаться на теории, желающие без труда найдут соответствующие статьи (например цикл статей //infostart.ru/public/167459/), ограничусь лишь рассмотрением практических вопросов, необходимых в рамках нашей задачи. Заранее прошу прощения у гуру за некий повтор информации из документации, цель моей публикации - изложить информацию в максимально доступной для новичков форме.

Итак, для работы нам потребуется 2 вида сущностей: ОбъектXDTO - объекты, которые будут для нас элементами графической схемы, и СписокXDTO - список объектов ОбъектXDTO. Многие объекты 1С, в том числе графическая схема, могут быть преобразованы в объекты XDTO:

Каждый объект характеризуется типом. Программист может создавать объекты XDTO произвольных типов. Тип определяется совокупностью двух строк: URIПространстваИмен и Имя типа. Например создание объекта - элемента графической схемы выглядит так:

Возникает вопрос: как перед созданием узнать тип нужного программисту объекта, т.е. Имя и URIПространстваИмен? Существует 2 способа: первый - создать объект вручную и посмотреть в отладчике свойства его типа:

Вариант второй - обратиться к в желтым книжкам, или синтаксис-помощнику. Так, для графической схемы:

. Данный объект может быть сериализован в/из XDTO. Тип XDTO, соответствующий данному объекту, определяется в пространстве имен . Имя типа XDTO: FlowchartContextType.

У объекта XDTO есть свойства, значениями которых могут выступать как простые типы, так и сложные: другие объекты или их списки.

Как видим, у объекта графической схемы есть собственные свойства, кроме того есть реквизит item - Список XDTO. Забегая вперед, отметим, что это - список графических элементов, т.е. именно то, что нам нужно.

Большинство свойств объектов доступны для изменения.

После модификации Объект XDTO можно преобразовать обратно в объект платформы 1С:

Таким образом методика программного изменения графической схемы выглядит так:

  • Сериализуем (т.е. преобразовываем в объект XDTO) графическую схему
  • Меняем свойства объекта XDTO, список графических элементов,
  • Десериализуем объект XDTO обратно в графическую схему.

Неоспоримым плюсом и отличием от способов, предлагаемых в других публикациях, является тот факт, что на этапе изменения схемы мы работаем с понятной объектной моделью - объектами (с доступными свойствами-реквизитами) и списками объектов.

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

Для примера попробуем добавить в графическую схему элемент "Действие":

Сериализуем графическую схему и создадим новый элемент схемы:

Реквизит itemType - один из самых важных. Он задает тип графического элемента и его внешний вид.

  • 0 - Декорация
  • 1 - Линия
  • 2 - Старт
  • 3 - Завершение
  • 4 - Условие
  • 5 - Действие
  • 6 - Выбор варианта
  • 7 - Разделение
  • 8 - Слияние
  • 9 - Обработка
  • 10 - Вложенный процесс

Далее зададим имя создаваемого объекта, его идентификатор (должен быть уникальным среди элементов схемы) и номер порядка обхода.

Следующий шаг - мы должны задать координаты прямоугольника, внутри которого будет расположен наш объект. Именно к серединам его сторон будут потом "привязываться" соединительные линии. Координаты отсчитываются от левого верхнего угла схемы.

Заголовок элемента - это несколько вариантов строк, для разных языков. Нам хватит одного.

Определим цвет элемента. В нашем случае - цвет по умолчанию, определяется типом элемента.

Следующий момент - задание типа линии границы элемента - значение реквизита border. На этом шаге спотыкается большинство разработчиков, так как в документации этот вопрос не рассмотрен, а реверс-инжиниринг дает непонятный результат. Правильно делать так:

У нашего объекта есть свойство point - список объектов XDTO - точек вершин элемента. Для корректного отображения элемента их надо задать. Правые и нижние координаты на единицу меньше чем координаты ограничивающего прямоугольника. (Почему так? Кто знает. )

Что будет если мы зададим свой набор точек? Можно будет нарисовать многоугольник произвольной формы? Да можно, но. до первого "шевеления" элемента мышкой. При первом же удобном случае элемент примет форму, определяемую его типом, в пределах ограничивающего прямоугольника.

И, наконец, добавим наш созданный элемент в список элементов графической схемы и десериализуем ее.

Приведенного выше кода достаточно для отображения элемента "Действие". Но можно настроить и другие свойства: alignHor, alignVer, hyperlink, picturePlacement, pictureStyle, transparent, lineColor, textColor и др. Их назначение понятно из названий.

Аналогичным образом создаются и другие объекты. При этом необходимо учесть несколько особенностей:

  • По умолчанию у объектов "Старт" и "Завершение" угол при вершине равен 120º
  • По умолчанию у объекта "Условие" углы правой и левой стороны равны 120º
  • Объект "Декорация" имеет реквизит shape, который отвечает за форму объекта: Блок, Документ, Эллипс и т.д.
  • У объекта "ВыборВарианта" есть реквизит transition, содержащий список вариантов.
  • Высота заголовка объекта "Действие" и высота вариантов объекта "ВыборВарианта" - величина постоянная

Создание соединительной линии несколько отличается от создания прочих объектов:

Здесь надо обратить внимание на следующие реквизиты: connectFromItemId, connectToItemId - идентификаторы объектов, к которым "привязаны" начало и конец линии. portIndexFrom, portIndexTo - номера сторон, к которым присоединены линии.

Список номеров сторон:

  • 1 - середина левой стороны ограничивающего объект прямоугольника
  • 2 - середина верхней стороны
  • 3 - середина правой стороны
  • 4 - середина нижней стороны
  • 6, 8, 10, . - середина левой стороны варианта 1, 2, 3, . для объекта ВыборВарианта
  • 7, 9, 11, . - середина правой стороны варианта 1, 2, 3, . для объекта ВыборВарианта

Особенности работы с линиями:

  • Если линия начинается из варианта объекта ВыборВарианта, то реквизит connectFromPortIndex равен номеру варианта.
  • Реквизит decorativeLine - флаг декоративной линии.
  • Соединительная линия, в отличие от декоративной, перестраивается при перемещении объекта, к которому присоединена. Присоединенная декоративная линия также перемещается вслед за перемещаемым объектом, но, как правило, ее форма не так сильно меняется.
  • Декоративная линия может иметь наконечники разных типов, а соединительная - только в виде заполненной стрелки.
  • Нельзя допускать наличия соседних сегментов линии, лежащих на одной прямой, иначе перемещение линии вызывает странные визуальные эффекты.

Библиотека для работы с графической схемой

Для упрощения работы с графической схемой была разработана библиотека функций, приложенная к статье.

Функции создания и удаления объектов:

Функции работы с вариантами:

Функция соединения объектов:

Задача соединения объектов линией оказалась неожиданно непростой. Количество вариантов взаимного расположения объектов с учетом комбинаций соединяемых сторон довольно велико. Для сокращения количества вариантов пришлось использовать поворот объектов вокруг оси координат так, чтобы линия в первый объект входила всегда с левой стороны. Интересной выглядит следующая задача: написать алгоритм построения соединительной линии так, чтобы а) линия по возможности огибала бы другие элементы схемы и б) количество пересечений с другими линиями было бы минимально. Задача а) уже решена в платформе. Желающие могут из решения этой задачи сделать очень хорошую публикацию.

Пример использования библиотеки:

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

В заключение хотелось бы отметить, что использование XDTO позволяет программисту получить дополнительные возможности по работе с самыми разными объектами (Дерево значений, табличный документ, и т.д.), тем самым несколько скомпенсировать отсутствие таких возможностей в объектной модели, предоставляемой платформой.

📎📎📎📎📎📎📎📎📎📎