org.eclipse.xtext.ui.editor.folding

Class DefaultFoldingRegionProvider

java.lang.Object

org.eclipse.xtext.ui.editor.folding.DefaultFoldingRegionProvider

All Implemented Interfaces:

IFoldingRegionProvider

public class DefaultFoldingRegionProvider
extends Object
implements IFoldingRegionProvider

Author:

Michael Clay - Initial contribution and API, Sebastian Zarnekow - Introduced FoldedRegion, use ILocationInFileProvider

Field Summary

Fields

Modifier and Type	Field and Description
protected static Pattern	TEXT_PATTERN_IN_COMMENT

Constructor Summary

Constructors

Constructor and Description
DefaultFoldingRegionProvider()
DefaultFoldingRegionProvider(ILocationInFileProvider locationInFileProvider) Deprecated.

Method Summary

Methods

Modifier and Type	Method and Description
protected void	computeCommentFolding(IXtextDocument xtextDocument, IFoldingRegionAcceptor<ITextRegion> foldingRegionAcceptor)
protected void	computeCommentFolding(IXtextDocument xtextDocument, IFoldingRegionAcceptor<ITextRegion> foldingRegionAcceptor, org.eclipse.jface.text.ITypedRegion typedRegion, boolean initiallyFolded)
protected void	computeObjectFolding(org.eclipse.emf.ecore.EObject eObject, IFoldingRegionAcceptor<ITextRegion> foldingRegionAcceptor)
protected void	computeObjectFolding(org.eclipse.emf.ecore.EObject eObject, IFoldingRegionAcceptor<ITextRegion> foldingRegionAcceptor, boolean initiallyFolded)
protected void	computeObjectFolding(XtextResource xtextResource, IFoldingRegionAcceptor<ITextRegion> foldingRegionAcceptor)
protected IFoldingRegionAcceptor<ITextRegion>	createAcceptor(IXtextDocument xtextDocument, Collection<FoldedPosition> foldedPositions)
protected Collection<FoldedPosition>	doGetFoldingRegions(IXtextDocument xtextDocument, XtextResource xtextResource) Compute the folding region.
Collection<FoldedPosition>	getFoldingRegions(IXtextDocument xtextDocument)
protected ILocationInFileProvider	getLocationInFileProvider()
protected Pattern	getTextPatternInComment()
protected boolean	isHandled(org.eclipse.emf.ecore.EObject eObject)
protected boolean	shouldProcessContent(org.eclipse.emf.ecore.EObject object)

Methods inherited from class java.lang.Object

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

Field Detail

TEXT_PATTERN_IN_COMMENT

protected static final Pattern TEXT_PATTERN_IN_COMMENT

Constructor Detail

DefaultFoldingRegionProvider

@Deprecated
public DefaultFoldingRegionProvider(ILocationInFileProvider locationInFileProvider)

Deprecated.

DefaultFoldingRegionProvider

@Inject
public DefaultFoldingRegionProvider()

Method Detail

getFoldingRegions

public Collection<FoldedPosition> getFoldingRegions(IXtextDocument xtextDocument)

Specified by:

getFoldingRegions in interface IFoldingRegionProvider

Returns:

the list of FoldedPosition for the given document

doGetFoldingRegions

protected Collection<FoldedPosition> doGetFoldingRegions(IXtextDocument xtextDocument,
                                             XtextResource xtextResource)

Compute the folding region. This method is executed in a IUnitOfWork so it's save to use the given resource. However, since this is a blocking action when opening editors in e4, implementors should be careful to not resolve too many cross references. Users of the DerivedStateAwareResource should consider to access the resource via getParseResult().getRootAstElement() rather than getContents().get(0).

createAcceptor

protected IFoldingRegionAcceptor<ITextRegion> createAcceptor(IXtextDocument xtextDocument,
                                                 Collection<FoldedPosition> foldedPositions)

computeObjectFolding

protected void computeObjectFolding(XtextResource xtextResource,
                        IFoldingRegionAcceptor<ITextRegion> foldingRegionAcceptor)

getLocationInFileProvider

protected ILocationInFileProvider getLocationInFileProvider()

computeObjectFolding

protected void computeObjectFolding(org.eclipse.emf.ecore.EObject eObject,
                        IFoldingRegionAcceptor<ITextRegion> foldingRegionAcceptor)

computeObjectFolding

protected void computeObjectFolding(org.eclipse.emf.ecore.EObject eObject,
                        IFoldingRegionAcceptor<ITextRegion> foldingRegionAcceptor,
                        boolean initiallyFolded)

Since:

2.8

computeCommentFolding

protected void computeCommentFolding(IXtextDocument xtextDocument,
                         IFoldingRegionAcceptor<ITextRegion> foldingRegionAcceptor)

computeCommentFolding

protected void computeCommentFolding(IXtextDocument xtextDocument,
                         IFoldingRegionAcceptor<ITextRegion> foldingRegionAcceptor,
                         org.eclipse.jface.text.ITypedRegion typedRegion,
                         boolean initiallyFolded)
                              throws org.eclipse.jface.text.BadLocationException

Throws:

org.eclipse.jface.text.BadLocationException

Since:

2.8

getTextPatternInComment

protected Pattern getTextPatternInComment()

Returns:

the regular expression that finds the first significant part of a multi line comment.

isHandled

protected boolean isHandled(org.eclipse.emf.ecore.EObject eObject)

Returns:

true if the object should be folded if it spans more than one line. Default is false if and only if the object is the root object of the resource.

shouldProcessContent

protected boolean shouldProcessContent(org.eclipse.emf.ecore.EObject object)

Returns:

clients should false to abort the traversal of the model.