Package com.intellij.openapi.editor.impl

Class FoldingModelImpl

java.lang.Object

com.intellij.openapi.editor.InlayModel.SimpleAdapter

com.intellij.openapi.editor.impl.FoldingModelImpl

All Implemented Interfaces:

Dumpable, DocumentListener, FoldingModelEx, PrioritizedDocumentListener, FoldingModel, InlayModel.Listener, ModificationTracker, java.util.EventListener

public class FoldingModelImpl
extends InlayModel.SimpleAdapter
implements FoldingModelEx, PrioritizedDocumentListener, Dumpable, ModificationTracker

Field Summary

Fields

Modifier and Type	Field and Description
static Key<java.lang.Boolean>	SELECT_REGION_ON_CARET_NEARBY

Fields inherited from interface com.intellij.openapi.editor.ex.PrioritizedDocumentListener

COMPARATOR

Fields inherited from interface com.intellij.openapi.editor.event.DocumentListener

ARRAY_FACTORY, EMPTY_ARRAY

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

EVER_CHANGED, NEVER_CHANGED

Method Summary

Modifier and Type	Method and Description
FoldRegion	addFoldRegion(int startOffset, int endOffset, java.lang.String placeholderText) Adds a fold region for the specified range of the document.
void	addListener(FoldingListener listener, Disposable parentDisposable)
void	beforeDocumentChange(DocumentEvent event) Called before the text of the document is changed.
void	clearDocumentRangesModificationStatus()
void	clearFoldRegions()
FoldRegion	createFoldRegion(int startOffset, int endOffset, java.lang.String placeholder, FoldingGroup group, boolean neverExpands)
void	documentChanged(DocumentEvent event) Called after the text of the document has been changed.
java.lang.String	dumpState()
FoldRegion []	fetchTopLevel()
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.
int	getEndOffset(FoldingGroup group)
int	getFoldedLinesCountBefore(int offset)
FoldRegion	getFoldingPlaceholderAt(java.awt.Point p)
FoldRegion	getFoldRegion(int startOffset, int endOffset) Returns fold region with given boundaries, if it exists, or null otherwise.
java.util.List<FoldRegion>	getGroupedRegions(FoldingGroup group)
int	getLastCollapsedRegionBefore(int offset) Returns an index in an array returned by FoldingModelEx.fetchTopLevel() method, for the last folding region lying entirely before given offset (region can touch given offset at its right edge).
long	getModificationCount()
TextAttributes	getPlaceholderAttributes()
int	getPriority()
boolean	hasDocumentRegionChangedFor(FoldRegion region)
boolean	intersectsRegion(int startOffset, int endOffset)
boolean	isFoldingEnabled()
boolean	isInBatchFoldingOperation()
boolean	isOffsetCollapsed(int offset) Checks if the specified offset in the document belongs to a folded region.
void	onUpdated(Inlay inlay, int changeFlags)
void	rebuild()
void	removeFoldRegion(FoldRegion region) Removes the specified fold region.
void	runBatchFoldingOperation(java.lang.Runnable operation, boolean moveCaret)
void	runBatchFoldingOperation(java.lang.Runnable operation, boolean allowMovingCaret, boolean keepRelativeCaretPosition) Performs folding model changes (creation/deletion/expanding/collapsing of fold regions).
void	setFoldingEnabled(boolean isEnabled)
java.lang.String	toString()

Methods inherited from class com.intellij.openapi.editor.InlayModel.SimpleAdapter

onAdded, onRemoved

Methods inherited from class java.lang.Object

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

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

addFoldRegion, runBatchFoldingOperation, runBatchFoldingOperationDoNotCollapseCaret

Methods inherited from interface com.intellij.openapi.editor.event.DocumentListener

bulkUpdateFinished, bulkUpdateStarting

Methods inherited from interface com.intellij.openapi.editor.InlayModel.Listener

onBatchModeFinish, onBatchModeStart, onUpdated

Field Detail

SELECT_REGION_ON_CARET_NEARBY

public static final Key<java.lang.Boolean> SELECT_REGION_ON_CARET_NEARBY

Method Detail

getGroupedRegions

public java.util.List<FoldRegion> getGroupedRegions(FoldingGroup group)

Specified by:

getGroupedRegions in interface FoldingModelEx

clearDocumentRangesModificationStatus

public void clearDocumentRangesModificationStatus()

Specified by:

clearDocumentRangesModificationStatus in interface FoldingModelEx

hasDocumentRegionChangedFor

public boolean hasDocumentRegionChangedFor(FoldRegion region)

Specified by:

hasDocumentRegionChangedFor in interface FoldingModelEx

getEndOffset

public int getEndOffset(FoldingGroup group)

isFoldingEnabled

public boolean isFoldingEnabled()

Specified by:

isFoldingEnabled in interface FoldingModelEx

isOffsetCollapsed

public boolean isOffsetCollapsed(int offset)

