Open topic with navigation

com.hp.lft.sdk.web

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

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

- Direct Known Subclasses:
    AreaDescription.Builder
  Enclosing class:
    AreaDescription

      protected abstract static class AreaDescription.Init<T extends AreaDescription.Init<T>>
      extends WebElementDescription.Init<T>

  Helper class for AreaDescription.Builder.

- - ### Constructor Summary

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

  - ### Method Summary

    Modifier and Type | Method and Description
    --- | ---
    `T` | `alt(java.lang.String alt)` Initializes the alternative text that will be displayed instead of the image.
    `T` | `alt(StringProperty alt)` Initializes the alternative text that will be displayed instead of the image.
    `AreaDescription` | `build()` Returns the built description instance (builder pattern).
    `T` | `coords(int[] coords)` Initializes the coordinates of an area in an image-map.
    `T` | `href(java.lang.String href)` Initializes the link's target without the last /.
    `T` | `href(StringProperty href)` Initializes the link's target without the last /.
    `T` | `mapName(java.lang.String mapName)` Initializes the name of the map element the image uses to define the area inside the image.
    `T` | `mapName(StringProperty mapName)` Initializes the name of the map element the image uses to define the area inside the image.
    `T` | `src(java.lang.String src)` Initializes the image source in URL format.
    `T` | `src(StringProperty src)` Initializes the image source in URL format.
    `T` | `target(java.lang.String target)` Initializes the name of the frame that will be navigated when user clicks on the frame.
    `T` | `target(StringProperty target)` Initializes the name of the frame that will be navigated when user clicks on the frame.
    `T` | `type(ImageType type)` Initializes the image type.

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

      `accessibilityName, accessibilityName, cssSelector, cssSelector, role, role, xpath, xpath`

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

      `absoluteLocation, absoluteLocation, absoluteLocation, attribute, attribute, attributes, className, className, id, id, innerHTML, innerHTML, innerText, innerText, location, location, location, name, name, outerHTML, outerHTML, outerText, outerText, size, size, size, style, style, styles, tagName, tagName, title, title, visible`

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

      `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

    - #### build

          public AreaDescription build()

      Description copied from class: `DescriptionBase.Init`
      Returns the built description instance (builder pattern).
      Overrides:
        `build` in class `WebElementDescription.Init<T extends AreaDescription.Init<T>>`
      Returns:
        The built description instance (builder pattern).

    - #### alt

          public T alt(java.lang.String alt)

      Initializes the alternative text that will be displayed instead of the image.
      Parameters:
        `alt` - the alternative text that will be displayed instead of the image.
      Returns:
        the description instance with the update state (builder pattern).

    - #### alt

          public T alt(StringProperty alt)

      Initializes the alternative text that will be displayed instead of the image.
      Parameters:
        `alt` - a StringProperty(or RegExpProperty) representing the alternative text that will be displayed instead of the image.
      Returns:
        the description instance with the update state (builder pattern).

    - #### src

          public T src(java.lang.String src)

      Initializes the image source in URL format.
      Parameters:
        `src` - the image source in URL format.
      Returns:
        the description instance with the update state (builder pattern).

    - #### src

          public T src(StringProperty src)

      Initializes the image source in URL format.
      Parameters:
        `src` - a StringProperty(or RegExpProperty) representing the image source in URL format.
      Returns:
        the description instance with the update state (builder pattern).

    - #### target

          public T target(java.lang.String target)

      Initializes the name of the frame that will be navigated when user clicks on the frame.
      Parameters:
        `target` - the name of the frame that will be navigated when user clicks on the frame.
      Returns:
        the description instance with the update state (builder pattern).

    - #### target

          public T target(StringProperty target)

      Initializes the name of the frame that will be navigated when user clicks on the frame.
      Parameters:
        `target` - a StringProperty(or RegExpProperty) representing the name of the frame that will be navigated when user clicks on the frame.
      Returns:
        the description instance with the update state (builder pattern).

    - #### href

          public T href(java.lang.String href)

      Initializes the link's target without the last /.
      Parameters:
        `href` - the link's target without the last /.
      Returns:
        the description instance with the update state (builder pattern).

    - #### href

          public T href(StringProperty href)

      Initializes the link's target without the last /.
      Parameters:
        `href` - a StringProperty(or RegExpProperty) representing the link's target without the last /.
      Returns:
        the description instance with the update state (builder pattern).

    - #### type

          public T type(ImageType type)

      Initializes the image type.
      Parameters:
        `type` - the image type.
      Returns:
        the description instance with the update state (builder pattern).

    - #### mapName

          public T mapName(java.lang.String mapName)

      Initializes the name of the map element the image uses to define the area inside the image.
      Parameters:
        `mapName` - the name of the map element the image uses to define the area inside the image.
      Returns:
        the description instance with the update state (builder pattern).

    - #### mapName

          public T mapName(StringProperty mapName)

      Initializes the name of the map element the image uses to define the area inside the image.
      Parameters:
        `mapName` - a StringProperty(or RegExpProperty) representing the name of the map element the image uses to define the area inside the image.
      Returns:
        the description instance with the update state (builder pattern).

    - #### coords

          public T coords(int[] coords)

      Initializes the coordinates of an area in an image-map. The coordinates format is determined by the shape of the area, in the following manner:
      shape="rect" - x1,y1,x2,y2.
      shape="circle" - x,y,radius
      shape="poly" - x1,y1,x2,y2,..,xn,yn
      Parameters:
        `coords` - the coordinates of an area in an image-map.
      Returns:
        the description instance with the update state (builder pattern).