DockingEvent (Rogue Wave JViews 9.1 API)

java.lang.Object
- java.util.EventObject
- - ilog.views.appframe.swing.docking.DockingEvent

All Implemented Interfaces:

Serializable
```
public class DockingEvent
extends EventObject
```
The docking event emitted by the docking area when a docking event has occurred.

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`DOCKABLE_PANE_ACTIVATED` This event indicates that a dockable pane has been activated.
`static int`	`DOCKABLE_PANE_DEACTIVATED` This event indicates that a dockable pane has been deactivated.
`static int`	`DOCKABLE_PANE_DOCKED` This event indicates that a dockable pane has been docked.
`static int`	`DOCKABLE_PANE_HIDDEN` This event indicates that a dockable pane has been hidden.
`static int`	`DOCKABLE_PANE_MOVED` This event indicates that a floatable window has been moved.
`static int`	`DOCKABLE_PANE_SHOWN` This event indicates that a dockable pane has been shown.
`static int`	`DOCKABLE_PANE_UNDOCKED` This event indicates that a dockable pane has been undocked.
`static int`	`DOCKING_AREA_INITIALIZED` This event indicates that the docking area has been initialized.
`static int`	`DOCKING_FIRST` The first number in the range of IDs used for docking events.
`static int`	`DOCKING_LAST` The last number in the range of IDs used for docking events.
`static int`	`WORKSPACE_ACTIVATED` This event indicates that a workspace configuration has been activated.
`static int`	`WORKSPACE_ADDED` This event indicates that a workspace configuration has been added.
`static int`	`WORKSPACE_DEACTIVATED` This event indicates that a workspace configuration has been deactivated.
`static int`	`WORKSPACE_REINITIALIZED` This event indicates that a workspace configuration has been reinitialized.
`static int`	`WORKSPACE_REMOVED` This event indicates that a workspace configuration has been removed.

Fields inherited from class java.util.EventObject
source

Constructor Summary

Constructors
Constructor and Description
`DockingEvent(int id, String name)` Constructs a `DockingEvent` object with the specified id and docked container source.
`DockingEvent(int id, String[] names)` Constructs a `DockingEvent` object with the specified id and docked container sources.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`getDockableCount()` Returns the number of dockables involved in this docking event.
`String`	`getDockableName()` Returns the name of the dockable involved in this event.
`String[]`	`getDockableNames()` Returns an array of the names of the dockables involved in this event.
`Point`	`getFloatingLocation()` Returns the position of the floating window containing the dockable that fired this event.
`int`	`getID()` Returns the event type.
`String`	`getOppositeDockableName()` Returns the name of the other dockable involved in the activation change.
`String`	`getWorkspaceName()` Returns the name of the workspace configuration that has been activated or deactivated.
`boolean`	`isDocked()` Determines whether the dockable that fired this event is docked.
`boolean`	`isUndocked()` Determines whether the dockable that fired this event is undocked.
`String`	`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
  - DOCKING_FIRST
```
public static final int DOCKING_FIRST
```
    The first number in the range of IDs used for docking events.
    
    See Also:
    
    Constant Field Values
  - DOCKABLE_PANE_ACTIVATED
```
public static final int DOCKABLE_PANE_ACTIVATED
```
    This event indicates that a dockable pane has been activated.
    
    See Also:
    
    Constant Field Values
  - DOCKABLE_PANE_DEACTIVATED
```
public static final int DOCKABLE_PANE_DEACTIVATED
```
    This event indicates that a dockable pane has been deactivated.
    
    See Also:
    
    Constant Field Values
  - DOCKABLE_PANE_HIDDEN
```
public static final int DOCKABLE_PANE_HIDDEN
```
    This event indicates that a dockable pane has been hidden.
    
    See Also:
    
    Constant Field Values
  - DOCKABLE_PANE_SHOWN
```
public static final int DOCKABLE_PANE_SHOWN
```
    This event indicates that a dockable pane has been shown.
    
    See Also:
    
    Constant Field Values
  - DOCKABLE_PANE_DOCKED
```
public static final int DOCKABLE_PANE_DOCKED
```
    This event indicates that a dockable pane has been docked.
    
    See Also:
    
    Constant Field Values
  - DOCKABLE_PANE_UNDOCKED
```
public static final int DOCKABLE_PANE_UNDOCKED
```
    This event indicates that a dockable pane has been undocked.
    
    See Also:
    
    Constant Field Values
  - DOCKABLE_PANE_MOVED
```
public static final int DOCKABLE_PANE_MOVED
```
    This event indicates that a floatable window has been moved.
    
    See Also:
    
    Constant Field Values
  - WORKSPACE_ADDED
```
public static final int WORKSPACE_ADDED
```
    This event indicates that a workspace configuration has been added.
    
    See Also:
    
    Constant Field Values
  - WORKSPACE_REMOVED
```
public static final int WORKSPACE_REMOVED
```
    This event indicates that a workspace configuration has been removed.
    
    See Also:
    
    Constant Field Values
  - WORKSPACE_ACTIVATED
```
public static final int WORKSPACE_ACTIVATED
```
    This event indicates that a workspace configuration has been activated.
    
    See Also:
    
    Constant Field Values
  - WORKSPACE_DEACTIVATED
```
public static final int WORKSPACE_DEACTIVATED
```
    This event indicates that a workspace configuration has been deactivated.
    
    See Also:
    
    Constant Field Values
  - WORKSPACE_REINITIALIZED
```
public static final int WORKSPACE_REINITIALIZED
```
    This event indicates that a workspace configuration has been reinitialized.
    
    See Also:
    
    Constant Field Values
  - DOCKING_AREA_INITIALIZED
```
public static final int DOCKING_AREA_INITIALIZED
```
    This event indicates that the docking area has been initialized.
    
    See Also:
    
    Constant Field Values
  - DOCKING_LAST
```
public static final int DOCKING_LAST
```
    The last number in the range of IDs used for docking events.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - DockingEvent
```
public DockingEvent(int id,
                    String name)
