public final class NameRecord extends ContinuableRecord
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_FILTER_DB |
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
|
static short |
sid |
Constructor and Description |
---|
NameRecord()
Creates new NameRecord
|
NameRecord(byte builtin,
int sheetNumber)
Constructor to create a built-in named region
|
NameRecord(RecordInputStream ris)
called by the constructor, should set class level fields.
|
Modifier and Type | Method and Description |
---|---|
byte |
getBuiltInName()
Gets the Built In Name
|
java.lang.String |
getCustomMenuText()
get the custom menu text
|
protected int |
getDataSize() |
java.lang.String |
getDescriptionText()
gets the description text
|
int |
getExternSheetNumber()
gets the extern sheet number
|
byte |
getFnGroup() |
java.lang.String |
getHelpTopicText()
get the help topic text
|
byte |
getKeyboardShortcut()
returns the keyboard shortcut
|
Ptg[] |
getNameDefinition()
gets the definition, reference (Formula)
|
java.lang.String |
getNameText()
gets the name
|
short |
getOptionFlag()
gets the option flag
|
int |
getSheetNumber()
For named ranges, and built-in names
|
short |
getSid()
return the non static version of the id for this record.
|
java.lang.String |
getStatusBarText()
gets the status bar text
|
boolean |
hasFormula() |
boolean |
isBuiltInName()
Convenience Function to determine if the name is a built-in name
|
boolean |
isCommandName() |
boolean |
isComplexFunction() |
boolean |
isFunctionName() |
boolean |
isHiddenName() |
boolean |
isMacro() |
void |
serialize(ContinuableRecordOutput out)
NameRecord can span into
|
void |
setCustomMenuText(java.lang.String text)
sets the custom menu text
|
void |
setDescriptionText(java.lang.String text)
sets the description text
|
void |
setFunction(boolean function)
Indicates that the defined name refers to a user-defined function.
|
void |
setHelpTopicText(java.lang.String text)
sets the help topic text
|
void |
setHidden(boolean b) |
void |
setKeyboardShortcut(byte shortcut)
sets the keyboard shortcut
|
void |
setNameDefinition(Ptg[] ptgs) |
void |
setNameText(java.lang.String name)
sets the name of the named range
|
void |
setOptionFlag(short flag)
sets the option flag for the named range
|
void |
setSheetNumber(int value) |
void |
setStatusBarText(java.lang.String text)
sets the status bar text
|
java.lang.String |
toString()
get a string representation of the record (for biffview/debugging)
|
getRecordSize, serialize
clone, cloneViaReserialise, 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 byte BUILTIN_FILTER_DB
public NameRecord()
public NameRecord(byte builtin, int sheetNumber)
builtin
- Built-in byte representation for the name record, use the public constantspublic NameRecord(RecordInputStream ris)
ris
- the RecordInputstream to read the record frompublic void setOptionFlag(short flag)
flag
- option flagpublic void setKeyboardShortcut(byte shortcut)
shortcut
- keyboard shortcutpublic int getSheetNumber()
public byte getFnGroup()
FnGroupCountRecord
public void setSheetNumber(int value)
public void setNameText(java.lang.String name)
name
- named range namepublic void setCustomMenuText(java.lang.String text)
text
- custom menu textpublic void setDescriptionText(java.lang.String text)
text
- the description textpublic void setHelpTopicText(java.lang.String text)
text
- help topix textpublic void setStatusBarText(java.lang.String text)
text
- status bar textpublic short getOptionFlag()
public byte getKeyboardShortcut()
public boolean isHiddenName()
public void setHidden(boolean b)
public boolean isFunctionName()
true
if name is a functionpublic void setFunction(boolean function)
function
- true
indicates the name refers to a function.public boolean hasFormula()
true
if name has a formula (named range or defined value)public boolean isCommandName()
public boolean isMacro()
public boolean isComplexFunction()
public boolean isBuiltInName()
public java.lang.String getNameText()
public byte getBuiltInName()
public Ptg[] getNameDefinition()
null
public void setNameDefinition(Ptg[] ptgs)
public java.lang.String getCustomMenuText()
public java.lang.String getDescriptionText()
public java.lang.String getHelpTopicText()
public java.lang.String getStatusBarText()
public void serialize(ContinuableRecordOutput out)
serialize
in class ContinuableRecord
out
- a data output streamprotected int getDataSize()
public int getExternSheetNumber()
public short getSid()
Copyright © 2005-2010 Potix Corporation. All Rights Reserved.