Open topic with navigation

com.hp.lft.sdk.web

## Class WebBaseDescription.Init<T extends WebBaseDescription.Init<T>>

- java.lang.Object
- - com.hp.lft.sdk.DescriptionBase.Init<T>
  - - com.hp.lft.sdk.web.WebBaseDescription.Init<T>

- Direct Known Subclasses:
    FrameDescription.Init, WebElementDescription.Init
  Enclosing class:
    WebBaseDescription

      protected abstract static class WebBaseDescription.Init<T extends WebBaseDescription.Init<T>>
      extends DescriptionBase.Init<T>

  Helper class for derived Builder classes.

- - ### Constructor Summary

    Modifier | Constructor and Description
    --- | ---
    `protected` | `Init()`

  - ### Method Summary

    Modifier and Type | Method and Description
    --- | ---
    `T` | `absoluteLocation(java.lang.Integer absX, java.lang.Integer absY)` Initializes the object's absolute coordinates relative to the screen (in pixels).
    `T` | `absoluteLocation(LocationProperty absLocation)` Initializes the object's absolute coordinates relative to the screen (in pixels).
    `T` | `absoluteLocation(java.awt.Point absLocation)` Initializes the object's absolute coordinates relative to the screen (in pixels).
    `T` | `attribute(java.lang.String name, java.lang.String value)` Initializes the test object DOM attributes.
    `T` | `attribute(java.lang.String name, StringProperty value)` Initializes the test object DOM attributes.
    `T` | `attributes(java.util.Map<java.lang.String,StringProperty> attributes)` Initializes the test object DOM attributes.
    `T` | `className(java.lang.String className)` Initializes the element's CSS class
    `T` | `className(StringProperty className)` Initializes the element's CSS class
    `T` | `id(java.lang.String id)` Initializes the element's HTML id.
    `T` | `id(StringProperty id)` Initializes the element's HTML id.
    `T` | `innerHTML(java.lang.String innerHTML)` Initializes the element's HTML not including the current element.
    `T` | `innerHTML(StringProperty innerHTML)` Initializes the element's HTML not including the current element.
    `T` | `innerText(java.lang.String innerText)` Initializes the element's text (including all sub elements), not including the wrapped text.
    `T` | `innerText(StringProperty innerText)` Initializes the element's text (including all sub elements), not including the wrapped text.
    `T` | `location(java.lang.Integer x, java.lang.Integer y)` Initializes the object's coordinates relative to the parent window (in pixels).
    `T` | `location(LocationProperty location)` Initializes the object's coordinates relative to the parent window (in pixels).
    `T` | `location(java.awt.Point location)` Initializes the object's coordinates relative to the parent window (in pixels).
    `T` | `name(java.lang.String name)` Initializes the element's name property.
    `T` | `name(StringProperty name)` Initializes the element's name property.
    `T` | `outerHTML(java.lang.String outerHTML)` Initializes the element's HTML including the current element.
    `T` | `outerHTML(StringProperty outerHTML)` Initializes the element's HTML including the current element.
    `T` | `outerText(java.lang.String outerText)` Initializes the element's text (including all sub elements) with the element's wrapping text.
    `T` | `outerText(StringProperty outerText)` Initializes the element's text (including all sub elements) with the element's wrapping text.
    `T` | `size(java.awt.Dimension size)` Initializes the test object's size (in pixels).
    `T` | `size(java.lang.Integer width, java.lang.Integer height)` Initializes the test object's size (in pixels).
    `T` | `size(SizeProperty size)` Initializes the test object's size (in pixels).
    `T` | `style(java.lang.String styleName, java.lang.String value)` Initializes the test object DOM attributes.
    `T` | `style(java.lang.String styleName, StringProperty value)` Initializes the test object DOM attributes.
    `T` | `styles(java.util.Map<java.lang.String,StringProperty> styles)` Initializes the test object computed style.
    `T` | `tagName(java.lang.String tagName)` Initializes the element's tag name.
    `T` | `tagName(StringProperty tagName)` Initializes the element's tag name.
    `T` | `title(java.lang.String title)` Initializes the element's title attribute (provides additional information on the element).
    `T` | `title(StringProperty title)` Initializes the element's title attribute (provides additional information on the element).
    `T` | `visible(java.lang.Boolean isVisible)` Initializes whether the current element is visible.

    - ### Methods inherited from class com.hp.lft.sdk.DescriptionBase.Init

      `build, index, self, vri, vri`

    - ### Methods inherited from class java.lang.Object

      `clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

- - ### Constructor Detail

    - #### Init

          protected Init()

  - ### Method Detail

    - #### tagName

          public T tagName(java.lang.String tagName)

      Initializes the element's tag name.
      Parameters:
        `tagName` - the element's tag name.
      Returns:
        the description instance with the update state (builder pattern).

    - #### tagName

          public T tagName(StringProperty tagName)

      Initializes the element's tag name.
      Parameters:
        `tagName` - a StringProperty(or RegExpProperty) representing the element's tag name.
      Returns:
        the description instance with the update state (builder pattern).

    - #### id

          public T id(java.lang.String id)

      Initializes the element's HTML id.
      Parameters:
        `id` - the element's HTML id.
      Returns:
        the description instance with the update state (builder pattern).

    - #### id

          public T id(StringProperty id)

      Initializes the element's HTML id.
      Parameters:
        `id` - a StringProperty(or RegExpProperty) representing the element's HTML id.
      Returns:
        the description instance with the update state (builder pattern).

    - #### className

          public T className(java.lang.String className)

      Initializes the element's CSS class
      Parameters:
        `className` - the element's CSS class
      Returns:
        the description instance with the update state (builder pattern).

    - #### className

          public T className(StringProperty className)

      Initializes the element's CSS class
      Parameters:
        `className` - a StringProperty(or RegExpProperty) representing the element's CSS class
      Returns:
        the description instance with the update state (builder pattern).

    - #### innerHTML

          public T innerHTML(java.lang.String innerHTML)

      Initializes the element's HTML not including the current element.
      Parameters:
        `innerHTML` - the element's HTML not including the current element.
      Returns:
        the description instance with the update state (builder pattern).

    - #### innerHTML

          public T innerHTML(StringProperty innerHTML)

      Initializes the element's HTML not including the current element.
      Parameters:
        `innerHTML` - a StringProperty(or RegExpProperty) representing the element's HTML not including the current element.
      Returns:
        the description instance with the update state (builder pattern).

    - #### outerHTML

          public T outerHTML(java.lang.String outerHTML)

      Initializes the element's HTML including the current element.
      Parameters:
        `outerHTML` - the element's HTML including the current element.
      Returns:
        the description instance with the update state (builder pattern).

    - #### outerHTML

          public T outerHTML(StringProperty outerHTML)

      Initializes the element's HTML including the current element.
      Parameters:
        `outerHTML` - a StringProperty(or RegExpProperty) representing the element's HTML including the current element.
      Returns:
        the description instance with the update state (builder pattern).

    - #### innerText

          public T innerText(java.lang.String innerText)

      Initializes the element's text (including all sub elements), not including the wrapped text.
      Parameters:
        `innerText` - the element's text (including all sub elements), not including the wrapped text.
      Returns:
        the description instance with the update state (builder pattern).

    - #### innerText

          public T innerText(StringProperty innerText)

      Initializes the element's text (including all sub elements), not including the wrapped text.
      Parameters:
        `innerText` - a StringProperty(or RegExpProperty) representing the element's text (including all sub elements), not including the wrapped text.
      Returns:
        the description instance with the update state (builder pattern).

    - #### outerText

          public T outerText(java.lang.String outerText)

      Initializes the element's text (including all sub elements) with the element's wrapping text.
      Parameters:
        `outerText` - the element's text (including all sub elements) with the element's wrapping text.
      Returns:
        the description instance with the update state (builder pattern).

    - #### outerText

          public T outerText(StringProperty outerText)

      Initializes the element's text (including all sub elements) with the element's wrapping text.
      Parameters:
        `outerText` - a StringProperty(or RegExpProperty) representing the element's text (including all sub elements) with the element's wrapping text.
      Returns:
        the description instance with the update state (builder pattern).

    - #### name

          public T name(java.lang.String name)

      Initializes the element's name property.
      Parameters:
        `name` - the element's name property.
      Returns:
        the description instance with the update state (builder pattern).

    - #### name

          public T name(StringProperty name)

      Initializes the element's name property.
      Parameters:
        `name` - a StringProperty(or RegExpProperty) representing the element's name property.
      Returns:
        the description instance with the update state (builder pattern).

    - #### title

          public T title(java.lang.String title)

      Initializes the element's title attribute (provides additional information on the element).
      Parameters:
        `title` - the element's title attribute (provides additional information on the element).
      Returns:
        the description instance with the update state (builder pattern).

    - #### title

          public T title(StringProperty title)

      Initializes the element's title attribute (provides additional information on the element).
      Parameters:
        `title` - a StringProperty(or RegExpProperty) representing the element's title attribute (provides additional information on the element).
      Returns:
        the description instance with the update state (builder pattern).

    - #### visible

          public T visible(java.lang.Boolean isVisible)

      Initializes whether the current element is visible.
      Parameters:
        `isVisible` - whether the current element is visible.
      Returns:
        the description instance with the update state (builder pattern).

    - #### location

          public T location(java.lang.Integer x,
                            java.lang.Integer y)

      Initializes the object's coordinates relative to the parent window (in pixels).
      Parameters:
        `x` - the X coordinate of the test object location.
        `y` - the Y coordinate of the test object location.
      Returns:
        the description instance with the update state (builder pattern).

    - #### location

          public T location(LocationProperty location)

      Initializes the object's coordinates relative to the parent window (in pixels).
      Parameters:
        `location` - a LocationProperty representing the object's coordinates relative to the parent window (in pixels).
      Returns:
        the description instance with the update state (builder pattern).

    - #### location

          public T location(java.awt.Point location)

      Initializes the object's coordinates relative to the parent window (in pixels).
      Parameters:
        `location` - a Point representing the object's coordinates relative to the parent window (in pixels).
      Returns:
        the description instance with the update state (builder pattern).

    - #### absoluteLocation

          public T absoluteLocation(java.lang.Integer absX,
                                    java.lang.Integer absY)

      Initializes the object's absolute coordinates relative to the screen (in pixels). 0,0 is always the top-left corner of the (primary) monitor.
      Parameters:
        `absX` - the absolute X coordinate of the test object location.
        `absY` - the absolute Y coordinate of the test object location.
      Returns:
        the description instance with the update state (builder pattern).

    - #### absoluteLocation

          public T absoluteLocation(LocationProperty absLocation)

      Initializes the object's absolute coordinates relative to the screen (in pixels). 0,0 is always the top-left corner of the (primary) monitor.
      Parameters:
        `absLocation` - a LocationProperty representing the object's absolute coordinates relative to the screen (in pixels).
      Returns:
        the description instance with the update state (builder pattern).

    - #### absoluteLocation

          public T absoluteLocation(java.awt.Point absLocation)

      Initializes the object's absolute coordinates relative to the screen (in pixels). 0,0 is always the top-left corner of the (primary) monitor.
      Parameters:
        `absLocation` - a Point representing the object's absolute coordinates relative to the screen (in pixels).
      Returns:
        the description instance with the update state (builder pattern).

    - #### size

          public T size(SizeProperty size)

      Initializes the test object's size (in pixels).
      Parameters:
        `size` - the test object's size (in pixels).
      Returns:
        the description instance with the update state (builder pattern).

    - #### size

          public T size(java.lang.Integer width,
                        java.lang.Integer height)

      Initializes the test object's size (in pixels).
      Parameters:
        `width` - the width of the test object (in pixels).
        `height` - the height of the test object (in pixels).
      Returns:
        the description instance with the update state (builder pattern).

    - #### size

          public T size(java.awt.Dimension size)

      Initializes the test object's size (in pixels).
      Parameters:
        `size` - the test object's size (in pixels).
      Returns:
        the description instance with the update state (builder pattern).

    - #### attributes

          public T attributes(java.util.Map<java.lang.String,StringProperty> attributes)

      Initializes the test object DOM attributes.
      Parameters:
        `attributes` - the attributes the describe the test object by.
      Returns:
        the description instance with the update state (builder pattern).

    - #### attribute

          public T attribute(java.lang.String name,
                             java.lang.String value)

      Initializes the test object DOM attributes.
      Parameters:
        `name` - the attribute name to be added to the attributes collection the describe the test object by.
        `value` - the attribute value to be added to the attributes collection the describe the test object by.
      Returns:
        the description instance with the update state (builder pattern).

    - #### attribute

          public T attribute(java.lang.String name,
                             StringProperty value)

      Initializes the test object DOM attributes.
      Parameters:
        `name` - the attribute name to be added to the attributes collection the describe the test object by.
        `value` - the attribute value to be added to the attributes collection the describe the test object by.
      Returns:
        the description instance with the update state (builder pattern).

    - #### styles

          public T styles(java.util.Map<java.lang.String,StringProperty> styles)

      Initializes the test object computed style.
      Parameters:
        `styles` - the computed style to describe the test object by.
      Returns:
        the description instance with the update state (builder pattern).

    - #### style

          public T style(java.lang.String styleName,
                         java.lang.String value)

      Initializes the test object DOM attributes.
      Parameters:
        `styleName` - the style name to be added to the styles collection the describe the test object by.
        `value` - the style value to be added to the styles collection the describe the test object by.
      Returns:
        the description instance with the update state (builder pattern).

    - #### style

          public T style(java.lang.String styleName,
                         StringProperty value)

      Initializes the test object DOM attributes.
      Parameters:
        `styleName` - the style name to be added to the styles collection the describe the test object by.
        `value` - the style value to be added to the styles collection the describe the test object by.
      Returns:
        the description instance with the update state (builder pattern).