|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectorg.apache.poi.POIDocument
org.apache.poi.hssf.usermodel.HSSFWorkbook
public final class HSSFWorkbook
High level representation of a workbook. This is the first object most users will construct whether they are reading or writing a workbook. It is also the top level object for creating new sheets/etc.
InternalWorkbook,
HSSFSheet| Field Summary | |
|---|---|
protected java.util.List<HSSFSheet> |
_sheets
this holds the HSSFSheet objects attached to this workbook |
static int |
INITIAL_CAPACITY
used for compile-time performance/memory optimization. |
| Fields inherited from class org.apache.poi.POIDocument |
|---|
directory |
| Fields inherited from interface org.apache.poi.ss.usermodel.Workbook |
|---|
PICTURE_TYPE_DIB, PICTURE_TYPE_EMF, PICTURE_TYPE_JPEG, PICTURE_TYPE_PICT, PICTURE_TYPE_PNG, PICTURE_TYPE_WMF, SHEET_STATE_HIDDEN, SHEET_STATE_VERY_HIDDEN, SHEET_STATE_VISIBLE |
| Constructor Summary | |
|---|---|
HSSFWorkbook()
Creates new HSSFWorkbook from scratch (start here!) |
|
HSSFWorkbook(DirectoryNode directory,
boolean preserveNodes)
given a POI POIFSFileSystem object, and a specific directory within it, read in its Workbook and populate the high and low level models. |
|
HSSFWorkbook(DirectoryNode directory,
POIFSFileSystem fs,
boolean preserveNodes)
given a POI POIFSFileSystem object, and a specific directory within it, read in its Workbook and populate the high and low level models. |
|
HSSFWorkbook(java.io.InputStream s)
|
|
HSSFWorkbook(java.io.InputStream s,
boolean preserveNodes)
Companion to HSSFWorkbook(POIFSFileSystem), this constructs the POI filesystem around your inputstream. |
|
HSSFWorkbook(POIFSFileSystem fs)
|
|
HSSFWorkbook(POIFSFileSystem fs,
boolean preserveNodes)
given a POI POIFSFileSystem object, read in its Workbook and populate the high and low level models. |
|
| Method Summary | |
|---|---|
int |
addPicture(byte[] pictureData,
int format)
Adds a picture to the workbook. |
int |
addSSTString(java.lang.String string)
Deprecated. Do not call this method from your applications. Use the methods available in the HSSFRow to add string HSSFCells |
void |
addToolPack(UDFFinder toopack)
Register a new toolpack in this workbook. |
boolean |
changeExternalReference(java.lang.String oldUrl,
java.lang.String newUrl)
Changes an external referenced file to another file. |
HSSFSheet |
cloneSheet(int sheetIndex)
create an HSSFSheet from an existing sheet in the HSSFWorkbook. |
static HSSFWorkbook |
create(InternalWorkbook book)
|
HSSFCellStyle |
createCellStyle()
Create a new Cell style and add it to the workbook's style table. |
HSSFDataFormat |
createDataFormat()
Returns the instance of HSSFDataFormat for this workbook. |
HSSFFont |
createFont()
create a new Font and add it to the workbook's font table |
HSSFName |
createName()
creates a new named range and add it to the model |
HSSFSheet |
createSheet()
create an HSSFSheet for this HSSFWorkbook, adds it to the sheets and returns the high level representation. |
HSSFSheet |
createSheet(java.lang.String sheetname)
Create a new sheet for this Workbook and return the high level representation. |
void |
dumpDrawingGroupRecords(boolean fat)
Spits out a list of all the drawing records in the workbook. |
HSSFFont |
findFont(short boldWeight,
short color,
short fontHeight,
java.lang.String name,
boolean italic,
boolean strikeout,
short typeOffset,
byte underline)
Finds a font that matches the one with the supplied attributes |
java.lang.String |
findSheetNameFromExternSheet(int externSheetIndex)
Deprecated. for POI internal use only (formula rendering). This method is likely to be removed in future versions of POI. |
int |
getActiveSheetIndex()
gets the tab whose data is actually seen when the sheet is opened. |
java.util.List<HSSFObjectData> |
getAllEmbeddedObjects()
Gets all embedded OLE2 objects from the Workbook. |
java.util.List<HSSFPictureData> |
getAllPictures()
Gets all pictures from the Workbook. |
boolean |
getBackupFlag()
determine whether the Excel GUI will backup the workbook when saving. |
byte[] |
getBytes()
Method getBytes - get the bytes of just the HSSF portions of the XLS file. |
HSSFCellStyle |
getCellStyleAt(short idx)
get the cell style object at the given index |
HSSFCreationHelper |
getCreationHelper()
Returns an object that handles instantiating concrete classes of the various instances one needs for HSSF and XSSF. |
HSSFPalette |
getCustomPalette()
|
short |
getDisplayedTab()
Deprecated. - Misleading name - use getFirstVisibleTab() |
int |
getExternalSheetIndex(int internalSheetIndex)
Deprecated. for POI internal use only (formula parsing). This method is likely to be removed in future versions of POI. |
int |
getFirstVisibleTab()
sets the first tab that is displayed in the list of tabs in excel. |
HSSFFont |
getFontAt(short idx)
Get the font at the given index number |
boolean |
getForceFormulaRecalculation()
Whether Excel will be asked to recalculate all formulas when the workbook is opened. |
Row.MissingCellPolicy |
getMissingCellPolicy()
Retrieves the current policy on what to do when getting missing or blank cells from a row. |
HSSFName |
getName(java.lang.String name)
|
HSSFName |
getNameAt(int nameIndex)
|
int |
getNameIndex(java.lang.String name)
Gets the defined name index by name Note: Excel defined names are case-insensitive and this method performs a case-insensitive search. |
java.lang.String |
getNameName(int index)
gets the named range name |
NameRecord |
getNameRecord(int nameIndex)
|
short |
getNumberOfFonts()
get the number of fonts in the font table |
int |
getNumberOfNames()
|
int |
getNumberOfSheets()
get the number of spreadsheets in the workbook (this will be three after serialization) |
short |
getNumCellStyles()
get the number of styles the workbook contains |
java.lang.String |
getPrintArea(int sheetIndex)
Retrieves the reference for the printarea of the specified sheet, the sheet name is appended to the reference even if it was not specified. |
short |
getSelectedTab()
Deprecated. - Misleading name - use getActiveSheetIndex() |
HSSFSheet |
getSheet(java.lang.String name)
Get sheet with the given name (case insensitive match) |
HSSFSheet |
getSheetAt(int index)
Get the HSSFSheet object at the given index. |
int |
getSheetIndex(Sheet sheet)
Returns the index of the given sheet |
int |
getSheetIndex(java.lang.String name)
Returns the index of the sheet by his name |
int |
getSheetIndexFromExternSheetIndex(int externSheetNumber)
|
java.lang.String |
getSheetName(int sheetIndex)
Get the sheet name |
java.lang.String |
getSSTString(int index)
Deprecated. Do not call this method from your applications. Use the methods available in the HSSFRow to get string HSSFCells |
void |
insertChartRecord()
Test only. |
boolean |
isHidden()
|
boolean |
isSheetHidden(int sheetIx)
Check whether a sheet is hidden. |
boolean |
isSheetVeryHidden(int sheetIx)
Check whether a sheet is very hidden. |
boolean |
isWriteProtected()
Is the workbook protected with a password (not encrypted)? |
void |
removeName(int index)
Remove the defined name at the specified index |
void |
removeName(java.lang.String name)
Remove a defined name by name |
void |
removePrintArea(int sheetIndex)
Delete the printarea for the sheet specified |
void |
removeSheetAt(int index)
Removes sheet at the given index. Care must be taken if the removed sheet is the currently active or only selected sheet in the workbook. |
protected void |
resetFontCache()
Reset the fonts cache, causing all new calls to getFontAt() to create new objects. |
java.lang.String |
resolveNameXText(int refIndex,
int definedNameIndex)
Deprecated. for POI internal use only (formula rendering). This method is likely to be removed in future versions of POI. |
void |
setActiveSheet(int index)
Convenience method to set the active sheet. |
void |
setBackupFlag(boolean backupValue)
determine whether the Excel GUI will backup the workbook when saving. |
void |
setDisplayedTab(short index)
Deprecated. - Misleading name - use setFirstVisibleTab() |
void |
setFirstVisibleTab(int index)
sets the first tab that is displayed in the list of tabs in excel. |
void |
setForceFormulaRecalculation(boolean value)
Whether the application shall perform a full recalculation when the workbook is opened. |
void |
setHidden(boolean hiddenFlag)
|
void |
setMissingCellPolicy(Row.MissingCellPolicy missingCellPolicy)
Sets the policy on what to do when getting missing or blank cells from a row. |
void |
setPrintArea(int sheetIndex,
int startColumn,
int endColumn,
int startRow,
int endRow)
For the Convenience of Java Programmers maintaining pointers. |
void |
setPrintArea(int sheetIndex,
java.lang.String reference)
Sets the printarea for the sheet provided |
void |
setRepeatingRowsAndColumns(int sheetIndex,
int startColumn,
int endColumn,
int startRow,
int endRow)
Sets the repeating rows and columns for a sheet (as found in 2003:File->PageSetup->Sheet, 2007:Page Layout->Print Titles). |
void |
setSelectedTab(int index)
Selects a single sheet. |
void |
setSelectedTab(short index)
Deprecated. use setSelectedTab(int) |
void |
setSelectedTabs(int[] indexes)
|
void |
setSheetHidden(int sheetIx,
boolean hidden)
Hide or unhide a sheet |
void |
setSheetHidden(int sheetIx,
int hidden)
Hide or unhide a sheet. |
void |
setSheetName(int sheetIx,
java.lang.String name)
Set the sheet name. |
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 |
write(java.io.OutputStream stream)
Method write - write out this workbook to an Outputstream. |
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. |
| Methods inherited from class org.apache.poi.POIDocument |
|---|
copyNodeRecursively, copyNodes, copyNodes, createInformationProperties, getDocumentSummaryInformation, getPropertySet, getSummaryInformation, readProperties, writeProperties, writeProperties, writePropertySet |
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Field Detail |
|---|
public static final int INITIAL_CAPACITY
protected java.util.List<HSSFSheet> _sheets
| Constructor Detail |
|---|
public HSSFWorkbook()
public HSSFWorkbook(POIFSFileSystem fs)
throws java.io.IOException
java.io.IOException
public HSSFWorkbook(POIFSFileSystem fs,
boolean preserveNodes)
throws java.io.IOException
fs - the POI filesystem that contains the Workbook stream.preserveNodes - whether to preseve other nodes, such as
macros. This takes more memory, so only say yes if you
need to. If set, will store all of the POIFSFileSystem
in memory
java.io.IOException - if the stream cannot be readPOIFSFileSystem
public HSSFWorkbook(DirectoryNode directory,
POIFSFileSystem fs,
boolean preserveNodes)
throws java.io.IOException
directory - the POI filesystem directory to process fromfs - the POI filesystem that contains the Workbook stream.preserveNodes - whether to preseve other nodes, such as
macros. This takes more memory, so only say yes if you
need to. If set, will store all of the POIFSFileSystem
in memory
java.io.IOException - if the stream cannot be readPOIFSFileSystem
public HSSFWorkbook(DirectoryNode directory,
boolean preserveNodes)
throws java.io.IOException
directory - the POI filesystem directory to process frompreserveNodes - whether to preseve other nodes, such as
macros. This takes more memory, so only say yes if you
need to. If set, will store all of the POIFSFileSystem
in memory
java.io.IOException - if the stream cannot be readPOIFSFileSystem
public HSSFWorkbook(java.io.InputStream s)
throws java.io.IOException
java.io.IOException
public HSSFWorkbook(java.io.InputStream s,
boolean preserveNodes)
throws java.io.IOException
s - the POI filesystem that contains the Workbook stream.preserveNodes - whether to preseve other nodes, such as
macros. This takes more memory, so only say yes if you
need to.
java.io.IOException - if the stream cannot be readPOIFSFileSystem,
HSSFWorkbook(POIFSFileSystem)| Method Detail |
|---|
public static HSSFWorkbook create(InternalWorkbook book)
public Row.MissingCellPolicy getMissingCellPolicy()
Row.MissingCellPolicy
getMissingCellPolicy in interface Workbookpublic void setMissingCellPolicy(Row.MissingCellPolicy missingCellPolicy)
HSSFRow.getCell(int)}. See
Row.MissingCellPolicy.
Note that this has no effect on any
iterators, only on when fetching Cells
by their column index.
setMissingCellPolicy in interface Workbook
public void setSheetOrder(java.lang.String sheetname,
int pos)
setSheetOrder in interface Workbooksheetname - the name of the sheet to reorderpos - the position that we want to insert the sheet into (0 based)public void setSelectedTab(int index)
setSelectedTab in interface Workbookindex - the index of the sheet to select (0 based)Sheet.setSelected(boolean)public void setSelectedTab(short index)
public void setSelectedTabs(int[] indexes)
public void setActiveSheet(int index)
setActiveSheet in interface Workbookindex - index of the active sheet (0-based)public int getActiveSheetIndex()
getActiveSheetIndex in interface WorkbookHSSFSheet.setSelected(boolean)public short getSelectedTab()
public void setFirstVisibleTab(int index)
setFirstVisibleTab in interface Workbookindex - public void setDisplayedTab(short index)
public int getFirstVisibleTab()
getFirstVisibleTab in interface Workbookpublic short getDisplayedTab()
public void setSheetName(int sheetIx,
java.lang.String name)
setSheetName in interface WorkbooksheetIx - number (0 based)
java.lang.IllegalArgumentException - if the name is null or invalid
or workbook already contains a sheet with this namecreateSheet(String),
WorkbookUtil.createSafeSheetName(String nameProposal)public java.lang.String getSheetName(int sheetIndex)
Workbook
getSheetName in interface WorkbooksheetIndex - sheet number (0 based)
public boolean isHidden()
isHidden in interface Workbookfalse if this workbook is not visible in the GUIpublic void setHidden(boolean hiddenFlag)
setHidden in interface WorkbookhiddenFlag - pass false to make the workbook visible in the GUIpublic boolean isSheetHidden(int sheetIx)
Workbook
Note that a sheet could instead be set to be very hidden, which is different
(Workbook.isSheetVeryHidden(int))
isSheetHidden in interface WorkbooksheetIx - Number
true if sheet is hiddenpublic boolean isSheetVeryHidden(int sheetIx)
Workbook
This is different from the normal hidden status
(Workbook.isSheetHidden(int))
isSheetVeryHidden in interface WorkbooksheetIx - sheet index to check
true if sheet is very hidden
public void setSheetHidden(int sheetIx,
boolean hidden)
Workbook
setSheetHidden in interface WorkbooksheetIx - the sheet index (0-based)hidden - True to mark the sheet as hidden, false otherwise
public void setSheetHidden(int sheetIx,
int hidden)
Workbook
setSheetHidden in interface WorkbooksheetIx - the sheet index (0-based)hidden - one of the following Workbook constants:
Workbook.SHEET_STATE_VISIBLE,
Workbook.SHEET_STATE_HIDDEN, or
Workbook.SHEET_STATE_VERY_HIDDEN.public int getSheetIndex(java.lang.String name)
getSheetIndex in interface Workbookname - the sheet name
public int getSheetIndex(Sheet sheet)
getSheetIndex in interface Workbooksheet - the sheet to look up
public int getExternalSheetIndex(int internalSheetIndex)
public java.lang.String findSheetNameFromExternSheet(int externSheetIndex)
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 record
public HSSFSheet createSheet()
createSheet in interface Workbookpublic HSSFSheet cloneSheet(int sheetIndex)
cloneSheet in interface Workbookpublic HSSFSheet createSheet(java.lang.String sheetname)
Note that Excel allows sheet names up to 31 chars in length but other applications (such as OpenOffice) allow more. Some versions of Excel crash with names longer than 31 chars, others - truncate such names to 31 character.
POI's SpreadsheetAPI silently truncates the input argument to 31 characters. Example:
Sheet sheet = workbook.createSheet("My very long sheet name which is longer than 31 chars"); // will be truncated
assert 31 == sheet.getSheetName().length();
assert "My very long sheet name which i" == sheet.getSheetName();
Except the 31-character constraint, Excel applies some other rules:
Sheet name MUST be unique in the workbook and MUST NOT contain the any of the following characters:
createSheet in interface Workbooksheetname - sheetname to set for the sheet.
java.lang.IllegalArgumentException - if the name is null or invalid
or workbook already contains a sheet with this nameWorkbookUtil.createSafeSheetName(String nameProposal)public int getNumberOfSheets()
getNumberOfSheets in interface Workbookpublic int getSheetIndexFromExternSheetIndex(int externSheetNumber)
public HSSFSheet getSheetAt(int index)
getSheetAt in interface Workbookindex - of the sheet number (0-based physical & logical)
public HSSFSheet getSheet(java.lang.String name)
getSheet in interface Workbookname - of the sheet
null if it does not existpublic void removeSheetAt(int index)
removeSheetAt in interface Workbookindex - of the sheet (0-based)public void setBackupFlag(boolean backupValue)
backupValue - true to indicate a backup will be performed.public boolean getBackupFlag()
public void setRepeatingRowsAndColumns(int sheetIndex,
int startColumn,
int endColumn,
int startRow,
int endRow)
To set just repeating columns:
workbook.setRepeatingRowsAndColumns(0,0,1,-1-1);To set just repeating rows:
workbook.setRepeatingRowsAndColumns(0,-1,-1,0,4);To remove all repeating rows and columns for a sheet.
workbook.setRepeatingRowsAndColumns(0,-1,-1,-1,-1);
setRepeatingRowsAndColumns in interface WorkbooksheetIndex - 0 based index to sheet.startColumn - 0 based start of repeating columns.endColumn - 0 based end of repeating columns.startRow - 0 based start of repeating rows.endRow - 0 based end of repeating rows.public HSSFFont createFont()
createFont in interface Workbook
public HSSFFont findFont(short boldWeight,
short color,
short fontHeight,
java.lang.String name,
boolean italic,
boolean strikeout,
short typeOffset,
byte underline)
findFont in interface Workbooknullpublic short getNumberOfFonts()
getNumberOfFonts in interface Workbookpublic HSSFFont getFontAt(short idx)
getFontAt in interface Workbookidx - index number
protected void resetFontCache()
public HSSFCellStyle createCellStyle()
createCellStyle in interface Workbookjava.lang.IllegalStateException - if the maximum number of cell styles exceeded the limitpublic short getNumCellStyles()
getNumCellStyles in interface Workbookpublic HSSFCellStyle getCellStyleAt(short idx)
getCellStyleAt in interface Workbookidx - index within the set of styles
public void write(java.io.OutputStream stream)
throws java.io.IOException
write in interface Workbookwrite in class POIDocumentstream - - the java OutputStream you wish to write the XLS to
java.io.IOException - if anything can't be written.POIFSFileSystempublic byte[] getBytes()
public int addSSTString(java.lang.String string)
public java.lang.String getSSTString(int index)
public int getNumberOfNames()
getNumberOfNames in interface Workbookpublic HSSFName getName(java.lang.String name)
getName in interface Workbookname - the name of the defined name
null if not found.public HSSFName getNameAt(int nameIndex)
getNameAt in interface WorkbooknameIndex - position of the named range (0-based)
public NameRecord getNameRecord(int nameIndex)
public java.lang.String getNameName(int index)
index - the named range index (0 based)
public void setPrintArea(int sheetIndex,
java.lang.String reference)
i.e. Reference = $A$1:$B$2
setPrintArea in interface WorkbooksheetIndex - Zero-based sheet index (0 Represents the first sheet to keep consistent with java)reference - Valid name Reference for the Print Area
public void setPrintArea(int sheetIndex,
int startColumn,
int endColumn,
int startRow,
int endRow)
setPrintArea in interface WorkbooksheetIndex - Zero-based sheet index (0 = First Sheet)startColumn - Column to begin printareaendColumn - Column to end the printareastartRow - Row to begin the printareaendRow - Row to end the printareasetPrintArea(int, String)public java.lang.String getPrintArea(int sheetIndex)
getPrintArea in interface WorkbooksheetIndex - Zero-based sheet index (0 Represents the first sheet to keep consistent with java)
public void removePrintArea(int sheetIndex)
removePrintArea in interface WorkbooksheetIndex - Zero-based sheet index (0 = First Sheet)public HSSFName createName()
createName in interface Workbookpublic int getNameIndex(java.lang.String name)
Workbook
getNameIndex in interface Workbookname - the name of the defined name
public void removeName(int index)
Workbook
removeName in interface Workbookindex - named range index (0 based)public HSSFDataFormat createDataFormat()
createDataFormat in interface WorkbookFormatRecord,
Recordpublic void removeName(java.lang.String name)
Workbook
removeName in interface Workbookname - the name of the defined namepublic HSSFPalette getCustomPalette()
public void insertChartRecord()
public void dumpDrawingGroupRecords(boolean fat)
public int addPicture(byte[] pictureData,
int format)
addPicture in interface WorkbookpictureData - The bytes of the pictureformat - The format of the picture. One of PICTURE_TYPE_*
Workbook.PICTURE_TYPE_EMF,
Workbook.PICTURE_TYPE_WMF,
Workbook.PICTURE_TYPE_PICT,
Workbook.PICTURE_TYPE_JPEG,
Workbook.PICTURE_TYPE_PNG,
Workbook.PICTURE_TYPE_DIBpublic java.util.List<HSSFPictureData> getAllPictures()
getAllPictures in interface WorkbookHSSFPictureData objects.)public boolean isWriteProtected()
public void writeProtectWorkbook(java.lang.String password,
java.lang.String username)
password - to setpublic void unwriteProtectWorkbook()
public java.util.List<HSSFObjectData> getAllEmbeddedObjects()
HSSFObjectData objects.)public HSSFCreationHelper getCreationHelper()
Workbook
getCreationHelper in interface Workbookpublic void addToolPack(UDFFinder toopack)
addToolPack in interface Workbooktoopack - the toolpack to registerpublic void setForceFormulaRecalculation(boolean value)
Typically you want to force formula recalculation when you modify cell formulas or values of a workbook previously created by Excel. When set to true, this flag will tell Excel that it needs to recalculate all formulas in the workbook the next time the file is opened.
Note, that recalculation updates cached formula results and, thus, modifies the workbook. Depending on the version, Excel may prompt you with "Do you want to save the changes in filename?" on close.
setForceFormulaRecalculation in interface Workbookvalue - true if the application will perform a full recalculation of
workbook values when the workbook is openedpublic boolean getForceFormulaRecalculation()
getForceFormulaRecalculation in interface Workbook
public boolean changeExternalReference(java.lang.String oldUrl,
java.lang.String newUrl)
oldUrl - The old URL to search for and which is to be replacednewUrl - The URL replacement
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||