Interface IVariable
-
- All Known Subinterfaces:
ICursorVariable
,IEditVariable
,IGlobalVariable
- All Known Implementing Classes:
AbstractVariable
,CreateMethodAndInvocationVariable
,CreateMethodVariable
,CursorVariable
,DateVariable
,EditVariable
,EnumerationValueVariable
,FormatStringVariable
,InsertMetadataObjectNameVariable
,MetadataObjectPredefinedItemVariable
,ProposalsVariable
,QueryTextVariable
,SelectionVariable
,TypeDescriptionBuilderVariable
,TypeSelectionVariable
,UserVariable
public interface IVariable
This interface represents variable inside template
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description ApplyResult
apply(String indentation)
Performs apply creating replace edits for template.IVariableDialogProvider
getDialogProvider()
Gets special provider for open dialog for editing value after apllying variableIVariableProposalProvider
getProposalProvider()
Creates proposal provider that can create proposals for linked position.org.eclipse.jface.text.IRegion
getRegion()
Returns region of the entry of this variable inside template
-
-
-
Method Detail
-
apply
ApplyResult apply(String indentation)
Performs apply creating replace edits for template. Do not shift for template's offset- Parameters:
indentation
- The current indentation level, cannot benull
- Returns:
- The replace edit for template string, cannot be
null
-
getRegion
org.eclipse.jface.text.IRegion getRegion()
Returns region of the entry of this variable inside template- Returns:
- The regions that are entries of this variable inside the template, cannot be
null
-
getProposalProvider
IVariableProposalProvider getProposalProvider()
Creates proposal provider that can create proposals for linked position.- Returns:
- Proposal provider for this variable, can be
null
if no proposals can be created by this variable and it does not need linked mode. Linked mode created for non-null providers
-
getDialogProvider
IVariableDialogProvider getDialogProvider()
Gets special provider for open dialog for editing value after apllying variable- Returns:
- special provider for open dialog for editing value after apllying variable, can be
null
-
-