Package org.eclipse.xtext.formatting2.regionaccess.internal

Class StringHidden

java.lang.Object

org.eclipse.xtext.formatting2.regionaccess.internal.AbstractTextSegment

org.eclipse.xtext.formatting2.regionaccess.internal.StringRegion

org.eclipse.xtext.formatting2.regionaccess.internal.StringHidden

All Implemented Interfaces:

java.lang.Comparable<ITextSegment>, IHiddenRegionPart, ITextSegment, org.eclipse.xtext.util.ITextRegion

Direct Known Subclasses:

StringComment, StringWhitespace

public class StringHidden
extends StringRegion
implements IHiddenRegionPart

Field Summary

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

EMPTY_REGION

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	StringHidden(AbstractHiddenRegion hidden, AbstractRule rule, int offset, int lenght)

Method Summary

Modifier and Type	Method	Description
HiddenRegionPartAssociation	getAssociation()
AbstractRule	getGrammarElement()
IHiddenRegion	getHiddenRegion()
IHiddenRegionPart	getNextHiddenPart()
IHiddenRegionPart	getPreviousHiddenPart()
protected void	setAssociation(HiddenRegionPartAssociation association)

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

getLength, getOffset, getTextRegionAccess, toString

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

compareTo, contains, contains, equals, getEndOffset, getLineCount, getLineRegions, getText, hashCode, isMultiline, merge, replaceWith

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Comparable

compareTo

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

contains, contains, getLength, getOffset

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

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

Constructor Detail

StringHidden

protected StringHidden(AbstractHiddenRegion hidden,
                       AbstractRule rule,
                       int offset,
                       int lenght)

Method Detail

getGrammarElement

public AbstractRule getGrammarElement()

Specified by:

getGrammarElement in interface IHiddenRegionPart

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.

setAssociation

protected void setAssociation(HiddenRegionPartAssociation association)

getAssociation

public HiddenRegionPartAssociation getAssociation()

Specified by:

getAssociation in interface IHiddenRegionPart

Returns:

A hint whether the whitespace or comment belongs to the previous or next semantic element or neither of them.

See Also:

for custom behaviour.