Open topic with navigation

com.hp.lft.sdk.web

## Class WebPanArgs

- java.lang.Object
- - com.hp.lft.sdk.web.WebPanArgs

-     public class WebPanArgs
      extends java.lang.Object

  Arguments that define additional behavior for Pan operations.
  This class can be initialized using the builder pattern.

- - ### Constructor Summary

    Constructor and Description
    `WebPanArgs(long deltaX, long deltaY)` Initializes a new instance of the WebPanArgs class with default arguments (pans from the center of the object for 0.5 second).

  - ### Method Summary

    Modifier and Type | Method and Description
    --- | ---
    `double` | `getDeltaX()` Returns the distance moved on the x-axis.
    `double` | `getDeltaY()` Returns the distance moved on the y-axis
    `double` | `getDuration()` Returns the duration for the Pan operation.
    `Location` | `getLocation()` Returns the location to start the Pan operation.
    `WebPanArgs` | `setDeltaX(long deltaX)` Sets the distance moved on the x-axis.
    `WebPanArgs` | `setDeltaY(long deltaY)` Sets the distance moved on the y-axis
    `WebPanArgs` | `setDuration(double duration)` Sets the duration for the Pan operation.
    `WebPanArgs` | `setLocation(Location location)` Sets the location to start the Pan operation .

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

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

- - ### Constructor Detail

    - #### WebPanArgs

          public WebPanArgs(long deltaX,
                            long deltaY)

      Initializes a new instance of the WebPanArgs class with default arguments (pans from the center of the object for 0.5 second).
      Parameters:
        `deltaX` - the distance moved on the x-axis
        `deltaY` - the distance moved on the y-axis

  - ### Method Detail

    - #### getDeltaX

          public double getDeltaX()

      Returns the distance moved on the x-axis.
      Returns:
        the distance moved on the x-axis

    - #### setDeltaX

          public WebPanArgs setDeltaX(long deltaX)

      Sets the distance moved on the x-axis.
      Parameters:
        `deltaX` - the distance moved on the x-axis
      Returns:
        the WebPanArgs instance with the updated state (builder pattern).

    - #### getDeltaY

          public double getDeltaY()

      Returns the distance moved on the y-axis
      Returns:
        the distance moved on the y-axis

    - #### setDeltaY

          public WebPanArgs setDeltaY(long deltaY)

      Sets the distance moved on the y-axis
      Parameters:
        `deltaY` - the distance moved on the y-axis
      Returns:
        the WebPanArgs instance with the updated state (builder pattern).

    - #### getLocation

          public Location getLocation()

      Returns the location to start the Pan operation. Possible values: `Location`
      Default value = center of the object
      Returns:
        the location to start the Pan operation.

    - #### setLocation

          public WebPanArgs setLocation(Location location)

      Sets the location to start the Pan operation .
      Parameters:
        `location` - the location to start the Pan operation. Possible values: `Location`
      Returns:
        the WebPanArgs instance with the updated state (builder pattern).

    - #### getDuration

          public double getDuration()

      Returns the duration for the Pan operation.
      Returns:
        the duration of the Pan operation.

    - #### setDuration

          public WebPanArgs setDuration(double duration)

      Sets the duration for the Pan operation.
      Parameters:
        `duration` - the number of seconds for the Pan operation.
      Returns:
        the WebPanArgs instance with the updated state (builder pattern).