Java Doc for CommonObjectDataSubRecord.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.SubRecord
         org.apache.poi.hssf.record.CommonObjectDataSubRecord

CommonObjectDataSubRecord
public class CommonObjectDataSubRecord extends SubRecord (Code)
The common object data record is used to store all common preferences for an excel object. NOTE: This source is automatically generated please do not modify this file. Either subclass or remove the record in src/records/definitions.
author:
   Glen Stampoultzis (glens at apache.org)


Field Summary
final public static  shortOBJECT_TYPE_ARC
    
final public static  shortOBJECT_TYPE_BUTTON
    
final public static  shortOBJECT_TYPE_CHART
    
final public static  shortOBJECT_TYPE_CHECKBOX
    
final public static  shortOBJECT_TYPE_COMBO_BOX
    
final public static  shortOBJECT_TYPE_COMMENT
    
final public static  shortOBJECT_TYPE_DIALOG_BOX
    
final public static  shortOBJECT_TYPE_EDIT_BOX
    
final public static  shortOBJECT_TYPE_GROUP
    
final public static  shortOBJECT_TYPE_GROUP_BOX
    
final public static  shortOBJECT_TYPE_LABEL
    
final public static  shortOBJECT_TYPE_LINE
    
final public static  shortOBJECT_TYPE_LIST_BOX
    
final public static  shortOBJECT_TYPE_MICROSOFT_OFFICE_DRAWING
    
final public static  shortOBJECT_TYPE_OPTION_BUTTON
    
final public static  shortOBJECT_TYPE_OVAL
    
final public static  shortOBJECT_TYPE_PICTURE
    
final public static  shortOBJECT_TYPE_POLYGON
    
final public static  shortOBJECT_TYPE_RECTANGLE
    
final public static  shortOBJECT_TYPE_RESERVED1
    
final public static  shortOBJECT_TYPE_RESERVED2
    
final public static  shortOBJECT_TYPE_RESERVED3
    
final public static  shortOBJECT_TYPE_RESERVED4
    
final public static  shortOBJECT_TYPE_RESERVED5
    
final public static  shortOBJECT_TYPE_RESERVED6
    
final public static  shortOBJECT_TYPE_RESERVED7
    
final public static  shortOBJECT_TYPE_RESERVED8
    
final public static  shortOBJECT_TYPE_RESERVED9
    
final public static  shortOBJECT_TYPE_SCROLL_BAR
    
final public static  shortOBJECT_TYPE_SPINNER
    
final public static  shortOBJECT_TYPE_TEXT
    
final public static  shortsid
    

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

Method Summary
public  Objectclone()
    
protected  voidfillFields(RecordInputStream in)
    
public  shortgetObjectId()
     Get the object id field for the CommonObjectData record.
public  shortgetObjectType()
     Get the object type field for the CommonObjectData record.
public  shortgetOption()
     Get the option field for the CommonObjectData record.
public  intgetRecordSize()
    
public  intgetReserved1()
     Get the reserved1 field for the CommonObjectData record.
public  intgetReserved2()
     Get the reserved2 field for the CommonObjectData record.
public  intgetReserved3()
     Get the reserved3 field for the CommonObjectData record.
public  shortgetSid()
    
public  booleanisAutofill()
    
public  booleanisAutoline()
    
public  booleanisLocked()
    
public  booleanisPrintable()
    
public  intserialize(int offset, byte[] data)
    
public  voidsetAutofill(boolean value)
     Sets the autofill field value.
public  voidsetAutoline(boolean value)
     Sets the autoline field value.
public  voidsetLocked(boolean value)
     Sets the locked field value.
public  voidsetObjectId(short field_2_objectId)
     Set the object id field for the CommonObjectData record.
public  voidsetObjectType(short field_1_objectType)
     Set the object type field for the CommonObjectData record.
public  voidsetOption(short field_3_option)
     Set the option field for the CommonObjectData record.
public  voidsetPrintable(boolean value)
     Sets the printable field value.
public  voidsetReserved1(int field_4_reserved1)
     Set the reserved1 field for the CommonObjectData record.
public  voidsetReserved2(int field_5_reserved2)
     Set the reserved2 field for the CommonObjectData record.
public  voidsetReserved3(int field_6_reserved3)
     Set the reserved3 field for the CommonObjectData record.
public  StringtoString()
    
protected  voidvalidateSid(short id)
    

Field Detail
OBJECT_TYPE_ARC
final public static short OBJECT_TYPE_ARC(Code)



