Package com.intellij.lang.folding

Class CustomFoldingBuilder

java.lang.Object

com.intellij.lang.folding.FoldingBuilderEx

com.intellij.lang.folding.CustomFoldingBuilder

All Implemented Interfaces:

FoldingBuilder, PossiblyDumbAware

Direct Known Subclasses:

CustomFileTypeFoldingBuilder, GroovyFoldingBuilder, JavaFoldingBuilderBase, MarkdownFoldingBuilder, PropertiesFoldingBuilder, PythonFoldingBuilder, XmlCodeFoldingBuilder, YAMLFoldingBuilder

public abstract class CustomFoldingBuilder
extends FoldingBuilderEx
implements PossiblyDumbAware

Builds custom folding regions. If custom folding is supported for a language, its FoldingBuilder must be inherited from this class.

Constructor Summary

Constructors

Constructor and Description
CustomFoldingBuilder()

Method Summary

Modifier and Type	Method and Description
FoldingDescriptor []	buildFoldRegions(ASTNode node, Document document) Builds the folding regions for the specified node in the AST tree and its children.
FoldingDescriptor []	buildFoldRegions(PsiElement root, Document document, boolean quick) Builds the folding regions for the specified node in the AST tree and its children.
protected abstract 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 abstract java.lang.String	getLanguagePlaceholderText(ASTNode node, TextRange range)
java.lang.String	getPlaceholderText(ASTNode node) Returns the text which is displayed in the editor for the folding region related to the specified node when the folding region is collapsed.
java.lang.String	getPlaceholderText(ASTNode node, TextRange range) Returns the text which is displayed in the editor for the folding region related to the specified node when the folding region is collapsed.
boolean	isCollapsedByDefault(ASTNode node) Returns the default collapsed state for the folding region related to the specified node.
protected boolean	isCustomFoldingCandidate(ASTNode node) Checks if a node may contain custom folding tags.
boolean	isCustomFoldingCandidate(PsiElement element)
protected boolean	isCustomFoldingRoot(ASTNode node) Checks if the node is used as custom folding root.
protected static boolean	isCustomRegionElement(PsiElement element)
protected boolean	isCustomRegionEnd(ASTNode node) Returns true if the node corresponds to custom region end.
boolean	isCustomRegionStart(ASTNode node) Returns true if the node corresponds to custom region start.
boolean	isDumbAware() Checks if the folding ranges can be created in the Dumb Mode.
protected abstract boolean	isRegionCollapsedByDefault(ASTNode node) Returns the default collapsed state for the folding region related to the specified node.

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

CustomFoldingBuilder

public CustomFoldingBuilder()

Method Detail

buildFoldRegions

public final FoldingDescriptor [] buildFoldRegions(PsiElement root,
                                                   Document document,
                                                   boolean quick)

Description copied from class: FoldingBuilderEx

Builds the folding regions for the specified node in the AST tree and its children.

Specified by:

buildFoldRegions in class FoldingBuilderEx

Parameters:

root - the element for which folding is requested.

document - the document for which folding is built. Can be used to retrieve line numbers for folding regions.

quick - whether the result should be provided as soon as possible. Is true, when an editor is opened and we need to auto-fold something immediately, like Java imports. If true, one should perform no reference resolving and avoid complex checks if possible.

Returns:

the array of folding descriptors.

buildFoldRegions

public final FoldingDescriptor [] buildFoldRegions(ASTNode node,
                                                   Document document)

Description copied from interface: FoldingBuilder

Builds the folding regions for the specified node in the AST tree and its children. Note that you can have several folding regions for one AST node, i.e. several FoldingDescriptor with similar AST node.

Specified by:

buildFoldRegions in interface FoldingBuilder

Overrides:

buildFoldRegions in class FoldingBuilderEx

Parameters:

node - the node for which folding is requested.

document - the document for which folding is built. Can be used to retrieve line numbers for folding regions.

Returns:

the array of folding descriptors.

buildLanguageFoldRegions

protected abstract 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.

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.

getPlaceholderText

public final java.lang.String getPlaceholderText(ASTNode node,
                                                 TextRange range)

Description copied from class: FoldingBuilderEx

Returns the text which is displayed in the editor for the folding region related to the specified node when the folding region is collapsed.

Overrides:

getPlaceholderText in class FoldingBuilderEx

Parameters:

node - the node for which the placeholder text is requested.

range - text range within whole file to fold

Returns:

the placeholder text.

getLanguagePlaceholderText

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

getPlaceholderText

public final java.lang.String getPlaceholderText(ASTNode node)

Description copied from interface: FoldingBuilder

Returns the text which is displayed in the editor for the folding region related to the specified node when the folding region is collapsed.

Specified by:

getPlaceholderText in interface FoldingBuilder

Parameters:

node - the node for which the placeholder text is requested.

Returns:

the placeholder text.

isCollapsedByDefault

public final boolean isCollapsedByDefault(ASTNode node)

Description copied from class: FoldingBuilderEx

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

Specified by:

isCollapsedByDefault in interface FoldingBuilder

Specified by:

isCollapsedByDefault in class FoldingBuilderEx

Parameters:

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

Returns:

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

isRegionCollapsedByDefault

protected abstract boolean isRegionCollapsedByDefault(ASTNode node)

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

Parameters:

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

Returns:

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

isCustomRegionStart

public final boolean isCustomRegionStart(ASTNode node)

Returns true if the node corresponds to custom region start. The node must be a custom folding candidate and match custom folding start pattern.

Parameters:

node - The node which may contain custom region start.

Returns:

True if the node marks a custom region start.

isCustomRegionEnd

protected final boolean isCustomRegionEnd(ASTNode node)

Returns true if the node corresponds to custom region end. The node must be a custom folding candidate and match custom folding end pattern.

Parameters:

node - The node which may contain custom region end

Returns:

True if the node marks a custom region end.

isCustomRegionElement

protected static boolean isCustomRegionElement(PsiElement element)

isCustomFoldingCandidate

protected boolean isCustomFoldingCandidate(ASTNode node)

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).

Parameters:

node - The node to check.

Returns:

True if the node may contain custom folding tags.

isCustomFoldingCandidate

public final boolean isCustomFoldingCandidate(PsiElement element)

isCustomFoldingRoot

protected boolean isCustomFoldingRoot(ASTNode node)

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).

Parameters:

node - The node to check.

Returns:

True if the node is a root for custom foldings.

isDumbAware

public boolean isDumbAware()

Checks if the folding ranges can be created in the Dumb Mode. In the most of language implementations the method returns true, but for strong context-dependent languages (like ObjC/C++) overridden method returns false.

Specified by:

isDumbAware in interface PossiblyDumbAware

Returns:

True if the folding ranges can be created in the Dumb Mode