Package com.intellij.util

Class DocumentUtil

java.lang.Object

com.intellij.util.DocumentUtil

public final class DocumentUtil
extends java.lang.Object

Is intended to hold utility methods to use during Document processing.

Method Summary

Modifier and Type	Method and Description
static int	alignToCodePointBoundary(Document document, int offset)
static void	executeInBulk(Document document, boolean executeInBulk, java.lang.Runnable task) Ensures that given task is executed when given document is at the given 'in bulk' mode.
static int	getFirstNonSpaceCharOffset(Document document, int line)
static int	getFirstNonSpaceCharOffset(Document document, int startOffset, int endOffset)
static java.lang.CharSequence	getIndent(Document document, int offset) Calculates indent of the line containing offset
static int	getLineEndOffset(int offset, Document document)
static int	getLineStartOffset(int offset, Document document)
static TextRange	getLineTextRange(Document document, int line)
static int	getNextCodePointOffset(Document document, int offset)
static int	getPreviousCodePointOffset(Document document, int offset)
static boolean	isAtLineEnd(int offset, Document document)
static boolean	isAtLineStart(int offset, Document document)
static boolean	isInsideCharacterPair(Document document, int offset) Tells whether given offset lies between surrogate pair characters or between characters of Windows-style line break (\r\n).
static boolean	isInsideSurrogatePair(Document document, int offset)
static boolean	isLineEmpty(Document document, int line)
static boolean	isSurrogatePair(Document document, int offset)
static boolean	isValidOffset(int offset, Document document)
static void	writeInRunUndoTransparentAction(java.lang.Runnable runnable)

Methods inherited from class java.lang.Object

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

Method Detail

executeInBulk

public static void executeInBulk(Document document,
                                 boolean executeInBulk,
                                 java.lang.Runnable task)

Ensures that given task is executed when given document is at the given 'in bulk' mode.

Parameters:

document - target document

executeInBulk - true to force given document to be in bulk mode when given task is executed; false to force given document to be not in bulk mode when given task is executed

task - task to execute

See Also:

Document.setInBulkUpdate(boolean)

writeInRunUndoTransparentAction

public static void writeInRunUndoTransparentAction(java.lang.Runnable runnable)

getFirstNonSpaceCharOffset

public static int getFirstNonSpaceCharOffset(Document document,
                                             int line)

getFirstNonSpaceCharOffset

public static int getFirstNonSpaceCharOffset(Document document,
                                             int startOffset,
                                             int endOffset)

isValidOffset

public static boolean isValidOffset(int offset,
                                    Document document)

getLineStartOffset

public static int getLineStartOffset(int offset,
                                     Document document)

getLineEndOffset

public static int getLineEndOffset(int offset,
                                   Document document)

getLineTextRange

public static TextRange getLineTextRange(Document document,
                                         int line)

isAtLineStart

public static boolean isAtLineStart(int offset,
                                    Document document)

isAtLineEnd

public static boolean isAtLineEnd(int offset,
                                  Document document)

alignToCodePointBoundary

public static int alignToCodePointBoundary(Document document,
                                           int offset)

isSurrogatePair

public static boolean isSurrogatePair(Document document,
                                      int offset)

isInsideSurrogatePair

public static boolean isInsideSurrogatePair(Document document,
                                            int offset)

getPreviousCodePointOffset

public static int getPreviousCodePointOffset(Document document,
                                             int offset)

getNextCodePointOffset

public static int getNextCodePointOffset(Document document,
                                         int offset)

isInsideCharacterPair

public static boolean isInsideCharacterPair(Document document,
                                            int offset)

Tells whether given offset lies between surrogate pair characters or between characters of Windows-style line break (\r\n).

isLineEmpty

public static boolean isLineEmpty(Document document,
                                  int line)

getIndent

public static java.lang.CharSequence getIndent(Document document,
                                               int offset)

Calculates indent of the line containing offset

Returns:

Whitespaces at the beginning of the line