Open topic with navigation

com.hp.lft.sdk.web

## Class LinkDescription

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

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

      public class LinkDescription
      extends WebElementDescription

  The description of a Web Link test object.

- - ### Nested Class Summary

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

  - ### Field Summary

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

      `properties`

  - ### Constructor Summary

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

  - ### Method Summary

    Modifier and Type | Method and Description
    --- | ---
    `StringProperty` | `getBackgroundColor()` Returns the link's background color.
    `StringProperty` | `getColor()` Returns the link's color.
    `StringProperty` | `getFontName()` Returns the link's font name.
    `StringProperty` | `getHref()` Returns the location to which the browser navigates when the image is clicked.
    `StringProperty` | `getTarget()` Returns the target frame of the navigation.
    `void` | `setBackgroundColor(java.lang.String color)` Sets the link's background color.
    `void` | `setBackgroundColor(StringProperty color)` Sets the link's background color.
    `void` | `setColor(java.lang.String color)` Sets the link's color.
    `void` | `setColor(StringProperty color)` Sets the link's color.
    `void` | `setFontName(java.lang.String fontName)` Sets the link's font name.
    `void` | `setFontName(StringProperty fontName)` Sets the link's font name.
    `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` | `setTarget(java.lang.String target)` Sets the name of the frame that will be navigated to when the user clicks on the frame.
    `void` | `setTarget(StringProperty target)` Sets the name of the frame that will be navigated to when the user clicks on the frame.

    - ### 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

    - #### LinkDescription

          public LinkDescription()

      Initializes a new instance of the Link class.

    - #### LinkDescription

          protected LinkDescription(LinkDescription.Init<?> init)

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

  - ### Method Detail

    - #### setTarget

          public void setTarget(StringProperty target)

      Sets the name of the frame that will be navigated to when the user clicks on the frame.
      Parameters:
        `target` - a StringProperty(or RegExpProperty) representing the name of the target frame of the navigation. Possible values: Any valid HTML target attribute value, for example, framename, _blank, or _self.

    - #### setTarget

          public void setTarget(java.lang.String target)

      Sets the name of the frame that will be navigated to when the user clicks on the frame.
      Parameters:
        `target` - the target frame of the navigation. Possible values: Any valid HTML target attribute value, for example, framename, _blank, or _self.

    - #### getTarget

          public StringProperty getTarget()

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

    - #### setFontName

          public void setFontName(StringProperty fontName)

      Sets the link's font name.
      Parameters:
        `fontName` - a StringProperty(or RegExpProperty) representing the font name.

    - #### setFontName

          public void setFontName(java.lang.String fontName)

      Sets the link's font name.
      Parameters:
        `fontName` - the font name.

    - #### getFontName

          public StringProperty getFontName()

      Returns the link's font name.
      Returns:
        the link's font name.

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

    - #### setColor

          public void setColor(StringProperty color)

      Sets the link's color.
      Parameters:
        `color` - a StringProperty(or RegExpProperty) representing the link's color.

    - #### setColor

          public void setColor(java.lang.String color)

      Sets the link's color.
      Parameters:
        `color` - the link's color.

    - #### getColor

          public StringProperty getColor()

      Returns the link's color.
      Returns:
        the link's color.

    - #### setBackgroundColor

          public void setBackgroundColor(StringProperty color)

      Sets the link's background color.
      Parameters:
        `color` - a StringProperty(or RegExpProperty) representing the link's background color.

    - #### setBackgroundColor

          public void setBackgroundColor(java.lang.String color)

      Sets the link's background color.
      Parameters:
        `color` - the link's background color.

    - #### getBackgroundColor

          public StringProperty getBackgroundColor()

      Returns the link's background color.
      Returns:
        the link's background color.