.. java:import:: java.time Duration

.. java:import:: java.util Optional

.. java:import:: org.openqa.selenium WebElement

.. java:import:: ru.bitec.gs.automation.client BrowserContext

Form
====

.. java:package:: ru.bitec.gs.automation.client.ui
   :noindex:

.. java:type:: public class Form extends AbstractForm

   .. versionadded:: 1.1.0 Методы и их сигнатуры приведены к :ref:`соглашению по именам<gsauto_namingconvensions>`. (см. описание соответствующих методов)

   Форма приложения (Mdi/Modal/Lookup).

   В основном, класс предоставляет методы для поиска и ожидания появления на dom-модели форм, открытых в соответствующих режимах :java:ref:`AbstractForm.OpenType <ru.bitec.gs.automation.client.ui.AbstractForm.OpenType>`.

   .. seealso::

      | :java:ref:`AbstractForm.OpenType <ru.bitec.gs.automation.client.ui.AbstractForm.OpenType>`
      | :java:ref:`AbstractForm <ru.bitec.gs.automation.client.ui.AbstractForm>`

Constructors
------------

Form
^^^^

.. java:constructor:: public Form(BrowserContext browserContext, WebElement webElement)
   :outertype: Form

Methods
-------

findAllLookup
^^^^^^^^^^^^^

.. java:method:: public static Form[] findAllLookup(BrowserContext browserContext)
   :outertype: Form

   Найти открытые Lookup-формы.

   :param browserContext: контекст браузера
   :return: массив форм

findAllMdi
^^^^^^^^^^

.. java:method:: public static Form[] findAllMdi(BrowserContext browserContext)
   :outertype: Form

   Найти открытые MDI-формы. Ищет на dom-модели формы, открытые в режиме MDI и возвращает их в виде массива.

   Нужно иметь в виду, что этот вариант поиска не гарантирует обнаружение форм, dom-представление которых еще не сгенерировано (ленивая/отложенная генерация).

   :param browserContext: контекст браузера
   :return: массив форм

findAllModal
^^^^^^^^^^^^

.. java:method:: public static Form[] findAllModal(BrowserContext browserContext)
   :outertype: Form

   Найти открытые модальные формы.

   :param browserContext: контекст браузера
   :return: массив форм

findLookup
^^^^^^^^^^

.. java:method:: public static Optional<Form> findLookup(BrowserContext browserContext, String name)
   :outertype: Form

   .. versionadded:: 1.1.0 Сигнатура метода приведена к :ref:`соглашению по именам<gsauto_namingconvensions>` (ранее возвращалась форма, теперь возвращается опциональная форма).

   Найти Lookup-форму по названию выборки и вернуть эту форму.

   :param browserContext: контекст браузера
   :param name: название выборки
   :return: опциональная форма

findLookup
^^^^^^^^^^

.. java:method:: public static Optional<Form> findLookup(BrowserContext browserContext, String name, String representation)
   :outertype: Form

   .. versionadded:: 1.1.0 Сигнатура метода приведена к :ref:`соглашению по именам<gsauto_namingconvensions>` (ранее возвращалась форма, теперь возвращается опциональная форма).

   Найти Lookup-форму по наименованию выборки и представления и вернуть эту форму.

   :param browserContext: контекст браузера
   :param name: название выборки
   :param representation: название представления
   :return: опциональная форма

findMdi
^^^^^^^

.. java:method:: public static Optional<Form> findMdi(BrowserContext browserContext, String name)
   :outertype: Form

   .. versionadded:: 1.1.0 Сигнатура метода приведена к :ref:`соглашению по именам<gsauto_namingconvensions>` (ранее возвращалась форма, теперь возвращается опциональная форма).

   Найти MDI-форму на dom-модели и вернуть эту форму.

   :param browserContext: контекст браузера
   :param name: название выборки
   :return: опциональная форма

findMdi
^^^^^^^

.. java:method:: public static Optional<Form> findMdi(BrowserContext browserContext, String name, String representation)
   :outertype: Form

   .. versionadded:: 1.1.0 Сигнатура метода приведена к :ref:`соглашению по именам<gsauto_namingconvensions>` (ранее возвращалась форма, теперь возвращается опциональная форма).

   Найти MDI-форму по названию выборки и представления и вернуть эту форму.

   :param browserContext: контекст браузера
   :param name: название выборки
   :param representation: название представления.
   :return: опциональная форма

