Java Doc for ExtendedFormatRecord.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.ExtendedFormatRecord

ExtendedFormatRecord
public class ExtendedFormatRecord extends Record (Code)
Title: Extended Format Record Description: Probably one of the more complex records. There are two breeds: Style and Cell.

It should be noted that fields in the extended format record are somewhat arbitrary. Almost all of the fields are bit-level, but we name them as best as possible by functional group. In some places this is better than others.

REFERENCE: PG 426 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  shortALT_BARS
    
final public static  shortBIG_SPOTS
    
final public static  shortBRICKS
    
final public static  shortCENTER
    
final public static  shortCENTER_SELECTION
    
final public static  shortDASHED
    
final public static  shortDASH_DOT
    
final public static  shortDASH_DOT_DOT
    
final public static  shortDIAMONDS
    
final public static  shortDOTTED
    
final public static  shortDOUBLE
    
final public static  shortFILL
    
final public static  shortFINE_DOTS
    
final public static  shortGENERAL
    
final public static  shortHAIR
    
final public static  shortJUSTIFY
    
final public static  shortLEFT
    
final public static  shortMEDIUM
    
final public static  shortMEDIUM_DASHED
    
final public static  shortMEDIUM_DASH_DOT
    
final public static  shortMEDIUM_DASH_DOT_DOT
    
final public static  shortNONE
    
final public static  shortNO_FILL
    
final public static  shortNULL
    
final public static  shortRIGHT
    
final public static  shortSLANTED_DASH_DOT
    
final public static  shortSOLID_FILL
    
final public static  shortSPARSE_DOTS
    
final public static  shortSQUARES
    
final public static  shortTHICK
    
final public static  shortTHICK_BACKWARD_DIAG
    
final public static  shortTHICK_FORWARD_DIAG
    
final public static  shortTHICK_HORZ_BANDS
    
final public static  shortTHICK_VERT_BANDS
    
final public static  shortTHIN
    
final public static  shortTHIN_BACKWARD_DIAG
    
final public static  shortTHIN_FORWARD_DIAG
    
final public static  shortTHIN_HORZ_BANDS
    
final public static  shortTHIN_VERT_BANDS
    
final public static  shortVERTICAL_BOTTOM
    
final public static  shortVERTICAL_CENTER
    
final public static  shortVERTICAL_JUSTIFY
    
final public static  shortVERTICAL_TOP
    
final public static  shortXF_CELL
    
final public static  shortXF_STYLE
    
final public static  shortsid
    

Constructor Summary
public  ExtendedFormatRecord()
    
public  ExtendedFormatRecord(RecordInputStream in)
     Constructs an ExtendedFormat record and sets its fields appropriately.

Method Summary
protected  voidfillFields(RecordInputStream in)
    
public  booleanget123Prefix()
     get some old holdover from lotus 123.
public  shortgetAdtlDiag()
    
public  shortgetAdtlDiagLineStyle()
    
public  shortgetAdtlFillPattern()
    
public  intgetAdtlPaletteOptions()
    
public  shortgetAlignment()
     get the horizontal alignment of the cell.
public  shortgetAlignmentOptions()
     get the alignment options bitmask.
public  shortgetBorderBottom()
    
public  shortgetBorderLeft()
    
public  shortgetBorderOptions()
    
public  shortgetBorderRight()
    
public  shortgetBorderTop()
    
public  shortgetBottomBorderPaletteIdx()
    
public  shortgetCellOptions()
    
public  shortgetDiag()
     Not sure what this is for (maybe fill lines?) 1 = down, 2 = up, 3 = both, 0 for none..
public  shortgetFillBackground()
    
public  shortgetFillForeground()
    
public  shortgetFillPaletteOptions()
    
public  shortgetFontIndex()
    
public  shortgetFormatIndex()
    
public  shortgetIndent()
    
public  shortgetIndentionOptions()
    
public  shortgetJustifyLast()
     Dunno.
public  shortgetLeftBorderPaletteIdx()
    
public  booleangetMergeCells()
    
public  shortgetPaletteOptions()
    
public  shortgetParentIndex()
     for cell XF types this is the parent style (usually 0/normal).
public  shortgetReadingOrder()
     get the reading order for far east versions (0 - Context, 1 - Left to right, 2 - right to left) - We could use some help with support for the far east.
public  intgetRecordSize()
    
public  shortgetRightBorderPaletteIdx()
    
public  shortgetRotation()
     get the degree of rotation.
public  booleangetShrinkToFit()
    
public  shortgetSid()
    
public  shortgetTopBorderPaletteIdx()
    
public  shortgetVerticalAlignment()
    
public  booleangetWrapText()
    
public  shortgetXFType()
    
public  booleanisHidden()
    
public  booleanisIndentNotParentAlignment()
     get whether or not to use the alignment in this XF instead of the parent XF.
public  booleanisIndentNotParentBorder()
     get whether or not to use the border in this XF instead of the parent XF.
public  booleanisIndentNotParentCellOptions()
     get whether or not to use the locking/hidden in this XF instead of the parent XF.
public  booleanisIndentNotParentFont()
     get whether or not to use the font in this XF instead of the parent XF.
public  booleanisIndentNotParentFormat()
     get whether or not to use the format in this XF instead of the parent XF.
public  booleanisIndentNotParentPattern()
     get whether or not to use the pattern in this XF instead of the parent XF.
public  booleanisLocked()
    
public  intserialize(int offset, byte[] data)
    
public  voidset123Prefix(boolean prefix)
     set some old holdover from lotus 123.
