org.apache.poi.hssf.record
Class WindowProtectRecord

java.lang.Object
  extended by org.apache.poi.hssf.record.RecordBase
      extended by org.apache.poi.hssf.record.Record
          extended by org.apache.poi.hssf.record.WindowProtectRecord

public class WindowProtectRecord
extends Record

Title: Window Protect Record

Description: flags whether workbook windows are protected

REFERENCE: PG 424 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)

Version:
2.0-pre
Author:
Andrew C. Oliver (acoliver at apache dot org)

Field Summary
static short sid
           
 
Constructor Summary
WindowProtectRecord()
           
WindowProtectRecord(RecordInputStream in)
           
 
Method Summary
 boolean getProtect()
          is this window protected or not
 int getRecordSize()
          gives the current serialized size of the record.
 short getSid()
          return the non static version of the id for this record.
 int serialize(int offset, byte[] data)
          called by the class that is responsible for writing this sucker.
 void setProtect(boolean protect)
          set whether this window should be protected or not
 java.lang.String toString()
          get a string representation of the record (for biffview/debugging)
 
Methods inherited from class org.apache.poi.hssf.record.Record
clone, cloneViaReserialise, serialize
 
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

sid

public static final short sid
See Also:
Constant Field Values
Constructor Detail

WindowProtectRecord

public WindowProtectRecord()

WindowProtectRecord

public WindowProtectRecord(RecordInputStream in)
Method Detail

setProtect

public void setProtect(boolean protect)
set whether this window should be protected or not

Parameters:
protect - or not

getProtect

public boolean getProtect()
is this window protected or not

Returns:
protected or not

toString

public java.lang.String toString()
Description copied from class: Record
get a string representation of the record (for biffview/debugging)

Overrides:
toString in class Record

serialize

public int serialize(int offset,
                     byte[] data)
Description copied from class: RecordBase
called by the class that is responsible for writing this sucker. Subclasses should implement this so that their data is passed back in a byte array.

Specified by:
serialize in class RecordBase
Parameters:
offset - to begin writing at
data - byte array containing instance data
Returns:
number of bytes written

getRecordSize

public int getRecordSize()
Description copied from class: Record
gives the current serialized size of the record. Should include the sid and reclength (4 bytes).

Overrides:
getRecordSize in class Record

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


Copyright 2008 The Apache Software Foundation or its licensors, as applicable.