pub.vlsolutions.swing.docking.event

Class DockableStateChangeEvent

java.lang.Object

pub.vlsolutions.swing.docking.event.DockableStateChangeEvent

public class DockableStateChangeEvent
extends java.lang.Object

An event triggered after 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 (the only one visible)
• floating (detached from the desktop)

It is also possible to track changes before they occurs with the DockableStateWillChangeEvent, which is triggered before the change is processed (this event is vetoable).

Version:

1.0

Author:

Lilian Chamontin, vlsolutions.

See Also:

DockableStateWillChangeEvent, DockableStateChangeListener

Constructor Summary

Constructors

Constructor and Description
DockableStateChangeEvent(DockableState previousState, DockableState newState)

Method Summary

Methods

Modifier and Type	Method and Description
DockableState	getNewState() returns the new state of the dockable
DockableState	getPreviousState() returns the previous state of the dockable, or null if the component wasn't known to the docking desktop before.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DockableStateChangeEvent

public DockableStateChangeEvent(DockableState previousState,
                        DockableState newState)

Method Detail

getPreviousState

public DockableState getPreviousState()

returns the previous state of the dockable, or null if the component wasn't known to the docking desktop before.

getNewState

public DockableState getNewState()

returns the new state of the dockable