info.bioinfweb.tic.input

Class TICInputEvent

java.lang.Object

java.util.EventObject

info.bioinfweb.tic.input.TICEvent

info.bioinfweb.tic.input.TICInputEvent

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

Direct Known Subclasses:

TICKeyEvent, TICMouseEvent

public class TICInputEvent
extends TICEvent

All toolkit independent input events in TIC should be inherited from this class.

Author:

Ben Stöver

See Also:

Serialized Form

Module:

info.bioinfweb.tic.core

Field Summary

Fields inherited from class java.util.EventObject

source

Constructor Summary

Constructors

Constructor and Description
TICInputEvent(TICComponent source, int id, long time, int modifiers) Creates a new instance of this class.

Method Summary

Modifier and Type	Method and Description
TICInputEvent	clone()
TICInputEvent	cloneWithNewSource(TICComponent source) Creates a copy of this event with all properties set to identical values but with a different source.
boolean	equals(java.lang.Object obj)
int	getID()
int	getModifiers()
long	getTime()
int	hashCode()
boolean	isAltDown() Determines whether the alt button was pressed during this event.
boolean	isAltGraphDown() Determines whether the alt graph button was pressed during this event.
boolean	isControlDown() Determines whether a control button was pressed during this event.
boolean	isMenuShortcutKeyDown() Tests whether the menu shortcut key is pressed (Command on Mac and Control on the other OS).
boolean	isMetaDown() Determines platform independent whether a meta button was pressed during this event.
boolean	isMouseButton1Down() Determines whether mouse button 1 was pressed during this event.
boolean	isMouseButton2Down() Determines whether mouse button 2 was pressed during this event.
boolean	isMouseButton3Down() Determines whether mouse button 3 was pressed during this event.
boolean	isShiftDown() Determines whether a shift button was pressed during this event.

Methods inherited from class info.bioinfweb.tic.input.TICEvent

getSource

Methods inherited from class java.util.EventObject

toString

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

TICInputEvent

public TICInputEvent(TICComponent source,
                     int id,
                     long time,
                     int modifiers)

Creates a new instance of this class. Objects of this type should not be instantiated directly but an inherited class should be used instead.

Parameters:

source - the TIC component triggering this event

id - the AWT ID identifying the event (e.g. KeyEvent.KEY_RELEASED or MouseEvent.MOUSE_CLICKED)

time - the time (in milliseconds) when the event happened

modifiers - the modifier keys in AWT format (see constants in KeyEvent)

Method Detail

getID

public int getID()

getTime

public long getTime()

getModifiers

public int getModifiers()

isShiftDown

public boolean isShiftDown()

Determines whether a shift button was pressed during this event.

Returns:

true if the button was pressed while this event happened, false otherwise.

isControlDown

public boolean isControlDown()

Determines whether a control button was pressed during this event.

Returns:

true if the button was pressed while this event happened, false otherwise.

isAltDown

public boolean isAltDown()

Determines whether the alt button was pressed during this event.

Returns:

true if the button was pressed while this event happened, false otherwise.

isAltGraphDown

public boolean isAltGraphDown()

Determines whether the alt graph button was pressed during this event.

Note that in the current implementation this method will always return false if this event was triggered by a SWT component.

Returns:

true if the button was pressed while this event happened, false otherwise.

isMetaDown

public boolean isMetaDown()

Determines platform independent whether a meta button was pressed during this event.

Note that in the current implementation this method will always return false if this event was triggered by a SWT component.

Returns:

true if the button was pressed while this event happened, false otherwise.

isMouseButton1Down

public boolean isMouseButton1Down()

Determines whether mouse button 1 was pressed during this event.

Returns:

true if the button was pressed while this event happened, false otherwise.

isMouseButton2Down

public boolean isMouseButton2Down()

Determines whether mouse button 2 was pressed during this event.

Returns:

true if the button was pressed while this event happened, false otherwise.

isMouseButton3Down

public boolean isMouseButton3Down()

Determines whether mouse button 3 was pressed during this event.

Returns:

true if the button was pressed while this event happened, false otherwise.

isMenuShortcutKeyDown

public boolean isMenuShortcutKeyDown()

Tests whether the menu shortcut key is pressed (Command on Mac and Control on the other OS).

Returns:

true if the button was pressed while this event happened, false otherwise.

cloneWithNewSource

public TICInputEvent cloneWithNewSource(TICComponent source)

Description copied from class: TICEvent

Creates a copy of this event with all properties set to identical values but with a different source.

Overrides:

cloneWithNewSource in class TICEvent

Parameters:

source - the source component to be used for the created copy

Returns:

the modified copy of this instance

clone

public TICInputEvent clone()

Overrides:

clone in class TICEvent

hashCode

public int hashCode()

Overrides:

hashCode in class TICEvent

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class TICEvent