findModal
^^^^^^^^^

.. java:method:: public static Optional<Form> findModal(BrowserContext browserContext, String name)
   :outertype: Form

   .. versionadded:: 1.1.0 Сигнатура метода приведена к :ref:`соглашению по именам<gsauto_namingconvensions>` (ранее возвращалась форма, теперь возвращается опциональная форма).

   Найти модальную форму по имени выборки и вернуть эту форму.

   :param browserContext: контекст браузера
   :param name: название выборки
   :return: опциональная форма

findModal
^^^^^^^^^

.. java:method:: public static Optional<Form> findModal(BrowserContext browserContext, String name, String representation)
   :outertype: Form

   .. versionadded:: 1.1.0 Сигнатура метода приведена к :ref:`соглашению по именам<gsauto_namingconvensions>` (ранее возвращалась форма, теперь возвращается опциональная форма).

   Найти модальную форму по названию выборки и представления и вернуть эту форму.

   :param browserContext: контекст браузера
   :param name: название выборки
   :param representation: название представления
   :return: опциональная форма

waitClosing
^^^^^^^^^^^

.. java:method:: public void waitClosing() throws ru.bitec.gs.automation.exception.AutomationException
   :outertype: Form

   Метод ожидает закрытия формы в течении отведенного времени. Закрытием формы считается пропадание с dom-модели корневого web-элемента этой формы.

   :throws ru.bitec.gs.automation.exception.AutomationException: если не дождались закрытия формы

waitLookup
^^^^^^^^^^

.. java:method:: public static Form waitLookup(BrowserContext browserContext, String name) throws ru.bitec.gs.automation.exception.ElementNotFoundException
   :outertype: Form

   Подождать появления на dom-модели Lookup-формы по имени выборки и вернуть эту форму.

   :param browserContext: контекст браузера
   :param name: название выборки
   :throws ru.bitec.gs.automation.exception.ElementNotFoundException: если не дождались появления Lookup-формы на dom-модели в течении отведенного времени
   :return: форма

waitLookup
^^^^^^^^^^

.. java:method:: public static Form waitLookup(BrowserContext browserContext, String name, String representation) throws ru.bitec.gs.automation.exception.ElementNotFoundException
   :outertype: Form

   Подождать появления на dom-модели Lookup-формы по названию выборки и представления и вернуть эту форму.

   :param browserContext: контекст браузера
   :param name: название выборки
   :param representation: название представления
   :throws ru.bitec.gs.automation.exception.ElementNotFoundException: если не дождались появления Lookup-формы на dom-модели в течении отведенного времени
   :return: форма

waitLookup
^^^^^^^^^^

.. java:method:: public static Form waitLookup(BrowserContext browserContext, String name, Duration duration) throws ru.bitec.gs.automation.exception.ElementNotFoundException
   :outertype: Form

   Подождать появления на dom-модели Lookup-форму по имени выборки в течении указанного времени и вернуть эту форму.

   :param browserContext: контекст браузера
   :param name: название выборки
   :param duration: продолжительность времени
   :throws ru.bitec.gs.automation.exception.ElementNotFoundException: если не дождались появления Lookup-формы на dom-модели в течении отведенного времени
   :return: форма

waitLookup
^^^^^^^^^^

.. java:method:: public static Form waitLookup(BrowserContext browserContext, String name, String representation, Duration duration) throws ru.bitec.gs.automation.exception.ElementNotFoundException
   :outertype: Form

   Подождать появления на dom-модели Loookup-форму по имени выборки и представления в течении указанного времени и вернуть эту форму.

   :param browserContext: контекст браузера
   :param name: название выборки
   :param representation: название представления
   :param duration: продолжительность времени
   :throws ru.bitec.gs.automation.exception.ElementNotFoundException: если не дождались появления Lookup-формы на dom-модели в течении отведенного времени
   :return: форма

waitMdi
^^^^^^^

.. java:method:: public static Form waitMdi(BrowserContext browserContext, String name) throws ru.bitec.gs.automation.exception.ElementNotFoundException
   :outertype: Form

   Подождать появления на dom-модели MDI-формы по имени выборки и вернуть эту форму.

   :param browserContext: контекст браузера
   :param name: название выборки
   :throws ru.bitec.gs.automation.exception.ElementNotFoundException: если не дождались появления mdi-формы в течении отведенного времени
   :return: форма

