javax.swing.text

Class AbstractDocument.DefaultDocumentEvent

java.lang.Object

javax.swing.undo.AbstractUndoableEdit

javax.swing.undo.CompoundEdit

javax.swing.text.AbstractDocument.DefaultDocumentEvent

All Implemented Interfaces:

java.io.Serializable, javax.swing.event.DocumentEvent, javax.swing.undo.UndoableEdit

Enclosing class:

AbstractDocument

public class AbstractDocument.DefaultDocumentEvent
extends javax.swing.undo.CompoundEdit
implements javax.swing.event.DocumentEvent

Stores the changes when a Document is beeing modified.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface javax.swing.event.DocumentEvent

javax.swing.event.DocumentEvent.ElementChange, javax.swing.event.DocumentEvent.EventType

Field Summary

Fields inherited from class javax.swing.undo.CompoundEdit

edits

Fields inherited from class javax.swing.undo.AbstractUndoableEdit

RedoName, UndoName

Constructor Summary

Constructors

Constructor and Description
AbstractDocument.DefaultDocumentEvent(int offset, int length, javax.swing.event.DocumentEvent.EventType type) Creates a new DefaultDocumentEvent.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	addEdit(javax.swing.undo.UndoableEdit edit) Adds an UndoableEdit to this DocumentEvent.
javax.swing.event.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.
javax.swing.event.DocumentEvent.EventType	getType() Returns the type of the modification.
java.lang.String	toString() Returns a String description of the change event.

Methods inherited from class javax.swing.undo.CompoundEdit

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

Methods inherited from class javax.swing.undo.AbstractUndoableEdit

replaceEdit

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

AbstractDocument.DefaultDocumentEvent

public AbstractDocument.DefaultDocumentEvent(int offset,
                                     int length,
                                     javax.swing.event.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 Detail

addEdit

public boolean addEdit(javax.swing.undo.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(javax.swing.text.Element).

Specified by:

addEdit in interface javax.swing.undo.UndoableEdit

Overrides:

addEdit in class javax.swing.undo.CompoundEdit

Parameters:

edit - the undoable edit to add

Returns:

true if edit could somehow be incorporated; false if edit has not been incorporated because CompoundEdit.end() was called before.

getDocument

public Document getDocument()

Returns the document that has been modified.

Specified by:

getDocument in interface javax.swing.event.DocumentEvent

Returns:

the document that has been modified

getLength

public int getLength()

Returns the length of the modification.

Specified by:

getLength in interface javax.swing.event.DocumentEvent

Returns:

the length of the modification

getOffset

public int getOffset()

Returns the start offset of the modification.

Specified by:

getOffset in interface javax.swing.event.DocumentEvent

Returns:

the start offset of the modification

getType

public javax.swing.event.DocumentEvent.EventType getType()

Returns the type of the modification.

Specified by:

getType in interface javax.swing.event.DocumentEvent

Returns:

the type of the modification

getChange

public javax.swing.event.DocumentEvent.ElementChange getChange(Element elem)

Returns the changes for an element.

Specified by:

getChange in interface javax.swing.event.DocumentEvent

Parameters:

elem - the element for which the changes are requested

Returns:

the changes for elem or null if elem has not been changed

toString

public java.lang.String toString()

Returns a String description of the change event. This returns the toString method of the Vector of edits.

Overrides:

toString in class javax.swing.undo.CompoundEdit

Returns:

the String representing this Object, which may be null

See Also:

Object.getClass(), Object.hashCode(), Class.getName(), Integer.toHexString(int)