.. _bpmn_frame:

BpmnEditor
~~~~~~~~~~~~~~~~~~~~

.. todo::

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


.. class:: View.Representation.Layout.Frame.BpmnEditor

  Класс фрейма :term:`PostgreSql решения <postgresql решение>`

  .. versionadded:: AS 1.15

.. seealso::

  - :java:type:`API работы с диаграммой через интерфейс CoreBpmnView <ru.bitec.gtk.core.gl.view.CoreBpmnView>`


Характеристики 
^^^^^^^^^^^^^^^^^^^^^^^^^^^


Основа фрейма - компонент `bmpn-js <https://github.com/bpmn-io/bpmn-js>`__, который обеспечивает основной функционал:

* Визуальный вывод и редактирование :term:`схем <Схема bpmn диаграммы>` в нотации :term:`bpmn` 2.0
* Текущая версия компонента: 7.5

.. rubric:: Global-system надстройка:


* Два режима работы:

  * просмотрщик
  * редактор
* Изменение :term:`bmpn диаграммы <bmpn диаграмма>` в режиме редактора приводит к вызову :term:`сеттера <сеттер>`
* Вывод операций выборки в :term:`contextPad`
  
  * Операции выводятся под пунктом с иконкой: |global_contextpad_menu|

    Выводятся все операции у которых включено :java:field:`visibleOnContextMenu` (для :term:`Oracle решения <oracle решение>`: :btk:operprop:`VISIBLE.POPUPMENU`)
* Работа с :term:`gid <gid bpmn элемента>`


.. |global_contextpad_menu| unicode:: 0x205D .. Иконка кнопки контекст пада под которой раскрываются операции выборки

Свойства фрейма
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

.. btk:frameprop:: xmlSchemaFieldName

  :title: Имя атрибута выборки, который содержит документ для отображения. 

  Документ может быть представлен как путём к файлу, так и бинарными данными.

  :frames:

    * :class:`View.Representation.Layout.Frame.BpmnEditor`

.. btk:frameprop:: isEditable

  :title: Управление режимом Просмотрщик(``false``)/Редактор(``true``)

  Свойство влияет только на процесс создания фрейма. 
  
  .. attention:: 
    
    Изменение значения для уже открытого фрейма не приведет к смене режима отображения диаграммы.

  :frames:

    * :class:`View.Representation.Layout.Frame.BpmnEditor`

  .. versionadded:: AS 1.17

Cобытия
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

.. btk:event:: OnSelectionChanged

  :frames: :class:`View.Representation.Layout.Frame.BpmnEditor`

  :mandatory: нет

  Вызывается после того как выделение во фрейме изменилось: добавились выделенные  элементы,
  их стало меньше или не стало вовсе. 
  
  .. attention:: Событие будет вызвано вне зависимости от того, менялось ли выделение програмно или его изменил пользователь своими действиями. 

  .. seealso:: Доступ к списку выделенных объектов через :java:meth:`ru.bitec.gtk.core.gl.view.CoreBpmnView.getSelectedIds()`


Пример схемы содержащей GID'ы
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

.. literalinclude:: schema_example.bmpn
  :language: xml