ilog.cpl.interactor
Class IlpViewActionEvent

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

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

IlpCreateLinkActionEvent, IlpCreateNodeActionEvent, IlpDefaultTableHeaderActionEvent, IlpMoveObjectsActionEvent, IlpRemoveObjectsActionEvent

public class IlpViewActionEvent
extends ActionEvent

When an action is triggered by a view interactor, after having recognized a gesture, the action event received by the action is a view action event. It allows the action to find out the context of the interaction that triggered it.

Since:

JTGO 3.0

See Also:

IlpDefaultViewInteractor, 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

IlpViewActionEvent(IlpViewInteractionContext context, IlpInteractionState state, int modifiers)
Creates a view action event.

IlpViewActionEvent(IlpViewInteractionContext context, int modifiers)
Creates a view action event.

Method Summary

IlpObject	getIlpObject() Returns the first business object involved in the gesture which led to the triggering of the action which receives this action event, or null.
protected IlpViewInteractionContext	getInteractionContext() Returns the view interaction context.
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 first representation object involved in the gesture which led to the triggering of the action which receives this action event, or null.
Collection	getRepresentationObjects() Returns the collection of IlpRepresentationObjects involved in the gesture which led to the triggering of the action which receives this action event.
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

IlpViewActionEvent

public IlpViewActionEvent(IlpViewInteractionContext context,
                          int modifiers)

Creates a view action event.

Parameters:

context - The view 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.

IlpViewActionEvent

public IlpViewActionEvent(IlpViewInteractionContext context,
                          IlpInteractionState state,
                          int modifiers)

Creates a view action event.

Parameters:

context - The view 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.

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.

getRepresentationObjects

public Collection getRepresentationObjects()

Returns the collection of IlpRepresentationObjects involved in the gesture which led to the triggering of the action which receives this action event. The collection may be empty.

getRepresentationObject

public IlpRepresentationObject getRepresentationObject()

Returns the first representation object involved in the gesture which led to the triggering of the action which receives this action event, or null. In most cases, the representation object is the one which was under the mouse when the gesture was recognized.

See Also:

getRepresentationObjects(), getIlpObject()

getIlpObject

public IlpObject getIlpObject()

Returns the first business object involved in the gesture which led to the triggering of the action which receives this action event, or null. In most cases, the business object is the one which was under the mouse when the gesture was recognized.

See Also:

getRepresentationObjects(), getRepresentationObject()

getInteractionContext

protected IlpViewInteractionContext getInteractionContext()

Returns the view interaction context.

Returns:

View interaction context as defined in the constructor.