Package com.vlsolutions.swing.docking.event

Events Package of the VLDocking Framework.

Interface Summary

DockableSelectionListenerThis interface describes a listener for dockable selection changes.
DockableStateChangeListenerInterface implemented by classes that need to be notified of a state change of a dockable.
DockableStateWillChangeListenerInterface implemented by classes that need to be notified of a state change of a dockable before it is processed.
DockingActionListenerA listener to docking actions.

Class Summary

DockableSelectionEventAn event for tracking selection changes of dockables.
DockableStateChangeEventAn event triggered after a change of dockable state.
DockableStateWillChangeEventAn event triggered before a change of dockable state.
DockDragEventAn event describing a drag operation occuring for docking purpose.
DockDropEventAn event send to a dockDropReceiver to complete a drop operation

This event is used by API extenders to manage drag and drop action related to docking.

DockEventAbstract superclass of drag and drop docking events.
DockingActionAddDockableEventA DockingActionEvent describing the first insertion of a dockable either inside a desktop docking panel (main panel) or into a compoundDockable (nested) container.
DockingActionCloseEventA DockingActionEvent describing the closing of a dockable
DockingActionCreateTabEventA DockingActionEvent describing a tab insertion (or movement).
DockingActionDockableEventA DockingActionEvent involving a single dockable as source of the action.
DockingActionEventAn abstract event class describing a docking action.
DockingActionSimpleStateChangeEventAn event describing a basic state change.
DockingActionSplitComponentEventA DockingActionEvent describing a split action (from a base component (splitcontainer, tab...)).
DockingActionSplitDockableContainerEventA split event : split a base component in two, and puts a dockable container in the other split position.
DockingActionSplitDockableEventA DockingActionEvent describing a split action (from a base dockable).

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

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 :

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 :

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 :

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

© Copyright 2004-2006 VLSolutions. All Rights Reserved.
www.vlsolutions.com : Java Components - Smart Client Applications