Class HSSFWorkbook
- All Implemented Interfaces:
Closeable,AutoCloseable,Iterable<Sheet>,Workbook
- See Also:
-
Field Summary
FieldsModifier and TypeFieldDescriptionthis holds the HSSFSheet objects attached to this workbookstatic final intused for compile-time performance/memory optimization.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 -
Constructor Summary
ConstructorsConstructorDescriptionCreates new HSSFWorkbook from scratch (start here!)Companion to HSSFWorkbook(POIFSFileSystem), this constructs the POI filesystem around yourInputStream, including all nodes.HSSFWorkbook(InputStream s, boolean preserveNodes) Companion to HSSFWorkbook(POIFSFileSystem), this constructs the POI filesystem around yourInputStream.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.Given a POI POIFSFileSystem object, read in its Workbook along with all related nodes, and populate the high and low level models.HSSFWorkbook(POIFSFileSystem fs, boolean preserveNodes) Given a POI POIFSFileSystem object, read in its Workbook and populate the high and low level models. -
Method Summary
Modifier and TypeMethodDescriptionintaddOlePackage(byte[] oleData, String label, String fileName, String command) Adds an OLE package manager object with the given content to the sheetintaddOlePackage(POIFSFileSystem poiData, String label, String fileName, String command) Adds an OLE package manager object with the given POIFS to the sheetintaddPicture(byte[] pictureData, int format) Adds a picture to the workbook.voidaddToolPack(UDFFinder toopack) Register a new toolpack in this workbook.booleanchangeExternalReference(String oldUrl, String newUrl) Changes an external referenced file to another file.cloneSheet(int sheetIndex) create an HSSFSheet from an existing sheet in the HSSFWorkbook.voidclose()Closes the underlyingPOIFSFileSystemfrom which the Workbook was read, if any.static HSSFWorkbookcreate(InternalWorkbook book) Create a new Cell style and add it to the workbook's style table.Returns the instance of HSSFDataFormat for this workbook.create a new Font and add it to the workbook's font tablecreates a new named range and add it to the modelcreate an HSSFSheet for this HSSFWorkbook, adds it to the sheets and returns the high level representation.createSheet(String sheetname) Create a new sheet for this Workbook and return the high level representation.voiddumpDrawingGroupRecords(boolean fat) Spits out a list of all the drawing records in the workbook.findFont(boolean bold, short color, short fontHeight, String name, boolean italic, boolean strikeout, short typeOffset, byte underline) Finds a font that matches the one with the supplied attributesintgets the tab whose data is actually seen when the sheet is opened.Gets all embedded OLE2 objects from the Workbook.Returns all defined names.Gets all pictures from the Workbook.booleandetermine 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.getCellStyleAt(int idx) get the cell style object at the given indexReturns an object that handles instantiating concrete classes of the various instances one needs for HSSF and XSSF.intsets the first tab that is displayed in the list of tabs in excel.getFontAt(int idx) Get the font at the given index numbergetFontAt(short idx) Deprecated.booleanWhether Excel will be asked to recalculate all formulas when the workbook is opened.Retrieves the current policy on what to do when getting missing or blank cells from a row.getNameAt(int nameIndex) intgetNameIndex(String name) Gets the defined name index by name
Note: Excel defined names are case-insensitive and this method performs a case-insensitive search.getNameName(int index) gets the named range namegetNameRecord(int nameIndex) Returns all defined names with the given name.shortDeprecated.intGet the number of fonts in the font tableintintget the number of spreadsheets in the workbook (this will be three after serialization)intget the number of styles the workbook containsgetPrintArea(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.Gets the selected sheets (if more than one, Excel calls these a [Group]).Get sheet with the given name (case insensitive match)getSheetAt(int index) Get the HSSFSheet object at the given index.intgetSheetIndex(String name) Returns the index of the sheet by his nameintgetSheetIndex(Sheet sheet) Returns the index of the given sheetgetSheetName(int sheetIndex) Get the sheet namegetSheetVisibility(int sheetIx) Get the visibility (visible, hidden, very hidden) of a sheet in this workbookReturns the spreadsheet version (EXCLE97) of this workbookstatic StringgetWorkbookDirEntryName(DirectoryNode directory) voidTest only.booleanisHidden()booleanisSheetHidden(int sheetIx) Check whether a sheet is hidden.booleanisSheetVeryHidden(int sheetIx) Check whether a sheet is very hidden.booleanIs the workbook protected with a password (not encrypted)?iterator()Alias forsheetIterator()to allow foreach loopsintlinkExternalWorkbook(String name, Workbook workbook) Adds the LinkTable records required to allow formulas referencing the specified external workbook to be added to this one.voidremoveName(int index) Remove the defined name at the specified indexvoidremoveName(String name) Remove a defined name by namevoidremoveName(Name name) AsremoveName(String)is not necessarily unique (name + sheet index is unique), this method is more accurate.voidremovePrintArea(int sheetIndex) Delete the printarea for the sheet specifiedvoidremoveSheetAt(int index) Removes sheet at the given index.voidsetActiveSheet(int index) Convenience method to set the active sheet.voidsetBackupFlag(boolean backupValue) determine whether the Excel GUI will backup the workbook when saving.voidsetFirstVisibleTab(int index) sets the first tab that is displayed in the list of tabs in excel.voidsetForceFormulaRecalculation(boolean value) Whether the application shall perform a full recalculation when the workbook is opened.voidsetHidden(boolean hiddenFlag) voidsetMissingCellPolicy(Row.MissingCellPolicy missingCellPolicy) Sets the policy on what to do when getting missing or blank cells from a row.voidsetPrintArea(int sheetIndex, int startColumn, int endColumn, int startRow, int endRow) For the Convenience of Java Programmers maintaining pointers.voidsetPrintArea(int sheetIndex, String reference) Sets the printarea for the sheet providedvoidsetSelectedTab(int index) Selects a single sheet.voidsetSelectedTabs(int[] indexes) Selects multiple sheets as a group.voidsetSelectedTabs(Collection<Integer> indexes) Selects multiple sheets as a group.voidsetSheetHidden(int sheetIx, boolean hidden) Hide or unhide a sheet.voidsetSheetName(int sheetIx, String name) Set the sheet name.voidsetSheetOrder(String sheetname, int pos) sets the order of appearance for a given sheet.voidsetSheetVisibility(int sheetIx, SheetVisibility visibility) Hide or unhide a sheet.Returns an iterator of the sheets in the workbook in sheet order.voidremoves the write protect flagvoidwrite()Write out this workbook to the currently openFilevia the writeablePOIFSFileSystemit was opened as.voidMethod write - write out this workbook to a newFile.voidwrite(OutputStream stream) Method write - write out this workbook to anOutputStream.voidwriteProtectWorkbook(String password, 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
clearDirectory, createInformationProperties, getDirectory, getDocumentSummaryInformation, getEncryptedPropertyStreamName, getPropertySet, getPropertySet, getSummaryInformation, initDirectory, readProperties, replaceDirectory, validateInPlaceWritePossible, writeProperties, writeProperties, writePropertiesMethods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface java.lang.Iterable
forEach, spliterator
-
Field Details
-
INITIAL_CAPACITY
public static final int INITIAL_CAPACITYused for compile-time performance/memory optimization. This determines the initial capacity for the sheet collection. Its currently set to 3. Changing it in this release will decrease performance since you're never allowed to have more or less than three sheets! -
_sheets
this holds the HSSFSheet objects attached to this workbook
-
-
Constructor Details
-
HSSFWorkbook
public HSSFWorkbook()Creates new HSSFWorkbook from scratch (start here!) -
HSSFWorkbook
Given a POI POIFSFileSystem object, read in its Workbook along with all related nodes, and populate the high and low level models.This calls
HSSFWorkbook(POIFSFileSystem, boolean)with preserve nodes set to true.- Throws:
IOException- if the stream cannot be read- See Also:
-
HSSFWorkbook
Given a POI POIFSFileSystem object, read in its Workbook and populate the high and low level models. If you're reading in a workbook... start here!- Parameters:
fs- the POI filesystem that contains the Workbook stream.preserveNodes- whether to preserve 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- Throws:
IOException- if the stream cannot be read- See Also:
-
HSSFWorkbook
public HSSFWorkbook(DirectoryNode directory, POIFSFileSystem fs, boolean preserveNodes) throws IOException given a POI POIFSFileSystem object, and a specific directory within it, read in its Workbook and populate the high and low level models. If you're reading in a workbook...start here.- Parameters:
directory- the POI filesystem directory to process fromfs- the POI filesystem that contains the Workbook stream.preserveNodes- whether to preserve 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- Throws:
IOException- if the stream cannot be read- See Also:
-
HSSFWorkbook
given a POI POIFSFileSystem object, and a specific directory within it, read in its Workbook and populate the high and low level models. If you're reading in a workbook...start here.- Parameters:
directory- the POI filesystem directory to process frompreserveNodes- whether to preserve 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- Throws:
IOException- if the stream cannot be read- See Also:
-
HSSFWorkbook
Companion to HSSFWorkbook(POIFSFileSystem), this constructs the POI filesystem around yourInputStream, including all nodes.This calls
HSSFWorkbook(InputStream, boolean)with preserve nodes set to true.- Throws:
IOException- if the stream cannot be read- See Also:
-
HSSFWorkbook
Companion to HSSFWorkbook(POIFSFileSystem), this constructs the POI filesystem around yourInputStream.- Parameters:
s- the POI filesystem that contains the Workbook stream.preserveNodes- whether to preserve other nodes, such as macros. This takes more memory, so only say yes if you need to.- Throws:
IOException- if the stream cannot be read- See Also:
-
-
Method Details
-
create
-
getWorkbookDirEntryName
-
getMissingCellPolicy
Retrieves the current policy on what to do when getting missing or blank cells from a row. The default is to return blank and null cells.Row.MissingCellPolicy- Specified by:
getMissingCellPolicyin interfaceWorkbook
-
setMissingCellPolicy
Sets the policy on what to do when getting missing or blank cells from a row. This will then apply to all calls toHSSFRow.getCell(int)}. SeeRow.MissingCellPolicy. Note that this has no effect on any iterators, only on when fetching Cells by their column index.- Specified by:
setMissingCellPolicyin interfaceWorkbook
-
setSheetOrder
sets the order of appearance for a given sheet.- Specified by:
setSheetOrderin interfaceWorkbook- Parameters:
sheetname- the name of the sheet to reorderpos- the position that we want to insert the sheet into (0 based)
-
setSelectedTab
public void setSelectedTab(int index) Selects a single sheet. This may be different to the 'active' sheet (which is the sheet with focus).- Specified by:
setSelectedTabin interfaceWorkbook- Parameters:
index- the index of the sheet to select (0 based)- See Also:
-
setSelectedTabs
public void setSelectedTabs(int[] indexes) Selects multiple sheets as a group. This is distinct from the 'active' sheet (which is the sheet with focus). Unselects sheets that are not inindexes.- Parameters:
indexes- Array of sheets to select, the index is 0-based.
-
setSelectedTabs
Selects multiple sheets as a group. This is distinct from the 'active' sheet (which is the sheet with focus). Unselects sheets that are not inindexes.- Parameters:
indexes- Collection of sheets to select, the index is 0-based.
-
getSelectedTabs
Gets the selected sheets (if more than one, Excel calls these a [Group]).- Returns:
- indices of selected sheets
-
setActiveSheet
public void setActiveSheet(int index) Convenience method to set the active sheet. The active sheet is is the sheet which is currently displayed when the workbook is viewed in Excel. 'Selected' sheet(s) is a distinct concept.- Specified by:
setActiveSheetin interfaceWorkbook- Parameters:
index- index of the active sheet (0-based)
-
getActiveSheetIndex
public int getActiveSheetIndex()gets the tab whose data is actually seen when the sheet is opened. This may be different from the "selected sheet" since excel seems to allow you to show the data of one sheet when another is seen "selected" in the tabs (at the bottom).- Specified by:
getActiveSheetIndexin interfaceWorkbook- Returns:
- the index of the active sheet (0-based)
- See Also:
-
setFirstVisibleTab
public void setFirstVisibleTab(int index) sets the first tab that is displayed in the list of tabs in excel. This method does not hide, select or focus sheets. It just sets the scroll position in the tab-bar.- Specified by:
setFirstVisibleTabin interfaceWorkbook- Parameters:
index- the sheet index of the tab that will become the first in the tab-bar
-
getFirstVisibleTab
public int getFirstVisibleTab()sets the first tab that is displayed in the list of tabs in excel.- Specified by:
getFirstVisibleTabin interfaceWorkbook- Returns:
- the first tab that to display in the list of tabs (0-based).
-
setSheetName
Set the sheet name.- Specified by:
setSheetNamein interfaceWorkbook- Parameters:
sheetIx- number (0 based)- Throws:
IllegalArgumentException- if the name is null or invalid or workbook already contains a sheet with this name- See Also:
-
getSheetName
Description copied from interface:WorkbookGet the sheet name- Specified by:
getSheetNamein interfaceWorkbook- Parameters:
sheetIndex- sheet number (0 based)- Returns:
- Sheet name for the specified index
-
isHidden
public boolean isHidden() -
setHidden
public void setHidden(boolean hiddenFlag) -
isSheetHidden
public boolean isSheetHidden(int sheetIx) Description copied from interface:WorkbookCheck whether a sheet is hidden.Note that a sheet could instead be set to be very hidden, which is different (
Workbook.isSheetVeryHidden(int))- Specified by:
isSheetHiddenin interfaceWorkbook- Parameters:
sheetIx- Number- Returns:
trueif sheet is hidden- See Also:
-
isSheetVeryHidden
public boolean isSheetVeryHidden(int sheetIx) Description copied from interface:WorkbookCheck whether a sheet is very hidden.This is different from the normal hidden status (
Workbook.isSheetHidden(int))- Specified by:
isSheetVeryHiddenin interfaceWorkbook- Parameters:
sheetIx- sheet index to check- Returns:
trueif sheet is very hidden- See Also:
-
getSheetVisibility
Description copied from interface:WorkbookGet the visibility (visible, hidden, very hidden) of a sheet in this workbook- Specified by:
getSheetVisibilityin interfaceWorkbook- Parameters:
sheetIx- the index of the sheet- Returns:
- the sheet visibility
-
setSheetHidden
public void setSheetHidden(int sheetIx, boolean hidden) Description copied from interface:WorkbookHide or unhide a sheet. Please note that the sheet currently set as active sheet (sheet 0 in a newly created workbook or the one set via setActiveSheet()) cannot be hidden.- Specified by:
setSheetHiddenin interfaceWorkbook- Parameters:
sheetIx- the sheet index (0-based)hidden- True to mark the sheet as hidden, false otherwise- See Also:
-
setSheetVisibility
Description copied from interface:WorkbookHide or unhide a sheet. Please note that the sheet currently set as active sheet (sheet 0 in a newly created workbook or the one set via setActiveSheet()) cannot be hidden.- Specified by:
setSheetVisibilityin interfaceWorkbook- Parameters:
sheetIx- the sheet index (0-based)visibility- the sheet visibility to set
-
getSheetIndex
Returns the index of the sheet by his name- Specified by:
getSheetIndexin interfaceWorkbook- Parameters:
name- the sheet name- Returns:
- index of the sheet (0 based)
-
getSheetIndex
Returns the index of the given sheet- Specified by:
getSheetIndexin interfaceWorkbook- Parameters:
sheet- the sheet to look up- Returns:
- index of the sheet (0 based). -1 if not found
-
createSheet
create an HSSFSheet for this HSSFWorkbook, adds it to the sheets and returns the high level representation. Use this to create new sheets.- Specified by:
createSheetin interfaceWorkbook- Returns:
- HSSFSheet representing the new sheet.
-
cloneSheet
create an HSSFSheet from an existing sheet in the HSSFWorkbook.- Specified by:
cloneSheetin interfaceWorkbook- Returns:
- HSSFSheet representing the cloned sheet.
-
createSheet
Create a new sheet for this Workbook and return the high level representation. Use this to create new sheets.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:
Except the 31-character constraint, Excel applies some other rules: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();Sheet name MUST be unique in the workbook and MUST NOT contain the any of the following characters:
- 0x0000
- 0x0003
- colon (:)
- backslash (\)
- asterisk (*)
- question mark (?)
- forward slash (/)
- opening square bracket ([)
- closing square bracket (])
- Specified by:
createSheetin interfaceWorkbook- Parameters:
sheetname- sheetname to set for the sheet.- Returns:
- Sheet representing the new sheet.
- Throws:
IllegalArgumentException- if the name is null or invalid or workbook already contains a sheet with this name- See Also:
-
sheetIterator
Returns an iterator of the sheets in the workbook in sheet order. Includes hidden and very hidden sheets.- Specified by:
sheetIteratorin interfaceWorkbook- Returns:
- an iterator of the sheets.
-
iterator
Alias forsheetIterator()to allow foreach loops -
getNumberOfSheets
public int getNumberOfSheets()get the number of spreadsheets in the workbook (this will be three after serialization)- Specified by:
getNumberOfSheetsin interfaceWorkbook- Returns:
- number of sheets
-
getSheetAt
Get the HSSFSheet object at the given index.- Specified by:
getSheetAtin interfaceWorkbook- Parameters:
index- of the sheet number (0-based physical & logical)- Returns:
- HSSFSheet at the provided index
- Throws:
IllegalArgumentException- if the index is out of range (index < 0 || index >= getNumberOfSheets()).
-
getSheet
Get sheet with the given name (case insensitive match) -
removeSheetAt
public 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. There are a few situations when Excel must have a selection and/or active sheet. (For example when printing - see Bug 40414).
This method makes sure that if the removed sheet was active, another sheet will become active in its place. Furthermore, if the removed sheet was the only selected sheet, another sheet will become selected. The newly active/selected sheet will have the same index, or one less if the removed sheet was the last in the workbook.- Specified by:
removeSheetAtin interfaceWorkbook- Parameters:
index- of the sheet (0-based)
-
setBackupFlag
public void setBackupFlag(boolean backupValue) determine whether the Excel GUI will backup the workbook when saving.- Parameters:
backupValue- true to indicate a backup will be performed.
-
getBackupFlag
public boolean getBackupFlag()determine whether the Excel GUI will backup the workbook when saving.- Returns:
- the current setting for backups.
-
createFont
create a new Font and add it to the workbook's font table- Specified by:
createFontin interfaceWorkbook- Returns:
- new font object
-
findFont
public HSSFFont findFont(boolean bold, short color, short fontHeight, String name, boolean italic, boolean strikeout, short typeOffset, byte underline) Finds a font that matches the one with the supplied attributes -
getNumberOfFonts
Deprecated.Description copied from interface:WorkbookGet the number of fonts in the font table- Specified by:
getNumberOfFontsin interfaceWorkbook- Returns:
- number of fonts
-
getNumberOfFontsAsInt
public int getNumberOfFontsAsInt()Description copied from interface:WorkbookGet the number of fonts in the font table- Specified by:
getNumberOfFontsAsIntin interfaceWorkbook- Returns:
- number of fonts
-
getFontAt
Deprecated.Description copied from interface:WorkbookGet the font at the given index number -
getFontAt
Description copied from interface:WorkbookGet the font at the given index number -
createCellStyle
Create a new Cell style and add it to the workbook's style table. You can define up to 4000 unique styles in a .xls workbook.- Specified by:
createCellStylein interfaceWorkbook- Returns:
- the new Cell Style object
- Throws:
IllegalStateException- if the number of cell styles exceeded the limit for this type of Workbook.
-
getNumCellStyles
public int getNumCellStyles()get the number of styles the workbook contains- Specified by:
getNumCellStylesin interfaceWorkbook- Returns:
- count of cell styles
-
getCellStyleAt
get the cell style object at the given index- Specified by:
getCellStyleAtin interfaceWorkbook- Parameters:
idx- index within the set of styles- Returns:
- HSSFCellStyle object at the index
-
close
Closes the underlyingPOIFSFileSystemfrom which the Workbook was read, if any.Once this has been called, no further operations, updates or reads should be performed on the Workbook.
- Specified by:
closein interfaceAutoCloseable- Specified by:
closein interfaceCloseable- Specified by:
closein interfaceWorkbook- Overrides:
closein classPOIDocument- Throws:
IOException
-
write
Write out this workbook to the currently openFilevia the writeablePOIFSFileSystemit was opened as.This will fail (with an
IllegalStateExceptionif the Workbook was opened read-only, opened from anInputStreaminstead of a File, or if this is not the root document. For those cases, you must usewrite(OutputStream)orwrite(File)to write to a brand new document.- Specified by:
writein classPOIDocument- Throws:
IOException- thrown on errors writing to the file
-
write
Method write - write out this workbook to a newFile. Constructs a new POI POIFSFileSystem, passes in the workbook binary representation and writes it out. If the file exists, it will be replaced, otherwise a new one will be created. Note that you cannot write to the currently open File using this method. If you opened your Workbook from a File, you must use thewrite()method instead!- Specified by:
writein classPOIDocument- Parameters:
newFile- The new File you wish to write the XLS to- Throws:
IOException- if anything can't be written.- See Also:
-
write
Method write - write out this workbook to anOutputStream. Constructs a new POI POIFSFileSystem, passes in the workbook binary representation and writes it out. Ifstreamis aFileOutputStreamon a networked drive or has a high cost/latency associated with each written byte, consider wrapping the OutputStream in aBufferedOutputStreamto improve write performance.- Specified by:
writein interfaceWorkbook- Specified by:
writein classPOIDocument- Parameters:
stream- - the java OutputStream you wish to write the XLS to- Throws:
IOException- if anything can't be written.- See Also:
-
getBytes
public byte[] getBytes()Method getBytes - get the bytes of just the HSSF portions of the XLS file. Use this to construct a POI POIFSFileSystem yourself.- Returns:
- byte[] array containing the binary representation of this workbook and all contained sheets, rows, cells, etc.
-
getNumberOfNames
public int getNumberOfNames()- Specified by:
getNumberOfNamesin interfaceWorkbook- Returns:
- the total number of defined names in this workbook
-
getName
-
getNames
Description copied from interface:WorkbookReturns all defined names with the given name. -
getNameAt
-
getAllNames
Description copied from interface:WorkbookReturns all defined names.- Specified by:
getAllNamesin interfaceWorkbook- Returns:
- a list of the defined names. An empty list is returned if none is found.
-
getNameRecord
-
getNameName
gets the named range name- Parameters:
index- the named range index (0 based)- Returns:
- named range name
-
setPrintArea
Sets the printarea for the sheet providedi.e. Reference = $A$1:$B$2
- Specified by:
setPrintAreain interfaceWorkbook- Parameters:
sheetIndex- Zero-based sheet index (0 Represents the first sheet to keep consistent with java)reference- Valid name Reference for the Print Area
-
setPrintArea
public void setPrintArea(int sheetIndex, int startColumn, int endColumn, int startRow, int endRow) For the Convenience of Java Programmers maintaining pointers.- Specified by:
setPrintAreain interfaceWorkbook- Parameters:
sheetIndex- 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 printarea- See Also:
-
getPrintArea
Retrieves the reference for the printarea of the specified sheet, the sheet name is appended to the reference even if it was not specified.- Specified by:
getPrintAreain interfaceWorkbook- Parameters:
sheetIndex- Zero-based sheet index (0 Represents the first sheet to keep consistent with java)- Returns:
- String Null if no print area has been defined
-
removePrintArea
public void removePrintArea(int sheetIndex) Delete the printarea for the sheet specified- Specified by:
removePrintAreain interfaceWorkbook- Parameters:
sheetIndex- Zero-based sheet index (0 = First Sheet)
-
createName
creates a new named range and add it to the model- Specified by:
createNamein interfaceWorkbook- Returns:
- named range high level
-
getNameIndex
Description copied from interface:WorkbookGets the defined name index by name
Note: Excel defined names are case-insensitive and this method performs a case-insensitive search.- Specified by:
getNameIndexin interfaceWorkbook- Parameters:
name- the name of the defined name- Returns:
- zero based index of the defined name. -1 if not found.
-
removeName
public void removeName(int index) Description copied from interface:WorkbookRemove the defined name at the specified index- Specified by:
removeNamein interfaceWorkbook- Parameters:
index- named range index (0 based)
-
createDataFormat
Returns the instance of HSSFDataFormat for this workbook.- Specified by:
createDataFormatin interfaceWorkbook- Returns:
- the HSSFDataFormat object
- See Also:
-
removeName
Description copied from interface:WorkbookRemove a defined name by name- Specified by:
removeNamein interfaceWorkbook- Parameters:
name- the name of the defined name
-
removeName
AsremoveName(String)is not necessarily unique (name + sheet index is unique), this method is more accurate.- Specified by:
removeNamein interfaceWorkbook- Parameters:
name- the name to remove.
-
getCustomPalette
-
insertChartRecord
public void insertChartRecord()Test only. Do not use -
dumpDrawingGroupRecords
public void dumpDrawingGroupRecords(boolean fat) Spits out a list of all the drawing records in the workbook. -
addPicture
public int addPicture(byte[] pictureData, int format) Adds a picture to the workbook.- Specified by:
addPicturein interfaceWorkbook- Parameters:
pictureData- The bytes of the pictureformat- The format of the picture. One ofPICTURE_TYPE_*- Returns:
- the index to this picture (1 based).
- See Also:
-
getAllPictures
Gets all pictures from the Workbook.- Specified by:
getAllPicturesin interfaceWorkbook- Returns:
- the list of pictures (a list of
HSSFPictureDataobjects.)
-
addOlePackage
public int addOlePackage(POIFSFileSystem poiData, String label, String fileName, String command) throws IOException Adds an OLE package manager object with the given POIFS to the sheet- Parameters:
poiData- an POIFS containing the embedded document, to be addedlabel- the label of the payloadfileName- the original filenamecommand- the command to open the payload- Returns:
- the index of the added ole object
- Throws:
IOException- if the object can't be embedded
-
addOlePackage
public int addOlePackage(byte[] oleData, String label, String fileName, String command) throws IOException Description copied from interface:WorkbookAdds an OLE package manager object with the given content to the sheet- Specified by:
addOlePackagein interfaceWorkbook- Parameters:
oleData- the payloadlabel- the label of the payloadfileName- the original filenamecommand- the command to open the payload- Returns:
- the index of the added ole object, i.e. the storage id
- Throws:
IOException- if the object can't be embedded
-
linkExternalWorkbook
Adds the LinkTable records required to allow formulas referencing the specified external workbook to be added to this one. Allows formulas such as "[MyOtherWorkbook]Sheet3!$A$5" to be added to the file, for workbooks not already referenced.- Specified by:
linkExternalWorkbookin interfaceWorkbook- Parameters:
name- The name the workbook will be referenced as in formulasworkbook- The open workbook to fetch the link required information from
-
isWriteProtected
public boolean isWriteProtected()Is the workbook protected with a password (not encrypted)? -
writeProtectWorkbook
protect a workbook with a password (not encypted, just sets writeprotect flags and the password.- Parameters:
password- to set
-
unwriteProtectWorkbook
public void unwriteProtectWorkbook()removes the write protect flag -
getAllEmbeddedObjects
Gets all embedded OLE2 objects from the Workbook.- Returns:
- the list of embedded objects (a list of
HSSFObjectDataobjects.)
-
getCreationHelper
Description copied from interface:WorkbookReturns an object that handles instantiating concrete classes of the various instances one needs for HSSF and XSSF.- Specified by:
getCreationHelperin interfaceWorkbook
-
addToolPack
Register a new toolpack in this workbook.- Specified by:
addToolPackin interfaceWorkbook- Parameters:
toopack- the toolpack to register
-
setForceFormulaRecalculation
public void setForceFormulaRecalculation(boolean value) Whether the application shall perform a full recalculation when the workbook is opened.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.
- Specified by:
setForceFormulaRecalculationin interfaceWorkbook- Parameters:
value- true if the application will perform a full recalculation of workbook values when the workbook is opened- Since:
- 3.8
-
getForceFormulaRecalculation
public boolean getForceFormulaRecalculation()Whether Excel will be asked to recalculate all formulas when the workbook is opened.- Specified by:
getForceFormulaRecalculationin interfaceWorkbook- Since:
- 3.8
-
changeExternalReference
Changes an external referenced file to another file. A formula in Excel which references a cell in another file is saved in two parts: The referenced file is stored in an reference table. the row/cell information is saved separate. This method invocation will only change the reference in the lookup-table itself.- Parameters:
oldUrl- The old URL to search for and which is to be replacednewUrl- The URL replacement- Returns:
- true if the oldUrl was found and replaced with newUrl. Otherwise false
-
getInternalWorkbook
-
getSpreadsheetVersion
Returns the spreadsheet version (EXCLE97) of this workbook- Specified by:
getSpreadsheetVersionin interfaceWorkbook- Returns:
- EXCEL97 SpreadsheetVersion enum
- Since:
- 3.14 beta 2
-
getEncryptionInfo
- Overrides:
getEncryptionInfoin classPOIDocument- Returns:
- the encryption info if the document is encrypted, otherwise
null
-