cpr.events.CMouseEvent

Mouse events
Hierarchy

Index

Properties
Name Type Description
AT_TARGET Number eventPhase constant.
BUBBLING_PHASE Number eventPhase constant.
CAPTURING_PHASE Number eventPhase constant.
NONE Number Commits on Mar 29, 2018
altKey Boolean Retrieves a Boolean value that indicates whether the left or right Alt key was pressed when the event occurred.
bubbles Boolean Indicates whether the specified event is bubbled through the DOM.
button Number Returns the value of the button that triggered the event when the mouse was pressed.
buttons Number Returns whether the mouse or other input device has pressed a button when the event is triggered.
cancelBubble Boolean The logging alias for the stopPropagation () method.
cancelable Boolean Indicates whether the event is cancelable.
clientX Number Returns the horizontal coordinate of the point at which the event occurred within the application client area (as opposed to the coordinate within the page).
clientY Number Returns the vertical coordinate at which the event occurred in the client area of ​​the application (as opposed to the coordinates within the page).
clipboardData DataTransfer It is a properties provided in Poste, Copy, Cut.
composed Boolean Indicates whether the event propagated across the Shadow DOM area and the standard DOM area.
content Object The contents passed to the control are passed in various types.
control IEventTarget Returns the control that dispatched the current event.
controlConstraint Constraint Returns the participation constraint information in the container to which the control that dispatched the current event belongs.
ctrlKey Boolean Returns a Boolean indicating if the control key is pressed (true) or not (false).
currentTarget EventTarget Identifies the current target of the event as it passes through the DOM.
data String For the textInput event, returns the message content of the typed character or onmessage event.
dataTransfer DataTransfer Maintains the data of the drag operation as a DataTransfer object.
defaultPrevented Boolean Returns a Boolean indicating if the preventDefault () method has been called on the event.
detail Number Returns an integer value specifying additional information about the event.
eventPhase Number Indicates the stage of the event flow currently being evaluated.
immediatePropagationStopped Boolean Obtains whether other listeners have been blocked from being called on the same event.
inputType String Input Event Returns the inputType supported by Level2.
isComposing Boolean For the textInput event, returns whether the characters entered are combinatorial.
isTrusted Boolean A value that is true if it was generated by a user action, false if the script is written or modified, or passed through dispatchEvent.
isWrapper Boolean Returns whether this is a wrapper.
metaKey Boolean Returns a Boolean indicating whether the meta key was pressed (true) or not (false) when the event occurred.
movementX Number Provides the X coordinate of the mouse pointer between this event and the previous mousemove event.
movementY Number Provides the Y coordinate of the mouse pointer between this event and the previous mousemove event.
offsetX Number Provides an offset in the X coordinate of the mouse pointer between the event and the padding edge of the target node.
offsetY Number Provides an offset in the Y coordinate of the mouse pointer between the event and the padding edge of the target node.
option CEventOption Returns the side information of the CEvent object.
pageX Number Returns the X (horizontal) coordinates of the event pixel relative to the entire document.
pageY Number Returns Y (vertical) coordinates, in pixels, of the event relative to the entire document.
propagationStopped Boolean Obtains whether the event has been blocked from propagating.
relatedTarget EventTarget The secondary target for the event, if any.
relatedTargetObject Object The child control on which the event is fired returns its associated side information within the parent control to which it belongs.
returnValue Boolean Indicates whether the default behavior of the event has been prevented.
scoped Boolean A Boolean value that indicates whether an event can bubble at the border between the Shadow DOM and the normal DOM.
screenX Number Provides the horizontal coordinate (offset) of the mouse pointer in global (screen) coordinates.
screenY Number Provides the ordinate (offset) of the full coordinate (screen) coordinates of the mouse pointer.
shiftKey Boolean Indicates whether the shift key was pressed (true) or false (false) when the event occurred.
srcElement EventTarget Exclusive alias for the standard Event.target property.
target EventTarget A reference to the object that dispatched the event.
targetControl IEventTarget Returns the control that raised the first event.
targetObject Object Returns the associated object of the control where the first event occurred.
timeStamp Number Returns the time at which the event occurred based on ms (milliseconds).
type String Returns a string that contains the event type.
userData object Specifies or gets a custom data object.
view Window Returns a reference to the AbstractView object where the event occurred.
which Number Represents the button that triggered the event when the mouse was pressed.
x Number An alias for the clientX property of MouseEvent.
y Number An alias for the clientY property of MouseEvent.
Methods
Name Return Type Description
composedPath EventTarget[] Returns the path in an array of Listener objects on which to fire the event.
deepPath EventTarget[] The deepPath property of the Event interface returns an array of nodes with inflated events.
getModifierState Boolean Returns the current state of the specified object.
initEvent Initializes an event object created with the createEvent method of type 'Event'.
preventDefault Prevents the following default behavior:
setCurrentTarget Sets the event target element.
stopImmediatePropagation Prevents other listeners for the same event from being called.
stopPropagation Prevents further propagation of current events during the capture and bubbling phases.

