|
Eclipse JDT Release 3.0 |
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.eclipse.ltk.core.refactoring.Change
org.eclipse.ltk.core.refactoring.TextChange
A text change is a special change object that applies a text edit tree
to a document. The text change manages the text edit tree.
Access to the document must be provided by concrete subclasses via the method
aquireDocument
,
commitDocument
, and
releaseDocument
.
A text change offers the ability to access the original content of
the document as well as creating a preview of the change. The edit
tree gets copied when creating any king of preview. Therefore no region
updating on the original edit tree takes place when requesting a preview
(for more information on region updating see class TextEdit
.
If region tracking is required for a preview it can be enabled via a call
to the method setKeepPreviewEdits
.
If enabled the text change keeps the copied edit tree executed for the
preview allowing clients to map an original edit to an executed edit. The
executed edit can then be used to determine its position in the preview.
Note: this class is not intended to be subclassed outside the refactoring framework.
Constructor Summary | |
protected |
TextChange(String name)
Creates a new text change with the specified name. |
Method Summary | |
protected abstract IDocument |
acquireDocument(IProgressMonitor pm)
Acquires a reference to the document to be changed by this text change. |
void |
addTextEditChangeGroup(TextEditChangeGroup group)
Adds a text edit change group . |
void |
addTextEditGroup(TextEditGroup group)
Adds a text edit group . |
protected abstract void |
commit(IDocument document,
IProgressMonitor pm)
Commits the document acquired via a call to aquireDocument . |
protected abstract Change |
createUndoChange(UndoEdit edit)
Hook to create an undo change for the given undo edit. |
String |
getCurrentContent(IProgressMonitor pm)
Returns the current content of the document this text change is associated with. |
String |
getCurrentContent(IRegion region,
boolean expandRegionToFullLine,
int surroundingLines,
IProgressMonitor pm)
Returns the current content of the text change clipped to a specific region. |
IDocument |
getCurrentDocument(IProgressMonitor pm)
Returns the document this text change is associated to. |
TextEdit |
getEdit()
Returns the root text edit. |
boolean |
getKeepPreviewEdits()
Returns whether preview edits are remembered for further region tracking or not. |
String |
getName()
Returns the human readable name of this change. The name MUST not be null . |
String |
getPreviewContent(IProgressMonitor pm)
Returns the preview content as a string. |
String |
getPreviewContent(TextEditChangeGroup[] changeGroups,
IRegion region,
boolean expandRegionToFullLine,
int surroundingLines,
IProgressMonitor pm)
Returns a preview of the text change clipped to a specific region. |
IDocument |
getPreviewDocument(IProgressMonitor pm)
Returns a document containing a preview of the text change. |
TextEdit |
getPreviewEdit(TextEdit original)
Returns the edit that got executed during preview generation instead of the given original. |
TextEdit[] |
getPreviewEdits(TextEdit[] originals)
Returns the edits that were executed during preview generation instead of the given array of original edits. |
TextEditChangeGroup[] |
getTextEditChangeGroups()
Returns the text edit change groups managed by this
text change. |
String |
getTextType()
Returns the text change's text type. |
Change |
perform(IProgressMonitor pm)
Performs this change. If this method is call on an invalid or disabled change object the result is unspecified. Changes should in general not respond to IProgressMonitor.isCanceled() since canceling a change tree in the
middle of its execution leaves the workspace in a half changed state. |
protected abstract void |
releaseDocument(IDocument document,
IProgressMonitor pm)
Releases the document acquired via a call to aquireDocument . |
void |
setEdit(TextEdit edit)
Sets the root text edit that should be applied to the document represented by this text change. |
void |
setEnabled(boolean enabled)
Sets whether this change is enabled or not. |
void |
setKeepPreviewEdits(boolean keep)
Controls whether the text change should keep executed edits during preview generation. |
void |
setTextType(String type)
Sets the text type. |
Methods inherited from class org.eclipse.ltk.core.refactoring.Change |
dispose, getAdapter, getModifiedElement, getParent, initializeValidationData, isEnabled, isValid |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
protected TextChange(String name)
null
.
The text type of this text change is set to txt
.
name
- the name of the text changesetTextType(String)
Method Detail |
public String getName()
null
.
getName
in class Change
public void setEnabled(boolean enabled)
setEnabled
in class Change
enabled
- true
to enable this change;
false
otherwisepublic void setTextType(String type)
org.eclipse.compare.contentMergeViewers
.
The default text type is txt
.
type
- the text type. If null
is passed the text type is
reseted to the default text type txt
.public String getTextType()
public void setEdit(TextEdit edit)
edit
- the root text edit. The root text edit
can only be set once.public TextEdit getEdit()
null
if no root edit has been
setpublic void addTextEditGroup(TextEditGroup group)
text edit group
. This method is a convenient
method for calling change.addTextEditChangeGroup(new
TextEditChangeGroup(change, group));
.
group
- the text edit group to addpublic void addTextEditChangeGroup(TextEditChangeGroup group)
text edit change group
. Calling the methods
requires that a root edit has been set via the method setEdit
. The edits managed by the given text edit change group must be part of
the change's root edit.
group
- the text edit change group to addpublic TextEditChangeGroup[] getTextEditChangeGroups()
text edit change groups
managed by this
text change.
protected abstract IDocument acquireDocument(IProgressMonitor pm) throws CoreException
releaseDocument(IDocument, IProgressMonitor)
.
The method releaseDocument
must be call as many times as
aquireDocument
has been called.
pm
- a progress monitor
CoreException
- if the document can't be acquiredprotected abstract 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.
document
- the document to commitpm
- a progress monitor
CoreException
- if the document can't be committedprotected abstract void releaseDocument(IDocument document, IProgressMonitor pm) throws CoreException
aquireDocument
.
document
- the document to releasepm
- a progress monitor
CoreException
- if the document can't be releasedprotected abstract Change createUndoChange(UndoEdit edit)
edit
- the UndoEdit
to create an undo change for
null
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 creating the
undo change.public Change perform(IProgressMonitor pm) throws CoreException
IProgressMonitor.isCanceled()
since canceling a change tree in the
middle of its execution leaves the workspace in a half changed state.
perform
in class Change
pm
- a progress monitor
null
if no
undo is provided
CoreException
- if an error occurred during change executionpublic IDocument getCurrentDocument(IProgressMonitor pm) throws CoreException
The returned document must not be modified by the client. Doing so will result in an unexpected behaviour when the change is performed.
pm
- a progress monitor to report progress or null
if no progress reporting is desired
CoreException
- if the document can't be acquiredpublic String getCurrentContent(IProgressMonitor pm) throws CoreException
pm
- a progress monitor to report progress or null
if no progress reporting is desired
CoreException
- if the content can't be accessedpublic String getCurrentContent(IRegion region, boolean expandRegionToFullLine, int surroundingLines, IProgressMonitor pm) throws CoreException
expandRegionToFullLine
is false
then the parameter region
determines the clipping.
expandRegionToFullLine
is true
then the region determined by the parameter region
is extended to cover full lines.
surroundingLines
> 0 then the given number
of surrounding lines is added. The value of surroundingLines
is only considered if expandRegionToFullLine
is true
region
- the starting region for the text to be returnedexpandRegionToFullLine
- if true
is passed the region
is extended to cover full linessurroundingLines
- the number of surrounding lines to be added to
the clipping region. Is only considered if expandRegionToFullLine
is true
pm
- a progress monitor to report progress or null
if no progress reporting is desired
CoreException
- if an exception occurs while accessing the current contentpublic void setKeepPreviewEdits(boolean keep)
keep
- if true
executed preview edits are keptpublic boolean getKeepPreviewEdits()
true
if executed text edits are remembered
during preview generation; otherwise false
public TextEdit getPreviewEdit(TextEdit original)
setKeepPreviewEdits
is set to true
and that
a preview has been requested via one of the getPreview*
methods.
The method returns null
if the original isn't managed
by this text change.
original
- the original edit managed by this text change
public TextEdit[] getPreviewEdits(TextEdit[] originals)
setKeepPreviewEdits
is set to true
and that a preview has been requested via one of the
getPreview*
methods.
The method returns an empty array if none of the original edits is managed by this text change.
originals
- an array of original edits managed by this text
change
public IDocument getPreviewDocument(IProgressMonitor pm) throws CoreException
text edit change groups
.
pm
- a progress monitor to report progress or null
if no progress reporting is desired
CoreException
- if the preview can't be createdpublic String getPreviewContent(IProgressMonitor pm) throws CoreException
getPreviewDocument(IProgressMonitor).get()
.
pm
- a progress monitor to report progress or null
if no progress reporting is desired
CoreException
- if the preview can't be createdpublic String getPreviewContent(TextEditChangeGroup[] changeGroups, IRegion region, boolean expandRegionToFullLine, int surroundingLines, IProgressMonitor pm) throws CoreException
text edit change groups
.
The region is determined as follows:
expandRegionToFullLine
is false
then the parameter region
determines the clipping.
expandRegionToFullLine
is true
then the region determined by the parameter region
is extended to cover full lines.
surroundingLines
> 0 then the given number
of surrounding lines is added. The value of surroundingLines
is only considered if expandRegionToFullLine
is true
changeGroups
- a set of change groups for which a preview is to be
generatedregion
- the starting region for the clippingexpandRegionToFullLine
- if true
is passed the region
is extended to cover full linessurroundingLines
- the number of surrounding lines to be added to
the clipping region. Is only considered if expandRegionToFullLine
is true
pm
- a progress monitor to report progress or null
if no progress reporting is desired
CoreException
- if an exception occurs while generating the previewgetCurrentContent(IRegion, boolean, int, IProgressMonitor)
|
Eclipse JDT Release 3.0 |
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |