Package org.eclipse.xtext.ide.server.occurrences

Interface ITextRegionTransformer

All Known Implementing Classes:

ITextRegionTransformer.Default

public interface ITextRegionTransformer

Representation of a transformer function that creates document document highlight instances form text regions.

Author:

akos.kitta - Initial contribution and API

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	ITextRegionTransformer.Default	Default text region to document highlight transformation function.

Method Summary

Modifier and Type	Method	Description
org.eclipse.lsp4j.DocumentHighlight	apply(Document document, org.eclipse.xtext.util.ITextRegion region, org.eclipse.lsp4j.DocumentHighlightKind kind)	Transforms the text region argument into a document highlight instance by calculating the proper position from the document.

Method Details

apply

org.eclipse.lsp4j.DocumentHighlight apply(Document document,
 org.eclipse.xtext.util.ITextRegion region,
 org.eclipse.lsp4j.DocumentHighlightKind kind)

Transforms the text region argument into a document highlight instance by calculating the proper position from the document. The given kind will be used to distinguish between read, write and ordinary text occurrences.

This conversion is required to transform the Xtext specific document relative offsets into language server specific line relative offsets.

Parameters:

document - the document that contains the text content. Cannot be null.

region - the text region that has to be converted. Cannot be null.

kind - the document highlight kind. Cannot be null.

Returns:

with a new transformed document highlight instance.