|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--org.apache.poi.hssf.record.Record | +--org.apache.poi.hssf.record.NameRecord
Title: Name Record (aka Named Range)
Description: Defines a named range within a workbook.
REFERENCE:
Field Summary | |
static short |
sid
|
Constructor Summary | |
NameRecord()
Creates new NameRecord |
|
NameRecord(short id,
short size,
byte[] data)
Constructs a Name record and sets its fields appropriately. |
|
NameRecord(short id,
short size,
byte[] data,
int offset)
Constructs a Name record and sets its fields appropriately. |
Method Summary | |
protected void |
fillFields(byte[] data,
short size,
int offset)
called by the constructor, should set class level fields. |
java.lang.String |
getAreaReference()
gets the reference , the area only (range) |
byte |
getCompressedUnicodeFlag()
gets the name compressed Unicode flag |
byte |
getCustomMenuLength()
gets the custom menu length |
java.lang.String |
getCustomMenuText()
get the custom menu text |
short |
getDefinitionTextLength()
get the definition length |
java.lang.String |
getDescriptionText()
gets the description text |
byte |
getDescriptionTextLength()
gets the description text length |
short |
getExternSheetNumber()
gets the extern sheet number |
byte |
getHelpTopicLength()
gets the help topic length |
java.lang.String |
getHelpTopicText()
get the help topic text |
short |
getIndexToSheet()
gets the index to extern sheet |
byte |
getKeyboardShortcut()
returns the keyboard shortcut |
java.util.List |
getNameDefinition()
gets the definition, reference (Formula) |
java.lang.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 |
java.lang.String |
getStatusBarText()
gets the status bar text |
int |
getTextsLength()
gets the length of all texts |
int |
serialize(int offset,
byte[] data)
called by the class that is responsible for writing this sucker. |
void |
setAreaReference(java.lang.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(java.lang.String text)
sets the custom menu text |
void |
setDefinitionTextLength(short length)
sets the definition (reference - formula) length |
void |
setDescriptionText(java.lang.String text)
sets the description text |
void |
setDescriptionTextLength(byte length)
sets the length of named range description |
void |
setExternSheetNumber(short externSheetNumber)
sets the extern sheet number |
void |
setHelpTopicLength(byte length)
sets the help topic length |
void |
setHelpTopicText(java.lang.String text)
sets the help topic text |
void |
setIndexToSheet(short index)
sets the index number to the extern sheet (thats is what writen in ducomentetion but as i saw , its work direrent) |
void |
setKeyboardShortcut(byte shortcut)
sets the keyboard shortcut |
void |
setNameText(java.lang.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(java.lang.String text)
sets the status bar text |
protected void |
validateSid(short id)
called by constructor, should throw runtime exception in the event of a record passed with a differing ID. |
Methods inherited from class org.apache.poi.hssf.record.Record |
fillFields, isInValueSection, isValue, processContinueRecord, serialize, toString |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
public static final short sid
Constructor Detail |
public NameRecord()
public NameRecord(short id, short size, byte[] data)
id
- id must be 0x18 or an exception will be throw upon validationsize
- the size of the data area of the recorddata
- data of the record (should not contain sid/len)public NameRecord(short id, short size, byte[] data, int offset)
id
- id must be 0x18 or an exception will be throw upon validationsize
- the size of the data area of the recorddata
- data of the record (should not contain sid/len)offset
- of the record's dataMethod Detail |
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 setIndexToSheet(short index)
index
- extern sheet indexpublic 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(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 byte getNameTextLength()
public short getDefinitionTextLength()
public short getIndexToSheet()
public byte getCustomMenuLength()
public byte getDescriptionTextLength()
public byte getHelpTopicLength()
public byte getStatusBarLength()
public byte getCompressedUnicodeFlag()
public java.lang.String getNameText()
public java.util.List getNameDefinition()
public java.lang.String getCustomMenuText()
public java.lang.String getDescriptionText()
public java.lang.String getHelpTopicText()
public java.lang.String getStatusBarText()
protected void validateSid(short id)
validateSid
in class Record
id
- alleged id for this recordpublic int serialize(int offset, byte[] data)
serialize
in class Record
offset
- to begin writing atdata
- byte array containing instance datapublic int getTextsLength()
public int getRecordSize()
getRecordSize
in class Record
public short getExternSheetNumber()
public void setExternSheetNumber(short externSheetNumber)
externSheetNumber
- extern sheet numberpublic java.lang.String getAreaReference()
public void setAreaReference(java.lang.String ref)
ref
- area referenceprotected void fillFields(byte[] data, short size, int offset)
fillFields
in class Record
data
- raw datasize
- size of dataoffset
- of the record's data (provided a big array of the file)public short getSid()
getSid
in class Record
|
jakarta-poi 1.6.0-dev | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |