Overview  Package   Class  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

com.nokia.mid.ui.gestures
Interface GestureEvent

public interface GestureEvent

The GestureEvent interface class is used by an application to receive gesture recognition events from the platform.

The API imposes the restriction that the gesture event data is only valid during the call to GestureListener.gestureAction(java.lang.Object, com.nokia.mid.ui.gestures.GestureInteractiveZone, com.nokia.mid.ui.gestures.GestureEvent).

Method Summary
 int getDragDistanceX()
          Query for the Drag & Drop gesture events movement in horizontal direction since last drag gesture.
 int getDragDistanceY()
          Query for the Drag & Drop gesture events movement in vertical direction since last drag gesture.
 float getFlickDirection()
          Query for the Flick gesture events direction.
 int getFlickSpeed()
          Query for the Flick gesture events speed in actual flick direction.
 int getFlickSpeedX()
          Query for the Flick gesture events speed in horizontal direction.
 int getFlickSpeedY()
          Query for the Flick gesture events speed in vertical direction.
 int getPinchCenterChangeX()
          Query for the Pinch gesture events change in the center position between the fingers in horizontal direction since the last pinch gesture.
 int getPinchCenterChangeY()
          Query for the Pinch gesture events change in the center position between the fingers in vertical direction since the last pinch gesture.
 int getPinchCenterX()
          Query for the Pinch gesture events current center position between the fingers in horizontal direction.
 int getPinchCenterY()
          Query for the Pinch gesture events current center position between the fingers in vertical direction.
 int getPinchDistanceChange()
          Query for the Pinch gesture events change in the distance between the fingers since the last pinch gesture.
 int getPinchDistanceCurrent()
          Query for the Pinch gesture events current distance between the fingers.
 int getPinchDistanceStarting()
          Gets the distance (in pixels) between the fingers when the pinch gesture started.
 int getStartX()
          Query for the gestures horizontal start location.
 int getStartY()
          Query for the gestures vertical start location.
 int getType()
          Query for the actual gesture event that has occurred.
 

Method Detail

getType

public int getType()

Query for the actual gesture event that has occurred.

Gesture Event can be one of:

Returns:
gesture event that has just occurred.

getDragDistanceX

public int getDragDistanceX()

Query for the Drag & Drop gesture events movement in horizontal direction since last drag gesture.

This method can only be called for drag GestureInteractiveZone.GESTURE_DRAG and drop GestureInteractiveZone.GESTURE_DROP gesture events.

Returns:
movement in horizontal direction in pixels since last drag event.
Throws:
java.lang.IllegalStateException - if requested data invalid for gesture event.
Since:
1.0

getDragDistanceY

public int getDragDistanceY()

Query for the Drag & Drop gesture events movement in vertical direction since last drag gesture.

This method can only be called for drag GestureInteractiveZone.GESTURE_DRAG and drop GestureInteractiveZone.GESTURE_DROP gesture events.

Returns:
movement in vertical direction in pixels since last drag event.
Throws:
java.lang.IllegalStateException - if requested data invalid for gesture event.
Since:
1.0

getStartX

public int getStartX()

Query for the gestures horizontal start location.

This method can be called for all gesture events.

Returns:
horizontal start location of the gesture event relative to the containers origin.
Since:
1.0

getStartY

public int getStartY()

Query for the gestures vertical start location.

This method can be called for all gesture events.

Returns:
vertical start location of the gesture event relative to the containers origin.
Since:
1.0

getFlickDirection

public float getFlickDirection()

Query for the Flick gesture events direction.

This method can only be called for the flick GestureInteractiveZone.GESTURE_FLICK gesture event.

Returns:
flick direction angle in radians.
Throws:
java.lang.IllegalStateException - if requested data invalid for gesture event.
Since:
1.0

getFlickSpeed

public int getFlickSpeed()

Query for the Flick gesture events speed in actual flick direction.

This method can only be called for the flick GestureInteractiveZone.GESTURE_FLICK gesture event.

Returns:
flick speed in pixels per second in actual flick direction.
Throws:
java.lang.IllegalStateException - if requested data invalid for gesture event.
Since:
1.0

getFlickSpeedX

public int getFlickSpeedX()

Query for the Flick gesture events speed in horizontal direction.

This method can only be called for the flick GestureInteractiveZone.GESTURE_FLICK gesture event.

Returns:
flick speed in pixels per second in horizontal direction.
Throws:
java.lang.IllegalStateException - if requested data invalid for gesture event.
Since:
1.0

