RichTextString (POI API Documentation)

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

org.apache.poi.ss.usermodel
Interface RichTextString

Rich text unicode string. These strings can have fonts applied to arbitary parts of the string.

Method Summary
`void`	`applyFont(Font font)` Sets the font of the entire string.
`void`	`applyFont(int startIndex, int endIndex, Font font)` Applies a font to the specified characters of a string.
`void`	`applyFont(int startIndex, int endIndex, short fontIndex)` Applies a font to the specified characters of a string.
`void`	`applyFont(short fontIndex)` Applies the specified font to the entire string.
`void`	`clearFormatting()` Removes any formatting that may have been applied to the string.
`int`	`getIndexOfFormattingRun(int index)` The index within the string to which the specified formatting run applies.
`java.lang.String`	`getString()` Returns the plain string representation.
`int`	`length()`
`int`	`numFormattingRuns()`

Method Detail

void applyFont(int startIndex,               int endIndex,               short fontIndex)

Applies a font to the specified characters of a string.

Parameters:: startIndex - The start index to apply the font to (inclusive); endIndex - The end index to apply the font to (exclusive); fontIndex - The font to use.

void applyFont(int startIndex,               int endIndex,               Font font)

Applies a font to the specified characters of a string.

Parameters:: startIndex - The start index to apply the font to (inclusive); endIndex - The end index to apply to font to (exclusive); font - The index of the font to use.