|
Eclipse JDT Release 3.8 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.eclipse.jdt.ui.text.java.correction.ChangeCorrectionProposal
org.eclipse.jdt.ui.text.java.correction.CUCorrectionProposal
org.eclipse.jdt.ui.text.java.correction.ASTRewriteCorrectionProposal
public class ASTRewriteCorrectionProposal
A proposal for quick fixes and quick assists that works on an AST rewrite. Either a rewrite is
directly passed in the constructor or the method getRewrite()
is overridden to provide
the AST rewrite that is evaluated on the document when the proposal is applied.
Field Summary |
---|
Fields inherited from interface org.eclipse.jdt.ui.text.java.correction.ICommandAccess |
---|
ASSIST_SUFFIX, COMMAND_ID_PREFIX |
Constructor Summary | |
---|---|
ASTRewriteCorrectionProposal(String name,
ICompilationUnit cu,
ASTRewrite rewrite,
int relevance)
Constructs an AST rewrite correction proposal. |
|
ASTRewriteCorrectionProposal(String name,
ICompilationUnit cu,
ASTRewrite rewrite,
int relevance,
Image image)
Constructs an AST rewrite correction proposal. |
Method Summary | |
---|---|
protected void |
addEdits(IDocument document,
TextEdit editRoot)
Called when the CompilationUnitChange is initialized. |
ImportRewrite |
createImportRewrite(CompilationUnit astRoot)
Creates and sets the import rewrite used for this compilation unit. |
ImportRewrite |
getImportRewrite()
Returns the import rewrite used for this compilation unit. |
protected ASTRewrite |
getRewrite()
Returns the rewrite that has been passed in the constructor. |
void |
setImportRewrite(ImportRewrite rewrite)
Sets the import rewrite used for this compilation unit. |
Methods inherited from class org.eclipse.jdt.ui.text.java.correction.CUCorrectionProposal |
---|
apply, createChange, createTextChange, didOpenEditor, getAdditionalProposalInfo, getCompilationUnit, getPreviewContent, getTextChange, toString |
Methods inherited from class org.eclipse.jdt.ui.text.java.correction.ChangeCorrectionProposal |
---|
getAdditionalProposalInfo, getChange, getCommandId, getContextInformation, getDisplayString, getImage, getName, getRelevance, getSelection, getStyledDisplayString, performChange, setCommandId, setDisplayName, setImage, setRelevance |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
public ASTRewriteCorrectionProposal(String name, ICompilationUnit cu, ASTRewrite rewrite, int relevance, Image image)
name
- the display name of the proposalcu
- the compilation unit that is modifiedrewrite
- the AST rewrite that is invoked when the proposal is applied or
null
if getRewrite()
is overriddenrelevance
- the relevance of this proposalimage
- the image that is displayed for this proposal or null
if no image
is desiredpublic ASTRewriteCorrectionProposal(String name, ICompilationUnit cu, ASTRewrite rewrite, int relevance)
name
- the display name of the proposalcu
- the compilation unit that is modifiedrewrite
- the AST rewrite that is invoked when the proposal is applied or
null
if getRewrite()
is overriddenrelevance
- The relevance of this proposalMethod Detail |
---|
public ImportRewrite getImportRewrite()
- Returns:
- the import rewrite or
null
if no import rewrite has been set - Restriction:
- This method is not intended to be re-implemented or extended by clients.
public void setImportRewrite(ImportRewrite rewrite)
rewrite
- the import rewritepublic ImportRewrite createImportRewrite(CompilationUnit astRoot)
astRoot
- the AST for the current CU
protected void addEdits(IDocument document, TextEdit editRoot) throws CoreException
CUCorrectionProposal
CompilationUnitChange
is initialized. Subclasses can override to add
text edits to the root edit of the change. Implementors must not access the proposal, e.g.
not call ChangeCorrectionProposal.getChange()
.
The default implementation does not add any edits
addEdits
in class CUCorrectionProposal
document
- content of the underlying compilation unit. To be accessed read only.editRoot
- The root edit to add all edits to
CoreException
- can be thrown if adding the edits is failing.protected ASTRewrite getRewrite() throws CoreException
CoreException
- when the rewrite could not be created
|
Eclipse JDT Release 3.8 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Guidelines for using Eclipse APIs.
Copyright (c) 2000, 2013 IBM Corporation and others. All rights reserved.