javax.swing.text
class AbstractDocument.ElementEdit

java.lang.Object 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.

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

getChildrenAdded

public Element[] getChildrenAdded()

Gets a list of children that were added.

Returns:

the list

getChildrenRemoved

public Element[] getChildrenRemoved()

Gets a list of children that were removed.

Returns:

the list

getElement

public Element getElement()

Returns the underlying element.

Returns:

the element

getIndex

public int getIndex()

Returns the index into the list of elements.

Returns:

the index >= 0

redo

public void redo()
          throws CannotRedoException

Redoes a change.

Overrides:

redo in class AbstractUndoableEdit

Throws:

CannotRedoException - if the change cannot be redone

undo

public void undo()
          throws CannotUndoException

Undoes a change.

Overrides:

undo in class AbstractUndoableEdit

Throws:

CannotUndoException - if the change cannot be undone