Overview  Package   Class  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

org.apache.poi.hssf.record
Class ScenarioProtectRecord

java.lang.Object
  extended by org.apache.poi.hssf.record.RecordBase
      extended by org.apache.poi.hssf.record.Record
          extended by org.apache.poi.hssf.record.StandardRecord
              extended by org.apache.poi.hssf.record.ScenarioProtectRecord

public final class ScenarioProtectRecord
extends StandardRecord

Title: Scenario Protect Record

Description: 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.

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

Field Summary
static short sid
           
 
Constructor Summary
ScenarioProtectRecord()
           
ScenarioProtectRecord(RecordInputStream in)
           
 
Method Summary
 java.lang.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
 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(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

public java.lang.Object clone()
Overrides:
clone in class Record
Overview  Package   Class  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD