org.zkoss.poi.hssf.record

Class ProtectRecord

java.lang.Object

org.zkoss.poi.hssf.record.RecordBase

org.zkoss.poi.hssf.record.Record

org.zkoss.poi.hssf.record.StandardRecord

org.zkoss.poi.hssf.record.ProtectRecord

public final class ProtectRecord
extends StandardRecord

Title: Protect Record (0x0012)

Description: defines whether a sheet or workbook is protected (HSSF DOES NOT SUPPORT ENCRYPTION)

HSSF now supports the simple "protected" sheets (where they are not encrypted and open office et al ignore the password record entirely). REFERENCE: PG 373 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)

Author:

Andrew C. Oliver (acoliver at apache dot org)

Field Summary

Fields

Modifier and Type	Field and Description
static short	sid

Constructor Summary

Constructors

Constructor and Description
ProtectRecord(boolean isProtected)
ProtectRecord(RecordInputStream in)

Method Summary

Modifier and Type	Method and Description
Object	clone()
protected int	getDataSize()
boolean	getProtect() get whether the sheet is protected or not
short	getSid() return the non static version of the id for this record.
void	serialize(LittleEndianOutput out) Write the data content of this BIFF record.
void	setProtect(boolean protect) set whether the sheet is protected or not
String	toString() get a string representation of the record (for biffview/debugging)

Methods inherited from class org.zkoss.poi.hssf.record.StandardRecord

getRecordSize, serialize

Methods inherited from class org.zkoss.poi.hssf.record.Record

cloneViaReserialise, serialize

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

sid

public static final short sid

See Also:

Constant Field Values

Constructor Detail

ProtectRecord

public ProtectRecord(boolean isProtected)

ProtectRecord

public ProtectRecord(RecordInputStream in)

Method Detail

setProtect

public void setProtect(boolean protect)

set whether the sheet is protected or not

Parameters:

protect - whether to protect the sheet or not

getProtect

public boolean getProtect()

get whether the sheet is protected or not

Returns:

whether to protect the sheet or not

toString

public String toString()

Description copied from class: Record

get a string representation of the record (for biffview/debugging)

Overrides:

toString in class Record

serialize

public void serialize(LittleEndianOutput out)

Description copied from class: StandardRecord

Write the data content of this BIFF record. The 'ushort sid' and 'ushort size' header fields have already been written by the superclass.
The number of bytes written must equal the record size reported by RecordBase.getRecordSize()} minus four ( record header consiting of a 'ushort sid' and 'ushort reclength' has already been written by thye superclass).

Specified by:

serialize in class StandardRecord

getDataSize

protected int getDataSize()

Specified by:

getDataSize in class StandardRecord

getSid

public short getSid()

Description copied from class: Record

return the non static version of the id for this record.

Specified by:

getSid in class Record

clone

public Object clone()

Overrides:

clone in class Record