com.gargoylesoftware.htmlunit.javascript.host.event

Class PointerEvent

java.lang.Object

net.sourceforge.htmlunit.corejs.javascript.ScriptableObject

com.gargoylesoftware.htmlunit.javascript.HtmlUnitScriptable

com.gargoylesoftware.htmlunit.javascript.SimpleScriptable

com.gargoylesoftware.htmlunit.javascript.host.event.Event

com.gargoylesoftware.htmlunit.javascript.host.event.UIEvent

com.gargoylesoftware.htmlunit.javascript.host.event.MouseEvent

com.gargoylesoftware.htmlunit.javascript.host.event.PointerEvent

All Implemented Interfaces:

Serializable, Cloneable, net.sourceforge.htmlunit.corejs.javascript.ConstProperties, net.sourceforge.htmlunit.corejs.javascript.debug.DebuggableObject, net.sourceforge.htmlunit.corejs.javascript.Scriptable

public class PointerEvent
extends MouseEvent

JavaScript object representing the PointerEvent.

Author:

Frank Danek

See Also:

W3C Spec, MSDN, Serialized Form

Field Summary

Fields inherited from class com.gargoylesoftware.htmlunit.javascript.host.event.MouseEvent

BUTTON_LEFT, BUTTON_MIDDLE, BUTTON_RIGHT, MOZ_SOURCE_CURSOR, MOZ_SOURCE_ERASER, MOZ_SOURCE_KEYBOARD, MOZ_SOURCE_MOUSE, MOZ_SOURCE_PEN, MOZ_SOURCE_TOUCH, MOZ_SOURCE_UNKNOWN, TYPE_CLICK, TYPE_CONTEXT_MENU, TYPE_DBL_CLICK, TYPE_MOUSE_DOWN, TYPE_MOUSE_MOVE, TYPE_MOUSE_OUT, TYPE_MOUSE_OVER, TYPE_MOUSE_UP

Fields inherited from class com.gargoylesoftware.htmlunit.javascript.host.event.UIEvent

SCROLL_PAGE_DOWN, SCROLL_PAGE_UP

Fields inherited from class com.gargoylesoftware.htmlunit.javascript.host.event.Event

ALT_MASK, AT_TARGET, BLUR, BUBBLING_PHASE, CAPTURING_PHASE, CHANGE, CLICK, CONTROL_MASK, DBLCLICK, DRAGDROP, FOCUS, KEY_CURRENT_EVENT, KEYDOWN, KEYPRESS, KEYUP, META_MASK, MOUSEDOWN, MOUSEDRAG, MOUSEMOVE, MOUSEOUT, MOUSEOVER, MOUSEUP, NONE, SELECT, SHIFT_MASK, TYPE_BEFORE_UNLOAD, TYPE_BLUR, TYPE_CHANGE, TYPE_CLOSE, TYPE_DOM_DOCUMENT_LOADED, TYPE_ERROR, TYPE_FOCUS, TYPE_FOCUS_IN, TYPE_FOCUS_OUT, TYPE_HASH_CHANGE, TYPE_INPUT, TYPE_KEY_DOWN, TYPE_KEY_PRESS, TYPE_KEY_UP, TYPE_LOAD, TYPE_MESSAGE, TYPE_OPEN, TYPE_POPSTATE, TYPE_PROPERTY_CHANGE, TYPE_READY_STATE_CHANGE, TYPE_RESET, TYPE_SUBMIT, TYPE_UNLOAD

Fields inherited from class net.sourceforge.htmlunit.corejs.javascript.ScriptableObject

CONST, DONTENUM, EMPTY, PERMANENT, READONLY, UNINITIALIZED_CONST

Fields inherited from interface net.sourceforge.htmlunit.corejs.javascript.Scriptable

NOT_FOUND

Constructor Summary

Constructors

Constructor and Description
PointerEvent() Creates a new event instance.
PointerEvent(DomNode domNode, String type, boolean shiftKey, boolean ctrlKey, boolean altKey, int button) Creates a new event instance.

Method Summary

Methods

Modifier and Type	Method and Description
long	getHeight()
long	getPointerId()
String	getPointerType()
double	getPressure()
long	getTiltX()
long	getTiltY()
long	getWidth()
void	initPointerEvent(String type, boolean bubbles, boolean cancelable, Object view, int detail, int screenX, int screenY, int clientX, int clientY, boolean ctrlKey, boolean altKey, boolean shiftKey, boolean metaKey, int button, Object relatedTarget, int offsetX, int offsetY, int width, int height, Double pressure, int rotation, int tiltX, int tiltY, int pointerId, String pointerType, int hwTimestamp, boolean isPrimary) Used for initializing the pointer event.
boolean	isPrimary()

Methods inherited from class com.gargoylesoftware.htmlunit.javascript.host.event.MouseEvent

getAltKey, getButton, getClientX, getClientY, getCtrlKey, getCurrentMouseEvent, getPageX, getPageY, getScreenX, getScreenY, getShiftKey, getWhich, initMouseEvent, isMouseEvent, setButton, setClientX, setClientY

Methods inherited from class com.gargoylesoftware.htmlunit.javascript.host.event.UIEvent

getCancelBubble, getDetail, getMetaKey, getView, initUIEvent, setCancelBubble, setDetail, setMetaKey

Methods inherited from class com.gargoylesoftware.htmlunit.javascript.host.event.Event

