Package org.apache.poi.hssf.record
Class NameRecord
java.lang.Object
org.apache.poi.hssf.record.RecordBase
org.apache.poi.hssf.record.Record
org.apache.poi.hssf.record.cont.ContinuableRecord
org.apache.poi.hssf.record.NameRecord
Title: DEFINEDNAME Record (0x0018)
Description: Defines a named range within a workbook.
-
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 bytestatic final byteIncluded for completeness sake, not implementedstatic final byteIncluded for completeness sake, not implementedstatic final short -
Constructor Summary
ConstructorsConstructorDescriptionCreates new NameRecordNameRecord(byte builtin, int sheetNumber) Constructor to create a built-in named regioncalled by the constructor, should set class level fields. -
Method Summary
Modifier and TypeMethodDescriptionbyteGets the Built In Nameget the custom menu textprotected intgets the description textintgets the extern sheet numberbyteget the help topic textbytereturns the keyboard shortcutPtg[]gets the definition, reference (Formula)gets the nameshortgets the option flagintFor named ranges, and built-in namesshortgetSid()return the non static version of the id for this record.gets the status bar textbooleanbooleanConvenience Function to determine if the name is a built-in namebooleanbooleanbooleanbooleanbooleanisMacro()voidNameRecord can span intovoidsetCustomMenuText(String text) sets the custom menu textvoidsetDescriptionText(String text) sets the description textvoidsetFunction(boolean function) Indicates that the defined name refers to a user-defined function.voidsetHelpTopicText(String text) sets the help topic textvoidsetHidden(boolean b) voidsetKeyboardShortcut(byte shortcut) sets the keyboard shortcutvoidsetNameDefinition(Ptg[] ptgs) voidsetNameText(String name) sets the name of the named rangevoidsetOptionFlag(short flag) sets the option flag for the named rangevoidsetSheetNumber(int value) voidsetStatusBarText(String text) sets the status bar texttoString()get a string representation of the record (for biffview/debugging)Methods inherited from class org.apache.poi.hssf.record.cont.ContinuableRecord
getRecordSize, serializeMethods inherited from class org.apache.poi.hssf.record.Record
clone, cloneViaReserialise, 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:
-
BUILTIN_FILTER_DB
public static final byte BUILTIN_FILTER_DB- See Also:
-
-
Constructor Details
-
NameRecord
public NameRecord()Creates new NameRecord -
NameRecord
public NameRecord(byte builtin, int sheetNumber) Constructor to create a built-in named region- Parameters:
builtin- Built-in byte representation for the name record, use the public constantssheetNumber- the sheet which the name applies to
-
NameRecord
called by the constructor, should set class level fields. Should throw runtime exception for bad/icomplete data.- Parameters:
ris- the RecordInputstream to read the record from
-
-
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
-
getSheetNumber
public int getSheetNumber()For named ranges, and built-in names- Returns:
- the 1-based sheet number.
-
getFnGroup
public byte getFnGroup()- Returns:
- function group
- See Also:
-
setSheetNumber
public void setSheetNumber(int value) -
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
-
isHiddenName
public boolean isHiddenName()- Returns:
- true if name is hidden
-
setHidden
public void setHidden(boolean b) -
isFunctionName
public boolean isFunctionName()- Returns:
trueif name is a function
-
setFunction
public void setFunction(boolean function) Indicates that the defined name refers to a user-defined function. This attribute is used when there is an add-in or other code project associated with the file.- Parameters:
function-trueindicates the name refers to a function.
-
hasFormula
public boolean hasFormula()- Returns:
trueif name has a formula (named range or defined value)
-
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- Returns:
- true, 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:
- the name formula. never
null
-
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
-
serialize
NameRecord can span into- Specified by:
serializein classContinuableRecord- Parameters:
out- a data output stream
-
getDataSize
protected int getDataSize() -
getExternSheetNumber
public int getExternSheetNumber()gets the extern sheet number- Returns:
- extern sheet index
-
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)
-