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

public final Class ObjectLinkRecord

extends StandardRecord
Class Inheritance
Static Imports
org.apache.poi.util.GenericRecordUtil.getEnumBitsAsString

Links text to an object on the chart or identifies it as the title.

Field Summary

Modifier and TypeField and Description
public static final short
public static final short
public static final short
public static final short
public static final short
private short
private short
private short
public static final short

Constructor Summary

AccessConstructor and Description
public
public
public

Method Summary

Modifier and TypeMethod and Description
public ObjectLinkRecord
public short

Returns:

One of ANCHOR_ID_CHART_TITLE ANCHOR_ID_Y_AXIS ANCHOR_ID_X_AXIS ANCHOR_ID_SERIES_OR_POINT ANCHOR_ID_Z_AXIS
getAnchorId
()

Get the anchor id field for the ObjectLink record.

protected int
public Map<String, Supplier<?>>
public HSSFRecordTypes
public short
getLink1()

Get the link 1 field for the ObjectLink record.

public short
getLink2()

Get the link 2 field for the ObjectLink record.

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
setAnchorId(short
One of ANCHOR_ID_CHART_TITLE ANCHOR_ID_Y_AXIS ANCHOR_ID_X_AXIS ANCHOR_ID_SERIES_OR_POINT ANCHOR_ID_Z_AXIS
field_1_anchorId
)

Set the anchor id field for the ObjectLink record.

public void
setLink1(short field_2_link1)

Set the link 1 field for the ObjectLink record.

public void
setLink2(short field_3_link2)

Set the link 2 field for the ObjectLink record.

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

Field Detail

ANCHOR_ID_CHART_TITLEback to summary
public static final short ANCHOR_ID_CHART_TITLE
ANCHOR_ID_SERIES_OR_POINTback to summary
public static final short ANCHOR_ID_SERIES_OR_POINT
ANCHOR_ID_X_AXISback to summary
public static final short ANCHOR_ID_X_AXIS
ANCHOR_ID_Y_AXISback to summary
public static final short ANCHOR_ID_Y_AXIS
ANCHOR_ID_Z_AXISback to summary
public static final short ANCHOR_ID_Z_AXIS
field_1_anchorIdback to summary
private short field_1_anchorId
field_2_link1back to summary
private short field_2_link1
field_3_link2back to summary
private short field_3_link2
sidback to summary
public static final short sid

Constructor Detail

ObjectLinkRecordback to summary
public ObjectLinkRecord()
ObjectLinkRecordback to summary
public ObjectLinkRecord(ObjectLinkRecord other)
ObjectLinkRecordback to summary
public ObjectLinkRecord(RecordInputStream in)

Method Detail

copyback to summary
public ObjectLinkRecord copy()

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

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

Returns:ObjectLinkRecord

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

a deep copy of the implementing class / instance

Annotations
@Override
getAnchorIdback to summary
public short getAnchorId()

Get the anchor id field for the ObjectLink record.

Returns:short

One of ANCHOR_ID_CHART_TITLE ANCHOR_ID_Y_AXIS ANCHOR_ID_X_AXIS ANCHOR_ID_SERIES_OR_POINT ANCHOR_ID_Z_AXIS

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
getLink1back to summary
public short getLink1()

Get the link 1 field for the ObjectLink record.

getLink2back to summary
public short getLink2()

Get the link 2 field for the ObjectLink record.

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

setAnchorIdback to summary
public void setAnchorId(short field_1_anchorId)

Set the anchor id field for the ObjectLink record.

Parameters
field_1_anchorId:short

One of ANCHOR_ID_CHART_TITLE ANCHOR_ID_Y_AXIS ANCHOR_ID_X_AXIS ANCHOR_ID_SERIES_OR_POINT ANCHOR_ID_Z_AXIS

setLink1back to summary
public void setLink1(short field_2_link1)

Set the link 1 field for the ObjectLink record.

setLink2back to summary
public void setLink2(short field_3_link2)

Set the link 2 field for the ObjectLink record.