Document (Starlink-UK API)

All Known Implementing Classes:

AbstractDocument, GraphDocument, MultipageDocument, SketchDocument, TextDocument
```
public interface Document
```
Document is an interface that captures the notion of a document in a graphical application. Typically, documents are associated with files, although this is not necessarily so. Each application will typically create one or more implementations of this interface for the types of documents it can work with.

Version:

$Revision: 1.15 $

Author:

John Reekie (johnr@eecs.berkeley.edu)

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`void`	`addPropertyChangeListener(PropertyChangeListener listener)` Add a property change listener to this document.
`void`	`close()` Close the document.
`Application`	`getApplication()` Get the application that this document belongs to.
`UndoableEditSupport`	`getEditSupport()` Return the undoable edit support.
`File`	`getFile()` Get the file object that this document is associated with.
`String`	`getShortTitle()` Get the short title of this document.
`String`	`getTitle()` Get the title of this document
`UndoManager`	`getUndoManager()` Return the undo manager of this document.
`URL`	`getURL()` Get the URL that this document is associated with.
`boolean`	`isDirty()` Test the "dirty" flag.
`boolean`	`isEditable()` Test the "editable" flag.
`boolean`	`isWritable()` Test the "writable" flag.
`void`	`open()` Open the document from its current file or URL.
`void`	`removePropertyChangeListener(PropertyChangeListener listener)` Remove a property change listener from this document.
`void`	`save()` Save the document to its current file or URL.
`void`	`saveAs(File file)` Save the document to the given file.
`void`	`saveAs(URL url)` Save the document to the given URL.
`void`	`setDirty(boolean flag)` Set the "dirty" flag.
`void`	`setEditable(boolean flag)` Set the "editable" flag.
`void`	`setFile(File file)` Set the file that this document saves itself to.
`void`	`setURL(URL url)` Set the URL that this document saves itself to.
`void`	`setWritable(boolean flag)` Set the "writable" flag.

- Method Detail
  - addPropertyChangeListener
```
void addPropertyChangeListener(PropertyChangeListener listener)
```
    Add a property change listener to this document. Changes to certain elements of the state of the Document require that registered property change listeners be notified of the change.
  - close
```
void close()
    throws Exception
```
    Close the document. Do not attempt to save the document first or do any other user-interface things like that. This method can thrown an exception if there is a failure, but it should only do so if there is no way it can recover. Note that actions such as querying the user to save a modified document and so on are the responsibility of the application, not the Document implementation.
    
    Throws:
    
    Exception - If the close operation fails.
  - getApplication
```
Application getApplication()
```
    Get the application that this document belongs to.
  - getEditSupport
```
UndoableEditSupport getEditSupport()
```
    Return the undoable edit support. You need this to post edits.
  - getUndoManager
```
UndoManager getUndoManager()
```
    Return the undo manager of this document.
  - getFile
```
File getFile()
```
    Get the file object that this document is associated with. If the document has multiple file objects, then get the one that can be considered the "primary" one. This field may be null.
    
    See Also:
    
    getURL()
  - getTitle
```
String getTitle()
```
    Get the title of this document
  - getShortTitle
```
String getShortTitle()
```
    Get the short title of this document. The short title is used in situations where the regular title is likely to be too long, such as iconified windows, menus, and so on.
  - getURL
```
URL getURL()
```
    Get the URL that this document is associated with. If the document has multiple URL objects, then get the one that can be considered the "primary" one. This field may be null.
    
    See Also:
    
    getFile()
  - isDirty
```
boolean isDirty()
```
    Test the "dirty" flag. If changes made to a document haven't been saved, this flag is set to true.
  - isEditable
```
boolean isEditable()
```
    Test the "editable" flag. In general, editors should only allow a document's data to be changed if this flag is set.
  - isWritable
```
boolean isWritable()
```
    Test the "writable" flag. In general, editors should only allow a document's data to be writen to storage if this flag is set.
  - open
```
void open()
   throws Exception
```
    Open the document from its current file or URL. Throw an exception if the operation failed.
    
    Throws:
    
    Exception - If the close operation fails.
  - removePropertyChangeListener
```
void removePropertyChangeListener(PropertyChangeListener listener)
```
    Remove a property change listener from this document.
  - save
```
void save()
   throws Exception
```
    Save the document to its current file or URL. Throw an exception if the operation failed. Reasons for failure might include the fact that the file is not writable, or that the document has a URL but we haven't implemented HTTP-DAV support yet...
    
    Throws:
    
    Exception - If the save operation fails.
  - saveAs
```
void saveAs(File file)
     throws Exception
```
    Save the document to the given file. Throw an exception if the operation failed. Return true if successful, false if not. Do not change the file attribute to the new File object as that is the responsibility of the application, which it will do according to its storage policy.
    
    Throws:
    
    Exception - If the save-as operation fails.
    
    See Also:
    
    save()
  - saveAs
```
void saveAs(URL url)
     throws Exception
```
    Save the document to the given URL. Throw an exception if the operation failed. Do not change the URL attribute to the new URL object as that is the responsibility of the application, which it will do according to its storage policy.
    
    Throws:
    
    Exception - If the save-as operation fails.
    
    See Also:
    
    save()
  - setEditable
```
void setEditable(boolean flag)
```
    Set the "editable" flag. Fire a property change event to registered listeners.
  - setFile
```
void setFile(File file)
```
    Set the file that this document saves itself to. This is a low-level method and should only be used by storage policy classes. Fire a property change listener to registered listeners.
  - setDirty
```
void setDirty(boolean flag)
```
    Set the "dirty" flag. Fire a property change event to registered listeners.
  - setURL
```
void setURL(URL url)
```
    Set the URL that this document saves itself to. This is a low-level method and should only be used by storage policy classes. Fire a property change listener to registered listeners.
  - setWritable
```
void setWritable(boolean flag)
```
    Set the "writable" flag. Fire a property change event to registered listeners.

Interface Document

Method Summary

Method Detail

addPropertyChangeListener

close

getApplication

getEditSupport

getUndoManager

getFile

getTitle

getShortTitle

getURL

isDirty

isEditable

isWritable

open

removePropertyChangeListener

save

saveAs

saveAs

setEditable

setFile

setDirty

setURL

setWritable