NameRecord (Bio-Formats API)

java.lang.Object
- loci.poi.hssf.record.Record
- - loci.poi.hssf.record.NameRecord

```
public class NameRecord
extends Record
```
Title: Name Record (aka Named Range)
Description: Defines a named range within a workbook.
REFERENCE:

Version:

1.0-pre

Author:

Libin Roman (Vista Portal LDT. Developer), Sergei Kozello (sergeikozello at mail.ru), Glen Stampoultzis (glens at apache.org)

Field Summary

Fields
Modifier and Type	Field and Description
`static byte`	`BUILTIN_AUTO_ACTIVATE` Included for completeness sake, not implemented
`static byte`	`BUILTIN_AUTO_CLOSE` Included for completeness sake, not implemented
`static byte`	`BUILTIN_AUTO_DEACTIVATE` Included for completeness sake, not implemented
`static byte`	`BUILTIN_AUTO_OPEN` Included for completeness sake, not implemented
`static byte`	`BUILTIN_CONSOLIDATE_AREA` Included for completeness sake, not implemented
`static byte`	`BUILTIN_CRITERIA` Included for completeness sake, not implemented
`static byte`	`BUILTIN_DATA_FORM` Included for completeness sake, not implemented
`static byte`	`BUILTIN_DATABASE` Included for completeness sake, not implemented
`static byte`	`BUILTIN_PRINT_AREA`
`static byte`	`BUILTIN_PRINT_TITLE`
`static byte`	`BUILTIN_RECORDER` Included for completeness sake, not implemented
`static byte`	`BUILTIN_SHEET_TITLE` Included for completeness sake, not implemented
`private short`	`field_1_option_flag`
`private byte`	`field_10_length_status_bar_text`
`private byte`	`field_11_compressed_unicode_flag`
`private byte`	`field_12_builtIn_name`
`private String`	`field_12_name_text`
`private Stack`	`field_13_name_definition`
`private String`	`field_14_custom_menu_text`
`private String`	`field_15_description_text`
`private String`	`field_16_help_topic_text`
`private String`	`field_17_status_bar_text`
`private byte`	`field_2_keyboard_shortcut`
`private byte`	`field_3_length_name_text`
`private short`	`field_4_length_name_definition`
`private short`	`field_5_index_to_sheet`
`private short`	`field_6_equals_to_index_to_sheet`
`private byte`	`field_7_length_custom_menu`
`private byte`	`field_8_length_description_text`
`private byte`	`field_9_length_help_topic_text`
`static short`	`OPT_BINDATA`
`static short`	`OPT_BUILTIN`
`static short`	`OPT_COMMAND_NAME`
`static short`	`OPT_COMPLEX`
`static short`	`OPT_FUNCTION_NAME`
`static short`	`OPT_HIDDEN_NAME`
`static short`	`OPT_MACRO`
`static short`	`sid`

Constructor Summary

Constructors
Constructor and Description
`NameRecord()` Creates new NameRecord
`NameRecord(byte builtin, short index)` Constructor to create a built-in named region
`NameRecord(RecordInputStream in)` Constructs a Name record and sets its fields appropriately.

Method Summary

