KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > edu > rice > cs > util > text > AbstractDocumentInterface


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.util.text;
35
36 import javax.swing.text.AttributeSet JavaDoc;
37 import javax.swing.text.BadLocationException JavaDoc;
38 //import javax.swing.text.Document;
39 import javax.swing.text.Position JavaDoc;
40
41 /** Swing Document interface augmented by readers/writers locking operations */
42 public interface AbstractDocumentInterface extends ReadersWritersLocking {
43   
44   /* Methods from Document interface used in FindReplaceMachine */
45   
46   /* Returns the length of the document. */
47   int getLength();
48   
49   /* Returns the specified substring of the document. */
50   String JavaDoc getText(int offset, int length) throws BadLocationException JavaDoc;
51   
52   /* Returns the entire text of this document. */
53   String JavaDoc getText();
54   
55   /* Inserts given string with specified attributes at the specified offset. */
56   void insertString(int offset, String JavaDoc str, AttributeSet JavaDoc a) throws BadLocationException JavaDoc;
57   
58   /* Removes the substring of specified length at the specified offset. */
59   void remove(int offset, int length) throws BadLocationException JavaDoc;
60   
61   /** Appends given string with specified attributes to end of this document. */
62   void append(String JavaDoc str, AttributeSet JavaDoc set);
63   
64   /** Creates a "sticky" position within a document */
65   Position JavaDoc createPosition(int offs) throws BadLocationException JavaDoc;
66 }
67
68
69     
70     
Popular Tags