Overview Package Class Use Source Tree Index Deprecated About
Prev Class | Next ClassFrames | No Frames
Summary: Nested | Field | Method | ConstrDetail: Nested | Field | Method | Constr

javax.swing.text

Class AbstractDocument.DefaultDocumentEvent

Enclosing Class:
AbstractDocument
Implemented Interfaces:
DocumentEvent, Serializable, UndoableEdit
public class AbstractDocument.DefaultDocumentEvent
extends CompoundEdit
implements DocumentEvent
Stores the changes when a Document is beeing modified.
See Also:
Serialized Form

Field Summary

Fields inherited from class javax.swing.undo.CompoundEdit

edits

Fields inherited from class javax.swing.undo.AbstractUndoableEdit

RedoName, UndoName

Constructor Summary

DefaultDocumentEvent(int offset, int length, DocumentEvent.EventType type)
Creates a new DefaultDocumentEvent.

Method Summary

boolean
addEdit(UndoableEdit edit)
Adds an UndoableEdit to this DocumentEvent.
ElementChange
getChange(Element elem)
Returns the changes for an element.
Document
getDocument()
Returns the document that has been modified.
int
getLength()
Returns the length of the modification.
int
getOffset()
Returns the start offset of the modification.
DocumentEvent.EventType
getType()
Returns the type of the modification.
String
toString()
Returns a String description of the change event.

Methods inherited from class javax.swing.undo.CompoundEdit

addEdit, canRedo, canUndo, die, end, getPresentationName, getRedoPresentationName, getUndoPresentationName, isInProgress, isSignificant, lastEdit, redo, toString, undo

Methods inherited from class javax.swing.undo.AbstractUndoableEdit

addEdit, canRedo, canUndo, die, getPresentationName, getRedoPresentationName, getUndoPresentationName, isSignificant, redo, replaceEdit, toString, undo

Methods inherited from class java.lang.Object

clone, equals, extends Object> getClass, finalize, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

DefaultDocumentEvent

public DefaultDocumentEvent(int offset,
                            int length,
                            DocumentEvent.EventType type)
Creates a new DefaultDocumentEvent.
Parameters:
offset - the starting offset of the change
length - the length of the change
type - the type of change

Method Details

addEdit

public boolean addEdit(UndoableEdit edit)
Adds an UndoableEdit to this DocumentEvent. If this edit is an instance of AbstractDocument.ElementEdit, then this record can later be fetched by calling getChange(Element).
Specified by:
addEdit in interface UndoableEdit
Overrides:
addEdit in interface CompoundEdit
Parameters:
edit - the undoable edit to add

getChange

public ElementChange getChange(Element elem)
Returns the changes for an element.
Specified by:
getChange in interface DocumentEvent
Parameters:
elem - the element for which the changes are requested
Returns:
the changes for elem or null if elem has not been changed

getDocument

public Document getDocument()
Returns the document that has been modified.
Specified by:
getDocument in interface DocumentEvent
Returns:
the document that has been modified

getLength

public int getLength()
Returns the length of the modification.
Specified by:
getLength in interface DocumentEvent
Returns:
the length of the modification

getOffset

public int getOffset()
Returns the start offset of the modification.
Specified by:
getOffset in interface DocumentEvent
Returns:
the start offset of the modification

getType

public DocumentEvent.EventType getType()
Returns the type of the modification.
Specified by:
getType in interface DocumentEvent
Returns:
the type of the modification

toString

public String toString()
Returns a String description of the change event. This returns the toString method of the Vector of edits.
Overrides:
toString in interface CompoundEdit
AbstractDocument.java -- Copyright (C) 2002, 2004, 2005, 2006 Free Software Foundation, Inc. This file is part of GNU Classpath. GNU Classpath is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2, or (at your option) any later version. GNU Classpath is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with GNU Classpath; see the file COPYING. If not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. Linking this library statically or dynamically with other modules is making a combined work based on this library. Thus, the terms and conditions of the GNU General Public License cover the whole combination. As a special exception, the copyright holders of this library give you permission to link this library with independent modules to produce an executable, regardless of the license terms of these independent modules, and to copy and distribute the resulting executable under terms of your choice, provided that you also meet, for each linked independent module, the terms and conditions of the license of that module. An independent module is a module which is not derived from or based on this library. If you modify this library, you may extend this exception to your version of the library, but you are not obligated to do so. If you do not wish to do so, delete this exception statement from your version.

Overview Package Class Use Source Tree Index Deprecated About