org.eclipse.xtext.formatting2.regionaccess.internal

Class AbstractRegionAccess

java.lang.Object

org.eclipse.xtext.formatting2.regionaccess.internal.AbstractRegionAccess

All Implemented Interfaces:

ITextRegionAccess, ITextRegionExtensions

Direct Known Subclasses:

NodeModelBasedRegionAccess, StringBasedRegionAccess

public abstract class AbstractRegionAccess
extends Object
implements ITextRegionAccess, ITextRegionExtensions

Author:

Moritz Eysholdt - Initial contribution and API

Constructor Summary

Constructors

Constructor and Description
AbstractRegionAccess()

Method Summary

Methods

Modifier and Type	Method and Description
ISemanticRegionsFinder	allRegionsFor(org.eclipse.emf.ecore.EObject object)
Iterable<ISemanticRegion>	allSemanticRegions(org.eclipse.emf.ecore.EObject object)
ITextRegionExtensions	getExtensions()
TextRegionRewriter	getRewriter()
protected abstract String	getText()
ITextRegionAccess	getTextRegionAccess()
org.eclipse.emf.ecore.EObject	grammarElement(org.eclipse.emf.ecore.EObject obj)
ISemanticRegionFinder	immediatelyFollowing(org.eclipse.emf.ecore.EObject owner)
ISemanticRegionFinder	immediatelyPreceding(org.eclipse.emf.ecore.EObject owner)
protected Map<? extends org.eclipse.emf.ecore.EObject,? extends AbstractEObjectRegion>	initMap()
boolean	isMultiline(org.eclipse.emf.ecore.EObject object)
IHiddenRegion	nextHiddenRegion(org.eclipse.emf.ecore.EObject owner)
IHiddenRegion	previousHiddenRegion(org.eclipse.emf.ecore.EObject owner)
ISemanticRegionsFinder	regionFor(org.eclipse.emf.ecore.EObject object)
abstract AbstractEObjectRegion	regionForEObject(org.eclipse.emf.ecore.EObject object)
ILineRegion	regionForLineAtOffset(int offset)
ITextSegment	regionForOffset(int offset, int length)
Iterable<ISemanticRegion>	semanticRegions(org.eclipse.emf.ecore.EObject object)
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

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

getResource, hasSyntaxError, regionForDocument, regionForRootEObject, textForOffset

Constructor Detail

AbstractRegionAccess

public AbstractRegionAccess()

Method Detail

getExtensions

public ITextRegionExtensions getExtensions()

Specified by:

getExtensions in interface ITextRegionAccess

allSemanticRegions

public Iterable<ISemanticRegion> allSemanticRegions(org.eclipse.emf.ecore.EObject object)

Specified by:

allSemanticRegions in interface ITextRegionExtensions

semanticRegions

public Iterable<ISemanticRegion> semanticRegions(org.eclipse.emf.ecore.EObject object)

Specified by:

semanticRegions in interface ITextRegionExtensions

allRegionsFor

public ISemanticRegionsFinder allRegionsFor(org.eclipse.emf.ecore.EObject object)

Specified by:

allRegionsFor in interface ITextRegionExtensions

grammarElement

public org.eclipse.emf.ecore.EObject grammarElement(org.eclipse.emf.ecore.EObject obj)

Specified by:

grammarElement in interface ITextRegionExtensions

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.

getRewriter

public TextRegionRewriter getRewriter()

Specified by:

getRewriter in interface ITextRegionAccess

getText

protected abstract String getText()

getTextRegionAccess

public ITextRegionAccess getTextRegionAccess()

Specified by:

getTextRegionAccess in interface ITextRegionExtensions

immediatelyFollowing

public ISemanticRegionFinder immediatelyFollowing(org.eclipse.emf.ecore.EObject owner)

Specified by:

immediatelyFollowing in interface ITextRegionExtensions

immediatelyPreceding

public ISemanticRegionFinder immediatelyPreceding(org.eclipse.emf.ecore.EObject owner)

Specified by:

immediatelyPreceding in interface ITextRegionExtensions

initMap

protected Map<? extends org.eclipse.emf.ecore.EObject,? extends AbstractEObjectRegion> initMap()

isMultiline

public boolean isMultiline(org.eclipse.emf.ecore.EObject object)

Specified by:

isMultiline in interface ITextRegionExtensions

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.

previousHiddenRegion

public IHiddenRegion previousHiddenRegion(org.eclipse.emf.ecore.EObject owner)

Specified by:

previousHiddenRegion in interface ITextRegionExtensions

Returns:

the IHiddenRegion that precedes the EObject's first ISemanticRegion.

See Also:

ITextRegionExtensions.nextHiddenRegion(EObject)

regionFor

public ISemanticRegionsFinder regionFor(org.eclipse.emf.ecore.EObject object)

Specified by:

regionFor in interface ITextRegionExtensions

regionForEObject

public abstract AbstractEObjectRegion regionForEObject(org.eclipse.emf.ecore.EObject object)

Specified by:

regionForEObject in interface ITextRegionAccess

Specified by:

regionForEObject in interface ITextRegionExtensions

Returns:

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

regionForLineAtOffset

public ILineRegion regionForLineAtOffset(int offset)

Specified by:

regionForLineAtOffset in interface ITextRegionAccess

regionForOffset

public ITextSegment regionForOffset(int offset,
                           int length)

Specified by:

regionForOffset in interface ITextRegionAccess

toString

public String toString()

Overrides:

toString in class Object

nextHiddenRegion

public IHiddenRegion nextHiddenRegion(org.eclipse.emf.ecore.EObject owner)

Specified by:

nextHiddenRegion in interface ITextRegionExtensions

Returns:

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

See Also:

ITextRegionExtensions.previousHiddenRegion(EObject)