com.javadocking.event
Class ChildDockEvent

java.lang.Object
  java.util.EventObject
      com.javadocking.event.DockingEvent
          com.javadocking.event.ChildDockEvent

All Implemented Interfaces:

java.io.Serializable

public class ChildDockEvent
extends DockingEvent

This kind of event is broad-casted when a child dock is added, moved, or removed from a composite dock. It is broad-casted:

• before the adding
• after the adding
• before the move
• after the move
• before the removing
• after the removing

Author:

Heidi Rakels.

See Also:

Serialized Form

Field Summary

Fields inherited from class java.util.EventObject

source

Constructor Summary

ChildDockEvent(java.lang.Object source, CompositeDock originDock, CompositeDock destinationDock, Dock childDock)
Constructs a docking event for the given composite dock and child dock.

Method Summary

Dock	getChildDock() Gets the child dock that is added, moved, or removed.

Methods inherited from class com.javadocking.event.DockingEvent

getDestinationDock, getOriginDock

Methods inherited from class java.util.EventObject

getSource, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

ChildDockEvent

public ChildDockEvent(java.lang.Object source,
                      CompositeDock originDock,
                      CompositeDock destinationDock,
                      Dock childDock)

Constructs a docking event for the given composite dock and child dock.

Parameters:

source - The object on which the event initially occurred.

originDock - The composite dock from which the child dock is removed or moved. Null when the child dock is added.

destinationDock - The dock to which the child dock is added or moved. Null when the child dock is removed.

childDock - The child dock that is added, moved, or removed.

Throws:

java.lang.IllegalArgumentException - If the child dock is null.

Method Detail

getChildDock

public Dock getChildDock()

Gets the child dock that is added, moved, or removed.

Returns:

The child dock that is added, moved, or removed.