AbstractDocument.ElementEdit (Java 2 Platform SE 5.0) (original) (raw)

javax.swing.text

Class AbstractDocument.ElementEdit

java.lang.Object extended by javax.swing.undo.AbstractUndoableEdit javax.swing.text.AbstractDocument.ElementEdit

All Implemented Interfaces:

Serializable, DocumentEvent.ElementChange, UndoableEdit

Enclosing class:

AbstractDocument

public static class AbstractDocument.ElementEdit

extends AbstractUndoableEdit

implements DocumentEvent.ElementChange

An implementation of ElementChange that can be added to the document event.

Field Summary

Fields inherited from class javax.swing.undo.AbstractUndoableEdit
RedoName, UndoName

Constructor Summary
[AbstractDocument.ElementEdit](../../../javax/swing/text/AbstractDocument.ElementEdit.html#AbstractDocument.ElementEdit%28javax.swing.text.Element, int, javax.swing.text.Element[], javax.swing.text.Element[]%29)(Element e, int index,Element[] removed,Element[] added) Constructs an edit record.

Method Summary
Element[]	getChildrenAdded() Gets a list of children that were added.
Element[]	getChildrenRemoved() Gets a list of children that were removed.
Element	getElement() Returns the underlying element.
int	getIndex() Returns the index into the list of elements.
void	redo() Redoes a change.
void	undo() Undoes a change.

Methods inherited from class javax.swing.undo.AbstractUndoableEdit
addEdit, canRedo, canUndo, die, getPresentationName, getRedoPresentationName, getUndoPresentationName, isSignificant, replaceEdit, toString

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, [wait](../../../java/lang/Object.html#wait%28long, int%29)

Constructor Detail

AbstractDocument.ElementEdit

public AbstractDocument.ElementEdit(Element e, int index, Element[] removed, Element[] added)

Constructs an edit record. This does not modify the element so it can safely be used to catch up a view to the current model state for views that just attached to a model.

Parameters:

e - the element

index - the index into the model >= 0

removed - a set of elements that were removed

added - a set of elements that were added

Method Detail

getElement

public Element getElement()

Returns the underlying element.

Specified by:

[getElement](../../../javax/swing/event/DocumentEvent.ElementChange.html#getElement%28%29) in interface [DocumentEvent.ElementChange](../../../javax/swing/event/DocumentEvent.ElementChange.html "interface in javax.swing.event")

Returns:

the element

getIndex

public int getIndex()

Returns the index into the list of elements.

Specified by:

[getIndex](../../../javax/swing/event/DocumentEvent.ElementChange.html#getIndex%28%29) in interface [DocumentEvent.ElementChange](../../../javax/swing/event/DocumentEvent.ElementChange.html "interface in javax.swing.event")

Returns:

the index >= 0

getChildrenRemoved

public Element[] getChildrenRemoved()

Gets a list of children that were removed.

Specified by:

[getChildrenRemoved](../../../javax/swing/event/DocumentEvent.ElementChange.html#getChildrenRemoved%28%29) in interface [DocumentEvent.ElementChange](../../../javax/swing/event/DocumentEvent.ElementChange.html "interface in javax.swing.event")

Returns:

the list

getChildrenAdded

public Element[] getChildrenAdded()

Gets a list of children that were added.

Specified by:

[getChildrenAdded](../../../javax/swing/event/DocumentEvent.ElementChange.html#getChildrenAdded%28%29) in interface [DocumentEvent.ElementChange](../../../javax/swing/event/DocumentEvent.ElementChange.html "interface in javax.swing.event")

Returns:

the list

redo

public void redo() throws CannotRedoException

Redoes a change.

Specified by:

[redo](../../../javax/swing/undo/UndoableEdit.html#redo%28%29) in interface [UndoableEdit](../../../javax/swing/undo/UndoableEdit.html "interface in javax.swing.undo")

Overrides:

[redo](../../../javax/swing/undo/AbstractUndoableEdit.html#redo%28%29) in class [AbstractUndoableEdit](../../../javax/swing/undo/AbstractUndoableEdit.html "class in javax.swing.undo")

Throws:

[CannotRedoException](../../../javax/swing/undo/CannotRedoException.html "class in javax.swing.undo") - if the change cannot be redone

See Also:

AbstractUndoableEdit.canRedo()

undo

public void undo() throws CannotUndoException

Undoes a change.

Specified by:

[undo](../../../javax/swing/undo/UndoableEdit.html#undo%28%29) in interface [UndoableEdit](../../../javax/swing/undo/UndoableEdit.html "interface in javax.swing.undo")

Overrides:

[undo](../../../javax/swing/undo/AbstractUndoableEdit.html#undo%28%29) in class [AbstractUndoableEdit](../../../javax/swing/undo/AbstractUndoableEdit.html "class in javax.swing.undo")

Throws:

[CannotUndoException](../../../javax/swing/undo/CannotUndoException.html "class in javax.swing.undo") - if the change cannot be undone

See Also:

AbstractUndoableEdit.canUndo()

Submit a bug or feature
For further API reference and developer documentation, see Java 2 SDK SE Developer Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.