Apache POI - Common 5.3.0 · org.apache.poi.hssf.record.aggregates.WorksheetProtectionBlock

Modifier and Type	Field and Description
private ObjectProtectRecord	_objectProtectRecord
private PasswordRecord	_passwordRecord
private ProtectRecord	_protectRecord
private ScenarioProtectRecord	_scenarioProtectRecord

Access	Constructor and Description
public	WorksheetProtectionBlock() Creates an empty WorksheetProtectionBlock

Method Summary

Modifier and Type	Method and Description
public void	addRecords(RecordStream rs) This method reads WorksheetProtectionBlock records from the supplied RecordStream until the first non-WorksheetProtectionBlock record is encountered.
private void	checkNotPresent(Record rec)
private static ObjectProtectRecord	createObjectProtect() creates an ObjectProtect record with protect set to false.
private static PasswordRecord	createPassword() creates a Password record with password set to 0x0000.
private static ScenarioProtectRecord	createScenarioProtect() creates a ScenarioProtect record with protect set to false.
public ScenarioProtectRecord	getHCenter()
private PasswordRecord	Returns: the PasswordRecord. If one is not contained in the sheet, then one is created. getPassword()
public int	getPasswordHash()
public PasswordRecord	getPasswordRecord()
private ProtectRecord	Returns: the ProtectRecord. If one is not contained in the sheet, then one is created. getProtect()
public static boolean	Returns: `true` if the specified Record sid is one belonging to the 'Page Settings Block'. isComponentRecord(int sid)
public boolean	isObjectProtected()
public boolean	isScenarioProtected()
public boolean	isSheetProtected()
public void	protectSheet(String to set. Pass `null` to remove all protection password, boolean are protected shouldProtectObjects, boolean are protected shouldProtectScenarios) protect a spreadsheet with a password (not encrypted, just sets protect flags and the password.
private boolean	readARecord(RecordStream rs)
public void	visitContainedRecords(RecordAggregate.RecordVisitor The visitor to use for callbacks while walking this object rv) Implements abstract org.apache.poi.hssf.record.aggregates.RecordAggregate.visitContainedRecords. Visit each of the atomic BIFF records contained in this RecordAggregate in the order that they should be written to file.
private static void	visitIfPresent(Record r, RecordAggregate.RecordVisitor rv)

Inherited from org.apache.poi.hssf.record.aggregates.RecordAggregate:: getRecordSize serialize

_objectProtectRecord	back to summary
private ObjectProtectRecord _objectProtectRecord

_passwordRecord	back to summary
private PasswordRecord _passwordRecord

_protectRecord	back to summary
private ProtectRecord _protectRecord

_scenarioProtectRecord	back to summary
private ScenarioProtectRecord _scenarioProtectRecord

WorksheetProtectionBlock	back to summary
public WorksheetProtectionBlock() Creates an empty WorksheetProtectionBlock

Method Detail

addRecords	back to summary
public void addRecords(RecordStream rs) This method reads WorksheetProtectionBlock records from the supplied RecordStream until the first non-WorksheetProtectionBlock record is encountered. As each record is read, it is incorporated into this WorksheetProtectionBlock. As per the OOO documentation, the protection block records can be expected to be written together (with no intervening records), but earlier versions of POI (prior to Jun 2009) didn't do this. Workbooks with sheet protection created by those earlier POI versions seemed to be valid (Excel opens them OK). So PO allows continues to support reading of files with non continuous worksheet protection blocks. Note - when POI writes out this WorksheetProtectionBlock, the records will always be written in one consolidated block (in the standard ordering) regardless of how scattered the records were when they were originally read.

addRecords

back to summary

public void addRecords(RecordStream rs)

This method reads WorksheetProtectionBlock records from the supplied RecordStream until the first non-WorksheetProtectionBlock record is encountered. As each record is read, it is incorporated into this WorksheetProtectionBlock.

As per the OOO documentation, the protection block records can be expected to be written together (with no intervening records), but earlier versions of POI (prior to Jun 2009) didn't do this. Workbooks with sheet protection created by those earlier POI versions seemed to be valid (Excel opens them OK). So PO allows continues to support reading of files with non continuous worksheet protection blocks.

Note

- when POI writes out this WorksheetProtectionBlock, the records will always be written in one consolidated block (in the standard ordering) regardless of how scattered the records were when they were originally read.

checkNotPresent	back to summary
private void checkNotPresent(Record rec)

createObjectProtect	back to summary
private static ObjectProtectRecord createObjectProtect() creates an ObjectProtect record with protect set to false.

createPassword	back to summary
private static PasswordRecord createPassword() creates a Password record with password set to 0x0000.

createScenarioProtect	back to summary
private static ScenarioProtectRecord createScenarioProtect() creates a ScenarioProtect record with protect set to false.

getHCenter	back to summary
public ScenarioProtectRecord getHCenter()

getPassword	back to summary
private PasswordRecord getPassword() Returns:PasswordRecord the PasswordRecord. If one is not contained in the sheet, then one is created.

getPasswordHash	back to summary
public int getPasswordHash()

getPasswordRecord	back to summary
public PasswordRecord getPasswordRecord()

getProtect	back to summary
private ProtectRecord getProtect() Returns:ProtectRecord the ProtectRecord. If one is not contained in the sheet, then one is created.

isComponentRecord	back to summary
public static boolean isComponentRecord(int sid) Returns:boolean `true` if the specified Record sid is one belonging to the 'Page Settings Block'.

isObjectProtected	back to summary
public boolean isObjectProtected()

isScenarioProtected	back to summary
public boolean isScenarioProtected()

isSheetProtected	back to summary
public boolean isSheetProtected()

protectSheet back to summary

protectSheet	back to summary
public void protectSheet(String password, boolean shouldProtectObjects, boolean shouldProtectScenarios) protect a spreadsheet with a password (not encrypted, just sets protect flags and the password. Parameters password:String to set. Pass `null` to remove all protection shouldProtectObjects:boolean are protected shouldProtectScenarios:boolean are protected

public void protectSheet(String password, boolean shouldProtectObjects, boolean shouldProtectScenarios)

protect a spreadsheet with a password (not encrypted, just sets protect flags and the password.

Parameters

password:String: to set. Pass null to remove all protection
shouldProtectObjects:boolean: are protected
shouldProtectScenarios:boolean: are protected

readARecord	back to summary
private boolean readARecord(RecordStream rs)

visitContainedRecords back to summary

visitContainedRecords	back to summary
public void visitContainedRecords(RecordAggregate.RecordVisitor rv) Implements abstract org.apache.poi.hssf.record.aggregates.RecordAggregate.visitContainedRecords. Doc from org.apache.poi.hssf.record.aggregates.RecordAggregate.visitContainedRecords. Visit each of the atomic BIFF records contained in this RecordAggregate in the order that they should be written to file. Implementors may or may not return the actual `Record`s being used to manage POI's internal implementation. Callers should not assume either way, and therefore only attempt to modify those `Record`s after cloning Parameters rv:RecordAggregate.RecordVisitor The visitor to use for callbacks while walking this object Annotations @Override

public void visitContainedRecords(RecordAggregate.RecordVisitor rv)

Implements abstract org.apache.poi.hssf.record.aggregates.RecordAggregate.visitContainedRecords.

Doc from org.apache.poi.hssf.record.aggregates.RecordAggregate.visitContainedRecords.

Visit each of the atomic BIFF records contained in this RecordAggregate in the order that they should be written to file. Implementors may or may not return the actual Records being used to manage POI's internal implementation. Callers should not assume either way, and therefore only attempt to modify those Records after cloning

Parameters

rv:RecordAggregate.RecordVisitor: The visitor to use for callbacks while walking this object

Annotations

@Override

visitIfPresent	back to summary
private static void visitIfPresent(Record r, RecordAggregate.RecordVisitor rv)

public final Class WorksheetProtectionBlock

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail