Java Doc for HSSFRichTextString.java in  » Collaboration » poi-3.0.2-beta2 » org » apache » poi » hssf » usermodel » Java Source Code / Java DocumentationJava Source Code and Java Documentation

Java Source Code / Java Documentation
1. 6.0 JDK Core
2. 6.0 JDK Modules
3. 6.0 JDK Modules com.sun
4. 6.0 JDK Modules com.sun.java
5. 6.0 JDK Modules sun
6. 6.0 JDK Platform
7. Ajax
8. Apache Harmony Java SE
9. Aspect oriented
10. Authentication Authorization
11. Blogger System
12. Build
13. Byte Code
14. Cache
15. Chart
16. Chat
17. Code Analyzer
18. Collaboration
19. Content Management System
20. Database Client
21. Database DBMS
22. Database JDBC Connection Pool
23. Database ORM
24. Development
25. EJB Server geronimo
26. EJB Server GlassFish
27. EJB Server JBoss 4.2.1
28. EJB Server resin 3.1.5
29. ERP CRM Financial
30. ESB
31. Forum
32. GIS
33. Graphic Library
34. Groupware
35. HTML Parser
36. IDE
37. IDE Eclipse
38. IDE Netbeans
39. Installer
40. Internationalization Localization
41. Inversion of Control
42. Issue Tracking
43. J2EE
44. JBoss
45. JMS
46. JMX
47. Library
48. Mail Clients
49. Net
50. Parser
51. PDF
52. Portal
53. Profiler
54. Project Management
55. Report
56. RSS RDF
57. Rule Engine
58. Science
59. Scripting
60. Search Engine
61. Security
62. Sevlet Container
63. Source Control
64. Swing Library
65. Template Engine
66. Test Coverage
67. Testing
68. UML
69. Web Crawler
70. Web Framework
71. Web Mail
72. Web Server
73. Web Services
74. Web Services apache cxf 2.0.1
75. Web Services AXIS2
76. Wiki Engine
77. Workflow Engines
78. XML
79. XML UI
Java
Java Tutorial
Java Open Source
Jar File Download
Java Articles
Java Products
Java by API
Photoshop Tutorials
Maya Tutorials
Flash Tutorials
3ds-Max Tutorials
Illustrator Tutorials
GIMP Tutorials
C# / C Sharp
C# / CSharp Tutorial
C# / CSharp Open Source
ASP.Net
ASP.NET Tutorial
JavaScript DHTML
JavaScript Tutorial
JavaScript Reference
HTML / CSS
HTML CSS Reference
C / ANSI-C
C Tutorial
C++
C++ Tutorial
Ruby
PHP
Python
Python Tutorial
Python Open Source
SQL Server / T-SQL
SQL Server / T-SQL Tutorial
Oracle PL / SQL
Oracle PL/SQL Tutorial
PostgreSQL
SQL / MySQL
MySQL Tutorial
VB.Net
VB.Net Tutorial
Flash / Flex / ActionScript
VBA / Excel / Access / Word
XML
XML Tutorial
Microsoft Office PowerPoint 2007 Tutorial
Microsoft Office Excel 2007 Tutorial
Microsoft Office Word 2007 Tutorial
Java Source Code / Java Documentation » Collaboration » poi 3.0.2 beta2 » org.apache.poi.hssf.usermodel 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


java.lang.Object
   org.apache.poi.hssf.usermodel.HSSFRichTextString

HSSFRichTextString
public class HSSFRichTextString implements Comparable(Code)
Rich text unicode string. These strings can have fonts applied to arbitary parts of the string.
author:
   Glen Stampoultzis (glens at apache.org)
author:
   Jason Height (jheight at apache.org)


Field Summary
final public static  shortNO_FONT
    

Constructor Summary
public  HSSFRichTextString()
    
public  HSSFRichTextString(String string)
    
 HSSFRichTextString(Workbook book, LabelSSTRecord record)
    

Method Summary
public  voidapplyFont(int startIndex, int endIndex, short fontIndex)
     Applies a font to the specified characters of a string.
public  voidapplyFont(int startIndex, int endIndex, HSSFFont font)
     Applies a font to the specified characters of a string.
public  voidapplyFont(HSSFFont font)
     Sets the font of the entire string.
public  voidapplyFont(short fontIndex)
     Applies the specified font to the entire string.
public  voidclearFormatting()
     Removes any formatting that may have been applied to the string.
public  intcompareTo(Object o)
     Compares one rich text string to another.
public  booleanequals(Object o)
    
