KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > nextapp > echo2 > app > text > Document


1 /*
2  * This file is part of the Echo Web Application Framework (hereinafter "Echo").
3  * Copyright (C) 2002-2005 NextApp, Inc.
4  *
5  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
6  *
7  * The contents of this file are subject to the Mozilla Public License Version
8  * 1.1 (the "License"); you may not use this file except in compliance with
9  * the License. You may obtain a copy of the License at
10  * http://www.mozilla.org/MPL/
11  *
12  * Software distributed under the License is distributed on an "AS IS" basis,
13  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
14  * for the specific language governing rights and limitations under the
15  * License.
16  *
17  * Alternatively, the contents of this file may be used under the terms of
18  * either the GNU General Public License Version 2 or later (the "GPL"), or
19  * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
20  * in which case the provisions of the GPL or the LGPL are applicable instead
21  * of those above. If you wish to allow use of your version of this file only
22  * under the terms of either the GPL or the LGPL, and not to allow others to
23  * use your version of this file under the terms of the MPL, indicate your
24  * decision by deleting the provisions above and replace them with the notice
25  * and other provisions required by the GPL or the LGPL. If you do not delete
26  * the provisions above, a recipient may use your version of this file under
27  * the terms of any one of the MPL, the GPL or the LGPL.
28  */
29
30 package nextapp.echo2.app.text;
31
32 import java.io.Serializable JavaDoc;
33
34 import nextapp.echo2.app.event.DocumentListener;
35
36 /**
37  * A model for text components.
38  */
39 public interface Document
40 extends Serializable JavaDoc {
41
42     /**
43      * Adds a listener which will be notified of changes to the document.
44      *
45      * @param l The listener to add.
46      */
47     public void addDocumentListener(DocumentListener l);
48     
49     /**
50      * Returns the text of the document.
51      * This method should return ab empty string in the event the document
52      * contains no text. Null may not be returned.
53      *
54      * @return The text of the document.
55      */
56     public String JavaDoc getText();
57     
58     /**
59      * Sets the text of the document.
60      *
61      * @param text The new text of the document.
62      */
63     public void setText(String JavaDoc text);
64     
65     /**
66      * Removes a listener from being notified of changes to the document.
67      *
68      * @param l The listener to remove.
69      */
70     public void removeDocumentListener(DocumentListener l);
71 }
72
Popular Tags