org.eclipse.xtext.formatting2.regionaccess

Interface ITextRegionExtensions

All Known Implementing Classes:

AbstractRegionAccess, NodeModelBasedRegionAccess, StringBasedRegionAccess, StringBasedTextRegionAccessDiff

public interface ITextRegionExtensions

This class is a facade on top of an ITextRegionAccess. It provides convenience methods to be used by formatters that are implemented in the Xtend programming language.

Method Summary

Modifier and Type	Method and Description
ISemanticRegionsFinder	allRegionsFor(org.eclipse.emf.ecore.EObject semanticElement)
java.lang.Iterable<ISemanticRegion>	allSemanticRegions(org.eclipse.emf.ecore.EObject semanticElement)
ITextRegionAccess	getTextRegionAccess()
org.eclipse.emf.ecore.EObject	grammarElement(org.eclipse.emf.ecore.EObject semanticElement)
ISemanticRegionFinder	immediatelyFollowing(org.eclipse.emf.ecore.EObject semanticElement)
ISemanticRegionFinder	immediatelyPreceding(org.eclipse.emf.ecore.EObject semanticElement)
boolean	isMultiline(org.eclipse.emf.ecore.EObject semanticElement)
IHiddenRegion	nextHiddenRegion(org.eclipse.emf.ecore.EObject semanticElement)
IHiddenRegion	previousHiddenRegion(org.eclipse.emf.ecore.EObject semanticElement)
ISemanticRegionsFinder	regionFor(org.eclipse.emf.ecore.EObject semanticElement)
IEObjectRegion	regionForEObject(org.eclipse.emf.ecore.EObject semanticElement)
java.lang.Iterable<ISemanticRegion>	semanticRegions(org.eclipse.emf.ecore.EObject semanticElement)

Method Detail

allRegionsFor

ISemanticRegionsFinder allRegionsFor(org.eclipse.emf.ecore.EObject semanticElement)

allSemanticRegions

java.lang.Iterable<ISemanticRegion> allSemanticRegions(org.eclipse.emf.ecore.EObject semanticElement)

getTextRegionAccess

ITextRegionAccess getTextRegionAccess()

grammarElement

org.eclipse.emf.ecore.EObject grammarElement(org.eclipse.emf.ecore.EObject semanticElement)

Returns:

the RuleCall or the assigned Action that led to the construction of this EObject. For the model's root element, the ParserRule is returned.

immediatelyFollowing

ISemanticRegionFinder immediatelyFollowing(org.eclipse.emf.ecore.EObject semanticElement)

immediatelyPreceding

ISemanticRegionFinder immediatelyPreceding(org.eclipse.emf.ecore.EObject semanticElement)

isMultiline

boolean isMultiline(org.eclipse.emf.ecore.EObject semanticElement)

Returns:

true, if the EObject's text range contains a line-wrap ("\n"). The EObject's text range reaches from the beginning of its first semantic region to the end of its last semantic region.

nextHiddenRegion

IHiddenRegion nextHiddenRegion(org.eclipse.emf.ecore.EObject semanticElement)

Returns:

the IHiddenRegion that follows after the EObject's last ISemanticRegion.

See Also:

previousHiddenRegion(EObject)

previousHiddenRegion

IHiddenRegion previousHiddenRegion(org.eclipse.emf.ecore.EObject semanticElement)

Returns:

the IHiddenRegion that precedes the EObject's first ISemanticRegion.

See Also:

nextHiddenRegion(EObject)

regionFor

ISemanticRegionsFinder regionFor(org.eclipse.emf.ecore.EObject semanticElement)

regionForEObject

IEObjectRegion regionForEObject(org.eclipse.emf.ecore.EObject semanticElement)

Returns:

a text region that reaches from the beginning of its first semantic region to the end of its last semantic region.

semanticRegions

java.lang.Iterable<ISemanticRegion> semanticRegions(org.eclipse.emf.ecore.EObject semanticElement)