Open topic with navigation

com.hp.lft.sdk.web

## Class WebSwipeArgs

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

-     public class WebSwipeArgs
      extends java.lang.Object

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

- - ### Constructor Summary

    Constructor and Description
    `WebSwipeArgs(SwipeDirection direction)` Initializes a new instance of the WebSwipeArgs class with default arguments (perform swipe 200 pixels from the center of the object in 0.25 seconds).

  - ### Method Summary

    Modifier and Type | Method and Description
    --- | ---
    `SwipeDirection` | `getDirection()` Returns the direction to swipe.
    `long` | `getDistance()` Returns the distance (in pixels) to swipe.
    `double` | `getDuration()` Returns the number of seconds to perform the Swipe operation.
    `Location` | `getLocation()` Returns the location to start the Swipe operation.
    `WebSwipeArgs` | `setDirection(SwipeDirection direction)` Sets the direction to swipe.
    `WebSwipeArgs` | `setDistance(long distance)` Sets the distance (in pixels) to swipe.
    `WebSwipeArgs` | `setDuration(double duration)` Sets the number of seconds to perform the swipe.
    `WebSwipeArgs` | `setLocation(Location location)` Sets the location to start the Swipe operation.

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

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

- - ### Constructor Detail

    - #### WebSwipeArgs

          public WebSwipeArgs(SwipeDirection direction)

      Initializes a new instance of the WebSwipeArgs class with default arguments (perform swipe 200 pixels from the center of the object in 0.25 seconds).
      Parameters:
        `direction` - the direction to swipe

  - ### Method Detail

    - #### getDirection

          public SwipeDirection getDirection()

      Returns the direction to swipe.
      Returns:
        the direction to swipe

    - #### setDirection

          public WebSwipeArgs setDirection(SwipeDirection direction)

      Sets the direction to swipe.
      Parameters:
        `direction` - the�direction to swipe. Possible values: `SwipeDirection`
      Returns:
        the WebSwipeArgs instance with the updated state (builder pattern).

    - #### getLocation

          public Location getLocation()

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

    - #### setLocation

          public WebSwipeArgs setLocation(Location location)

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

    - #### getDuration

          public double getDuration()

      Returns the number of seconds to perform the Swipe operation.
      Returns:
        the number of seconds to perform the Swipe operation

    - #### setDuration

          public WebSwipeArgs setDuration(double duration)

      Sets the number of seconds to perform the swipe.
      Parameters:
        `duration` - the number of seconds to perform the swipe
      Returns:
        the WebSwipeArgs instance with the updated state (builder pattern).

    - #### getDistance

          public long getDistance()

      Returns the distance (in pixels) to swipe.
      Returns:
        the distance (in pixels) to swipe

    - #### setDistance

          public WebSwipeArgs setDistance(long distance)

      Sets the distance (in pixels) to swipe.
      Parameters:
        `distance` - the distance (in pixels) to swipe
      Returns:
        the WebSwipeArgs instance with the updated state (builder pattern).