01: /*
02: * This file is part of the Echo Web Application Framework (hereinafter "Echo").
03: * Copyright (C) 2002-2005 NextApp, Inc.
04: *
05: * Version: MPL 1.1/GPL 2.0/LGPL 2.1
06: *
07: * The contents of this file are subject to the Mozilla Public License Version
08: * 1.1 (the "License"); you may not use this file except in compliance with
09: * 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;
33:
34: import nextapp.echo2.app.event.DocumentListener;
35:
36: /**
37: * A model for text components.
38: */
39: public interface Document extends Serializable {
40:
41: /**
42: * Adds a listener which will be notified of changes to the document.
43: *
44: * @param l The listener to add.
45: */
46: public void addDocumentListener(DocumentListener l);
47:
48: /**
49: * Returns the text of the document.
50: * This method should return ab empty string in the event the document
51: * contains no text. Null may not be returned.
52: *
53: * @return The text of the document.
54: */
55: public String getText();
56:
57: /**
58: * Sets the text of the document.
59: *
60: * @param text The new text of the document.
61: */
62: public void setText(String text);
63:
64: /**
65: * Removes a listener from being notified of changes to the document.
66: *
67: * @param l The listener to remove.
68: */
69: public void removeDocumentListener(DocumentListener l);
70: }
|