Package org.apache.poi.hssf.record
Class ProtectRecord
java.lang.Object
org.apache.poi.hssf.record.RecordBase
org.apache.poi.hssf.record.Record
org.apache.poi.hssf.record.StandardRecord
org.apache.poi.hssf.record.ProtectRecord
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)
-
Field Summary
Fields -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionclone()
protected int
boolean
get whether the sheet is protected or notshort
getSid()
return the non static version of the id for this record.void
Write the data content of this BIFF record.void
setProtect
(boolean protect) set whether the sheet is protected or nottoString()
get a string representation of the record (for biffview/debugging)Methods inherited from class org.apache.poi.hssf.record.StandardRecord
getRecordSize, serialize
Methods inherited from class org.apache.poi.hssf.record.Record
cloneViaReserialise, serialize
-
Field Details
-
sid
public static final short sid- See Also:
-
-
Constructor Details
-
ProtectRecord
public ProtectRecord(boolean isProtected) -
ProtectRecord
-
-
Method Details
-
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
Description copied from class:Record
get a string representation of the record (for biffview/debugging) -
serialize
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 consisting of a 'ushort sid' and 'ushort reclength' has already been written by their superclass).- Specified by:
serialize
in classStandardRecord
- Parameters:
out
- the output object
-
getDataSize
protected int getDataSize()- Specified by:
getDataSize
in classStandardRecord
-
getSid
public short getSid()Description copied from class:Record
return the non static version of the id for this record. -
clone
-