public class NameRecord extends Record
Description: Defines a named range within a workbook.
REFERENCE:
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 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.
|
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.
|
clone, isInValueSection, isValue, serialize
public static final short sid
public static final byte BUILTIN_CONSOLIDATE_AREA
public static final byte BUILTIN_AUTO_OPEN
public static final byte BUILTIN_AUTO_CLOSE
public static final byte BUILTIN_DATABASE
public static final byte BUILTIN_CRITERIA
public static final byte BUILTIN_PRINT_AREA
public static final byte BUILTIN_PRINT_TITLE
public static final byte BUILTIN_RECORDER
public static final byte BUILTIN_DATA_FORM
public static final byte BUILTIN_AUTO_ACTIVATE
public static final byte BUILTIN_AUTO_DEACTIVATE
public static final byte BUILTIN_SHEET_TITLE
public static final short OPT_HIDDEN_NAME
public static final short OPT_FUNCTION_NAME
public static final short OPT_COMMAND_NAME
public static final short OPT_MACRO
public static final short OPT_COMPLEX
public static final short OPT_BUILTIN
public static final short OPT_BINDATA
private short field_1_option_flag
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
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
public NameRecord()
public NameRecord(RecordInputStream in)
in
- the RecordInputstream to read the record frompublic NameRecord(byte builtin, short index)
builtin
- Built-in byte representation for the name record, use the public constantsindex
- public void setOptionFlag(short flag)
flag
- option flagpublic void setKeyboardShortcut(byte shortcut)
shortcut
- keyboard shortcutpublic void setNameTextLength(byte length)
length
- name lengthpublic void setDefinitionTextLength(short length)
length
- defenition lengthpublic void setUnused(short index)
index
- extern sheet indexpublic short getEqualsToIndexToSheet()
public short getIndexToSheet()
getEqualsToIndexToSheet()
public byte getFnGroup()
FnGroupCountRecord
public void setEqualsToIndexToSheet(short value)
public void setCustomMenuLength(byte length)
length
- custom menu lengthpublic void setDescriptionTextLength(byte length)
length
- description lengthpublic void setHelpTopicLength(byte length)
length
- help topic lengthpublic void setStatusBarLength(byte length)
length
- status bar text lengthpublic void setCompressedUnicodeFlag(byte flag)
flag
- unicode flagpublic void setNameText(String name)
name
- named range namepublic void setCustomMenuText(String text)
text
- custom menu textpublic void setDescriptionText(String text)
text
- the description textpublic void setHelpTopicText(String text)
text
- help topix textpublic void setStatusBarText(String text)
text
- status bar textpublic short getOptionFlag()
public byte getKeyboardShortcut()
public byte getNameTextLength()
public short getDefinitionLength()
public short getUnused()
public byte getCustomMenuLength()
public byte getDescriptionTextLength()
public byte getHelpTopicLength()
public byte getStatusBarLength()
public byte getCompressedUnicodeFlag()
public boolean isHiddenName()
public boolean isFunctionName()
public boolean isCommandName()
public boolean isMacro()
public boolean isComplexFunction()
public boolean isBuiltInName()
public String getNameText()
public byte getBuiltInName()
public List getNameDefinition()
public void setNameDefinition(Stack nameDefinition)
public String getCustomMenuText()
public String getDescriptionText()
public String getHelpTopicText()
public String getStatusBarText()
protected void validateSid(short id)
validateSid
in class Record
id
- alleged id for this recordpublic int serialize(int offset, byte[] data)
public int getTextsLength()
private int getNameDefinitionSize()
public int getRecordSize()
getRecordSize
in class Record
public short getExternSheetNumber()
public void setExternSheetNumber(short externSheetNumber)
externSheetNumber
- extern sheet numberprivate Ptg createNewPtg()
public String getAreaReference(Workbook book)
public void setAreaReference(String ref)
ref
- area referenceprotected void fillFields(RecordInputStream in)
fillFields
in class Record
in
- the RecordInputstream to read the record frompublic short getSid()
public String toString()
Record
toString
in class Record
Object.toString()
protected String translateBuiltInName(byte name)
Copyright © 2016 Open Microscopy Environment