Package com.intellij.openapi.editor

Interface FoldRegion

All Superinterfaces:

RangeMarker, Segment, UserDataHolder

All Known Implementing Classes:

FoldingRegionWindow, FoldRegionImpl

public interface FoldRegion
extends RangeMarker

Represents a region of text in the editor which can be folded.

See Also:

FoldingModel.addFoldRegion(int, int, String), FoldingModel.getAllFoldRegions()

Field Summary

Fields

Modifier and Type	Field and Description
static FoldRegion[]	EMPTY_ARRAY

Fields inherited from interface com.intellij.openapi.editor.RangeMarker

BY_START_OFFSET

Fields inherited from interface com.intellij.openapi.util.Segment

BY_START_OFFSET_THEN_END_OFFSET

Method Summary

Modifier and Type	Method and Description
default boolean	areInnerHighlightersMuted()
Editor	getEditor()
FoldingGroup	getGroup()
java.lang.String	getPlaceholderText() Returns the placeholder text displayed when the fold region is collapsed.
boolean	isExpanded() Checks if the fold region is currently expanded.
default boolean	isGutterMarkEnabledForSingleLine()
void	setExpanded(boolean expanded) Expands or collapses the fold region.
default void	setGutterMarkEnabledForSingleLine(boolean value) By default, gutter mark (for collapsing/expanding the region using mouse) is not shown for a folding region, if it's contained within a single document line.
default void	setInnerHighlightersMuted(boolean value) If inner highlighters are muted for a collapsed fold region, there will be no visual indication that region contains certain highlighters inside.
default void	setPlaceholderText(java.lang.String text) Updates region's placeholder text.
boolean	shouldNeverExpand() If true, this region is always in a collapsed state, setExpanded(boolean) does nothing for it.

Methods inherited from interface com.intellij.openapi.editor.RangeMarker

dispose, getDocument, getEndOffset, getStartOffset, isGreedyToLeft, isGreedyToRight, isValid, setGreedyToLeft, setGreedyToRight

Methods inherited from interface com.intellij.openapi.util.UserDataHolder

getUserData, putUserData

Field Detail

EMPTY_ARRAY

static final FoldRegion[] EMPTY_ARRAY

Method Detail

isExpanded

boolean isExpanded()

Checks if the fold region is currently expanded.

Returns:

true if the fold region is expanded, false otherwise.

setExpanded

void setExpanded(boolean expanded)

Expands or collapses the fold region.

Parameters:

expanded - true if the region should be expanded, false otherwise.

getPlaceholderText

java.lang.String getPlaceholderText()

Returns the placeholder text displayed when the fold region is collapsed.

Returns:

the placeholder text.

getEditor

Editor getEditor()

getGroup

FoldingGroup getGroup()

shouldNeverExpand

boolean shouldNeverExpand()

If true, this region is always in a collapsed state, setExpanded(boolean) does nothing for it. No marker is displayed in gutter for such a region.

See Also:

FoldingModelEx.createFoldRegion(int, int, String, FoldingGroup, boolean)

setInnerHighlightersMuted

default void setInnerHighlightersMuted(boolean value)

If inner highlighters are muted for a collapsed fold region, there will be no visual indication that region contains certain highlighters inside. By default such indication is added.

See Also:

RangeHighlighterEx.isVisibleIfFolded()

areInnerHighlightersMuted

default boolean areInnerHighlightersMuted()

See Also:

setInnerHighlightersMuted(boolean)

setGutterMarkEnabledForSingleLine

default void setGutterMarkEnabledForSingleLine(boolean value)

By default, gutter mark (for collapsing/expanding the region using mouse) is not shown for a folding region, if it's contained within a single document line. This method allows to change this behaviour for given fold region.

See Also:

isGutterMarkEnabledForSingleLine(), EditorSettings.setAllowSingleLogicalLineFolding(boolean)

isGutterMarkEnabledForSingleLine

default boolean isGutterMarkEnabledForSingleLine()

See Also:

setGutterMarkEnabledForSingleLine(boolean)

setPlaceholderText

default void setPlaceholderText(java.lang.String text)

Updates region's placeholder text. Should be called inside FoldingModel.runBatchFoldingOperation(Runnable), like any other operations with fold regions.