KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > edu > rice > cs > drjava > project > DocumentInfoGetter


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-2005 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.project;
35
36 import java.io.File JavaDoc;
37
38 import edu.rice.cs.plt.tuple.Pair;
39
40 /** Classes that implement this interface are expected to give information specific to a single document that is
41  * to be saved by the project file builder. These objects are passed to the builder upon a save. These objects
42  * should not be cached anywhere so that they may be gc'd. They are meant for temporary transmition of data.
43  */
44 public interface DocumentInfoGetter {
45   
46   /** @return the selection with the start and ending locations paired together. The cursor location is at the second
47    * location in the pair while the selection is defined between the two.
48    */
49   public Pair<Integer JavaDoc,Integer JavaDoc> getSelection();
50   
51   /** @return the scroll offset of the scroll pane with the first element being the vertical scroll and the second
52    * being the horizontal scroll
53    */
54   public Pair<Integer JavaDoc,Integer JavaDoc> getScroll();
55   
56   /** @return the filename of the document being described by this getter. */
57   public File JavaDoc getFile();
58   
59   /** Returns the package declared in the java code within the document being described
60    * @return the package of this document.
61    */
62   public String JavaDoc getPackage();
63   
64   /** @return true iff the described document is the current active document. */
65   public boolean isActive();
66   
67   /** @return whether the document has a file currently associated with it. */
68   public boolean isUntitled();
69 }
Popular Tags