Open topic with navigation

com.hp.lft.sdk.web

## Class PageDescription

- java.lang.Object
- - com.hp.lft.sdk.internal.PropertiesDescriptionBase
  - - com.hp.lft.sdk.PropertiesDescription
    - - com.hp.lft.sdk.DescriptionBase
      - - com.hp.lft.sdk.web.PageDescription

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

      public class PageDescription
      extends DescriptionBase

  The description of a Web Page test object.

- - ### Nested Class Summary

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

  - ### Field Summary

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

      `properties`

  - ### Constructor Summary

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

  - ### Method Summary

    Modifier and Type | Method and Description
    --- | ---
    `LocationProperty` | `getAbsoluteLocation()` Returns the object's absolute coordinates relative to the screen (in pixels).
    `SizeProperty` | `getSize()` Returns the test object's size (in pixels).
    `StringProperty` | `getText()` Returns the inner text of the body element.
    `StringProperty` | `getTitle()` Returns the page's title attribute.
    `StringProperty` | `getUrl()` Returns the URL of the page.
    `void` | `setAbsoluteLocation(java.lang.Integer absX, java.lang.Integer absY)` Sets the object's absolute coordinates relative to the screen (in pixels).
    `void` | `setAbsoluteLocation(LocationProperty absLocation)` Sets the object's absolute coordinates relative to the screen (in pixels).
    `void` | `setAbsoluteLocation(java.awt.Point absLocation)` Sets the object's absolute coordinates relative to the screen (in pixels).
    `void` | `setSize(java.awt.Dimension size)` Sets the test object's size (in pixels).
    `void` | `setSize(java.lang.Integer width, java.lang.Integer height)` Sets the test object's size (in pixels).
    `void` | `setSize(SizeProperty size)` Sets the test object's size (in pixels).
    `void` | `setText(java.lang.String text)` Sets the inner text of the body element.
    `void` | `setText(StringProperty text)` Sets the inner text of the body element.
    `void` | `setTitle(java.lang.String title)` Sets the element's title attribute (provides additional information on the element).
    `void` | `setTitle(StringProperty title)` Sets the element's title attribute (provides additional information on the element).
    `void` | `setUrl(java.lang.String url)` Sets the URL of the page.
    `void` | `setUrl(StringProperty url)` Sets the URL of the page.

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

      `cloneTo, 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

    - #### PageDescription

          public PageDescription()

      Initializes a new instance of the PageDescription class.

    - #### PageDescription

          protected PageDescription(PageDescription.Init<?> init)

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

  - ### Method Detail

    - #### setUrl

          public void setUrl(StringProperty url)

      Sets the URL of the page.
      Parameters:
        `url` - a StringProperty(or RegExpProperty) representing the URL of the page.

    - #### setUrl

          public void setUrl(java.lang.String url)

      Sets the URL of the page.
      Parameters:
        `url` - the URL of the page.

    - #### getUrl

          public StringProperty getUrl()

      Returns the URL of the page.
      Returns:
        the URL of the page.

    - #### setText

          public void setText(StringProperty text)

      Sets the inner text of the body element.
      Parameters:
        `text` - a StringProperty(or RegExpProperty) representing the inner text of the body element.

    - #### setText

          public void setText(java.lang.String text)

      Sets the inner text of the body element.
      Parameters:
        `text` - the inner text of the body element.

    - #### getText

          public StringProperty getText()

      Returns the inner text of the body element.
      Returns:
        the inner text of the body element.

    - #### setTitle

          public void setTitle(java.lang.String title)

      Sets the element's title attribute (provides additional information on the element).
      Parameters:
        `title` - the element's title attribute (provides additional information on the element).

    - #### setTitle

          public void setTitle(StringProperty title)

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

    - #### getTitle

          public StringProperty getTitle()

      Returns the page's title attribute.
      Returns:
        the page's title attribute.

    - #### setAbsoluteLocation

          public void setAbsoluteLocation(LocationProperty absLocation)

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

    - #### setAbsoluteLocation

          public void setAbsoluteLocation(java.lang.Integer absX,
                                          java.lang.Integer absY)

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

    - #### setAbsoluteLocation

          public void setAbsoluteLocation(java.awt.Point absLocation)

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

    - #### getAbsoluteLocation

          public LocationProperty getAbsoluteLocation()

      Returns the object's absolute coordinates relative to the screen (in pixels).
      Returns:
        the object's absolute coordinates relative to the screen (in pixels).

    - #### setSize

          public void setSize(SizeProperty size)

      Sets the test object's size (in pixels).
      Parameters:
        `size` - the test object's size (in pixels).

    - #### setSize

          public void setSize(java.awt.Dimension size)

      Sets the test object's size (in pixels).
      Parameters:
        `size` - the test object's size (in pixels).

    - #### setSize

          public void setSize(java.lang.Integer width,
                              java.lang.Integer height)

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

    - #### getSize

          public SizeProperty getSize()

      Returns the test object's size (in pixels).
      Returns:
        the test object's size (in pixels).