edu.umd.cs.piccolox.pswing
Interface PSwingEvent

All Known Implementing Classes:

PSwingMouseEvent, PSwingMouseMotionEvent, PSwingMouseWheelEvent

public interface PSwingEvent

Interface allowing PSwing events that originated from swing and are destined for PSwing nodes must conform to.

Method Summary

MouseEvent	asMouseEvent() Returns this event as a mouse event.
void	dispatchTo(Object listener) Calls appropriate method on the listener based on this events ID.
PNode	getCurrentNode() Get the current node that is under the cursor.
PPickPath	getCurrentPath() Get the path from the PCanvas down to the visual component currently under the mouse.This may give a different result then getGrabPath() during a MOUSE_DRAGGED or MOUSE_RELEASED operation.
PNode	getGrabNode() Determine the node the event originated at.
PPickPath	getGrabPath() Return the path from the PCanvas down to the currently grabbed object.
int	getID() Determine the event type.
Point2D	getLocalPoint() Returns the x,y position of the event in the local coordinate system of the node the event occurred on.
double	getLocalX() Returns the horizontal x position of the event in the local coordinate system of the node the event occurred on.
double	getLocalY() Returns the vertical y position of the event in the local coordinate system of the node the event occurred on.
PNode	getNode() Determine the node the event originated at.
PPickPath	getPath() Determine the path the event took from the PCanvas down to the visual component.
void	setSource(Object aSource) Set the source of this event.

Method Detail

getLocalPoint

Point2D getLocalPoint()

Returns the x,y position of the event in the local coordinate system of the node the event occurred on.

Returns:

a Point2D object containing the x and y coordinates local to the node.

getLocalX

double getLocalX()

Returns the horizontal x position of the event in the local coordinate system of the node the event occurred on.

Returns:

x a double indicating horizontal position local to the node.

getLocalY

double getLocalY()

Returns the vertical y position of the event in the local coordinate system of the node the event occurred on.

Returns:

y a double indicating vertical position local to the node.

getID

int getID()

Determine the event type.

Returns:

the id

getNode

PNode getNode()

Determine the node the event originated at. If an event percolates up the tree and is handled by an event listener higher up in the tree than the original node that generated the event, this returns the original node. For mouse drag and release events, this is the node that the original matching press event went to - in other words, the event is 'grabbed' by the originating node.

Returns:

the node

getPath

PPickPath getPath()

Determine the path the event took from the PCanvas down to the visual component.

Returns:

the path

getGrabNode

PNode getGrabNode()

Determine the node the event originated at. If an event percolates up the tree and is handled by an event listener higher up in the tree than the original node that generated the event, this returns the original node. For mouse drag and release events, this is the node that the original matching press event went to - in other words, the event is 'grabbed' by the originating node.

Returns:

the node

getGrabPath

PPickPath getGrabPath()

Return the path from the PCanvas down to the currently grabbed object.

Returns:

the path

getCurrentNode

PNode getCurrentNode()

Get the current node that is under the cursor. This may return a different result then getGrabNode() when in a MOUSE_RELEASED or MOUSE_DRAGGED event.

Returns:

the current node.

getCurrentPath

PPickPath getCurrentPath()

Get the path from the PCanvas down to the visual component currently under the mouse.This may give a different result then getGrabPath() during a MOUSE_DRAGGED or MOUSE_RELEASED operation.

Returns:

the current path.

dispatchTo

void dispatchTo(Object listener)

Calls appropriate method on the listener based on this events ID.

Parameters:

listener - the MouseListener or MouseMotionListener to dispatch to.

setSource

void setSource(Object aSource)

Set the source of this event. As the event is fired up the tree the source of the event will keep changing to reflect the scenegraph object that is firing the event.

Parameters:

aSource - the source of the event

asMouseEvent

MouseEvent asMouseEvent()

Returns this event as a mouse event. This reduces the need to cast instances of this interface when they are known to all extend MouseEvent.

Returns:

this object casted to a MouseEvent