de.sciss.app
Interface Document

All Superinterfaces:

Disposable

All Known Implementing Classes:

BasicDocument

public interface Document
extends Disposable

The Document interface is an attempt to create common classes and interfaces (the package de.sciss.app) which can be shared by different programmes, such as Meloncillo or FScape, without having to make adjustments in different places each time a modification is made. This interface describes the most prominent methods needed for a general application document.

Version:

0.11, 24-Jun-06

Author:

Hanns Holger Rutz

Method Summary

Application	getApplication() Returns the application carrying this document.
java.lang.String	getName()
UndoManager	getUndoManager() Returns the undo manager responsible for this document.
boolean	isDirty() Asks whether this document contains unsaved changes or not.
void	setDirty(boolean dirty) Marks this document as having unsaved changes or as being saved.

Methods inherited from interface de.sciss.util.Disposable

dispose

Method Detail

getApplication

Application getApplication()

Returns the application carrying this document.

Returns:

the application carrying this document

getUndoManager

UndoManager getUndoManager()

Returns the undo manager responsible for this document.

Returns:

the undo manager responsible for this document

isDirty

boolean isDirty()

Asks whether this document contains unsaved changes or not.

Returns:

true indicates that the document contains unsaved changes, false indicates that the document was saved or cleared.

setDirty

void setDirty(boolean dirty)

Marks this document as having unsaved changes or as being saved.

Parameters:

dirty - true indicates that the document contains unsaved changes, false indicates that the document was saved or cleared.

getName

java.lang.String getName()