Top Description Fields Constructors Methods
org.apache.xerces.dom.events

public Class MouseEventImpl

extends UIEventImpl
implements MouseEvent
Class Inheritance
All Implemented Interfaces
org.w3c.dom.events.MouseEvent, org.w3c.dom.events.UIEvent, org.w3c.dom.events.Event
Imports
org.w3c.dom.events.EventTarget, .MouseEvent, org.w3c.dom.views.AbstractView
An implementation of the DOM Level 2 MouseEvent interface.
Version
$Id: MouseEventImpl.java 533574 2007-04-30 00:29:47Z mrglavas $

Field Summary

Modifier and TypeField and Description
private boolean
fAltKey

private short
fButton

private int
fClientX

private int
fClientY

private boolean
fCtrlKey

private boolean
fMetaKey

private EventTarget
fRelatedTarget

private int
fScreenX

private int
fScreenY

private boolean
fShiftKey

Constructor Summary

AccessConstructor and Description
public
MouseEventImpl()

Method Summary

Modifier and TypeMethod and Description
public boolean
getAltKey()

Implements org.w3c.dom.events.MouseEvent.getAltKey.

Used to indicate whether the 'alt' key was depressed during the firing of the event.
public short
getButton()

Implements org.w3c.dom.events.MouseEvent.getButton.

During mouse events caused by the depression or release of a mouse button, button is used to indicate which mouse button changed state.
public int
getClientX()

Implements org.w3c.dom.events.MouseEvent.getClientX.

The horizontal coordinate at which the event occurred relative to the DOM implementation's client area.
public int
getClientY()

Implements org.w3c.dom.events.MouseEvent.getClientY.

The vertical coordinate at which the event occurred relative to the DOM implementation's client area.
public boolean
getCtrlKey()

Implements org.w3c.dom.events.MouseEvent.getCtrlKey.

Used to indicate whether the 'ctrl' key was depressed during the firing of the event.
public boolean
getMetaKey()

Implements org.w3c.dom.events.MouseEvent.getMetaKey.

Used to indicate whether the 'meta' key was depressed during the firing of the event.
public EventTarget
getRelatedTarget()

Implements org.w3c.dom.events.MouseEvent.getRelatedTarget.

Used to identify a secondary EventTarget related to a UI event.
public int
getScreenX()

Implements org.w3c.dom.events.MouseEvent.getScreenX.

The horizontal coordinate at which the event occurred relative to the origin of the screen coordinate system.
public int
getScreenY()

Implements org.w3c.dom.events.MouseEvent.getScreenY.

The vertical coordinate at which the event occurred relative to the origin of the screen coordinate system.
public boolean
getShiftKey()

Implements org.w3c.dom.events.MouseEvent.getShiftKey.

Used to indicate whether the 'shift' key was depressed during the firing of the event.
public void
initMouseEvent(String
Specifies the event type.
typeArg, boolean
Specifies whether or not the event can bubble.
canBubbleArg, boolean
Specifies whether or not the event's default action can be prevented.
cancelableArg, AbstractView
Specifies the Event's AbstractView.
viewArg, int
Specifies the Event's mouse click count.
detailArg, int
Specifies the Event's screen x coordinate
screenXArg, int
Specifies the Event's screen y coordinate
screenYArg, int
Specifies the Event's client x coordinate
clientXArg, int
Specifies the Event's client y coordinate
clientYArg, boolean
Specifies whether or not control key was depressed during the Event.
ctrlKeyArg, boolean
Specifies whether or not alt key was depressed during the Event.
altKeyArg, boolean
Specifies whether or not shift key was depressed during the Event.
shiftKeyArg, boolean
Specifies whether or not meta key was depressed during the Event.
metaKeyArg, short
Specifies the Event's mouse button.
buttonArg, EventTarget
Specifies the Event's related EventTarget.
relatedTargetArg)

Implements org.w3c.dom.events.MouseEvent.initMouseEvent.

The initMouseEvent method is used to initialize the value of a MouseEvent created through the DocumentEvent interface.
Inherited from org.apache.xerces.dom.events.UIEventImpl:
getDetailgetViewinitUIEvent

Field Detail

fAltKeyback to summary
private boolean fAltKey
fButtonback to summary
private short fButton
fClientXback to summary
private int fClientX
fClientYback to summary
private int fClientY
fCtrlKeyback to summary
private boolean fCtrlKey
fMetaKeyback to summary
private boolean fMetaKey
fRelatedTargetback to summary
private EventTarget fRelatedTarget
fScreenXback to summary
private int fScreenX
fScreenYback to summary
private int fScreenY
fShiftKeyback to summary
private boolean fShiftKey

Constructor Detail

MouseEventImplback to summary
public MouseEventImpl()

Method Detail

getAltKeyback to summary
public boolean getAltKey()

Implements org.w3c.dom.events.MouseEvent.getAltKey.

