Package com.intellij.codeInsight.folding.impl

Class CollapseExpandDocCommentsHandler

java.lang.Object

com.intellij.codeInsight.folding.impl.CollapseExpandDocCommentsHandler

All Implemented Interfaces:

CodeInsightActionHandler, FileModifier, WriteActionAware

public class CollapseExpandDocCommentsHandler
extends java.lang.Object
implements CodeInsightActionHandler

Constructor Summary

Constructors

Constructor and Description
CollapseExpandDocCommentsHandler(boolean isExpand)

Method Summary

Modifier and Type	Method and Description
PsiElement	getElementToMakeWritable(PsiFile currentFile) Controls whether this intention/fix is going to modify the current file.
void	invoke(Project project, Editor editor, PsiFile file)
static void	setDocCommentMark(FoldRegion region, boolean value)

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.intellij.openapi.application.WriteActionAware

startInWriteAction

Constructor Detail

CollapseExpandDocCommentsHandler

public CollapseExpandDocCommentsHandler(boolean isExpand)

Method Detail

setDocCommentMark

public static void setDocCommentMark(FoldRegion region,
                                     boolean value)

invoke

public void invoke(Project project,
                   Editor editor,
                   PsiFile file)

Specified by:

invoke in interface CodeInsightActionHandler

getElementToMakeWritable

public PsiElement getElementToMakeWritable(PsiFile currentFile)

Description copied from interface: FileModifier

Controls whether this intention/fix is going to modify the current file. If @NotNull, and the current file is read-only, it will be made writable (honoring version control integration) before the intention/fix is invoked.

By default, as a heuristic, returns the same as WriteActionAware.startInWriteAction().

If the action is going to modify multiple files, or the set of the files is unknown in advance, please don't bother overriding this method, return false from WriteActionAware.startInWriteAction(), and call FileModificationService methods in the implementation, and take write actions yourself as needed.

Specified by:

getElementToMakeWritable in interface FileModifier

Parameters:

currentFile - the same file where intention would be invoked (for LocalQuickFix it would be the containing file of ProblemDescriptor.getPsiElement())