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

public final Class HideObjRecord

extends StandardRecord
Class Inheritance
Imports
java.util.Map, java.util.function.Supplier, org.apache.poi.util.GenericRecordUtil, .LittleEndianOutput
Flag defines whether to hide placeholders and object
Version
2.0-pre

Field Summary

Modifier and TypeField and Description
private short
field_1_hide_obj

public static final short
HIDE_ALL

public static final short
SHOW_ALL

public static final short
SHOW_PLACEHOLDERS

public static final short
sid

Constructor Summary

AccessConstructor and Description
public
HideObjRecord()

public
HideObjRecord(HideObjRecord other)

public
HideObjRecord(RecordInputStream in)

Method Summary

Modifier and TypeMethod and Description
public HideObjRecord
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 short

Returns:

hide options
getHideObj()

get hide object options

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.

Write the data content of this BIFF record.

public void
setHideObj(short
options
hide)

set hide object options

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

Field Detail

field_1_hide_objback to summary
private short field_1_hide_obj
HIDE_ALLback to summary
public static final short HIDE_ALL
SHOW_ALLback to summary
public static final short SHOW_ALL
SHOW_PLACEHOLDERSback to summary
public static final short SHOW_PLACEHOLDERS
sidback to summary
public static final short sid

Constructor Detail

HideObjRecordback to summary
public HideObjRecord()
HideObjRecordback to summary
public HideObjRecord(HideObjRecord other)
HideObjRecordback to summary
public HideObjRecord(RecordInputStream in)

Method Detail

copyback to summary
public HideObjRecord copy()

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

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

Returns:HideObjRecord

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
getHideObjback to summary
public short getHideObj()

get hide object options

Returns:short

hide options

See Also
HIDE_ALL, SHOW_PLACEHOLDERS, SHOW_ALL
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.

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

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 org.apache.poi.hssf.record.Record#getRecordSize()} minus four ( record header consisting of a 'ushort sid' and 'ushort reclength' has already been written by their superclass).

Parameters
out:LittleEndianOutput

the output object

setHideObjback to summary
public void setHideObj(short hide)

set hide object options

Parameters
hide:short

options

See Also
HIDE_ALL, SHOW_PLACEHOLDERS, SHOW_ALL