Package com.intellij.codeInsight.folding.impl.actions

Class BaseFoldingHandler

java.lang.Object

com.intellij.openapi.editor.actionSystem.EditorActionHandler

com.intellij.codeInsight.folding.impl.actions.BaseFoldingHandler

public abstract class BaseFoldingHandler
extends EditorActionHandler

Constructor Summary

Constructors

Constructor and Description
BaseFoldingHandler()

Method Summary

Modifier and Type	Method and Description
protected java.util.List<FoldRegion>	getFoldRegionsForCaret(Editor editor, Caret caret, boolean toCollapse) Returns a region corresponding to current caret position, and all regions contained in it.
protected java.util.List<FoldRegion>	getFoldRegionsForSelection(Editor editor, Caret caret) Returns fold regions inside selection, or all regions in editor, if selection doesn't exist or doesn't contain fold regions.
protected boolean	isEnabledForCaret(Editor editor, Caret caret, DataContext dataContext) Implementations can override this method to define whether handler is enabled for a specific caret in a given editor.

Methods inherited from class com.intellij.openapi.editor.actionSystem.EditorActionHandler

doExecute, execute, execute, executeInCommand, getCommandGroupId, isEnabled, isEnabled, runForAllCarets

Methods inherited from class java.lang.Object

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

Constructor Detail

BaseFoldingHandler

public BaseFoldingHandler()

Method Detail

isEnabledForCaret

protected boolean isEnabledForCaret(Editor editor,
                                    Caret caret,
                                    DataContext dataContext)

Description copied from class: EditorActionHandler

Implementations can override this method to define whether handler is enabled for a specific caret in a given editor.

Overrides:

isEnabledForCaret in class EditorActionHandler

getFoldRegionsForSelection

protected java.util.List<FoldRegion> getFoldRegionsForSelection(Editor editor,
                                                                Caret caret)

Returns fold regions inside selection, or all regions in editor, if selection doesn't exist or doesn't contain fold regions.

getFoldRegionsForCaret

protected java.util.List<FoldRegion> getFoldRegionsForCaret(Editor editor,
                                                            Caret caret,
                                                            boolean toCollapse)

Returns a region corresponding to current caret position, and all regions contained in it.