loci.poi.hssf.usermodel

Class HSSFRichTextString

java.lang.Object

loci.poi.hssf.usermodel.HSSFRichTextString

All Implemented Interfaces:

Comparable

public class HSSFRichTextString
extends Object
implements Comparable

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

Author:

Glen Stampoultzis (glens at apache.org), Jason Height (jheight at apache.org)

Field Summary

Fields

Modifier and Type	Field and Description
private Workbook	book
static short	NO_FONT Place holder for indicating that NO_FONT has been applied here
private LabelSSTRecord	record
private UnicodeString	string

Constructor Summary

Constructors

Constructor and Description
HSSFRichTextString()
HSSFRichTextString(String string)
HSSFRichTextString(Workbook book, LabelSSTRecord record)

Method Summary

Methods

Modifier and Type	Method and Description
private void	addToSSTIfRequired()
void	applyFont(HSSFFont font) Sets the font of the entire string.
void	applyFont(int startIndex, int endIndex, HSSFFont 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.
private UnicodeString	cloneStringIfRequired() Called whenever the unicode string is modified.
int	compareTo(Object o) Compares one rich text string to another.
boolean	equals(Object o)
short	getFontAtIndex(int index) Returns the font in use at a particular index.
short	getFontOfFormattingRun(int index) Gets the font used in a particular formatting run.
int	getIndexOfFormattingRun(int index) The index within the string to which the specified formatting run applies.
String	getString() Returns the plain string representation.
(package private) UnicodeString	getUnicodeString() Used internally by the HSSFCell to get the internal string value
int	length()
int	numFormattingRuns()
(package private) void	setUnicodeString(UnicodeString str) Used internally by the HSSFCell to set the internal string value
(package private) void	setWorkbookReferences(Workbook book, LabelSSTRecord record) This must be called to setup the internal work book references whenever a RichTextString is added to a cell
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

NO_FONT

public static final short NO_FONT

Place holder for indicating that NO_FONT has been applied here

See Also:

Constant Field Values

string

private UnicodeString string

book

private Workbook book

record

private LabelSSTRecord record

Constructor Detail

HSSFRichTextString

public HSSFRichTextString()

HSSFRichTextString

public HSSFRichTextString(String string)

HSSFRichTextString

HSSFRichTextString(Workbook book,
                  LabelSSTRecord record)

Method Detail

setWorkbookReferences

void setWorkbookReferences(Workbook book,
                         LabelSSTRecord record)

This must be called to setup the internal work book references whenever a RichTextString is added to a cell

cloneStringIfRequired

private UnicodeString cloneStringIfRequired()

Called whenever the unicode string is modified. When it is modified we need to create a new SST index, so that other LabelSSTRecords will not be affected by changes tat we make to this string.

addToSSTIfRequired

private void addToSSTIfRequired()

applyFont

public 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.

applyFont

public void applyFont(int startIndex,
             int endIndex,
             HSSFFont 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.

applyFont

public void applyFont(HSSFFont font)

Sets the font of the entire string.

Parameters:

font - The font to use.

clearFormatting

public void clearFormatting()

Removes any formatting that may have been applied to the string.

getString

public String getString()

Returns the plain string representation.

getUnicodeString

UnicodeString getUnicodeString()

Used internally by the HSSFCell to get the internal string value

setUnicodeString

void setUnicodeString(UnicodeString str)

Used internally by the HSSFCell to set the internal string value

length

public int length()

Returns:

the number of characters in the font.

getFontAtIndex

public short getFontAtIndex(int index)

Returns the font in use at a particular index.

Parameters:

index - The index.

Returns:

The font that's currently being applied at that index or null if no font is being applied or the index is out of range.

numFormattingRuns

public int numFormattingRuns()

Returns:

The number of formatting runs used. There will always be at least one of font NO_FONT.

See Also:

NO_FONT

getIndexOfFormattingRun

public int getIndexOfFormattingRun(int index)

The index within the string to which the specified formatting run applies.

Parameters:

index - the index of the formatting run

Returns:

the index within the string.

getFontOfFormattingRun

public short getFontOfFormattingRun(int index)

Gets the font used in a particular formatting run.

Parameters:

index - the index of the formatting run

Returns:

the font number used.

compareTo

public int compareTo(Object o)

Compares one rich text string to another.

Specified by:

compareTo in interface Comparable

equals

public boolean equals(Object o)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

Returns:

the plain text representation of this string.

applyFont

public void applyFont(short fontIndex)

Applies the specified font to the entire string.

Parameters:

fontIndex - the font to apply.