ilog.views.appframe.swing.mdi
Class MDIClientEvent

java.lang.Object
  extended by java.util.EventObject
      extended by java.awt.AWTEvent
          extended by ilog.views.appframe.swing.mdi.MDIClientEvent
All Implemented Interfaces:
Serializable

public class MDIClientEvent
extends AWTEvent

An AWTEvent that adds support for IlvMDIClient objects as event sources.

See Also:
Serialized Form

Field Summary
static int MDI_CLIENT_ACTIVATED
          The window activated event type.
static int MDI_CLIENT_CLOSED
          The window closed event.
static int MDI_CLIENT_CLOSING
          The "window is closing" event.
static int MDI_CLIENT_DEACTIVATED
          The window deactivated event type.
static int MDI_CLIENT_DEICONIFIED
          The window-not-minimized event type.
static int MDI_CLIENT_FIRST
          The first number in the range of IDs used for window events.
static int MDI_CLIENT_ICONIFIED
          The window-minimized event.
static int MDI_CLIENT_LAST
          The last number in the range of IDs used for window events.
static int MDI_CLIENT_OPENED
          The window opened event.
 
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
MDIClientEvent(IlvMDIClient mdiClient, int id, IlvMDIViewContainer container)
          Constructs a new MDIClientEvent.
 
Method Summary
 IlvMDIViewContainer getContainer()
          The view container that originated the event.
 IlvMDIClient getMDIClient()
          Returns the MDI client that owns the view container that originated the event.
 String paramString()
          Returns a parameter string identifying this event.
 
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
 

Field Detail

MDI_CLIENT_FIRST

public static final int MDI_CLIENT_FIRST
The first number in the range of IDs used for window events.

See Also:
Constant Field Values

MDI_CLIENT_LAST

public static final int MDI_CLIENT_LAST
The last number in the range of IDs used for window events.

See Also:
Constant Field Values

MDI_CLIENT_OPENED

public static final int MDI_CLIENT_OPENED
The window opened event. This event is delivered only the first time a window is made visible.

See Also:
Constant Field Values

MDI_CLIENT_CLOSING

public static final int MDI_CLIENT_CLOSING
The "window is closing" event. This event is delivered when the user selects "Quit" from the window's system menu. If the program does not explicitly hide or destroy the window while processing this event, the window close operation will be canceled.

See Also:
Constant Field Values

MDI_CLIENT_CLOSED

public static final int MDI_CLIENT_CLOSED
The window closed event. This event is delivered after the window has been closed as the result of a call to hide or destroy.

See Also:
Constant Field Values

MDI_CLIENT_ICONIFIED

public static final int MDI_CLIENT_ICONIFIED
The window-minimized event. This event indicates that the window was shrunk to a small icon.

See Also:
Constant Field Values

MDI_CLIENT_DEICONIFIED

public static final int MDI_CLIENT_DEICONIFIED
The window-not-minimized event type. This event indicates that the window has been restored to its normal size.

See Also:
Constant Field Values

MDI_CLIENT_ACTIVATED

public static final int MDI_CLIENT_ACTIVATED
The window activated event type. This event indicates that keystrokes and mouse clicks are directed towards this window.

See Also:
Constant Field Values

MDI_CLIENT_DEACTIVATED

public static final int MDI_CLIENT_DEACTIVATED
The window deactivated event type. This event indicates that keystrokes and mouse clicks are no longer directed to the window.

See Also:
Constant Field Values
Constructor Detail

MDIClientEvent

public MDIClientEvent(IlvMDIClient mdiClient,
                      int id,
                      IlvMDIViewContainer container)
Constructs a new MDIClientEvent.

Parameters:
mdiClient - The MDI client that owns the view container that originated the event.
id - The ID of the event.
container - The view container that originated the event.
Method Detail

paramString

public String paramString()
Returns a parameter string identifying this event. This method is useful for event logging and for debugging.

Overrides:
paramString in class AWTEvent
Returns:
a string identifying the event and its attributes

getMDIClient

public IlvMDIClient getMDIClient()
Returns the MDI client that owns the view container that originated the event.


getContainer

public IlvMDIViewContainer getContainer()
The view container that originated the event.



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