org.gjt.sp.util
Class StandardUtilities

java.lang.Object
  org.gjt.sp.util.StandardUtilities

public class StandardUtilities
extends java.lang.Object

Several tools that depends on JDK only.

Since:

4.3pre5

Method Summary

static java.lang.String	createWhiteSpace(int len, int tabSize) Creates a string of white space with the specified length.
static java.lang.String	createWhiteSpace(int len, int tabSize, int start) Creates a string of white space with the specified length.
static int	getLeadingWhiteSpace(java.lang.String str) Returns the number of leading white space characters in the specified string.
static int	getLeadingWhiteSpaceWidth(java.lang.String str, int tabSize) Returns the width of the leading white space in the specified string.
static int	getOffsetOfVirtualColumn(javax.swing.text.Segment seg, int tabSize, int column, int[] totalVirtualWidth) Returns the array offset of a virtual column number (taking tabs into account) in the segment.
static int	getTrailingWhiteSpace(java.lang.String str) Returns the number of trailing whitespace characters in the specified string.
static int	getVirtualWidth(javax.swing.text.Segment seg, int tabSize) Returns the virtual column number (taking tabs into account) of the specified offset in the segment.

Methods inherited from class java.lang.Object

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

Method Detail

getLeadingWhiteSpace

public static int getLeadingWhiteSpace(java.lang.String str)

Returns the number of leading white space characters in the specified string.

Parameters:

str - The string

getTrailingWhiteSpace

public static int getTrailingWhiteSpace(java.lang.String str)

Returns the number of trailing whitespace characters in the specified string.

Parameters:

str - The string

getLeadingWhiteSpaceWidth

public static int getLeadingWhiteSpaceWidth(java.lang.String str,
                                            int tabSize)

Returns the width of the leading white space in the specified string.

Parameters:

str - The string

tabSize - The tab size

createWhiteSpace

public static java.lang.String createWhiteSpace(int len,
                                                int tabSize)

Creates a string of white space with the specified length.

To get a whitespace string tuned to the current buffer's settings, call this method as follows:

myWhitespace = MiscUtilities.createWhiteSpace(myLength,
     (buffer.getBooleanProperty("noTabs") ? 0
     : buffer.getTabSize()));

Parameters:

len - The length

tabSize - The tab size, or 0 if tabs are not to be used

createWhiteSpace

public static java.lang.String createWhiteSpace(int len,
                                                int tabSize,
                                                int start)

Creates a string of white space with the specified length.

To get a whitespace string tuned to the current buffer's settings, call this method as follows:

myWhitespace = MiscUtilities.createWhiteSpace(myLength,
     (buffer.getBooleanProperty("noTabs") ? 0
     : buffer.getTabSize()));

Parameters:

len - The length

tabSize - The tab size, or 0 if tabs are not to be used

start - The start offset, for tab alignment

getVirtualWidth

public static int getVirtualWidth(javax.swing.text.Segment seg,
                                  int tabSize)

Returns the virtual column number (taking tabs into account) of the specified offset in the segment.

Parameters:

seg - The segment

tabSize - The tab size

getOffsetOfVirtualColumn

public static int getOffsetOfVirtualColumn(javax.swing.text.Segment seg,
                                           int tabSize,
                                           int column,
                                           int[] totalVirtualWidth)

Returns the array offset of a virtual column number (taking tabs into account) in the segment.

Parameters:

seg - The segment

tabSize - The tab size

column - The virtual column number

totalVirtualWidth - If this array is non-null, the total virtual width will be stored in its first location if this method returns -1.

Returns:

-1 if the column is out of bounds