Methods
Modifier and Type	Method and Description
`private Ptg`	`createNewPtg()`
`protected void`	`fillFields(RecordInputStream in)` called by the constructor, should set class level fields.
`String`	`getAreaReference(Workbook book)` gets the reference , the area only (range)
`byte`	`getBuiltInName()` Gets the Built In Name
`byte`	`getCompressedUnicodeFlag()` gets the name compressed Unicode flag
`byte`	`getCustomMenuLength()` gets the custom menu length
`String`	`getCustomMenuText()` get the custom menu text
`short`	`getDefinitionLength()` get the definition length
`String`	`getDescriptionText()` gets the description text
`byte`	`getDescriptionTextLength()` gets the description text length
`short`	`getEqualsToIndexToSheet()`
`short`	`getExternSheetNumber()` gets the extern sheet number
`byte`	`getFnGroup()`
`byte`	`getHelpTopicLength()` gets the help topic length
`String`	`getHelpTopicText()` get the help topic text
`short`	`getIndexToSheet()` Convenience method to retrieve the index the name refers to.
`byte`	`getKeyboardShortcut()` returns the keyboard shortcut
`List`	`getNameDefinition()` gets the definition, reference (Formula)
`private int`	`getNameDefinitionSize()`
`String`	`getNameText()` gets the name
`byte`	`getNameTextLength()` gets the name length
`short`	`getOptionFlag()` gets the option flag
`int`	`getRecordSize()` returns the record size
`short`	`getSid()` return the non static version of the id for this record.
`byte`	`getStatusBarLength()` get the status bar text length
`String`	`getStatusBarText()` gets the status bar text
`int`	`getTextsLength()` gets the length of all texts
`short`	`getUnused()` gets the index to extern sheet
`boolean`	`isBuiltInName()` Convenience Function to determine if the name is a built-in name
`boolean`	`isCommandName()`
`boolean`	`isComplexFunction()`
`boolean`	`isFunctionName()`
`boolean`	`isHiddenName()`
`boolean`	`isMacro()`
`int`	`serialize(int offset, byte[] data)` called by the class that is responsible for writing this sucker.
`void`	`setAreaReference(String ref)` sets the reference , the area only (range)
`void`	`setCompressedUnicodeFlag(byte flag)` sets the compressed unicode flag
`void`	`setCustomMenuLength(byte length)` sets the custom menu length
`void`	`setCustomMenuText(String text)` sets the custom menu text
`void`	`setDefinitionTextLength(short length)` sets the definition (reference - formula) length
`void`	`setDescriptionText(String text)` sets the description text
`void`	`setDescriptionTextLength(byte length)` sets the length of named range description
`void`	`setEqualsToIndexToSheet(short value)`
`void`	`setExternSheetNumber(short externSheetNumber)` sets the extern sheet number
`void`	`setHelpTopicLength(byte length)` sets the help topic length
`void`	`setHelpTopicText(String text)` sets the help topic text
`void`	`setKeyboardShortcut(byte shortcut)` sets the keyboard shortcut
`void`	`setNameDefinition(Stack nameDefinition)`
`void`	`setNameText(String name)` sets the name of the named range
`void`	`setNameTextLength(byte length)` sets the name of the named range length
`void`	`setOptionFlag(short flag)` sets the option flag for the named range
`void`	`setStatusBarLength(byte length)` sets the length of the status bar text
`void`	`setStatusBarText(String text)` sets the status bar text
`void`	`setUnused(short index)` sets the index number to the extern sheet (thats is what writen in documentation but as i saw , it works differently)
`String`	`toString()` get a string representation of the record (for biffview/debugging)
`protected String`	`translateBuiltInName(byte name)` Creates a human readable name for built in types
`protected void`	`validateSid(short id)` called by constructor, should throw runtime exception in the event of a record passed with a differing ID.

Methods inherited from class loci.poi.hssf.record.Record
clone, isInValueSection, isValue, 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
  - BUILTIN_CONSOLIDATE_AREA
```
public static final byte BUILTIN_CONSOLIDATE_AREA
```
    Included for completeness sake, not implemented
    
    See Also:
    Constant Field Values
  - BUILTIN_AUTO_OPEN
```
public static final byte BUILTIN_AUTO_OPEN
```
    Included for completeness sake, not implemented
    
    See Also:
    Constant Field Values
  - BUILTIN_AUTO_CLOSE
```
public static final byte BUILTIN_AUTO_CLOSE
```
    Included for completeness sake, not implemented
    
    See Also:
    Constant Field Values
  - BUILTIN_DATABASE
```
public static final byte BUILTIN_DATABASE
```
    Included for completeness sake, not implemented
    
    See Also:
    Constant Field Values
  - BUILTIN_CRITERIA
```
public static final byte BUILTIN_CRITERIA
```
    Included for completeness sake, not implemented
    
    See Also:
    Constant Field Values
  - BUILTIN_PRINT_AREA
```
public static final byte BUILTIN_PRINT_AREA
```
    See Also:
    Constant Field Values
  - BUILTIN_PRINT_TITLE
```
public static final byte BUILTIN_PRINT_TITLE
```
    See Also:
    Constant Field Values
  - BUILTIN_RECORDER
```
public static final byte BUILTIN_RECORDER
```
    Included for completeness sake, not implemented
    
    See Also:
    Constant Field Values
  - BUILTIN_DATA_FORM
```
public static final byte BUILTIN_DATA_FORM
```
    Included for completeness sake, not implemented
    
    See Also:
    Constant Field Values
  - BUILTIN_AUTO_ACTIVATE
```
public static final byte BUILTIN_AUTO_ACTIVATE
```
    Included for completeness sake, not implemented
    
    See Also:
    Constant Field Values
  - BUILTIN_AUTO_DEACTIVATE
