All Packages  Class Hierarchy  This Package  Previous  Next  Index  

Class java.awt.font.StyledString

java.lang.Object
    |
    +----java.awt.font.StyledString

public class StyledString

extends Object

See Also:

drawString

attrs

StyledString()

Constructs a new StyledString with no characters.

StyledString(String, AttributeSet)

StyledString(String, Font)

Constructs a new StyledString from the given String using the given Font.

charAt(int)

Returns the character at the specified index.

concat(StyledString)

Concatenates the specified StyledString to the end of this StyledString and returns a new StyledString object representing the concatenation.

createIterator()

createIterator(int, int, int)

getAdvanceVector()

Returns the advance vector for the end position of this StyledString.

getAscent()

Returns the largest ascent of any font represented in this StyledString.

getAttributes(int)

getAttributesAt(int)

getBounds2D()

Returns the bounding box of this StyledString.

getChars()

getChars(int, int, char[], int)

Copies characters from this string into the destination character array.

getDescent()

Returns the largest descent of any font represented in this StyledString.

getFontAt(int)

Returns the Font associated with the character at the specified index.

getGlyphSets()

Returns an array of GlyphSet objects associated with this StyledString.

getLeading()

Returns the largest leading of any font represented in this StyledString.

getRunLimit(int)

getRunStart(int)

getStringOutline()

Returns the Shape object for this StyledString, which is the union of all the outlines for glyphs in the StyledString.

length()

Returns the length of the StyledString.

substring(int, int)

Creates a StyledString object that is a substring of this StyledString.

toString()

Generates a String representation of the StyledString.

public AttributeSet[] attrs

public StyledString()

Constructs a new StyledString with no characters.

public StyledString(String str,
                    AttributeSet attributes)

public StyledString(String str,
                    Font font)

Constructs a new StyledString from the given String using the given Font.

Parameters:

str - the String object.

font - the Font object.

public StyledString substring(int beginIndex,
                              int endIndex)

Creates a StyledString object that is a substring of this StyledString. The substring is specified by a beginIndex (inclusive) and an endIndex (exclusive).

Parameters:

beginIndex - the beginning character index (inclusive) for the substring.

endIndex - the ending character index (exclusive) for the substring.

Throws: StringIndexOutOfBoundsException

if the beginIndex or the endIndex is out of range, or if the beginIndex is greater than the endIndex.

public float getAscent()

Returns the largest ascent of any font represented in this StyledString. The units are user space coordinates.

public float getDescent()

Returns the largest descent of any font represented in this StyledString. The units are user space coordinates.

public float getLeading()

Returns the largest leading of any font represented in this StyledString. The units are user space coordinates.

public AttributeSet getAttributes(int index)

public int getRunStart(int index)

public int getRunLimit(int index)

public Point2D getAdvanceVector()

Returns the advance vector for the end position of this StyledString.

public Rectangle2D getBounds2D()

Returns the bounding box of this StyledString.

public GlyphSet[] getGlyphSets()

Returns an array of GlyphSet objects associated with this StyledString.

public Shape getStringOutline()

Returns the Shape object for this StyledString, which is the union of all the outlines for glyphs in the StyledString.

public String toString()

Generates a String representation of the StyledString.

Overrides:

toString in class Object

public StyledString concat(StyledString str)

Concatenates the specified StyledString to the end of this StyledString and returns a new StyledString object representing the concatenation.

public char charAt(int index)

Returns the character at the specified index. An index ranges from 0 to length() - 1.

Throws: StringIndexOutOfBoundsException

if the index is not in the range 0 to length()-1.

public Font getFontAt(int index)

Returns the Font associated with the character at the specified index. An index ranges from 0 to length() - 1.

Throws: StringIndexOutOfBoundsException

if the index is not in the range 0 to length()-1.

public int length()

Returns the length of the StyledString. The length of the StyledString is equal to the number of 16-bit Unicode characters in the String.

public AttributedCharacterIterator createIterator()

public AttributedCharacterIterator createIterator(int start,
                                                  int limit,
                                                  int pos)

public AttributeSet getAttributesAt(int index)

public void getChars(int srcBegin,
                     int srcEnd,
                     char[] dst,
                     int dstBegin)

Copies characters from this string into the destination character array.

The first character to be copied is at index srcBegin; the last character to be copied is at index srcEnd-1 (thus the total number of characters to be copied is srcEnd-srcBegin). The characters are copied into the subarray of dst starting at index dstBegin and ending at index:

     dstbegin + (srcEnd-srcBegin) - 1
 

Parameters:

srcBegin - index of the first character in the string to copy.

srcEnd - index after the last character in the string to copy.

dst - the destination array.

dstBegin - the start offset in the destination array.

Throws: StringIndexOutOfBoundsException

If srcBegin or srcEnd is out of range, or if srcBegin is greater than the srcEnd.

public char[] getChars()

All Packages  Class Hierarchy  This Package  Previous  Next  Index