org.eclipse.xtext.formatting2.regionaccess.internal

Class NodeHidden

java.lang.Object

org.eclipse.xtext.formatting2.internal.AbstractTextSegment

org.eclipse.xtext.formatting2.regionaccess.internal.NodeRegion

org.eclipse.xtext.formatting2.regionaccess.internal.NodeHidden

All Implemented Interfaces:

java.lang.Comparable<ITextSegment>, ITextSegment, IHiddenRegionPart, ITextRegion

Direct Known Subclasses:

NodeComment, NodeWhitespace

public class NodeHidden
extends NodeRegion
implements IHiddenRegionPart

Author:

Moritz Eysholdt - Initial contribution and API

Field Summary

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

EMPTY_REGION

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	NodeHidden(HiddenRegion gap, INode node)

Method Summary

Methods

Modifier and Type	Method and Description
AbstractRule	getGrammarElement()
IHiddenRegion	getHiddenRegion()
IHiddenRegionPart	getNextHiddenPart()
IHiddenRegionPart	getPreviousHiddenPart()

Methods inherited from class org.eclipse.xtext.formatting2.regionaccess.internal.NodeRegion

getLength, getNode, getOffset, getSemanticElement, getTextRegionAccess, toString

Methods inherited from class org.eclipse.xtext.formatting2.internal.AbstractTextSegment

compareTo, contains, contains, equals, getEndOffset, getIndentation, getLineCount, getText, hashCode, isMultiline, merge, splitIntoLines

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

getEndOffset, getIndentation, getLineCount, getText, getTextRegionAccess, isMultiline, splitIntoLines

Methods inherited from interface java.lang.Comparable

compareTo

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

contains, contains, getLength, getOffset, merge

Constructor Detail

NodeHidden

protected NodeHidden(HiddenRegion gap,
          INode node)

Method Detail

getGrammarElement

public AbstractRule getGrammarElement()

Specified by:

getGrammarElement in interface IHiddenRegionPart

Overrides:

getGrammarElement in class NodeRegion

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

public IHiddenRegion getHiddenRegion()

Specified by:

getHiddenRegion in interface IHiddenRegionPart

Returns:

the IHiddenRegion this IWhitespace or IComment is a member of.

getNextHiddenPart

public IHiddenRegionPart getNextHiddenPart()

Specified by:

getNextHiddenPart in interface IHiddenRegionPart

Returns:

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

getPreviousHiddenPart

public IHiddenRegionPart getPreviousHiddenPart()

Specified by:

getPreviousHiddenPart in interface IHiddenRegionPart

Returns:

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