Package com.intellij.codeInsight.editorActions

Class CommentJoinLinesHandler

java.lang.Object

com.intellij.codeInsight.editorActions.CommentJoinLinesHandler

All Implemented Interfaces:

JoinLinesHandlerDelegate, JoinRawLinesHandlerDelegate

public class CommentJoinLinesHandler
extends java.lang.Object
implements JoinRawLinesHandlerDelegate

Field Summary

Fields inherited from interface com.intellij.codeInsight.editorActions.JoinLinesHandlerDelegate

CANNOT_JOIN, EP_NAME

Constructor Summary

Constructors

Constructor and Description
CommentJoinLinesHandler()

Method Summary

Modifier and Type	Method and Description
int	tryJoinLines(Document document, PsiFile file, int start, int end) Tries to join lines at the specified position of the specified file.
int	tryJoinRawLines(Document document, PsiFile file, int start, int end) Tries to join lines at the specified position of the specified file.

Methods inherited from class java.lang.Object

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

Constructor Detail

CommentJoinLinesHandler

public CommentJoinLinesHandler()

Method Detail

tryJoinLines

public int tryJoinLines(Document document,
                        PsiFile file,
                        int start,
                        int end)

Description copied from interface: JoinLinesHandlerDelegate

Tries to join lines at the specified position of the specified file. Method is called on a document where part of whitespace between lines is already stripped, and it has a chance to smooth out the join point.

Specified by:

tryJoinLines in interface JoinLinesHandlerDelegate

Parameters:

document - where the lines are

file - where the lines are

start - offset where the whitespace between lines starts

end - offset where the whitespace between lines ends

Returns:

the position to place the caret after the operation, or JoinLinesHandlerDelegate.CANNOT_JOIN if this handler was not able to perform the operation.

tryJoinRawLines

public int tryJoinRawLines(Document document,
                           PsiFile file,
                           int start,
                           int end)

Description copied from interface: JoinRawLinesHandlerDelegate

Tries to join lines at the specified position of the specified file.
In contrast to tryJoinLines(), this method is called on an unmodified document.

This joiner is allowed to keep number of lines the same, but it should not increase number of lines in the document.

It's possible that more than one line-break appears between start and end if several empty lines were selected.

Specified by:

tryJoinRawLines in interface JoinRawLinesHandlerDelegate

Parameters:

document - where the lines are

file - where the lines are

start - offset right after the last non-space char of first line;

end - offset of first non-space char since the next line.

Returns:

the position to place the caret after the operation, or -1 if this handler was not able to perform the operation.