public class DocumentChange extends TextChange
IDocument
.
The document change uses a simple length compare to check if it
is still valid. So as long as its length hasn't changed the text edits
managed have a valid range and can be applied to the document. The
same applies to the undo change returned from the perform method.
Note: this class is not intended to be extended by clients.
Constructor and Description |
---|
DocumentChange(String name,
IDocument document)
Creates a new
DocumentChange for the given
IDocument . |
Modifier and Type | Method and Description |
---|---|
protected IDocument |
acquireDocument(IProgressMonitor pm)
Acquires a reference to the document to be changed by this text
change.
|
protected void |
commit(IDocument document,
IProgressMonitor pm)
Commits the document acquired via a call to
aquireDocument . |
protected Change |
createUndoChange(UndoEdit edit)
Hook to create an undo change for the given undo edit.
|
Object |
getModifiedElement()
Returns the element modified by this
Change . |
void |
initializeValidationData(IProgressMonitor pm)
Hook method to initialize some internal state to provide an adequate answer
for the
isValid method. |
RefactoringStatus |
isValid(IProgressMonitor pm)
Verifies that this change object is still valid and can be executed by calling
perform . |
protected UndoEdit |
performEdits(IDocument document)
Executes the text edits on the given document.
|
protected void |
releaseDocument(IDocument document,
IProgressMonitor pm)
Releases the document acquired via a call to
aquireDocument . |
addEdit, addTextEditChangeGroup, addTextEditGroup, getCurrentContent, getCurrentContent, getCurrentDocument, getEdit, getPreviewContent, getPreviewContent, getPreviewContent, getPreviewDocument, getPreviewEdit, getPreviewEdits, getTextEditChangeGroups, perform, setEdit, setKeepPreviewEdits
addChangeGroup, getChangeGroups, getKeepPreviewEdits, getName, getTextType, hasOneGroupCategory, setEnabled, setTextType
dispose, getAdapter, getAffectedObjects, getDescriptor, getParent, isEnabled, setEnabledShallow
public Object getModifiedElement()
Change
. The method may return
null
if the change isn't related to an element.getModifiedElement
in class Change
public void initializeValidationData(IProgressMonitor pm)
isValid
method. This method gets called after a change
or a whole change tree has been created.
Typically this method is implemented in one of the following ways:
dispose
.isValid
is called.
For example, a change object that manipulates the content of an IFile
could either listen to resource changes and detect that the file got changed or
it could remember some content stamp and compare it with the actual content stamp
when isValid
is called.
initializeValidationData
in class Change
pm
- a progress monitorpublic RefactoringStatus isValid(IProgressMonitor pm) throws CoreException
perform
. If a refactoring status with a severity of RefactoringStatus.FATAL
is returned then the change has to be treated as invalid
and can no longer be executed. Performing such a change produces an unspecified
result and will very likely throw an exception.
This method is also called by the UndoManager
to decide if
an undo or redo change is still valid and therefore can be executed.
isValid
in class Change
pm
- a progress monitor.CoreException
- if an error occurred during validation check. The change
is to be treated as invalid if an exception occursprotected IDocument acquireDocument(IProgressMonitor pm) throws CoreException
TextChange.releaseDocument(IDocument, IProgressMonitor)
.
The method releaseDocument
must be called as many times as
aquireDocument
has been called.
acquireDocument
in class TextChange
pm
- a progress monitorCoreException
- if the document can't be acquiredprotected void commit(IDocument document, IProgressMonitor pm) throws CoreException
aquireDocument
. It is up to the implementors of this method to decide what committing
a document means. Typically, the content of the document is written back to the file
system.commit
in class TextChange
document
- the document to commitpm
- a progress monitorCoreException
- if the document can't be committedprotected void releaseDocument(IDocument document, IProgressMonitor pm) throws CoreException
aquireDocument
.releaseDocument
in class TextChange
document
- the document to releasepm
- a progress monitorCoreException
- if the document can't be releasedprotected UndoEdit performEdits(IDocument document) throws BadLocationException, MalformedTreeException
TextChange
super.performEdits(document)
.performEdits
in class TextChange
document
- the documentBadLocationException
- is thrown if one of the edits in the
tree can't be executed. The state of the document is undefined if this
exception is thrown.MalformedTreeException
- is thrown if the edit tree isn't
in a valid state. This exception is thrown before any edit is executed.
So the document is still in its original state.protected Change createUndoChange(UndoEdit edit)
createUndoChange
in class TextChange
edit
- the UndoEdit
to create an undo change fornull
if no undo change can
be created. Returning null
results in the fact that
the whole change tree can't be undone. So returning null
is only recommended if an exception occurred during the creation of the
undo change.
Copyright (c) 2000, 2015 Eclipse Contributors and others. All rights reserved.Guidelines for using Eclipse APIs.