Package com.vlsolutions.swing.docking.event

Events Package of the VLDocking Framework.

See:
Description

Interface Summary

DockableSelectionListener	This interface describes a listener for dockable selection changes.
DockableStateChangeListener	Interface implemented by classes that need to be notified of a state change of a dockable.
DockableStateWillChangeListener	Interface implemented by classes that need to be notified of a state change of a dockable before it is processed.
DockingActionListener	A listener to docking actions.

Class Summary

DockableSelectionEvent	An event for tracking selection changes of dockables.
DockableStateChangeEvent	An event triggered after a change of dockable state.
DockableStateWillChangeEvent	An event triggered before a change of dockable state.
DockDragEvent	An event describing a drag operation occuring for docking purpose.
DockDropEvent	An event send to a dockDropReceiver to complete a drop operation
DockEvent	Abstract superclass of drag and drop docking events.
DockingActionAddDockableEvent	A DockingActionEvent describing the first insertion of a dockable either inside a desktop docking panel (main panel) or into a compoundDockable (nested) container.
DockingActionCloseEvent	A DockingActionEvent describing the closing of a dockable
DockingActionCreateTabEvent	A DockingActionEvent describing a tab insertion (or movement).
DockingActionDockableEvent	A DockingActionEvent involving a single dockable as source of the action.
DockingActionEvent	An abstract event class describing a docking action.
DockingActionSimpleStateChangeEvent	An event describing a basic state change.
DockingActionSplitComponentEvent	A DockingActionEvent describing a split action (from a base component (splitcontainer, tab...)).
DockingActionSplitDockableContainerEvent	A split event : split a base component in two, and puts a dockable container in the other split position.
DockingActionSplitDockableEvent	A DockingActionEvent describing a split action (from a base dockable).

Package com.vlsolutions.swing.docking.event Description

Events Package of the VLDocking Framework.

This package contains event and listeners classes of the docking framework.

There are two types of events :

• Drag and Drop events, used for docking processing.
• State-change event, used for notifications.

Drag and Drop events

Those events are used by the docking framework to process Docking operations.

They shoud not be used by User Applications, only by API extenders.

This category contains :

• DockEvent : the ancestor
• DockDragEvent : an event transmitted to DockDropReceivers in order to know if Drag is allowed and which shape should be drawn.
• DockDropEvent : when a DockDragEvent is accepted, and mouse button released, a DockDropEvent is transmitted to a DockDropReceiver. It is its responsibility to call the appropriate methods of DockingDesktop in order to change the docking position of the dragged component.

DockableState events

Those events are used for notification purpose, in order to allow the User Application to track configuration changes on the docking desktop.

Note : there are 3 states :

• docked : component is visible on the docking desktop
• hidden : iconified in an auto-hide border of the docking desktop
• closed : not visible

A state change is triggered only when a Dockable changes of state.
Keep in mind that multiple changes of docking position do not trigger multiple state change events (only the initial docking triggers the event).

This category contains :

• DockableStateWillChangeEvent : a vetoable state change is triggered before state change (for example before a docked component is closed).
  The User application can cancel the event to veto the change.
• DockableStateChangeEvent : a non-vetoable state change is triggered after the state change (for example, after a hidden component is closed), in order to let the user application know about the state change.

The workflow of event delivering is the following

  Dockable in state S1 (docked/hidden/closed)

   "stateChange" requested
      event manager : triggers DockableStateWillChangeEvents
      if (event.isAccepted()){
        process state change
        ...
        Dockable in state S2 != S1 (docked/hidden/closed)
        event manager : triggers DockableStateChangeEvents

      } // else don't change state