Top Description Fields Constructors Methods
org.apache.poi.hssf.record

public final Class WindowProtectRecord

extends StandardRecord
Class Inheritance
Imports
java.util.Map, java.util.function.Supplier, org.apache.poi.util.BitField, .BitFieldFactory, .GenericRecordUtil, .LittleEndianOutput
Flags whether workbook windows are protected

Field Summary

Modifier and TypeField and Description
private int
_options

private static final BitField
settingsProtectedFlag

public static final short
sid

Constructor Summary

AccessConstructor and Description
public
WindowProtectRecord(int options)

public
WindowProtectRecord(WindowProtectRecord other)

public
WindowProtectRecord(RecordInputStream in)

public
WindowProtectRecord(boolean protect)

Method Summary

Modifier and TypeMethod and Description
public WindowProtectRecord
copy()

Implements abstract org.apache.poi.hssf.record.StandardRecord.copy.

Implements org.apache.poi.common.Duplicatable.copy.

protected int
getDataSize()

Implements abstract org.apache.poi.hssf.record.StandardRecord.getDataSize.

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

Implements org.apache.poi.common.usermodel.GenericRecord.getGenericProperties.

public HSSFRecordTypes
getGenericRecordType()

Overrides default org.apache.poi.common.usermodel.GenericRecord.getGenericRecordType.

Implements abstract org.apache.poi.hssf.record.Record.getGenericRecordType.

public boolean

Returns:

protected or not
getProtect()

is this window protected or not

public short
getSid()

Implements abstract org.apache.poi.hssf.record.Record.getSid.

return the non static version of the id for this record.

public void
serialize(LittleEndianOutput
the output object
out)

Implements abstract org.apache.poi.hssf.record.StandardRecord.serialize.

Write the data content of this BIFF record.

public void
setProtect(boolean
or not
protect)

set whether this window should be protected or not

Inherited from org.apache.poi.hssf.record.StandardRecord:
getRecordSizeserialize

Field Detail

_optionsback to summary
private int _options
settingsProtectedFlagback to summary
private static final BitField settingsProtectedFlag
sidback to summary
public static final short sid

Constructor Detail

WindowProtectRecordback to summary
public WindowProtectRecord(int options)
WindowProtectRecordback to summary
public WindowProtectRecord(WindowProtectRecord other)
WindowProtectRecordback to summary
public WindowProtectRecord(RecordInputStream in)
WindowProtectRecordback to summary
public WindowProtectRecord(boolean protect)

Method Detail

copyback to summary
public WindowProtectRecord copy()

Implements abstract org.apache.poi.hssf.record.StandardRecord.copy.

Implements org.apache.poi.common.Duplicatable.copy.

Returns:WindowProtectRecord

Doc from org.apache.poi.common.Duplicatable.copy.

a deep copy of the implementing class / instance

Annotations
@Override
getDataSizeback to summary
protected int getDataSize()

Implements abstract org.apache.poi.hssf.record.StandardRecord.getDataSize.

getGenericPropertiesback to summary
public Map<String, Supplier<?>> getGenericProperties()

Implements org.apache.poi.common.usermodel.GenericRecord.getGenericProperties.

Annotations
@Override
getGenericRecordTypeback to summary
public HSSFRecordTypes getGenericRecordType()

Overrides default org.apache.poi.common.usermodel.GenericRecord.getGenericRecordType.

Implements abstract org.apache.poi.hssf.record.Record.getGenericRecordType.

Annotations
@Override
getProtectback to summary
public boolean getProtect()

is this window protected or not

Returns:boolean

protected or not

getSidback to summary
public short getSid()

Implements abstract org.apache.poi.hssf.record.Record.getSid.

Doc from org.apache.poi.hssf.record.Record.getSid.

return the non static version of the id for this record.

Returns:short

he id for this record

serializeback to summary
public void serialize(LittleEndianOutput out)

Implements abstract org.apache.poi.hssf.record.StandardRecord.serialize.

Doc from org.apache.poi.hssf.record.StandardRecord.serialize.

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 org.apache.poi.hssf.record.Record#getRecordSize()} minus four ( record header consisting of a 'ushort sid' and 'ushort reclength' has already been written by their superclass).

Parameters
out:LittleEndianOutput

the output object

setProtectback to summary
public void setProtect(boolean protect)

set whether this window should be protected or not

Parameters
protect:boolean

or not