Package com.e1c.g5.v8.dt.lcore.ui.templates.contentassist.variable

Interface IGlobalVariable

All Superinterfaces:

IVariable

All Known Implementing Classes:

CreateMethodAndInvocationVariable, CreateMethodVariable

public interface IGlobalVariable
extends IVariable

Global variable that can apply edits to any point of the document

Method Summary

Modifier and Type	Method	Description
ApplyResult	applyGlobal(org.eclipse.xtext.ui.editor.model.XtextDocument document, org.eclipse.jface.text.IRegion variablePosition, IPlacementContext placementContext)	Performs apply at any region of the document
IPlacementContext	preApplyGlobal(org.eclipse.xtext.ui.editor.model.XtextDocument document, int offset)	Computes additional data for computing ApplyResult in method #applyGlobal(XtextDocument, IRegion) before content of the document will be changed by template pattern

Methods inherited from interface com.e1c.g5.v8.dt.lcore.ui.templates.contentassist.variable.IVariable

apply, getDialogProvider, getProposalProvider, getRegion

Method Detail

preApplyGlobal

IPlacementContext preApplyGlobal(org.eclipse.xtext.ui.editor.model.XtextDocument document,
                                 int offset)

Computes additional data for computing ApplyResult in method #applyGlobal(XtextDocument, IRegion) before content of the document will be changed by template pattern

Parameters:

document - actual document for applying ITemplate

offset - offset of applying whole ITemplate

Returns:

additional data for computing ApplyResult in method #applyGlobal(XtextDocument, IRegion) before content of the document will be changed by template pattern, can be null if

applyGlobal

ApplyResult applyGlobal(org.eclipse.xtext.ui.editor.model.XtextDocument document,
                        org.eclipse.jface.text.IRegion variablePosition,
                        IPlacementContext placementContext)

Performs apply at any region of the document

Parameters:

document - The document to perform apply on, cannot be null

variablePosition - The position of the variable after applying template and usual IVariable.apply(String), cannot be null

placementContext - additional information for creating ApplyResult, computed in {@link #preApplyGlobal(XtextDocument, int), can be null if there is no additional information

Returns:

The result of global apply, cannot be null