```
    Constructs a DockingEvent object with the specified id and docked container source.
    
    Parameters:
    
    id - The ID of the docking event.
    
    name - The name of the dockable involved in this docking event.
  - DockingEvent
```
public DockingEvent(int id,
                    String[] names)
```
    Constructs a DockingEvent object with the specified id and docked container sources.
    
    Parameters:
    
    id - The ID of the docking event.
    
    names - The array of names of the dockables involved in this docking event.
- Method Detail
  - getID
```
public int getID()
```
    Returns the event type.
  - getDockableName
```
public String getDockableName()
```
    Returns the name of the dockable involved in this event. This method should only be called if one dockable is involved in this docking event. Otherwise, the method getDockableNames() should be invoked to retrieve the dockables associated with this event.
    Note that only one dockable can be involved for the following events:
    See Also:
    
    getDockableNames(), getDockableCount()
  - getDockableNames
```
public String[] getDockableNames()
```
    Returns an array of the names of the dockables involved in this event. This method should only be called if more than one dockable is involved in this docking event. Otherwise, the method getDockableName() should be invoked to retrieve the dockable associated with this event.
    
    See Also:
    
    getDockableName(), getDockableCount()
  - getDockableCount
```
public int getDockableCount()
```
    Returns the number of dockables involved in this docking event.
    
    Returns:
    
    The number of dockables.
    
    See Also:
    
    getDockableName(), getDockableNames()
  - getFloatingLocation
```
public Point getFloatingLocation()
```
    Returns the position of the floating window containing the dockable that fired this event.
    
    Returns:
    
    The screen coordinates of the floating window if the method isUndocked() returns true; null otherwise.
  - isDocked
```
public boolean isDocked()
```
    Determines whether the dockable that fired this event is docked.
    
    Returns:
    
    true if the dockable is docked; false otherwise.
  - isUndocked
```
public boolean isUndocked()
```
    Determines whether the dockable that fired this event is undocked.
    
    Returns:
    
    true if the dockable is undocked; false otherwise.
  - getOppositeDockableName
```
public String getOppositeDockableName()
```
    Returns the name of the other dockable involved in the activation change. If the ID of the event is DOCKABLE_PANE_ACTIVATED, this method returns the name of the dockable being deactivated. If the ID of the event is DOCKABLE_PANE_DEACTIVATED, this method returns the name of the dockable being activated. If the ID of the event is not one of the two events DOCKABLE_PANE_ACTIVATED or DOCKABLE_PANE_DEACTIVATED, this method returns null.
    
    Since:
    
    JViews6.0
  - getWorkspaceName
```
public String getWorkspaceName()
```
    Returns the name of the workspace configuration that has been activated or deactivated.
    
    See Also:
    
    WORKSPACE_ACTIVATED, WORKSPACE_DEACTIVATED
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class EventObject

Class DockingEvent

Field Summary

Fields inherited from class java.util.EventObject

Constructor Summary

Method Summary

Methods inherited from class java.util.EventObject

Methods inherited from class java.lang.Object

Field Detail

DOCKING_FIRST

DOCKABLE_PANE_ACTIVATED

DOCKABLE_PANE_DEACTIVATED

DOCKABLE_PANE_HIDDEN

DOCKABLE_PANE_SHOWN

DOCKABLE_PANE_DOCKED

DOCKABLE_PANE_UNDOCKED

DOCKABLE_PANE_MOVED

WORKSPACE_ADDED

WORKSPACE_REMOVED

WORKSPACE_ACTIVATED

WORKSPACE_DEACTIVATED

WORKSPACE_REINITIALIZED

DOCKING_AREA_INITIALIZED

DOCKING_LAST

Constructor Detail

DockingEvent

DockingEvent

Method Detail

getID

getDockableName

getDockableNames

getDockableCount

getFloatingLocation

isDocked

isUndocked

getOppositeDockableName

getWorkspaceName

toString