Source for javax.swing.event.DocumentEvent

   1: /* DocumentEvent.java --
   2:    Copyright (C) 2002, 2004 Free Software Foundation, Inc.
   3: 
   4: This file is part of GNU Classpath.
   5: 
   6: GNU Classpath is free software; you can redistribute it and/or modify
   7: it under the terms of the GNU General Public License as published by
   8: the Free Software Foundation; either version 2, or (at your option)
   9: any later version.
  10: 
  11: GNU Classpath is distributed in the hope that it will be useful, but
  12: WITHOUT ANY WARRANTY; without even the implied warranty of
  13: MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14: General Public License for more details.
  15: 
  16: You should have received a copy of the GNU General Public License
  17: along with GNU Classpath; see the file COPYING.  If not, write to the
  18: Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
  19: 02110-1301 USA.
  20: 
  21: Linking this library statically or dynamically with other modules is
  22: making a combined work based on this library.  Thus, the terms and
  23: conditions of the GNU General Public License cover the whole
  24: combination.
  25: 
  26: As a special exception, the copyright holders of this library give you
  27: permission to link this library with independent modules to produce an
  28: executable, regardless of the license terms of these independent
  29: modules, and to copy and distribute the resulting executable under
  30: terms of your choice, provided that you also meet, for each linked
  31: independent module, the terms and conditions of the license of that
  32: module.  An independent module is a module which is not derived from
  33: or based on this library.  If you modify this library, you may extend
  34: this exception to your version of the library, but you are not
  35: obligated to do so.  If you do not wish to do so, delete this
  36: exception statement from your version. */
  37: 
  38: package javax.swing.event;
  39: 
  40: import javax.swing.text.Document;
  41: import javax.swing.text.Element;
  42: 
  43: /**
  44:  * DocumentEvent public interface
  45:  * @author Andrew Selkirk
  46:  * @author Ronald Veldema
  47:  */
  48: public interface DocumentEvent {
  49: 
  50:     //-------------------------------------------------------------
  51:     // Classes ----------------------------------------------------
  52:     //-------------------------------------------------------------
  53: 
  54:     /**
  55:      * ElementChange public interface
  56:      */
  57:     public interface ElementChange {
  58: 
  59:         //-------------------------------------------------------------
  60:         // Methods ----------------------------------------------------
  61:         //-------------------------------------------------------------
  62: 
  63:         /**
  64:          * getIndex
  65:          * @returns int
  66:          */
  67:         int getIndex();
  68: 
  69:         /**
  70:          * getElement
  71:          * @returns Element
  72:          */
  73:         Element getElement();
  74: 
  75:         /**
  76:          * getChildrenRemoved
  77:          * @returns Element[]
  78:          */
  79:         Element[] getChildrenRemoved();
  80: 
  81:         /**
  82:          * getChildrenAdded
  83:          * @returns Element[]
  84:          */
  85:         Element[] getChildrenAdded();
  86: 
  87: 
  88:     } // ElementChange
  89: 
  90:   /**
  91:    * EventType
  92:    */
  93:   class EventType
  94:   {
  95:     /**
  96:      * INSERT
  97:      */
  98:     public static final EventType INSERT = new EventType("INSERT"); // TODO
  99: 
 100:     /**
 101:      * REMOVE
 102:      */
 103:     public static final EventType REMOVE = new EventType("REMOVE"); // TODO
 104: 
 105:     /**
 106:      * CHANGE
 107:      */
 108:     public static final EventType CHANGE = new EventType("CHANGE"); // TODO
 109: 
 110:     /**
 111:      * typeString
 112:      */
 113:     private String type;
 114: 
 115:     /**
 116:      * Constructor EventType
 117:      * @param type TODO
 118:      */
 119:     private EventType(String type)
 120:     {
 121:       this.type = type;
 122:     }
 123: 
 124:     /**
 125:      * toString
 126:      * @returns String
 127:      */
 128:     public String toString()
 129:     {
 130:       return type;
 131:     }
 132:   }
 133: 
 134:     /**
 135:      * getType
 136:      * @returns EventType
 137:      */
 138:     EventType getType();
 139: 
 140:     /**
 141:      * getOffset
 142:      * @returns int
 143:      */
 144:     int getOffset();
 145: 
 146:     /**
 147:      * getLength
 148:      * @returns int
 149:      */
 150:     int getLength();
 151: 
 152:     /**
 153:      * getDocument
 154:      * @returns Document
 155:      */
 156:     Document getDocument();
 157: 
 158:     /**
 159:      * getChange
 160:      * @param element TODO
 161:      * @returns ElementChange
 162:      */
 163:     ElementChange getChange(Element element);
 164: 
 165: 
 166: } // DocumentEvent