public  shortgetFontAtIndex(int index)
     Returns the font in use at a particular index.
Parameters:
  index - The index.
public  shortgetFontOfFormattingRun(int index)
     Gets the font used in a particular formatting run.
public  intgetIndexOfFormattingRun(int index)
     The index within the string to which the specified formatting run applies.
public  StringgetString()
     Returns the plain string representation.
 UnicodeStringgetUnicodeString()
    
public  intlength()
    
public  intnumFormattingRuns()
     The number of formatting runs used.
 voidsetUnicodeString(UnicodeString str)
    
 voidsetWorkbookReferences(Workbook book, LabelSSTRecord record)
    
public  StringtoString()
    

Field Detail
NO_FONT
final public static short NO_FONT(Code)
Place holder for indicating that NO_FONT has been applied here




Constructor Detail
HSSFRichTextString
public HSSFRichTextString()(Code)



HSSFRichTextString
public HSSFRichTextString(String string)(Code)



HSSFRichTextString
HSSFRichTextString(Workbook book, LabelSSTRecord record)(Code)




Method Detail
applyFont
public void applyFont(int startIndex, int endIndex, short fontIndex)(Code)
Applies a font to the specified characters of a string.
Parameters:
  startIndex - The start index to apply the font to (inclusive)
Parameters:
  endIndex - The end index to apply the font to (exclusive)
Parameters:
  fontIndex - The font to use.



applyFont
public void applyFont(int startIndex, int endIndex, HSSFFont font)(Code)
Applies a font to the specified characters of a string.
Parameters:
  startIndex - The start index to apply the font to (inclusive)
Parameters:
  endIndex - The end index to apply to font to (exclusive)
Parameters:
  font - The index of the font to use.



applyFont
public void applyFont(HSSFFont font)(Code)
Sets the font of the entire string.
Parameters:
  font - The font to use.



applyFont
public void applyFont(short fontIndex)(Code)
Applies the specified font to the entire string.
Parameters:
  fontIndex - the font to apply.



clearFormatting
public void clearFormatting()(Code)
Removes any formatting that may have been applied to the string.



compareTo
public int compareTo(Object o)(Code)
Compares one rich text string to another.



equals
public boolean equals(Object o)(Code)



getFontAtIndex
public short getFontAtIndex(int index)(Code)
Returns the font in use at a particular index.
Parameters:
  index - The index. The font that's currently being applied at thatindex or null if no font is being applied or theindex is out of range.



getFontOfFormattingRun
public short getFontOfFormattingRun(int index)(Code)
Gets the font used in a particular formatting run.
Parameters:
  index - the index of the formatting run the font number used.



getIndexOfFormattingRun
public int getIndexOfFormattingRun(int index)(Code)
The index within the string to which the specified formatting run applies.
Parameters:
  index - the index of the formatting run the index within the string.



getString
public String getString()(Code)
Returns the plain string representation.



getUnicodeString
UnicodeString getUnicodeString()(Code)
Used internally by the HSSFCell to get the internal string value



length
public int length()(Code)
the number of characters in the font.



numFormattingRuns
public int numFormattingRuns()(Code)
The number of formatting runs used. There will always be atleast one of font NO_FONT.
See Also:   HSSFRichTextString.NO_FONT



setUnicodeString
void setUnicodeString(UnicodeString str)(Code)
Used internally by the HSSFCell to set the internal string value



setWorkbookReferences
void setWorkbookReferences(Workbook book, LabelSSTRecord record)(Code)
This must be called to setup the internal work book references whenever a RichTextString is added to a cell



toString
public String toString()(Code)
the plain text representation of this string.



Methods inherited from java.lang.Object
native protected Object clone() throws CloneNotSupportedException(Code)(Java Doc)
public boolean equals(Object obj)(Code)(Java Doc)
protected void finalize() throws Throwable(Code)(Java Doc)
final native public Class getClass()(Code)(Java Doc)
native public int hashCode()(Code)(Java Doc)
final native public void notify()(Code)(Java Doc)
final native public void notifyAll()(Code)(Java Doc)
public String toString()(Code)(Java Doc)
final native public void wait(long timeout) throws InterruptedException(Code)(Java Doc)
final public void wait(long timeout, int nanos) throws InterruptedException(Code)(Java Doc)
final public void wait() throws InterruptedException(Code)(Java Doc)

www.java2java.com | Contact Us
Copyright 2009 - 12 Demo Source and Support. All rights reserved.
All other trademarks are property of their respective owners.