Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## org.apache.poi.hssf.record
Class LabelSSTRecord

    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.CellRecord
                      org.apache.poi.hssf.record.LabelSSTRecord

All Implemented Interfaces:
  java.lang.Cloneable, CellValueRecordInterface

    public final class LabelSSTRecord

extends CellRecord
implements java.lang.Cloneable

Title: Label SST Record

Description: Refers to a string in the shared string table and is a column value.

REFERENCE: PG 325 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)

Field Summary
`static short` | `sid`

Constructor Summary
`LabelSSTRecord()`
`LabelSSTRecord(RecordInputStream in)`

Method Summary
`protected void` | `appendValueText(java.lang.StringBuilder sb)` Append specific debug info (used by `CellRecord.toString()` for the value contained in this record.
`LabelSSTRecord` | `clone()`
`protected java.lang.String` | `getRecordName()` Gets the debug info BIFF record type name (used by `CellRecord.toString()`.
`short` | `getSid()` return the non static version of the id for this record.
`int` | `getSSTIndex()` get the index to the string in the SSTRecord
`protected int` | `getValueDataSize()`
`protected void` | `serializeValue(LittleEndianOutput out)` writes out the value data for this cell record
`void` | `setSSTIndex(int index)` set the index to the string in the SSTRecord

Methods inherited from class org.apache.poi.hssf.record.CellRecord
`copyBaseFields, getColumn, getDataSize, getRow, getXFIndex, serialize, setColumn, setRow, setXFIndex, toString`

Methods inherited from class org.apache.poi.hssf.record.StandardRecord
`getRecordSize, serialize`

Methods inherited from class org.apache.poi.hssf.record.Record
`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

### LabelSSTRecord

    public LabelSSTRecord()

### LabelSSTRecord

    public LabelSSTRecord(RecordInputStream in)

Method Detail

### setSSTIndex

    public void setSSTIndex(int index)

  set the index to the string in the SSTRecord

  Parameters:
    `index` - - of string in the SST Table
  See Also:
    `SSTRecord`

### getSSTIndex

    public int getSSTIndex()

  get the index to the string in the SSTRecord

  Returns:
    index of string in the SST Table
  See Also:
    `SSTRecord`

### getRecordName

    protected java.lang.String getRecordName()

  Description copied from class: `CellRecord`
  Gets the debug info BIFF record type name (used by `CellRecord.toString()`.

  Specified by:
    `getRecordName` in class `CellRecord`
  Returns:
    the record type name

### appendValueText

    protected void appendValueText(java.lang.StringBuilder sb)

  Description copied from class: `CellRecord`
  Append specific debug info (used by `CellRecord.toString()` for the value contained in this record. Trailing new-line should not be appended (superclass does that).

  Specified by:
    `appendValueText` in class `CellRecord`
  Parameters:
    `sb` - the StringBuilder to write to

### serializeValue

    protected void serializeValue(LittleEndianOutput out)

  Description copied from class: `CellRecord`
  writes out the value data for this cell record

  Specified by:
    `serializeValue` in class `CellRecord`
  Parameters:
    `out` - the output

### getValueDataSize

    protected int getValueDataSize()

  Specified by:
    `getValueDataSize` in class `CellRecord`
  Returns:
    the size (in bytes) of the value data for this cell 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`
  Returns:
    he id for this record

### clone

    public LabelSSTRecord clone()

  Overrides:
    `clone` in class `Record`

Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

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