.. java:import:: java.time Duration .. java:import:: java.util Optional .. java:import:: org.openqa.selenium WebElement .. java:import:: ru.bitec.gs.automation.client BrowserContext AbstractForm ============ .. java:package:: ru.bitec.gs.automation.client.ui :noindex: .. java:type:: public abstract class AbstractForm extends AbstractUiElement .. versionadded:: 1.1.0 Добавлены методы ожидания выборки. Названия методов и их сигнатуры приведены к :ref:`соглашению по именам` (см. описания соответствующих методов). Абстрактная форма приложения. Предоставляет методы, обеспечивающие взаимодействие с формами. .. seealso:: | :java:ref:`AbstractForm.OpenType ` Constructors ------------ AbstractForm ^^^^^^^^^^^^ .. java:constructor:: protected AbstractForm(BrowserContext browserContext, WebElement webElement) :outertype: AbstractForm Methods ------- find ^^^^ .. java:method:: static Optional find(BrowserContext browserContext, Name name, AbstractForm.OpenType openType) :outertype: AbstractForm .. versionadded:: 1.1.0 Сигнатура приведена к :ref:`соглашению по именам` (ранее возвращалась форма, теперь возвращается опциональная форма). Метод выполняет поиск html-элемента, соответствующего форме с указанными именем и типом открытия, в дереве html-элементов браузера. :param browserContext: контекст браузера :param name: имя формы :param openType: тип открытия :return: опциональная форма findAll ^^^^^^^ .. java:method:: static AbstractForm[] findAll(BrowserContext browserContext, AbstractForm.OpenType openType) :outertype: AbstractForm Метод выполняет поиск html-элементов, соответствующих формам с указанными типом открытия, в дереве html-элементов браузера. :param browserContext: контекст браузера :param openType: тип открытия :return: массив форм .. seealso:: | :java:ref:`AbstractForm.OpenType ` findAll ^^^^^^^ .. java:method:: static AbstractForm[] findAll(BrowserContext browserContext) :outertype: AbstractForm Метод выполняет поиск html-элементов, соответствующих формам, в дереве html-элементов браузера. :param browserContext: контекст браузера :return: массив форм findBySimpleName ^^^^^^^^^^^^^^^^ .. java:method:: static Optional findBySimpleName(BrowserContext browserContext, Name name, AbstractForm.OpenType openType) :outertype: AbstractForm .. versionadded:: 1.1.0 Сигнатура приведена к :ref:`соглашению по именам` (ранее возвращалась форма, теперь возвращается опциональная форма). Метод выполняет поиск html-элемента, соответствующего форме с указанными простым именем и типом открытия, в дереве html-элементов браузера. :param browserContext: контекст браузера :param name: простое имя формы :param openType: тип открытия :return: опциональная форма .. seealso:: | :java:ref:`Name.getSimpleName() ` get ^^^ .. java:method:: static AbstractForm get(BrowserContext browserContext, Name name, AbstractForm.OpenType openType) throws ElementNotFoundException :outertype: AbstractForm .. versionadded:: 1.1.0 Метод возвращает html-элемент, соответствующий форме с указанными именем и типом открытия, в дереве html-элементов браузера. :param browserContext: контекст браузера :param name: имя формы :param openType: тип открытия :throws ElementNotFoundException: если форма не найдена на dom-модели :return: форма getBySimpleName ^^^^^^^^^^^^^^^ .. java:method:: static AbstractForm getBySimpleName(BrowserContext browserContext, Name simpleName, AbstractForm.OpenType openType) throws ElementNotFoundException :outertype: AbstractForm .. versionadded:: 1.1.0 Метод возвращает html-элемент, соответствующий форме с указанными простым именем и типом открытия, в дереве html-элементов браузера. :param browserContext: контекст браузера :param simpleName: простое имя формы :param openType: тип открытия :throws ElementNotFoundException: если форма не найдена на dom-модели :return: форма .. seealso:: | :java:ref:`Name.getSimpleName() ` getName ^^^^^^^ .. java:method:: public String getName() :outertype: AbstractForm Возвращает имя формы. Именем формы является имя и отображение главной выборки. Примеры возможных значений имён для MDI/Modal/Lookup-форм: * gtk-company.namespace.module.Module_SomeName#Representation * gtk@sbtname-company.namespace.module.Module_SomeName#Representation :return: Имя формы getOpenType ^^^^^^^^^^^ .. java:method:: public AbstractForm.OpenType getOpenType() :outertype: AbstractForm Возвращает тип открытия формы. :return: Тип открытия getQualifiedName ^^^^^^^^^^^^^^^^ .. java:method:: public Name getQualifiedName() :outertype: AbstractForm Возвращает квалифицированное имя формы. :return: Квалифицированное имя. mainSelection ^^^^^^^^^^^^^ .. java:method:: public Selection mainSelection() throws ElementNotFoundException :outertype: AbstractForm .. versionadded:: 1.1.0 Метод приведен к :ref:`соглашению по именам` (ранее выбрасывались исключения типа :java:ref:`NoSuchElementException `). Ищет на форме и возвращает главную выборку этой формы. :throws ElementNotFoundException: если главная выборка не обнаружена на dom-модели :return: Выборка. selection ^^^^^^^^^ .. java:method:: public Selection selection(String name) throws ElementNotFoundException :outertype: AbstractForm .. versionadded:: 1.1.0 Метод приведен к :ref:`соглашению по именам` (ранее выбрасывались исключения типа :java:ref:`NoSuchElementException `). Ищет на форме и возвращает выборку с указанными именем и отображением. :param name: имя выборки :throws ElementNotFoundException: если выборка на dom-модели не обнаружена :return: Выборка selection ^^^^^^^^^ .. java:method:: public Selection selection(String name, String representation) throws ElementNotFoundException :outertype: AbstractForm .. versionadded:: 1.1.0 Метод приведен к :ref:`соглашению по именам` (ранее выбрасывались исключения типа :java:ref:`NoSuchElementException `). Ищет на форме и возвращает выборку с указанными именем и отображением. :param name: имя выборки :param representation: отображение :throws ElementNotFoundException: если выборка на dom-модели не обнаружена :return: Выборка wait ^^^^ .. java:method:: static AbstractForm wait(BrowserContext browserContext, Name name, AbstractForm.OpenType openType) throws ElementNotFoundException :outertype: AbstractForm .. versionadded:: 1.1.0 Метод приведен к :ref:`соглашению по именам` (ранее выбрасывались исключения типа :java:ref:`TimeoutException `). Метод выполняет ожидание появления html-элемента, соответствующего форме с указанными именем и типом открытия, в дереве html-элементов браузера. :param browserContext: контекст браузера :param name: имя формы :param openType: тип открытия :throws ElementNotFoundException: если не удалось дождаться появления формы на dom-модели :return: Форма wait ^^^^ .. java:method:: static AbstractForm wait(BrowserContext browserContext, Name name, AbstractForm.OpenType openType, Duration duration) throws ElementNotFoundException :outertype: AbstractForm .. versionadded:: 1.1.0 Метод приведен к :ref:`соглашению по именам` (ранее выбрасывались исключения типа :java:ref:`TimeoutException `). Метод выполняет ожидание появления html-элемента, соответствующего форме с указанными именем и типом открытия, в дереве html-элементов браузера. :param browserContext: контекст браузера :param name: имя формы :param openType: тип открытия :param duration: длительность ожидания :throws ElementNotFoundException: если не удалось дождаться появления формы на dom-модели :return: Форма waitBySimpleName ^^^^^^^^^^^^^^^^ .. java:method:: static AbstractForm waitBySimpleName(BrowserContext browserContext, Name name, AbstractForm.OpenType openType) throws ElementNotFoundException :outertype: AbstractForm .. versionadded:: 1.1.0 Метод приведен к :ref:`соглашению по именам` (ранее выбрасывались исключения типа :java:ref:`TimeoutException `). Метод выполняет ожидание появления html-элемента, соответствующего форме с указанными простым именем и типом открытия, в дереве html-элементов браузера. :param browserContext: контекст браузера :param name: имя формы :param openType: тип открытия :throws ElementNotFoundException: если не удалось дождаться появления формы на dom-модели :return: Форма .. seealso:: | :java:ref:`Name.getSimpleName() ` waitBySimpleName ^^^^^^^^^^^^^^^^ .. java:method:: static AbstractForm waitBySimpleName(BrowserContext browserContext, Name name, AbstractForm.OpenType openType, Duration duration) throws ElementNotFoundException :outertype: AbstractForm .. versionadded:: 1.1.0 Метод приведен к :ref:`соглашению по именам` (ранее выбрасывались исключения типа :java:ref:`TimeoutException `). Метод выполняет ожидание появления html-элемента, соответствующего форме с указанными простым именем и типом открытия, в дереве html-элементов браузера. :param browserContext: контекст браузера :param name: имя формы :param openType: тип открытия :param duration: длительность ожидания :throws ElementNotFoundException: если не удалось дождаться появления формы на dom-модели :return: Форма .. seealso:: | :java:ref:`Name.getSimpleName() ` waitClosing ^^^^^^^^^^^ .. java:method:: static void waitClosing(BrowserContext browserContext, Name name, AbstractForm.OpenType openType) throws AutomationException :outertype: AbstractForm .. versionadded:: 1.1.0 Метод приведен к :ref:`соглашению по именам` (ранее выбрасывались исключения типа :java:ref:`TimeoutException `). Метод ожидает закрытия формы с указанными именем и типом открытия. :param browserContext: контекст браузера :param name: имя формы :param openType: тип открытия :throws AutomationException: если не удалось дождаться закрытия формы waitClosing ^^^^^^^^^^^ .. java:method:: static void waitClosing(BrowserContext browserContext, Name name, AbstractForm.OpenType openType, Duration duration) throws AutomationException :outertype: AbstractForm .. versionadded:: 1.1.0 Метод приведен к :ref:`соглашению по именам` (ранее выбрасывались исключения типа :java:ref:`TimeoutException `). Метод ожидает закрытия формы с указанными именем и типом открытия. :param browserContext: контекст браузера :param name: имя формы :param openType: тип открытия :param duration: длительность ожидания закрытия :throws AutomationException: если не удалось дождаться закрытия формы waitClosingBySimpleName ^^^^^^^^^^^^^^^^^^^^^^^ .. java:method:: static void waitClosingBySimpleName(BrowserContext browserContext, Name name, AbstractForm.OpenType openType) throws AutomationException :outertype: AbstractForm .. versionadded:: 1.1.0 Метод приведен к :ref:`соглашению по именам` (ранее выбрасывались исключения типа :java:ref:`TimeoutException `). Метод ожидает закрытия формы с указанными простым именем и типом открытия. :param browserContext: контекст браузера :param name: имя формы :param openType: тип открытия :throws AutomationException: если не удалось дождаться закрытия формы waitClosingBySimpleName ^^^^^^^^^^^^^^^^^^^^^^^ .. java:method:: static void waitClosingBySimpleName(BrowserContext browserContext, Name name, AbstractForm.OpenType openType, Duration duration) throws org.openqa.selenium.TimeoutException :outertype: AbstractForm Метод ожидает закрытия формы с указанными именем и типом открытия. :param browserContext: контекст браузера :param name: имя формы :param openType: тип открытия :param duration: длительность ожидания закрытия :throws org.openqa.selenium.TimeoutException: если не удалось дождаться закрытия формы waitSelection ^^^^^^^^^^^^^ .. java:method:: public Selection waitSelection(String name) throws ElementNotFoundException :outertype: AbstractForm .. versionadded:: 1.1.0 Ожидает появления на форме и возвращает выборку с указанными именем и отображением. :param name: имя выборки :throws ElementNotFoundException: если не удалось дождаться появления выборки на dom-модели :return: Выборка waitSelection ^^^^^^^^^^^^^ .. java:method:: public Selection waitSelection(String name, String representation) throws ElementNotFoundException :outertype: AbstractForm .. versionadded:: 1.1.0 Ожидает появления на форме и возвращает выборку с указанными именем и отображением. :param name: имя выборки :param representation: отображение :throws ElementNotFoundException: если не удалось дождаться появления выборки на dom-модели :return: Выборка