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: import java.util.EventListener;
34:
35: import nextapp.echo2.app.event.DocumentEvent;
36: import nextapp.echo2.app.event.DocumentListener;
37: import nextapp.echo2.app.event.EventListenerList;
38:
39: /**
40: * An abstract implementation of a text component model.
41: * Provides listener management and notification facilities.
42: */
43: public abstract class AbstractDocument implements Document,
44: Serializable {
45:
46: /**
47: * A listener storage facility.
48: */
49: protected EventListenerList listenerList = new EventListenerList();
50:
51: /**
52: * Default constructor.
53: */
54: public AbstractDocument() {
55: super ();
56: }
57:
58: /**
59: * Adds a listener which will be notified of changes to the document.
60: *
61: * @param l The listener to add.
62: *
63: * @see nextapp.echo2.app.text.Document#addDocumentListener(DocumentListener)
64: */
65: public void addDocumentListener(DocumentListener l) {
66: listenerList.addListener(DocumentListener.class, l);
67: }
68:
69: /**
70: * Notifies listeners about an update to the document.
71: *
72: * @param e An event describing the changes to the document.
73: */
74: public void fireDocumentUpdate(DocumentEvent e) {
75: EventListener[] listeners = listenerList
76: .getListeners(DocumentListener.class);
77:
78: for (int index = 0; index < listeners.length; ++index) {
79: ((DocumentListener) listeners[index]).documentUpdate(e);
80: }
81: }
82:
83: /**
84: * Removes a listener from being notified of changes to the document.
85: *
86: * @param l The listener to remove.
87: *
88: * @see nextapp.echo2.app.text.Document#removeDocumentListener(DocumentListener)
89: */
90: public void removeDocumentListener(DocumentListener l) {
91: listenerList.removeListener(DocumentListener.class, l);
92: }
93: }
|