JavaScript API Reference for Oracle ADF Faces

oracle.adf.view.js.event
Class AdfComponentTouchEvent

org.ecmascript.object.Object
   |
   +--oracle.adf.view.js.base.AdfObject
         |
         +--oracle.adf.view.js.event.AdfBaseEvent
               |
               +--oracle.adf.view.js.event.AdfPhasedEvent
                     |
                     +--oracle.adf.view.js.event.AdfComponentEvent
                           |
                           +--oracle.adf.view.js.event.AdfUIInputEvent
                                 |
                                 +--oracle.adf.view.js.event.AdfDomUIInputEvent
                                       |
                                       +--oracle.adf.view.js.event.AdfComponentTouchEvent

Direct Known Subclasses:

AdfTouchShowContextMenuEvent

public class AdfComponentTouchEvent
extends AdfDomUIInputEvent

TOUCH_CANCEL_EVENT_TYPE

public static Object TOUCH_CANCEL_EVENT_TYPE

Sent when the system cancels tracking for the touch.

TOUCH_END_EVENT_TYPE

public static Object TOUCH_END_EVENT_TYPE

Sent when a given event lifts from the surface.

TOUCH_MOVE_EVENT_TYPE

public static Object TOUCH_MOVE_EVENT_TYPE

Sent when a given event moves on the surface.

TOUCH_START_EVENT_TYPE

public static Object TOUCH_START_EVENT_TYPE

Sent when a finger for a given event touches the surface.

AdfComponentTouchEvent

public AdfComponentTouchEvent(AdfComponent source,
                              Object type,
                              Object event)

AdfUIComponent event that redistributes native touch events. The touch event is fired as fingers touch and move across a surface. A touch event provides a snapshot of all touches during a multi-touch sequence that are new or have changed for a particular target. Valid "AdfBaseEvent#type" values are as follows:

• TOUCH_START_EVENT_TYPE
• TOUCH_MOVE_EVENT_TYPE
• TOUCH_END_EVENT_TYPE
• TOUCH_CANCEL_EVENT_TYPE

All of the event types listed above will bubble except for TOUCH_MOVE_EVENT_TYPE.

Parameters:

source	-	component of native event target
type
event

cancel

public void cancel()

Preventing the default native event behavior before delegating on the the standard component cancel behavior.

Return:

void - null

Overrides:

AdfBaseEvent.cancel()

deriveContextMenuEvent

public static AdfComponentEvent deriveContextMenuEvent(Object componentEvent)

Utility function that derives a AdfComponentEvent.CONTEXT_MENU_EVENT_TYPE from a touch even type. The resultant event will share the same "AdfComponentTouchEvent#getNativeEvent" and "AdfComponentTouchEvent#getSource" properties.

Parameters:

componentEvent

Return:

AdfComponentEvent - component event of type AdfComponentEvent.CONTEXT_MENU_EVENT_TYPE or null if the componentEvent is not of the correct "AdfComponentTouchEvent#getType()".

See also:

AdfAgent.createContextMenuEventGenerator()

AdfTouchContextMenuManager.deriveContextMenuEvent(AdfComponentEvent)

getButtons

public Number getButtons()

Returns mask of buttons clicked

Return:

Number - Treat all touches as the left mouse button, AdfUIInputEvent.LEFT_BUTTON_FLAG

Overrides:

AdfUIInputEvent.getButtons()

getClientX

public Number getClientX()

Return:

Number - Returns the horizontal coordinate of the first touch event

Overrides:

AdfUIInputEvent.getClientX()

getClientY

public Number getClientY()

Return:

Number - Returns the vertical coordinate of the first touch event

Overrides:

AdfUIInputEvent.getClientY()

getCurrentTarget

public AdfUIComponent getCurrentTarget()

Returns the object whose listeners are currently being called. This will be different than the source of the event during the capture and bubble phases.

Return:

AdfUIComponent - if the "#getType" equals TOUCH_MOVE_EVENT_TYPE, the event doesn't bubble and the "#getSource" is returned; otherwise, delegate on to the super to return the component that this event is currently broadcast on.

Overrides:

AdfBaseEvent.getCurrentTarget()

getDoesBubbles

public boolean getDoesBubbles()

Prevents the chatty touch move from bubbling. All the other touch events will bubble.

Return:

boolean - returns false if the event type is TOUCH_MOVE_EVENT_TYPE

Overrides:

AdfBaseEvent.getDoesBubbles()

__getFirstTouch

static Touch __getFirstTouch(TouchEvent evt)

Get the first Touch object from a touch event.

Called by this class and AdfSafariMobileAgent.

Parameters:

evt

-

the native touch event

Return:

Touch - the first native touch object if present, otherwise null.

_getFirstTouch

private Object _getFirstTouch()

Return:

Object

getKeyCode

public Number getKeyCode()

Returns key code for key events

Return:

Number - returns 0 because events have no keys.

Overrides:

AdfUIInputEvent.getKeyCode()

getPageX

public Number getPageX()

Return:

Number - Retuns the horizontal (x-coordinate) within the webpage of the first touch event

Overrides:

AdfUIInputEvent.getPageX()

getPageY

public Number getPageY()

Return:

Number - Retuns the vertical (y-coordinate) within the webpage of the first touch event

Overrides:

AdfUIInputEvent.getPageY()

getScreenX

public Number getScreenX()

Return:

Number - Returns the horizontal coordinate (according to the users computer screen) of the first touch event.

Overrides:

AdfUIInputEvent.getScreenX()

getScreenY

public Number getScreenY()

Return:

Number - Returns the vertical coordinate (according to the users computer screen) of the first touch event.

Overrides:

AdfUIInputEvent.getScreenY()

getTouchCount

public Number getTouchCount()

Return:

Number - number of point of contact currently touching the surface (for touchend events, this includes the fingers that are being released).