bibliothek.gui.dock.event

Interface DockStationListener

All Known Implementing Classes:

DockableShowingManager, DockStationAdapter

@LayoutLocked
public interface DockStationListener

This listener is added to a DockStation. It receives events on adding or removing children of the station, or if the visibility of a child has changed.

Author:

Benjamin Sigg

Method Summary

Modifier and Type	Method and Description
void	dockableAdded(DockStation station, Dockable dockable) Invoked after dockable has been added to station. Note: this method is called when the tree of DockElements contains the new element, other properties - like the bounds of the Component of dockable - might not yet be set.
void	dockableAdding(DockStation station, Dockable dockable) Invoked before dockable is added to station.
void	dockableRemoved(DockStation station, Dockable dockable) Invoked after dockable has been removed from station.
void	dockableRemoving(DockStation station, Dockable dockable) Invoked before dockable is removed from station.
void	dockableSelected(DockStation station, Dockable oldSelection, Dockable newSelection) Called when dockable has been selected.
void	dockableShowingChanged(DockStation station, Dockable dockable, boolean showing) Invoked if the visibility of a child has been changed.
void	dockablesRepositioned(DockStation station, Dockable[] dockables) Called when the location and/or size of one or several dockables changed.

Method Detail

dockableAdding

void dockableAdding(DockStation station,
                    Dockable dockable)

Invoked before dockable is added to station.

Parameters:

station - the station where the new child will be added

dockable - the new child

dockableRemoving

void dockableRemoving(DockStation station,
                      Dockable dockable)

Invoked before dockable is removed from station.

Parameters:

station - the station where the old child will be removed

dockable - the old child

dockableAdded

void dockableAdded(DockStation station,
                   Dockable dockable)

Invoked after dockable has been added to station.
Note: this method is called when the tree of DockElements contains the new element, other properties - like the bounds of the Component of dockable - might not yet be set.

Parameters:

station - the station where the new child was added

dockable - the new child

dockableRemoved

void dockableRemoved(DockStation station,
                     Dockable dockable)

Invoked after dockable has been removed from station.

Parameters:

station - the station where the old child was removed

dockable - the old child

dockableShowingChanged

void dockableShowingChanged(DockStation station,
                            Dockable dockable,
                            boolean showing)

Invoked if the visibility of a child has been changed. In this context visibility means whether the user can or cannot see the dockable. See also Dockable.isDockableShowing().
Callers may use the class DockableShowingManager to organize the calls in an easy way.

Parameters:

station - the station whose children have changed their visibility

dockable - the Dockable whose visibility has changed

showing - the new visibility-state

dockableSelected

void dockableSelected(DockStation station,
                      Dockable oldSelection,
                      Dockable newSelection)

Called when dockable has been selected. The value of dockable should be the same as DockStation.getFrontDockable().

Parameters:

station - the source of the event

oldSelection - the element which was selected before the change, can be null

newSelection - the current value of DockStation.getFrontDockable(), can be null

dockablesRepositioned

void dockablesRepositioned(DockStation station,
                           Dockable[] dockables)

Called when the location and/or size of one or several dockables changed. This means that DockStation.getDockableProperty(Dockable, Dockable) now returns another value than before. This method may or may not be called for Dockables that were just added or being removed from station.

Parameters:

station - the source of the event

dockables - the affected elements