com.tensegrity.gui.document.event
Interface DocumentListener

All Superinterfaces:

EventListenerTag

All Known Implementing Classes:

ApplicationFrame, DocumentAdapter, DocumentEventMultiplexer, SwingToolBar, SwtToolBar, TreeOutliner, ZoomComboBox

public interface DocumentListener

extends EventListenerTag

The listener interface for receiving events that are related to an mdicomponent instance.

Version:

$Id: DocumentListener.java,v 1.6 2003/03/04 13:20:55 sr Exp $

Author:

Stepan Rutz

Method Summary

void	documentAdded(DocumentEvent documentevent) Invoked after a document was added to the mdicomponent.
void	documentModelChanged(DocumentEvent documentevent) Invoked after a document's model has changed.
void	documentPreAdd(DocumentEvent documentevent) Invoked when a document is about to be added to a mdicomponent.
void	documentPreRemove(DocumentEvent documentevent) Invoked when a document is about to be removed from a mdicomponent.
void	documentRemoved(DocumentEvent documentevent) Invoked after a document was removed from the mdicomponent.
void	documentSelected(DocumentEvent documentevent) Invoked after a document was selected in the mdicomponent.
void	documentUnselected(DocumentEvent documentevent) Invoked after a document was unselected in the mdicomponent.

Method Detail

documentPreAdd

public void documentPreAdd(DocumentEvent documentevent)
                    throws DocumentEventVetoException

Invoked when a document is about to be added to a mdicomponent. If the implementor throws the declared exception then the documentevent will be veto'd and the corresponding action will not be commence.

Parameters:

documentevent - the documentevent structure carrying information.

Throws:

DocumentEventVetoException - indicates that the documentevent is not desired.

documentPreRemove

public void documentPreRemove(DocumentEvent documentevent)
                       throws DocumentEventVetoException

Invoked when a document is about to be removed from a mdicomponent. If the implementor throws the declared exception then the documentevent will be veto'd and the corresponding action will not be commence.

Parameters:

documentevent - the documentevent structure carrying information.

Throws:

DocumentEventVetoException - indicates that the documentevent is not desired.

documentAdded

public void documentAdded(DocumentEvent documentevent)

Invoked after a document was added to the mdicomponent.

Parameters:

documentevent - the documentevent structure carrying information.

documentRemoved

public void documentRemoved(DocumentEvent documentevent)

Invoked after a document was removed from the mdicomponent.

Parameters:

documentevent - the documentevent structure carrying information.

documentSelected

public void documentSelected(DocumentEvent documentevent)

Invoked after a document was selected in the mdicomponent.

Parameters:

documentevent - the documentevent structure carrying information.

documentUnselected

public void documentUnselected(DocumentEvent documentevent)

Invoked after a document was unselected in the mdicomponent.

Parameters:

documentevent - the documentevent structure carrying information.

documentModelChanged

public void documentModelChanged(DocumentEvent documentevent)

Invoked after a document's model has changed. This means the data behind the document has changed subtantially and needs to be rehashed.

Parameters:

documentevent - the documentevent structure carrying information.