org.gjt.sp.jedit
Class TextUtilities

java.lang.Object
  |
  +--org.gjt.sp.jedit.TextUtilities

public class TextUtilities
extends java.lang.Object

Contains several text manipulation methods.

Version:
$Id: TextUtilities.java,v 1.40 2003/01/30 02:58:40 spestov Exp $
Author:
Slava Pestov

Field Summary
static int LOWER_CASE
           
static int MIXED
           
static int TITLE_CASE
           
static int UPPER_CASE
           
 
Constructor Summary
TextUtilities()
           
 
Method Summary
static int findMatchingBracket(Buffer buffer, int line, int offset)
          Returns the offset of the bracket matching the one at the specified offset of the buffer, or -1 if the bracket is unmatched (or if the character is not a bracket).
static int findMatchingBracketFuzzy(Buffer buffer, int line, int offset)
          Works exactly like the findMatchingBracket(Bufferm int, int) method, but if there is no (matching) bracket at the specified offset, it looks at the next character too.
static int findWordEnd(java.lang.String line, int pos, java.lang.String noWordSep)
          Locates the end of the word at the specified position.
static int findWordEnd(java.lang.String line, int pos, java.lang.String noWordSep, boolean joinNonWordChars)
          Locates the end of the word at the specified position.
static int findWordStart(java.lang.String line, int pos, java.lang.String noWordSep)
          Locates the start of the word at the specified position.
static int findWordStart(java.lang.String line, int pos, java.lang.String noWordSep, boolean joinNonWordChars)
          Locates the start of the word at the specified position.
static java.lang.String format(java.lang.String text, int maxLineLength, int tabSize)
          Formats the specified text by merging and breaking lines to the specified width.
static int getStringCase(java.lang.String str)
          Returns if the specified string is all upper case, all lower case, or title case (first letter upper case, rest lower case).
static Token getTokenAtOffset(Token tokens, int offset)
          Returns the token that contains the specified offset.
static boolean regionMatches(boolean ignoreCase, javax.swing.text.Segment text, int offset, char[] match)
          Checks if a subregion of a Segment is equal to a character array.
static java.lang.String spacesToTabs(java.lang.String in, int tabSize)
          Converts consecutive spaces to tabs in the specified string.
static java.lang.String tabsToSpaces(java.lang.String in, int tabSize)
          Converts tabs to consecutive spaces in the specified string.
static java.lang.String toTitleCase(java.lang.String str)
          Converts the specified string to title case, by capitalizing the first letter.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

MIXED

public static final int MIXED
See Also:
Constant Field Values

LOWER_CASE

public static final int LOWER_CASE
See Also:
Constant Field Values

UPPER_CASE

public static final int UPPER_CASE
See Also:
Constant Field Values

TITLE_CASE

public static final int TITLE_CASE
See Also:
Constant Field Values
Constructor Detail

TextUtilities

public TextUtilities()
Method Detail

getTokenAtOffset

public static Token getTokenAtOffset(Token tokens,
                                     int offset)
Returns the token that contains the specified offset.

Parameters:
tokens - The token list
offset - The offset
Since:
jEdit 4.0pre3

findMatchingBracket

public static int findMatchingBracket(Buffer buffer,
                                      int line,
                                      int offset)
Returns the offset of the bracket matching the one at the specified offset of the buffer, or -1 if the bracket is unmatched (or if the character is not a bracket).

Parameters:
buffer - The buffer
line - The line
offset - The offset within that line
Since:
jEdit 2.6pre1

findMatchingBracketFuzzy

public static int findMatchingBracketFuzzy(Buffer buffer,
                                           int line,
                                           int offset)
Works exactly like the findMatchingBracket(Bufferm int, int) method, but if there is no (matching) bracket at the specified offset, it looks at the next character too. The caller only needs to make sure that the given offset is valid.

Parameters:
buffer - The buffer
line - The line
offset - The offset within that line
Since:
4.1pre1

findWordStart

public static int findWordStart(java.lang.String line,
                                int pos,
                                java.lang.String noWordSep)
Locates the start of the word at the specified position.

Parameters:
line - The text
pos - The position
noWordSep - Characters that are non-alphanumeric, but should be treated as word characters anyway

findWordStart

public static int findWordStart(java.lang.String line,
                                int pos,
                                java.lang.String noWordSep,
                                boolean joinNonWordChars)
Locates the start of the word at the specified position.

Parameters:
line - The text
pos - The position
noWordSep - Characters that are non-alphanumeric, but should be treated as word characters anyway
joinNonWordChars - Treat consecutive non-alphanumeric characters as one word
Since:
jEdit 4.1pre2

findWordEnd

public static int findWordEnd(java.lang.String line,
                              int pos,
                              java.lang.String noWordSep)
Locates the end of the word at the specified position.

Parameters:
line - The text
pos - The position
noWordSep - Characters that are non-alphanumeric, but should be treated as word characters anyway

findWordEnd

public static int findWordEnd(java.lang.String line,
                              int pos,
                              java.lang.String noWordSep,
                              boolean joinNonWordChars)
Locates the end of the word at the specified position.

Parameters:
line - The text
pos - The position
noWordSep - Characters that are non-alphanumeric, but should be treated as word characters anyway
joinNonWordChars - Treat consecutive non-alphanumeric characters as one word
Since:
jEdit 4.1pre2

regionMatches

public static boolean regionMatches(boolean ignoreCase,
                                    javax.swing.text.Segment text,
                                    int offset,
                                    char[] match)
Checks if a subregion of a Segment is equal to a character array.

Parameters:
ignoreCase - True if case should be ignored, false otherwise
text - The segment
offset - The offset into the segment
match - The character array to match
Since:
jEdit 2.7pre1

spacesToTabs

public static java.lang.String spacesToTabs(java.lang.String in,
                                            int tabSize)
Converts consecutive spaces to tabs in the specified string.

Parameters:
in - The string
tabSize - The tab size

tabsToSpaces

public static java.lang.String tabsToSpaces(java.lang.String in,
                                            int tabSize)
Converts tabs to consecutive spaces in the specified string.

Parameters:
in - The string
tabSize - The tab size

format

public static java.lang.String format(java.lang.String text,
                                      int maxLineLength,
                                      int tabSize)
Formats the specified text by merging and breaking lines to the specified width.

Parameters:
text - The text

getStringCase

public static int getStringCase(java.lang.String str)
Returns if the specified string is all upper case, all lower case, or title case (first letter upper case, rest lower case).

Parameters:
str - The string
Since:
jEdit 4.0pre1

toTitleCase

public static java.lang.String toTitleCase(java.lang.String str)
Converts the specified string to title case, by capitalizing the first letter.

Parameters:
str - The string
Since:
jEdit 4.0pre1