Package org.apache.poi.hssf.record

Class ExternalNameRecord

  • public final class ExternalNameRecord
extends StandardRecord
    EXTERNALNAME (0x0023)

    • Constructor Detail

      • ExternalNameRecord

        public ExternalNameRecord()

    • Method Detail

      • isBuiltInName

        public boolean isBuiltInName()
        Returns:
        true if the name is a built-in name

      • isAutomaticLink

        public boolean isAutomaticLink()
        For OLE and DDE, links can be either 'automatic' or 'manual'
        Returns:
        true if this is a automatic link

      • isPicureLink

        public boolean isPicureLink()
        only for OLE and DDE
        Returns:
        true if this is a picture link

      • isStdDocumentNameIdentifier

        public boolean isStdDocumentNameIdentifier()
        DDE links only. If true, this denotes the 'StdDocumentName'
        Returns:
        true if this denotes the 'StdDocumentName'

      • isOLELink

        public boolean isOLELink()

      • isIconifiedPictureLink

        public boolean isIconifiedPictureLink()

      • getText

        public java.lang.String getText()
        Returns:
        the standard String representation of this name

      • setText

        public void setText​(java.lang.String str)

      • getIx

        public short getIx()
        If this is a local name, then this is the (1 based) index of the name of the Sheet this refers to, as defined in the preceding SupBookRecord. If it isn't a local name, then it must be zero.
        Returns:
        the index of the name of the Sheet this refers to

      • setIx

        public void setIx​(short ix)

      • getParsedExpression

        public Ptg[] getParsedExpression()

      • setParsedExpression

        public void setParsedExpression​(Ptg[] ptgs)

      • serialize

        public void serialize​(LittleEndianOutput out)
        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 class StandardRecord
        Parameters:
        out - the output object

      • getSid

        public short getSid()
        Description copied from class: Record
        return the non static version of the id for this record.
        Specified by:
        getSid in class Record
        Returns:
        he id for this record

      • toString

        public java.lang.String toString()
        Description copied from class: Record
        get a string representation of the record (for biffview/debugging)
        Overrides:
        toString in class Record