Constructor

CMouseEvent(type, options)
Creates a mouse event.
Parameters
name type description
type String Event type
optionsoptional CUIEventOptions event options.

Properties

AT_TARGET
declaring type CEvent
type Number
readonly
eventPhase constant. At this stage, a registered event listener is called at this time.
BUBBLING_PHASE
declaring type CEvent
type Number
readonly
eventPhase constant. This event propagates the ancestors of the target in reverse order, in reverse order, starting from the parent and eventually reaching the contained Window.
CAPTURING_PHASE
declaring type CEvent
type Number
readonly
eventPhase constant. The event is propagated through the ancestor objects of the target. This process begins with a window, a document, an HTMLHtmlElement, and so on until it reaches the parent of the object.
NONE
declaring type CEvent
type Number
readonly
Commits on Mar 29, 2018
altKey
type Boolean
readonly
Retrieves a Boolean value that indicates whether the left or right Alt key was pressed when the event occurred.
bubbles
declaring type CEvent
type Boolean
readonly
Indicates whether the specified event is bubbled through the DOM.
button
type Number
readonly
Returns the value of the button that triggered the event when the mouse was pressed.
left = 0, wheel or middle = 1, right = 2, browserback button = 3, browserforward button = 4
buttons
type Number
readonly
Returns whether the mouse or other input device has pressed a button when the event is triggered. no button = 0, left = 1, right = 2, middel or wheel = 4, browser back button = 8, browser forward button = 16
cancelBubble
declaring type CEvent
type Boolean
get
The logging alias for the stopPropagation () method.
set
The logging alias for the stopPropagation () method.
cancelable
declaring type CEvent
type Boolean
readonly
Indicates whether the event is cancelable.
clientX
type Number
readonly
Returns the horizontal coordinate of the point at which the event occurred within the application client area (as opposed to the coordinate within the page).
clientY
type Number
readonly
Returns the vertical coordinate at which the event occurred in the client area of ​​the application (as opposed to the coordinates within the page).
clipboardData
declaring type CEvent
type DataTransfer
readonly
It is a properties provided in Poste, Copy, Cut. Other events return null.
composed
declaring type CEvent
type Boolean
readonly
Indicates whether the event propagated across the Shadow DOM area and the standard DOM area.
content
declaring type CUIEvent
type Object
readonly
The contents passed to the control are passed in various types.
control
declaring type CEvent
type IEventTarget
readonly
Returns the control that dispatched the current event.
controlConstraint
declaring type CUIEvent
type Constraint
readonly
Returns the participation constraint information in the container to which the control that dispatched the current event belongs.
ctrlKey
type Boolean
readonly
Returns a Boolean indicating if the control key is pressed (true) or not (false).
currentTarget
declaring type CEvent
type EventTarget
readonly
Identifies the current target of the event as it passes through the DOM.
data
declaring type CUIEvent
type String
readonly
For the textInput event, returns the message content of the typed character or onmessage event.
dataTransfer
type DataTransfer
readonly
Maintains the data of the drag operation as a DataTransfer object.
defaultPrevented
declaring type CEvent
type Boolean
readonly
Returns a Boolean indicating if the preventDefault () method has been called on the event.
detail
declaring type CUIEvent
type Number
readonly
Returns an integer value specifying additional information about the event.
eventPhase
declaring type CEvent
type Number
readonly
Indicates the stage of the event flow currently being evaluated.
immediatePropagationStopped
declaring type CEvent
type Boolean
readonly
Obtains whether other listeners have been blocked from being called on the same event.
inputType
declaring type CUIEvent
type String
readonly
Input Event Returns the inputType supported by Level2.
isComposing
declaring type CUIEvent
type Boolean
readonly
For the textInput event, returns whether the characters entered are combinatorial.
isTrusted
declaring type CEvent
type Boolean
readonly
A value that is true if it was generated by a user action, false if the script is written or modified, or passed through dispatchEvent.
isWrapper
declaring type CEvent
type Boolean
readonly
Returns whether this is a wrapper.
metaKey
type Boolean
readonly
Returns a Boolean indicating whether the meta key was pressed (true) or not (false) when the event occurred.
movementX
type Number
readonly
Provides the X coordinate of the mouse pointer between this event and the previous mousemove event.
movementY
type Number
readonly
Provides the Y coordinate of the mouse pointer between this event and the previous mousemove event.
offsetX
type Number
readonly
Provides an offset in the X coordinate of the mouse pointer between the event and the padding edge of the target node.
offsetY
type Number
readonly
Provides an offset in the Y coordinate of the mouse pointer between the event and the padding edge of the target node.
option
declaring type CEvent
type CEventOption
readonly
Returns the side information of the CEvent object.
pageX
type Number
readonly
Returns the X (horizontal) coordinates of the event pixel relative to the entire document.
pageY
type Number
readonly
Returns Y (vertical) coordinates, in pixels, of the event relative to the entire document.
propagationStopped
declaring type CEvent
type Boolean
readonly
Obtains whether the event has been blocked from propagating.
relatedTarget
type EventTarget
readonly
The secondary target for the event, if any.
relatedTargetObject
declaring type CEvent
type Object
readonly
The child control on which the event is fired returns its associated side information within the parent control to which it belongs.
returnValue
declaring type CEvent
type Boolean
get
Indicates whether the default behavior of the event has been prevented.
set
Sets whether the default behavior of the event is prevented.
By default, this is set to true to allow default behavior.
If this property is set to false, the default action is prohibited.
scoped
declaring type CEvent
type Boolean
readonly
A Boolean value that indicates whether an event can bubble at the border between the Shadow DOM and the normal DOM.
screenX
type Number
readonly
Provides the horizontal coordinate (offset) of the mouse pointer in global (screen) coordinates.
screenY
type Number
readonly
Provides the ordinate (offset) of the full coordinate (screen) coordinates of the mouse pointer.
shiftKey
type Boolean
readonly
Indicates whether the shift key was pressed (true) or false (false) when the event occurred.
srcElement
declaring type CEvent
type EventTarget
readonly
Exclusive alias for the standard Event.target property.
Applies only to earlier versions of Microsoft Internet Explorer.
target
declaring type CEvent
type EventTarget
readonly
A reference to the object that dispatched the event.
It differs from event.currentTarget when an event handler is called in the bubbling or capture phase of an event.
targetControl
declaring type CEvent
type IEventTarget
readonly
Returns the control that raised the first event.
targetObject
declaring type CEvent
type Object
readonly
Returns the associated object of the control where the first event occurred. If a control has a child object, such as a Grid, the child object's information will be returned when the event occurs on the child object. The returned object may or may not be present, depending on the event firing control.
timeStamp
declaring type CEvent
type Number
readonly
Returns the time at which the event occurred based on ms (milliseconds).
type
declaring type CEvent
type String
readonly
Returns a string that contains the event type.
It is set when an event is generated and is a commonly used name to refer to a specific event.
userData
declaring type CEvent
type object
Specifies or gets a custom data object.
view
declaring type CUIEvent
type Window
readonly
Returns a reference to the AbstractView object where the event occurred.
which
type Number
readonly
Represents the button that triggered the event when the mouse was pressed.
no button = 0, left button = 1, middle button = 2, right button = 3
x
type Number
readonly
An alias for the clientX property of MouseEvent.
y
type Number
readonly
An alias for the clientY property of MouseEvent.

