com.vlsolutions.swing.docking.event
Class DockableStateWillChangeEvent
java.lang.Object
com.vlsolutions.swing.docking.event.DockableStateWillChangeEvent
public class DockableStateWillChangeEvent
extends java.lang.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 .
cancel
public void cancel()
Refuse the change of dockable state.
The docking action is cancelled.
getCurrentState
public DockableState getCurrentState()
this method will return null when the event is triggered for initial docking
getFutureState
public DockableState getFutureState()
Returns the future (proposed) state of the dockable. if cancel() is called on the event,
this state change will be vetoed.
isAccepted
public boolean isAccepted()
© Copyright 2004-2006 VLSolutions. All Rights Reserved.
www.vlsolutions.com : Java Components - Smart Client Applications