TemplateProposal (Eclipse 3.5.2 Javadoc and Source)

java.lang.Object
- org.eclipse.jdt.internal.ui.text.template.contentassist.TemplateProposal

All Implemented Interfaces:

IJavaCompletionProposal, ICompletionProposal, ICompletionProposalExtension2, ICompletionProposalExtension3, ICompletionProposalExtension4, ICompletionProposalExtension6

Direct Known Subclasses:

SurroundWithTemplateProposal
```
public class TemplateProposal
extends Object
implements IJavaCompletionProposal, ICompletionProposalExtension2, ICompletionProposalExtension3, ICompletionProposalExtension4, ICompletionProposalExtension6
```
A template proposal.

Constructor Summary

Constructors
Constructor and Description
`TemplateProposal(Template template, TemplateContext context, IRegion region, Image image)` Creates a template proposal with a template and its context.

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`apply(IDocument document)` Deprecated. This method is no longer called by the framework and clients should overwrite `apply(ITextViewer, char, int, int)` instead
`void`	`apply(ITextViewer viewer, char trigger, int stateMask, int offset)` Applies the proposed completion to the given document.
`String`	`getAdditionalProposalInfo()` Returns optional additional information about the proposal.
`protected TemplateContext`	`getContext()` Returns the context in which the template was requested.
`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.
`IInformationControlCreator`	`getInformationControlCreator()` Returns the information control creator of this completion proposal.
`int`	`getPrefixCompletionStart(IDocument document, int completionOffset)` Returns the document offset at which the receiver would insert its proposal.
`CharSequence`	`getPrefixCompletionText(IDocument document, int completionOffset)` Returns the string that would be inserted at the position returned from `ICompletionProposalExtension3.getPrefixCompletionStart(IDocument, int)` if this proposal was applied.
`int`	`getRelevance()` Returns the relevance of this completion proposal.
`protected int`	`getReplaceEndOffset()` Returns the end offset of the range in the document that will be replaced by applying this template.
`protected int`	`getReplaceOffset()` Returns the offset of the range in the document that will be replaced by applying this template.
`Point`	`getSelection(IDocument document)` Returns the new selection after the proposal has been applied to the given document in absolute document coordinates.
`StyledString`	`getStyledDisplayString()` Returns the styled string used to display this proposal in the list of completion proposals.
`Template`	`getTemplate()` Returns the template of this proposal.
`boolean`	`isAutoInsertable()` Returns `true` if the proposal may be automatically inserted, `false` otherwise.
`void`	`selected(ITextViewer viewer, boolean smartToggle)` Called when the proposal is selected.
`void`	`setDisplayString(StyledString displayString)`
`void`	`setRelevance(int relevance)`
`void`	`unselected(ITextViewer viewer)` Called when the proposal is unselected.
`boolean`	`validate(IDocument document, int offset, DocumentEvent event)` Requests the proposal to be validated with respect to the document event.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - TemplateProposal
```
public TemplateProposal(Template template,
                TemplateContext context,
                IRegion region,
                Image image)
```
    Creates a template proposal with a template and its context.
    
    Parameters:
    template - the template
    context - the context in which the template was requested.
    region - the region this proposal is applied to
    image - the icon of the proposal.
- Method Detail
  - getTemplate
```
public final Template getTemplate()
```
    Returns the template of this proposal.
    
    Returns:
    the template of this proposal
    Since:
    
    3.1
  - getContext
```
protected final TemplateContext getContext()
```
    Returns the context in which the template was requested.
    
    Returns:
    the context in which the template was requested
    Since:
    
    3.1
  - apply
```
public final void apply(IDocument document)
```
    Deprecated. This method is no longer called by the framework and clients should overwrite apply(ITextViewer, char, int, int) instead
    
    Inserts the proposed completion into the given document.
    
    Specified by:
    
    apply in interface ICompletionProposal
    
    Parameters:
    document - the document into which to insert the proposed completion
  - apply
```
public void apply(ITextViewer viewer,
         char trigger,
         int stateMask,
         int offset)
