public final class Utilities
extends java.lang.Object
Utilities
just defines convenient utility routines.Constructor and Description |
---|
Utilities() |
Modifier and Type | Method and Description |
---|---|
static int |
clearBit(int value,
int flag)
Returns the value with the indicated bit flag off.
|
static int |
getColumnFromOffset(TextBuffer textBuffer,
int offset,
int tabSize)
Fetches the column (0-based) of the given offset in the buffer
based on a certain tab size.
|
static int |
getColumnFromOffset(TextBuffer textBuffer,
int line,
int offset,
int tabSize)
Fetches the column (0-based) of the given offset in the buffer
based on a certain tab size.
|
static java.lang.String |
getCurrentWord(BasicEditorPane editor)
Gets the text from the editor, at the caret offset
|
static int |
getLineFromOffset(TextBuffer textBuffer,
int offset)
Fetches the line (1-based) of the given offset in the buffer
|
static int |
getNextTabStop(int tabSize,
int startColumn)
Fetches the next tab stop (column) based on the given tab size
and start column.
|
static int |
getNextWordEnd(BasicDocument document,
int offset)
Determines the next occurrence of the end of a word for the given
location.
|
static int |
getNextWordStart(BasicDocument document,
int offset)
Determines the next occurrence of the start of a word for the
given location.
|
static int |
getOffsetFromColumn(TextBuffer textBuffer,
int line,
int column,
int tabSize)
Fetches the offset corresponding to a given line and column (both
0-based) and given tab size.
|
static int |
getPreviousWordEnd(BasicDocument document,
int offset)
Determines the previous occurrence of the end of a word for the
given location.
|
static int |
getPreviousWordStart(BasicDocument document,
int offset)
Determines the previous occurrence of the start of a word for the
given location.
|
static int |
getRowEnd(BasicDocument document,
int offset)
Determines the ending row model position of the row that contains
the specified model position.
|
static int |
getRowStart(BasicDocument document,
int offset)
Determines the starting row model position of the row that contains
the specified model position.
|
static int |
getTextWidth(TextBuffer textBuffer,
int startOffset,
int endOffset,
int tabSize,
int startColumn)
Fetches the width of the given range of text in the text buffer
in columns (not pixels.) This will take into account any tabs in
the text and what the specified tab size is.
|
static int |
getWordEnd(BasicDocument document,
int offset)
Determines the end of a word for the given location.
|
static int |
getWordStart(BasicDocument document,
int offset)
Determines the start of a word for the given model location.
|
static int |
setBit(int value,
int flag)
Returns the value with the indicated bit flag on.
|
static boolean |
testBit(int value,
int flag)
Determines whether the given bit flag (i.e., 0x0001000) is set
in the value.
|
static java.lang.String |
trimCommonWhitespace(java.lang.String text)
Takes a string containing one or more lines, and removes whitespace that
is common to the start of every line.
|
public static int getTextWidth(TextBuffer textBuffer, int startOffset, int endOffset, int tabSize, int startColumn)
textBuffer
- the text buffer the data is instartOffset
- the start of the range of text (inclusive)endOffset
- the end of the range of text (exclusive)tabSize
- the tab size or tab stop (i.e., tab size 4)startColumn
- the current column that startOffset corresponds topublic static int getNextTabStop(int tabSize, int startColumn)
tabSize
- the current tab sizestartColumn
- the starting columnpublic static int getLineFromOffset(TextBuffer textBuffer, int offset)
textBuffer
- the text buffer of the dataoffset
- the offset to mappublic static int getColumnFromOffset(TextBuffer textBuffer, int offset, int tabSize)
textBuffer
- the text buffer of the dataoffset
- the offset to maptabSize
- the current tab sizepublic static int getColumnFromOffset(TextBuffer textBuffer, int line, int offset, int tabSize)
textBuffer
- the text buffer of the dataline
- the line the data is contained onoffset
- the offset to maptabSize
- the current tab sizepublic static int getOffsetFromColumn(TextBuffer textBuffer, int line, int column, int tabSize)
textBuffer
- the text buffer of the dataline
- the line the text is on (which we are trying to map)column
- the column we are trying to maptabSize
- the current tab sizepublic static int getRowStart(BasicDocument document, int offset)
document
- the documentoffset
- the offset in the document >= 0public static int getRowEnd(BasicDocument document, int offset)
document
- the documentoffset
- the offset in the document >= 0public static int getWordStart(BasicDocument document, int offset)
document
- the documentoffset
- offset in the document >= 0public static int getWordEnd(BasicDocument document, int offset)
document
- the documentoffset
- offset in the document >= 0public static int getNextWordStart(BasicDocument document, int offset)
document
- the documentoffset
- offset in the document >= 0public static int getNextWordEnd(BasicDocument document, int offset)
document
- the documentoffset
- offset in the document >= 0public static int getPreviousWordStart(BasicDocument document, int offset)
document
- the documentoffset
- offset in the document >= 0public static int getPreviousWordEnd(BasicDocument document, int offset)
document
- the documentoffset
- offset in the document >= 0public static boolean testBit(int value, int flag)
value
- value to testflag
- the bit flag to test forpublic static int setBit(int value, int flag)
value
- value to set the bit inflag
- the bit flag to turn onpublic static int clearBit(int value, int flag)
value
- value to clear the bit inflag
- the bit flag to clearpublic static java.lang.String trimCommonWhitespace(java.lang.String text)
text
- the text to trim.public static java.lang.String getCurrentWord(BasicEditorPane editor)