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

EscherBSERecord
public class EscherBSERecord extends EscherRecord (Code)
The BSE record is related closely to the EscherBlipRecord and stores extra information about the blip. A blip record is actually stored inside the BSE record even though the BSE record isn't actually a container record.
author:
   Glen Stampoultzis
See Also:   EscherBlipRecord


Field Summary
final public static  byteBT_DIB
    
final public static  byteBT_EMF
    
final public static  byteBT_ERROR
    
final public static  byteBT_JPEG
    
final public static  byteBT_PICT
    
final public static  byteBT_PNG
    
final public static  byteBT_UNKNOWN
    
final public static  byteBT_WMF
    
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  EscherBlipRecordgetBlipRecord()
    
public  StringgetBlipType(byte b)
     Retrieve the string representation given a blip id.
public  bytegetBlipTypeMacOS()
     The expected blip type under MacOS (failure to match this blip type will result in Excel converting to this format).
public  bytegetBlipTypeWin32()
     The expected blip type under windows (failure to match this blip type will result in Excel converting to this format).
public  bytegetName()
     The length in characters of the blip name.
public  intgetOffset()
     File offset in the delay stream.
public  StringgetRecordName()
    
public  intgetRecordSize()
     Returns the number of bytes that are required to serialize this record.
public  intgetRef()
     The reference count of this blip.
public  byte[]getRemainingData()
     Any remaining data in this record.
public  intgetSize()
     Blip size in stream.
public  shortgetTag()
    
public  byte[]getUid()
     16 byte MD4 checksum.
public  bytegetUnused2()
    
public  bytegetUnused3()
    
public  bytegetUsage()
     Defines the way this blip is used.
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  voidsetBlipRecord(EscherBlipRecord field_12_blipRecord)
    
public  voidsetBlipTypeMacOS(byte blipTypeMacOS)
    
public  voidsetBlipTypeWin32(byte blipTypeWin32)
    
public  voidsetName(byte name)
     The length in characters of the blip name.
public  voidsetOffset(int offset)
     File offset in the delay stream.
public  voidsetRef(int ref)
     The reference count of this blip.
public  voidsetRemainingData(byte[] remainingData)
     Any remaining data in this record.
public  voidsetSize(int size)
     Blip size in stream.
public  voidsetTag(short tag)
    
public  voidsetUid(byte[] uid)
     16 byte MD4 checksum.
public  voidsetUnused2(byte unused2)
    
public  voidsetUnused3(byte unused3)
    
public  voidsetUsage(byte usage)
     Defines the way this blip is used.
public  StringtoString()
    

Field Detail
BT_DIB
final public static byte BT_DIB(Code)



BT_EMF
final public static byte BT_EMF(Code)



BT_ERROR
final public static byte BT_ERROR(Code)



BT_JPEG
final public static byte BT_JPEG(Code)



BT_PICT
final public static byte BT_PICT(Code)



BT_PNG
final public static byte BT_PNG(Code)



BT_UNKNOWN
final public static byte BT_UNKNOWN(Code)



BT_WMF
final public static byte BT_WMF(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.



getBlipRecord
public EscherBlipRecord getBlipRecord()(Code)



getBlipType
public String getBlipType(byte b)(Code)
Retrieve the string representation given a blip id.



getBlipTypeMacOS
public byte getBlipTypeMacOS()(Code)
The expected blip type under MacOS (failure to match this blip type will result in Excel converting to this format).



getBlipTypeWin32
public byte getBlipTypeWin32()(Code)
The expected blip type under windows (failure to match this blip type will result in Excel converting to this format).



getName
public byte getName()(Code)
The length in characters of the blip name.



getOffset
public int getOffset()(Code)
File offset in the delay stream.



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



getRef
public int getRef()(Code)
The reference count of this blip.



getRemainingData
public byte[] getRemainingData()(Code)
Any remaining data in this record.



getSize
public int getSize()(Code)
Blip size in stream.



getTag
public short getTag()(Code)
unused



getUid
public byte[] getUid()(Code)
16 byte MD4 checksum.



getUnused2
public byte getUnused2()(Code)



getUnused3
public byte getUnused3()(Code)



getUsage
public byte getUsage()(Code)
Defines the way this blip is used.



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



setBlipRecord
public void setBlipRecord(EscherBlipRecord field_12_blipRecord)(Code)



setBlipTypeMacOS
public void setBlipTypeMacOS(byte blipTypeMacOS)(Code)
Set the expected MacOS blip type



setBlipTypeWin32
public void setBlipTypeWin32(byte blipTypeWin32)(Code)
Set the expected win32 blip type



setName
public void setName(byte name)(Code)
The length in characters of the blip name.



setOffset
public void setOffset(int offset)(Code)
File offset in the delay stream.



setRef
public void setRef(int ref)(Code)
The reference count of this blip.



setRemainingData
public void setRemainingData(byte[] remainingData)(Code)
Any remaining data in this record.



setSize
public void setSize(int size)(Code)
Blip size in stream.



setTag
public void setTag(short tag)(Code)
unused



setUid
public void setUid(byte[] uid)(Code)
16 byte MD4 checksum.



setUnused2
public void setUnused2(byte unused2)(Code)



setUnused3
public void setUnused3(byte unused3)(Code)



setUsage
public void setUsage(byte usage)(Code)
Defines the way this blip is used.



toString
public String toString()(Code)
Calculate the string representation of this object



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.