gishur.core.event
Class ModifyEvent

java.lang.Object
  |
  +--java.util.EventObject
        |
        +--java.awt.AWTEvent
              |
              +--gishur.core.event.GishurEvent
                    |
                    +--gishur.core.event.ConsumableEvent
                          |
                          +--gishur.core.event.ModifyEvent
All Implemented Interfaces:
java.lang.Cloneable, Cloneable, java.io.Serializable

public class ModifyEvent
extends ConsumableEvent

Event class for tracking modification of objects. Based on java.awt.AWTEvent events of this type can be dispatched on every Component.

Version:
1.0
Author:
Thomas Wolf
See Also:
Serialized Form

Field Summary
static int ACTION
          ID: Another modification-related action.
static int CANCEL_MODIFICATION
          ID: Modification was canceled
static int DO_ACTION
          Sub-Type: General Action.
static int DO_MODIFICATION
          ID: Event released while the modification of the target object takes place.
static int FINISH_MODIFICATION
          ID: Modification finishes.
static int INPUT_OBJECT
          Sub-Type: Input of an object.
static int MODIFY_EVENT_MASK
          Event Mask for ModifyEvents (=={link GishurEvent#MIN_GISHUR_MASK}).
static int MODIFY_OBJECT
          Sub-Type: General object modification.
static int MOVE_OBJECT
          Sub-Type: Object moved.
static int REMOVE_OBJECT
          Sub-Type: Input of an object.
static int RESERVED_SUBTYPE_MAX
          Maximum sub-type value used in this class.
static int ROTATE_OBJECT
          Sub-Type: Object rotated.
static int SCALE_OBJECT
          Sub-Type: Object scaled.
static int START_MODIFICATION
          ID: Begin a modification of the target object.
 
Fields inherited from class gishur.core.event.GishurEvent
AWT_ACTION_EVENT_MASK, AWT_ADJUSTMENT_EVENT_MASK, AWT_COMPONENT_EVENT_MASK, AWT_CONTAINER_EVENT_MASK, AWT_FOCUS_EVENT_MASK, AWT_ITEM_EVENT_MASK, AWT_KEY_EVENT_MASK, AWT_MOUSE_EVENT_MASK, AWT_MOUSE_MOTION_EVENT_MASK, AWT_TEXT_EVENT_MASK, AWT_WINDOW_EVENT_MASK, GISHUR_EVENT_MASK, GISHUR_ID_MASK, MAX_EVENT_TYPES, MIN_GISHUR_MASK
 
Fields inherited from class java.awt.AWTEvent
ACTION_EVENT_MASK, ADJUSTMENT_EVENT_MASK, COMPONENT_EVENT_MASK, consumed, CONTAINER_EVENT_MASK, FOCUS_EVENT_MASK, HIERARCHY_BOUNDS_EVENT_MASK, HIERARCHY_EVENT_MASK, id, INPUT_METHOD_EVENT_MASK, INVOCATION_EVENT_MASK, ITEM_EVENT_MASK, KEY_EVENT_MASK, MOUSE_EVENT_MASK, MOUSE_MOTION_EVENT_MASK, PAINT_EVENT_MASK, RESERVED_ID_MAX, TEXT_EVENT_MASK, WINDOW_EVENT_MASK
 
Fields inherited from class java.util.EventObject
source
 
Constructor Summary
ModifyEvent(java.lang.Object source, int id, int subtype, java.lang.Object target)
          Constructs a new ModifyEvent with the specified source object, id subtype-id and target object
 
Method Summary
 int getSubType()
          Returns the sub-type of the event.
 java.lang.Object getTarget()
          Returns the modified target object.
 java.lang.String toString()
          Returns a string representation of the object.
 
Methods inherited from class gishur.core.event.ConsumableEvent
clone, consume, isConsumed
 
Methods inherited from class gishur.core.event.GishurEvent
isMaskedBy
 
Methods inherited from class java.awt.AWTEvent
finalize, getID, paramString
 
Methods inherited from class java.util.EventObject
getSource
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

MODIFY_EVENT_MASK

public static final int MODIFY_EVENT_MASK
Event Mask for ModifyEvents (=={link GishurEvent#MIN_GISHUR_MASK}).

START_MODIFICATION

public static final int START_MODIFICATION
ID: Begin a modification of the target object.

DO_MODIFICATION

public static final int DO_MODIFICATION
ID: Event released while the modification of the target object takes place.

FINISH_MODIFICATION

public static final int FINISH_MODIFICATION
ID: Modification finishes.

CANCEL_MODIFICATION

public static final int CANCEL_MODIFICATION
ID: Modification was canceled

ACTION

public static final int ACTION
ID: Another modification-related action.

DO_ACTION

public static final int DO_ACTION
Sub-Type: General Action.

INPUT_OBJECT

public static final int INPUT_OBJECT
Sub-Type: Input of an object.

REMOVE_OBJECT

public static final int REMOVE_OBJECT
Sub-Type: Input of an object.

MODIFY_OBJECT

public static final int MODIFY_OBJECT
Sub-Type: General object modification.

MOVE_OBJECT

public static final int MOVE_OBJECT
Sub-Type: Object moved.

SCALE_OBJECT

public static final int SCALE_OBJECT
Sub-Type: Object scaled.

ROTATE_OBJECT

public static final int ROTATE_OBJECT
Sub-Type: Object rotated.

RESERVED_SUBTYPE_MAX

public static final int RESERVED_SUBTYPE_MAX
Maximum sub-type value used in this class.
Constructor Detail

ModifyEvent

public ModifyEvent(java.lang.Object source,
                   int id,
                   int subtype,
                   java.lang.Object target)
Constructs a new ModifyEvent with the specified source object, id subtype-id and target object
Parameters:
source - source object that generated the event
id - type of the event
subtype - sub-type of the event
target - target object that was modified
Method Detail

getTarget

public java.lang.Object getTarget()
Returns the modified target object.
Returns:
the modified target object.

getSubType

public int getSubType()
Returns the sub-type of the event.
Returns:
the sub-type of the event.

toString

public java.lang.String toString()
Returns a string representation of the object. In general, the toString method returns a string that "textually represents" this object.
Overrides:
toString in class java.awt.AWTEvent
Returns:
a string representation of the object.