ilog.views.graphic.composite.objectinteractor
Class IlvCompositeActionEvent

java.lang.Object
  extended by java.util.EventObject
      extended by java.awt.AWTEvent
          extended by java.awt.event.ActionEvent
              extended by ilog.views.graphic.composite.objectinteractor.IlvCompositeActionEvent
All Implemented Interfaces:
Serializable

public class IlvCompositeActionEvent
extends ActionEvent

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

Since:
JViews 6.0
See Also:
IlvCompositeGraphic, 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
IlvCompositeActionEvent(MouseEvent mouseEvent, String command, IlvComposite compositeNode, int childIndex, IlvCompositeContext compositeContext, IlvObjectInteractorContext objectIteractorContext)
          Constructs an IlvCompositeActionEvent object with modifier keys.
 
Method Summary
 int getChildIndex()
          Returns the index of the child on which the event occurred
 IlvCompositeContext getCompositeContext()
          Returns the composite context of this event
 IlvComposite getCompositeNode()
          Returns the IlvCompositeGraphic instance on which the event occurred
 IlvObjectInteractorContext getObjectInteractorContext()
          Returns the object interactor which triggered the event
 IlvPoint getPoint()
          Returns the point in manager coordinates where this event occurred
 IlvTransformer getTransformer()
          Returns the transformer of the interactor context.
 
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

IlvCompositeActionEvent

public IlvCompositeActionEvent(MouseEvent mouseEvent,
                               String command,
                               IlvComposite compositeNode,
                               int childIndex,
                               IlvCompositeContext compositeContext,
                               IlvObjectInteractorContext objectIteractorContext)
Constructs an IlvCompositeActionEvent object with modifier keys.

Note that passing in an invalid id results in unspecified behavior.

Parameters:
mouseEvent - mouse event that triggered this action
command - a string that may specify a command (possibly one of several) associated with the event
compositeNode - the IlvCompositeGraphic on which the event occurred
childIndex - index of the child of the composite graphic on which the event occurred
compositeContext - allows the action listeners to change the SDM model properties of the object being represented by the composite graphic
objectIteractorContext - the context passed to the IlvCompositeInteractor
See Also:
IlvCompositeContext, IlvCompositeInteractor
Method Detail

getCompositeNode

public IlvComposite getCompositeNode()
Returns the IlvCompositeGraphic instance on which the event occurred


getObjectInteractorContext

public IlvObjectInteractorContext getObjectInteractorContext()
Returns the object interactor which triggered the event

Since:
JViews 8.0

getCompositeContext

public IlvCompositeContext getCompositeContext()
Returns the composite context of this event

Since:
JViews 8.0
See Also:
IlvCompositeContext

getTransformer

public IlvTransformer getTransformer()
Returns the transformer of the interactor context.

Since:
JViews 8.0

getPoint

public IlvPoint getPoint()
Returns the point in manager coordinates where this event occurred

Since:
JViews 8.0

getChildIndex

public int getChildIndex()
Returns the index of the child on which the event occurred

Since:
JViews 8.0


Copyright © 1996-2007 ILOG S.A. All rights reserved.   Documentation homepage.