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 bytestatic final bytestatic final bytestatic final bytestatic final bytestatic final bytestatic final bytestatic final bytestatic final bytestatic final short -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionclone()protected intPtg[]Get the formula of link field for the LinkedData record.shortGet the index number fmt record field for the LinkedData record.byteGet the link type field for the LinkedData record.shortGet the options field for the LinkedData record.byteGet the reference type field for the LinkedData record.shortgetSid()return the non static version of the id for this record.booleantrue if this object has a custom number formatvoidWrite the data content of this BIFF record.voidsetCustomNumberFormat(boolean value) Sets the custom number format field value.voidsetFormulaOfLink(Ptg[] ptgs) Set the formula of link field for the LinkedData record.voidsetIndexNumberFmtRecord(short field_4_indexNumberFmtRecord) Set the index number fmt record field for the LinkedData record.voidsetLinkType(byte field_1_linkType) Set the link type field for the LinkedData record.voidsetOptions(short field_3_options) Set the options field for the LinkedData record.voidsetReferenceType(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, serializeMethods 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:Recordget a string representation of the record (for biffview/debugging) -
serialize
Description copied from class:StandardRecordWrite 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:
serializein classStandardRecord- Parameters:
out- the output object
-
getDataSize
protected int getDataSize()- Specified by:
getDataSizein classStandardRecord
-
getSid
public short getSid()Description copied from class:Recordreturn 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_CATEGORIESREFERENCE_TYPE_DIRECTREFERENCE_TYPE_WORKSHEETREFERENCE_TYPE_NOT_USEDREFERENCE_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.
-