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

public final Class UserSViewBegin

extends StandardRecord
Class Inheritance
Imports
java.util.Arrays, .Map, java.util.function.Supplier, org.apache.poi.util.GenericRecordUtil, .LittleEndianOutput
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

Modifier and TypeField and Description
private byte[]
_rawData

public static final short
sid

Constructor Summary

AccessConstructor and Description
public
UserSViewBegin(UserSViewBegin other)

public
UserSViewBegin(byte[] data)

public
UserSViewBegin(RecordInputStream
the RecordInputstream to read the record from
in)

construct an UserSViewBegin record.

Method Summary

Modifier and TypeMethod and Description
public UserSViewBegin
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 byte[]

Returns:

Globally unique identifier for the custom view
getGuid()

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.

spit the record out AS IS.

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

Field Detail

_rawDataback to summary
private byte[] _rawData
sidback to summary
public static final short sid

Constructor Detail

UserSViewBeginback to summary
public UserSViewBegin(UserSViewBegin other)
UserSViewBeginback to summary
public UserSViewBegin(byte[] data)
UserSViewBeginback to summary
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:RecordInputStream

the RecordInputstream to read the record from

Method Detail

copyback to summary
public UserSViewBegin copy()

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

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

Returns:UserSViewBegin

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
getGuidback to summary
public byte[] getGuid()
Returns:byte[]

Globally unique identifier for the custom view

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.

spit the record out AS IS. no interpretation or identification

Parameters
out:LittleEndianOutput

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

the output object