Package com.intellij.codeInsight.generation

Class CommentByLineCommentHandler

java.lang.Object

com.intellij.codeInsight.actions.MultiCaretCodeInsightActionHandler

com.intellij.codeInsight.generation.CommentByLineCommentHandler

public class CommentByLineCommentHandler
extends MultiCaretCodeInsightActionHandler

Constructor Summary

Constructors

Constructor and Description
CommentByLineCommentHandler()

Method Summary

Modifier and Type	Method and Description
void	doDefaultCommenting(com.intellij.codeInsight.generation.CommentByLineCommentHandler.Block block)
void	invoke(Project project, Editor editor, Caret caret, PsiFile file) Invoked for each caret in editor (in top-to-bottom order).
static void	markInjectedFileUnsuitableForLineComment(PsiFile file) Disable line commenting in an injected file making this action operate on its host file instead.
void	postInvoke() Invoked after processing all carets.

Methods inherited from class java.lang.Object

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

Constructor Detail

CommentByLineCommentHandler

public CommentByLineCommentHandler()

Method Detail

markInjectedFileUnsuitableForLineComment

public static void markInjectedFileUnsuitableForLineComment(PsiFile file)

Disable line commenting in an injected file making this action operate on its host file instead.

Parameters:

file - injected file where line comment action shouldn't be available

invoke

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

Description copied from class: MultiCaretCodeInsightActionHandler

Invoked for each caret in editor (in top-to-bottom order). project value is the same for all carets, editor and file values can be different in presence of multi-root PSI and injected fragments. For injected fragments caret instance will belong to corresponding injected editor.

Specified by:

invoke in class MultiCaretCodeInsightActionHandler

postInvoke

public void postInvoke()

Description copied from class: MultiCaretCodeInsightActionHandler

Invoked after processing all carets.

Overrides:

postInvoke in class MultiCaretCodeInsightActionHandler

doDefaultCommenting

public void doDefaultCommenting(com.intellij.codeInsight.generation.CommentByLineCommentHandler.Block block)