Package com.intellij.lang

Class XmlCodeFoldingBuilder

java.lang.Object

com.intellij.lang.folding.FoldingBuilderEx

com.intellij.lang.folding.CustomFoldingBuilder

com.intellij.lang.XmlCodeFoldingBuilder

All Implemented Interfaces:

FoldingBuilder, DumbAware, PossiblyDumbAware

Direct Known Subclasses:

XmlFoldingBuilder

public abstract class XmlCodeFoldingBuilder
extends CustomFoldingBuilder
implements DumbAware

Constructor Summary

Constructors

Constructor and Description
XmlCodeFoldingBuilder()

Method Summary

Modifier and Type	Method and Description
protected void	addElementsToFold(java.util.List<FoldingDescriptor> foldings, XmlElement tag, Document document)
protected boolean	addToFold(java.util.List<? super FoldingDescriptor> foldings, PsiElement elementToFold, Document document)
void	buildLanguageFoldRegions(java.util.List<FoldingDescriptor> foldings, PsiElement psiElement, Document document, boolean quick) Implement this method to build language folding regions besides custom folding regions.
protected void	doAddForChildren(XmlElement tag, java.util.List<FoldingDescriptor> foldings, Document document)
protected int	getCommentStartEnd(XmlComment element)
protected int	getCommentStartOffset(XmlComment element)
static java.lang.String	getEntityPlaceholder(PsiElement psi)
static java.lang.String	getEntityValue(java.lang.String value)
protected abstract XmlCodeFoldingSettings	getFoldingSettings()
java.lang.String	getLanguagePlaceholderText(ASTNode node, TextRange range)
TextRange	getRangeToFold(PsiElement element)
protected boolean	isCustomFoldingCandidate(ASTNode node) Checks if a node may contain custom folding tags.
protected boolean	isCustomFoldingRoot(ASTNode node) Checks if the node is used as custom folding root.
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, 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

XmlCodeFoldingBuilder

public XmlCodeFoldingBuilder()

Method Detail

buildLanguageFoldRegions

public void buildLanguageFoldRegions(java.util.List<FoldingDescriptor> foldings,
                                     PsiElement psiElement,
                                     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:

foldings - The list of folding descriptors to store results to.

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

addElementsToFold

protected void addElementsToFold(java.util.List<FoldingDescriptor> foldings,
                                 XmlElement tag,
                                 Document document)

doAddForChildren

protected void doAddForChildren(XmlElement tag,
                                java.util.List<FoldingDescriptor> foldings,
                                Document document)

getRangeToFold

public TextRange getRangeToFold(PsiElement element)

getCommentStartOffset

protected int getCommentStartOffset(XmlComment element)

getCommentStartEnd

protected int getCommentStartEnd(XmlComment element)

addToFold

protected boolean addToFold(java.util.List<? super FoldingDescriptor> foldings,
                            PsiElement elementToFold,
                            Document document)

getLanguagePlaceholderText

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

Specified by:

getLanguagePlaceholderText in class CustomFoldingBuilder

getEntityPlaceholder

public static java.lang.String getEntityPlaceholder(PsiElement psi)

getEntityValue

public static java.lang.String getEntityValue(java.lang.String value)

isRegionCollapsedByDefault

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

getFoldingSettings

protected abstract XmlCodeFoldingSettings getFoldingSettings()

isCustomFoldingRoot

protected boolean isCustomFoldingRoot(ASTNode node)

Description copied from class: CustomFoldingBuilder

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

Overrides:

isCustomFoldingRoot in class CustomFoldingBuilder

Parameters:

node - The node to check.

Returns:

True if the node is a root for custom foldings.

isCustomFoldingCandidate

protected boolean isCustomFoldingCandidate(ASTNode node)

Description copied from class: CustomFoldingBuilder

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

Overrides:

isCustomFoldingCandidate in class CustomFoldingBuilder

Parameters:

node - The node to check.

Returns:

True if the node may contain custom folding tags.