Package org.apache.poi.hssf.usermodel
Class HSSFRichTextString
java.lang.Object
org.apache.poi.hssf.usermodel.HSSFRichTextString
- All Implemented Interfaces:
Comparable<HSSFRichTextString>,RichTextString
public final class HSSFRichTextString
extends Object
implements Comparable<HSSFRichTextString>, RichTextString
Rich text unicode string. These strings can have fonts applied to
arbitary parts of the string.
Note, that in certain cases creating too many HSSFRichTextString cells may cause Excel 2003 and lower to crash when changing the color of the cells and then saving the Excel file. Compare two snippets that produce equivalent output:
andHSSFCell hssfCell = row.createCell(idx); //rich text consists of two runs HSSFRichTextString richString = new HSSFRichTextString( "Hello, World!" ); richString.applyFont( 0, 6, font1 ); richString.applyFont( 6, 13, font2 ); hssfCell.setCellValue( richString );
//create a cell style and assign the first font to it HSSFCellStyle style = workbook.createCellStyle(); style.setFont(font1); HSSFCell hssfCell = row.createCell(idx); hssfCell.setCellStyle(style); //rich text consists of one run overriding the cell style HSSFRichTextString richString = new HSSFRichTextString( "Hello, World!" ); richString.applyFont( 6, 13, font2 ); hssfCell.setCellValue( richString );
Excel always uses the latter approach: for a reach text containing N runs Excel saves the font of the first run in the cell's style and subsequent N-1 runs override this font.
For more information regarding this behavior please consult Bugzilla 47543: https://issues.apache.org/bugzilla/show_bug.cgi?id=47543
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final shortPlace holder for indicating that NO_FONT has been applied here -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoidapplyFont(int startIndex, int endIndex, short fontIndex) Applies a font to the specified characters of a string.voidApplies a font to the specified characters of a string.voidapplyFont(short fontIndex) Applies the specified font to the entire string.voidSets the font of the entire string.voidRemoves any formatting that may have been applied to the string.intCompares one rich text string to another.booleanshortgetFontAtIndex(int index) Returns the font in use at a particular index.shortgetFontOfFormattingRun(int index) Gets the font used in a particular formatting run.intgetIndexOfFormattingRun(int index) The index within the string to which the specified formatting run applies.Returns the plain string representation.inthashCode()intlength()inttoString()
-
Field Details
-
NO_FONT
public static final short NO_FONTPlace holder for indicating that NO_FONT has been applied here- See Also:
-
-
Constructor Details
-
HSSFRichTextString
public HSSFRichTextString() -
HSSFRichTextString
-
-
Method Details
-
applyFont
public void applyFont(int startIndex, int endIndex, short fontIndex) Applies a font to the specified characters of a string.- Specified by:
applyFontin interfaceRichTextString- 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
Applies a font to the specified characters of a string.- Specified by:
applyFontin interfaceRichTextString- 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
Sets the font of the entire string.- Specified by:
applyFontin interfaceRichTextString- Parameters:
font- The font to use.
-
clearFormatting
public void clearFormatting()Removes any formatting that may have been applied to the string.- Specified by:
clearFormattingin interfaceRichTextString
-
getString
Returns the plain string representation.- Specified by:
getStringin interfaceRichTextString
-
length
public int length()- Specified by:
lengthin interfaceRichTextString- Returns:
- the number of characters in the text.
-
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()- Specified by:
numFormattingRunsin interfaceRichTextString- Returns:
- The number of formatting runs used. There will always be at least one of font NO_FONT.
- See Also:
-
getIndexOfFormattingRun
public int getIndexOfFormattingRun(int index) The index within the string to which the specified formatting run applies.- Specified by:
getIndexOfFormattingRunin interfaceRichTextString- 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
Compares one rich text string to another.- Specified by:
compareToin interfaceComparable<HSSFRichTextString>
-
equals
-
hashCode
public int hashCode() -
toString
-
applyFont
public void applyFont(short fontIndex) Applies the specified font to the entire string.- Specified by:
applyFontin interfaceRichTextString- Parameters:
fontIndex- the font to apply.
-