createPropertyChangeEvent, endFire, eventCreated, getBubbles, getCancelable, getCurrentTarget, getDefaultPrevented, getEventPhase, getKeyCode, getPropertyName, getReturnValue, getSrcElement, getTarget, getTimeStamp, getType, initEvent, isAborted, isPropagationStopped, jsConstructor, preventDefault, setAltKey, setBubbles, setCancelable, setCtrlKey, setCurrentTarget, setEventPhase, setEventType, setKeyCode, setReturnValue, setShiftKey, setSrcElement, setTarget, setType, startFire, stopPropagation, toString

Methods inherited from class com.gargoylesoftware.htmlunit.javascript.SimpleScriptable

clone, equivalentValues, get, getBrowserVersion, getDefaultValue, getDomNodeOrDie, getDomNodeOrNull, getPrototype, getScriptableFor, getStartingScope, getWindow, getWindow, getWithPreemption, has, hasInstance, initParentScope, isReadOnlySettable, makeScriptableFor, setCaseSensitive, setDomNode, setDomNode, setHtmlElement

Methods inherited from class com.gargoylesoftware.htmlunit.javascript.HtmlUnitScriptable

defineFunctionProperties, defineProperty, getClassName, setClassName, setParentScope

Methods inherited from class net.sourceforge.htmlunit.corejs.javascript.ScriptableObject

applyDescriptorToAttributeBitset, associateValue, avoidObjectDetection, buildDataDescriptor, callMethod, callMethod, checkPropertyChange, checkPropertyDefinition, defineClass, defineClass, defineClass, defineConst, defineConstProperty, defineOwnProperties, defineOwnProperty, defineOwnProperty, defineProperty, defineProperty, defineProperty, delete, delete, deleteProperty, deleteProperty, ensureScriptable, ensureScriptableObject, get, get, getAllIds, getArrayPrototype, getAssociatedValue, getAttributes, getAttributes, getAttributes, getAttributes, getClassPrototype, getDefaultValue, getExternalArrayData, getExternalArrayLength, getFunctionPrototype, getGetterOrSetter, getIds, getObjectPrototype, getOwnPropertyDescriptor, getParentScope, getProperty, getProperty, getPropertyIds, getPrototype, getSlot, getTopLevelScope, getTopScopeValue, getTypedProperty, getTypedProperty, getTypeOf, has, hasProperty, hasProperty, isAccessorDescriptor, isConst, isDataDescriptor, isEmpty, isExtensible, isFalse, isGenericDescriptor, isGetterOrSetter, isSealed, isTrue, preventExtensions, put, put, putConst, putConstProperty, putProperty, putProperty, redefineProperty, sameValue, sealObject, setAttributes, setAttributes, setAttributes, setAttributes, setExternalArrayData, setGetterOrSetter, setPrototype, size

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

PointerEvent

public PointerEvent()

Creates a new event instance.

PointerEvent

public PointerEvent(DomNode domNode,
            String type,
            boolean shiftKey,
            boolean ctrlKey,
            boolean altKey,
            int button)

Creates a new event instance.

Parameters:

domNode - the DOM node that triggered the event

type - the event type

shiftKey - true if SHIFT is pressed

ctrlKey - true if CTRL is pressed

altKey - true if ALT is pressed

button - the button code, must be MouseEvent.BUTTON_LEFT, MouseEvent.BUTTON_MIDDLE or MouseEvent.BUTTON_RIGHT

Method Detail

initPointerEvent

public void initPointerEvent(String type,
                    boolean bubbles,
                    boolean cancelable,
                    Object view,
                    int detail,
                    int screenX,
                    int screenY,
                    int clientX,
                    int clientY,
                    boolean ctrlKey,
                    boolean altKey,
                    boolean shiftKey,
                    boolean metaKey,
                    int button,
                    Object relatedTarget,
                    int offsetX,
                    int offsetY,
                    int width,
                    int height,
                    Double pressure,
                    int rotation,
                    int tiltX,
                    int tiltY,
                    int pointerId,
                    String pointerType,
                    int hwTimestamp,
                    boolean isPrimary)

Used for initializing the pointer event.

Parameters:

type - the event type

bubbles - can the event bubble

cancelable - can the event be canceled

view - the view to use for this event

detail - the detail to set for the event

screenX - the initial value of screenX

screenY - the initial value of screenY

clientX - the initial value of clientX

clientY - the initial value of clientY

ctrlKey - is the control key pressed

altKey - is the alt key pressed

shiftKey - is the shift key pressed

metaKey - is the meta key pressed

button - what mouse button is pressed

relatedTarget - is there a related target for the event

offsetX - the initial value of offsetX

offsetY - the initial value of offsetY

width - the initial value of width

height - the initial value of height

pressure - the initial value of pressure

rotation - the initial value of rotation

tiltX - the initial value of tiltX

tiltY - the initial value of tiltY

pointerId - the pointerId

pointerType - the pointer type

hwTimestamp - the initial value of hwTimestamp

isPrimary - the initial value of isPrimary

getPointerId

public long getPointerId()

Returns:

the pointerId

getWidth

public long getWidth()

Returns:

the width

getHeight

public long getHeight()

Returns:

the height

getPressure

public double getPressure()

Returns:

the pressure

getTiltX

public long getTiltX()

Returns:

the tiltX

getTiltY

public long getTiltY()

Returns:

the tiltY

getPointerType

public String getPointerType()

Returns:

the pointerType

isPrimary

public boolean isPrimary()

Returns:

the isPrimary