|
Eclipse Platform Release 3.0 |
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.eclipse.ui.texteditor.templates.TemplateVariableProposal
A proposal for insertion of template variables.
This class should not be used by clients and may become package visible in the future.
Constructor Summary | |
TemplateVariableProposal(TemplateVariableResolver variable,
int offset,
int length,
ITextViewer viewer)
Creates a template variable proposal. |
Method Summary | |
void |
apply(IDocument document)
Inserts the proposed completion into the given document. |
String |
getAdditionalProposalInfo()
Returns optional additional information about the proposal. |
IContextInformation |
getContextInformation()
Returns optional context information associated with this proposal. |
String |
getDisplayString()
Returns the string to be displayed in the list of completion proposals. |
Image |
getImage()
Returns the image to be displayed in the list of completion proposals. |
Point |
getSelection(IDocument document)
Returns the new selection after the proposal has been applied to the given document in absolute document coordinates. |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
public TemplateVariableProposal(TemplateVariableResolver variable, int offset, int length, ITextViewer viewer)
variable
- the template variableoffset
- the offset to replacelength
- the length to replaceviewer
- the viewerMethod Detail |
public void apply(IDocument document)
ICompletionProposal
apply
in interface ICompletionProposal
document
- the document into which to insert the proposed completionpublic Point getSelection(IDocument document)
ICompletionProposal
null
, no new selection is set.
A document change can trigger other document changes, which have
to be taken into account when calculating the new selection. Typically,
this would be done by installing a document listener or by using a
document position during ICompletionProposal.apply(IDocument)
.
getSelection
in interface ICompletionProposal
document
- the document into which the proposed completion has been inserted
public String getAdditionalProposalInfo()
ICompletionProposal
getAdditionalProposalInfo
in interface ICompletionProposal
null
public String getDisplayString()
ICompletionProposal
getDisplayString
in interface ICompletionProposal
public Image getImage()
ICompletionProposal
getImage
in interface ICompletionProposal
null
if no image is desiredpublic IContextInformation getContextInformation()
ICompletionProposal
getContextInformation
in interface ICompletionProposal
null
|
Eclipse Platform Release 3.0 |
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Guidelines for using Eclipse APIs.
Copyright (c) IBM Corp. and others 2000, 2004. All rights reserved.