public  voidsetAdtlDiag(short diag)
    
public  voidsetAdtlDiagLineStyle(short diag)
    
public  voidsetAdtlFillPattern(short fill)
    
public  voidsetAdtlPaletteOptions(short options)
    
public  voidsetAlignment(short align)
     set the horizontal alignment of the cell.
public  voidsetAlignmentOptions(short options)
     set the alignment options bitmask.
public  voidsetBorderBottom(short border)
    
public  voidsetBorderLeft(short border)
    
public  voidsetBorderOptions(short options)
    
public  voidsetBorderRight(short border)
    
public  voidsetBorderTop(short border)
    
public  voidsetBottomBorderPaletteIdx(short border)
    
public  voidsetCellOptions(short options)
    
public  voidsetDiag(short diag)
     Not sure what this is for (maybe fill lines?) 1 = down, 2 = up, 3 = both, 0 for none..
public  voidsetFillBackground(short color)
    
public  voidsetFillForeground(short color)
    
public  voidsetFillPaletteOptions(short options)
    
public  voidsetFontIndex(short index)
    
public  voidsetFormatIndex(short index)
    
public  voidsetHidden(boolean hidden)
    
public  voidsetIndent(short indent)
    
public  voidsetIndentNotParentAlignment(boolean alignment)
     set whether or not to use the alignment in this XF instead of the parent XF.
public  voidsetIndentNotParentBorder(boolean border)
     set whether or not to use the border in this XF instead of the parent XF.
public  voidsetIndentNotParentCellOptions(boolean options)
     set whether or not to use the locking/hidden in this XF instead of the parent XF.
public  voidsetIndentNotParentFont(boolean font)
     set whether or not to use the font in this XF instead of the parent XF.
public  voidsetIndentNotParentFormat(boolean parent)
     set whether or not to use the format in this XF instead of the parent XF.
public  voidsetIndentNotParentPattern(boolean pattern)
    
public  voidsetIndentionOptions(short options)
    
public  voidsetJustifyLast(short justify)
     Dunno.
public  voidsetLeftBorderPaletteIdx(short border)
    
public  voidsetLocked(boolean locked)
    
public  voidsetMergeCells(boolean merge)
    
public  voidsetPaletteOptions(short options)
    
public  voidsetParentIndex(short parent)
     for cell XF types this is the parent style (usually 0/normal).
public  voidsetReadingOrder(short order)
     set the reading order for far east versions (0 - Context, 1 - Left to right, 2 - right to left) - We could use some help with support for the far east.
public  voidsetRightBorderPaletteIdx(short border)
    
public  voidsetRotation(short rotation)
     set the degree of rotation.
public  voidsetShrinkToFit(boolean shrink)
    
public  voidsetTopBorderPaletteIdx(short border)
    
public  voidsetVerticalAlignment(short align)
    
public  voidsetWrapText(boolean wrapped)
    
public  voidsetXFType(short type)
    
public  StringtoString()
    
protected  voidvalidateSid(short id)
    

Field Detail
ALT_BARS
final public static short ALT_BARS(Code)



BIG_SPOTS
final public static short BIG_SPOTS(Code)



BRICKS
final public static short BRICKS(Code)



CENTER
final public static short CENTER(Code)



CENTER_SELECTION
final public static short CENTER_SELECTION(Code)



DASHED
final public static short DASHED(Code)



DASH_DOT
final public static short DASH_DOT(Code)



DASH_DOT_DOT
final public static short DASH_DOT_DOT(Code)



DIAMONDS
final public static short DIAMONDS(Code)



DOTTED
final public static short DOTTED(Code)



DOUBLE
final public static short DOUBLE(Code)



FILL
final public static short FILL(Code)



FINE_DOTS
final public static short FINE_DOTS(Code)



GENERAL
final public static short GENERAL(Code)



HAIR
final public static short HAIR(Code)



JUSTIFY
final public static short JUSTIFY(Code)



LEFT
final public static short LEFT(Code)



MEDIUM
final public static short MEDIUM(Code)



MEDIUM_DASHED
final public static short MEDIUM_DASHED(Code)



MEDIUM_DASH_DOT
final public static short MEDIUM_DASH_DOT(Code)



MEDIUM_DASH_DOT_DOT
final public static short MEDIUM_DASH_DOT_DOT(Code)



NONE
final public static short NONE(Code)



NO_FILL
final public static short NO_FILL(Code)



NULL
final public static short NULL(Code)



RIGHT
final public static short RIGHT(Code)



SLANTED_DASH_DOT
final public static short SLANTED_DASH_DOT(Code)



SOLID_FILL
final public static short SOLID_FILL(Code)



SPARSE_DOTS
final public static short SPARSE_DOTS(Code)



SQUARES
final public static short SQUARES(Code)



THICK
final public static short THICK(Code)



THICK_BACKWARD_DIAG
final public static short THICK_BACKWARD_DIAG(Code)



THICK_FORWARD_DIAG
final public static short THICK_FORWARD_DIAG(Code)



THICK_HORZ_BANDS
final public static short THICK_HORZ_BANDS(Code)



THICK_VERT_BANDS
final public static short THICK_VERT_BANDS(Code)



THIN
final public static short THIN(Code)



THIN_BACKWARD_DIAG
final public static short THIN_BACKWARD_DIAG(Code)



THIN_FORWARD_DIAG
final public static short THIN_FORWARD_DIAG(Code)



THIN_HORZ_BANDS
final public static short THIN_HORZ_BANDS(Code)