```
    Description copied from interface: ICompletionProposalExtension2
    
    Applies the proposed completion to the given document. The insertion has been triggered by entering the given character with a modifier at the given offset. This method assumes that ICompletionProposalExtension2.validate(IDocument, int, DocumentEvent) returns true if called for offset.
    
    Specified by:
    
    apply in interface ICompletionProposalExtension2
    
    Parameters:
    viewer - the text viewer into which to insert the proposed completion
    trigger - the trigger to apply the completion
    stateMask - the state mask of the modifiers
    offset - the offset at which the trigger has been activated
  - getReplaceOffset
```
protected final int getReplaceOffset()
```
    Returns the offset of the range in the document that will be replaced by applying this template.
    
    Returns:
    the offset of the range in the document that will be replaced by applying this template
  - getReplaceEndOffset
```
protected final int getReplaceEndOffset()
```
    Returns the end offset of the range in the document that will be replaced by applying this template.
    
    Returns:
    the end offset of the range in the document that will be replaced by applying this template
  - getSelection
```
public Point getSelection(IDocument document)
```
    Description copied from interface: ICompletionProposal
    
    Returns the new selection after the proposal has been applied to the given document in absolute document coordinates. If it returns 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).
    
    Specified by:
    
    getSelection in interface ICompletionProposal
    
    Parameters:
    document - the document into which the proposed completion has been inserted
    
    Returns:
    the new selection in absolute document coordinates
  - getAdditionalProposalInfo
```
public String getAdditionalProposalInfo()
```
    Description copied from interface: ICompletionProposal
    
    Returns optional additional information about the proposal. The additional information will be presented to assist the user in deciding if the selected proposal is the desired choice.
    If ICompletionProposalExtension5 is implemented, this method should not be called any longer. This method may be deprecated in a future release.
    
    Specified by:
    
    getAdditionalProposalInfo in interface ICompletionProposal
    
    Returns:
    the additional information or null
  - getDisplayString
```
public String getDisplayString()
```
    Description copied from interface: ICompletionProposal
    
    Returns the string to be displayed in the list of completion proposals.
    
    Specified by:
    
    getDisplayString in interface ICompletionProposal
    
    Returns:
    the string to be displayed
    See Also:
    ICompletionProposalExtension6.getStyledDisplayString()
  - getStyledDisplayString
```
public StyledString getStyledDisplayString()
```
    Description copied from interface: ICompletionProposalExtension6
    
    Returns the styled string used to display this proposal in the list of completion proposals. This can for example be used to draw mixed colored labels.
    Note: ICompletionProposal.getDisplayString() still needs to be correctly implemented as this method might be ignored in case of uninstalled owner draw support.
    
    Specified by:
    
    getStyledDisplayString in interface ICompletionProposalExtension6
    
    Returns:
    the string builder used to display this proposal
  - setDisplayString
```
public void setDisplayString(StyledString displayString)
```
  - getImage
```
public Image getImage()
```
    Description copied from interface: ICompletionProposal
    
    Returns the image to be displayed in the list of completion proposals. The image would typically be shown to the left of the display string.
    
    Specified by:
    
    getImage in interface ICompletionProposal
    
    Returns:
    the image to be shown or null if no image is desired
  - getContextInformation
```
public IContextInformation getContextInformation()
```
    Description copied from interface: ICompletionProposal
    
    Returns optional context information associated with this proposal. The context information will automatically be shown if the proposal has been applied.
    
    Specified by:
    
    getContextInformation in interface ICompletionProposal
    
    Returns:
    the context information for this proposal or null
  - getRelevance
```
public int getRelevance()
```
    Description copied from interface: IJavaCompletionProposal
    
    Returns the relevance of this completion proposal.
    The relevance is used to determine if this proposal is more relevant than another proposal.
    
    Specified by:
    
    getRelevance in interface IJavaCompletionProposal
    
    Returns:
    the relevance of this completion proposal in the range of [0, 100]
  - setRelevance
```
public void setRelevance(int relevance)
```
  - getInformationControlCreator
```
public IInformationControlCreator getInformationControlCreator()
```
    Description copied from interface: ICompletionProposalExtension3
    
    Returns the information control creator of this completion proposal.
    
    Specified by:
    
    getInformationControlCreator in interface ICompletionProposalExtension3
    
    Returns:
    the information control creator, or null if no custom control creator is available
  - selected
```
public void selected(ITextViewer viewer,
            boolean smartToggle)
