Package com.intellij.lang.folding

Class CustomFoldingProvider

java.lang.Object

com.intellij.lang.folding.CustomFoldingProvider

Direct Known Subclasses:

NetBeansCustomFoldingProvider, VisualStudioCustomFoldingProvider

public abstract class CustomFoldingProvider
extends java.lang.Object

Base class and extension point for custom folding providers.

Field Summary

Fields

Modifier and Type	Field and Description
static ExtensionPointName<CustomFoldingProvider>	EP_NAME

Constructor Summary

Constructors

Constructor and Description
CustomFoldingProvider()

Method Summary

Modifier and Type	Method and Description
static java.util.List<CustomFoldingProvider>	getAllProviders()
abstract java.lang.String	getDescription()
abstract java.lang.String	getEndString() Called from new folding generation procedure.
abstract java.lang.String	getPlaceholderText(java.lang.String elementText)
abstract java.lang.String	getStartString() Called from new folding generation procedure.
boolean	isCollapsedByDefault(java.lang.String text)
abstract boolean	isCustomRegionEnd(java.lang.String elementText)
abstract boolean	isCustomRegionStart(java.lang.String elementText)
boolean	isSupportedBy(FoldingBuilder foldingBuilder)
boolean	wrapStartEndMarkerTextInLanguageSpecificComment() If the method returns `false`, the inheritance class need: 1.

Methods inherited from class java.lang.Object

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

Field Detail

EP_NAME

public static final ExtensionPointName<CustomFoldingProvider> EP_NAME

Constructor Detail

CustomFoldingProvider

public CustomFoldingProvider()

Method Detail

getAllProviders

public static java.util.List<CustomFoldingProvider> getAllProviders()

isCustomRegionStart

public abstract boolean isCustomRegionStart(java.lang.String elementText)

isCustomRegionEnd

public abstract boolean isCustomRegionEnd(java.lang.String elementText)

getPlaceholderText

public abstract java.lang.String getPlaceholderText(java.lang.String elementText)

getDescription

public abstract java.lang.String getDescription()

Returns:

A description string shown in "Surround With" action.

wrapStartEndMarkerTextInLanguageSpecificComment

public boolean wrapStartEndMarkerTextInLanguageSpecificComment()

If the method returns `false`, the inheritance class need: 1. override the method `isSupportedBy` and limit folding by a language-specific instantiation of `CustomFoldingBuilder` 2. the language-specific instantiation of `CustomFoldingBuilder` need to filter out language-specific AST nodes in the overridden `CustomFoldingBuilder#isCustomFoldingCandidate(ASTNode)`

Returns:

true, if you like to wrap `getStartString/getEndString` return values in language specific comment on folding generation

isSupportedBy

public boolean isSupportedBy(FoldingBuilder foldingBuilder)

Parameters:

foldingBuilder -

Returns:

true, if custom folding provider is supported

getStartString

public abstract java.lang.String getStartString()

Called from new folding generation procedure. Please, use tailing `?` as description placeholder if any.

Returns:

starting marker text without comment suffix/prefix if `wrapStartEndMarkerTextInLanguageSpecificComment` returns true. Else, full starting element text for non-comment bound element.

getEndString

public abstract java.lang.String getEndString()

Called from new folding generation procedure.

Returns:

ending marker text without comment suffix/prefix if `wrapStartEndMarkerTextInLanguageSpecificComment` returns true. Else, full ending element text for non-comment bound element.

isCollapsedByDefault

public boolean isCollapsedByDefault(java.lang.String text)