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

LegendRecord
public class LegendRecord extends Record (Code)
Defines a legend for a chart. NOTE: This source is automatically generated please do not modify this file. Either subclass or remove the record in src/records/definitions.
author:
   Andrew C. Oliver (acoliver at apache.org)


Field Summary
final public static  byteSPACING_CLOSE
    
final public static  byteSPACING_MEDIUM
    
final public static  byteSPACING_OPEN
    
final public static  byteTYPE_BOTTOM
    
final public static  byteTYPE_CORNER
    
final public static  byteTYPE_LEFT
    
final public static  byteTYPE_RIGHT
    
final public static  byteTYPE_TOP
    
final public static  byteTYPE_UNDOCKED
    
final public static  shortsid
    

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

Method Summary
public  Objectclone()
    
protected  voidfillFields(RecordInputStream in)
    
public  shortgetOptions()
     Get the options field for the Legend record.
public  intgetRecordSize()
    
public  shortgetSid()
    
public  bytegetSpacing()
     Get the spacing field for the Legend record.
public  bytegetType()
     Get the type field for the Legend record.
public  intgetXAxisUpperLeft()
     Get the x axis upper left field for the Legend record.
public  intgetXSize()
     Get the x size field for the Legend record.
public  intgetYAxisUpperLeft()
     Get the y axis upper left field for the Legend record.
public  intgetYSize()
     Get the y size field for the Legend record.
public  booleanisAutoPosition()
    
public  booleanisAutoSeries()
    
public  booleanisAutoXPositioning()
    
public  booleanisAutoYPositioning()
    
public  booleanisDataTable()
    
public  booleanisVertical()
     vertical or horizontal legend (1 or 0 respectively).
public  intserialize(int offset, byte[] data)
    
public  voidsetAutoPosition(boolean value)
     Sets the auto position field value.
public  voidsetAutoSeries(boolean value)
     Sets the auto series field value.
public  voidsetAutoXPositioning(boolean value)
     Sets the auto x positioning field value.
public  voidsetAutoYPositioning(boolean value)
     Sets the auto y positioning field value.
public  voidsetDataTable(boolean value)
     Sets the data table field value.
public  voidsetOptions(short field_7_options)
     Set the options field for the Legend record.
public  voidsetSpacing(byte field_6_spacing)
     Set the spacing field for the Legend record.
public  voidsetType(byte field_5_type)
     Set the type field for the Legend record.
public  voidsetVertical(boolean value)
     Sets the vertical field value. vertical or horizontal legend (1 or 0 respectively).
public  voidsetXAxisUpperLeft(int field_1_xAxisUpperLeft)
     Set the x axis upper left field for the Legend record.
public  voidsetXSize(int field_3_xSize)
     Set the x size field for the Legend record.
public  voidsetYAxisUpperLeft(int field_2_yAxisUpperLeft)
     Set the y axis upper left field for the Legend record.
public  voidsetYSize(int field_4_ySize)
     Set the y size field for the Legend record.
public  StringtoString()
    
protected  voidvalidateSid(short id)
    

Field Detail
SPACING_CLOSE
final public static byte SPACING_CLOSE(Code)



SPACING_MEDIUM
final public static byte SPACING_MEDIUM(Code)



SPACING_OPEN
final public static byte SPACING_OPEN(Code)



TYPE_BOTTOM
final public static byte TYPE_BOTTOM(Code)



TYPE_CORNER
final public static byte TYPE_CORNER(Code)



TYPE_LEFT
final public static byte TYPE_LEFT(Code)



TYPE_RIGHT
final public static byte TYPE_RIGHT(Code)



TYPE_TOP
final public static byte TYPE_TOP(Code)



TYPE_UNDOCKED
final public static byte TYPE_UNDOCKED(Code)



sid
final public static short sid(Code)




Constructor Detail
LegendRecord
public LegendRecord()(Code)



LegendRecord
public LegendRecord(RecordInputStream in)(Code)
Constructs a Legend 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)



getOptions
public short getOptions()(Code)
Get the options field for the Legend record.



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



getSid
public short getSid()(Code)



getSpacing
public byte getSpacing()(Code)
Get the spacing field for the Legend record. One of SPACING_CLOSESPACING_MEDIUMSPACING_OPEN



getType
public byte getType()(Code)
Get the type field for the Legend record. One of TYPE_BOTTOMTYPE_CORNERTYPE_TOPTYPE_RIGHTTYPE_LEFTTYPE_UNDOCKED



getXAxisUpperLeft
public int getXAxisUpperLeft()(Code)
Get the x axis upper left field for the Legend record.



getXSize
public int getXSize()(Code)
Get the x size field for the Legend record.



getYAxisUpperLeft
public int getYAxisUpperLeft()(Code)
Get the y axis upper left field for the Legend record.



getYSize
public int getYSize()(Code)
Get the y size field for the Legend record.



isAutoPosition
public boolean isAutoPosition()(Code)
automatic positioning (1=docked) the auto position field value.



isAutoSeries
public boolean isAutoSeries()(Code)
excel 5 only (true) the auto series field value.



isAutoXPositioning
public boolean isAutoXPositioning()(Code)
position of legend on the x axis is automatic the auto x positioning field value.



isAutoYPositioning
public boolean isAutoYPositioning()(Code)
position of legend on the y axis is automatic the auto y positioning field value.



isDataTable
public boolean isDataTable()(Code)
1 if chart contains data table the data table field value.



isVertical
public boolean isVertical()(Code)
vertical or horizontal legend (1 or 0 respectively). Always 0 if not automatic. the vertical field value.



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



setAutoPosition
public void setAutoPosition(boolean value)(Code)
Sets the auto position field value. automatic positioning (1=docked)



setAutoSeries
public void setAutoSeries(boolean value)(Code)
Sets the auto series field value. excel 5 only (true)



setAutoXPositioning
public void setAutoXPositioning(boolean value)(Code)
Sets the auto x positioning field value. position of legend on the x axis is automatic



setAutoYPositioning
public void setAutoYPositioning(boolean value)(Code)
Sets the auto y positioning field value. position of legend on the y axis is automatic



setDataTable
public void setDataTable(boolean value)(Code)
Sets the data table field value. 1 if chart contains data table



setOptions
public void setOptions(short field_7_options)(Code)
Set the options field for the Legend record.



setSpacing
public void setSpacing(byte field_6_spacing)(Code)
Set the spacing field for the Legend record.
Parameters:
  field_6_spacing - One of SPACING_CLOSESPACING_MEDIUMSPACING_OPEN



setType
public void setType(byte field_5_type)(Code)
Set the type field for the Legend record.
Parameters:
  field_5_type - One of TYPE_BOTTOMTYPE_CORNERTYPE_TOPTYPE_RIGHTTYPE_LEFTTYPE_UNDOCKED



setVertical
public void setVertical(boolean value)(Code)
Sets the vertical field value. vertical or horizontal legend (1 or 0 respectively). Always 0 if not automatic.



setXAxisUpperLeft
public void setXAxisUpperLeft(int field_1_xAxisUpperLeft)(Code)
Set the x axis upper left field for the Legend record.



setXSize
public void setXSize(int field_3_xSize)(Code)
Set the x size field for the Legend record.



setYAxisUpperLeft
public void setYAxisUpperLeft(int field_2_yAxisUpperLeft)(Code)
Set the y axis upper left field for the Legend record.



setYSize
public void setYSize(int field_4_ySize)(Code)
Set the y size field for the Legend 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.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.