Eclipse GEF
2.1

org.eclipse.gef.tools
Class AbstractTool.Input

java.lang.Object
  |
  +--org.eclipse.gef.util.FlagSupport
        |
        +--org.eclipse.gef.tools.AbstractTool.Input
Enclosing class:
AbstractTool

public static class AbstractTool.Input
extends FlagSupport

Allows the user to access mouse and keyboard input.


Constructor Summary
AbstractTool.Input()
           
 
Method Summary
protected  int getModifiers()
          Returns the event modifiers.
 Point getMouseLocation()
          Returns the current location of the mouse.
 boolean isAltKeyDown()
          Returns true if the ALT key is pressed.
 boolean isAnyButtonDown()
          Returns true if any of the 3 mouse buttons are pressed.
 boolean isControlKeyDown()
          Returns true if the CTRL key is pressed.
 boolean isMouseButtonDown(int which)
          Returns true if the specified button is down.
 boolean isShiftKeyDown()
          Returns true if the SHIFT key is pressed.
 void setInput(MouseEvent me)
          Sets the mouse and keyboard input based on the MouseEvent.
 void setMouseButton(int which, boolean state)
          Sets mouse button # which to be pressed if state is true.
 
Methods inherited from class org.eclipse.gef.util.FlagSupport
getFlag, setFlag
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

AbstractTool.Input

public AbstractTool.Input()
Method Detail

getModifiers

protected int getModifiers()
Returns the event modifiers. Modifiers are defined in MouseEvent.stateMask, and include things like the mouse buttons and keyboard modifier keys.

Returns:
the event modifiers

getMouseLocation

public Point getMouseLocation()
Returns the current location of the mouse.

Returns:
the mouse location

isAltKeyDown

public boolean isAltKeyDown()
Returns true if the ALT key is pressed.

Returns:
true if the ALT key is pressed

isAnyButtonDown

public boolean isAnyButtonDown()
Returns true if any of the 3 mouse buttons are pressed.

Returns:
true if any of the 3 mouse buttons are pressed

isControlKeyDown

public boolean isControlKeyDown()
Returns true if the CTRL key is pressed.

Returns:
true of CTRL pressed

isMouseButtonDown

public boolean isMouseButtonDown(int which)
Returns true if the specified button is down.

Parameters:
which - which button
Returns:
true if the button is down

isShiftKeyDown

public boolean isShiftKeyDown()
Returns true if the SHIFT key is pressed.

Returns:
true if SHIFT pressed

setMouseButton

public void setMouseButton(int which,
                           boolean state)
Sets mouse button # which to be pressed if state is true.

Parameters:
which - which button
state - true if button down

setInput

public void setInput(MouseEvent me)
Sets the mouse and keyboard input based on the MouseEvent.

Parameters:
me - the mouse event providing the input

Eclipse GEF
2.1

Copyright (c) IBM Corp. and others 2000, 2003. All Rights Reserved.