Apache POI - Common 5.3.0 · org.apache.poi.hssf.record.StyleRecord

Field Summary

Modifier and Type	Field and Description
private int	field_1_xf_index shared by both user defined and built-in styles
private int	field_2_builtin_style
private int	field_3_outline_style_level
private boolean	field_3_stringHasMultibyte
private String	field_4_name
private static final BitField	isBuiltinFlag
public static final short	sid
private static final BitField	styleIndexMask

Constructor Summary

Access	Constructor and Description
public	StyleRecord() creates a new style record, initially set to 'built-in'
public	StyleRecord(StyleRecord other)
public	StyleRecord(RecordInputStream in)

Method Summary

Modifier and Type	Method and Description
public StyleRecord	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 String	Returns: name of the style getName() get the style's name
public short	getSid() Implements abstract org.apache.poi.hssf.record.Record.getSid. return the non static version of the id for this record.
public int	Returns: index of the xf record getXFIndex() get the actual index of the style extended format record
public boolean	isBuiltin()
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	setBuiltinStyle(int style number (0-7) builtinStyleId) if this is a builtin style set the number of the built in style
public void	setName(String of the style name) set the style's name
public void	setOutlineStyleLevel(int The outline-level level) set the row or column level of the style (if builtin 1\|\|2)
public void	setXFIndex(int of the xf record xfIndex) set the actual index of the style extended format record

Inherited from org.apache.poi.hssf.record.StandardRecord:: getRecordSize serialize

Field Detail

field_1_xf_index	back to summary
private int field_1_xf_index shared by both user defined and built-in styles

field_2_builtin_style	back to summary
private int field_2_builtin_style

field_3_outline_style_level	back to summary
private int field_3_outline_style_level

field_3_stringHasMultibyte	back to summary
private boolean field_3_stringHasMultibyte

field_4_name	back to summary
private String field_4_name

isBuiltinFlag	back to summary
private static final BitField isBuiltinFlag

sid	back to summary
public static final short sid

styleIndexMask	back to summary
private static final BitField styleIndexMask

Constructor Detail

StyleRecord	back to summary
public StyleRecord() creates a new style record, initially set to 'built-in'

StyleRecord	back to summary
public StyleRecord(StyleRecord other)

StyleRecord	back to summary
public StyleRecord(RecordInputStream in)

Method Detail

copy	back to summary
public StyleRecord copy() Implements abstract org.apache.poi.hssf.record.StandardRecord.copy. Implements org.apache.poi.common.Duplicatable.copy. Returns:StyleRecord Doc from org.apache.poi.common.Duplicatable.copy. a deep copy of the implementing class / instance Annotations @Override

copy

back to summary

public StyleRecord copy()

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

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

Returns:StyleRecord

Doc from org.apache.poi.common.Duplicatable.copy.

a deep copy of the implementing class / instance

Annotations

@Override

getDataSize	back to summary
protected int getDataSize() Implements abstract org.apache.poi.hssf.record.StandardRecord.getDataSize. Annotations @Override

getDataSize

back to summary

protected int getDataSize()

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

Annotations

@Override

getGenericProperties	back to summary
public Map<String, Supplier<?>> getGenericProperties() Implements org.apache.poi.common.usermodel.GenericRecord.getGenericProperties. Annotations @Override

getGenericProperties

back to summary

public Map<String, Supplier<?>> getGenericProperties()

Implements org.apache.poi.common.usermodel.GenericRecord.getGenericProperties.

Annotations

@Override

getGenericRecordType	back 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

getGenericRecordType

back 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

getName	back to summary
public String getName() get the style's name Returns:String name of the style

getName

back to summary

public String getName()

get the style's name

Returns:String: name of the style

getSid	back 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 Annotations @Override

getSid

back 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

Annotations

@Override

getXFIndex back to summary

getXFIndex	back to summary
public int getXFIndex() get the actual index of the style extended format record Returns:int index of the xf record See Also `getXFIndex()`

public int getXFIndex()

get the actual index of the style extended format record

Returns:int: index of the xf record
See Also: getXFIndex()

isBuiltin	back to summary
public boolean isBuiltin()

serialize back to summary

serialize	back 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 Annotations @Override

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

Annotations

@Override

setBuiltinStyle	back to summary
public void setBuiltinStyle(int builtinStyleId) if this is a builtin style set the number of the built in style Parameters builtinStyleId:int style number (0-7)

setBuiltinStyle

back to summary

public void setBuiltinStyle(int builtinStyleId)

if this is a builtin style set the number of the built in style

Parameters

builtinStyleId:int: style number (0-7)

setName	back to summary
public void setName(String name) set the style's name Parameters name:String of the style

setName

back to summary

public void setName(String name)

set the style's name

Parameters

name:String: of the style

setOutlineStyleLevel	back to summary
public void setOutlineStyleLevel(int level) set the row or column level of the style (if builtin 1\|\|2) Parameters level:int The outline-level

setOutlineStyleLevel

back to summary

public void setOutlineStyleLevel(int level)

set the row or column level of the style (if builtin 1||2)

Parameters

level:int: The outline-level

setXFIndex	back to summary
public void setXFIndex(int xfIndex) set the actual index of the style extended format record Parameters xfIndex:int of the xf record

setXFIndex

back to summary

public void setXFIndex(int xfIndex)

set the actual index of the style extended format record

Parameters

xfIndex:int: of the xf record

public final Class StyleRecord

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail