Package loci.poi.hssf.record
Class NameRecord
java.lang.Object
loci.poi.hssf.record.Record
loci.poi.hssf.record.NameRecord
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
FieldsModifier and TypeFieldDescriptionstatic final byteIncluded for completeness sake, not implementedstatic final byteIncluded for completeness sake, not implementedstatic final byteIncluded for completeness sake, not implementedstatic final byteIncluded for completeness sake, not implementedstatic final byteIncluded for completeness sake, not implementedstatic final byteIncluded for completeness sake, not implementedstatic final byteIncluded for completeness sake, not implementedstatic final byteIncluded for completeness sake, not implementedstatic final bytestatic final bytestatic final byteIncluded for completeness sake, not implementedstatic final byteIncluded for completeness sake, not implementedstatic final shortstatic final shortstatic final shortstatic final shortstatic final shortstatic final shortstatic final shortstatic final short -
Constructor Summary
ConstructorsConstructorDescriptionCreates new NameRecordNameRecord(byte builtin, short index) Constructor to create a built-in named regionConstructs a Name record and sets its fields appropriately. -
Method Summary
Modifier and TypeMethodDescriptionprotected voidcalled by the constructor, should set class level fields.getAreaReference(Workbook book) gets the reference , the area only (range)byteGets the Built In Namebytegets the name compressed Unicode flagbytegets the custom menu lengthget the custom menu textshortget the definition lengthgets the description textbytegets the description text lengthshortshortgets the extern sheet numberbytebytegets the help topic lengthget the help topic textshortConvenience method to retrieve the index the name refers to.bytereturns the keyboard shortcutgets the definition, reference (Formula)gets the namebytegets the name lengthshortgets the option flagintreturns the record sizeshortgetSid()return the non static version of the id for this record.byteget the status bar text lengthgets the status bar textintgets the length of all textsshortgets the index to extern sheetbooleanConvenience Function to determine if the name is a built-in namebooleanbooleanbooleanbooleanbooleanisMacro()intserialize(int offset, byte[] data) called by the class that is responsible for writing this sucker.voidsetAreaReference(String ref) sets the reference , the area only (range)voidsetCompressedUnicodeFlag(byte flag) sets the compressed unicode flagvoidsetCustomMenuLength(byte length) sets the custom menu lengthvoidsetCustomMenuText(String text) sets the custom menu textvoidsetDefinitionTextLength(short length) sets the definition (reference - formula) lengthvoidsetDescriptionText(String text) sets the description textvoidsetDescriptionTextLength(byte length) sets the length of named range descriptionvoidsetEqualsToIndexToSheet(short value) voidsetExternSheetNumber(short externSheetNumber) sets the extern sheet numbervoidsetHelpTopicLength(byte length) sets the help topic lengthvoidsetHelpTopicText(String text) sets the help topic textvoidsetKeyboardShortcut(byte shortcut) sets the keyboard shortcutvoidsetNameDefinition(Stack nameDefinition) voidsetNameText(String name) sets the name of the named rangevoidsetNameTextLength(byte length) sets the name of the named range lengthvoidsetOptionFlag(short flag) sets the option flag for the named rangevoidsetStatusBarLength(byte length) sets the length of the status bar textvoidsetStatusBarText(String text) sets the status bar textvoidsetUnused(short index) sets the index number to the extern sheet (thats is what writen in documentation but as i saw , it works differently)toString()get a string representation of the record (for biffview/debugging)protected StringtranslateBuiltInName(byte name) Creates a human readable name for built in typesprotected voidvalidateSid(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
-
Field Details
-
sid
public static final short sid- See Also:
-
BUILTIN_CONSOLIDATE_AREA
public static final byte BUILTIN_CONSOLIDATE_AREAIncluded for completeness sake, not implemented- See Also:
-
BUILTIN_AUTO_OPEN
public static final byte BUILTIN_AUTO_OPENIncluded for completeness sake, not implemented- See Also:
-
BUILTIN_AUTO_CLOSE
public static final byte BUILTIN_AUTO_CLOSEIncluded for completeness sake, not implemented- See Also:
-
BUILTIN_DATABASE
public static final byte BUILTIN_DATABASEIncluded for completeness sake, not implemented- See Also:
-
BUILTIN_CRITERIA
public static final byte BUILTIN_CRITERIAIncluded for completeness sake, not implemented- See Also:
-
BUILTIN_PRINT_AREA
public static final byte BUILTIN_PRINT_AREA- See Also:
-
BUILTIN_PRINT_TITLE
public static final byte BUILTIN_PRINT_TITLE- See Also:
-
BUILTIN_RECORDER
public static final byte BUILTIN_RECORDERIncluded for completeness sake, not implemented- See Also:
-
BUILTIN_DATA_FORM
public static final byte BUILTIN_DATA_FORMIncluded for completeness sake, not implemented- See Also:
-
BUILTIN_AUTO_ACTIVATE
public static final byte BUILTIN_AUTO_ACTIVATEIncluded for completeness sake, not implemented- See Also:
-
BUILTIN_AUTO_DEACTIVATE
public static final byte BUILTIN_AUTO_DEACTIVATEIncluded for completeness sake, not implemented- See Also:
-
BUILTIN_SHEET_TITLE
public static final byte BUILTIN_SHEET_TITLEIncluded for completeness sake, not implemented- See Also:
-
OPT_HIDDEN_NAME
public static final short OPT_HIDDEN_NAME- See Also:
-
OPT_FUNCTION_NAME
public static final short OPT_FUNCTION_NAME- See Also:
-
OPT_COMMAND_NAME
public static final short OPT_COMMAND_NAME- See Also:
-
OPT_MACRO
public static final short OPT_MACRO- See Also:
-
OPT_COMPLEX
public static final short OPT_COMPLEX- See Also:
-
OPT_BUILTIN
public static final short OPT_BUILTIN- See Also:
-
OPT_BINDATA
public static final short OPT_BINDATA- See Also:
-
-
Constructor Details
-
NameRecord
public NameRecord()Creates new NameRecord -
NameRecord
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 constantsindex-
-
-
Method Details
-
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:
-
getFnGroup
public byte getFnGroup()- Returns:
- function group
- See Also:
-
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
sets the name of the named range- Parameters:
name- named range name
-
setCustomMenuText
sets the custom menu text- Parameters:
text- custom menu text
-
setDescriptionText
sets the description text- Parameters:
text- the description text
-
setHelpTopicText
sets the help topic text- Parameters:
text- help topix text
-
setStatusBarText
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
gets the name- Returns:
- name
-
getBuiltInName
public byte getBuiltInName()Gets the Built In Name- Returns:
- the built in Name
-
getNameDefinition
gets the definition, reference (Formula)- Returns:
- definition -- can be null if we cant parse ptgs
-
setNameDefinition
-
getCustomMenuText
get the custom menu text- Returns:
- custom menu text
-
getDescriptionText
gets the description text- Returns:
- description text
-
getHelpTopicText
get the help topic text- Returns:
- gelp topic text
-
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:
validateSidin classRecord- 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 -
getTextsLength
public int getTextsLength()gets the length of all texts- Returns:
- total length
-
getRecordSize
public int getRecordSize()returns the record size- Overrides:
getRecordSizein classRecord
-
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
-
getAreaReference
gets the reference , the area only (range)- Returns:
- area reference
-
setAreaReference
sets the reference , the area only (range)- Parameters:
ref- area reference
-
fillFields
called by the constructor, should set class level fields. Should throw runtime exception for bad/icomplete data.- Specified by:
fillFieldsin classRecord- Parameters:
in- the RecordInputstream to read the record from
-
getSid
public short getSid()return the non static version of the id for this record. -
toString
Description copied from class:Recordget a string representation of the record (for biffview/debugging) -
translateBuiltInName
Creates a human readable name for built in types- Returns:
- Unknown if the built-in name cannot be translated
-