OBJECT_TYPE_BUTTON
final public static short OBJECT_TYPE_BUTTON(Code)



OBJECT_TYPE_CHART
final public static short OBJECT_TYPE_CHART(Code)



OBJECT_TYPE_CHECKBOX
final public static short OBJECT_TYPE_CHECKBOX(Code)



OBJECT_TYPE_COMBO_BOX
final public static short OBJECT_TYPE_COMBO_BOX(Code)



OBJECT_TYPE_COMMENT
final public static short OBJECT_TYPE_COMMENT(Code)



OBJECT_TYPE_DIALOG_BOX
final public static short OBJECT_TYPE_DIALOG_BOX(Code)



OBJECT_TYPE_EDIT_BOX
final public static short OBJECT_TYPE_EDIT_BOX(Code)



OBJECT_TYPE_GROUP
final public static short OBJECT_TYPE_GROUP(Code)



OBJECT_TYPE_GROUP_BOX
final public static short OBJECT_TYPE_GROUP_BOX(Code)



OBJECT_TYPE_LABEL
final public static short OBJECT_TYPE_LABEL(Code)



OBJECT_TYPE_LINE
final public static short OBJECT_TYPE_LINE(Code)



OBJECT_TYPE_LIST_BOX
final public static short OBJECT_TYPE_LIST_BOX(Code)



OBJECT_TYPE_MICROSOFT_OFFICE_DRAWING
final public static short OBJECT_TYPE_MICROSOFT_OFFICE_DRAWING(Code)



OBJECT_TYPE_OPTION_BUTTON
final public static short OBJECT_TYPE_OPTION_BUTTON(Code)



OBJECT_TYPE_OVAL
final public static short OBJECT_TYPE_OVAL(Code)



OBJECT_TYPE_PICTURE
final public static short OBJECT_TYPE_PICTURE(Code)



OBJECT_TYPE_POLYGON
final public static short OBJECT_TYPE_POLYGON(Code)



OBJECT_TYPE_RECTANGLE
final public static short OBJECT_TYPE_RECTANGLE(Code)



OBJECT_TYPE_RESERVED1
final public static short OBJECT_TYPE_RESERVED1(Code)



OBJECT_TYPE_RESERVED2
final public static short OBJECT_TYPE_RESERVED2(Code)



OBJECT_TYPE_RESERVED3
final public static short OBJECT_TYPE_RESERVED3(Code)



OBJECT_TYPE_RESERVED4
final public static short OBJECT_TYPE_RESERVED4(Code)



OBJECT_TYPE_RESERVED5
final public static short OBJECT_TYPE_RESERVED5(Code)



OBJECT_TYPE_RESERVED6
final public static short OBJECT_TYPE_RESERVED6(Code)



OBJECT_TYPE_RESERVED7
final public static short OBJECT_TYPE_RESERVED7(Code)



OBJECT_TYPE_RESERVED8
final public static short OBJECT_TYPE_RESERVED8(Code)



OBJECT_TYPE_RESERVED9
final public static short OBJECT_TYPE_RESERVED9(Code)



OBJECT_TYPE_SCROLL_BAR
final public static short OBJECT_TYPE_SCROLL_BAR(Code)



OBJECT_TYPE_SPINNER
final public static short OBJECT_TYPE_SPINNER(Code)



OBJECT_TYPE_TEXT
final public static short OBJECT_TYPE_TEXT(Code)



sid
final public static short sid(Code)




Constructor Detail
CommonObjectDataSubRecord
public CommonObjectDataSubRecord()(Code)



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




Method Detail
clone
public Object clone()(Code)



fillFields
protected void fillFields(RecordInputStream in)(Code)



getObjectId
public short getObjectId()(Code)
Get the object id field for the CommonObjectData record.



getObjectType
public short getObjectType()(Code)
Get the object type field for the CommonObjectData record. One of OBJECT_TYPE_GROUPOBJECT_TYPE_LINEOBJECT_TYPE_RECTANGLEOBJECT_TYPE_OVALOBJECT_TYPE_ARCOBJECT_TYPE_CHARTOBJECT_TYPE_TEXTOBJECT_TYPE_BUTTONOBJECT_TYPE_PICTUREOBJECT_TYPE_POLYGONOBJECT_TYPE_RESERVED1OBJECT_TYPE_CHECKBOXOBJECT_TYPE_OPTION_BUTTONOBJECT_TYPE_EDIT_BOXOBJECT_TYPE_LABELOBJECT_TYPE_DIALOG_BOXOBJECT_TYPE_SPINNEROBJECT_TYPE_SCROLL_BAROBJECT_TYPE_LIST_BOXOBJECT_TYPE_GROUP_BOXOBJECT_TYPE_COMBO_BOXOBJECT_TYPE_RESERVED2OBJECT_TYPE_RESERVED3OBJECT_TYPE_RESERVED4OBJECT_TYPE_RESERVED5OBJECT_TYPE_COMMENTOBJECT_TYPE_RESERVED6OBJECT_TYPE_RESERVED7OBJECT_TYPE_RESERVED8OBJECT_TYPE_RESERVED9OBJECT_TYPE_MICROSOFT_OFFICE_DRAWING



