com.intellij.openapi.editor
Interface FoldRegion

All Superinterfaces:

RangeMarker, UserDataHolder

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

Method Summary

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.
void	setExpanded(boolean expanded) Expands or collapses the fold region.

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

getDocument, getEndOffset, getStartOffset, isValid, setGreedyToLeft, setGreedyToRight

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

getUserData, putUserData

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

@NotNull
java.lang.String getPlaceholderText()

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

Returns:

the placeholder text.