Package com.intellij.lang.folding

Interface FoldingBuilder

All Known Implementing Classes:

CompositeFoldingBuilder, CustomFileTypeFoldingBuilder, CustomFoldingBuilder, FoldingBuilderEx, GeneratedCodeFoldingBuilder, GroovyFoldingBuilder, IndentationFoldingBuilder, JavaFoldingBuilder, JavaFoldingBuilderBase, JsonFoldingBuilder, MarkdownFoldingBuilder, PropertiesFoldingBuilder, PropertyFoldingBuilder, PythonFoldingBuilder, RncFoldingBuilder, SuppressWarningsFoldingBuilder, XmlCodeFoldingBuilder, XmlFoldingBuilder, YAMLFoldingBuilder

public interface FoldingBuilder

Allows a custom language plugin to define rules for folding code in the language handled by the plugin.

See Also:

LanguageFolding.forLanguage(Language)

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.
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.
boolean	isCollapsedByDefault(ASTNode node) Returns the default collapsed state for the folding region related to the specified node.
default boolean	isCollapsedByDefault(FoldingDescriptor foldingDescriptor)

Method Detail

buildFoldRegions

FoldingDescriptor [] buildFoldRegions(ASTNode node,
                                      Document document)

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.

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.

getPlaceholderText

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.

Parameters:

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

Returns:

the placeholder text.

isCollapsedByDefault

boolean isCollapsedByDefault(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.

isCollapsedByDefault

default boolean isCollapsedByDefault(FoldingDescriptor foldingDescriptor)