Open topic with navigation

com.hp.lft.sdk.web

## Class ImageDescription

- java.lang.Object
- - com.hp.lft.sdk.internal.PropertiesDescriptionBase
  - - com.hp.lft.sdk.PropertiesDescription
    - - com.hp.lft.sdk.DescriptionBase
      - - com.hp.lft.sdk.web.WebBaseDescription
        - - com.hp.lft.sdk.web.WebElementDescription
          - - com.hp.lft.sdk.web.ImageDescription

- All Implemented Interfaces:
    CloneableObject, Description, com.hp.lft.sdk.internal.DescriptionWithVri, java.lang.Cloneable

      public class ImageDescription
      extends WebElementDescription

  The description of a Web Image test object.

- - ### Nested Class Summary

    Modifier and Type | Class and Description
    --- | ---
    `static class` | `ImageDescription.Builder` This class can be used to construct an instance of the ImageDescription class using the builder pattern.
    `protected static class` | `ImageDescription.Init<T extends ImageDescription.Init<T>>` Helper class for ImageDescription.Builder.

  - ### Field Summary

    - ### Fields inherited from class com.hp.lft.sdk.internal.PropertiesDescriptionBase

      `properties`

  - ### Constructor Summary

    Modifier | Constructor and Description
    --- | ---
    `` | `ImageDescription()` Initializes a new instance of the Image class.
    `protected` | `ImageDescription(ImageDescription.Init<?> init)` Initializes a new instance of the ImageDescription class using the Builder pattern.

  - ### Method Summary

    Modifier and Type | Method and Description
    --- | ---
    `StringProperty` | `getAlt()` Returns the image's tooltip text..
    `StringProperty` | `getHref()` Returns the location to which the browser navigates when the image is clicked.
    `StringProperty` | `getSrc()` Returns the image source in URL format.
    `StringProperty` | `getTarget()` Returns the name of the target frame of the navigation.
    `ImageType` | `getType()` Returns the image type.
    `void` | `setAlt(java.lang.String alt)` Sets the image's tooltip text.
    `void` | `setAlt(StringProperty alt)` Sets the image's tooltip text.
    `void` | `setHref(java.lang.String href)` Sets the location to which the browser navigates when the image is clicked.
    `void` | `setHref(StringProperty href)` Sets the location to which the browser navigates when the image is clicked.
    `void` | `setSrc(java.lang.String src)` Sets the image source in URL format.
    `void` | `setSrc(StringProperty src)` Sets the image source in URL format.
    `void` | `setTarget(java.lang.String target)` Sets the name of the frame that will be navigated when user clicks on the frame.
    `void` | `setTarget(StringProperty target)` Sets the name of the frame that will be navigated when user clicks on the frame.
    `void` | `setType(ImageType type)` Sets the image type.

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

      `getAccessibilityName, getCSSSelector, getRole, getXPath, setAccessibilityName, setAccessibilityName, setCSSSelector, setCSSSelector, setRole, setRole, setXPath, setXPath`

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

      `cloneTo, getAbsoluteLocation, getAttributes, getClassName, getId, getInnerHTML, getInnerText, getLocation, getName, getOuterHTML, getOuterText, getSize, getStyles, getTagName, getTitle, isVisible, setAbsoluteLocation, setAbsoluteLocation, setAbsoluteLocation, setAttributes, setClassName, setClassName, setId, setId, setInnerHTML, setInnerHTML, setInnerText, setInnerText, setLocation, setLocation, setLocation, setName, setName, setOuterHTML, setOuterHTML, setOuterText, setOuterText, setSize, setSize, setSize, setStyles, setTagName, setTagName, setTitle, setTitle, setVisible`

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

      `getIndex, getIndexType, getVRI, setIndex, setIndexType, setVRI, setVRI`

    - ### Methods inherited from class com.hp.lft.sdk.PropertiesDescription

      `clone`

    - ### Methods inherited from class com.hp.lft.sdk.internal.PropertiesDescriptionBase

      `getValueAs, getValueAsStringProperty, insertValue`

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

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

    - ### Methods inherited from interface com.hp.lft.sdk.CloneableObject

      `clone`

- - ### Constructor Detail

    - #### ImageDescription

          public ImageDescription()

      Initializes a new instance of the Image class.

    - #### ImageDescription

          protected ImageDescription(ImageDescription.Init<?> init)

      Initializes a new instance of the ImageDescription class using the Builder pattern.
      Parameters:
        `init` - the Builder pattern.

  - ### Method Detail

    - #### setAlt

          public void setAlt(StringProperty alt)

      Sets the image's tooltip text.
      Parameters:
        `alt` - a StringProperty(or RegExpProperty) representing the image's tooltip text.

    - #### setAlt

          public void setAlt(java.lang.String alt)

      Sets the image's tooltip text.
      Parameters:
        `alt` - the image's tooltip text.

    - #### getAlt

          public StringProperty getAlt()

      Returns the image's tooltip text..
      Returns:
        the image's tooltip text..

    - #### setSrc

          public void setSrc(StringProperty src)

      Sets the image source in URL format.
      Parameters:
        `src` - a StringProperty(or RegExpProperty) representing the image source in URL format.

    - #### setSrc

          public void setSrc(java.lang.String src)

      Sets the image source in URL format.
      Parameters:
        `src` - the image source in URL format.

    - #### getSrc

          public StringProperty getSrc()

      Returns the image source in URL format.
      Returns:
        the image source in URL format.

    - #### setTarget

          public void setTarget(StringProperty target)

      Sets 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.

    - #### setTarget

          public void setTarget(java.lang.String target)

      Sets 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.

    - #### getTarget

          public StringProperty getTarget()

      Returns the name of the target frame of the navigation.
      Returns:
        the name of the target frame of the navigation. Possible values: Possible values: Any valid HTML target attribute value, for example, framename, _blank, or _self.

    - #### setHref

          public void setHref(StringProperty href)

      Sets the location to which the browser navigates when the image is clicked.
      Parameters:
        `href` - a StringProperty(or RegExpProperty) representing the location to which the browser navigates when the image is clicked.

    - #### setHref

          public void setHref(java.lang.String href)

      Sets the location to which the browser navigates when the image is clicked.
      Parameters:
        `href` - the location to which the browser navigates when the image is clicked.

    - #### getHref

          public StringProperty getHref()

      Returns the location to which the browser navigates when the image is clicked.
      Returns:
        the location to which the browser navigates when the image is clicked.

    - #### setType

          public void setType(ImageType type)

      Sets the image type.
      Parameters:
        `type` - the image type.

    - #### getType

          public ImageType getType()

      Returns the image type.
      Returns:
        the image type.