Package com.intellij.lang.folding

Class CompositeFoldingBuilder

java.lang.Object

com.intellij.lang.folding.FoldingBuilderEx

com.intellij.lang.folding.CompositeFoldingBuilder

All Implemented Interfaces:

FoldingBuilder, PossiblyDumbAware

public class CompositeFoldingBuilder
extends FoldingBuilderEx
implements PossiblyDumbAware

Used by LanguageFolding class if more than one FoldingBuilder were specified for a particular language.

See Also:

LanguageFolding

Method Summary

Modifier and Type	Method and Description
FoldingDescriptor []	buildFoldRegions(PsiElement root, Document document, boolean quick) Builds the folding regions for the specified node in the AST tree and its children.
static FoldingBuilder	getOriginalBuilder(FoldingDescriptor foldingDescriptor)
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.
boolean	isCollapsedByDefault(FoldingDescriptor foldingDescriptor)
boolean	isDumbAware()
java.lang.String	toString()

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

buildFoldRegions

Methods inherited from class java.lang.Object

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

Method Detail

buildFoldRegions

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

getPlaceholderText

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

getPlaceholderText

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

isCollapsedByDefault

public boolean isCollapsedByDefault(FoldingDescriptor foldingDescriptor)

Specified by:

isCollapsedByDefault in interface FoldingBuilder

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

isDumbAware

public boolean isDumbAware()

Specified by:

isDumbAware in interface PossiblyDumbAware

getOriginalBuilder

public static FoldingBuilder getOriginalBuilder(FoldingDescriptor foldingDescriptor)