Save This Page
Home » cocoon-2.1.11-src » org.apache.cocoon.poi » hssf » record » [javadoc | source]
org.apache.cocoon.poi.hssf.record
public class: BoundSheetRecord [javadoc | source]
java.lang.Object
   org.apache.cocoon.poi.hssf.record.Record
      org.apache.cocoon.poi.hssf.record.BoundSheetRecord
Title: Bound Sheet Record (aka BundleSheet)

Description: Defines a sheet within a workbook. Basically stores the sheetname and tells where the Beginning of file record is within the HSSF file.

Copyright: Copyright (c) 2001 SuperLink Software, Inc.

REFERENCE: PG 291 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)

Field Summary
public static final  short sid     
Fields inherited from org.apache.cocoon.poi.hssf.record.Record:
sid
Constructor:
 public BoundSheetRecord() 
 public BoundSheetRecord(short id,
    short size,
    byte[] data) 
 public BoundSheetRecord(short id,
    short size,
    byte[] data,
    int offset) 
Method from org.apache.cocoon.poi.hssf.record.BoundSheetRecord Summary:
fillFields,   getCompressedUnicodeFlag,   getOptionFlags,   getPositionOfBof,   getSheetname,   getSheetnameLength,   getSid,   serialize,   setCompressedUnicodeFlag,   setOptionFlags,   setPositionOfBof,   setSheetname,   setSheetnameLength,   toString,   validateSid
Methods from org.apache.cocoon.poi.hssf.record.Record:
fillFields,   fillFields,   getRecordSize,   getSid,   isInValueSection,   isValue,   processContinueRecord,   serialize,   toString,   validateSid
Methods from java.lang.Object:
equals,   getClass,   hashCode,   notify,   notifyAll,   toString,   wait,   wait,   wait
Method from org.apache.cocoon.poi.hssf.record.BoundSheetRecord Detail:
 protected  void fillFields(byte[] data,
    short size,
    int offset) 
 public byte getCompressedUnicodeFlag() 
    get whether or not to interperate the Sheetname as compressed unicode (8/16 bit) (This is undocumented but can be found as Q187919 on the Microsoft(tm) Support site)
 public short getOptionFlags() 
    get the option flags (unimportant for HSSF supported sheets)
 public int getPositionOfBof() 
    get the offset in bytes of the Beginning of File Marker within the HSSF Stream part of the POIFS file
 public String getSheetname() 
    get the sheetname for this sheet. (this appears in the tabs at the bottom)
 public byte getSheetnameLength() 
    get the length of the sheetname in characters
 public short getSid() 
 public byte[] serialize() 
 public  void setCompressedUnicodeFlag(byte flag) 
    set whether or not to interperate the Sheetname as compressed unicode (8/16 bit) (This is undocumented but can be found as Q187919 on the Microsoft(tm) Support site)
 public  void setOptionFlags(short flags) 
    set the option flags (unimportant for HSSF supported sheets)
 public  void setPositionOfBof(int pos) 
    set the offset in bytes of the Beginning of File Marker within the HSSF Stream part of the POIFS file
 public  void setSheetname(String sheetname) 
    Set the sheetname for this sheet. (this appears in the tabs at the bottom)
 public  void setSheetnameLength(byte len) 
    Set the length of the sheetname in characters
 public String toString() 
 protected  void validateSid(short id)