ilog.cpl.interactor
Class IlpObjectActionEvent

java.lang.Object
  java.util.EventObject
      java.awt.AWTEvent
          java.awt.event.ActionEvent
              ilog.cpl.interactor.IlpObjectActionEvent

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

IlpMoveObjectActionEvent, IlpUpdateObjectActionEvent

public class IlpObjectActionEvent
extends ActionEvent

When an action is triggered by an object interactor, the action event received by the action is an object action event. The event allows the action to find out the context of the interaction which triggered it.

Since:

JTGO 3.0

See Also:

IlpDefaultObjectInteractor, IlpInteractor.setGestureAction(ilog.cpl.interactor.IlpGesture, javax.swing.Action), IlpInteractor.setKeyStrokeAction(javax.swing.KeyStroke, javax.swing.Action), Serialized Form

Field Summary

Fields inherited from class java.awt.event.ActionEvent

ACTION_FIRST, ACTION_LAST, ACTION_PERFORMED, ALT_MASK, CTRL_MASK, META_MASK, SHIFT_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, MOUSE_WHEEL_EVENT_MASK, PAINT_EVENT_MASK, RESERVED_ID_MAX, TEXT_EVENT_MASK, WINDOW_EVENT_MASK, WINDOW_FOCUS_EVENT_MASK, WINDOW_STATE_EVENT_MASK

Fields inherited from class java.util.EventObject

source

Constructor Summary

IlpObjectActionEvent(IlpObjectInteractionContext context, IlpInteractionState state, int modifiers)
Creates an object action event.

IlpObjectActionEvent(IlpObjectInteractionContext context, int modifiers)
Creates an object action event.

Method Summary

IlpGraphic	getGraphic() Returns the graphic on which the interaction occurred.
IlpInteractionState	getInteractionState() Looks up the interaction state corresponding to the interaction context present in this event.
IlpPoint	getPosition() Returns the mouse position where the interaction ended.
IlpRepresentationObject	getRepresentationObject() Returns the representation object on which the interaction occurred.
IlpPoint	getStartingPosition() Returns the mouse position where the interaction started.
IlpGraphicView	getView() Returns the view in which the interaction occurred.

Methods inherited from class java.awt.event.ActionEvent

getActionCommand, getModifiers, getWhen, paramString

Methods inherited from class java.awt.AWTEvent

consume, getID, isConsumed, setSource, toString

Methods inherited from class java.util.EventObject

getSource

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

IlpObjectActionEvent

public IlpObjectActionEvent(IlpObjectInteractionContext context,
                            int modifiers)

Creates an object action event.

Parameters:

context - The object interaction context which led to the triggering of the action.

modifiers - The modifiers of the interaction which led to the triggering of the action.

Throws:

NullPointerException - if the given interaction context is null.

IlpObjectActionEvent

public IlpObjectActionEvent(IlpObjectInteractionContext context,
                            IlpInteractionState state,
                            int modifiers)

Creates an object action event.

Parameters:

context - The object interaction context which led to the triggering of the action.

state - The interaction's state.

modifiers - The modifiers of the interaction which led to the triggering of the action.

Throws:

NullPointerException - if the given interaction context is null.

Method Detail

getInteractionState

public IlpInteractionState getInteractionState()

Looks up the interaction state corresponding to the interaction context present in this event.

Returns:

The interaction state when the event occurred or null, if the interaction state information has not been provided to this event.

Since:

JTGO 4.0

getView

public IlpGraphicView getView()

Returns the view in which the interaction occurred.

getGraphic

public IlpGraphic getGraphic()

Returns the graphic on which the interaction occurred. May be null.

getRepresentationObject

public IlpRepresentationObject getRepresentationObject()

Returns the representation object on which the interaction occurred.

getPosition

public IlpPoint getPosition()

Returns the mouse position where the interaction ended. May be null.

getStartingPosition

public IlpPoint getStartingPosition()

Returns the mouse position where the interaction started. May be null.