Java Doc for FontRecord.java in  » Collaboration » poi-3.0.2-beta2 » org » apache » poi » hssf » record » 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.record 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


java.lang.Object
   org.apache.poi.hssf.record.Record
      org.apache.poi.hssf.record.FontRecord

FontRecord
public class FontRecord extends Record (Code)
Title: Font Record - descrbes a font in the workbook (index = 0-3,5-infinity - skip 4)

Description: An element in the Font Table

REFERENCE: PG 315 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)


author:
   Andrew C. Oliver (acoliver at apache dot org)
version:
   2.0-pre



Field Summary
final public static  shortSS_NONE
    
final public static  shortSS_SUB
    
final public static  shortSS_SUPER
    
final public static  byteU_DOUBLE
    
final public static  byteU_DOUBLE_ACCOUNTING
    
final public static  byteU_NONE
    
final public static  byteU_SINGLE
    
final public static  byteU_SINGLE_ACCOUNTING
    
final public static  shortsid
    

Constructor Summary
public  FontRecord()
    
public  FontRecord(RecordInputStream in)
     Constructs a Font record and sets its fields appropriately.

Method Summary
protected  voidfillFields(RecordInputStream in)
    
public  shortgetAttributes()
    
public  shortgetBoldWeight()
     get the bold weight for this font (100-1000dec or 0x64-0x3e8).
public  bytegetCharset()
    
public  shortgetColorPaletteIndex()
    
public  bytegetFamily()
    
public  shortgetFontHeight()
    
