Package 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
Constructors Constructor Description Input()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description protected intgetModifiers()Returns the event modifiers.org.eclipse.draw2d.geometry.PointgetMouseLocation()Returns the current location of the mouse.booleanisAltKeyDown()Returnstrueif the ALT key is pressed.booleanisAnyButtonDown()Returnstrueif any of the mouse buttons are pressed.booleanisControlKeyDown()Returnstrueif the CTRL key is pressed.booleanisModKeyDown(int mod)Returnstrueif any of the given mod keys are pressed.booleanisMouseButtonDown(int which)Returnstrueif the specified button is down.booleanisShiftKeyDown()Returnstrueif the SHIFT key is pressed.voidsetInput(KeyEvent ke)Sets the keyboard input based on the KeyEvent.voidsetInput(MouseEvent me)Sets the mouse and keyboard input based on the MouseEvent.voidsetMouseButton(int which, boolean state)Sets mouse button #whichto be pressed ifstateis true.voidsetMouseLocation(int x, int y)Sets the current location of the mouse-
Methods inherited from class org.eclipse.gef.util.FlagSupport
getFlag, setFlag
-
-
-
-
Method Detail
-
getModifiers
protected int getModifiers()
Returns the event modifiers. Modifiers are defined inMouseEvent.stateMask, and include things like the mouse buttons and keyboard modifier keys.- Returns:
- the event modifiers
-
getMouseLocation
public org.eclipse.draw2d.geometry.Point getMouseLocation()
Returns the current location of the mouse.- Returns:
- the mouse location
-
isAltKeyDown
public boolean isAltKeyDown()
Returnstrueif the ALT key is pressed.- Returns:
trueif the ALT key is pressed
-
isAnyButtonDown
public boolean isAnyButtonDown()
Returnstrueif any of the mouse buttons are pressed.- Returns:
trueif any of the mouse buttons are pressed
-
isControlKeyDown
public boolean isControlKeyDown()
Returnstrueif the CTRL key is pressed.- Returns:
trueof CTRL pressed
-
isModKeyDown
public boolean isModKeyDown(int mod)
Returnstrueif any of the given mod keys are pressed.- Parameters:
mod- SWT.MOD1, SWT.MOD2, SWT.MOD3, SWT.MOD4 or any combination thereof- Returns:
trueif the given mod key is pressed- Since:
- 3.1
-
isMouseButtonDown
public boolean isMouseButtonDown(int which)
Returnstrueif the specified button is down.- Parameters:
which- which button- Returns:
trueif the button is down
-
isShiftKeyDown
public boolean isShiftKeyDown()
Returnstrueif the SHIFT key is pressed.- Returns:
trueif SHIFT pressed
-
setInput
public void setInput(KeyEvent ke)
Sets the keyboard input based on the KeyEvent.- Parameters:
ke- the key event providing the input
-
setInput
public void setInput(MouseEvent me)
Sets the mouse and keyboard input based on the MouseEvent.- Parameters:
me- the mouse event providing the input
-
setMouseButton
public void setMouseButton(int which, boolean state)Sets mouse button #whichto be pressed ifstateis true.- Parameters:
which- which buttonstate-trueif button down
-
setMouseLocation
public void setMouseLocation(int x, int y)Sets the current location of the mouse- Parameters:
x- x locationy- y location- Since:
- 3.4
-
-