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

public final Class TickRecord

extends StandardRecord
Class Inheritance
Static Imports
org.apache.poi.util.GenericRecordUtil.getBitsAsString
The Tick record defines how tick marks and label positioning/formatting

Field Summary

Modifier and TypeField and Description
private static final BitField
autorotate

private static final BitField
autoTextBackground

private static final BitField
autoTextColor

private short
field_10_options

private short
field_11_tickColor

private short
field_12_zero5

private byte
field_1_majorTickType

private byte
field_2_minorTickType

private byte
field_3_labelPosition

private byte
field_4_background

private int
field_5_labelColorRgb

private int
field_6_zero1

private int
field_7_zero2

private int
field_8_zero3

private int
field_9_zero4

private static final BitField
rotation

public static final short
sid

Constructor Summary

AccessConstructor and Description
public
TickRecord()

public
TickRecord(TickRecord other)

public
TickRecord(RecordInputStream in)

Method Summary

Modifier and TypeMethod and Description
public TickRecord
copy()

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

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

public byte
getBackground()

Get the background field for the Tick record.

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 int
getLabelColorRgb()

Get the label color rgb field for the Tick record.

public byte
getLabelPosition()

Get the label position field for the Tick record.

public byte
getMajorTickType()

Get the major tick type field for the Tick record.

public byte
getMinorTickType()

Get the minor tick type field for the Tick record.

public short
getOptions()

Get the options field for the Tick record.

public short

Returns:

the rotation field value.
getRotation()

rotate text (0=none, 1=normal, 2=90 degrees counterclockwise, 3=90 degrees clockwise)

public short
getSid()

Implements abstract org.apache.poi.hssf.record.Record.getSid.

return the non static version of the id for this record.

public short
getTickColor()

Get the tick color field for the Tick record.

public int
getZero1()

Get the zero 1 field for the Tick record.

public int
getZero2()

Get the zero 2 field for the Tick record.

public short
getZero3()

Get the zero 3 field for the Tick record.

public boolean

Returns:

the autorotate field value.
isAutorotate()

automatically rotate the text

public boolean

Returns:

the auto text background field value.
isAutoTextBackground()

use the quote unquote automatic color for text background

public boolean

Returns:

the auto text color field value.
isAutoTextColor()

use the quote unquote automatic color for text

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
setAutorotate(boolean value)

Sets the autorotate field value.

public void
setAutoTextBackground(boolean value)

Sets the auto text background field value.

public void
setAutoTextColor(boolean value)

Sets the auto text color field value.

public void
setBackground(byte field_4_background)

Set the background field for the Tick record.

public void
setLabelColorRgb(int field_5_labelColorRgb)

Set the label color rgb field for the Tick record.

public void
setLabelPosition(byte field_3_labelPosition)

Set the label position field for the Tick record.

public void
setMajorTickType(byte field_1_majorTickType)

Set the major tick type field for the Tick record.

public void
setMinorTickType(byte field_2_minorTickType)

Set the minor tick type field for the Tick record.

public void
setOptions(short field_10_options)

Set the options field for the Tick record.

public void
setRotation(short value)

Sets the rotation field value.

public void
setTickColor(short field_11_tickColor)

Set the tick color field for the Tick record.

public void
setZero1(int field_6_zero1)

Set the zero 1 field for the Tick record.

public void
setZero2(int field_7_zero2)

Set the zero 2 field for the Tick record.

public void
setZero3(short field_12_zero3)

Set the zero 3 field for the Tick record.

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

Field Detail

autorotateback to summary
private static final BitField autorotate
autoTextBackgroundback to summary
private static final BitField autoTextBackground
autoTextColorback to summary
private static final BitField autoTextColor
field_10_optionsback to summary
private short field_10_options
field_11_tickColorback to summary
private short field_11_tickColor
field_12_zero5back to summary
private short field_12_zero5
field_1_majorTickTypeback to summary
private byte field_1_majorTickType
field_2_minorTickTypeback to summary
private byte field_2_minorTickType
field_3_labelPositionback to summary
private byte field_3_labelPosition
field_4_backgroundback to summary
private byte field_4_background
field_5_labelColorRgbback to summary
private int field_5_labelColorRgb
field_6_zero1back to summary
private int field_6_zero1
field_7_zero2back to summary
private int field_7_zero2
field_8_zero3back to summary
private int field_8_zero3
field_9_zero4back to summary
private int field_9_zero4
rotationback to summary
private static final BitField rotation
sidback to summary
public static final short sid

