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
All Implemented Interfaces:
org.apache.poi.common.Duplicatable, GenericRecord
public final class ProtectRecord extends StandardRecord
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).

  • Field Details

  • Constructor Details

    • ProtectRecord

      public ProtectRecord(boolean isProtected)

    • ProtectRecord

      public ProtectRecord(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)

    • 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 ProtectRecord copy()
      Specified by:
      copy in interface org.apache.poi.common.Duplicatable
      Specified by:
      copy in class StandardRecord

    • getGenericRecordType

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

    • getGenericProperties

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