Package com.intellij.ide.highlighter.custom.impl

Class CustomFileTypeFoldingBuilder

java.lang.Object

com.intellij.lang.folding.FoldingBuilderEx

com.intellij.lang.folding.CustomFoldingBuilder

com.intellij.ide.highlighter.custom.impl.CustomFileTypeFoldingBuilder

All Implemented Interfaces:

FoldingBuilder, PossiblyDumbAware

public class CustomFileTypeFoldingBuilder
extends CustomFoldingBuilder

Constructor Summary

Constructors

Constructor and Description
CustomFileTypeFoldingBuilder()

Method Summary

Modifier and Type	Method and Description
static void	buildBraceMatcherBasedFolding(java.util.List<? super FoldingDescriptor> descriptors, PsiElement root, Document document, SyntaxHighlighter highlighter)
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)
protected boolean	isRegionCollapsedByDefault(ASTNode node) Returns the default collapsed state for the folding region related to the specified node.

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

buildFoldRegions, buildFoldRegions, getPlaceholderText, getPlaceholderText, isCollapsedByDefault, isCustomFoldingCandidate, isCustomFoldingCandidate, isCustomFoldingRoot, 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

CustomFileTypeFoldingBuilder

public CustomFileTypeFoldingBuilder()

Method Detail

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.

buildBraceMatcherBasedFolding

public static void buildBraceMatcherBasedFolding(java.util.List<? super FoldingDescriptor> descriptors,
                                                 PsiElement root,
                                                 Document document,
                                                 SyntaxHighlighter highlighter)

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.