Package com.intellij.lang.folding

Class FoldingDescriptor

java.lang.Object

com.intellij.lang.folding.FoldingDescriptor

Direct Known Subclasses:

NamedFoldingDescriptor

public class FoldingDescriptor
extends java.lang.Object

Defines a single folding region in the code.

Dependencies

Dependencies are objects (in particular, instances of ModificationTracker, more info - here), which can be tracked for changes, that should trigger folding regions recalculation for an editor (initiating code folding pass).

See Also:

FoldingBuilder

Field Summary

Fields

Modifier and Type	Field and Description
static FoldingDescriptor[]	EMPTY

Constructor Summary

Constructors

Constructor and Description
FoldingDescriptor(ASTNode node, TextRange range) Creates a folding region related to the specified AST node and covering the specified text range.
FoldingDescriptor(ASTNode node, TextRange range, FoldingGroup group) Creates a folding region related to the specified AST node and covering the specified text range.
FoldingDescriptor(ASTNode node, TextRange range, FoldingGroup group, java.util.Set<java.lang.Object> dependencies) Creates a folding region related to the specified AST node and covering the specified text range.
FoldingDescriptor(ASTNode node, TextRange range, FoldingGroup group, java.util.Set<java.lang.Object> dependencies, boolean neverExpands) Creates a folding region related to the specified AST node and covering the specified text range.
FoldingDescriptor(ASTNode node, TextRange range, FoldingGroup group, java.util.Set<java.lang.Object> dependencies, boolean neverExpands, java.lang.String placeholderText, java.lang.Boolean collapsedByDefault) Creates a folding region related to the specified AST node and covering the specified text range.
FoldingDescriptor(ASTNode node, TextRange range, FoldingGroup group, java.lang.String placeholderText) Creates a folding region related to the specified AST node and covering the specified text range.
FoldingDescriptor(ASTNode node, TextRange range, FoldingGroup group, java.lang.String placeholderText, java.lang.Boolean collapsedByDefault, java.util.Set<java.lang.Object> dependencies) Creates a folding region related to the specified AST node and covering the specified text range.
FoldingDescriptor(PsiElement e, int start, int end, FoldingGroup group, java.lang.String placeholderText) Creates a folding region related to the specified AST node and covering the specified text range.
FoldingDescriptor(PsiElement element, TextRange range)

Method Summary

Modifier and Type	Method and Description
boolean	canBeRemovedWhenCollapsed()
java.util.Set<java.lang.Object>	getDependencies()
ASTNode	getElement()
FoldingGroup	getGroup()
java.lang.String	getPlaceholderText()
TextRange	getRange() Returns the folded text range.
java.lang.Boolean	isCollapsedByDefault()
boolean	isGutterMarkEnabledForSingleLine()
boolean	isNonExpandable()
void	setCanBeRemovedWhenCollapsed(boolean canBeRemovedWhenCollapsed) By default, collapsed regions are not removed automatically, even if related PSI elements become invalid.
void	setGutterMarkEnabledForSingleLine(boolean value) See javadoc for FoldRegion.setGutterMarkEnabledForSingleLine(boolean).
void	setPlaceholderText(java.lang.String placeholderText)
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

EMPTY

public static final FoldingDescriptor[] EMPTY

Constructor Detail

FoldingDescriptor

public FoldingDescriptor(ASTNode node,
                         TextRange range)

Creates a folding region related to the specified AST node and covering the specified text range.

Parameters:

node - The node to which the folding region is related. The node is then passed to FoldingBuilder.getPlaceholderText(ASTNode) and FoldingBuilder.isCollapsedByDefault(ASTNode).

range - The folded text range in file

FoldingDescriptor

public FoldingDescriptor(PsiElement element,
                         TextRange range)

FoldingDescriptor

public FoldingDescriptor(ASTNode node,
                         TextRange range,
                         FoldingGroup group)

Creates a folding region related to the specified AST node and covering the specified text range.

Parameters:

node - The node to which the folding region is related. The node is then passed to FoldingBuilder.getPlaceholderText(ASTNode) and FoldingBuilder.isCollapsedByDefault(ASTNode).

range - The folded text range in file

group - Regions with the same group instance expand and collapse together.

FoldingDescriptor

public FoldingDescriptor(ASTNode node,
                         TextRange range,
                         FoldingGroup group,
                         java.util.Set<java.lang.Object> dependencies)

Creates a folding region related to the specified AST node and covering the specified text range.

Parameters:

node - The node to which the folding region is related. The node is then passed to FoldingBuilder.getPlaceholderText(ASTNode) and FoldingBuilder.isCollapsedByDefault(ASTNode).

range - The folded text range in file

group - Regions with the same group instance expand and collapse together.

dependencies - folding dependencies: other files or elements that could change folding description, see Dependencies