Methods

composedPath()
declaring typeCEvent
Returns the path in an array of Listener objects on which to fire the event.
return EventTarget[]
deepPath()
declaring typeCEvent
The deepPath property of the Event interface returns an array of nodes with inflated events.
return EventTarget[] An array of nodes.
getModifierState(keyArg)
Returns the current state of the specified object.
Parameters
name type description
keyArg String The specified object name.
return Boolean The current state of the specified object.
initEvent(eventTypeArg, canBubbleArg, cancelableArg)
declaring typeCEvent
Initializes an event object created with the createEvent method of type 'Event'.
Parameters
name type description
eventTypeArg String A string that specifies the name (type) of the event to initialize.
canBubbleArg Boolean Specifies whether the event is bubbled. Sets the bubbles property of the event object.
cancelableArg Boolean Specifies whether the event can be canceled. Sets the cancelable property of the event object.
preventDefault()
declaring typeCEvent
Prevents the following default behavior:
setCurrentTarget(eventTarget)
declaring typeCEvent
Sets the event target element.
Parameters
name type description
eventTarget EventTarget
stopImmediatePropagation()
declaring typeCEvent
Prevents other listeners for the same event from being called.
stopPropagation(nativeCall)
declaring typeCEvent
Prevents further propagation of current events during the capture and bubbling phases.
Parameters
name type description
nativeCalloptional Boolean defaulttrue