4,10 → 4,10 |
* Coded by: Group 5, software practice summer 2003 |
* University of Bielefeld, Germany |
* |
* @version $Revision: 1.17 $ |
* @version $Revision: 1.18 $ |
* |
* Last modification: $Date: 2003/07/21 13:51:17 $ |
* $Id: DocumentManagerInterface.java,v 1.17 2003/07/21 13:51:17 hjokusch Exp $ |
* Last modification: $Date: 2003/07/21 14:04:00 $ |
* $Id: DocumentManagerInterface.java,v 1.18 2003/07/21 14:04:00 smcsporr Exp $ |
*/ |
|
package src.control; |
20,72 → 20,62 |
import org.apache.xerces.dom.DocumentImpl; |
|
/** |
* The Interface <code> DocumentManagerInterface </code> is made to interact with the |
* DocumentManager, which implements this interface. It cotains methods to manage the |
* documents. |
* This interface describes the functionality, which an implementation of a |
* document manager must provide. |
* |
* @author Holger |
* |
* @version $Revision: 1.87 $ Last modification: $Date: 2003/07/21 15:36:37 $ |
*/ |
public interface DocumentManagerInterface { |
|
/** |
* The methode<code>changeToDocument</code> changes the actual |
* <code>changeToDocument</code> changes the actual |
* document to the document with the file name specified. |
* |
* @param fileName: The name of the file belonging to a parsed document in the |
* <code>openDocumentList</code> which should be the new actual document. |
* |
* @return true, if it was able to change to the document, false if not |
* |
* author Group 5 |
* |
* Last revision: 16-Jul-2003 |
* @return <code>true</code>, if it was able to change to the specified document, |
* <code>false</code> otherwise. |
*/ |
public boolean changeToDocument(File documentName); |
|
/** |
* The methode <code> closeActualDocument is to remove an opened document |
* from the openDocument List and to let it disappear from the screen |
* |
* author Group 5 |
* The method <code>closeActualDocument</code> is used to remove an open document |
* from the internal document list and to update the program display afterwards. |
* |
*/ |
public void closeActualDocument(); |
|
/** |
* The methode <code> getActualDocument</code> is do get the |
* <code> documentImpl</code> of the actual document |
/** |
* This method returns the document object of the current <code>OurDocument</code> instance. |
* |
* @see org.apache.xerces.dom.DocumentImpl; |
* @return The implementation of a DOM document. |
* |
* @return DocumentImpl see @see |
* |
* author Group 5 |
* @see src.document.OurDocument |
*/ |
public DocumentImpl getActualDocument(); |
public DocumentImpl getActualDocument(); |
|
/** |
* The methode <code> getOpendDocumentList </code> is to get the |
* FileNames of all opened documents |
/** |
* The method <code>getOpenDocumentList</code> returns a <code>LinkedList</code> with the |
* file names of all currently opened <code>OurDocument</code> instances. |
* |
* @return a LinkedList containing the FileNames of all opened Documents |
* @return A list containing the file names of the currently opened documents. |
* |
* author Group 5 |
* @see src.document.OurDocument |
*/ |
public LinkedList getOpendDocumentList(); |
|
/** |
* The methode <code> closeAll </code> delets all opened Documents from |
* the openDocumentList and from the screen with checking, |
* if the documents are saved |
* This method closes all opened documents using the method |
* <code>closeAllDocumentsWithSaveConfimation</code>. |
* |
* author Group 5 |
* @see closeAllDocumentsWithSaveConfirmation |
*/ |
public void closeAll(); |
|
/** |
* The method <code>setActualVisibleTree</code> sets |
* a <code>Vector</code> of the visible TreePaths(<code> TreePath</code>) |
* a <code>Vector</code> of the visible <code>TreePath</code>s. |
* |
* @param en: An <code>Enumeration</code> of <code>TreePath</code> objects. |
* |
110,22 → 100,16 |
* chooses one. |
* |
* @return Returns <code>true</code>, if a file has been chosen, false otherwise. |
* |
* Last revision: 08-Jul-2003 |
*/ |
public boolean loadDocument(); |
|
/** |
* <code>setNewDTD</code> launches a method that changes a document's DTD grammar. |
* |
* Last revision: 11-Jul-2003 |
*/ |
public void setNewDTD(); |
|
/** |
* <code>setNewSchema</code> launches a method that changes a document's XML schema. |
* |
* Last revision: 14-Jul-2003 |
*/ |
public void setNewSchema(); |
|
132,8 → 116,6 |
/** |
* <code>makeNewDocument</code> creates a new <code>OurDocument</code> object and |
* adds it to an internal document list. |
* |
* Last revision: 10-Jul-2003 |
*/ |
public void makeNewDocument(); |
|
141,8 → 123,6 |
* <code>saveActualDocument</code> launches a method that saves the active document. |
* This is a kind of a quicksave function and can only be used if the corresponding |
* file name of the current document is available. |
* |
* Last revision: 08-Jul-2003 |
*/ |
public void saveActualDocument(); |
|
149,38 → 129,30 |
/** |
* <code>saveActualDocumentAs</code> saves the active document in a specified file |
* chosen by the user. |
* |
* Last revision: 08-Jul-2003 |
*/ |
public void saveActualDocumentAs(); |
|
/** |
* The method <code>setDocument</code> gives the actual Document a |
* XML document as <code>DocumentImpl</code> |
/** |
* This method sets the document object of the current <code>OurDocument</code> |
* instance to the given parameter. |
* |
* @param docu: A XML document as <code>DocumentImpl</code>. |
* @param document: A DOM implementation of a document. |
* |
* @see org.apache.xerces.dom.DocumentImpl |
* |
* Last revision: 21-Jul-2003 |
* @see src.document.OurDocument |
*/ |
public void setDocument(DocumentImpl docu); |
public void setDocument(DocumentImpl document); |
|
/** |
* This method checks, if the actual Document has been changed and not saved. |
* |
* @return <code>true</code> if document has been changed, <code>false</code> otherwise. |
* |
* Last revision: 21-Jul-2003 |
*/ |
public boolean actualDocumentChanged(); |
|
/** |
* Delivers the name of the actual document. |
* Delivers the title of the actual document. |
* |
* @return The name of the actual document (which is also used in the GUI). |
* |
* Last revision: 13-Jul-2003 by Sascha W. |
* @return The title of the actual document (which is also used in the GUI). |
*/ |
public String getActualDocumentName(); |
|
188,8 → 160,6 |
* Returns the <code>File</code> object belonging to the actual document |
* |
* @return The file's path and name from which the actual document has been parsed. |
* |
* Last revision: 16-Jul-2003 |
*/ |
public File getActualDocumentFile(); |
} |