THIN_VERT_BANDS
final public static short THIN_VERT_BANDS(Code)



VERTICAL_BOTTOM
final public static short VERTICAL_BOTTOM(Code)



VERTICAL_CENTER
final public static short VERTICAL_CENTER(Code)



VERTICAL_JUSTIFY
final public static short VERTICAL_JUSTIFY(Code)



VERTICAL_TOP
final public static short VERTICAL_TOP(Code)



XF_CELL
final public static short XF_CELL(Code)



XF_STYLE
final public static short XF_STYLE(Code)



sid
final public static short sid(Code)




Constructor Detail
ExtendedFormatRecord
public ExtendedFormatRecord()(Code)
Constructor ExtendedFormatRecord



ExtendedFormatRecord
public ExtendedFormatRecord(RecordInputStream in)(Code)
Constructs an ExtendedFormat record and sets its fields appropriately.
Parameters:
  in - the RecordInputstream to read the record from




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



get123Prefix
public boolean get123Prefix()(Code)
get some old holdover from lotus 123. Who cares, its all over for Lotus. RIP Lotus. prefix - the lotus thing
See Also:   ExtendedFormatRecord.getCellOptions()



getAdtlDiag
public short getAdtlDiag()(Code)
get for diagonal borders? No idea (its a palette color for the other function we didn't know what was?) diag - the palette index?
See Also:   ExtendedFormatRecord.getAdtlPaletteOptions()



getAdtlDiagLineStyle
public short getAdtlDiagLineStyle()(Code)
get the diagonal border line style? Who the heck ever heard of a diagonal border? diag - the line style
See Also:   ExtendedFormatRecord.NONE
See Also:   ExtendedFormatRecord.THIN
See Also:   ExtendedFormatRecord.MEDIUM
See Also:   ExtendedFormatRecord.DASHED
See Also:   ExtendedFormatRecord.DOTTED
See Also:   ExtendedFormatRecord.THICK
See Also:   ExtendedFormatRecord.DOUBLE
See Also:   ExtendedFormatRecord.HAIR
See Also:   ExtendedFormatRecord.MEDIUM_DASHED
See Also:   ExtendedFormatRecord.DASH_DOT
See Also:   ExtendedFormatRecord.MEDIUM_DASH_DOT
See Also:   ExtendedFormatRecord.DASH_DOT_DOT
See Also:   ExtendedFormatRecord.MEDIUM_DASH_DOT_DOT
See Also:   ExtendedFormatRecord.SLANTED_DASH_DOT
See Also:   ExtendedFormatRecord.getAdtlPaletteOptions()



getAdtlFillPattern
public short getAdtlFillPattern()(Code)
get the additional fill pattern
See Also:   ExtendedFormatRecord.NO_FILL
See Also:   ExtendedFormatRecord.SOLID_FILL
See Also:   ExtendedFormatRecord.FINE_DOTS
See Also:   ExtendedFormatRecord.ALT_BARS
See Also:   ExtendedFormatRecord.SPARSE_DOTS
See Also:   ExtendedFormatRecord.THICK_HORZ_BANDS
See Also:   ExtendedFormatRecord.THICK_VERT_BANDS
See Also:   ExtendedFormatRecord.THICK_BACKWARD_DIAG
See Also:   ExtendedFormatRecord.THICK_FORWARD_DIAG
See Also:   ExtendedFormatRecord.BIG_SPOTS
See Also:   ExtendedFormatRecord.BRICKS
See Also:   ExtendedFormatRecord.THIN_HORZ_BANDS
See Also:   ExtendedFormatRecord.THIN_VERT_BANDS
See Also:   ExtendedFormatRecord.THIN_BACKWARD_DIAG
See Also:   ExtendedFormatRecord.THIN_FORWARD_DIAG
See Also:   ExtendedFormatRecord.SQUARES
See Also:   ExtendedFormatRecord.DIAMONDS fill - fill pattern??
See Also:   ExtendedFormatRecord.getAdtlPaletteOptions()



getAdtlPaletteOptions
public int getAdtlPaletteOptions()(Code)
get the additional palette options bitmask (see individual bit getter methods that reference this method) options - bitmask to set



getAlignment
public short getAlignment()(Code)
get the horizontal alignment of the cell. align - how to align the cell (see constants)
See Also:   ExtendedFormatRecord.GENERAL
See Also:   ExtendedFormatRecord.LEFT
See Also:   ExtendedFormatRecord.CENTER
See Also:   ExtendedFormatRecord.RIGHT
See Also:   ExtendedFormatRecord.FILL
See Also:   ExtendedFormatRecord.JUSTIFY
See Also:   ExtendedFormatRecord.CENTER_SELECTION
See Also:   ExtendedFormatRecord.getAlignmentOptions()



getAlignmentOptions
public short getAlignmentOptions()(Code)
get the alignment options bitmask. See corresponding bitgetter methods that reference this one. options - the bitmask



getBorderBottom
public short getBorderBottom()(Code)
get the borderline style for the bottom border border - type of border for the bottom of the cell
See Also:   ExtendedFormatRecord.NONE
See Also:   ExtendedFormatRecord.THIN
See Also:   ExtendedFormatRecord.MEDIUM
See Also:   ExtendedFormatRecord.DASHED
See Also:   ExtendedFormatRecord.DOTTED
See Also:   ExtendedFormatRecord.THICK
See Also:   ExtendedFormatRecord.DOUBLE
See Also:   ExtendedFormatRecord.HAIR
See Also:   ExtendedFormatRecord.MEDIUM_DASHED
See Also:   ExtendedFormatRecord.DASH_DOT
See Also:   ExtendedFormatRecord.MEDIUM_DASH_DOT
See Also:   ExtendedFormatRecord.DASH_DOT_DOT
See Also:   ExtendedFormatRecord.MEDIUM_DASH_DOT_DOT
See Also:   ExtendedFormatRecord.SLANTED_DASH_DOT
See Also:   ExtendedFormatRecord.getBorderOptions()



getBorderLeft
public short getBorderLeft()(Code)
get the borderline style for the left border border - type of border for the left side of the cell
See Also:   ExtendedFormatRecord.NONE
See Also:   ExtendedFormatRecord.THIN
See Also:   ExtendedFormatRecord.MEDIUM
See Also:   ExtendedFormatRecord.DASHED
See Also:   ExtendedFormatRecord.DOTTED
See Also:   ExtendedFormatRecord.THICK
See Also:   ExtendedFormatRecord.DOUBLE
See Also:   ExtendedFormatRecord.HAIR
See Also:   ExtendedFormatRecord.MEDIUM_DASHED
See Also:   ExtendedFormatRecord.DASH_DOT
See Also:   ExtendedFormatRecord.MEDIUM_DASH_DOT
See Also:   ExtendedFormatRecord.DASH_DOT_DOT
See Also:   ExtendedFormatRecord.MEDIUM_DASH_DOT_DOT
See Also:   ExtendedFormatRecord.SLANTED_DASH_DOT
See Also:   ExtendedFormatRecord.getBorderOptions()



getBorderOptions
public short getBorderOptions()(Code)
get the border options bitmask (see the corresponding bit getter methods that reference back to this one) options - the bit mask to set



getBorderRight
public short getBorderRight()(Code)
get the borderline style for the right border border - type of border for the right side of the cell
See Also:   ExtendedFormatRecord.NONE
See Also:   ExtendedFormatRecord.THIN
See Also:   ExtendedFormatRecord.MEDIUM
See Also:   ExtendedFormatRecord.DASHED
See Also:   ExtendedFormatRecord.DOTTED
See Also:   ExtendedFormatRecord.THICK
See Also:   ExtendedFormatRecord.DOUBLE
See Also:   ExtendedFormatRecord.HAIR
See Also:   ExtendedFormatRecord.MEDIUM_DASHED
See Also:   ExtendedFormatRecord.DASH_DOT
See Also:   ExtendedFormatRecord.MEDIUM_DASH_DOT
See Also:   ExtendedFormatRecord.DASH_DOT_DOT
See Also:   ExtendedFormatRecord.MEDIUM_DASH_DOT_DOT
See Also:   ExtendedFormatRecord.SLANTED_DASH_DOT
See Also:   ExtendedFormatRecord.getBorderOptions()



getBorderTop
public short getBorderTop()(Code)
get the borderline style for the top border border - type of border for the top of the cell
See Also:   ExtendedFormatRecord.NONE
See Also:   ExtendedFormatRecord.THIN
See Also:   ExtendedFormatRecord.MEDIUM
See Also:   ExtendedFormatRecord.DASHED
See Also:   ExtendedFormatRecord.DOTTED
See Also:   ExtendedFormatRecord.THICK
See Also:   ExtendedFormatRecord.DOUBLE
See Also:   ExtendedFormatRecord.HAIR
See Also:   ExtendedFormatRecord.MEDIUM_DASHED
See Also:   ExtendedFormatRecord.DASH_DOT
See Also:   ExtendedFormatRecord.MEDIUM_DASH_DOT
See Also:   ExtendedFormatRecord.DASH_DOT_DOT
See Also:   ExtendedFormatRecord.MEDIUM_DASH_DOT_DOT
See Also:   ExtendedFormatRecord.SLANTED_DASH_DOT
See Also:   ExtendedFormatRecord.getBorderOptions()



getBottomBorderPaletteIdx
public short getBottomBorderPaletteIdx()(Code)
get the palette index for the bottom border border - palette index
See Also:   ExtendedFormatRecord.getAdtlPaletteOptions()



getCellOptions
public short getCellOptions()(Code)
gets the options bitmask - you can also use corresponding option bit getters (see other methods that reference this one) options bitmask



getDiag
public short getDiag()(Code)
Not sure what this is for (maybe fill lines?) 1 = down, 2 = up, 3 = both, 0 for none.. diag - whatever it is that this is.
See Also:   ExtendedFormatRecord.getPaletteOptions()



getFillBackground
public short getFillBackground()(Code)
get the background palette color index color palette index
See Also:   ExtendedFormatRecord.getFillPaletteOptions()



getFillForeground
public short getFillForeground()(Code)
get the foreground palette color index color - palette index
See Also:   ExtendedFormatRecord.getFillPaletteOptions()



getFillPaletteOptions
public short getFillPaletteOptions()(Code)
get the fill palette options bitmask (see indivdual bit getters that reference this method) options



getFontIndex
public short getFontIndex()(Code)
get the index to the FONT record (which font to use 0 based) index to the font
See Also:   org.apache.poi.hssf.record.FontRecord



getFormatIndex
public short getFormatIndex()(Code)
get the index to the Format record (which FORMAT to use 0-based) index to the format record
See Also:   org.apache.poi.hssf.record.FormatRecord



getIndent
public short getIndent()(Code)
get indention (not sure of the units, think its spaces) indent - how far to indent the cell
See Also:   ExtendedFormatRecord.getIndentionOptions()



getIndentionOptions
public short getIndentionOptions()(Code)
get the indent options bitmask (see corresponding bit getters that reference this field) options bitmask



getJustifyLast
public short getJustifyLast()(Code)
Dunno. Docs just say this is for far east versions.. (I'm guessing it justifies for right-to-left read languages) justify
See Also:   ExtendedFormatRecord.getAlignmentOptions()



getLeftBorderPaletteIdx
public short getLeftBorderPaletteIdx()(Code)
get the palette index for the left border color border - palette index
See Also:   ExtendedFormatRecord.getPaletteOptions()



getMergeCells
public boolean getMergeCells()(Code)
get whether to merge cells merge - merge cells or not
See Also:   ExtendedFormatRecord.getIndentionOptions()



getPaletteOptions
public short getPaletteOptions()(Code)
get the palette options bitmask (see the individual bit getter methods that reference this one) options - the bitmask



getParentIndex
public short getParentIndex()(Code)
for cell XF types this is the parent style (usually 0/normal). For style this should be NULL. index of parent XF
See Also:   ExtendedFormatRecord.NULL
See Also:   ExtendedFormatRecord.getCellOptions()



getReadingOrder
public short getReadingOrder()(Code)
get the reading order for far east versions (0 - Context, 1 - Left to right, 2 - right to left) - We could use some help with support for the far east. order - the reading order (0,1,2)
See Also:   ExtendedFormatRecord.getIndentionOptions()



getRecordSize
public int getRecordSize()(Code)



getRightBorderPaletteIdx
public short getRightBorderPaletteIdx()(Code)
get the palette index for the right border color border - palette index
See Also:   ExtendedFormatRecord.getPaletteOptions()



getRotation
public short getRotation()(Code)
get the degree of rotation. (I've not actually seen this used anywhere) rotation - the degree of rotation
See Also:   ExtendedFormatRecord.getAlignmentOptions()



getShrinkToFit
public boolean getShrinkToFit()(Code)
get whether to shrink the text to fit shrink - shrink to fit or not
See Also:   ExtendedFormatRecord.getIndentionOptions()



getSid
public short getSid()(Code)



getTopBorderPaletteIdx
public short getTopBorderPaletteIdx()(Code)
get the palette index for the top border border - palette index
See Also:   ExtendedFormatRecord.getAdtlPaletteOptions()



getVerticalAlignment
public short getVerticalAlignment()(Code)
get the vertical alignment of text in the cell where to align the text
See Also:   ExtendedFormatRecord.VERTICAL_TOP
See Also:   ExtendedFormatRecord.VERTICAL_CENTER
See Also:   ExtendedFormatRecord.VERTICAL_BOTTOM
See Also:   ExtendedFormatRecord.VERTICAL_JUSTIFY
See Also:   ExtendedFormatRecord.getAlignmentOptions()



getWrapText
public boolean getWrapText()(Code)
get whether to wrap the text in the cell wrapped - whether or not to wrap the cell text
See Also:   ExtendedFormatRecord.getAlignmentOptions()



getXFType
public short getXFType()(Code)
get whether the cell is a cell or style XFRecord type - cell or style (0/1)
See Also:   ExtendedFormatRecord.XF_STYLE
See Also:   ExtendedFormatRecord.XF_CELL
See Also:   ExtendedFormatRecord.getCellOptions()



isHidden
public boolean isHidden()(Code)
get whether the cell is hidden or not hidden - if the cell is hidden
See Also:   ExtendedFormatRecord.getCellOptions()



isIndentNotParentAlignment
public boolean isIndentNotParentAlignment()(Code)
get whether or not to use the alignment in this XF instead of the parent XF. alignment true if this XF has a different alignment value than its parent,false otherwise.
See Also:   ExtendedFormatRecord.getIndentionOptions()



isIndentNotParentBorder
public boolean isIndentNotParentBorder()(Code)
get whether or not to use the border in this XF instead of the parent XF. border - true if this XF has a different border value than its parent,false otherwise.
See Also:   ExtendedFormatRecord.getIndentionOptions()



isIndentNotParentCellOptions
public boolean isIndentNotParentCellOptions()(Code)
get whether or not to use the locking/hidden in this XF instead of the parent XF. options- true if this XF has a different locking or hidden value than its parent,false otherwise.
See Also:   ExtendedFormatRecord.getIndentionOptions()



isIndentNotParentFont
public boolean isIndentNotParentFont()(Code)
get whether or not to use the font in this XF instead of the parent XF. font - true if this XF has a different font value than its parent,false otherwise.
See Also:   ExtendedFormatRecord.getIndentionOptions()



isIndentNotParentFormat
public boolean isIndentNotParentFormat()(Code)
get whether or not to use the format in this XF instead of the parent XF. parent - true if this XF has a different format value than its parent,false otherwise.
See Also:   ExtendedFormatRecord.getIndentionOptions()



isIndentNotParentPattern
public boolean isIndentNotParentPattern()(Code)
get whether or not to use the pattern in this XF instead of the parent XF. (foregrount/background) pattern- true if this XF has a different pattern value than its parent,false otherwise.
See Also:   ExtendedFormatRecord.getIndentionOptions()



isLocked
public boolean isLocked()(Code)
get whether the cell is locked or not locked - if the cell is locked
See Also:   ExtendedFormatRecord.getCellOptions()



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



set123Prefix
public void set123Prefix(boolean prefix)(Code)
set some old holdover from lotus 123. Who cares, its all over for Lotus. RIP Lotus.
Parameters:
  prefix - - the lotus thing to set.
See Also:   ExtendedFormatRecord.setCellOptions(short)



setAdtlDiag
public void setAdtlDiag(short diag)(Code)
set for diagonal borders? No idea (its a palette color for the other function we didn't know what was?)
Parameters:
  diag - - the palette index?
See Also:   ExtendedFormatRecord.setAdtlPaletteOptions(short)



setAdtlDiagLineStyle
public void setAdtlDiagLineStyle(short diag)(Code)
set the diagonal border line style? Who the heck ever heard of a diagonal border?
Parameters:
  diag - - the line style
See Also:   ExtendedFormatRecord.NONE
See Also:   ExtendedFormatRecord.THIN
See Also:   ExtendedFormatRecord.MEDIUM
See Also:   ExtendedFormatRecord.DASHED
See Also:   ExtendedFormatRecord.DOTTED
See Also:   ExtendedFormatRecord.THICK
See Also:   ExtendedFormatRecord.DOUBLE
See Also:   ExtendedFormatRecord.HAIR
See Also:   ExtendedFormatRecord.MEDIUM_DASHED
See Also:   ExtendedFormatRecord.DASH_DOT
See Also:   ExtendedFormatRecord.MEDIUM_DASH_DOT
See Also:   ExtendedFormatRecord.DASH_DOT_DOT
See Also:   ExtendedFormatRecord.MEDIUM_DASH_DOT_DOT
See Also:   ExtendedFormatRecord.SLANTED_DASH_DOT
See Also:   ExtendedFormatRecord.setAdtlPaletteOptions(short)



setAdtlFillPattern
public void setAdtlFillPattern(short fill)(Code)
set the fill pattern
See Also:   ExtendedFormatRecord.NO_FILL
See Also:   ExtendedFormatRecord.SOLID_FILL
See Also:   ExtendedFormatRecord.FINE_DOTS
See Also:   ExtendedFormatRecord.ALT_BARS
See Also:   ExtendedFormatRecord.SPARSE_DOTS
See Also:   ExtendedFormatRecord.THICK_HORZ_BANDS
See Also:   ExtendedFormatRecord.THICK_VERT_BANDS
See Also:   ExtendedFormatRecord.THICK_BACKWARD_DIAG
See Also:   ExtendedFormatRecord.THICK_FORWARD_DIAG
See Also:   ExtendedFormatRecord.BIG_SPOTS
See Also:   ExtendedFormatRecord.BRICKS
See Also:   ExtendedFormatRecord.THIN_HORZ_BANDS
See Also:   ExtendedFormatRecord.THIN_VERT_BANDS
See Also:   ExtendedFormatRecord.THIN_BACKWARD_DIAG
See Also:   ExtendedFormatRecord.THIN_FORWARD_DIAG
See Also:   ExtendedFormatRecord.SQUARES
See Also:   ExtendedFormatRecord.DIAMONDS
Parameters:
  fill - - fill pattern??
See Also:   ExtendedFormatRecord.setAdtlPaletteOptions(short)



setAdtlPaletteOptions
public void setAdtlPaletteOptions(short options)(Code)
set the additional palette options bitmask (see individual bitsetter methods that reference this method)
Parameters:
  options - - bitmask to set



setAlignment
public void setAlignment(short align)(Code)
set the horizontal alignment of the cell.
Parameters:
  align - - how to align the cell (see constants)
See Also:   ExtendedFormatRecord.GENERAL
See Also:   ExtendedFormatRecord.LEFT
See Also:   ExtendedFormatRecord.CENTER
See Also:   ExtendedFormatRecord.RIGHT
See Also:   ExtendedFormatRecord.FILL
See Also:   ExtendedFormatRecord.JUSTIFY
See Also:   ExtendedFormatRecord.CENTER_SELECTION
See Also:   ExtendedFormatRecord.setAlignmentOptions(short)



setAlignmentOptions
public void setAlignmentOptions(short options)(Code)
set the alignment options bitmask. See corresponding bitsetter methods that reference this one.
Parameters:
  options - - the bitmask to set



setBorderBottom
public void setBorderBottom(short border)(Code)
set the border line style for the bottom border
Parameters:
  border - - type of border for the bottom of the cell
See Also:   ExtendedFormatRecord.NONE
See Also:   ExtendedFormatRecord.THIN
See Also:   ExtendedFormatRecord.MEDIUM
See Also:   ExtendedFormatRecord.DASHED
See Also:   ExtendedFormatRecord.DOTTED
See Also:   ExtendedFormatRecord.THICK
See Also:   ExtendedFormatRecord.DOUBLE
See Also:   ExtendedFormatRecord.HAIR
See Also:   ExtendedFormatRecord.MEDIUM_DASHED
See Also:   ExtendedFormatRecord.DASH_DOT
See Also:   ExtendedFormatRecord.MEDIUM_DASH_DOT
See Also:   ExtendedFormatRecord.DASH_DOT_DOT
See Also:   ExtendedFormatRecord.MEDIUM_DASH_DOT_DOT
See Also:   ExtendedFormatRecord.SLANTED_DASH_DOT
See Also:   ExtendedFormatRecord.setBorderOptions(short)



setBorderLeft
public void setBorderLeft(short border)(Code)
set the borderline style for the left border
Parameters:
  border - - type of border for the left side of the cell
See Also:   ExtendedFormatRecord.NONE
See Also:   ExtendedFormatRecord.THIN
See Also:   ExtendedFormatRecord.MEDIUM
See Also:   ExtendedFormatRecord.DASHED
See Also:   ExtendedFormatRecord.DOTTED
See Also:   ExtendedFormatRecord.THICK
See Also:   ExtendedFormatRecord.DOUBLE
See Also:   ExtendedFormatRecord.HAIR
See Also:   ExtendedFormatRecord.MEDIUM_DASHED
See Also:   ExtendedFormatRecord.DASH_DOT
See Also:   ExtendedFormatRecord.MEDIUM_DASH_DOT
See Also:   ExtendedFormatRecord.DASH_DOT_DOT
See Also:   ExtendedFormatRecord.MEDIUM_DASH_DOT_DOT
See Also:   ExtendedFormatRecord.SLANTED_DASH_DOT
See Also:   ExtendedFormatRecord.setBorderOptions(short)



setBorderOptions
public void setBorderOptions(short options)(Code)
set the border options bitmask (see the corresponding bitsetter methods that reference back to this one)
Parameters:
  options - - the bit mask to set



setBorderRight
public void setBorderRight(short border)(Code)
set the border line style for the right border
Parameters:
  border - - type of border for the right side of the cell
See Also:   ExtendedFormatRecord.NONE
See Also:   ExtendedFormatRecord.THIN
See Also:   ExtendedFormatRecord.MEDIUM
See Also:   ExtendedFormatRecord.DASHED
See Also:   ExtendedFormatRecord.DOTTED
See Also:   ExtendedFormatRecord.THICK
See Also:   ExtendedFormatRecord.DOUBLE
See Also:   ExtendedFormatRecord.HAIR
See Also:   ExtendedFormatRecord.MEDIUM_DASHED
See Also:   ExtendedFormatRecord.DASH_DOT
See Also:   ExtendedFormatRecord.MEDIUM_DASH_DOT
See Also:   ExtendedFormatRecord.DASH_DOT_DOT
See Also:   ExtendedFormatRecord.MEDIUM_DASH_DOT_DOT
See Also:   ExtendedFormatRecord.SLANTED_DASH_DOT
See Also:   ExtendedFormatRecord.setBorderOptions(short)



setBorderTop
public void setBorderTop(short border)(Code)
set the border line style for the top border
Parameters:
  border - - type of border for the top of the cell
See Also:   ExtendedFormatRecord.NONE
See Also:   ExtendedFormatRecord.THIN
See Also:   ExtendedFormatRecord.MEDIUM
See Also:   ExtendedFormatRecord.DASHED
See Also:   ExtendedFormatRecord.DOTTED
See Also:   ExtendedFormatRecord.THICK
See Also:   ExtendedFormatRecord.DOUBLE
See Also:   ExtendedFormatRecord.HAIR
See Also:   ExtendedFormatRecord.MEDIUM_DASHED
See Also:   ExtendedFormatRecord.DASH_DOT
See Also:   ExtendedFormatRecord.MEDIUM_DASH_DOT
See Also:   ExtendedFormatRecord.DASH_DOT_DOT
See Also:   ExtendedFormatRecord.MEDIUM_DASH_DOT_DOT
See Also:   ExtendedFormatRecord.SLANTED_DASH_DOT
See Also:   ExtendedFormatRecord.setBorderOptions(short)



setBottomBorderPaletteIdx
public void setBottomBorderPaletteIdx(short border)(Code)
set the palette index for the bottom border
Parameters:
  border - - palette index
See Also:   ExtendedFormatRecord.setAdtlPaletteOptions(short)



setCellOptions
public void setCellOptions(short options)(Code)
sets the options bitmask - you can also use corresponding option bit setters (see other methods that reference this one)
Parameters:
  options - bitmask to set



setDiag
public void setDiag(short diag)(Code)
Not sure what this is for (maybe fill lines?) 1 = down, 2 = up, 3 = both, 0 for none..
Parameters:
  diag - - set whatever it is that this is.
See Also:   ExtendedFormatRecord.setPaletteOptions(short)



setFillBackground
public void setFillBackground(short color)(Code)
set the background palette color index
Parameters:
  color - - palette index
See Also:   ExtendedFormatRecord.setFillPaletteOptions(short)



setFillForeground
public void setFillForeground(short color)(Code)
set the foreground palette color index
Parameters:
  color - - palette index
See Also:   ExtendedFormatRecord.setFillPaletteOptions(short)



setFillPaletteOptions
public void setFillPaletteOptions(short options)(Code)
set the fill palette options bitmask (see
Parameters:
  options -



setFontIndex
public void setFontIndex(short index)(Code)
set the index to the FONT record (which font to use 0 based)
Parameters:
  index - to the font
See Also:   org.apache.poi.hssf.record.FontRecord



setFormatIndex
public void setFormatIndex(short index)(Code)
set the index to the Format record (which FORMAT to use 0-based)
Parameters:
  index - to the format record
See Also:   org.apache.poi.hssf.record.FormatRecord



setHidden
public void setHidden(boolean hidden)(Code)
set whether the cell is hidden or not
Parameters:
  hidden - - if the cell is hidden
See Also:   ExtendedFormatRecord.setCellOptions(short)



setIndent
public void setIndent(short indent)(Code)
set indention (not sure of the units, think its spaces)
Parameters:
  indent - - how far to indent the cell
See Also:   ExtendedFormatRecord.setIndentionOptions(short)



setIndentNotParentAlignment
public void setIndentNotParentAlignment(boolean alignment)(Code)
set whether or not to use the alignment in this XF instead of the parent XF.
Parameters:
  alignment - true if this XF has a different alignment value than its parent,false otherwise.
See Also:   ExtendedFormatRecord.setIndentionOptions(short)



setIndentNotParentBorder
public void setIndentNotParentBorder(boolean border)(Code)
set whether or not to use the border in this XF instead of the parent XF.
Parameters:
  border - - true if this XF has a different border value than its parent,false otherwise.
See Also:   ExtendedFormatRecord.setIndentionOptions(short)



setIndentNotParentCellOptions
public void setIndentNotParentCellOptions(boolean options)(Code)
set whether or not to use the locking/hidden in this XF instead of the parent XF.
Parameters:
  options - true if this XF has a different locking or hidden value than its parent,false otherwise.
See Also:   ExtendedFormatRecord.setIndentionOptions(short)



setIndentNotParentFont
public void setIndentNotParentFont(boolean font)(Code)
set whether or not to use the font in this XF instead of the parent XF.
Parameters:
  font - - true if this XF has a different font value than its parent,false otherwise.
See Also:   ExtendedFormatRecord.setIndentionOptions(short)



setIndentNotParentFormat
public void setIndentNotParentFormat(boolean parent)(Code)
set whether or not to use the format in this XF instead of the parent XF.
Parameters:
  parent - - true if this XF has a different format value than its parent,false otherwise.
See Also:   ExtendedFormatRecord.setIndentionOptions(short)



setIndentNotParentPattern
public void setIndentNotParentPattern(boolean pattern)(Code)

Sets whether or not to use the pattern in this XF instead of the parent XF (foreground/background).


Parameters:
  pattern - true if this XF has a different patternvalue than its parent, false otherwise.
See Also:   ExtendedFormatRecord.setIndentionOptions(short)



setIndentionOptions
public void setIndentionOptions(short options)(Code)
set the indent options bitmask (see corresponding bitmask setters that reference this field)
Parameters:
  options - bitmask to set.



setJustifyLast
public void setJustifyLast(short justify)(Code)
Dunno. Docs just say this is for far east versions.. (I'm guessing it justifies for right-to-left read languages)
Parameters:
  justify -
See Also:   ExtendedFormatRecord.setAlignmentOptions(short)



setLeftBorderPaletteIdx
public void setLeftBorderPaletteIdx(short border)(Code)
set the palette index for the left border color
Parameters:
  border - - palette index
See Also:   ExtendedFormatRecord.setPaletteOptions(short)



setLocked
public void setLocked(boolean locked)(Code)
set whether the cell is locked or not
Parameters:
  locked - - if the cell is locked
See Also:   ExtendedFormatRecord.setCellOptions(short)



setMergeCells
public void setMergeCells(boolean merge)(Code)
set whether to merge cells
Parameters:
  merge - - merge cells or not
See Also:   ExtendedFormatRecord.setIndentionOptions(short)



setPaletteOptions
public void setPaletteOptions(short options)(Code)
set the palette options bitmask (see the individual bitsetter methods that reference this one)
Parameters:
  options - - the bitmask to set



setParentIndex
public void setParentIndex(short parent)(Code)
for cell XF types this is the parent style (usually 0/normal). For style this should be NULL.
Parameters:
  parent - index of parent XF
See Also:   ExtendedFormatRecord.NULL
See Also:   ExtendedFormatRecord.setCellOptions(short)



setReadingOrder
public void setReadingOrder(short order)(Code)
set the reading order for far east versions (0 - Context, 1 - Left to right, 2 - right to left) - We could use some help with support for the far east.
Parameters:
  order - - the reading order (0,1,2)
See Also:   ExtendedFormatRecord.setIndentionOptions(short)



setRightBorderPaletteIdx
public void setRightBorderPaletteIdx(short border)(Code)
set the palette index for the right border color
Parameters:
  border - - palette index
See Also:   ExtendedFormatRecord.setPaletteOptions(short)



setRotation
public void setRotation(short rotation)(Code)
set the degree of rotation. (I've not actually seen this used anywhere)
Parameters:
  rotation - the degree of rotation
See Also:   ExtendedFormatRecord.setAlignmentOptions(short)



setShrinkToFit
public void setShrinkToFit(boolean shrink)(Code)
set whether to shrink the text to fit
Parameters:
  shrink - - shrink to fit or not
See Also:   ExtendedFormatRecord.setIndentionOptions(short)



setTopBorderPaletteIdx
public void setTopBorderPaletteIdx(short border)(Code)
set the palette index for the top border
Parameters:
  border - - palette index
See Also:   ExtendedFormatRecord.setAdtlPaletteOptions(short)



setVerticalAlignment
public void setVerticalAlignment(short align)(Code)
set the vertical alignment of text in the cell
Parameters:
  align - where to align the text
See Also:   ExtendedFormatRecord.VERTICAL_TOP
See Also:   ExtendedFormatRecord.VERTICAL_CENTER
See Also:   ExtendedFormatRecord.VERTICAL_BOTTOM
See Also:   ExtendedFormatRecord.VERTICAL_JUSTIFY
See Also:   ExtendedFormatRecord.setAlignmentOptions(short)



setWrapText
public void setWrapText(boolean wrapped)(Code)
set whether to wrap the text in the cell
Parameters:
  wrapped - - whether or not to wrap the cell text
See Also:   ExtendedFormatRecord.setAlignmentOptions(short)



setXFType
public void setXFType(short type)(Code)
set whether the cell is a cell or style XFRecord
Parameters:
  type - - cell or style (0/1)
See Also:   ExtendedFormatRecord.XF_STYLE
See Also:   ExtendedFormatRecord.XF_CELL
See Also:   ExtendedFormatRecord.setCellOptions(short)



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.