.. java:import:: org.openqa.selenium OutputType

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

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

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

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

.. java:import:: ru.bitec.gs.automation.exception AutomationException

AbstractUiElement
=================

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

.. java:type:: public abstract class AbstractUiElement extends AbstractContextAware implements WithWebElement

   Абстрактный элемент пользовательского интерфейса приложения Global.

   Класс является общим предком для всех классов элементов пользовательского интерфейса.

   Содержит ссылку на элемент :java:ref:`WebElement <org.openqa.selenium.WebElement>` в дереве html-элементов браузера.

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

AbstractUiElement
^^^^^^^^^^^^^^^^^

.. java:constructor:: protected AbstractUiElement(BrowserContext browserContext, WebElement webElement)
   :outertype: AbstractUiElement

AbstractUiElement
^^^^^^^^^^^^^^^^^

.. java:constructor:: protected AbstractUiElement(AbstractUiElement parent, WebElement webElement)
   :outertype: AbstractUiElement

Methods
-------

formatPNodeClass
^^^^^^^^^^^^^^^^

.. java:method:: protected String formatPNodeClass()
   :outertype: AbstractUiElement

   Форматирует имя класса соответствующей P-ноды.

   Имя P-ноды содержится в html-атрибуте :java:ref:`Attributes.DATA_NODE_CLASS <ru.bitec.gs.automation.client.ui.Attributes.DATA_NODE_CLASS>`.
   Используется при поиске :java:ref:`WebElement <org.openqa.selenium.WebElement>`'ов в дереве Html-элементов браузера.

   :return: Имя класса P-ноды.

formatPNodeClass
^^^^^^^^^^^^^^^^

.. java:method:: public static String formatPNodeClass(Class<? extends AbstractUiElement> thisClass)
   :outertype: AbstractUiElement

   Форматирует имя класса P-ноды, которое, по умолчанию, соответствует переданному классу

   :param thisClass: класс
   :return: Имя класса P-ноды.

getNodeClass
^^^^^^^^^^^^

.. java:method:: public String getNodeClass()
   :outertype: AbstractUiElement

   Метод возвращает значение data-атрибута ``data-node.class="PClassName"`` :java:ref:`WebElement <org.openqa.selenium.WebElement>`'а, переданного
   в конструктор.

   :return: Имя класса

getParent
^^^^^^^^^

.. java:method:: public AbstractUiElement getParent()
   :outertype: AbstractUiElement

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

   :return: UI элемент или `null`, если выполнялся глобальный поиск по всему дереву html-элементов.

getScreenshotAs
^^^^^^^^^^^^^^^

.. java:method:: public <X> X getScreenshotAs(OutputType<X> target) throws org.openqa.selenium.WebDriverException, UnsupportedOperationException
   :outertype: AbstractUiElement

   Делает снимок области экрана, соответствующей текущему элементу интерфейса.

   :param <X>: Return type for getScreenshotAs.
   :param target: target type, @see OutputType
   :throws org.openqa.selenium.WebDriverException: on failure.
   :throws UnsupportedOperationException: if the underlying implementation does not support
                                          screenshot capturing.
   :return: Object in which is stored information about the screenshot.

getWebElement
^^^^^^^^^^^^^

.. java:method:: @Override public WebElement getWebElement()
   :outertype: AbstractUiElement

   Возвращает ссылку на элемент :java:ref:`WebElement <org.openqa.selenium.WebElement>` в дереве Html-элементов браузера.

   :return: dom-элемент

isValid
^^^^^^^

.. java:method:: @Override public boolean isValid()
   :outertype: AbstractUiElement

   Метод проверяет валидность ссылки на :java:ref:`WebElement <org.openqa.selenium.WebElement>`.

   Если вызов :java:ref:`WebElement.isDisplayed() <org.openqa.selenium.WebElement.isDisplayed()>` завершается исключением :java:ref:`StaleElementReferenceException <org.openqa.selenium.StaleElementReferenceException>`,
   ссылка считается не валидной.

   :return: true, если ссылка валидна, иначе false.

setParent
^^^^^^^^^

.. java:method:: protected void setParent(AbstractUiElement parent)
   :outertype: AbstractUiElement

setWebElement
^^^^^^^^^^^^^

.. java:method:: protected void setWebElement(WebElement webElement)
   :outertype: AbstractUiElement