|
| |
|
| java.lang.Object
 org.apache.poi.hssf.record.Record
org.apache.poi.hssf.record.NameRecord
| NameRecord | | public class NameRecord extends Record (Code) | | Title: Name Record (aka Named Range)
Description: Defines a named range within a workbook.
REFERENCE:
author:
Libin Roman (Vista Portal LDT. Developer)
author:
Sergei Kozello (sergeikozello at mail.ru)
author:
Glen Stampoultzis (glens at apache.org)
version:
1.0-pre |
| BUILTIN_AUTO_ACTIVATE | | final public static byte BUILTIN_AUTO_ACTIVATE(Code) | | Included for completeness sake, not implemented
|
| BUILTIN_AUTO_CLOSE | | final public static byte BUILTIN_AUTO_CLOSE(Code) | | Included for completeness sake, not implemented
|
| BUILTIN_AUTO_DEACTIVATE | | final public static byte BUILTIN_AUTO_DEACTIVATE(Code) | | Included for completeness sake, not implemented
|
| BUILTIN_AUTO_OPEN | | final public static byte BUILTIN_AUTO_OPEN(Code) | | Included for completeness sake, not implemented
|
| BUILTIN_CONSOLIDATE_AREA | | final public static byte BUILTIN_CONSOLIDATE_AREA(Code) | | Included for completeness sake, not implemented
|
| BUILTIN_CRITERIA | | final public static byte BUILTIN_CRITERIA(Code) | | Included for completeness sake, not implemented
|
| BUILTIN_DATABASE | | final public static byte BUILTIN_DATABASE(Code) | | Included for completeness sake, not implemented
|
| BUILTIN_DATA_FORM | | final public static byte BUILTIN_DATA_FORM(Code) | | Included for completeness sake, not implemented
|
| BUILTIN_PRINT_AREA | | final public static byte BUILTIN_PRINT_AREA(Code) | | |
| BUILTIN_PRINT_TITLE | | final public static byte BUILTIN_PRINT_TITLE(Code) | | |
| BUILTIN_RECORDER | | final public static byte BUILTIN_RECORDER(Code) | | Included for completeness sake, not implemented
|
| BUILTIN_SHEET_TITLE | | final public static byte BUILTIN_SHEET_TITLE(Code) | | Included for completeness sake, not implemented
|
| OPT_BINDATA | | final public static short OPT_BINDATA(Code) | | |
| OPT_BUILTIN | | final public static short OPT_BUILTIN(Code) | | |
| OPT_COMMAND_NAME | | final public static short OPT_COMMAND_NAME(Code) | | |
| OPT_COMPLEX | | final public static short OPT_COMPLEX(Code) | | |
| OPT_FUNCTION_NAME | | final public static short OPT_FUNCTION_NAME(Code) | | |
| OPT_HIDDEN_NAME | | final public static short OPT_HIDDEN_NAME(Code) | | |
| OPT_MACRO | | final public static short OPT_MACRO(Code) | | |
| sid | | final public static short sid(Code) | | |
| NameRecord | | public NameRecord()(Code) | | Creates new NameRecord
|
| NameRecord | | public NameRecord(RecordInputStream in)(Code) | | 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)(Code) | | Constructor to create a built-in named region
Parameters:
builtin - Built-in byte representation for the name record, use the public constants
Parameters:
index - |
| fillFields | | protected void fillFields(RecordInputStream in)(Code) | | called by the constructor, should set class level fields. Should throw
runtime exception for bad/icomplete data.
Parameters:
in - the RecordInputstream to read the record from |
| getAreaReference | | public String getAreaReference(Workbook book)(Code) | | gets the reference , the area only (range)
area reference |
| getBuiltInName | | public byte getBuiltInName()(Code) | | Gets the Built In Name
the built in Name |
| getCompressedUnicodeFlag | | public byte getCompressedUnicodeFlag()(Code) | | gets the name compressed Unicode flag
compressed unicode flag |
| getCustomMenuLength | | public byte getCustomMenuLength()(Code) | | gets the custom menu length
custom menu length |
| getCustomMenuText | | public String getCustomMenuText()(Code) | | get the custom menu text
custom menu text |
| getDefinitionLength | | public short getDefinitionLength()(Code) | | get the definition length
definition length |
| getDescriptionText | | public String getDescriptionText()(Code) | | gets the description text
description text |
| getDescriptionTextLength | | public byte getDescriptionTextLength()(Code) | | gets the description text length
description text length |
| getEqualsToIndexToSheet | | public short getEqualsToIndexToSheet()(Code) | | |
| getExternSheetNumber | | public short getExternSheetNumber()(Code) | | gets the extern sheet number
extern sheet index |
| getHelpTopicLength | | public byte getHelpTopicLength()(Code) | | gets the help topic length
help topic length |
| getHelpTopicText | | public String getHelpTopicText()(Code) | | get the help topic text
gelp topic text |
| getKeyboardShortcut | | public byte getKeyboardShortcut()(Code) | | returns the keyboard shortcut
keyboard shortcut |
| getNameDefinition | | public List getNameDefinition()(Code) | | gets the definition, reference (Formula)
definition -- can be null if we cant parse ptgs |
| getNameText | | public String getNameText()(Code) | | gets the name
name |
| getNameTextLength | | public byte getNameTextLength()(Code) | | gets the name length
name length |
| getOptionFlag | | public short getOptionFlag()(Code) | | gets the option flag
option flag |
| getRecordSize | | public int getRecordSize()(Code) | | returns the record size
|
| getSid | | public short getSid()(Code) | | return the non static version of the id for this record.
|
| getStatusBarLength | | public byte getStatusBarLength()(Code) | | get the status bar text length
satus bar length |
| getStatusBarText | | public String getStatusBarText()(Code) | | gets the status bar text
status bar text |
| getTextsLength | | public int getTextsLength()(Code) | | gets the length of all texts
total length |
| getUnused | | public short getUnused()(Code) | | gets the index to extern sheet
index to extern sheet |
| isBuiltInName | | public boolean isBuiltInName()(Code) | | Convenience Function to determine if the name is a built-in name
|
| isCommandName | | public boolean isCommandName()(Code) | | true if name is a command |
| isComplexFunction | | public boolean isComplexFunction()(Code) | | true if array formula or user defined |
| isFunctionName | | public boolean isFunctionName()(Code) | | true if name is a function |
| isHiddenName | | public boolean isHiddenName()(Code) | | true if name is hidden |
| isMacro | | public boolean isMacro()(Code) | | true if function macro or command macro |
| serialize | | public int serialize(int offset, byte[] data)(Code) | | called by the class that is responsible for writing this sucker.
Subclasses should implement this so that their data is passed back in a
Parameters:
offset - to begin writing at
Parameters:
data - byte array containing instance data number of bytes written |
| setAreaReference | | public void setAreaReference(String ref)(Code) | | sets the reference , the area only (range)
Parameters:
ref - area reference |
| setCompressedUnicodeFlag | | public void setCompressedUnicodeFlag(byte flag)(Code) | | sets the compressed unicode flag
Parameters:
flag - unicode flag |
| setCustomMenuLength | | public void setCustomMenuLength(byte length)(Code) | | sets the custom menu length
Parameters:
length - custom menu length |
| setCustomMenuText | | public void setCustomMenuText(String text)(Code) | | sets the custom menu text
Parameters:
text - custom menu text |
| setDefinitionTextLength | | public void setDefinitionTextLength(short length)(Code) | | sets the definition (reference - formula) length
Parameters:
length - defenition length |
| setDescriptionText | | public void setDescriptionText(String text)(Code) | | sets the description text
Parameters:
text - the description text |
| setDescriptionTextLength | | public void setDescriptionTextLength(byte length)(Code) | | sets the length of named range description
Parameters:
length - description length |
| setEqualsToIndexToSheet | | public void setEqualsToIndexToSheet(short value)(Code) | | |
| setExternSheetNumber | | public void setExternSheetNumber(short externSheetNumber)(Code) | | sets the extern sheet number
Parameters:
externSheetNumber - extern sheet number |
| setHelpTopicLength | | public void setHelpTopicLength(byte length)(Code) | | sets the help topic length
Parameters:
length - help topic length |
| setHelpTopicText | | public void setHelpTopicText(String text)(Code) | | sets the help topic text
Parameters:
text - help topix text |
| setKeyboardShortcut | | public void setKeyboardShortcut(byte shortcut)(Code) | | sets the keyboard shortcut
Parameters:
shortcut - keyboard shortcut |
| setNameDefinition | | public void setNameDefinition(Stack nameDefinition)(Code) | | |
| setNameText | | public void setNameText(String name)(Code) | | sets the name of the named range
Parameters:
name - named range name |
| setNameTextLength | | public void setNameTextLength(byte length)(Code) | | sets the name of the named range length
Parameters:
length - name length |
| setOptionFlag | | public void setOptionFlag(short flag)(Code) | | sets the option flag for the named range
Parameters:
flag - option flag |
| setStatusBarLength | | public void setStatusBarLength(byte length)(Code) | | sets the length of the status bar text
Parameters:
length - status bar text length |
| setStatusBarText | | public void setStatusBarText(String text)(Code) | | sets the status bar text
Parameters:
text - status bar text |
| setUnused | | public void setUnused(short index)(Code) | | 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 |
| translateBuiltInName | | protected String translateBuiltInName(byte name)(Code) | | Creates a human readable name for built in types
Unknown if the built-in name cannot be translated |
| validateSid | | protected void validateSid(short id)(Code) | | called by constructor, should throw runtime exception in the event of a
record passed with a differing ID.
Parameters:
id - alleged id for this record |
|
|
|