bibliothek.gui.dock.common.event

Interface CVetoClosingListener

public interface CVetoClosingListener

This listener can be called before a CDockable or a set of CDockables are closed. Subclasses can fire a veto indicating that some CDockable must not yet be closed.
Please note:

• It may not always be possible to cancel a closing-operation.
• There is no guarantee that closing(CVetoClosingEvent) is called before closed(CVetoClosingEvent)
• The event-object passed to closing(CVetoClosingEvent) and closed(CVetoClosingEvent) may not be equal, even if they describe the same event
• Events may be split: if closing(CVetoClosingEvent) was called once and handled three dockables, then closed(CVetoClosingEvent) may be called three times to handle one dockable
• MultipleCDockables that are not children of a CWorkingArea are closed and re-opened if the layout changes (CControl.load(String)). This may be prevented with a correct implementation of MultipleCDockableFactory.match.

Author:

Benjamin Sigg

See Also:

CControl.addVetoClosingListener(CVetoClosingListener), CControl.removeVetoClosingListener(CVetoClosingListener), CDockable.addVetoClosingListener(CVetoClosingListener), CDockable.removeVetoClosingListener(CVetoClosingListener)

Method Summary

Modifier and Type	Method and Description
void	closed(CVetoClosingEvent event) Called after a set of CDockables has been closed.
void	closing(CVetoClosingEvent event) Called before a set of CDockables gets closed.

Method Detail

closing

void closing(CVetoClosingEvent event)

Called before a set of CDockables gets closed. This method may be invoked with events that are already canceled, check the CVetoClosingEvent.isCanceled() property.

Parameters:

event - the event that will happen but may be canceled

closed

void closed(CVetoClosingEvent event)

Called after a set of CDockables has been closed. This method may be called without closing(CVetoClosingEvent) been called beforehand.

Parameters:

event - the event that has already happened