```
public static final byte BUILTIN_AUTO_DEACTIVATE
```
    Included for completeness sake, not implemented
    
    See Also:
    Constant Field Values
  - BUILTIN_SHEET_TITLE
```
public static final byte BUILTIN_SHEET_TITLE
```
    Included for completeness sake, not implemented
    
    See Also:
    Constant Field Values
  - OPT_HIDDEN_NAME
```
public static final short OPT_HIDDEN_NAME
```
    See Also:
    Constant Field Values
  - OPT_FUNCTION_NAME
```
public static final short OPT_FUNCTION_NAME
```
    See Also:
    Constant Field Values
  - OPT_COMMAND_NAME
```
public static final short OPT_COMMAND_NAME
```
    See Also:
    Constant Field Values
  - OPT_MACRO
```
public static final short OPT_MACRO
```
    See Also:
    Constant Field Values
  - OPT_COMPLEX
```
public static final short OPT_COMPLEX
```
    See Also:
    Constant Field Values
  - OPT_BUILTIN
```
public static final short OPT_BUILTIN
```
    See Also:
    Constant Field Values
  - OPT_BINDATA
```
public static final short OPT_BINDATA
```
    See Also:
    Constant Field Values
  - field_1_option_flag
```
private short field_1_option_flag
```
  - field_2_keyboard_shortcut
```
private byte field_2_keyboard_shortcut
```
  - field_3_length_name_text
```
private byte field_3_length_name_text
```
  - field_4_length_name_definition
```
private short field_4_length_name_definition
```
  - field_5_index_to_sheet
```
private short field_5_index_to_sheet
```
  - field_6_equals_to_index_to_sheet
```
private short field_6_equals_to_index_to_sheet
```
  - field_7_length_custom_menu
```
private byte field_7_length_custom_menu
```
  - field_8_length_description_text
```
private byte field_8_length_description_text
```
  - field_9_length_help_topic_text
```
private byte field_9_length_help_topic_text
```
  - field_10_length_status_bar_text
```
private byte field_10_length_status_bar_text
```
  - field_11_compressed_unicode_flag
```
private byte field_11_compressed_unicode_flag
```
  - field_12_builtIn_name
```
private byte field_12_builtIn_name
```
  - field_12_name_text
```
private String field_12_name_text
```
  - field_13_name_definition
```
private Stack field_13_name_definition
```
  - field_14_custom_menu_text
```
private String field_14_custom_menu_text
```
  - field_15_description_text
```
private String field_15_description_text
```
  - field_16_help_topic_text
```
private String field_16_help_topic_text
```
  - field_17_status_bar_text
```
private String field_17_status_bar_text
```
- Constructor Detail
  - NameRecord
```
public NameRecord()
```
    Creates new NameRecord
  - NameRecord
```
public NameRecord(RecordInputStream in)
```
    Constructs a Name record and sets its fields appropriately.
    
    Parameters:
    in - the RecordInputstream to read the record from
  - NameRecord
```
public NameRecord(byte builtin,
          short index)
```
    Constructor to create a built-in named region
    
    Parameters:
    builtin - Built-in byte representation for the name record, use the public constants
    index -
- Method Detail
  - setOptionFlag
```
public void setOptionFlag(short flag)
```
    sets the option flag for the named range
    
    Parameters:
    flag - option flag
  - setKeyboardShortcut
```
public void setKeyboardShortcut(byte shortcut)
```
    sets the keyboard shortcut
    
    Parameters:
    shortcut - keyboard shortcut
  - setNameTextLength
```
public void setNameTextLength(byte length)
```
    sets the name of the named range length
    
    Parameters:
    length - name length
  - setDefinitionTextLength
```
public void setDefinitionTextLength(short length)
```
    sets the definition (reference - formula) length
    
    Parameters:
    length - defenition length
  - setUnused
```
public void setUnused(short index)
```
    sets the index number to the extern sheet (thats is what writen in documentation but as i saw , it works differently)
    
    Parameters:
    index - extern sheet index
  - getEqualsToIndexToSheet
```
public short getEqualsToIndexToSheet()
```
  - getIndexToSheet
```
public short getIndexToSheet()
```
    Convenience method to retrieve the index the name refers to.
    
    Returns:
    short
    See Also:
    getEqualsToIndexToSheet()
  - getFnGroup
```
public byte getFnGroup()
```
    Returns:
    function group
    See Also:
    FnGroupCountRecord
  - setEqualsToIndexToSheet