Constructor Detail

TickRecordback to summary
public TickRecord()
TickRecordback to summary
public TickRecord(TickRecord other)
TickRecordback to summary
public TickRecord(RecordInputStream in)

Method Detail

copyback to summary
public TickRecord copy()

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

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

Returns:TickRecord

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

a deep copy of the implementing class / instance

Annotations
@Override
getBackgroundback to summary
public byte getBackground()

Get the background field for the Tick record.

getDataSizeback to summary
protected int getDataSize()

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

Annotations
@Override
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
getLabelColorRgbback to summary
public int getLabelColorRgb()

Get the label color rgb field for the Tick record.

getLabelPositionback to summary
public byte getLabelPosition()

Get the label position field for the Tick record.

getMajorTickTypeback to summary
public byte getMajorTickType()

Get the major tick type field for the Tick record.

getMinorTickTypeback to summary
public byte getMinorTickType()

Get the minor tick type field for the Tick record.

getOptionsback to summary
public short getOptions()

Get the options field for the Tick record.

getRotationback to summary
public short getRotation()

rotate text (0=none, 1=normal, 2=90 degrees counterclockwise, 3=90 degrees clockwise)

Returns:short

the rotation field value.

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

Annotations
@Override
getTickColorback to summary
public short getTickColor()

Get the tick color field for the Tick record.

getZero1back to summary
public int getZero1()

Get the zero 1 field for the Tick record.

getZero2back to summary
public int getZero2()

Get the zero 2 field for the Tick record.

getZero3back to summary
public short getZero3()

Get the zero 3 field for the Tick record.

isAutorotateback to summary
public boolean isAutorotate()

automatically rotate the text

Returns:boolean

the autorotate field value.

isAutoTextBackgroundback to summary
public boolean isAutoTextBackground()

use the quote unquote automatic color for text background

Returns:boolean

the auto text background field value.

isAutoTextColorback to summary
public boolean isAutoTextColor()

use the quote unquote automatic color for text

Returns:boolean

the auto text color field value.

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

Annotations
@Override
setAutorotateback to summary
public void setAutorotate(boolean value)

Sets the autorotate field value. automatically rotate the text

setAutoTextBackgroundback to summary
public void setAutoTextBackground(boolean value)

Sets the auto text background field value. use the quote unquote automatic color for text background

setAutoTextColorback to summary
public void setAutoTextColor(boolean value)

Sets the auto text color field value. use the quote unquote automatic color for text

setBackgroundback to summary
public void setBackground(byte field_4_background)

Set the background field for the Tick record.

setLabelColorRgbback to summary
public void setLabelColorRgb(int field_5_labelColorRgb)

Set the label color rgb field for the Tick record.

setLabelPositionback to summary
public void setLabelPosition(byte field_3_labelPosition)

Set the label position field for the Tick record.

setMajorTickTypeback to summary
public void setMajorTickType(byte field_1_majorTickType)

Set the major tick type field for the Tick record.

setMinorTickTypeback to summary
public void setMinorTickType(byte field_2_minorTickType)

Set the minor tick type field for the Tick record.

setOptionsback to summary
public void setOptions(short field_10_options)

Set the options field for the Tick record.

setRotationback to summary
public void setRotation(short value)

Sets the rotation field value. rotate text (0=none, 1=normal, 2=90 degrees counterclockwise, 3=90 degrees clockwise)

setTickColorback to summary
public void setTickColor(short field_11_tickColor)

Set the tick color field for the Tick record.

setZero1back to summary
public void setZero1(int field_6_zero1)

Set the zero 1 field for the Tick record.

setZero2back to summary
public void setZero2(int field_7_zero2)

Set the zero 2 field for the Tick record.

setZero3back to summary
public void setZero3(short field_12_zero3)

Set the zero 3 field for the Tick record.