org.apache.poi.hssf.record

Class ScenarioProtectRecord

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.ScenarioProtectRecord

All Implemented Interfaces:

Duplicatable

public final class ScenarioProtectRecord
extends StandardRecord

I have no idea what a Scenario is or why on would want to protect it with the lamest "security" ever invented. However this record tells excel "I want to protect my scenarios" (0xAF) with lame security. It appears in conjunction with the PASSWORD and PROTECT records as well as its object protect cousin.

Field Summary

Fields

Modifier and Type	Field and Description
static short	sid

Constructor Summary

Constructors

Constructor and Description
ScenarioProtectRecord()
ScenarioProtectRecord(RecordInputStream in)
ScenarioProtectRecord(ScenarioProtectRecord other)

Method Summary

Modifier and Type	Method and Description
ScenarioProtectRecord	clone() Deprecated.
ScenarioProtectRecord	copy()
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
java.lang.String	toString() 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

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

ScenarioProtectRecord

public ScenarioProtectRecord()

ScenarioProtectRecord

public ScenarioProtectRecord(ScenarioProtectRecord other)

ScenarioProtectRecord

public ScenarioProtectRecord(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 java.lang.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 consisting of a 'ushort sid' and 'ushort reclength' has already been written by their superclass).

Specified by:

serialize in class StandardRecord

Parameters:

out - the output object

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

Returns:

he id for this record

clone

@Deprecated
 @Removal(version="5.0.0")
public ScenarioProtectRecord clone()

Deprecated.

Overrides:

clone in class java.lang.Object

copy

public ScenarioProtectRecord copy()

Specified by:

copy in interface Duplicatable

Specified by:

copy in class StandardRecord

Returns:

a deep copy of the implementing class / instance