Open topic with navigation

com.hp.lft.sdk.mobile

## Class TapArgs

- java.lang.Object
- - com.hp.lft.sdk.mobile.TapArgs

-     public class TapArgs
      extends java.lang.Object

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

- - ### Constructor Summary

    Constructor and Description
    `TapArgs()` Initializes a new instance of the TapArgs class with default arguments (tap the center of the object once at one touch point).

  - ### Method Summary

    Modifier and Type | Method and Description
    --- | ---
    `java.lang.String` | `getGesture()` Returns the gesture class designed by the mobile application developer to handle this gesture on this object.
    `Location` | `getLocation()` Returns the location to tap.
    `int` | `getNumberOfTaps()` Returns the number of times to tap the object.
    `int` | `getNumberOfTouchPoints()` The number of points to tap, similar to the number of fingers you would use for the gesture on a real device.
    `TapArgs` | `setGesture(java.lang.String gesture)` Sets the gesture class designed by the mobile application developer to handle this gesture on this object.
    `TapArgs` | `setLocation(Location location)` Sets the location to tap.
    `TapArgs` | `setNumberOfTaps(int numberOfTaps)` Sets the number of times to tap the object.
    `TapArgs` | `setNumberOfTouchPoints(int numberOfTouchPoints)` Sets the number of points to tap, similar to the number of fingers you would use for the gesture on a real device.

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

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

- - ### Constructor Detail

    - #### TapArgs

          public TapArgs()

      Initializes a new instance of the TapArgs class with default arguments (tap the center of the object once at one touch point).

  - ### Method Detail

    - #### getGesture

          public java.lang.String getGesture()

      Returns the gesture class designed by the mobile application developer to handle this gesture on this object. (iOS Only)
      Needed only if the application developer overrode the default iOS gesture class.
      Returns:
        the gesture class designed by the mobile application developer.

    - #### setGesture

          public TapArgs setGesture(java.lang.String gesture)

      Sets the gesture class designed by the mobile application developer to handle this gesture on this object. (iOS Only)
      Needed only if the application developer overrode the default iOS gesture class.
      Parameters:
        `gesture` - the gesture class designed by the mobile application developer.
      Returns:
        the TapArgs instance with the updated state (builder pattern).

    - #### getLocation

          public Location getLocation()

      Returns the location to tap.
      Default = center of the object
      Returns:
        the location to tap.

    - #### setLocation

          public TapArgs setLocation(Location location)

      Sets the location to tap.
      Parameters:
        `location` - the location to tap.
      Returns:
        the TapArgs instance with the updated state (builder pattern).

    - #### getNumberOfTouchPoints

          public int getNumberOfTouchPoints()

      The number of points to tap, similar to the number of fingers you would use for the gesture on a real device. (iOS Only)
      Default = 1
      Returns:
        the number of points to tap.

    - #### setNumberOfTouchPoints

          public TapArgs setNumberOfTouchPoints(int numberOfTouchPoints)

      Sets the number of points to tap, similar to the number of fingers you would use for the gesture on a real device. (iOS Only)
      Parameters:
        `numberOfTouchPoints` - the number of points to tap.
      Returns:
        the TapArgs instance with the updated state (builder pattern).

    - #### getNumberOfTaps

          public int getNumberOfTaps()

      Returns the number of times to tap the object. (iOS Only)
      Returns:
        the number of times to tap the object.

    - #### setNumberOfTaps

          public TapArgs setNumberOfTaps(int numberOfTaps)

      Sets the number of times to tap the object. (iOS Only)
      Parameters:
        `numberOfTaps` - the number of times to tap the object.
      Returns:
        the TapArgs instance with the updated state (builder pattern).