```
public void setEqualsToIndexToSheet(short value)
```
  - setCustomMenuLength
```
public void setCustomMenuLength(byte length)
```
    sets the custom menu length
    
    Parameters:
    length - custom menu length
  - setDescriptionTextLength
```
public void setDescriptionTextLength(byte length)
```
    sets the length of named range description
    
    Parameters:
    length - description length
  - setHelpTopicLength
```
public void setHelpTopicLength(byte length)
```
    sets the help topic length
    
    Parameters:
    length - help topic length
  - setStatusBarLength
```
public void setStatusBarLength(byte length)
```
    sets the length of the status bar text
    
    Parameters:
    length - status bar text length
  - setCompressedUnicodeFlag
```
public void setCompressedUnicodeFlag(byte flag)
```
    sets the compressed unicode flag
    
    Parameters:
    flag - unicode flag
  - setNameText
```
public void setNameText(String name)
```
    sets the name of the named range
    
    Parameters:
    name - named range name
  - setCustomMenuText
```
public void setCustomMenuText(String text)
```
    sets the custom menu text
    
    Parameters:
    text - custom menu text
  - setDescriptionText
```
public void setDescriptionText(String text)
```
    sets the description text
    
    Parameters:
    text - the description text
  - setHelpTopicText
```
public void setHelpTopicText(String text)
```
    sets the help topic text
    
    Parameters:
    text - help topix text
  - setStatusBarText
```
public void setStatusBarText(String text)
```
    sets the status bar text
    
    Parameters:
    text - status bar text
  - getOptionFlag
```
public short getOptionFlag()
```
    gets the option flag
    
    Returns:
    option flag
  - getKeyboardShortcut
```
public byte getKeyboardShortcut()
```
    returns the keyboard shortcut
    
    Returns:
    keyboard shortcut
  - getNameTextLength
```
public byte getNameTextLength()
```
    gets the name length
    
    Returns:
    name length
  - getDefinitionLength
```
public short getDefinitionLength()
```
    get the definition length
    
    Returns:
    definition length
  - getUnused
```
public short getUnused()
```
    gets the index to extern sheet
    
    Returns:
    index to extern sheet
  - getCustomMenuLength
```
public byte getCustomMenuLength()
```
    gets the custom menu length
    
    Returns:
    custom menu length
  - getDescriptionTextLength
```
public byte getDescriptionTextLength()
```
    gets the description text length
    
    Returns:
    description text length
  - getHelpTopicLength
```
public byte getHelpTopicLength()
```
    gets the help topic length
    
    Returns:
    help topic length
  - getStatusBarLength
```
public byte getStatusBarLength()
```
    get the status bar text length
    
    Returns:
    satus bar length
  - getCompressedUnicodeFlag
```
public byte getCompressedUnicodeFlag()
```
    gets the name compressed Unicode flag
    
    Returns:
    compressed unicode flag
  - isHiddenName
```
public boolean isHiddenName()
```
    Returns:
    true if name is hidden
  - isFunctionName
```
public boolean isFunctionName()
```
    Returns:
    true if name is a function
  - isCommandName
```
public boolean isCommandName()
```
    Returns:
    true if name is a command
  - isMacro
```
public boolean isMacro()
```
    Returns:
    true if function macro or command macro
  - isComplexFunction
```
public boolean isComplexFunction()
```
    Returns:
    true if array formula or user defined
  - isBuiltInName
```
public boolean isBuiltInName()
```
    Convenience Function to determine if the name is a built-in name
  - getNameText
```
public String getNameText()
```
    gets the name
    
    Returns:
    name
  - getBuiltInName
```
public byte getBuiltInName()
```
    Gets the Built In Name
    
    Returns:
    the built in Name
  - getNameDefinition
```
public List getNameDefinition()
```
    gets the definition, reference (Formula)
    
    Returns:
    definition -- can be null if we cant parse ptgs
  - setNameDefinition
```
public void setNameDefinition(Stack nameDefinition)
```
  - getCustomMenuText
```
public String getCustomMenuText()
```
    get the custom menu text
    
    Returns:
    custom menu text
  - getDescriptionText
```
public String getDescriptionText()
```
    gets the description text
    
    Returns:
    description text
  - getHelpTopicText
```
public String getHelpTopicText()
```
    get the help topic text
    
    Returns:
    gelp topic text
  - getStatusBarText
```
public String getStatusBarText()
```
    gets the status bar text
    
    Returns:
    status bar text
  - validateSid