FoldingDescriptor

public FoldingDescriptor(ASTNode node,
                         TextRange range,
                         FoldingGroup group,
                         java.util.Set<java.lang.Object> dependencies,
                         boolean neverExpands)

Creates a folding region related to the specified AST node and covering the specified text range.

Parameters:

node - The node to which the folding region is related. The node is then passed to FoldingBuilder.getPlaceholderText(ASTNode) and FoldingBuilder.isCollapsedByDefault(ASTNode).

range - The folded text range in file

group - Regions with the same group instance expand and collapse together.

dependencies - folding dependencies: other files or elements that could change, see Dependencies

neverExpands - shall be true for fold regions that must not be ever expanded.

FoldingDescriptor

public FoldingDescriptor(PsiElement e,
                         int start,
                         int end,
                         FoldingGroup group,
                         java.lang.String placeholderText)

Creates a folding region related to the specified AST node and covering the specified text range.

Parameters:

e - PSI element to which the folding region is related.

start - Folded text range's start offset in file

end - Folded text range's end offset in file

group - Regions with the same group instance expand and collapse together.

placeholderText - Text displayed instead of folded text, when the region is collapsed

FoldingDescriptor

public FoldingDescriptor(ASTNode node,
                         TextRange range,
                         FoldingGroup group,
                         java.lang.String placeholderText)

Creates a folding region related to the specified AST node and covering the specified text range.

Parameters:

node - The node to which the folding region is related. The node is then passed to FoldingBuilder.isCollapsedByDefault(ASTNode).

range - The folded text range in file

group - Regions with the same group instance expand and collapse together.

placeholderText - Text displayed instead of folded text, when the region is collapsed

FoldingDescriptor

public FoldingDescriptor(ASTNode node,
                         TextRange range,
                         FoldingGroup group,
                         java.lang.String placeholderText,
                         java.lang.Boolean collapsedByDefault,
                         java.util.Set<java.lang.Object> dependencies)

Creates a folding region related to the specified AST node and covering the specified text range.

Parameters:

node - The node to which the folding region is related. The node is then passed to FoldingBuilder.isCollapsedByDefault(ASTNode).

range - The folded text range in file

group - Regions with the same group instance expand and collapse together.

placeholderText - Text displayed instead of folded text, when the region is collapsed

collapsedByDefault - Whether the region should be collapsed for newly opened files

dependencies - folding dependencies: other files or elements that could change, see Dependencies

FoldingDescriptor

public FoldingDescriptor(ASTNode node,
                         TextRange range,
                         FoldingGroup group,
                         java.util.Set<java.lang.Object> dependencies,
                         boolean neverExpands,
                         java.lang.String placeholderText,
                         java.lang.Boolean collapsedByDefault)

Creates a folding region related to the specified AST node and covering the specified text range.

Parameters:

node - The node to which the folding region is related. The node is then passed to FoldingBuilder.getPlaceholderText(ASTNode) and FoldingBuilder.isCollapsedByDefault(ASTNode).

range - The folded text range in file

group - Regions with the same group instance expand and collapse together.

dependencies - folding dependencies: other files or elements that could change, see Dependencies

neverExpands - shall be true for fold regions that must not be ever expanded.

placeholderText - Text displayed instead of folded text, when the region is collapsed

collapsedByDefault - Whether the region should be collapsed for newly opened files

Method Detail

getElement

public ASTNode getElement()

Returns:

the node to which the folding region is related.

getRange

public TextRange getRange()

Returns the folded text range.

Returns:

the folded text range.

getGroup

public FoldingGroup getGroup()

getPlaceholderText

public java.lang.String getPlaceholderText()

setPlaceholderText

public void setPlaceholderText(java.lang.String placeholderText)

getDependencies

public java.util.Set<java.lang.Object> getDependencies()

isNonExpandable

public boolean isNonExpandable()

canBeRemovedWhenCollapsed

public boolean canBeRemovedWhenCollapsed()

isCollapsedByDefault

public java.lang.Boolean isCollapsedByDefault()

setCanBeRemovedWhenCollapsed

public void setCanBeRemovedWhenCollapsed(boolean canBeRemovedWhenCollapsed)

By default, collapsed regions are not removed automatically, even if related PSI elements become invalid. This method allows to override default behaviour for specific regions.

isGutterMarkEnabledForSingleLine

public boolean isGutterMarkEnabledForSingleLine()

See Also:

setGutterMarkEnabledForSingleLine(boolean)

setGutterMarkEnabledForSingleLine

public void setGutterMarkEnabledForSingleLine(boolean value)

See javadoc for FoldRegion.setGutterMarkEnabledForSingleLine(boolean).

See Also:

isGutterMarkEnabledForSingleLine()

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object