org.eclipse.xtext.resource

Interface ILocationInFileProvider

All Known Implementing Classes:

DefaultLocationInFileProvider, XtextLocationInFileProvider

public interface ILocationInFileProvider

Delivers ITextRegions for model elements or feature settings. The significant text is the part of the text identifying the element, e.g. its name, as opposed to the full region which is the full text representing the element. In addition to this service, the extension interface ILocationInFileProviderExtension allows to query for the region that is spanned by an EObject including its comments.

Author:

Sven Efftinge - Initial contribution and API, Jan Koehnlein - Distinguish significant and full region

Method Summary

Methods

Modifier and Type	Method and Description
ITextRegion	getFullTextRegion(org.eclipse.emf.ecore.EObject obj)
ITextRegion	getFullTextRegion(org.eclipse.emf.ecore.EObject owner, org.eclipse.emf.ecore.EStructuralFeature feature, int indexInList)
ITextRegion	getSignificantTextRegion(org.eclipse.emf.ecore.EObject obj)
ITextRegion	getSignificantTextRegion(org.eclipse.emf.ecore.EObject owner, org.eclipse.emf.ecore.EStructuralFeature feature, int indexInList)

Method Detail

getSignificantTextRegion

ITextRegion getSignificantTextRegion(org.eclipse.emf.ecore.EObject obj)

See Also:

ILocationInFileProviderExtension.RegionDescription.SIGNIFICANT

getSignificantTextRegion

ITextRegion getSignificantTextRegion(org.eclipse.emf.ecore.EObject owner,
                                   org.eclipse.emf.ecore.EStructuralFeature feature,
                                   int indexInList)

See Also:

ILocationInFileProviderExtension.RegionDescription.SIGNIFICANT

getFullTextRegion

ITextRegion getFullTextRegion(org.eclipse.emf.ecore.EObject obj)

See Also:

ILocationInFileProviderExtension.RegionDescription.FULL

getFullTextRegion

ITextRegion getFullTextRegion(org.eclipse.emf.ecore.EObject owner,
                            org.eclipse.emf.ecore.EStructuralFeature feature,
                            int indexInList)

See Also:

ILocationInFileProviderExtension.RegionDescription.FULL