Save This Page
Home » poi-src-3.2-FINAL-20081019 » org.apache » poi » hssf » usermodel » [javadoc | source]
org.apache.poi.hssf.usermodel
public class: HSSFRichTextString [javadoc | source]
java.lang.Object
   org.apache.poi.hssf.usermodel.HSSFRichTextString

All Implemented Interfaces:
    Comparable

Rich text unicode string. These strings can have fonts applied to arbitary parts of the string.
Field Summary
public static final  short NO_FONT    Place holder for indicating that NO_FONT has been applied here 
Constructor:
 public HSSFRichTextString() 
 public HSSFRichTextString(String string) 
 HSSFRichTextString(Workbook book,
    LabelSSTRecord record) 
Method from org.apache.poi.hssf.usermodel.HSSFRichTextString Summary:
applyFont,   applyFont,   applyFont,   applyFont,   clearFormatting,   compareTo,   equals,   getFontAtIndex,   getFontOfFormattingRun,   getIndexOfFormattingRun,   getString,   getUnicodeString,   length,   numFormattingRuns,   setUnicodeString,   setWorkbookReferences,   toString
Methods from java.lang.Object:
equals,   getClass,   hashCode,   notify,   notifyAll,   toString,   wait,   wait,   wait
Method from org.apache.poi.hssf.usermodel.HSSFRichTextString Detail:
 public  void applyFont(HSSFFont font) 
    Sets the font of the entire string.
 public  void applyFont(short fontIndex) 
    Applies the specified font to the entire string.
 public  void applyFont(int startIndex,
    int endIndex,
    short fontIndex) 
    Applies a font to the specified characters of a string.
 public  void applyFont(int startIndex,
    int endIndex,
    HSSFFont font) 
    Applies a font to the specified characters of a string.
 public  void clearFormatting() 
    Removes any formatting that may have been applied to the string.
 public int compareTo(Object o) 
    Compares one rich text string to another.
 public boolean equals(Object o) 
 public short getFontAtIndex(int index) 
    Returns the font in use at a particular index.
 public short getFontOfFormattingRun(int index) 
    Gets the font used in a particular formatting run.
 public int getIndexOfFormattingRun(int index) 
    The index within the string to which the specified formatting run applies.
 public String getString() 
    Returns the plain string representation.
 UnicodeString getUnicodeString() 
    Used internally by the HSSFCell to get the internal string value
 public int length() 
 public int numFormattingRuns() 
  void setUnicodeString(UnicodeString str) 
    Used internally by the HSSFCell to set the internal string value
  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
 public String toString()