Package com.intellij.codeInsight.folding

Class CodeFoldingManager

java.lang.Object

com.intellij.codeInsight.folding.CodeFoldingManager

Direct Known Subclasses:

CodeFoldingManagerImpl

public abstract class CodeFoldingManager
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
CodeFoldingManager()

Method Summary

Modifier and Type	Method and Description
abstract CodeFoldingState	buildInitialFoldings(Document document)
abstract void	buildInitialFoldings(Editor editor)
abstract FoldRegion	findFoldRegion(Editor editor, int startOffset, int endOffset)
abstract FoldRegion[]	getFoldRegionsAtOffset(Editor editor, int offset)
static CodeFoldingManager	getInstance(Project project)
abstract java.lang.Boolean	isCollapsedByDefault(FoldRegion region) For auto-generated regions (created by FoldingBuilders), returns their 'collapsed by default' status, for other regions returns null.
abstract CodeFoldingState	readFoldingState(Element element, Document document)
abstract void	releaseFoldings(Editor editor)
abstract void	restoreFoldingState(Editor editor, CodeFoldingState state)
abstract CodeFoldingState	saveFoldingState(Editor editor)
abstract void	scheduleAsyncFoldingUpdate(Editor editor) Schedules recalculation of foldings in editor (CodeFoldingPass), which will happen even if document (and other dependencies declared by FoldingBuilder) haven't changed.
abstract void	updateFoldRegions(Editor editor)
abstract java.lang.Runnable	updateFoldRegionsAsync(Editor editor, boolean firstTime)
abstract void	writeFoldingState(CodeFoldingState state, Element element)

Methods inherited from class java.lang.Object

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

Constructor Detail

CodeFoldingManager

public CodeFoldingManager()

Method Detail

getInstance

public static CodeFoldingManager getInstance(Project project)

updateFoldRegions

public abstract void updateFoldRegions(Editor editor)

updateFoldRegionsAsync

public abstract java.lang.Runnable updateFoldRegionsAsync(Editor editor,
                                                          boolean firstTime)

findFoldRegion

public abstract FoldRegion findFoldRegion(Editor editor,
                                          int startOffset,
                                          int endOffset)

getFoldRegionsAtOffset

public abstract FoldRegion[] getFoldRegionsAtOffset(Editor editor,
                                                    int offset)

saveFoldingState

public abstract CodeFoldingState saveFoldingState(Editor editor)

restoreFoldingState

public abstract void restoreFoldingState(Editor editor,
                                         CodeFoldingState state)

writeFoldingState

public abstract void writeFoldingState(CodeFoldingState state,
                                       Element element)

readFoldingState

public abstract CodeFoldingState readFoldingState(Element element,
                                                  Document document)

releaseFoldings

public abstract void releaseFoldings(Editor editor)

buildInitialFoldings

public abstract void buildInitialFoldings(Editor editor)

buildInitialFoldings

public abstract CodeFoldingState buildInitialFoldings(Document document)

isCollapsedByDefault

public abstract java.lang.Boolean isCollapsedByDefault(FoldRegion region)

For auto-generated regions (created by FoldingBuilders), returns their 'collapsed by default' status, for other regions returns null.

scheduleAsyncFoldingUpdate

public abstract void scheduleAsyncFoldingUpdate(Editor editor)

Schedules recalculation of foldings in editor (CodeFoldingPass), which will happen even if document (and other dependencies declared by FoldingBuilder) haven't changed.