public  StringgetFontName()
     get the name of the font fn - name of the font (i.e.
public  bytegetFontNameLength()
    
public  intgetRecordSize()
    
public  shortgetSid()
    
public  shortgetSuperSubScript()
    
public  bytegetUnderline()
    
public  booleanisItalic()
    
public  booleanisMacoutlined()
    
public  booleanisMacshadowed()
    
public  booleanisStruckout()
    
public  intserialize(int offset, byte[] data)
    
public  voidsetAttributes(short attributes)
    
public  voidsetBoldWeight(short bw)
     set the bold weight for this font (100-1000dec or 0x64-0x3e8).
public  voidsetCharset(byte charset)
    
public  voidsetColorPaletteIndex(short cpi)
    
public  voidsetFamily(byte f)
    
public  voidsetFontHeight(short height)
    
public  voidsetFontName(String fn)
     set the name of the font
Parameters:
  fn - - name of the font (i.e.
public  voidsetFontNameLength(byte len)
    
public  voidsetItalic(boolean italics)
    
public  voidsetMacoutline(boolean mac)
    
public  voidsetMacshadow(boolean mac)
    
public  voidsetStrikeout(boolean strike)
    
public  voidsetSuperSubScript(short sss)
    
public  voidsetUnderline(byte u)
    
public  StringtoString()
    
protected  voidvalidateSid(short id)
    

Field Detail
SS_NONE
final public static short SS_NONE(Code)



SS_SUB
final public static short SS_SUB(Code)



SS_SUPER
final public static short SS_SUPER(Code)



U_DOUBLE
final public static byte U_DOUBLE(Code)



U_DOUBLE_ACCOUNTING
final public static byte U_DOUBLE_ACCOUNTING(Code)



U_NONE
final public static byte U_NONE(Code)



U_SINGLE
final public static byte U_SINGLE(Code)



U_SINGLE_ACCOUNTING
final public static byte U_SINGLE_ACCOUNTING(Code)



sid
final public static short sid(Code)




Constructor Detail
FontRecord
public FontRecord()(Code)



FontRecord
public FontRecord(RecordInputStream in)(Code)
Constructs a Font record and sets its fields appropriately.
Parameters:
  in - the RecordInputstream to read the record from




Method Detail
fillFields
protected void fillFields(RecordInputStream in)(Code)



getAttributes
public short getAttributes()(Code)
get the font attributes (see individual bit getters that reference this method) attribute - the bitmask



getBoldWeight
public short getBoldWeight()(Code)
get the bold weight for this font (100-1000dec or 0x64-0x3e8). Default is 0x190 for normal and 0x2bc for bold bw - a number between 100-1000 for the fonts "boldness"



getCharset
public byte getCharset()(Code)
get the character set charset - characterset



getColorPaletteIndex
public short getColorPaletteIndex()(Code)
get the font's color palette index cpi - font color index



getFamily
public byte getFamily()(Code)
get the font family (TODO) family



getFontHeight
public short getFontHeight()(Code)
gets the height of the font in 1/20th point units fontheight (in points/20)



getFontName
public String getFontName()(Code)
get the name of the font fn - name of the font (i.e. "Arial")



getFontNameLength
public byte getFontNameLength()(Code)
get the length of the fontname string length of the font name
See Also:   FontRecord.getFontName()



getRecordSize
public int getRecordSize()(Code)



getSid
public short getSid()(Code)



getSuperSubScript
public short getSuperSubScript()(Code)
get the type of super or subscript for the font super or subscript option
See Also:   FontRecord.SS_NONE
See Also:   FontRecord.SS_SUPER
See Also:   FontRecord.SS_SUB



getUnderline
public byte getUnderline()(Code)
get the type of underlining for the font super or subscript option
See Also:   FontRecord.U_NONE
See Also:   FontRecord.U_SINGLE
See Also:   FontRecord.U_DOUBLE
See Also:   FontRecord.U_SINGLE_ACCOUNTING
See Also:   FontRecord.U_DOUBLE_ACCOUNTING



isItalic
public boolean isItalic()(Code)
get whether the font is to be italics or not italics - whether the font is italics or not
See Also:   FontRecord.getAttributes()



isMacoutlined
public boolean isMacoutlined()(Code)
whether to use the mac outline font style thing (mac only) - Some mac person should comment this instead of me doing it (since I have no idea) mac - whether to do that mac font outline thing or not
See Also:   FontRecord.getAttributes()



isMacshadowed
public boolean isMacshadowed()(Code)
whether to use the mac shado font style thing (mac only) - Some mac person should comment this instead of me doing it (since I have no idea) mac - whether to do that mac font shadow thing or not
See Also:   FontRecord.getAttributes()



isStruckout
public boolean isStruckout()(Code)
get whether the font is to be stricken out or not strike - whether the font is stricken out or not
See Also:   FontRecord.getAttributes()



serialize
public int serialize(int offset, byte[] data)(Code)



setAttributes
public void setAttributes(short attributes)(Code)
set the font attributes (see individual bit setters that reference this method)
Parameters:
  attributes - the bitmask to set



setBoldWeight
public void setBoldWeight(short bw)(Code)
set the bold weight for this font (100-1000dec or 0x64-0x3e8). Default is 0x190 for normal and 0x2bc for bold
Parameters:
  bw - - a number between 100-1000 for the fonts "boldness"



setCharset
public void setCharset(byte charset)(Code)
set the character set
Parameters:
  charset - - characterset



setColorPaletteIndex
public void setColorPaletteIndex(short cpi)(Code)
set the font's color palette index
Parameters:
  cpi - - font color index



setFamily
public void setFamily(byte f)(Code)
set the font family (TODO)
Parameters:
  f - family



setFontHeight
public void setFontHeight(short height)(Code)
sets the height of the font in 1/20th point units
Parameters:
  height - fontheight (in points/20)



setFontName
public void setFontName(String fn)(Code)
set the name of the font
Parameters:
  fn - - name of the font (i.e. "Arial")



setFontNameLength
public void setFontNameLength(byte len)(Code)
set the length of the fontname string
Parameters:
  len - length of the font name
See Also:   FontRecord.setFontName(String)



setItalic
public void setItalic(boolean italics)(Code)
set the font to be italics or not
Parameters:
  italics - - whether the font is italics or not
See Also:   FontRecord.setAttributes(short)



setMacoutline
public void setMacoutline(boolean mac)(Code)
whether to use the mac outline font style thing (mac only) - Some mac person should comment this instead of me doing it (since I have no idea)
Parameters:
  mac - - whether to do that mac font outline thing or not
See Also:   FontRecord.setAttributes(short)



setMacshadow
public void setMacshadow(boolean mac)(Code)
whether to use the mac shado font style thing (mac only) - Some mac person should comment this instead of me doing it (since I have no idea)
Parameters:
  mac - - whether to do that mac font shadow thing or not
See Also:   FontRecord.setAttributes(short)



setStrikeout
public void setStrikeout(boolean strike)(Code)
set the font to be stricken out or not
Parameters:
  strike - - whether the font is stricken out or not
See Also:   FontRecord.setAttributes(short)



setSuperSubScript
public void setSuperSubScript(short sss)(Code)
set the type of super or subscript for the font
Parameters:
  sss - super or subscript option
See Also:   FontRecord.SS_NONE
See Also:   FontRecord.SS_SUPER
See Also:   FontRecord.SS_SUB



setUnderline
public void setUnderline(byte u)(Code)
set the type of underlining for the font
Parameters:
  u - super or subscript option
See Also:   FontRecord.U_NONE
See Also:   FontRecord.U_SINGLE
See Also:   FontRecord.U_DOUBLE
See Also:   FontRecord.U_SINGLE_ACCOUNTING
See Also:   FontRecord.U_DOUBLE_ACCOUNTING



toString
public String toString()(Code)



validateSid
protected void validateSid(short id)(Code)



Methods inherited from org.apache.poi.hssf.record.Record
public Object clone()(Code)(Java Doc)
abstract protected void fillFields(RecordInputStream in)(Code)(Java Doc)
public int getRecordSize()(Code)(Java Doc)
abstract public short getSid()(Code)(Java Doc)
public boolean isInValueSection()(Code)(Java Doc)
public boolean isValue()(Code)(Java Doc)
public byte[] serialize()(Code)(Java Doc)
abstract public int serialize(int offset, byte[] data)(Code)(Java Doc)
public String toString()(Code)(Java Doc)
abstract protected void validateSid(short id)(Code)(Java Doc)

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.