```
    Description copied from interface: ICompletionProposalExtension2
    
    Called when the proposal is selected.
    
    Specified by:
    
    selected in interface ICompletionProposalExtension2
    
    Parameters:
    viewer - the text viewer.
    smartToggle - the smart toggle key was pressed
  - unselected
```
public void unselected(ITextViewer viewer)
```
    Description copied from interface: ICompletionProposalExtension2
    
    Called when the proposal is unselected.
    
    Specified by:
    
    unselected in interface ICompletionProposalExtension2
    
    Parameters:
    viewer - the text viewer.
  - validate
```
public boolean validate(IDocument document,
               int offset,
               DocumentEvent event)
```
    Description copied from interface: ICompletionProposalExtension2
    
    Requests the proposal to be validated with respect to the document event. If the proposal cannot be validated, the methods returns false. If the document event was null, only the caret offset was changed, but not the document. This method replaces ICompletionProposalExtension.isValidFor(IDocument, int)
    
    Specified by:
    
    validate in interface ICompletionProposalExtension2
    
    Parameters:
    document - the document
    offset - the caret offset
    event - the document event, may be null
    
    Returns:
    boolean
  - getPrefixCompletionText
```
public CharSequence getPrefixCompletionText(IDocument document,
                                   int completionOffset)
```
    Description copied from interface: ICompletionProposalExtension3
    
    Returns the string that would be inserted at the position returned from ICompletionProposalExtension3.getPrefixCompletionStart(IDocument, int) if this proposal was applied. If the replacement string cannot be determined, null may be returned.
    
    Specified by:
    
    getPrefixCompletionText in interface ICompletionProposalExtension3
    
    Parameters:
    document - the document that the receiver applies to
    completionOffset - the offset into document where the completion takes place
    
    Returns:
    the replacement string or null if it cannot be determined
  - getPrefixCompletionStart
```
public int getPrefixCompletionStart(IDocument document,
                           int completionOffset)
```
    Description copied from interface: ICompletionProposalExtension3
    
    Returns the document offset at which the receiver would insert its proposal.
    
    Specified by:
    
    getPrefixCompletionStart in interface ICompletionProposalExtension3
    
    Parameters:
    document - the document that the receiver applies to
    completionOffset - the offset into document where the completion takes place
    
    Returns:
    the offset at which the proposal would insert its proposal
  - isAutoInsertable
```
public boolean isAutoInsertable()
```
    Description copied from interface: ICompletionProposalExtension4
    
    Returns true if the proposal may be automatically inserted, false otherwise. Automatic insertion can happen if the proposal is the only one being proposed, in which case the content assistant may decide to not prompt the user with a list of proposals, but simply insert the single proposal. A proposal may veto this behavior by returning false to a call to this method.
    
    Specified by:
    
    isAutoInsertable in interface ICompletionProposalExtension4
    
    Returns:
    true if the proposal may be inserted automatically, false if not

Class TemplateProposal [ source ]

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

TemplateProposal

Method Detail

getTemplate

getContext

apply

apply

getReplaceOffset

getReplaceEndOffset

getSelection

getAdditionalProposalInfo

getDisplayString

getStyledDisplayString

setDisplayString

getImage

getContextInformation

getRelevance

setRelevance

getInformationControlCreator

selected

unselected

validate

getPrefixCompletionText

getPrefixCompletionStart

isAutoInsertable