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

.. java:import:: ru.bitec.gs.automation.client.ui AbstractUiElement

.. java:import:: ru.bitec.gs.automation.client.ui Selection

.. java:import:: ru.bitec.gs.automation.client.ui.layout.bar ToolBar

.. java:import:: ru.bitec.gs.automation.client.ui.layout.tab TabPanel

.. java:import:: ru.bitec.gs.automation.client.ui.layout.view AbstractView

.. java:import:: ru.bitec.gs.automation.client.ui.layout.view.filter FilterPanel

Frame
=====

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

.. java:type:: public class Frame extends AbstractUiElement

   .. versionadded:: 1.1.0 Добавлен метод получения карточки фильтров фрейма. Методы приведены к :ref:`соглашению по именам<gsauto_namingconvensions>`.

   Прямоугольный элемент интерфейса группирующий: Панель инструментов :java:ref:`ToolBar <ru.bitec.gs.automation.client.ui.layout.bar.ToolBar>` и Главный контрол фрейма :java:ref:`AbstractView <ru.bitec.gs.automation.client.ui.layout.view.AbstractView>`.

   .. seealso::

      | :java:ref:`ToolBar <ru.bitec.gs.automation.client.ui.layout.bar.ToolBar>`
      | :java:ref:`TabPanel <ru.bitec.gs.automation.client.ui.layout.tab.TabPanel>`
      | :java:ref:`AbstractView <ru.bitec.gs.automation.client.ui.layout.view.AbstractView>`
      | :java:ref:`FilterPanel <ru.bitec.gs.automation.client.ui.layout.view.filter.FilterPanel>`

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

Frame
^^^^^

.. java:constructor:: public Frame(Selection selection, WebElement webElement)
   :outertype: Frame

Methods
-------

filters
^^^^^^^

.. java:method:: public FilterPanel filters() throws ElementNotFoundException
   :outertype: Frame

   .. versionadded:: 1.1.0

   Получить карточку фильтров :java:ref:`FilterPanel <ru.bitec.gs.automation.client.ui.layout.view.filter.FilterPanel>` фрейма.

   :throws ElementNotFoundException: если не удалось получить карточку фильтров фрейма
   :return: карточка фильтров.

getParent
^^^^^^^^^

.. java:method:: @Override public Selection getParent()
   :outertype: Frame

   Возвращает ссылку на UI-элемент, от которого выполнялся поиск текущего элемента. Нет гарантии, что
   будет возвращён непосредственный родитель. Между текущим элементом и возвращённым, могут находить другие элементы.

getSelectionId
^^^^^^^^^^^^^^

.. java:method:: protected String getSelectionId()
   :outertype: Frame

tabpanel
^^^^^^^^

.. java:method:: public TabPanel tabpanel() throws ElementNotFoundException
   :outertype: Frame

   Возвращает панель вкладок :java:ref:`TabPanel <ru.bitec.gs.automation.client.ui.layout.tab.TabPanel>` фрейма выборки.

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

toolbar
^^^^^^^

.. java:method:: public ToolBar toolbar() throws ElementNotFoundException
   :outertype: Frame

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

   Получить панель инструментов :java:ref:`ToolBar <ru.bitec.gs.automation.client.ui.layout.bar.ToolBar>` фрейма.

   :throws ElementNotFoundException: если не найден
   :return: панель инструментов.

view
^^^^

.. java:method:: @SuppressWarnings public <V extends AbstractView> V view() throws AutomationException
   :outertype: Frame

   .. versionadded:: 1.1.0 Добавлена поддержка вида фрейма :java:ref:`Tree <ru.bitec.gs.automation.client.ui.layout.view.table.Tree>`.

   Получить вид фрейма.

   :param <V>: тип вида фрейма
   :throws AutomationException: при неизвестном виде фрейма.
   :return: вид фрейма

   .. seealso::

      | :java:ref:`AbstractView <ru.bitec.gs.automation.client.ui.layout.view.AbstractView>`
      | :java:ref:`Grid <ru.bitec.gs.automation.client.ui.layout.view.table.Grid>`
      | :java:ref:`Card <ru.bitec.gs.automation.client.ui.layout.view.card.Card>`
      | :java:ref:`Tree <ru.bitec.gs.automation.client.ui.layout.view.table.Tree>`

wait
^^^^

.. java:method:: public static Frame wait(Selection parent) throws org.openqa.selenium.TimeoutException
   :outertype: Frame

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

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

   :param parent: Выборка, на которой ожидается фрейм.
   :throws org.openqa.selenium.TimeoutException: если не удалось дождаться появления фрейма на dom-модели в течение времени ожидания
   :return: фрейм