Doc from org.w3c.dom.events.MouseEvent.getAltKey.

Used to indicate whether the 'alt' key was depressed during the firing of the event. On some platforms this key may map to an alternative key name.

getButtonback to summary
public short getButton()

Implements org.w3c.dom.events.MouseEvent.getButton.

Doc from org.w3c.dom.events.MouseEvent.getButton.

During mouse events caused by the depression or release of a mouse button, button is used to indicate which mouse button changed state. The values for button range from zero to indicate the left button of the mouse, one to indicate the middle button if present, and two to indicate the right button. For mice configured for left handed use in which the button actions are reversed the values are instead read from right to left.

getClientXback to summary
public int getClientX()

Implements org.w3c.dom.events.MouseEvent.getClientX.

Doc from org.w3c.dom.events.MouseEvent.getClientX.

The horizontal coordinate at which the event occurred relative to the DOM implementation's client area.

getClientYback to summary
public int getClientY()

Implements org.w3c.dom.events.MouseEvent.getClientY.

Doc from org.w3c.dom.events.MouseEvent.getClientY.

The vertical coordinate at which the event occurred relative to the DOM implementation's client area.

getCtrlKeyback to summary
public boolean getCtrlKey()

Implements org.w3c.dom.events.MouseEvent.getCtrlKey.

Doc from org.w3c.dom.events.MouseEvent.getCtrlKey.

Used to indicate whether the 'ctrl' key was depressed during the firing of the event.

getMetaKeyback to summary
public boolean getMetaKey()

Implements org.w3c.dom.events.MouseEvent.getMetaKey.

Doc from org.w3c.dom.events.MouseEvent.getMetaKey.

Used to indicate whether the 'meta' key was depressed during the firing of the event. On some platforms this key may map to an alternative key name.

getRelatedTargetback to summary
public EventTarget getRelatedTarget()

Implements org.w3c.dom.events.MouseEvent.getRelatedTarget.

Doc from org.w3c.dom.events.MouseEvent.getRelatedTarget.

Used to identify a secondary EventTarget related to a UI event. Currently this attribute is used with the mouseover event to indicate the EventTarget which the pointing device exited and with the mouseout event to indicate the EventTarget which the pointing device entered.

getScreenXback to summary
public int getScreenX()

Implements org.w3c.dom.events.MouseEvent.getScreenX.

Doc from org.w3c.dom.events.MouseEvent.getScreenX.

The horizontal coordinate at which the event occurred relative to the origin of the screen coordinate system.

getScreenYback to summary
public int getScreenY()

Implements org.w3c.dom.events.MouseEvent.getScreenY.

Doc from org.w3c.dom.events.MouseEvent.getScreenY.

The vertical coordinate at which the event occurred relative to the origin of the screen coordinate system.

getShiftKeyback to summary
public boolean getShiftKey()

Implements org.w3c.dom.events.MouseEvent.getShiftKey.

Doc from org.w3c.dom.events.MouseEvent.getShiftKey.

Used to indicate whether the 'shift' key was depressed during the firing of the event.

initMouseEventback to summary
public void initMouseEvent(String typeArg, boolean canBubbleArg, boolean cancelableArg, AbstractView viewArg, int detailArg, int screenXArg, int screenYArg, int clientXArg, int clientYArg, boolean ctrlKeyArg, boolean altKeyArg, boolean shiftKeyArg, boolean metaKeyArg, short buttonArg, EventTarget relatedTargetArg)

Implements org.w3c.dom.events.MouseEvent.initMouseEvent.

Doc from org.w3c.dom.events.MouseEvent.initMouseEvent.

The initMouseEvent method is used to initialize the value of a MouseEvent created through the DocumentEvent interface. This method may only be called before the MouseEvent has been dispatched via the dispatchEvent method, though it may be called multiple times during that phase if necessary. If called multiple times, the final invocation takes precedence.

Parameters
typeArg:String

Specifies the event type.

canBubbleArg:boolean

Specifies whether or not the event can bubble.

cancelableArg:boolean

Specifies whether or not the event's default action can be prevented.

viewArg:AbstractView

Specifies the Event's AbstractView.

detailArg:int

Specifies the Event's mouse click count.

screenXArg:int

Specifies the Event's screen x coordinate

screenYArg:int

Specifies the Event's screen y coordinate

clientXArg:int

Specifies the Event's client x coordinate

clientYArg:int

Specifies the Event's client y coordinate

ctrlKeyArg:boolean

Specifies whether or not control key was depressed during the Event.

altKeyArg:boolean

Specifies whether or not alt key was depressed during the Event.

shiftKeyArg:boolean

Specifies whether or not shift key was depressed during the Event.

metaKeyArg:boolean

Specifies whether or not meta key was depressed during the Event.

buttonArg:short

Specifies the Event's mouse button.

relatedTargetArg:EventTarget

Specifies the Event's related EventTarget.