org.eclipse.xtext.ui.refactoring.impl

Class EditorDocumentChange

java.lang.Object

org.eclipse.ltk.core.refactoring.Change

org.eclipse.ltk.core.refactoring.TextEditBasedChange

org.eclipse.ltk.core.refactoring.TextChange

org.eclipse.xtext.ui.refactoring.impl.EditorDocumentChange

All Implemented Interfaces:

org.eclipse.core.runtime.IAdaptable

public class EditorDocumentChange
extends org.eclipse.ltk.core.refactoring.TextChange

Copied and adapted DocumentChange. The original implementation relies on the ITextFileBuffer API. Xtext doesn't and the fallback implementation in DocumentChange will always yield an invalid thread access error. In addition, we need a way to combine editor saving with document changes, as there is no way to tell JDT to save our editors after a combined Xtext/JDT refactoring.

Author:

Jan Koehnlein - Initial contribution and API

Constructor Summary

Constructors

Constructor and Description
EditorDocumentChange(String name, org.eclipse.ui.texteditor.ITextEditor editor, boolean doSave)

Method Summary

Methods

Modifier and Type	Method and Description
protected org.eclipse.jface.text.IDocument	acquireDocument(org.eclipse.core.runtime.IProgressMonitor pm)
protected void	commit(org.eclipse.jface.text.IDocument document, org.eclipse.core.runtime.IProgressMonitor pm)
protected org.eclipse.ltk.core.refactoring.Change	createUndoChange(org.eclipse.text.edits.UndoEdit edit)
org.eclipse.ui.texteditor.ITextEditor	getEditor()
Object	getModifiedElement()
void	initializeValidationData(org.eclipse.core.runtime.IProgressMonitor pm)
boolean	isDoSave()
org.eclipse.ltk.core.refactoring.RefactoringStatus	isValid(org.eclipse.core.runtime.IProgressMonitor pm)
org.eclipse.ltk.core.refactoring.Change	perform(org.eclipse.core.runtime.IProgressMonitor pm)
protected void	releaseDocument(org.eclipse.jface.text.IDocument document, org.eclipse.core.runtime.IProgressMonitor pm)
void	setDoSave(boolean doSave)

Methods inherited from class org.eclipse.ltk.core.refactoring.TextChange

addEdit, addTextEditChangeGroup, addTextEditGroup, getCurrentContent, getCurrentContent, getCurrentDocument, getEdit, getPreviewContent, getPreviewContent, getPreviewContent, getPreviewDocument, getPreviewEdit, getPreviewEdits, getTextEditChangeGroups, performEdits, setEdit, setKeepPreviewEdits

Methods inherited from class org.eclipse.ltk.core.refactoring.TextEditBasedChange

addChangeGroup, getChangeGroups, getKeepPreviewEdits, getName, getTextType, hasOneGroupCategory, setEnabled, setTextType

Methods inherited from class org.eclipse.ltk.core.refactoring.Change

dispose, getAdapter, getAffectedObjects, getDescriptor, getParent, isEnabled, setEnabledShallow

Methods inherited from class java.lang.Object

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

Constructor Detail

EditorDocumentChange

public EditorDocumentChange(String name,
                    org.eclipse.ui.texteditor.ITextEditor editor,
                    boolean doSave)

Method Detail

getModifiedElement

public Object getModifiedElement()

Specified by:

getModifiedElement in class org.eclipse.ltk.core.refactoring.Change

getEditor

public org.eclipse.ui.texteditor.ITextEditor getEditor()

isDoSave

public boolean isDoSave()

setDoSave

public void setDoSave(boolean doSave)

initializeValidationData

public void initializeValidationData(org.eclipse.core.runtime.IProgressMonitor pm)

Specified by:

initializeValidationData in class org.eclipse.ltk.core.refactoring.Change

isValid

public org.eclipse.ltk.core.refactoring.RefactoringStatus isValid(org.eclipse.core.runtime.IProgressMonitor pm)
                                                           throws org.eclipse.core.runtime.CoreException

Specified by:

isValid in class org.eclipse.ltk.core.refactoring.Change

Throws:

org.eclipse.core.runtime.CoreException

acquireDocument

protected org.eclipse.jface.text.IDocument acquireDocument(org.eclipse.core.runtime.IProgressMonitor pm)
                                                    throws org.eclipse.core.runtime.CoreException

Specified by:

acquireDocument in class org.eclipse.ltk.core.refactoring.TextChange

Throws:

org.eclipse.core.runtime.CoreException

commit

protected void commit(org.eclipse.jface.text.IDocument document,
          org.eclipse.core.runtime.IProgressMonitor pm)
               throws org.eclipse.core.runtime.CoreException

Specified by:

commit in class org.eclipse.ltk.core.refactoring.TextChange

Throws:

org.eclipse.core.runtime.CoreException

releaseDocument

protected void releaseDocument(org.eclipse.jface.text.IDocument document,
                   org.eclipse.core.runtime.IProgressMonitor pm)
                        throws org.eclipse.core.runtime.CoreException

Specified by:

releaseDocument in class org.eclipse.ltk.core.refactoring.TextChange

Throws:

org.eclipse.core.runtime.CoreException

perform

public org.eclipse.ltk.core.refactoring.Change perform(org.eclipse.core.runtime.IProgressMonitor pm)
                                                throws org.eclipse.core.runtime.CoreException

Overrides:

perform in class org.eclipse.ltk.core.refactoring.TextChange

Throws:

org.eclipse.core.runtime.CoreException

createUndoChange

protected org.eclipse.ltk.core.refactoring.Change createUndoChange(org.eclipse.text.edits.UndoEdit edit)

Specified by:

createUndoChange in class org.eclipse.ltk.core.refactoring.TextChange