.. _gsauto_ug_menu:

Объект меню
===========

Объект меню предоставляет доступ к главному меню приложения и контекстным меню.

Получить объект меню приложения можно с помощью объекта приложения.

.. code-block:: java
   :caption: Получение меню приложения

   MainForm mainForm = application.mainForm();
   MainMenu mainMenu = mainForm.mainMenu();

.. seealso::
   - Руководство пользователя: :ref:`gsauto_ug_application`

Получить объект контекстного меню можно выполнив :java:meth:`клик правой кнопкой мыши <ru.bitec.gs.automation.client.Clickable.rightClick()>` в
элемент интерфейса с последующим выполнением :java:meth:`ожидания отрисовки контекстного меню <ru.bitec.gs.automation.client.ui.Application.waitContextMenu()>`.


.. code-block:: java
   :caption: Получение контекстного меню

   grid.rightClick();
   ContextMenu contextMenu = application.waitContextMenu();

.. seealso::
   - Спецификация: :ref:`gsauto_namingconventions`
   - API: :java:type:`ru.bitec.gs.automation.client.ui.menu.ContextMenu <ru.bitec.gs.automation.client.ui.menu.ContextMenu>`
   - API: :java:type:`ru.bitec.gs.automation.client.ui.Application <ru.bitec.gs.automation.client.ui.Application>`
   - Руководство пользователя: :ref:`gsauto_ug_clickable`

Через объект меню можно осуществлять вызов зарегистрированных :term:`операций <Операция>`.
Для запуска нужной операции укажите последовательность пунктов подменю до 
соответствующего пункта меню и вызовите его метод 
:java:meth:`click()<ru.bitec.gs.automation.client.ui.OperationController.click()>`.

Предположим, что в нашем приложении в главном меню имеется пункт "Формы", 
содержащий подпункт "Справочник с MDI-карточкой":

.. code-block:: java
   :caption: Вызов операции "Справочник с MDI-карточкой" в меню "Формы" главного меню

   mainMenu.itemByCaption("Формы", "Справочник с MDI-карточкой").click();


Метод :java:meth:`itemByCaption(String...) <ru.bitec.gs.automation.client.ui.menu.AbstractMenu.itemByCaption(String[])>` 
можно использовать при любом уровне вложенности подменю. Метод выполняет поиск пункта меню по тексту, отображаемому в пунктах меню.

Объект меню имеет аналогичный метод :java:meth:`item(String...) <ru.bitec.gs.automation.client.ui.menu.AbstractMenu.item(String[])>`. 
Этот метод выполняет поиск по имени операции.

.. seealso::
   - API: :java:type:`ru.bitec.gs.automation.client.ui.menu.AbstractMenu <ru.bitec.gs.automation.client.ui.menu.AbstractMenu>`
   - Руководство пользователя: :ref:`gsauto_ug_clickable`