com.tensegrity.gui.document.event
Class DocumentAdapter

java.lang.Object
  com.tensegrity.gui.document.event.DocumentAdapter

All Implemented Interfaces:

DocumentListener, EventListenerTag

public class DocumentAdapter

extends java.lang.Object

implements DocumentListener

A convenience adapter-class for document-listeners.

Version:

$Id: DocumentAdapter.java,v 1.6 2003/11/20 08:57:32 sr Exp $

Author:

Stepan Rutz

Constructor Summary

DocumentAdapter()
Constructs a new DocumentAdapter instance.

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.

Methods inherited from class java.lang.Object

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

Constructor Detail

DocumentAdapter

public DocumentAdapter()

Constructs a new DocumentAdapter instance.

Method Detail

documentPreAdd

public void documentPreAdd(DocumentEvent documentevent)
                    throws DocumentEventVetoException

Description copied from interface: DocumentListener

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.

Specified by:

documentPreAdd in interface DocumentListener

Parameters:

documentevent - the documentevent structure carrying information.

Throws:

DocumentEventVetoException - indicates that the documentevent is not desired.

documentPreRemove

public void documentPreRemove(DocumentEvent documentevent)
                       throws DocumentEventVetoException

Description copied from interface: DocumentListener

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.

Specified by:

documentPreRemove in interface DocumentListener

Parameters:

documentevent - the documentevent structure carrying information.

Throws:

DocumentEventVetoException - indicates that the documentevent is not desired.

documentAdded

public void documentAdded(DocumentEvent documentevent)

Description copied from interface: DocumentListener

Invoked after a document was added to the mdicomponent.

Specified by:

documentAdded in interface DocumentListener

Parameters:

documentevent - the documentevent structure carrying information.

documentRemoved

public void documentRemoved(DocumentEvent documentevent)

Description copied from interface: DocumentListener

Invoked after a document was removed from the mdicomponent.

Specified by:

documentRemoved in interface DocumentListener

Parameters:

documentevent - the documentevent structure carrying information.

documentSelected

public void documentSelected(DocumentEvent documentevent)

Description copied from interface: DocumentListener

Invoked after a document was selected in the mdicomponent.

Specified by:

documentSelected in interface DocumentListener

Parameters:

documentevent - the documentevent structure carrying information.

documentUnselected

public void documentUnselected(DocumentEvent documentevent)

Description copied from interface: DocumentListener

Invoked after a document was unselected in the mdicomponent.

Specified by:

documentUnselected in interface DocumentListener

Parameters:

documentevent - the documentevent structure carrying information.

documentModelChanged

public void documentModelChanged(DocumentEvent documentevent)

Description copied from interface: DocumentListener

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

Specified by:

documentModelChanged in interface DocumentListener

Parameters:

documentevent - the documentevent structure carrying information.