Description copied from interface: FoldingModel

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 FoldingModel.runBatchFoldingOperation(Runnable) invocation.

Specified by:

isOffsetCollapsed in interface FoldingModel

Parameters:

offset - the offset to check.

Returns:

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

See Also:

FoldingModel.getCollapsedRegionAtOffset(int)

setFoldingEnabled

public void setFoldingEnabled(boolean isEnabled)

Specified by:

setFoldingEnabled in interface FoldingModelEx

addFoldRegion

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

Description copied from interface: FoldingModel

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

Specified by:

addFoldRegion in interface FoldingModel

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)

runBatchFoldingOperation

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

Description copied from interface: FoldingModel

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

Specified by:

runBatchFoldingOperation in interface FoldingModel

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.

runBatchFoldingOperation

public void runBatchFoldingOperation(java.lang.Runnable operation,
                                     boolean moveCaret)

Specified by:

runBatchFoldingOperation in interface FoldingModel

getAllFoldRegions

public FoldRegion [] getAllFoldRegions()

Description copied from interface: FoldingModel

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.

Specified by:

getAllFoldRegions in interface FoldingModel

Returns:

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

getCollapsedRegionAtOffset

public FoldRegion getCollapsedRegionAtOffset(int offset)

Description copied from interface: FoldingModel

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 FoldingModel.runBatchFoldingOperation(Runnable) invocation.

Specified by:

getCollapsedRegionAtOffset in interface FoldingModel

See Also:

FoldingModel.isOffsetCollapsed(int)

getFoldRegion

public FoldRegion getFoldRegion(int startOffset,
                                int endOffset)

Description copied from interface: FoldingModel

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

Specified by:

getFoldRegion in interface FoldingModel

getFoldingPlaceholderAt

public FoldRegion getFoldingPlaceholderAt(java.awt.Point p)

Specified by:

getFoldingPlaceholderAt in interface FoldingModelEx

removeFoldRegion

public void removeFoldRegion(FoldRegion region)

Description copied from interface: FoldingModel

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

Specified by:

removeFoldRegion in interface FoldingModel

Parameters:

region - the region to remove.

clearFoldRegions

public void clearFoldRegions()

Specified by:

clearFoldRegions in interface FoldingModelEx

rebuild

public void rebuild()

Specified by:

rebuild in interface FoldingModelEx

isInBatchFoldingOperation

public boolean isInBatchFoldingOperation()

getFoldedLinesCountBefore

public int getFoldedLinesCountBefore(int offset)

fetchTopLevel

public FoldRegion [] fetchTopLevel()

Specified by:

fetchTopLevel in interface FoldingModelEx

intersectsRegion

public boolean intersectsRegion(int startOffset,
                                int endOffset)

Specified by:

intersectsRegion in interface FoldingModelEx

getLastCollapsedRegionBefore

public int getLastCollapsedRegionBefore(int offset)

Description copied from interface: FoldingModelEx

Returns an index in an array returned by FoldingModelEx.fetchTopLevel() method, for the last folding region lying entirely before given offset (region can touch given offset at its right edge).

Specified by:

getLastCollapsedRegionBefore in interface FoldingModelEx

getPlaceholderAttributes

public TextAttributes getPlaceholderAttributes()

Specified by:

getPlaceholderAttributes in interface FoldingModelEx

beforeDocumentChange

public void beforeDocumentChange(DocumentEvent event)

Description copied from interface: DocumentListener

Called before the text of the document is changed.

Specified by:

beforeDocumentChange in interface DocumentListener

Parameters:

event - the event containing the information about the change.

documentChanged

public void documentChanged(DocumentEvent event)

Description copied from interface: DocumentListener

Called after the text of the document has been changed.

Specified by:

documentChanged in interface DocumentListener

Parameters:

event - the event containing the information about the change.

getPriority

public int getPriority()

Specified by:

getPriority in interface PrioritizedDocumentListener

onUpdated

public void onUpdated(Inlay inlay,
                      int changeFlags)

Specified by:

onUpdated in interface InlayModel.Listener

changeFlags - see InlayModel.ChangeFlags

createFoldRegion

public FoldRegion createFoldRegion(int startOffset,
                                   int endOffset,
                                   java.lang.String placeholder,
                                   FoldingGroup group,
                                   boolean neverExpands)

Specified by:

createFoldRegion in interface FoldingModelEx

neverExpands - If true, the created region is created in the collapsed state, and cannot be expanded (FoldRegion.setExpanded(boolean) does nothing for it). No marker will be displayed in gutter for such a region. 'Never-expanding' fold region cannot be part of a FoldingGroup.

addListener

public void addListener(FoldingListener listener,
                        Disposable parentDisposable)

Specified by:

addListener in interface FoldingModelEx

dumpState

public java.lang.String dumpState()

Specified by:

dumpState in interface Dumpable

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getModificationCount

public long getModificationCount()

Specified by:

getModificationCount in interface ModificationTracker