Package com.intellij.openapi.editor

Interface FoldingModel

All Known Subinterfaces:

FoldingModelEx

All Known Implementing Classes:

FoldingModelImpl

public interface FoldingModel

Provides services for controlling and getting information about folded regions in the editor.

See Also:

Editor.getFoldingModel()

Method Summary

Modifier and Type	Method and Description
default boolean	addFoldRegion(FoldRegion region) Deprecated. Does nothing
FoldRegion	addFoldRegion(int startOffset, int endOffset, java.lang.String placeholderText) Adds a fold region for the specified range of the document.
FoldRegion []	getAllFoldRegions() Gets the list of all fold regions in the specified editor.
FoldRegion	getCollapsedRegionAtOffset(int offset) Returns collapsed folded region at a given offset or null if there's no such region.
FoldRegion	getFoldRegion(int startOffset, int endOffset) Returns fold region with given boundaries, if it exists, or null otherwise.
boolean	isOffsetCollapsed(int offset) Checks if the specified offset in the document belongs to a folded region.
void	removeFoldRegion(FoldRegion region) Removes the specified fold region.
default void	runBatchFoldingOperation(java.lang.Runnable operation) Runs an operation which is allowed to modify fold regions in the editor by calling addFoldRegion(int, int, String) and removeFoldRegion(FoldRegion).
void	runBatchFoldingOperation(java.lang.Runnable operation, boolean moveCaretFromCollapsedRegion) Deprecated. Passing false for moveCaretFromCollapsedRegion might leave caret in an inconsistent state after the operation. Use runBatchFoldingOperation(Runnable) instead.
void	runBatchFoldingOperation(java.lang.Runnable operation, boolean allowMovingCaret, boolean keepRelativeCaretPosition) Performs folding model changes (creation/deletion/expanding/collapsing of fold regions).
default void	runBatchFoldingOperationDoNotCollapseCaret(java.lang.Runnable operation)

Method Detail

addFoldRegion

FoldRegion addFoldRegion(int startOffset,
                         int endOffset,
                         java.lang.String placeholderText)

Adds a fold region for the specified range of the document. This method must be called from the Runnable passed to runBatchFoldingOperation(Runnable). The region is initially not folded.

Parameters:

startOffset - the start offset of the region to fold.

endOffset - the end offset of the region to fold.

placeholderText - the text to display instead of the region contents when the region is folded.

Returns:

the fold region, or null if folding is currently disabled or corresponding region cannot be added (e.g. if it intersects with another existing region)

addFoldRegion

@Deprecated
default boolean addFoldRegion(FoldRegion region)

Deprecated. Does nothing

removeFoldRegion

void removeFoldRegion(FoldRegion region)

Removes the specified fold region. This method must be called from the Runnable passed to runBatchFoldingOperation(Runnable).

Parameters:

region - the region to remove.

getAllFoldRegions

FoldRegion [] getAllFoldRegions()

Gets the list of all fold regions in the specified editor. Returned array is sorted according to RangeMarker.BY_START_OFFSET comparator, i.e. first by start offset, then by end offset.

Returns:

the array of fold regions, or an empty array if folding is currently disabled.

isOffsetCollapsed

boolean isOffsetCollapsed(int offset)

Checks if the specified offset in the document belongs to a folded region. The region must contain given offset or be located right after given offset, i.e. the following condition must hold: foldStartOffset <= offset < foldEndOffset.
This method can return incorrect data if it's invoked in the context of runBatchFoldingOperation(Runnable) invocation.

Parameters:

offset - the offset to check.

Returns:

true if the offset belongs to a folded region, false otherwise.

See Also:

getCollapsedRegionAtOffset(int)

getCollapsedRegionAtOffset

FoldRegion getCollapsedRegionAtOffset(int offset)

Returns collapsed folded region at a given offset or null if there's no such region. Returned region will satisfy the following condition: region.getStartOffset() <= offset < region.getEndOffset()
This method can return incorrect data if it's invoked in the context of runBatchFoldingOperation(Runnable) invocation.

See Also:

isOffsetCollapsed(int)

getFoldRegion

FoldRegion getFoldRegion(int startOffset,
                         int endOffset)

Returns fold region with given boundaries, if it exists, or null otherwise.

runBatchFoldingOperation

default void runBatchFoldingOperation(java.lang.Runnable operation)

Runs an operation which is allowed to modify fold regions in the editor by calling addFoldRegion(int, int, String) and removeFoldRegion(FoldRegion).

Parameters:

operation - the operation to execute.

runBatchFoldingOperation

@Deprecated
void runBatchFoldingOperation(java.lang.Runnable operation,
                              boolean moveCaretFromCollapsedRegion)

Deprecated. Passing false for moveCaretFromCollapsedRegion might leave caret in an inconsistent state after the operation. Use runBatchFoldingOperation(Runnable) instead.

runBatchFoldingOperationDoNotCollapseCaret

default void runBatchFoldingOperationDoNotCollapseCaret(java.lang.Runnable operation)

runBatchFoldingOperation

void runBatchFoldingOperation(java.lang.Runnable operation,
                              boolean allowMovingCaret,
                              boolean keepRelativeCaretPosition)

Performs folding model changes (creation/deletion/expanding/collapsing of fold regions).

Parameters:

allowMovingCaret - If false, requests to collapse a region containing caret won't be processed. If true - corresponding operation will be performed with caret automatically moved to the region's start offset (original caret position is remembered and is restored on region expansion).

keepRelativeCaretPosition - If true, editor scrolling position will be adjusted after the operation, so that vertical caret position will remain unchanged (if caret is not visible at operation start, top left corner of editor will be used as an anchor instead). If false, no scrolling adjustment will be done.