Package com.intellij.codeInsight.folding.impl

Class JavaFoldingBuilderBase

java.lang.Object

com.intellij.lang.folding.FoldingBuilderEx

com.intellij.lang.folding.CustomFoldingBuilder

com.intellij.codeInsight.folding.impl.JavaFoldingBuilderBase

All Implemented Interfaces:

FoldingBuilder, DumbAware, PossiblyDumbAware

Direct Known Subclasses:

JavaFoldingBuilder

public abstract class JavaFoldingBuilderBase
extends CustomFoldingBuilder
implements DumbAware

Constructor Summary

Constructors

Constructor and Description
JavaFoldingBuilderBase()

Method Summary

Modifier and Type	Method and Description
protected void	buildLanguageFoldRegions(java.util.List<FoldingDescriptor> descriptors, PsiElement root, Document document, boolean quick) Implement this method to build language folding regions besides custom folding regions.
protected java.lang.String	getLanguagePlaceholderText(ASTNode node, TextRange range)
static boolean	hasErrorElementsNearby(PsiFile file, int startOffset, int endOffset)
protected abstract boolean	isBelowRightMargin(PsiFile file, int lineLength)
protected boolean	isCustomFoldingCandidate(ASTNode node) Checks if a node may contain custom folding tags.
protected boolean	isCustomFoldingRoot(ASTNode node) Checks if the node is used as custom folding root.
protected boolean	isRegionCollapsedByDefault(ASTNode node) Returns the default collapsed state for the folding region related to the specified node.
protected java.lang.String	rightArrow()
protected abstract boolean	shouldShowExplicitLambdaType(PsiAnonymousClass anonymousClass, PsiNewExpression expression)

Methods inherited from class com.intellij.lang.folding.CustomFoldingBuilder

buildFoldRegions, buildFoldRegions, getPlaceholderText, getPlaceholderText, isCollapsedByDefault, isCustomFoldingCandidate, isCustomRegionElement, isCustomRegionEnd, isCustomRegionStart, isDumbAware

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.intellij.lang.folding.FoldingBuilder

isCollapsedByDefault

Constructor Detail

JavaFoldingBuilderBase

public JavaFoldingBuilderBase()

Method Detail

hasErrorElementsNearby

public static boolean hasErrorElementsNearby(PsiFile file,
                                             int startOffset,
                                             int endOffset)

shouldShowExplicitLambdaType

protected abstract boolean shouldShowExplicitLambdaType(PsiAnonymousClass anonymousClass,
                                                        PsiNewExpression expression)

buildLanguageFoldRegions

protected void buildLanguageFoldRegions(java.util.List<FoldingDescriptor> descriptors,
                                        PsiElement root,
                                        Document document,
                                        boolean quick)

Description copied from class: CustomFoldingBuilder

Implement this method to build language folding regions besides custom folding regions.

Specified by:

buildLanguageFoldRegions in class CustomFoldingBuilder

Parameters:

descriptors - The list of folding descriptors to store results to.

root - The root node for which the folding is requested.

document - The document for which folding is built.

quick - whether the result should be provided as soon as possible without reference resolving and complex checks.

getLanguagePlaceholderText

protected java.lang.String getLanguagePlaceholderText(ASTNode node,
                                                      TextRange range)

Specified by:

getLanguagePlaceholderText in class CustomFoldingBuilder

isRegionCollapsedByDefault

protected boolean isRegionCollapsedByDefault(ASTNode node)

Description copied from class: CustomFoldingBuilder

Returns the default collapsed state for the folding region related to the specified node.

Specified by:

isRegionCollapsedByDefault in class CustomFoldingBuilder

Parameters:

node - the node for which the collapsed state is requested.

Returns:

true if the region is collapsed by default, false otherwise.

rightArrow

protected java.lang.String rightArrow()

isBelowRightMargin

protected abstract boolean isBelowRightMargin(PsiFile file,
                                              int lineLength)

isCustomFoldingCandidate

protected boolean isCustomFoldingCandidate(ASTNode node)

Description copied from class: CustomFoldingBuilder

Checks if a node may contain custom folding tags. By default returns true for PsiComment but a language folding builder may override this method to allow only specific subtypes of comments (for example, line comments only).

Overrides:

isCustomFoldingCandidate in class CustomFoldingBuilder

Parameters:

node - The node to check.

Returns:

True if the node may contain custom folding tags.

isCustomFoldingRoot

protected boolean isCustomFoldingRoot(ASTNode node)

Description copied from class: CustomFoldingBuilder

Checks if the node is used as custom folding root. Any custom folding elements inside the root are considered to be at the same level even if they are located at different levels of PSI tree. By default the method returns true if the node has any child elements (only custom folding comments at the same PSI tree level are processed, start/end comments at different levels will be ignored).

Overrides:

isCustomFoldingRoot in class CustomFoldingBuilder

Parameters:

node - The node to check.

Returns:

True if the node is a root for custom foldings.