Package 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, GenericRecord
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 Details

  • Constructor Details

    • ScenarioProtectRecord

      public ScenarioProtectRecord()

    • ScenarioProtectRecord

      public ScenarioProtectRecord(ScenarioProtectRecord other)

    • ScenarioProtectRecord

      public ScenarioProtectRecord(RecordInputStream in)

  • 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

    • 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

    • 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

    • getGenericRecordType

      public HSSFRecordTypes getGenericRecordType()
      Specified by:
      getGenericRecordType in interface GenericRecord
      Specified by:
      getGenericRecordType in class Record

    • getGenericProperties

      public Map<String,Supplier<?>> getGenericProperties()