getFlickSpeedY

public int getFlickSpeedY()

Query for the Flick gesture events speed in vertical direction.

This method can only be called for the flick GestureInteractiveZone.GESTURE_FLICK gesture event.

Returns:
flick speed in pixels per second in vertical direction.
Throws:
java.lang.IllegalStateException - if requested data invalid for gesture event.
Since:
1.0

getPinchDistanceStarting

public int getPinchDistanceStarting()

Gets the distance (in pixels) between the fingers when the pinch gesture started.

This method can only be called for the pinch GestureInteractiveZone.GESTURE_PINCH gesture event.

Returns:
The distance between the fingers when the pinch gesture was started in pixels.
Throws:
java.lang.IllegalStateException - if requested data invalid for gesture event.
Since:
1.1

getPinchDistanceCurrent

public int getPinchDistanceCurrent()

Query for the Pinch gesture events current distance between the fingers.

This method can only be called for the pinch GestureInteractiveZone.GESTURE_PINCH gesture event.

Returns:
Current distance between the fingers in pixels.
Throws:
java.lang.IllegalStateException - if requested data invalid for gesture event.
Since:
1.1

getPinchDistanceChange

public int getPinchDistanceChange()

Query for the Pinch gesture events change in the distance between the fingers since the last pinch gesture.

This method can only be called for the pinch GestureInteractiveZone.GESTURE_PINCH gesture event.

Returns:
Change in the distance between the fingers since the last pinch gesture in pixels.
Throws:
java.lang.IllegalStateException - if requested data invalid for gesture event.
Since:
1.1

getPinchCenterX

public int getPinchCenterX()

Query for the Pinch gesture events current center position between the fingers in horizontal direction.

This method can only be called for the pinch GestureInteractiveZone.GESTURE_PINCH gesture event.

Returns:
Current center position between the fingers in horizontal direction in pixels.
Throws:
java.lang.IllegalStateException - if requested data invalid for gesture event.
Since:
1.1

getPinchCenterY

public int getPinchCenterY()

Query for the Pinch gesture events current center position between the fingers in vertical direction.

This method can only be called for the pinch GestureInteractiveZone.GESTURE_PINCH gesture event.

Returns:
Current center position between the fingers in vertical direction in pixels.
Throws:
java.lang.IllegalStateException - if requested data invalid for gesture event.
Since:
1.1

getPinchCenterChangeX

public int getPinchCenterChangeX()

Query for the Pinch gesture events change in the center position between the fingers in horizontal direction since the last pinch gesture.

This method can only be called for the pinch GestureInteractiveZone.GESTURE_PINCH gesture event.

Returns:
Change in the center position between the fingers in horizontal direction since the last pinch gesture.
Throws:
java.lang.IllegalStateException - if requested data invalid for gesture event.
Since:
1.1

getPinchCenterChangeY

public int getPinchCenterChangeY()

Query for the Pinch gesture events change in the center position between the fingers in vertical direction since the last pinch gesture.

This method can only be called for the pinch GestureInteractiveZone.GESTURE_PINCH gesture event.

Returns:
Change in the center position between the fingers in vertical direction since the last pinch gesture.
Throws:
java.lang.IllegalStateException - if requested data invalid for gesture event.
Since:
1.1
Overview  Package   Class  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD
Copyright © 2012 Nokia Corporation. All rights reserved.

Nokia is registered trademark of Nokia Corporation. Java and all Java-based marks are trademarks or registered trademarks of Oracle Corporation. Other product and company names mentioned herein may be trademarks or trade names of their respective owners. This document is confidential information of Nokia Corporation.

Disclaimer
The information in this document is provided "as is," with no warranties whatsoever, including any warranty of merchantability, fitness for any particular purpose, or any warranty otherwise arising out of any proposal, specification, or sample. Furthermore, information provided in this document is preliminary, and may be changed substantially prior to final release.

Nokia Corporation disclaims all liability, including liability for infringement of any proprietary rights, relating to this document and implementation of any information presented in this document.

Nokia Corporation retains the right to make changes to this document at any time, without notice.

License
Subject to above disclaimer, a license is hereby granted to use this documentation solely under existing Limited License Agreement and non-disclosure agreement between the companies for the agreed application development for Series 40 Nokia phones. No other licenses e.g. to any intellectual property rights are granted herein. Any use of the screen shots of this documentation, including any icons thereof, is subject to Nokia's prior written approval.