Package org.apache.poi.hssf.record.chart
Class LinkedDataRecord
java.lang.Object
org.apache.poi.hssf.record.RecordBase
org.apache.poi.hssf.record.Record
org.apache.poi.hssf.record.StandardRecord
org.apache.poi.hssf.record.chart.LinkedDataRecord
- All Implemented Interfaces:
Cloneable
Describes a linked data record. This record refers to the series data or text.
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final byte
static final byte
static final byte
static final byte
static final byte
static final byte
static final byte
static final byte
static final byte
static final short
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionclone()
protected int
Ptg[]
Get the formula of link field for the LinkedData record.short
Get the index number fmt record field for the LinkedData record.byte
Get the link type field for the LinkedData record.short
Get the options field for the LinkedData record.byte
Get the reference type field for the LinkedData record.short
getSid()
return the non static version of the id for this record.boolean
true if this object has a custom number formatvoid
Write the data content of this BIFF record.void
setCustomNumberFormat
(boolean value) Sets the custom number format field value.void
setFormulaOfLink
(Ptg[] ptgs) Set the formula of link field for the LinkedData record.void
setIndexNumberFmtRecord
(short field_4_indexNumberFmtRecord) Set the index number fmt record field for the LinkedData record.void
setLinkType
(byte field_1_linkType) Set the link type field for the LinkedData record.void
setOptions
(short field_3_options) Set the options field for the LinkedData record.void
setReferenceType
(byte field_2_referenceType) Set the reference type field for the LinkedData record.toString()
get a string representation of the record (for biffview/debugging)Methods inherited from class org.apache.poi.hssf.record.StandardRecord
getRecordSize, serialize
Methods inherited from class org.apache.poi.hssf.record.Record
cloneViaReserialise, serialize
-
Field Details
-
sid
public static final short sid- See Also:
-
LINK_TYPE_TITLE_OR_TEXT
public static final byte LINK_TYPE_TITLE_OR_TEXT- See Also:
-
LINK_TYPE_VALUES
public static final byte LINK_TYPE_VALUES- See Also:
-
LINK_TYPE_CATEGORIES
public static final byte LINK_TYPE_CATEGORIES- See Also:
-
LINK_TYPE_SECONDARY_CATEGORIES
public static final byte LINK_TYPE_SECONDARY_CATEGORIES- See Also:
-
REFERENCE_TYPE_DEFAULT_CATEGORIES
public static final byte REFERENCE_TYPE_DEFAULT_CATEGORIES- See Also:
-
REFERENCE_TYPE_DIRECT
public static final byte REFERENCE_TYPE_DIRECT- See Also:
-
REFERENCE_TYPE_WORKSHEET
public static final byte REFERENCE_TYPE_WORKSHEET- See Also:
-
REFERENCE_TYPE_NOT_USED
public static final byte REFERENCE_TYPE_NOT_USED- See Also:
-
REFERENCE_TYPE_ERROR_REPORTED
public static final byte REFERENCE_TYPE_ERROR_REPORTED- See Also:
-
-
Constructor Details
-
LinkedDataRecord
public LinkedDataRecord() -
LinkedDataRecord
-
-
Method Details
-
toString
Description copied from class:Record
get a string representation of the record (for biffview/debugging) -
serialize
Description copied from class:StandardRecord
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
RecordBase.getRecordSize()
} minus four ( record header consisting of a 'ushort sid' and 'ushort reclength' has already been written by their superclass).- Specified by:
serialize
in classStandardRecord
- Parameters:
out
- the output object
-
getDataSize
protected int getDataSize()- Specified by:
getDataSize
in classStandardRecord
-
getSid
public short getSid()Description copied from class:Record
return the non static version of the id for this record. -
clone
-
getLinkType
public byte getLinkType()Get the link type field for the LinkedData record.- Returns:
- One of
LINK_TYPE_TITLE_OR_TEXT
,LINK_TYPE_VALUES
,LINK_TYPE_CATEGORIES
, orLINK_TYPE_SECONDARY_CATEGORIES
-
setLinkType
public void setLinkType(byte field_1_linkType) Set the link type field for the LinkedData record.- Parameters:
field_1_linkType
- One ofLINK_TYPE_TITLE_OR_TEXT
,LINK_TYPE_VALUES
,LINK_TYPE_CATEGORIES
, orLINK_TYPE_SECONDARY_CATEGORIES
-
getReferenceType
public byte getReferenceType()Get the reference type field for the LinkedData record. -
setReferenceType
public void setReferenceType(byte field_2_referenceType) Set the reference type field for the LinkedData record.- Parameters:
field_2_referenceType
- One ofREFERENCE_TYPE_DEFAULT_CATEGORIES
REFERENCE_TYPE_DIRECT
REFERENCE_TYPE_WORKSHEET
REFERENCE_TYPE_NOT_USED
REFERENCE_TYPE_ERROR_REPORTED
-
getOptions
public short getOptions()Get the options field for the LinkedData record. -
setOptions
public void setOptions(short field_3_options) Set the options field for the LinkedData record. -
getIndexNumberFmtRecord
public short getIndexNumberFmtRecord()Get the index number fmt record field for the LinkedData record. -
setIndexNumberFmtRecord
public void setIndexNumberFmtRecord(short field_4_indexNumberFmtRecord) Set the index number fmt record field for the LinkedData record. -
getFormulaOfLink
Get the formula of link field for the LinkedData record. -
setFormulaOfLink
Set the formula of link field for the LinkedData record. -
setCustomNumberFormat
public void setCustomNumberFormat(boolean value) Sets the custom number format field value. true if this object has a custom number format -
isCustomNumberFormat
public boolean isCustomNumberFormat()true if this object has a custom number format- Returns:
- the custom number format field value.
-