org.apache.poi.hssf.model
public final class Workbook extends java.lang.Object implements Model
This file contains the low level binary records starting at the workbook's BOF and ending with the workbook's EOF. Use HSSFWorkbook for a high level representation.
The structures of the highlevel API use references to this to perform most of their operations. Its probably unwise to use these low level structures directly unless you really know what you're doing. I recommend you read the Microsoft Excel 97 Developer's Kit (Microsoft Press) and the documentation at http://sc.openoffice.org/excelfileformat.pdf before even attempting to use this.
HSSFWorkbook
Modifier and Type | Field and Description |
---|---|
protected int |
numfonts |
protected int |
numxfs |
protected SSTRecord |
sst
this contains a reference to the SSTRecord so that new stings can be added
to it.
|
Constructor and Description |
---|
Workbook()
Creates new Workbook with no intitialization --useless right now
|
Modifier and Type | Method and Description |
---|---|
int |
addBSERecord(EscherBSERecord e) |
NameRecord |
addName(NameRecord name)
creates new name
|
int |
addSSTString(UnicodeString string)
Adds a string to the SST table and returns its index (if its a duplicate
just returns its index and update the counts) ASSUMES compressed unicode
(meaning 8bit)
|
short |
checkExternSheet(int sheetNumber)
returns the extern sheet number for specific sheet number ,
if this sheet doesn't exist in extern sheet , add it
|
void |
cloneDrawings(Sheet sheet)
Check if the cloned sheet has drawings.
|
NameRecord |
createBuiltInName(byte builtInName,
int sheetNumber)
Generates a NameRecord to represent a built-in region
|
ExtendedFormatRecord |
createCellXF()
creates a new Cell-type Extneded Format Record and adds it to the end of
ExtendedFormatRecords collection
|
void |
createDrawingGroup()
Creates a primary drawing group record.
|
int |
createFormat(java.lang.String formatString)
Creates a FormatRecord, inserts it, and returns the index code.
|
NameRecord |
createName()
creates new name
|
FontRecord |
createNewFont()
creates a new font record and adds it to the "font table".
|
StyleRecord |
createStyleRecord(int xfIndex)
Creates a new StyleRecord, for the given Extended
Format index, and adds it onto the end of the
records collection
|
static Workbook |
createWorkbook()
Creates an empty workbook object with three blank sheets and all the empty
fields.
|
static Workbook |
createWorkbook(java.util.List<Record> recs)
read support for low level
API.
|
boolean |
doesContainsSheetName(java.lang.String name,
int excludeSheetIdx)
Determines whether a workbook contains the provided sheet name.
|
void |
findDrawingGroup()
Finds the primary drawing group, if one already exists
|
Record |
findFirstRecordBySid(short sid)
Returns the first occurance of a record matching a particular sid.
|
int |
findFirstRecordLocBySid(short sid)
Returns the index of a record matching a particular sid.
|
Record |
findNextRecordBySid(short sid,
int pos)
Returns the next occurance of a record matching a particular sid.
|
java.lang.String |
findSheetNameFromExternSheet(int externSheetIndex)
finds the sheet name by his extern sheet index
|
BackupRecord |
getBackupRecord()
Returns the position of the backup record.
|
EscherBSERecord |
getBSERecord(int pictureIndex) |
PaletteRecord |
getCustomPalette()
Returns the custom palette in use for this workbook; if a custom palette record
does not exist, then it is created.
|
DrawingManager2 |
getDrawingManager() |
ExtendedFormatRecord |
getExFormatAt(int index)
gets the ExtendedFormatRecord at the given 0-based index
|
EvaluationWorkbook.ExternalSheet |
getExternalSheet(int externSheetIndex) |
int |
getExternalSheetIndex(java.lang.String workbookName,
java.lang.String sheetName) |
FileSharingRecord |
getFileSharing() |
int |
getFontIndex(FontRecord font)
Retrieves the index of the given font
|
FontRecord |
getFontRecordAt(int idx)
gets the font record at the given index in the font table.
|
short |
getFormat(java.lang.String format,
boolean createIfNotFound)
Returns a format index that matches the passed in format.
|
java.util.List |
getFormats()
Returns the list of FormatRecords in the workbook.
|
java.util.List |
getHyperlinks() |
NameRecord |
getNameRecord(int index)
gets the name record
|
NameXPtg |
getNameXPtg(java.lang.String name) |
int |
getNumberOfFontRecords()
gets the number of font records
|
int |
getNumExFormats()
get the number of ExtendedFormat records contained in this workbook.
|
int |
getNumNames()
gets the total number of names
|
int |
getNumRecords() |
int |
getNumSheets()
returns the number of boundsheet objects contained in this workbook.
|
java.util.List<Record> |
getRecords() |
int |
getSheetIndex(java.lang.String name)
get the sheet's index
|
int |
getSheetIndexFromExternSheetIndex(int externSheetNumber)
Finds the sheet index for a particular external sheet number.
|
java.lang.String |
getSheetName(int sheetIndex)
gets the name for a given sheet.
|
int |
getSize() |
NameRecord |
getSpecificBuiltinRecord(byte name,
int sheetNumber)
Retrieves the Builtin NameRecord that matches the name and index
There shouldn't be too many names to make the sequential search too slow
|
UnicodeString |
getSSTString(int str)
given an index into the SST table, this function returns the corresponding String value
|
StyleRecord |
getStyleRecord(int xfIndex)
Returns the StyleRecord for the given
xfIndex, or null if that ExtendedFormat doesn't
have a Style set.
|
WindowOneRecord |
getWindowOne() |
WriteAccessRecord |
getWriteAccess() |
WriteProtectRecord |
getWriteProtect() |
void |
insertSST()
use this function to add a Shared String Table to an existing sheet (say
generated by a different java api) without an sst....
|
boolean |
isSheetHidden(int sheetnum)
Gets the hidden flag for a given sheet.
|
boolean |
isSheetVeryHidden(int sheetnum)
Gets the very hidden flag for a given sheet.
|
boolean |
isUsing1904DateWindowing()
Whether date windowing is based on 1/2/1904 or 1/1/1900.
|
boolean |
isWriteProtected()
is the workbook protected with a password (not encrypted)?
|
void |
removeBuiltinRecord(byte name,
int sheetIndex)
Removes the specified Builtin NameRecord that matches the name and index
|
void |
removeExFormatRecord(ExtendedFormatRecord rec)
Removes the given ExtendedFormatRecord record from the
file's list.
|
void |
removeFontRecord(FontRecord rec)
Removes the given font record from the
file's list.
|
void |
removeName(int nameIndex)
removes the name
|
void |
removeSheet(int sheetIndex) |
java.lang.String |
resolveNameXText(int refIndex,
int definedNameIndex) |
int |
serialize(int offset,
byte[] data)
Serializes all records int the worksheet section into a big byte array.
|
void |
setSheetBof(int sheetIndex,
int pos)
Sets the BOF for a given sheet
|
void |
setSheetHidden(int sheetnum,
boolean hidden)
Hide or unhide a sheet
|
void |
setSheetHidden(int sheetnum,
int hidden)
Hide or unhide a sheet.
|
void |
setSheetName(int sheetnum,
java.lang.String sheetname)
sets the name for a given sheet.
|
void |
setSheetOrder(java.lang.String sheetname,
int pos)
sets the order of appearance for a given sheet.
|
void |
unwriteProtectWorkbook()
removes the write protect flag
|
void |
updateNamesAfterCellShift(FormulaShifter shifter)
Updates named ranges due to moving of cells
|
void |
writeProtectWorkbook(java.lang.String password,
java.lang.String username)
protect a workbook with a password (not encypted, just sets writeprotect
flags and the password.
|
protected SSTRecord sst
protected int numxfs
protected int numfonts
public Workbook()
createWorkbook(List)
public static Workbook createWorkbook(java.util.List<Record> recs)
recs
- an array of Record objectspublic static Workbook createWorkbook()
public NameRecord getSpecificBuiltinRecord(byte name, int sheetNumber)
name
- byte representation of the builtin name to matchsheetNumber
- 1-based sheet numberpublic void removeBuiltinRecord(byte name, int sheetIndex)
name
- byte representation of the builtin to matchsheetIndex
- zero-based sheet referencepublic int getNumRecords()
public FontRecord getFontRecordAt(int idx)
idx
- the index to look at (0 or greater but NOT 4)public int getFontIndex(FontRecord font)
public FontRecord createNewFont()
public void removeFontRecord(FontRecord rec)
public int getNumberOfFontRecords()
public void setSheetBof(int sheetIndex, int pos)
sheetIndex
- the number of the sheet to set the positing of the bof forpos
- the actual bof positionpublic BackupRecord getBackupRecord()
public void setSheetName(int sheetnum, java.lang.String sheetname)
sheetnum
- the sheet number (0 based)sheetname
- the name for the sheetpublic boolean doesContainsSheetName(java.lang.String name, int excludeSheetIdx)
name
- the name to test (case insensitive match)excludeSheetIdx
- the sheet to exclude from the check or -1 to include all sheets in the check.public void setSheetOrder(java.lang.String sheetname, int pos)
sheetname
- the name of the sheet to reorderpos
- the position that we want to insert the sheet into (0 based)public java.lang.String getSheetName(int sheetIndex)
sheetIndex
- the sheet number (0 based)public boolean isSheetHidden(int sheetnum)
isSheetVeryHidden(int)
)sheetnum
- the sheet number (0 based)public boolean isSheetVeryHidden(int sheetnum)
isSheetHidden(int)
)sheetnum
- the sheet number (0 based)public void setSheetHidden(int sheetnum, boolean hidden)
sheetnum
- The sheet numberhidden
- True to mark the sheet as hidden, false otherwisepublic void setSheetHidden(int sheetnum, int hidden)
sheetnum
- The sheet numberhidden
- 0 for not hidden, 1 for hidden, 2 for very hiddenpublic int getSheetIndex(java.lang.String name)
name
- sheet namepublic void removeSheet(int sheetIndex)
sheetIndex
- zero based sheet indexpublic int getNumSheets()
public int getNumExFormats()
public ExtendedFormatRecord getExFormatAt(int index)
index
- of the Extended format record (0-based)public void removeExFormatRecord(ExtendedFormatRecord rec)
public ExtendedFormatRecord createCellXF()
public StyleRecord getStyleRecord(int xfIndex)
public StyleRecord createStyleRecord(int xfIndex)
public int addSSTString(UnicodeString string)
string
- the string to be added to the SSTRecordpublic UnicodeString getSSTString(int str)
public void insertSST()
createExtendedSST()
,
SSTRecord
public int serialize(int offset, byte[] data)
offset
- of the data to be writtendata
- array of bytes to write this topublic int getSize()
public java.lang.String findSheetNameFromExternSheet(int externSheetIndex)
externSheetIndex
- extern sheet indexpublic EvaluationWorkbook.ExternalSheet getExternalSheet(int externSheetIndex)
public int getSheetIndexFromExternSheetIndex(int externSheetNumber)
externSheetNumber
- The external sheet number to convertpublic short checkExternSheet(int sheetNumber)
sheetNumber
- sheet numberpublic int getExternalSheetIndex(java.lang.String workbookName, java.lang.String sheetName)
public int getNumNames()
public NameRecord getNameRecord(int index)
index
- name indexpublic NameRecord createName()
public NameRecord addName(NameRecord name)
public NameRecord createBuiltInName(byte builtInName, int sheetNumber)
public void removeName(int nameIndex)
nameIndex
- name indexpublic short getFormat(java.lang.String format, boolean createIfNotFound)
format
- the format stringcreateIfNotFound
- creates a new format if format not foundpublic java.util.List getFormats()
public int createFormat(java.lang.String formatString)
formatString
- the format stringFormatRecord
,
Record
public Record findFirstRecordBySid(short sid)
public int findFirstRecordLocBySid(short sid)
sid
- The sid of the record to matchpublic Record findNextRecordBySid(short sid, int pos)
public java.util.List getHyperlinks()
public java.util.List<Record> getRecords()
public boolean isUsing1904DateWindowing()
public PaletteRecord getCustomPalette()
public void findDrawingGroup()
public void createDrawingGroup()
public WindowOneRecord getWindowOne()
public EscherBSERecord getBSERecord(int pictureIndex)
public int addBSERecord(EscherBSERecord e)
public DrawingManager2 getDrawingManager()
public WriteProtectRecord getWriteProtect()
public WriteAccessRecord getWriteAccess()
public FileSharingRecord getFileSharing()
public boolean isWriteProtected()
public void writeProtectWorkbook(java.lang.String password, java.lang.String username)
password
- to setpublic void unwriteProtectWorkbook()
public java.lang.String resolveNameXText(int refIndex, int definedNameIndex)
refIndex
- Index to REF entry in EXTERNSHEET record in the Link TabledefinedNameIndex
- zero-based to DEFINEDNAME or EXTERNALNAME recordpublic NameXPtg getNameXPtg(java.lang.String name)
public void cloneDrawings(Sheet sheet)
sheet
- the cloned sheetpublic void updateNamesAfterCellShift(FormulaShifter shifter)
Copyright 2014 The Apache Software Foundation or its licensors, as applicable.