org.eclipse.xtext.formatting2.regionaccess

Interface ITextSegment

All Superinterfaces:

Comparable<ITextSegment>, ITextRegion

All Known Subinterfaces:

IComment, IEObjectRegion, IHiddenRegion, IHiddenRegionPart, ILineRegion, ISemanticRegion, ISequentialRegion, ITextReplacement, IWhitespace

All Known Implementing Classes:

AbstractEObjectRegion, AbstractHiddenRegion, AbstractTextSegment, LineRegion, NodeComment, NodeEObjectRegion, NodeHidden, NodeHiddenRegion, NodeRegion, NodeSemanticRegion, NodeWhitespace, StringComment, StringEObjectRegion, StringHidden, StringHiddenRegion, StringRegion, StringSemanticRegion, StringWhitespace, TextReplacement, TextSegment

public interface ITextSegment
extends Comparable<ITextSegment>, ITextRegion

A text segment describes a part of a document and carries a few more information, e.g. about the current indentation level.

Since:

2.8

Author:

Moritz Eysholdt - Initial contribution and API

Field Summary

Fields inherited from interface org.eclipse.xtext.util.ITextRegion

EMPTY_REGION

Method Summary

Methods

Modifier and Type	Method and Description
int	getEndOffset()
int	getLineCount()
List<ILineRegion>	getLineRegions()
String	getText()
ITextRegionAccess	getTextRegionAccess()
boolean	isMultiline()
ITextSegment	merge(ITextRegion region)
ITextReplacement	replaceWith(String text)

Methods inherited from interface java.lang.Comparable

compareTo

Methods inherited from interface org.eclipse.xtext.util.ITextRegion

contains, contains, getLength, getOffset

Method Detail

getEndOffset

int getEndOffset()

getLineCount

int getLineCount()

getLineRegions

List<ILineRegion> getLineRegions()

getText

String getText()

getTextRegionAccess

ITextRegionAccess getTextRegionAccess()

isMultiline

boolean isMultiline()

merge

ITextSegment merge(ITextRegion region)

Specified by:

merge in interface ITextRegion

replaceWith

ITextReplacement replaceWith(String text)