DockableStateWillChangeEvent (VLSolutions Docking Framework 2.1.4 API)

Class DockableStateWillChangeEvent

public class DockableStateWillChangeEvent extends Object

An event triggered before a change of dockable state.

Events are triggered when a component is :

Docked (added to the desktop)
set in Auto-hide mode (collapsed as a border button)
closed (removed from the desktop)
maximized
floating (detached from its window)

Note that event are not triggered by drag-dock moves (they don't correspond to a state change). If you need to track such changes, use a Swing AncestorListener, or override the addNotify method of your dockable component.

It is also possible to track changes after they occur with the DockableStateChangeEvent .

See Also: javax.swing.event.AncestorListener

Constructor Summary
	DockableStateWillChangeEvent(DockableState currentState, DockableState futureState)

Constructor Summary

DockableStateWillChangeEvent(DockableState currentState, DockableState futureState)

Method Summary
void	cancel() Refuse the change of dockable state.
DockableState	getCurrentState() this method will return null when the event is triggered for initial docking
DockableState	getFutureState() Returns the future (proposed) state of the dockable. if cancel() is called on the event, this state change will be vetoed.
boolean	isAccepted()

Method Summary

void

cancel()

Refuse the change of dockable state.

DockableState

getCurrentState()

this method will return null when the event is triggered for initial docking

DockableState

getFutureState()

Returns the future (proposed) state of the dockable. if cancel() is called on the event, this state change will be vetoed.

boolean

isAccepted()