getOption
public short getOption()(Code)
Get the option field for the CommonObjectData record.



getRecordSize
public int getRecordSize()(Code)
Size of record (exluding 4 byte header)



getReserved1
public int getReserved1()(Code)
Get the reserved1 field for the CommonObjectData record.



getReserved2
public int getReserved2()(Code)
Get the reserved2 field for the CommonObjectData record.



getReserved3
public int getReserved3()(Code)
Get the reserved3 field for the CommonObjectData record.



getSid
public short getSid()(Code)



isAutofill
public boolean isAutofill()(Code)
whether object uses an automatic fill style the autofill field value.



isAutoline
public boolean isAutoline()(Code)
whether object uses an automatic line style the autoline field value.



isLocked
public boolean isLocked()(Code)
true if object is locked when sheet has been protected the locked field value.



isPrintable
public boolean isPrintable()(Code)
object appears when printed the printable field value.



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



setAutofill
public void setAutofill(boolean value)(Code)
Sets the autofill field value. whether object uses an automatic fill style



setAutoline
public void setAutoline(boolean value)(Code)
Sets the autoline field value. whether object uses an automatic line style



setLocked
public void setLocked(boolean value)(Code)
Sets the locked field value. true if object is locked when sheet has been protected



setObjectId
public void setObjectId(short field_2_objectId)(Code)
Set the object id field for the CommonObjectData record.



setObjectType
public void setObjectType(short field_1_objectType)(Code)
Set the object type field for the CommonObjectData record.
Parameters:
  field_1_objectType - One of OBJECT_TYPE_GROUPOBJECT_TYPE_LINEOBJECT_TYPE_RECTANGLEOBJECT_TYPE_OVALOBJECT_TYPE_ARCOBJECT_TYPE_CHARTOBJECT_TYPE_TEXTOBJECT_TYPE_BUTTONOBJECT_TYPE_PICTUREOBJECT_TYPE_POLYGONOBJECT_TYPE_RESERVED1OBJECT_TYPE_CHECKBOXOBJECT_TYPE_OPTION_BUTTONOBJECT_TYPE_EDIT_BOXOBJECT_TYPE_LABELOBJECT_TYPE_DIALOG_BOXOBJECT_TYPE_SPINNEROBJECT_TYPE_SCROLL_BAROBJECT_TYPE_LIST_BOXOBJECT_TYPE_GROUP_BOXOBJECT_TYPE_COMBO_BOXOBJECT_TYPE_RESERVED2OBJECT_TYPE_RESERVED3OBJECT_TYPE_RESERVED4OBJECT_TYPE_RESERVED5OBJECT_TYPE_COMMENTOBJECT_TYPE_RESERVED6OBJECT_TYPE_RESERVED7OBJECT_TYPE_RESERVED8OBJECT_TYPE_RESERVED9OBJECT_TYPE_MICROSOFT_OFFICE_DRAWING



setOption
public void setOption(short field_3_option)(Code)
Set the option field for the CommonObjectData record.



setPrintable
public void setPrintable(boolean value)(Code)
Sets the printable field value. object appears when printed



setReserved1
public void setReserved1(int field_4_reserved1)(Code)
Set the reserved1 field for the CommonObjectData record.



setReserved2
public void setReserved2(int field_5_reserved2)(Code)
Set the reserved2 field for the CommonObjectData record.



setReserved3
public void setReserved3(int field_6_reserved3)(Code)
Set the reserved3 field for the CommonObjectData record.



toString
public String toString()(Code)



validateSid
protected void validateSid(short id)(Code)
Checks the sid matches the expected side for this record
Parameters:
  id - the expected sid.



Methods inherited from org.apache.poi.hssf.record.SubRecord
public static Record createSubRecord(RecordInputStream in)(Code)(Java Doc)

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.