Package org.eclipse.xtext.ide.editor.folding

Class DefaultFoldingRangeProvider

java.lang.Object

org.eclipse.xtext.ide.editor.folding.DefaultFoldingRangeProvider

All Implemented Interfaces:

IFoldingRangeProvider

public class DefaultFoldingRangeProvider
extends java.lang.Object
implements IFoldingRangeProvider

Since:

2.26

Field Summary

Fields

Modifier and Type	Field	Description
protected static java.util.regex.Pattern	TEXT_PATTERN_IN_COMMENT

Constructor Summary

Constructors

Constructor	Description
DefaultFoldingRangeProvider()

Method Summary

Modifier and Type	Method	Description
protected void	acceptCommentFolding(org.eclipse.xtext.nodemodel.INode commentNode, IFoldingRangeAcceptor foldingRangeAcceptor)
protected void	acceptCommentNodes(org.eclipse.emf.ecore.EObject eObject, IFoldingRangeAcceptor foldingRangeAcceptor)
protected void	acceptObjectFolding(org.eclipse.emf.ecore.EObject eObject, IFoldingRangeAcceptor foldingRangeAcceptor)
protected org.eclipse.xtext.util.ITextRegion	buildSignificantRegion(org.eclipse.xtext.util.ITextRegion significantRegion, org.eclipse.xtext.nodemodel.INode node)
protected void	computeCommentFolding(org.eclipse.xtext.resource.XtextResource resource, IFoldingRangeAcceptor foldingRangeAcceptor)
protected void	computeObjectFolding(org.eclipse.xtext.resource.XtextResource resource, IFoldingRangeAcceptor foldingRangeAcceptor, org.eclipse.xtext.util.CancelIndicator cancelIndicator)
protected IFoldingRangeAcceptor	createAcceptor(org.eclipse.xtext.resource.XtextResource resource, java.util.Collection<FoldingRange> foldingRanges)
java.util.SortedSet<FoldingRange>	getFoldingRanges(org.eclipse.xtext.resource.XtextResource xtextDocument, org.eclipse.xtext.util.CancelIndicator cancelIndicator)
protected org.eclipse.xtext.resource.ILocationInFileProvider	getLocationInFileProvider()
protected java.lang.String	getMultilineCommentRuleName()
protected java.util.regex.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 java.util.regex.Pattern TEXT_PATTERN_IN_COMMENT

Constructor Detail

DefaultFoldingRangeProvider

public DefaultFoldingRangeProvider()

Method Detail

getFoldingRanges

public java.util.SortedSet<FoldingRange> getFoldingRanges(org.eclipse.xtext.resource.XtextResource xtextDocument,
                                                          org.eclipse.xtext.util.CancelIndicator cancelIndicator)

Specified by:

getFoldingRanges in interface IFoldingRangeProvider

Returns:

the set of FoldingRanges for the given document

computeObjectFolding

protected void computeObjectFolding(org.eclipse.xtext.resource.XtextResource resource,
                                    IFoldingRangeAcceptor foldingRangeAcceptor,
                                    org.eclipse.xtext.util.CancelIndicator cancelIndicator)

acceptObjectFolding

protected void acceptObjectFolding(org.eclipse.emf.ecore.EObject eObject,
                                   IFoldingRangeAcceptor foldingRangeAcceptor)

buildSignificantRegion

protected org.eclipse.xtext.util.ITextRegion buildSignificantRegion(org.eclipse.xtext.util.ITextRegion significantRegion,
                                                                    org.eclipse.xtext.nodemodel.INode node)

computeCommentFolding

protected void computeCommentFolding(org.eclipse.xtext.resource.XtextResource resource,
                                     IFoldingRangeAcceptor foldingRangeAcceptor)

acceptCommentNodes

protected void acceptCommentNodes(org.eclipse.emf.ecore.EObject eObject,
                                  IFoldingRangeAcceptor foldingRangeAcceptor)

acceptCommentFolding

protected void acceptCommentFolding(org.eclipse.xtext.nodemodel.INode commentNode,
                                    IFoldingRangeAcceptor foldingRangeAcceptor)

createAcceptor

protected IFoldingRangeAcceptor createAcceptor(org.eclipse.xtext.resource.XtextResource resource,
                                               java.util.Collection<FoldingRange> foldingRanges)

getLocationInFileProvider

protected org.eclipse.xtext.resource.ILocationInFileProvider getLocationInFileProvider()

getMultilineCommentRuleName

protected java.lang.String getMultilineCommentRuleName()

getTextPatternInComment

protected java.util.regex.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 return false to abort the traversal of the model.