doodle.events.createMouseEvent

Description:

MouseEvent (type:string, bubbles:boolean, cancelable:boolean, view:HTMLElement, detail:number, screenX:number, screenY:number, clientX:number, clientY:number, ctrlKey:boolean, altKey:boolean, shiftKey:boolean, metaKey:boolean, button:number, relatedTarget:Node) :MouseEvent

Inherits

  1. UIEvent
  2. Event
  3. Object

Parameters

  1. type:string – [optional]
  2. bubbles:boolean – [optional]
  3. cancelable:boolean – [optional]
  4. view:HTMLElement – [optional]
  5. detail:number – [optional]
  6. screenX:number – [optional]
  7. screenY:number – [optional]
  8. clientX:number – [optional]
  9. clientY:number – [optional]
  10. ctrlKey:boolean – [optional]
  11. altKey:boolean – [optional]
  12. shiftKey:boolean – [optional]
  13. metaKey:boolean – [optional]
  14. button:number – [optional] Mouse button that caused the event (0|1|2)
  15. relatedTarget:Node – [optional] Secondary target for event (only for some events)

Returns

  • MouseEvent –

Throws

  • TypeError –
  • SyntaxError –

Properties

altKey :boolean

Returns

  • boolean – [read-only]
bubbles :boolean

Returns

  • boolean – [read-only]
button :number

Returns

  • number – [read-only]
cancelable :boolean

Returns

  • boolean – [read-only]
charCode :number

Returns

  • number – [read-only]
clientX :number

Returns

  • number – [read-only]
clientY :number

Returns

  • number – [read-only]
ctrlKey :boolean

Returns

  • boolean – [read-only]
currentTarget :Node

Returns

  • Node – [read-only]
detail :number

Returns

  • number – [read-only]
eventPhase :number

Returns

  • number – [read-only]
keyCode :number

Returns

  • number – [read-only]
layerX :number

Returns

  • number – [read-only]
layerY :number

Returns

  • number – [read-only]
metaKey :boolean

Returns

  • boolean – [read-only]
offsetX :number

Returns

  • number – [read-only]
offsetY :number

Returns

  • number – [read-only]
pageX :number

Returns

  • number – [read-only]
pageY :number

Returns

  • number – [read-only]
relatedTarget :Node

Returns

  • Node – [read-only]
returnValue :*

Returns

  • * – [read-only]
screenX :number

Returns

  • number – [read-only]
screenY :number

Returns

  • number – [read-only]
shiftKey :boolean

Returns

  • boolean – [read-only]
srcElement :Emitter

Returns

  • Emitter – [read-only]
target :Node

Returns

  • Node – [read-only]
timeStamp :Date

Returns

  • Date – [read-only]
type :string

Returns

  • string – [read-only]
view :HTMLElement

Returns

  • HTMLElement – [read-only]
which :number

Returns

  • number – [read-only]
x :number

Returns

  • number – [read-only]
y :number

Returns

  • number – [read-only]

Methods

cancelBubble (cancelArg:boolean) :void

Parameters

  1. cancelArg:boolean –

Throws

  • TypeError –
id () :string

Returns

  • string –
initEvent (typeArg:string, canBubbleArg:boolean, cancelableArg:boolean) :Event

Parameters

  1. typeArg:string – [optional]
  2. canBubbleArg:boolean – [optional]
  3. cancelableArg:boolean – [optional]

Returns

  • Event –

Throws

  • TypeError –
initMouseEvent (typeArg:string, canBubbleArg:boolean, cancelableArg:boolean, viewArg:HTMLElement, detailArg:number, screenXArg:number, screenYArg:number, clientXArg:number, clientYArg:number, ctrlKeyArg:boolean, altKeyArg:boolean, shiftKeyArg:boolean, metaKeyArg:boolean, buttonArg:number, relatedTargetArg:Node) :MouseEvent

Parameters

  1. typeArg:string –
  2. canBubbleArg:boolean –
  3. cancelableArg:boolean –
  4. viewArg:HTMLElement –
  5. detailArg:number –
  6. screenXArg:number –
  7. screenYArg:number –
  8. clientXArg:number –
  9. clientYArg:number –
  10. ctrlKeyArg:boolean –
  11. altKeyArg:boolean –
  12. shiftKeyArg:boolean –
  13. metaKeyArg:boolean –
  14. buttonArg:number –
  15. relatedTargetArg:Node –

Returns

  • MouseEvent –

Throws

  • TypeError –
initUIEvent (typeArg:string, canBubbleArg:boolean, cancelableArg:boolean, viewArg:HTMLElement, detailArg:number) :UIEvent

Parameters

  1. typeArg:string –
  2. canBubbleArg:boolean –
  3. cancelableArg:boolean –
  4. viewArg:HTMLElement –
  5. detailArg:number –

Returns

  • UIEvent –

Throws

  • TypeError –
preventDefault () :void

stopImmediatePropagation () :void

Throws

  • Error – If called on event that can not be canceled.
stopPropagation () :void

Throws

  • Error – If called on event that can not be canceled.
toString () :string

Returns

  • string –
getModifierState (key:string) :boolean

Queries the state of a modifier using a key identifier.

Parameters

  1. key:string – A modifier key identifier

Returns

  • boolean – True if it is a modifier key and the modifier is activated, false otherwise.

Throws

  • TypeError –

Constants

CONTEXT_MENU :string

Returns

  • string – [read-only]
DOUBLE_CLICK :string

Returns

  • string – [read-only]
MOUSE_DOWN :string

Returns

  • string – [read-only]
MOUSE_ENTER :string

Returns

  • string – [read-only]
MOUSE_LEAVE :string

Returns

  • string – [read-only]
MOUSE_MOVE :string

Returns

  • string – [read-only]
MOUSE_OUT :string

Returns

  • string – [read-only]
MOUSE_OVER :string

Returns

  • string – [read-only]
MOUSE_UP :string

Returns

  • string – [read-only]
MOUSE_WHEEL :string

Returns

  • string – [read-only]
CLICK :string

To test for left/middle/right button check value for event.which (0,1,2).

Returns

  • string – [read-only]

Class Functions

isMouseEvent (event:doodle.events.MouseEvent) :boolean

Test if an object is a MouseEvent.

Parameters

  1. event:doodle.events.MouseEvent –

Returns

  • boolean –