001    /* DocumentEvent.java --
002       Copyright (C) 2002, 2004, 2005, 2006, Free Software Foundation, Inc.
003    
004    This file is part of GNU Classpath.
005    
006    GNU Classpath is free software; you can redistribute it and/or modify
007    it under the terms of the GNU General Public License as published by
008    the Free Software Foundation; either version 2, or (at your option)
009    any later version.
010    
011    GNU Classpath is distributed in the hope that it will be useful, but
012    WITHOUT ANY WARRANTY; without even the implied warranty of
013    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
014    General Public License for more details.
015    
016    You should have received a copy of the GNU General Public License
017    along with GNU Classpath; see the file COPYING.  If not, write to the
018    Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
019    02110-1301 USA.
020    
021    Linking this library statically or dynamically with other modules is
022    making a combined work based on this library.  Thus, the terms and
023    conditions of the GNU General Public License cover the whole
024    combination.
025    
026    As a special exception, the copyright holders of this library give you
027    permission to link this library with independent modules to produce an
028    executable, regardless of the license terms of these independent
029    modules, and to copy and distribute the resulting executable under
030    terms of your choice, provided that you also meet, for each linked
031    independent module, the terms and conditions of the license of that
032    module.  An independent module is a module which is not derived from
033    or based on this library.  If you modify this library, you may extend
034    this exception to your version of the library, but you are not
035    obligated to do so.  If you do not wish to do so, delete this
036    exception statement from your version. */
037    
038    package javax.swing.event;
039    
040    import javax.swing.text.Document;
041    import javax.swing.text.Element;
042    
043    /**
044     * DocumentEvent public interface
045     * @author Andrew Selkirk
046     * @author Ronald Veldema
047     */
048    public interface DocumentEvent
049    {
050      /**
051       * ElementChange public interface
052       */
053      public static interface ElementChange
054      {
055        /**
056         * getIndex
057         * @return int
058         */
059        int getIndex();
060    
061        /**
062         * getElement
063         * @return Element
064         */
065        Element getElement();
066    
067        /**
068         * getChildrenRemoved
069         * @return Element[]
070         */
071        Element[] getChildrenRemoved();
072    
073        /**
074         * getChildrenAdded
075         * @return Element[]
076         */
077        Element[] getChildrenAdded();
078        
079      }
080    
081      /**
082       * EventType
083       */
084      final class EventType
085      {
086        /**
087         * INSERT
088         */
089        public static final EventType INSERT = new EventType("INSERT"); // TODO
090    
091        /**
092         * REMOVE
093         */
094        public static final EventType REMOVE = new EventType("REMOVE"); // TODO
095    
096        /**
097         * CHANGE
098         */
099        public static final EventType CHANGE = new EventType("CHANGE"); // TODO
100    
101        /**
102         * typeString
103         */
104        private String type;
105    
106        /**
107         * Constructor EventType
108         * @param type TODO
109         */
110        private EventType(String type)
111        {
112          this.type = type;
113        }
114    
115        /**
116         * toString
117         * @return String
118         */
119        public String toString()
120        {
121          return type;
122        }
123      }
124    
125      /**
126       * getType
127       * @return EventType
128       */
129      EventType getType();
130    
131      /**
132       * getOffset
133       * @return int
134       */
135      int getOffset();
136    
137      /**
138       * getLength
139       * @return int
140       */
141      int getLength();
142    
143      /**
144       * getDocument
145       * @return Document
146       */
147      Document getDocument();
148    
149      /**
150       * getChange
151       * @param element TODO
152       * @return ElementChange
153       */
154      ElementChange getChange(Element element);
155    
156    }