com.tensegrity.composite.event.base
Class BCMouseEvent

java.lang.Object
  com.tensegrity.composite.event.base.AbstractBaseCompositeEvent
      com.tensegrity.composite.event.base.BCMouseEvent

All Implemented Interfaces:

BaseCompositeEvent, CompositeRootEvent

public class BCMouseEvent

extends AbstractBaseCompositeEvent

The MouseEvent occurs whenever a mouse interaction has taken place to a BaseComposite.

Version:

$Id: BCMouseEvent.java,v 1.9 2004/07/06 07:12:12 MichaelKegel Exp $

Author:

MichaelKegel

Constructor Summary

BCMouseEvent(BaseComposite basecomposite, MouseInfo mouseInfo, Coordinate coordinate)
Constructor for MouseEvent with a BaseComposite given by basecomposite for which the event is generated and a MouseInfo object that hold the necessary informations about the state of the mouse, a timestamp and such.

Method Summary

Coordinate	getLocation() Returns the current location of the mouse in units of the window toolkit the BaseComposite (repectiveliy the CompositeView) is resided in.
Coordinate	getLocationInCompositeSpace() Returns the current location of the mouse in units of the coordinate system of the BaseComposite.
Coordinate	getLocationInViewSpace() Returns the current location of the mouse in units of the coordinate system of the CompositeView the BaseComposite is resided in.
MouseInfo	getMouseInfo() Returns a MouseInfo object.
java.lang.String	toString()

Methods inherited from class com.tensegrity.composite.event.base.AbstractBaseCompositeEvent

getBaseComposite

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

BCMouseEvent

public BCMouseEvent(BaseComposite basecomposite,
                    MouseInfo mouseInfo,
                    Coordinate coordinate)

Constructor for MouseEvent with a BaseComposite given by basecomposite for which the event is generated and a MouseInfo object that hold the necessary informations about the state of the mouse, a timestamp and such.

Parameters:

basecomposite - the BaseComposite the event occurs at

mouseInfo - the MouseInfo object

coordinate - the Coordinate of the event.

Method Detail

getMouseInfo

public MouseInfo getMouseInfo()

Returns a MouseInfo object. To get more informations about this object please see the documentation about the MouseInfo class.

Returns:

MouseInfo the MouseInfo object

getLocation

public Coordinate getLocation()

Returns the current location of the mouse in units of the window toolkit the BaseComposite (repectiveliy the CompositeView) is resided in.

Returns:

Coordinate the current location of the mouse in units of the window toolkit

getLocationInViewSpace

public Coordinate getLocationInViewSpace()

Returns the current location of the mouse in units of the coordinate system of the CompositeView the BaseComposite is resided in.

Returns:

Coordinate the current location of the mouse in units of the CompositeView

getLocationInCompositeSpace

public Coordinate getLocationInCompositeSpace()

Returns the current location of the mouse in units of the coordinate system of the BaseComposite.

Returns:

Coordinate the current location of the mouse in units of the BaseComposite

toString

public java.lang.String toString()