bibliothek.gui.dock.event

Interface VetoableDockFrontendListener

All Known Implementing Classes:

VetoableDockFrontendAdapter

public interface VetoableDockFrontendListener

This listener is added to a DockFrontend. It gets informed before and after a Dockable is shown or hidden. In some cases this listener can cancel the operation.
The number of calls of a method of this listener does not have to be the same number for any other method. Also an array of Dockables given to one method may be split up into many arrays the next time or when given to another method. It is however guaranteed that there are no false alarms (i.e. an already invisible Dockable will never be given to hiding(VetoableDockFrontendEvent)).
Note: the scope of this listener is limited, please read the comments of DockFrontend.addVetoableListener(VetoableDockFrontendListener) for further information.

Author:

Benjamin Sigg

Method Summary

Modifier and Type	Method and Description
void	hidden(VetoableDockFrontendEvent event) Called whenever a set of Dockable was hidden.
void	hiding(VetoableDockFrontendEvent event) Called before a set of Dockables is hidden.
void	showing(VetoableDockFrontendEvent event) Called before a Dockable is shown.
void	shown(VetoableDockFrontendEvent event) Called whenever a Dockable was shown.

Method Detail

showing

void showing(VetoableDockFrontendEvent event)

Called before a Dockable is shown. To abort the operation, VetoableDockFrontendEvent.cancel() can be invoked. This method may not be called for all Dockables, it is certainly called if a client opens a Dockable through DockFrontend.show(Dockable)

Parameters:

event - description of the element to close

shown

void shown(VetoableDockFrontendEvent event)

Called whenever a Dockable was shown. Other than showing(VetoableDockFrontendEvent) this method is always called.

Parameters:

event - description of the element and how it got shown

hiding

void hiding(VetoableDockFrontendEvent event)

Called before a set of Dockables is hidden. To abort the operation, VetoableDockFrontendEvent.cancel() can be invoked. This method may not always be invoked for all Dockables, it is certainly invoked if DockFrontend.hide(Dockable) is called or if DockFrontend.setSetting(bibliothek.gui.dock.frontend.Setting, boolean).

Parameters:

event - description of the element to close

hidden

void hidden(VetoableDockFrontendEvent event)

Called whenever a set of Dockable was hidden. Other than hiding(VetoableDockFrontendEvent) this method is always called.

Parameters:

event - description of the element and how it got closed