org.apache.poi.hssf.record
Class ExternalNameRecord

java.lang.Object
  extended by org.apache.poi.hssf.record.RecordBase
      extended by org.apache.poi.hssf.record.Record
          extended by org.apache.poi.hssf.record.ExternalNameRecord

public final class ExternalNameRecord
extends Record

EXTERNALNAME

Author:
Josh Micich

Field Summary
static short sid
           
 
Constructor Summary
ExternalNameRecord(RecordInputStream in)
           
 
Method Summary
 int getRecordSize()
          gives the current serialized size of the record.
 short getSid()
          return the non static version of the id for this record.
 java.lang.String getText()
           
 boolean isAutomaticLink()
          For OLE and DDE, links can be either 'automatic' or 'manual'
 boolean isBuiltInName()
          Convenience Function to determine if the name is a built-in name
 boolean isIconifiedPictureLink()
           
 boolean isOLELink()
           
 boolean isPicureLink()
          only for OLE and DDE
 boolean isStdDocumentNameIdentifier()
          DDE links only.
 int serialize(int offset, byte[] data)
          called by the class that is responsible for writing this sucker.
 java.lang.String toString()
          get a string representation of the record (for biffview/debugging)
 
Methods inherited from class org.apache.poi.hssf.record.Record
clone, cloneViaReserialise, serialize
 
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

sid

public static final short sid
See Also:
Constant Field Values
Constructor Detail

ExternalNameRecord

public ExternalNameRecord(RecordInputStream in)
Method Detail

isBuiltInName

public boolean isBuiltInName()
Convenience Function to determine if the name is a built-in name


isAutomaticLink

public boolean isAutomaticLink()
For OLE and DDE, links can be either 'automatic' or 'manual'


isPicureLink

public boolean isPicureLink()
only for OLE and DDE


isStdDocumentNameIdentifier

public boolean isStdDocumentNameIdentifier()
DDE links only. If true, 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

serialize

public int serialize(int offset,
                     byte[] data)
called by the class that is responsible for writing this sucker. Subclasses should implement this so that their data is passed back in a byte array.

Specified by:
serialize in class RecordBase
Parameters:
offset - to begin writing at
data - byte array containing instance data
Returns:
number of bytes written

getRecordSize

public int getRecordSize()
Description copied from class: Record
gives the current serialized size of the record. Should include the sid and reclength (4 bytes).

Overrides:
getRecordSize in class Record

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

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


Copyright 2008 The Apache Software Foundation or its licensors, as applicable.