.. _event_reference: Справочник событий ========================== .. list-table:: :widths: 30 30 30 30 :header-rows: 0 :align: left * - :btk:event:`afterClose` - :btk:event:`afterCloseForm` - :btk:event:`afterEdit` - :btk:event:`afterOpen` * - :btk:event:`afterRefresh` - :btk:event:`afterRefreshItem` - :btk:event:`afterScroll` - :btk:event:`beforeClose` * - :btk:event:`beforeCloseForm` - :btk:event:`beforeEdit` - :btk:event:`beforeOpen` - :btk:event:`beforeRefresh` * - :btk:event:`beforeRefreshItem` - :btk:event:`beforeScroll` - :btk:event:`checkWorkability` - :btk:event:`checkWorkabilitySysOps` * - :btk:event:`handleEvents` - :btk:event:`onApplyFilter` - :btk:event:`onClipboardPaste` - :btk:event:`onCloseFormQuery` * - :btk:event:`onControllerCreated` - :btk:event:`onDeleteItem` - :btk:event:`onDragDrop` - :btk:event:`onDragOver` * - :btk:event:`onFilterFinalize` - :btk:event:`onFilterInit` - :btk:event:`onFocusedCellChanged` - :btk:event:`onFocusedFieldChanged` * - :btk:event:`onFocusedItemChanged` - :btk:event:`onFrameActivated` - :btk:event:`onInsertItem` - :btk:event:`onLoadAdminMeta` * - :btk:event:`onLoadMeta` - :btk:event:`onRefresh` - :btk:event:`onRefreshItem` - :btk:event:`onResetFilter` * - :btk:event:`onRestoreState` - :btk:event:`onShow` - :btk:event:`form.FormActivated` - :btk:event:`form.FormDeactivated` * - :btk:event:`onStoreState` - :btk:event:`onUnloadMeta` - :btk:event:`application.PropertiesChange` - :btk:event:`tree.NodeOpen` * - :btk:event:`tree.NodesToggle` - - - События выборки -------------------- .. btk:event:: afterClose Вызывается после каждого закрытия выборки. Выполняется как :term:`операция`, через вызов :term:`сервером` одноименного метода :term:`прикладного кода<Прикладной код>` :term:`выборки<Выборка>`. .. btk:event:: afterEdit Вызывается перед завершением редактирования записи, при попытке перейти с отредактированной записи на другую запись выборки или при закрытии выборки. Предназначено для выполнения проверок ограничений на значения полей записи. Выполняется как :term:`операция`, через вызов :term:`сервером` одноименного метода :term:`прикладного кода<Прикладной код>` :term:`выборки<Выборка>`. .. btk:event:: afterOpen Вызывается после каждого открытия выборки. Выполняется как :term:`операция`, через вызов :term:`сервером` одноименного метода :term:`прикладного кода<Прикладной код>` :term:`выборки<Выборка>`. .. btk:event:: afterRefresh Вызывается после каждого обновления набора данных выборки. Выполняется как :term:`операция`, через вызов :term:`сервером` одноименного метода :term:`прикладного кода<Прикладной код>` :term:`выборки<Выборка>`. .. btk:event:: afterRefreshItem Вызывается после обновления данных текущей записи выборки. Выполняется как :term:`операция`, через вызов :term:`сервером` одноименного метода :term:`прикладного кода<Прикладной код>` :term:`выборки<Выборка>`. .. btk:event:: afterScroll Вызывается после изменения активной записи после: открытия выборки, вставки/удаления записи, перемещения к следующей/предыдущей записи. Выполняется как :term:`операция`, через вызов :term:`сервером` одноименного метода :term:`прикладного кода<Прикладной код>` :term:`выборки<Выборка>`. .. btk:event:: beforeClose Вызывается перед закрытием выборки. Выполняется как :term:`операция`, через вызов :term:`сервером` одноименного метода :term:`прикладного кода<Прикладной код>` :term:`выборки<Выборка>`. .. btk:event:: beforeEdit Вызывается перед началом редактирования текущей записи, для выполнения подготовительных действий перед началом редактирования. Выполняется как :term:`операция`, через вызов :term:`сервером` одноименного метода :term:`прикладного кода<Прикладной код>` :term:`выборки<Выборка>`. .. btk:event:: beforeOpen Вызывается перед каждым открытием выборки. Выполняется как :term:`операция`, через вызов :term:`сервером` одноименного метода :term:`прикладного кода<Прикладной код>` :term:`выборки<Выборка>`. .. btk:event:: beforeRefresh Вызывается перед каждым обновлением данных выборки и операцией :btk:event:`onRefresh` Выполняется как :term:`операция`, через вызов :term:`сервером` одноименного метода :term:`прикладного кода<Прикладной код>` :term:`выборки<Выборка>`. .. btk:event:: beforeRefreshItem Вызывается перед каждым обновлением текущей записи выборки операцией :btk:event:`onRefreshItem` Выполняется как :term:`операция`, через вызов :term:`сервером` одноименного метода :term:`прикладного кода<Прикладной код>` :term:`выборки<Выборка>`. .. btk:event:: beforeScroll Вызывается перед изменением активной записи выборки. Выполняется как :term:`операция`, через вызов :term:`сервером` одноименного метода :term:`прикладного кода<Прикладной код>` :term:`выборки<Выборка>`. .. btk:event:: checkWorkability Вызывается при переходе с записи на запись, при открытии выборки, а также после выполнения операции, для которой выставлен флаг «выполнять операцию применимости после выполнения операции». Операция предназначена для осуществления проверок изменения состояния пользовательских операций выборки и доступности редактирования ее атрибутов. Выполняется как :term:`операция`, через вызов :term:`сервером` одноименного метода :term:`прикладного кода<Прикладной код>` :term:`выборки<Выборка>`. .. btk:event:: checkWorkabilitySysOps Вызывается при переходе с записи на запись, при открытии выборки, а также после выполнения операции, для которой выставлен флаг «выполнять операцию применимости после выполнения операции». Операция предназначена для осуществления проверок изменения состояния служебных операций выборки. Выполняется как :term:`операция`, через вызов :term:`сервером` одноименного метода :term:`прикладного кода<Прикладной код>` :term:`выборки<Выборка>`. .. btk:event:: handleEvents Вызывается при получении выборкой сообщения шины обмена сообщениями между выборками. Выполняется как :term:`операция`, через вызов :term:`сервером` одноименного метода :term:`прикладного кода<Прикладной код>` :term:`выборки<Выборка>`. .. btk:event:: onApplyFilter Вызывается при применении условий серверного фильтра. Выполняется как :term:`операция`, через вызов :term:`сервером` одноименного метода :term:`прикладного кода<Прикладной код>` :term:`выборки<Выборка>`. .. btk:event:: onFilterFinalize Событие деинициализации серверного фильтра для выборки. Выполняется как :term:`операция`, через вызов :term:`сервером` одноименного метода :term:`прикладного кода<Прикладной код>` :term:`выборки<Выборка>`. .. btk:event:: onFilterInit Событие инициализации серверного фильтра для выборки. Выполняется как :term:`операция`, через вызов :term:`сервером` одноименного метода :term:`прикладного кода<Прикладной код>` :term:`выборки<Выборка>`. .. btk:event:: onInsertItem Вызывается при вставке записи в выборку. Выполняется как :term:`операция`, через вызов :term:`сервером` одноименного метода :term:`прикладного кода<Прикладной код>` :term:`выборки<Выборка>`. .. btk:event:: onDeleteItem Вызывается перед удалением записи, когда известен идентификатор удаляемой записи. Выполняется как :term:`операция`, через вызов :term:`сервером` одноименного метода :term:`прикладного кода<Прикладной код>` :term:`выборки<Выборка>`. .. btk:event:: onLoadAdminMeta Вызывается при загрузке мета-данных администрирования выборки. Выполняется как :term:`операция`, через вызов :term:`сервером` одноименного метода :term:`прикладного кода<Прикладной код>` :term:`выборки<Выборка>`. .. btk:event:: onLoadMeta Вызывается при загрузке мета-данных выборки. Выполняется как :term:`операция`, через вызов :term:`сервером` одноименного метода :term:`прикладного кода<Прикладной код>` :term:`выборки<Выборка>`. .. btk:event:: onRefresh Вызывается при получении данных выборки. :return: - Строку с SQL-запросом. - Экземпляр :java:type:`ru.bitec.engine.core.datastore.DataStorePacket`. - Коллекция POJO :java:type:`java.lang.Iterable\`. Выполняется как :term:`операция`, через вызов :term:`сервером` одноименного метода :term:`прикладного кода<Прикладной код>` :term:`выборки<Выборка>`. .. btk:event:: onRefreshItem Вызывается при обновлении одной (текущей) записи. :return: - Строку с SQL-запросом - Экземпляр :java:type:`ru.bitec.engine.core.datastore.DataStorePacket` - Коллекция POJO :java:type:`java.lang.Iterable\` Выполняется как :term:`операция`, через вызов :term:`сервером` одноименного метода :term:`прикладного кода<Прикладной код>` :term:`выборки<Выборка>`. .. btk:event:: onResetFilter Событие сброса условий серверного фильтра. Выполняется как :term:`операция`, через вызов :term:`сервером` одноименного метода :term:`прикладного кода<Прикладной код>` :term:`выборки<Выборка>`. .. btk:event:: onRestoreState Вызывается после пересоздания экземпляра :term:`Avi` выборки. Предназначено для восстановления состояния выборки после перезагрузки прикладного кода. Выполняется как :term:`операция`, через вызов :term:`сервером` одноименного метода :term:`прикладного кода<Прикладной код>` :term:`выборки<Выборка>`. .. btk:event:: onStoreState Событие вызывается перед пересозданием экземпляра :term:`Avi` выборки. Предназначено для сохранения состояния выборки перед перезагрузкой прикладного кода. Выполняется как :term:`операция`, через вызов :term:`сервером` одноименного метода :term:`прикладного кода<Прикладной код>` :term:`выборки<Выборка>`. .. btk:event:: onUnloadMeta Вызывается перед уничтожением экземпляра выборки. Выполняется как :term:`операция`, через вызов :term:`сервером` одноименного метода :term:`прикладного кода<Прикладной код>` :term:`выборки<Выборка>`. .. btk:event:: application.PropertiesChange Оповещает главную выборку приложения об изменении свойств приложения (:java:type:`CoreApplication`). Тип события :java:type:`CoreModelEvent`. Посылается через диспетчер событий :java:type:`CoreEventDispatcher`. :params: :java:meth:`CoreModelEvent.getArgs` содержит название измененного свойства приложения :java:type:`PropertiesChange.PropertyNames` :Название операции для Oracle решения: onApplicationPropertiesChange .. versionadded:: 1.23.0_rc5 События фрейма -------------------- .. btk:event:: onControllerCreated Вызывается один раз после построения контролов фрейма (список, дерево, карточка и т.д.) и заполнения их данными. После этого события известен список видимых колонок списков. Выполняется как :term:`операция`, через вызов :term:`сервером` одноименного метода :term:`прикладного кода<Прикладной код>` :term:`выборки<Выборка>`. .. btk:event:: onFocusedCellChanged Вызывается при изменении сфокусированной ячейки списка/дерева. Выполняется как :term:`операция`, через вызов :term:`сервером` одноименного метода :term:`прикладного кода<Прикладной код>` :term:`выборки<Выборка>`. .. btk:event:: onFocusedFieldChanged Вызывается при изменении сфокусированной колонки списка/дерева, редактора карточки. Выполняется как :term:`операция`, через вызов :term:`сервером` одноименного метода :term:`прикладного кода<Прикладной код>` :term:`выборки<Выборка>`. .. btk:event:: onFrameActivated Вызывается при получения фокуса ввода соответствующим выборке фреймом. Выполняется как :term:`операция`, через вызов :term:`сервером` одноименного метода :term:`прикладного кода<Прикладной код>` :term:`выборки<Выборка>`. .. btk:event:: onClipboardPaste Вызывается при вставке данных из буфера обмена, в главный контрол фрейма. Выполняется как :term:`операция`, через вызов :term:`сервером` одноименного метода :term:`прикладного кода<Прикладной код>` :term:`выборки<Выборка>`. .. btk:event:: onDragOver Вызывается при перемещении указателя мыши в режиме перетаскивания. Операция позволяет оперировать свойством :java:type:`CoreListView#canAcceptDragObject()`. Свойство определяет, может принять данный фрейм перетаскиваемый объект или нет. Выполняется как :term:`операция`, через вызов :term:`сервером` одноименного метода :term:`прикладного кода<Прикладной код>` :term:`выборки<Выборка>`. .. seealso:: :ref:`Перетаскивание (Drag & Drop) строк списка мышью` .. btk:event:: onDragDrop Операция вызывается при “бросании” перетаскиваемого объекта. Выполняется как :term:`операция`, через вызов :term:`сервером` одноименного метода :term:`прикладного кода<Прикладной код>` :term:`выборки<Выборка>`. .. seealso:: :ref:`Перетаскивание (Drag & Drop) строк списка мышью` События формы -------------------- .. btk:event:: onShow Вызывается после открытия всех выборок и полного построения интерфейса формы. Выполняется как :term:`операция`, через вызов :term:`сервером` одноименного метода :term:`прикладного кода<Прикладной код>` :term:`выборки<Выборка>`. .. btk:event:: form.FormActivated Вызывается при активации формы: * при открытии формы, после вызова :btk:event:`onShow` * при переключении пользователем на данную форму * при закрытии другой формы, флаг активности к которой перешел от данной формы Вызывается для главной выборки формы. Тип события :java:type:`CoreModelEvent`. Посылается через диспетчер событий :java:type:`CoreEventDispatcher`. :Название операции для Oracle решения: onFormActivated .. versionadded:: 1.24.0-ms11 .. btk:event:: form.FormDeactivated Вызывается при деактивации формы: * при закрытии формы, после вызова :btk:event:`beforeCloseForm` * при переключении пользователем на другую форму * при открытии другой формы Вызывается для главной выборки формы. Тип события :java:type:`CoreModelEvent`. Посылается через диспетчер событий :java:type:`CoreEventDispatcher`. :Название операции для Oracle решения: onFormDeactivated .. versionadded:: 1.24.0-ms11 .. btk:event:: onCloseFormQuery Вызывается перед закрытием формы и предоставляет возможность изменения результата закрытия формы, в том числе отмены закрытия. :return: Boolean. Если `true`, закрытие формы будет продолжено. Если `false`, закрытие формы будет отменено. Выполняется как :term:`операция`, через вызов :term:`сервером` одноименного метода :term:`прикладного кода<Прикладной код>` :term:`выборки<Выборка>`. .. btk:event:: beforeCloseForm Вызывается перед закрытием формы. :params: - beforeCloseEvent: `BeforeCloseFormEvent` - Принимает результат закрытия формы `closeEvent.formResult: FormResult`. И позволяет установить ссылку на объект, который будет возвращён в точку вызова формы из прикладного кода. Выполняется как :term:`операция`, через вызов :term:`сервером` одноименного метода :term:`прикладного кода<Прикладной код>` :term:`выборки<Выборка>`. .. btk:event:: afterCloseForm Вызывается при закрытии формы, после определения результата закрытия формы. :params: - afterCloseEvent: `AfterCloseFormEvent` - Принимает результат закрытия формы `closeEvent.formResult: FormResult`. Выполняется как :term:`операция`, через вызов :term:`сервером` одноименного метода :term:`прикладного кода<Прикладной код>` :term:`выборки<Выборка>`. .. _tree_events_ref: События дерева ----------------- .. seealso:: :ref:`Фрейм древовидного представления` .. btk:event:: selection.layout.composer.frame.tree.NodeOpen Вызывается при раскрытии узла в дереве. Тип события :java:type:`CoreModelEvent`. Посылается через диспетчер событий :java:type:`CoreEventDispatcher`. :Название операции для Oracle решения: onAfterNodeOpen .. versionadded:: 1.24.0-ms4 .. btk:event:: selection.layout.composer.frame.tree.NodesToggle Вызывается при изменении состояния раскрытости узлов в дереве по средствам пользовательского действия (Пункты контекстного меню, клики по иконкам узлов и контекстный поиск, если он привел к раскрытию). Тип события :java:type:`CoreModelEvent`. Посылается через диспетчер событий :java:type:`CoreEventDispatcher`. :params: :java:meth:`CoreModelEvent.getArgs` содержит информацию о том произошло раскрытие или сворачивание из :java:type:`NodesToggle.ToggleType` :Название операции для Oracle решения: onTreeNodesToggle .. versionadded:: 1.24.0-ms4 .. _gantt_events_ref: События диаграммы Ганта ---------------------------- .. seealso:: * :ref:`Фрейм диаграммы Ганта ` .. btk:event:: onFocusedItemChanged Вызывается при получении выделения элементом диаграммы Ганта. .. versionadded:: 1.20.0_ms25 Выполняется как :term:`операция`, через вызов :term:`сервером` одноименного метода :term:`прикладного кода<Прикладной код>` :term:`выборки<Выборка>`.