Subversion Repositories general

Compare Revisions

Ignore whitespace Rev 672 → Rev 673

/sun/xmleditor/trunk/src/control/DocumentManagerInterface.java
4,10 → 4,10
* Coded by: Group 5, software practice summer 2003
* University of Bielefeld, Germany
*
* @version $Revision: 1.15 $
* @version $Revision: 1.16 $
*
* Last modification: $Date: 2003/07/18 14:20:19 $
* $Id: DocumentManagerInterface.java,v 1.15 2003/07/18 14:20:19 hjokusch Exp $
* Last modification: $Date: 2003/07/19 12:45:00 $
* $Id: DocumentManagerInterface.java,v 1.16 2003/07/19 12:45:00 hjokusch Exp $
*/
 
package src.control;
19,7 → 19,14
 
import org.apache.xerces.dom.DocumentImpl;
 
// TODO JavaDoc interface description
/**
* The Interface <code> DocumentManagerInterface </code> is made to interact with the
* DocumentManager, which implements this interface. It cotains methods to manage the
* documents.
*
* @author Holger
*
*/
public interface DocumentManagerInterface {
 
/**
29,7 → 36,7
* @param fileName: The name of the file belonging to a parsed document in the
* <code>openDocumentList</code> which should be the new actual document.
*
// TODO * @return ???
* @return true, if it was able to change to the document, false if not
*
* author Group 5
*
37,20 → 44,69
*/
public boolean changeToDocument(File documentName);
 
// TODO JavaDoc-comments
/**
* 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
*/
public void closeActualDocument();
// TODO JavaDoc-comments
/**
* The methode <code> getActualDocument</code> is do get the
* <code> documentImpl</code> of the actual document
*
* @see org.apache.xerces.dom.DocumentImpl;
*
* @return DocumentImpl see @see
*
* author Group 5
*/
public DocumentImpl getActualDocument();
// TODO JavaDoc-comments
/**
* The methode <code> getOpendDocumentList </code> is to get the
* FileNames of all opened documents
*
* @return a LinkedList containing the FileNames of all opened Documents
*
* author Group 5
*/
public LinkedList getOpendDocumentList();
// TODO JavaDoc-comments
/**
* The methode <code> closeAll </code> delets all opened Documents from
* the openDocumentList and from the screen with checking,
* if the documents are saved
*
* author Group 5
*/
public void closeAll();
/**
* The methode <code> setActualVisibleTree </code> sets
* a Vector of the visible TreePaths(<code> TreePath</code>)
*
* @see javax.swing.tree.TreePath
* @see java.util.Enumeration;
*
* @param en: Enumeration of the TreePath objects
*
* author Group 5
*/
public void setActualVisibleTree(Enumeration en);
/**
* The methode <code> setActualVisibleTree </code> returns
* a <code>Enumeration </code> of the visible TreePaths(<code> TreePath</code>)
*
* @see javax.swing.tree.TreePath;
* @see java.util.Enumeration;
*
* @return Enumeration of the TreePath objects
*
* author Group 5
*/
public Enumeration getActualVisibleTree();
/**
83,7 → 139,14
*/
public void setNewSchema();
// TODO JavaDoc-comments
/**
* The methode <code> makeNewDocument</code> cause that a
* new document will appear. The user will have to choose grammar file:
* a DTD or a XML schema;
*
* author Group 5
*
*/
public void makeNewDocument();
/**
107,7 → 170,16
*/
public void saveActualDocumentAs();
// TODO JavaDoc-comments
/**
* The methode <code> setDocument </code> gives the actual Document a
* XML document as <code>DocumentImpl</code>
*
* @see org.apache.xerces.dom.DocumentImpl;
*
* @param docu: a XML DOcument as <code> DocumentImpl</code>
*
* author H.Jakusch
*/
public void setDocument(DocumentImpl docu);
 
/**