org.eclipse.xtext.formatting2.regionaccess

Interface IHiddenRegionPart

All Superinterfaces:

Comparable<ITextSegment>, ITextRegion, ITextSegment

All Known Subinterfaces:

IComment, IWhitespace

All Known Implementing Classes:

NodeComment, NodeHidden, NodeWhitespace, StringComment, StringHidden, StringWhitespace

public interface IHiddenRegionPart
extends ITextSegment

Common interface for IWhitespace and IComment.

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
org.eclipse.emf.ecore.EObject	getGrammarElement()
IHiddenRegion	getHiddenRegion()
IHiddenRegionPart	getNextHiddenPart()
IHiddenRegionPart	getPreviousHiddenPart()

Methods inherited from interface org.eclipse.xtext.formatting2.regionaccess.ITextSegment

getEndOffset, getLineCount, getLineRegions, getText, getTextRegionAccess, isMultiline, merge, replaceWith

Methods inherited from interface java.lang.Comparable

compareTo

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

contains, contains, getLength, getOffset

Method Detail

getGrammarElement

org.eclipse.emf.ecore.EObject getGrammarElement()

Returns:

The grammar element the parser used to parse this IWhitespace or IComment. This should be an TerminalRule for tokens the grammar defined as 'hidden'. May be another grammar element if the construction of the ITextRegionAccess has been customized.

getHiddenRegion

IHiddenRegion getHiddenRegion()

Returns:

the IHiddenRegion this IWhitespace or IComment is a member of.

getNextHiddenPart

IHiddenRegionPart getNextHiddenPart()

Returns:

The next following IWhitespace or IComment inside the same IHiddenRegion. Null if the current IHiddenRegionPart is the last element inside its IHiddenRegion.

getPreviousHiddenPart

IHiddenRegionPart getPreviousHiddenPart()

Returns:

The leading IWhitespace or IComment inside the same IHiddenRegion. Null if the current IHiddenRegionPart is the first element inside its IHiddenRegion.