waitMdi
^^^^^^^

.. java:method:: public static Form waitMdi(BrowserContext browserContext, String name, String representation) throws ru.bitec.gs.automation.exception.ElementNotFoundException
   :outertype: Form

   Подождать появления на dom-модели MDI-формы по названию выборки и представления и вернуть эту форму.

   :param browserContext: контекст браузера
   :param name: название выборки
   :param representation: название представления
   :throws ru.bitec.gs.automation.exception.ElementNotFoundException: если не дождались появления mdi-формы на dom-модели в течении отведенного времени
   :return: форма

waitMdi
^^^^^^^

.. java:method:: public static Form waitMdi(BrowserContext browserContext, String name, Duration duration) throws ru.bitec.gs.automation.exception.ElementNotFoundException
   :outertype: Form

   Подождать появления на dom-модели MDI-формы по названию выборки в течении указанной продолжительности времени и вернуть эту форму.

   :param browserContext: контекст браузера
   :param name: название выборки
   :param duration: продолжительность времени ожидания
   :throws ru.bitec.gs.automation.exception.ElementNotFoundException: если не дождались появления mdi-формы на dom-модели в течении отведенного времени
   :return: форма

waitMdi
^^^^^^^

.. java:method:: public static Form waitMdi(BrowserContext browserContext, String name, String representation, Duration duration) throws ru.bitec.gs.automation.exception.ElementNotFoundException
   :outertype: Form

   Подождать появления на dom-модели MDI-формы по имени выборки и представления в течение указанного времени и вернуть эту форму.

   :param browserContext: контекст браузера
   :param name: название выборки
   :param representation: название представления
   :param duration: продолжительность времени ожидания
   :throws ru.bitec.gs.automation.exception.ElementNotFoundException: если не дождались появления mdi-формы на dom-модели в течении отведенного времени
   :return: форма

waitModal
^^^^^^^^^

.. java:method:: public static Form waitModal(BrowserContext browserContext, String name) throws ru.bitec.gs.automation.exception.ElementNotFoundException
   :outertype: Form

   Подождать появления на dom-модели модальной формы по названию выборки и вернуть эту форму.

   :param browserContext: контекст браузера
   :param name: название выборки
   :throws ru.bitec.gs.automation.exception.ElementNotFoundException: если не дождались появления модальной формы на dom-модели в течении отведенного времени
   :return: форма

waitModal
^^^^^^^^^

.. java:method:: public static Form waitModal(BrowserContext browserContext, String name, String representation) throws ru.bitec.gs.automation.exception.ElementNotFoundException
   :outertype: Form

   Подождать появления на dom-модели модальной формы с указанным именем выборки и представления и вернуть эту форму.

   :param browserContext: контекст браузера
   :param name: название выборки
   :param representation: название представления
   :throws ru.bitec.gs.automation.exception.ElementNotFoundException: если не дождались появления модальной формы на dom-модели в течении отведенного времени
   :return: форма

waitModal
^^^^^^^^^

.. java:method:: public static Form waitModal(BrowserContext browserContext, String name, Duration duration) throws ru.bitec.gs.automation.exception.ElementNotFoundException
   :outertype: Form

   Подождать появления на dom-модели модальной формы по имени выборки в течение указанного времени и вернуть эту форму.

   :param browserContext: контекст браузера
   :param name: название выборки
   :param duration: продолжительность времени
   :throws ru.bitec.gs.automation.exception.ElementNotFoundException: если не дождались появления модальной формы на dom-модели в течении отведенного времени
   :return: форма

waitModal
^^^^^^^^^

.. java:method:: public static Form waitModal(BrowserContext browserContext, String name, String representation, Duration duration) throws ru.bitec.gs.automation.exception.ElementNotFoundException
   :outertype: Form

   Подождать появления на dom-модели модальной формы с указанным именем выборки и представления в течении указанного времени и вернуть эту форму.

   :param browserContext: контекст браузера
   :param name: название выборки
   :param representation: название представления
   :param duration: продолжительность времени
   :throws ru.bitec.gs.automation.exception.ElementNotFoundException: если не дождались появления модальной формы на dom-модели в течении отведенного времени
   :return: форма