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


java.lang.Object
   org.apache.poi.ddf.EscherRecord
      org.apache.poi.ddf.EscherSpRecord

EscherSpRecord
public class EscherSpRecord extends EscherRecord (Code)
Together the the EscherOptRecord this record defines some of the basic properties of a shape.
author:
   Glen Stampoultzis (glens at apache.org)


Field Summary
final public static  intFLAG_BACKGROUND
    
final public static  intFLAG_CHILD
    
final public static  intFLAG_CONNECTOR
    
final public static  intFLAG_DELETED
    
final public static  intFLAG_FLIPHORIZ
    
final public static  intFLAG_FLIPVERT
    
final public static  intFLAG_GROUP
    
final public static  intFLAG_HASSHAPETYPE
    
final public static  intFLAG_HAVEANCHOR
    
final public static  intFLAG_HAVEMASTER
    
final public static  intFLAG_OLESHAPE
    
final public static  intFLAG_PATRIARCH
    
final public static  StringRECORD_DESCRIPTION
    
final public static  shortRECORD_ID
    


Method Summary
public  intfillFields(byte[] data, int offset, EscherRecordFactory recordFactory)
     This method deserializes the record from a byte array.
Parameters:
  data - The byte array containing the escher record information
Parameters:
  offset - The starting offset into data.
Parameters:
  recordFactory - May be null since this is not a container record.
public  intgetFlags()
     The flags that apply to this shape.
public  shortgetRecordId()
    
public  StringgetRecordName()
    
public  intgetRecordSize()
     Returns the number of bytes that are required to serialize this record.
public  intgetShapeId()
    
public  intserialize(int offset, byte[] data, EscherSerializationListener listener)
     This method serializes this escher record into a byte array.
Parameters:
  offset - The offset into data to start writing the record data to.
Parameters:
  data - The byte array to serialize to.
Parameters:
  listener - A listener to retrieve start and end callbacks.
public  voidsetFlags(int field_2_flags)
     The flags that apply to this shape.
public  voidsetShapeId(int field_1_shapeId)
     Sets a number that identifies this shape.
public  StringtoString()
    

Field Detail
FLAG_BACKGROUND
final public static int FLAG_BACKGROUND(Code)



FLAG_CHILD
final public static int FLAG_CHILD(Code)



FLAG_CONNECTOR
final public static int FLAG_CONNECTOR(Code)



FLAG_DELETED
final public static int FLAG_DELETED(Code)



FLAG_FLIPHORIZ
final public static int FLAG_FLIPHORIZ(Code)



FLAG_FLIPVERT
final public static int FLAG_FLIPVERT(Code)



FLAG_GROUP
final public static int FLAG_GROUP(Code)



FLAG_HASSHAPETYPE
final public static int FLAG_HASSHAPETYPE(Code)



FLAG_HAVEANCHOR
final public static int FLAG_HAVEANCHOR(Code)



FLAG_HAVEMASTER
final public static int FLAG_HAVEMASTER(Code)



FLAG_OLESHAPE
final public static int FLAG_OLESHAPE(Code)



FLAG_PATRIARCH
final public static int FLAG_PATRIARCH(Code)



RECORD_DESCRIPTION
final public static String RECORD_DESCRIPTION(Code)



RECORD_ID
final public static short RECORD_ID(Code)





Method Detail
fillFields
public int fillFields(byte[] data, int offset, EscherRecordFactory recordFactory)(Code)
This method deserializes the record from a byte array.
Parameters:
  data - The byte array containing the escher record information
Parameters:
  offset - The starting offset into data.
Parameters:
  recordFactory - May be null since this is not a container record. The number of bytes read from the byte array.



getFlags
public int getFlags()(Code)
The flags that apply to this shape.
See Also:   EscherSpRecord.FLAG_GROUP
See Also:   EscherSpRecord.FLAG_CHILD
See Also:   EscherSpRecord.FLAG_PATRIARCH
See Also:   EscherSpRecord.FLAG_DELETED
See Also:   EscherSpRecord.FLAG_OLESHAPE
See Also:   EscherSpRecord.FLAG_HAVEMASTER
See Also:   EscherSpRecord.FLAG_FLIPHORIZ
See Also:   EscherSpRecord.FLAG_FLIPVERT
See Also:   EscherSpRecord.FLAG_CONNECTOR
See Also:   EscherSpRecord.FLAG_HAVEANCHOR
See Also:   EscherSpRecord.FLAG_BACKGROUND
See Also:   EscherSpRecord.FLAG_HASSHAPETYPE



getRecordId
public short getRecordId()(Code)
the 16 bit identifier for this record.



getRecordName
public String getRecordName()(Code)
The short name for this record



getRecordSize
public int getRecordSize()(Code)
Returns the number of bytes that are required to serialize this record. Number of bytes



getShapeId
public int getShapeId()(Code)
A number that identifies this shape



serialize
public int serialize(int offset, byte[] data, EscherSerializationListener listener)(Code)
This method serializes this escher record into a byte array.
Parameters:
  offset - The offset into data to start writing the record data to.
Parameters:
  data - The byte array to serialize to.
Parameters:
  listener - A listener to retrieve start and end callbacks. Use a NullEscherSerailizationListener to ignore these events. The number of bytes written.
See Also:   NullEscherSerializationListener



setFlags
public void setFlags(int field_2_flags)(Code)
The flags that apply to this shape.
See Also:   EscherSpRecord.FLAG_GROUP
See Also:   EscherSpRecord.FLAG_CHILD
See Also:   EscherSpRecord.FLAG_PATRIARCH
See Also:   EscherSpRecord.FLAG_DELETED
See Also:   EscherSpRecord.FLAG_OLESHAPE
See Also:   EscherSpRecord.FLAG_HAVEMASTER
See Also:   EscherSpRecord.FLAG_FLIPHORIZ
See Also:   EscherSpRecord.FLAG_FLIPVERT
See Also:   EscherSpRecord.FLAG_CONNECTOR
See Also:   EscherSpRecord.FLAG_HAVEANCHOR
See Also:   EscherSpRecord.FLAG_BACKGROUND
See Also:   EscherSpRecord.FLAG_HASSHAPETYPE



setShapeId
public void setShapeId(int field_1_shapeId)(Code)
Sets a number that identifies this shape.



toString
public String toString()(Code)
the string representing this shape.



Methods inherited from org.apache.poi.ddf.EscherRecord
public Object clone()(Code)(Java Doc)
public void display(PrintWriter w, int indent)(Code)(Java Doc)
protected int fillFields(byte[] data, EscherRecordFactory f)(Code)(Java Doc)
abstract public int fillFields(byte[] data, int offset, EscherRecordFactory recordFactory)(Code)(Java Doc)
public EscherRecord getChild(int index)(Code)(Java Doc)
public List getChildRecords()(Code)(Java Doc)
public short getInstance()(Code)(Java Doc)
public short getOptions()(Code)(Java Doc)
public short getRecordId()(Code)(Java Doc)
abstract public String getRecordName()(Code)(Java Doc)
abstract public int getRecordSize()(Code)(Java Doc)
public boolean isContainerRecord()(Code)(Java Doc)
protected int readHeader(byte[] data, int offset)(Code)(Java Doc)
public byte[] serialize()(Code)(Java Doc)
public int serialize(int offset, byte[] data)(Code)(Java Doc)
abstract public int serialize(int offset, byte[] data, EscherSerializationListener listener)(Code)(Java Doc)
public void setChildRecords(List childRecords)(Code)(Java Doc)
public void setOptions(short options)(Code)(Java Doc)
public void setRecordId(short recordId)(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.