org.apache.poi.hssf.record

Class UserSViewBegin

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.UserSViewBegin

All Implemented Interfaces:

Duplicatable

public final class UserSViewBegin
extends StandardRecord

The UserSViewBegin record specifies settings for a custom view associated with the sheet. This record also marks the start of custom view records, which save custom view settings. Records between UserSViewBegin and UserSViewEnd contain settings for the custom view, not settings for the sheet itself.

Field Summary

Fields

Modifier and Type	Field and Description
static short	sid

Constructor Summary

Constructors

Constructor and Description
UserSViewBegin(byte[] data)
UserSViewBegin(RecordInputStream in) construct an UserSViewBegin record.
UserSViewBegin(UserSViewBegin other)

Method Summary

Modifier and Type	Method and Description
UserSViewBegin	clone() Deprecated.
UserSViewBegin	copy()
protected int	getDataSize()
byte[]	getGuid()
short	getSid() return the non static version of the id for this record.
void	serialize(LittleEndianOutput out) spit the record out AS IS.
java.lang.String	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

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

UserSViewBegin

public UserSViewBegin(UserSViewBegin other)

UserSViewBegin

public UserSViewBegin(byte[] data)

UserSViewBegin

public UserSViewBegin(RecordInputStream in)

construct an UserSViewBegin record. No fields are interpreted and the record will be serialized in its original form more or less

Parameters:

in - the RecordInputstream to read the record from

Method Detail

serialize

public void serialize(LittleEndianOutput out)

spit the record out AS IS. no interpretation or identification

Specified by:

serialize in class StandardRecord

Parameters:

out - the output object

getDataSize

protected int getDataSize()

Specified by:

getDataSize in class StandardRecord

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

getGuid

public byte[] getGuid()

Returns:

Globally unique identifier for the custom view

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

clone

@Deprecated
 @Removal(version="5.0.0")
public UserSViewBegin clone()

Deprecated.

Overrides:

clone in class java.lang.Object

copy

public UserSViewBegin copy()

Specified by:

copy in interface Duplicatable

Specified by:

copy in class StandardRecord

Returns:

a deep copy of the implementing class / instance