4,10 → 4,10 |
* Coded by: Group 5, software practice summer 2003 |
* University of Bielefeld, Germany |
* |
* @version $Revision: 1.24 $ |
* @version $Revision: 1.25 $ |
* |
* Last modification: $Date: 2003/07/22 14:11:44 $ |
* $Id: DocumentManagerInterface.java,v 1.24 2003/07/22 14:11:44 smcsporr Exp $ |
* Last modification: $Date: 2003/07/22 19:59:04 $ |
* $Id: DocumentManagerInterface.java,v 1.25 2003/07/22 19:59:04 smcsporr Exp $ |
*/ |
|
package src.control; |
22,7 → 22,9 |
* This interface describes the functionality, which an implementation of a |
* document manager must provide. |
* |
* @version $Revision: 1.24 $ Last modification: $Date: 2003/07/22 14:11:44 $ |
* @see src.control.DocumentManager |
* |
* @version $Revision: 1.25 $ Last modification: $Date: 2003/07/22 19:59:04 $ |
*/ |
public interface DocumentManagerInterface { |
|
64,12 → 66,6 |
public LinkedList getOpenDocumentList(); |
|
/** |
* This method closes all opened documents using the method |
* <code>closeAllDocumentsWithSaveConfimation</code>. |
*/ |
public void closeAll(); |
|
/** |
* The method <code>setActualVisibleTree</code> sets |
* a <code>LinkedList</code> of the visible <code>TreePath</code>s. |
* |
82,9 → 78,9 |
|
/** |
* The method <code>getActualVisibleTree</code> returns |
* an <code>LinkedList</code> of the visible <code>TreePath</code>s. |
* a <code>LinkedList</code> of the visible <code>TreePath</code>s. |
* |
* @return LinkedList of the TreePath objects |
* @return A <code>LinkedList</code> of <code>TreePath</code> objects |
* |
* @see javax.swing.tree.TreePath |
* @see java.util.LinkedList |
92,19 → 88,29 |
public LinkedList getActualVisibleTree(); |
|
/** |
* The methode <code>setExpression</code> sets the xpathExpression to save the actual XPath expression |
* The method <code>setExpression</code> saves an xpathExpression to |
* store information to restore the state of the tree display. |
* |
* @param expression the XPath expression |
* @param expression: An XPath expression. |
*/ |
public void setExpression(String expression); |
|
/** |
* The methode <code>getExpression</code> return the actual XPath expression |
* The method <code>getExpression</code> returns the current XPath expression. |
* |
* @return the XPath expression set |
* @return An XPath expression. |
* |
* @see src.control.DocumentManagerInterface#setExpression |
*/ |
public String getExpression(); |
|
/** |
* The method <code>closeActualDocumentWithSaveCofirmation</code> closes |
* the active document. If it has not been saved, a dialog will appear to ask the user if |
* he really doesn't want to save the file before closing it. |
*/ |
public void closeActualDocumentWithSaveConfirmation(); |
|
/** |
* This method displays a <code>JFileChooser</code> and parses a file if the user |
* chooses one. |
114,12 → 120,16 |
public boolean loadDocument(); |
|
/** |
* <code>setNewDTD</code> launches a method that changes a document's DTD grammar. |
* <code>setNewDTD</code> lets the user choose a DTD file and launches a method in the |
* current <code>OurDocument</code> instance that changes it's DTD grammar file entry |
* to the chosen file. |
*/ |
public void setNewDTD(); |
|
/** |
* <code>setNewSchema</code> launches a method that changes a document's XML schema. |
* <code>setNewSchema</code> lets the user choose an XML schema file and launches a method in |
* the current <code>OurDocument</code> instance that changes it's XML schema file entry |
* to the chosen file. |
*/ |
public void setNewSchema(); |
|
130,6 → 140,17 |
public void makeNewDocument(); |
|
/** |
* <code>createNewFileWithDTD</code> creates a new document and sets a new |
* DTD grammar. A root node will be inserted according to the chosen DTD. |
*/ |
public void createNewFileWithDTD(); |
|
/** |
* <code>createNewFileWithSchema</code> creates a new document and sets a new |
*/ |
public void createNewFileWithSchema(); |
|
/** |
* <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. |
172,4 → 193,20 |
* @return The file's path and name from which the actual document has been parsed. |
*/ |
public File getActualDocumentFile(); |
|
/** |
* This method closes all opened documents using the method |
* <code>closeAllDocumentsWithSaveConfimation</code>. |
*/ |
public void closeAll(); |
|
/** |
* This method saves all opened documents using the methods |
* <code>saveActualDocument</code> and, if the actual document doesn't |
* exist as saved document, <code>saveActualDocumentAs</code>. |
* |
* @see src.control.DocumentManager#saveActualDocument |
* @see src.control.DocumentManager#saveActualDocumentAs |
*/ |
public void saveAll(); |
} |