public class MouseEvent extends Event
There are two possible way to identify a mouse event.
One is by coordinate (getX()
and getY()
.
The other is by a logical name, called area (getArea()
).
Modifier and Type | Field and Description |
---|---|
static int |
ALT_KEY
Indicates whether the Alt key is pressed.
|
static int |
CTRL_KEY
Indicates whether the Ctrl key is pressed.
|
static int |
LEFT_CLICK
Indicates whether the left button is clicked.
|
static int |
META_KEY
Indicates whether the Meta key is pressed.
|
static int |
MIDDLE_CLICK
Indicates whether the middle button is clicked.
|
static int |
RIGHT_CLICK
Indicates whether the right button is clicked.
|
static int |
SHIFT_KEY
Indicates whether the Shift key is pressed.
|
Constructor and Description |
---|
MouseEvent(java.lang.String name,
Component target)
Construct a mouse relevant event with coordinate or area.
|
MouseEvent(java.lang.String name,
Component target,
int x,
int y,
int pageX,
int pageY)
Constructs a mouse relevant event.
|
MouseEvent(java.lang.String name,
Component target,
int x,
int y,
int pageX,
int pageY,
int keys)
Constructs a mouse relevant event.
|
MouseEvent(java.lang.String name,
Component target,
java.lang.String area,
int keys)
Constructs a mouse relevant event with a logic name called area.
|
Modifier and Type | Method and Description |
---|---|
java.lang.String |
getArea()
Returns the logical name of the area that the click occurs, or
null if not available.
|
Component |
getAreaComponent()
Returns the component representing the area that the click occurs,
or null if not associated with any component.
|
int |
getKeys()
Returns what keys were pressed when the mouse is clicked, or 0 if
none of them was pressed.
|
static MouseEvent |
getMouseEvent(AuRequest request)
Converts an AU request to a mouse event.
|
int |
getPageX()
Returns the horizontal coordinate of the mouse pointer relative
to the whole document.
|
int |
getPageY()
Returns the vertical coordinate of the mouse pointer relative
to the whole document.
|
int |
getX()
Returns the horizontal coordinate of the mouse pointer relevant to
the component.
|
int |
getY()
Returns the vertical coordinate of the mouse pointer relevant to
the component.
|
getData, getEvent, getName, getPage, getTarget, isPropagatable, stopPropagation, toString
public static final int ALT_KEY
getKeys()
.public static final int CTRL_KEY
getKeys()
.public static final int SHIFT_KEY
getKeys()
.public static final int META_KEY
getKeys()
.public static final int LEFT_CLICK
public static final int RIGHT_CLICK
public static final int MIDDLE_CLICK
public MouseEvent(java.lang.String name, Component target)
public MouseEvent(java.lang.String name, Component target, int x, int y, int pageX, int pageY)
public MouseEvent(java.lang.String name, Component target, int x, int y, int pageX, int pageY, int keys)
keys
- a combination of CTRL_KEY
, SHIFT_KEY
ALT_KEY
, LEFT_CLICK
and RIGHT_CLICK
.public MouseEvent(java.lang.String name, Component target, java.lang.String area, int keys)
public static MouseEvent getMouseEvent(AuRequest request)
public java.lang.String getArea()
It is used only with some special components, that partition itself into several logical areas.
For example, imagemap
and chart
partition an image into multiple sections represented with
the area component (Area
).
If each partition is represented with Area
, the
return value is AbstractComponent.getId()
, if it is assigned, or
AbstractComponent.getUuid()
if not assigned.
To simplify the access, you can retrieve it back with
getAreaComponent()
.
getAreaComponent()
public Component getAreaComponent()
This method assumes getArea()
is either a component's ID
or a component's UUID. It is true when Area
is used
to partition a component, such as Imagemap
and Chart
.
public final int getX()
public final int getY()
public final int getPageX()
public final int getPageY()
public final int getKeys()
CTRL_KEY
, SHIFT_KEY
ALT_KEY
, LEFT_CLICK
and RIGHT_CLICK
.Copyright © 2005-2018 Potix Corporation. All Rights Reserved.