Package org.apache.poi.hssf.record
Class FileSharingRecord
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.FileSharingRecord
- All Implemented Interfaces:
Cloneable
Title: FILESHARING (0x005B)
Description: stores the encrypted readonly for a workbook (write protect) This functionality is accessed from the options dialog box available when performing 'Save As'.
REFERENCE: PG 314 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
-
Field Summary
Fields -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionclone()
protected int
short
short
get the readonlyshort
getSid()
return the non static version of the id for this record.void
Write the data content of this BIFF record.void
setPassword
(short password) void
setReadOnly
(short readonly) set the readonly flagvoid
setUsername
(String username) 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
-
Field Details
-
sid
public static final short sid- See Also:
-
-
Constructor Details
-
FileSharingRecord
public FileSharingRecord() -
FileSharingRecord
-
-
Method Details
-
setReadOnly
public void setReadOnly(short readonly) set the readonly flag- Parameters:
readonly
- 1 for true, not 1 for false
-
getReadOnly
public short getReadOnly()get the readonly- Returns:
- short representing if this is read only (1 = true)
-
setPassword
public void setPassword(short password) - Parameters:
password
- hashed password
-
getPassword
public short getPassword()- Returns:
- password hashed with hashPassword() (very lame)
-
getUsername
- Returns:
- username of the user that created the file
-
setUsername
- Parameters:
username
- of the user that created the file
-
toString
Description copied from class:Record
get a string representation of the record (for biffview/debugging) -
serialize
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 classStandardRecord
- Parameters:
out
- the output object
-
getDataSize
protected int getDataSize()- Specified by:
getDataSize
in classStandardRecord
-
getSid
public short getSid()Description copied from class:Record
return the non static version of the id for this record. -
clone
-