com.javadocking.event
Class DockableEvent

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

All Implemented Interfaces:

java.io.Serializable

public class DockableEvent
extends DockingEvent

This kind of event is broad-casted when a dockable is added to a dock, moved in a dock, moved to another dock, or removed from a dock. It is broad-casted before the docking change and after the docking change.

Author:

Heidi Rakels.

See Also:

Serialized Form

Field Summary

Fields inherited from class java.util.EventObject

source

Constructor Summary

DockableEvent(java.lang.Object source, Dock originDock, Dock destinationDock, Dockable dockable)
Constructs a docking event for the given dock and dockable.

Method Summary

Dockable

getDockable() Gets the dockable that is added to a dock, moved in a dock, moved to another dock, or removed from a dock.

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

DockableEvent

public DockableEvent(java.lang.Object source,
                     Dock originDock,
                     Dock destinationDock,
                     Dockable dockable)

Constructs a docking event for the given dock and dockable.

Parameters:

source - The object on which the event initially occurred.

originDock - The dock from which the dockable is removed or moved. Null when the dockable was closed before.

destinationDock - The dock to which the dockable is added or moved. Null when the dockable is closed.

dockable - The dockable that is added to a dock, moved in a dock, moved to another dock, or removed from a dock.

Throws:

java.lang.IllegalArgumentException - If the dock or dockable are null.

Method Detail

getDockable

public Dockable getDockable()

Gets the dockable that is added to a dock, moved in a dock, moved to another dock, or removed from a dock.

Returns:

The dockable that is added to a dock, moved in a dock, moved to another dock, or removed from a dock.