KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > edu > rice > cs > drjava > model > SingleDisplayModel


1 /*BEGIN_COPYRIGHT_BLOCK
2  *
3  * This file is part of DrJava. Download the current version of this project from http://www.drjava.org/
4  * or http://sourceforge.net/projects/drjava/
5  *
6  * DrJava Open Source License
7  *
8  * Copyright (C) 2001-2006 JavaPLT group at Rice University (javaplt@rice.edu). All rights reserved.
9  *
10  * Developed by: Java Programming Languages Team, Rice University, http://www.cs.rice.edu/~javaplt/
11  *
12  * Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated
13  * documentation files (the "Software"), to deal with the Software without restriction, including without limitation
14  * the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and
15  * to permit persons to whom the Software is furnished to do so, subject to the following conditions:
16  *
17  * - Redistributions of source code must retain the above copyright notice, this list of conditions and the
18  * following disclaimers.
19  * - Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the
20  * following disclaimers in the documentation and/or other materials provided with the distribution.
21  * - Neither the names of DrJava, the JavaPLT, Rice University, nor the names of its contributors may be used to
22  * endorse or promote products derived from this Software without specific prior written permission.
23  * - Products derived from this software may not be called "DrJava" nor use the term "DrJava" as part of their
24  * names without prior written permission from the JavaPLT group. For permission, write to javaplt@rice.edu.
25  *
26  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO
27  * THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
28  * CONTRIBUTORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF
29  * CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
30  * WITH THE SOFTWARE.
31  *
32  *END_COPYRIGHT_BLOCK*/

33
34 package edu.rice.cs.drjava.model;
35
36 import java.util.List JavaDoc;
37
38 /**
39  * A GlobalModel that enforces invariants associated with having
40  * one active document at a time.
41  *
42  * Invariants:
43  * <OL>
44  * <LI>{@link #getOpenDefinitionsDocuments} will always return an array of
45  * at least size 1.
46  * </LI>
47  * <LI>(follows from previous) If there is ever no document in the model,
48  * a new one will be created.
49  * </LI>
50  * <LI>There is always exactly one active document, which can be get/set
51  * via {@link #getActiveDocument} and {@link #setActiveDocument}.
52  * </LI>
53  * </OL>
54  *
55  * Other functions added by this class:
56  * <OL>
57  * <LI>When calling {@link #openFile}, if there is currently only one open
58  * document, and it is untitled and unchanged, it will be closed after the
59  * new document is opened. This means that, in one atomic transaction, the
60  * model goes from having one totally empty document open to having one
61  * document (the requested one) open.
62  * </LI>
63  * </OL>
64  *
65  * @version $Id: SingleDisplayModel.java 3920 2006-07-27 23:02:53Z mgricken $
66  */

67 public interface SingleDisplayModel extends GlobalModel {
68   /**
69    * @return the currently active document.
70    */

71   public OpenDefinitionsDocument getActiveDocument();
72
73   /** Sets the currently active document by updating the selection model.
74    * @param doc Document to set as active
75    */

76   public void setActiveDocument(OpenDefinitionsDocument doc);
77   
78   /** Invokes the activeDocumentChanged method in the global listener on the argument _activeDocument. */
79   public void refreshActiveDocument();
80
81   /** @return the IDocumentNavigator container expressed as an AWT component. */
82   public java.awt.Container JavaDoc getDocCollectionWidget();
83
84   /** Sets the active document to be the next one in the list. */
85   public void setActiveNextDocument();
86
87   /** Sets the active document to be the previous one in the list. */
88   public void setActivePreviousDocument();
89
90   /** Shared code between close project and close All files which only sets the new active document after all documents
91    * to be closed have been closed.
92    * @param docList the list of files to close
93    * @return whether all files were closed
94    */

95   public boolean closeFiles(List JavaDoc<OpenDefinitionsDocument> docList);
96   
97   public void setActiveFirstDocument();
98   
99   public void dispose();
100   
101   /** Disposes of external resources, e.g. other VMs. */
102   public void disposeExternalResources();
103
104 // Any lightweight parsing has been disabled until we have something that is beneficial and works better in the background.
105
// /** @return the parsing control */
106
// public LightWeightParsingControl getParsingControl();
107
}
108
Popular Tags