|
|||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||||
java.lang.Objectorg.apache.poi.hssf.record.Record
org.apache.poi.hssf.record.HideObjRecord
Title: Hide Object Record
Description: flag defines whether to hide placeholders and object
REFERENCE: PG 321 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
| Field Summary | |
static short |
HIDE_ALL
|
static short |
SHOW_ALL
|
static short |
SHOW_PLACEHOLDERS
|
static short |
sid
|
| Constructor Summary | |
HideObjRecord()
|
|
HideObjRecord(short id,
short size,
byte[] data)
Constructs an HideObj record and sets its fields appropriately. |
|
HideObjRecord(short id,
short size,
byte[] data,
int offset)
Constructs an HideObj record and sets its fields appropriately. |
|
| Method Summary | |
protected void |
fillFields(byte[] data,
short size,
int offset)
called by the constructor, should set class level fields. |
short |
getHideObj()
get hide object options |
int |
getRecordSize()
gives the current serialized size of the record. |
short |
getSid()
return the non static version of the id for this record. |
int |
serialize(int offset,
byte[] data)
called by the class that is responsible for writing this sucker. |
void |
setHideObj(short hide)
set hide object options |
java.lang.String |
toString()
get a string representation of the record (for biffview/debugging) |
protected void |
validateSid(short id)
called by constructor, should throw runtime exception in the event of a record passed with a differing ID. |
| Methods inherited from class org.apache.poi.hssf.record.Record |
clone, fillFields, isInValueSection, isValue, processContinueRecord, serialize |
| Methods inherited from class java.lang.Object |
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
| Field Detail |
public static final short sid
public static final short HIDE_ALL
public static final short SHOW_PLACEHOLDERS
public static final short SHOW_ALL
| Constructor Detail |
public HideObjRecord()
public HideObjRecord(short id,
short size,
byte[] data)
id - id must be 0x8d or an exception will be throw upon validationsize - the size of the data area of the recorddata - data of the record (should not contain sid/len)
public HideObjRecord(short id,
short size,
byte[] data,
int offset)
id - id must be 0x8d or an exception will be throw upon validationsize - the size of the data area of the recorddata - data of the record (should not contain sid/len)offset - of the record's data| Method Detail |
protected void validateSid(short id)
Record
validateSid in class Recordid - alleged id for this record
protected void fillFields(byte[] data,
short size,
int offset)
Record
fillFields in class Recorddata - raw datasize - size of dataoffset - of the record's data (provided a big array of the file)public void setHideObj(short hide)
hide - optionsHIDE_ALL,
SHOW_PLACEHOLDERS,
SHOW_ALLpublic short getHideObj()
HIDE_ALL,
SHOW_PLACEHOLDERS,
SHOW_ALLpublic java.lang.String toString()
Record
toString in class Record
public int serialize(int offset,
byte[] data)
Record
serialize in class Recordoffset - to begin writing atdata - byte array containing instance data
public int getRecordSize()
Record
getRecordSize in class Recordpublic short getSid()
Record
getSid in class Record
|
|||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||||