```
protected void validateSid(short id)
```
    called by constructor, should throw runtime exception in the event of a record passed with a differing ID.
    
    Specified by:
    
    validateSid in class Record
    
    Parameters:
    id - alleged id for this record
  - 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
    
    Specified by:
    
    serialize in class Record
    
    Parameters:
    offset - to begin writing at
    data - byte array containing instance data
    
    Returns:
    number of bytes written
  - getTextsLength
```
public int getTextsLength()
```
    gets the length of all texts
    
    Returns:
    total length
  - getNameDefinitionSize
```
private int getNameDefinitionSize()
```
  - getRecordSize
```
public int getRecordSize()
```
    returns the record size
    
    Overrides:
    
    getRecordSize in class Record
  - getExternSheetNumber
```
public short getExternSheetNumber()
```
    gets the extern sheet number
    
    Returns:
    extern sheet index
  - setExternSheetNumber
```
public void setExternSheetNumber(short externSheetNumber)
```
    sets the extern sheet number
    
    Parameters:
    externSheetNumber - extern sheet number
  - createNewPtg
```
private Ptg createNewPtg()
```
  - getAreaReference
```
public String getAreaReference(Workbook book)
```
    gets the reference , the area only (range)
    
    Returns:
    area reference
  - setAreaReference
```
public void setAreaReference(String ref)
```
    sets the reference , the area only (range)
    
    Parameters:
    ref - area reference
  - fillFields
```
protected void fillFields(RecordInputStream in)
```
    called by the constructor, should set class level fields. Should throw runtime exception for bad/icomplete data.
    
    Specified by:
    
    fillFields in class Record
    
    Parameters:
    in - the RecordInputstream to read the record from
  - getSid
```
public short getSid()
```
    return the non static version of the id for this record.
    
    Specified by:
    
    getSid in class Record
  - toString
```
public String toString()
```
    Description copied from class: Record
    
    get a string representation of the record (for biffview/debugging)
    
    Overrides:
    
    toString in class Record
    
    See Also:
    Object.toString()
  - translateBuiltInName
```
protected String translateBuiltInName(byte name)
```
    Creates a human readable name for built in types
    
    Returns:
    Unknown if the built-in name cannot be translated

Class NameRecord

Field Summary

Constructor Summary

Method Summary

Methods inherited from class loci.poi.hssf.record.Record

Methods inherited from class java.lang.Object

Field Detail

sid

BUILTIN_CONSOLIDATE_AREA

BUILTIN_AUTO_OPEN

BUILTIN_AUTO_CLOSE

BUILTIN_DATABASE

BUILTIN_CRITERIA

BUILTIN_PRINT_AREA

BUILTIN_PRINT_TITLE

BUILTIN_RECORDER

BUILTIN_DATA_FORM

BUILTIN_AUTO_ACTIVATE

BUILTIN_AUTO_DEACTIVATE

BUILTIN_SHEET_TITLE

OPT_HIDDEN_NAME

OPT_FUNCTION_NAME

OPT_COMMAND_NAME

OPT_MACRO

OPT_COMPLEX

OPT_BUILTIN

OPT_BINDATA

field_1_option_flag

field_2_keyboard_shortcut

field_3_length_name_text

field_4_length_name_definition

field_5_index_to_sheet

field_6_equals_to_index_to_sheet

field_7_length_custom_menu

field_8_length_description_text

field_9_length_help_topic_text

field_10_length_status_bar_text

field_11_compressed_unicode_flag

field_12_builtIn_name

field_12_name_text

field_13_name_definition

field_14_custom_menu_text

field_15_description_text

field_16_help_topic_text

field_17_status_bar_text

Constructor Detail

NameRecord

NameRecord

NameRecord

Method Detail

setOptionFlag

setKeyboardShortcut

setNameTextLength

setDefinitionTextLength

setUnused

getEqualsToIndexToSheet

getIndexToSheet

getFnGroup

setEqualsToIndexToSheet

setCustomMenuLength

setDescriptionTextLength

setHelpTopicLength

setStatusBarLength

setCompressedUnicodeFlag

setNameText

setCustomMenuText

setDescriptionText

setHelpTopicText

setStatusBarText

getOptionFlag

getKeyboardShortcut

getNameTextLength

getDefinitionLength

getUnused

getCustomMenuLength

getDescriptionTextLength

getHelpTopicLength

getStatusBarLength

getCompressedUnicodeFlag

isHiddenName