Open topic with navigation

com.hp.lft.sdk

## Class LocationProperty

- java.lang.Object
- - com.hp.lft.sdk.LocationProperty

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

      public class LocationProperty
      extends java.lang.Object
      implements com.hp.lft.sdk.internal.GroupedProperty, CloneableObject

  Class for defining a test object's location property.

- - ### Field Summary

    Modifier and Type | Field and Description
    --- | ---
    `java.lang.Integer` | `x` The x-coordinate (in pixels) of the test object location.
    `java.lang.Integer` | `y` The y-coordinate (in pixels) of the test object location.

  - ### Constructor Summary

    Constructor and Description
    `LocationProperty()` Initializes a new instance of the LocationProperty class.
    `LocationProperty(java.lang.Integer x, java.lang.Integer y)` Initializes a new instance of the LocationProperty class with the specified x and y values.
    `LocationProperty(LocationProperty locationToCopy)` Initializes a new instance of the LocationProperty class by copying values from the provided `LocationProperty` object.
    `LocationProperty(java.awt.Point location)` Initializes a new instance of the LocationProperty class with the specified location values.

  - ### Method Summary

    Modifier and Type | Method and Description
    --- | ---
    `java.lang.Object` | `clone()` Returns a clone of this instance.
    `java.util.Map<java.lang.String,java.lang.Object>` | `getProperties()`
    `java.lang.Integer` | `getX()` Returns the x-coordinate (in pixels) of the test object location.
    `java.lang.Integer` | `getY()` Returns the y-coordinate (in pixels) of the test object location.
    `LocationProperty` | `setX(java.lang.Integer x)` Sets the x-coordinate (in pixels) of the test object location.
    `LocationProperty` | `setY(java.lang.Integer y)` Sets the y-coordinate (in pixels) of the test object location.
    `java.lang.String` | `toString()`

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

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

- - ### Field Detail

    - #### x

          public java.lang.Integer x

      The x-coordinate (in pixels) of the test object location.

    - #### y

          public java.lang.Integer y

      The y-coordinate (in pixels) of the test object location.

  - ### Constructor Detail

    - #### LocationProperty

          public LocationProperty()

      Initializes a new instance of the LocationProperty class.

    - #### LocationProperty

          public LocationProperty(java.awt.Point location)

      Initializes a new instance of the LocationProperty class with the specified location values.
      Parameters:
        `location` - the `Location` to use to initialize the LocationProperty.

    - #### LocationProperty

          public LocationProperty(java.lang.Integer x,
                                  java.lang.Integer y)

      Initializes a new instance of the LocationProperty class with the specified x and y values.
      Parameters:
        `x` - the x-coordinate (in pixels) of the test object location.
        `y` - the y-coordinate (in pixels) of the test object location.

    - #### LocationProperty

          public LocationProperty(LocationProperty locationToCopy)

      Initializes a new instance of the LocationProperty class by copying values from the provided `LocationProperty` object.
      Parameters:
        `locationToCopy` - the `LocationProperty` object whose values will be copied to the new instance.

  - ### Method Detail

    - #### clone

          public java.lang.Object clone()
                                 throws java.lang.CloneNotSupportedException

      Description copied from interface: `CloneableObject`
      Returns a clone of this instance.
      Specified by:
        `clone` in interface `CloneableObject`
      Overrides:
        `clone` in class `java.lang.Object`
      Returns:
        a clone of this instance.
      Throws:
        `java.lang.CloneNotSupportedException` - if the instance cannot be cloned.

    - #### getProperties

          public java.util.Map<java.lang.String,java.lang.Object> getProperties()

      Specified by:
        `getProperties` in interface `com.hp.lft.sdk.internal.GroupedProperty`

    - #### getX

          public java.lang.Integer getX()

      Returns the x-coordinate (in pixels) of the test object location.
      Returns:
        the x-coordinate (in pixels) of the test object location.

    - #### setX

          public LocationProperty setX(java.lang.Integer x)

      Sets the x-coordinate (in pixels) of the test object location.
      Parameters:
        `x` - the x-coordinate (in pixels) of the test object location.
      Returns:
        the `LocationProperty` instance with the updated state (builder pattern).

    - #### getY

          public java.lang.Integer getY()

      Returns the y-coordinate (in pixels) of the test object location.
      Returns:
        the y-coordinate (in pixels) of the test object location.

    - #### setY

          public LocationProperty setY(java.lang.Integer y)

      Sets the y-coordinate (in pixels) of the test object location.
      Parameters:
        `y` - the y-coordinate (in pixels) of the test object location.
      Returns:
        the `LocationProperty` instance with the updated state (builder pattern).

    - #### toString

          public java.lang.String toString()

      Overrides:
        `toString` in class `java.lang.Object`