com.swath.event
Class UserButtonPressed

java.lang.Object
  com.swath.event.SwathEvent
      com.swath.event.UserButtonPressed

All Implemented Interfaces:

EventIfc

public final class UserButtonPressed

extends com.swath.event.SwathEvent

The UserButtonPressed event.
Posted: When a user toolbar button is pressed.

Since:

SWATH 1.7

Method Summary

char	getButton() Gets the user toolbar button that was pressed.
java.lang.String	getClassName() Gets the event class name.
boolean	isEventClass(java.lang.Class eventClass) Indicates if this event matches a given event class.
boolean	isUserDefined() Indicates if this event is user defined or not.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getButton

public char getButton()

Gets the user toolbar button that was pressed.

Returns:

The button character.

Since:

SWATH 1.7

isEventClass

public final boolean isEventClass(java.lang.Class eventClass)

Description copied from interface: EventIfc

Indicates if this event matches a given event class.

Specified by:

isEventClass in interface EventIfc

Parameters:

eventClass - The event class.

Returns:

true if this event is of the same class, otherwise false.

isUserDefined

public final boolean isUserDefined()

Description copied from interface: EventIfc

Indicates if this event is user defined or not.

Specified by:

isUserDefined in interface EventIfc

Returns:

true if user defined, otherwise false.

getClassName

public final java.lang.String getClassName()

Description copied from interface: EventIfc

Gets the event class name.

Specified by:

getClassName in interface EventIfc

Returns:

The class name.