Class XSSFWorkbook
- java.lang.Object
-
- org.apache.poi.ooxml.POIXMLDocumentPart
-
- org.apache.poi.ooxml.POIXMLDocument
-
- org.apache.poi.xssf.usermodel.XSSFWorkbook
-
- All Implemented Interfaces:
Closeable,AutoCloseable,Iterable<Sheet>,Date1904Support,Workbook
public class XSSFWorkbook extends POIXMLDocument implements Workbook, Date1904Support
High level representation of a SpreadsheetML 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.
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from class org.apache.poi.ooxml.POIXMLDocumentPart
POIXMLDocumentPart.RelationPart
-
-
Field Summary
Fields Modifier and Type Field Description static intPICTURE_TYPE_BMPstatic intPICTURE_TYPE_EPSstatic intPICTURE_TYPE_GIFImages formats supported by XSSF but not by HSSFstatic intPICTURE_TYPE_TIFFstatic intPICTURE_TYPE_WPG-
Fields inherited from class org.apache.poi.ooxml.POIXMLDocument
DOCUMENT_CREATOR, OLE_OBJECT_REL_TYPE, PACK_OBJECT_REL_TYPE
-
Fields inherited from interface org.apache.poi.ss.usermodel.Workbook
MAX_SENSITIVE_SHEET_NAME_LEN, PICTURE_TYPE_DIB, PICTURE_TYPE_EMF, PICTURE_TYPE_JPEG, PICTURE_TYPE_PICT, PICTURE_TYPE_PNG, PICTURE_TYPE_WMF
-
-
Constructor Summary
Constructors Constructor Description XSSFWorkbook()Create a new SpreadsheetML workbook.XSSFWorkbook(File file)Constructs a XSSFWorkbook object from a given file.XSSFWorkbook(InputStream is)Constructs a XSSFWorkbook object, by buffering the whole stream into memory and then opening anOPCPackageobject for it.XSSFWorkbook(String path)Constructs a XSSFWorkbook object given a file name.XSSFWorkbook(OPCPackage pkg)Constructs a XSSFWorkbook object given a OpenXML4JPackageobject, see https://poi.apache.org/oxml4j/.XSSFWorkbook(PackagePart part)Constructs a XSSFWorkbook object using Package Part.XSSFWorkbook(XSSFFactory factory)XSSFWorkbook(XSSFWorkbookType workbookType)Create a new SpreadsheetML workbook.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description intaddOlePackage(byte[] oleData, String label, String fileName, String command)intaddPicture(byte[] pictureData, int format)Adds a picture to the workbook.intaddPicture(InputStream is, int format)Adds a picture to the workbook.protected org.openxmlformats.schemas.spreadsheetml.x2006.main.CTPivotCacheaddPivotCache(String rId)Add pivotCache to the workbookvoidaddToolPack(UDFFinder toolpack)Register a new toolpack in this workbook.protected voidbeforeDocumentRead()XSSFSheetcloneSheet(int sheetNum)Create an XSSFSheet from an existing sheet in the XSSFWorkbook.XSSFSheetcloneSheet(int sheetNum, String newName)Create an XSSFSheet from an existing sheet in the XSSFWorkbook.voidclose()Closes the underlyingOPCPackagefrom which this document was read, if there is oneprotected voidcommit()Save the content in the underlying package part.XSSFCellStylecreateCellStyle()Create a new XSSFCellStyle and add it to the workbook's style tableXSSFDataFormatcreateDataFormat()Returns the workbook's data format table (a factory for creating data format strings).protected XSSFDialogsheetcreateDialogsheet(String sheetname, org.openxmlformats.schemas.spreadsheetml.x2006.main.CTDialogsheet dialogsheet)XSSFEvaluationWorkbookcreateEvaluationWorkbook()XSSFFontcreateFont()Create a new Font and add it to the workbook's font tableXSSFNamecreateName()XSSFSheetcreateSheet()Create an XSSFSheet for this workbook, adds it to the sheets and returns the high level representation.XSSFSheetcreateSheet(String sheetname)Create a new sheet for this Workbook and return the high level representation.XSSFFontfindFont(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 attributesintgetActiveSheetIndex()Convenience method to get the active sheet.List<PackagePart>getAllEmbeddedParts()Get the document's embedded files.List<XSSFName>getAllNames()Get a list of all the named ranges in the workbook.List<XSSFPictureData>getAllPictures()Gets all pictures from the Workbook.CalculationChaingetCalculationChain()Return theCalculationChainobject for this workbookbooleangetCellFormulaValidation()Whether a call toCellBase.setCellFormula(String)will validate the formula or not.CellReferenceTypegetCellReferenceType()XSSFCellStylegetCellStyleAt(int idx)Get the cell style object at the given indexXSSFCreationHelpergetCreationHelper()Returns an object that handles instantiating concrete classes of the various instances for XSSF.org.openxmlformats.schemas.spreadsheetml.x2006.main.CTWorkbookgetCTWorkbook()Return the underlying XML beanCollection<XSSFMap>getCustomXMLMappings()List<ExternalLinksTable>getExternalLinksTable()Returns the list ofExternalLinksTableobject for this workbookintgetFirstVisibleTab()Gets the first tab that is displayed in the list of tabs in excel.XSSFFontgetFontAt(int idx)booleangetForceFormulaRecalculation()Whether Excel will be asked to recalculate all formulas when the workbook is opened.MapInfogetMapInfo()Row.MissingCellPolicygetMissingCellPolicy()Retrieves the current policy on what to do when getting missing or blank cells from a row.XSSFNamegetName(String name)Get the first named range with the given name.List<XSSFName>getNames(String name)Get the named ranges with the given name.intgetNumberOfFonts()intgetNumberOfFontsAsInt()Deprecated.intgetNumberOfNames()Get the number of named ranges in the this workbookintgetNumberOfSheets()Get the number of worksheets in the this workbookintgetNumCellStyles()Get the number of styles the workbook containsList<XSSFPivotTable>getPivotTables()StringgetPrintArea(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.SharedStringsTablegetSharedStringSource()Returns SharedStringsTable - tha cache of string for this workbookXSSFSheetgetSheet(String name)Get sheet with the given name (case insensitive match)XSSFSheetgetSheetAt(int index)Get the XSSFSheet object at the given index.intgetSheetIndex(String name)Returns the index of the sheet by his name (case insensitive match)intgetSheetIndex(Sheet sheet)Returns the index of the given sheetStringgetSheetName(int sheetIx)Get the sheet nameSheetVisibilitygetSheetVisibility(int sheetIx)SpreadsheetVersiongetSpreadsheetVersion()Returns the spreadsheet version (EXCLE2007) of this workbookStylesTablegetStylesSource()Return a object representing a collection of shared objects used for styling content, e.g.XSSFTablegetTable(String name)Returns the data table with the given name (case insensitive).ThemesTablegetTheme()Returns the Theme of current workbook.XSSFWorkbookTypegetWorkbookType()XSSFFactorygetXssfFactory()booleanisDate1904()Gets a boolean value that indicates whether the date systems used in the workbook starts in 1904.booleanisHidden()booleanisMacroEnabled()Are we a normal workbook (.xlsx), or a macro enabled workbook (.xlsm)?booleanisRevisionLocked()Specifies a boolean value that indicates whether the workbook is locked for revisions.booleanisSheetHidden(int sheetIx)booleanisSheetVeryHidden(int sheetIx)booleanisStructureLocked()Specifies a boolean value that indicates whether structure of workbook is locked.booleanisWindowsLocked()Specifies a boolean value that indicates whether the windows that comprise the workbook are locked.Iterator<Sheet>iterator()Alias forsheetIterator()to allow foreach loops Note: remove() is not supported on this iterator.intlinkExternalWorkbook(String name, Workbook workbook)Adds the External Link Table part and relations required to allow formulas referencing the specified external workbook to be added to this one.voidlockRevision()Locks the workbook for revisions.voidlockStructure()Locks the structure of workbook.voidlockWindows()Locks the windows that comprise the workbook.protected static OPCPackagenewPackage(XSSFWorkbookType workbookType)Create a new SpreadsheetML package and setup the default minimal contentprotected voidonDeleteFormula(XSSFCell cell)Fired when a formula is deleted from this workbook, for example when calling cell.setCellFormula(null)protected voidonDocumentRead()Fired when a package part is readvoidparseSheet(Map<String,XSSFSheet> shIdMap, org.openxmlformats.schemas.spreadsheetml.x2006.main.CTSheet ctSheet)Not normally to be called externally, but possibly to be overridden to avoid the DOM based parse of large sheets (see examples).voidremoveName(Name name)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.voidsetCellFormulaValidation(boolean value)Whether a call toCellBase.setCellFormula(String)will validate the formula or not.voidsetCellReferenceType(CellReferenceType cellReferenceType)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.protected voidsetPivotTables(List<XSSFPivotTable> pivotTables)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 providedvoidsetRevisionsPassword(String password, HashAlgorithm hashAlgo)Sets the revisions password.voidsetSelectedTab(int index)We only set one sheet as selected for compatibility with HSSF.voidsetSheetHidden(int sheetIx, boolean hidden)voidsetSheetName(int sheetIndex, String sheetname)Set the sheet name.voidsetSheetOrder(String sheetname, int pos)sets the order of appearance for a given sheet.voidsetSheetVisibility(int sheetIx, SheetVisibility visibility)voidsetVBAProject(InputStream vbaProjectStream)Adds a vbaProject.bin file to the workbook.voidsetVBAProject(XSSFWorkbook macroWorkbook)Adds a vbaProject.bin file taken from another, given workbook to this one.voidsetWorkbookPassword(String password, HashAlgorithm hashAlgo)Sets the workbook password.voidsetWorkbookType(XSSFWorkbookType type)Sets whether the workbook will be an .xlsx or .xlsm (macro-enabled) file.Iterator<Sheet>sheetIterator()Returns an iterator of the sheets in the workbook in sheet order.Spliterator<Sheet>spliterator()Returns a spliterator of the sheets in the workbook in sheet order.voidunLock()Removes the workbook protection settingsvoidunLockRevision()Unlocks the workbook for revisions.voidunLockStructure()Unlocks the structure of workbook.voidunLockWindows()Unlocks the windows that comprise the workbook.booleanvalidateRevisionsPassword(String password)Validate the password against the stored hash, the hashing method will be determined by the existing password attributesbooleanvalidateWorkbookPassword(String password)Validate the password against the stored hash, the hashing method will be determined by the existing password attributes-
Methods inherited from class org.apache.poi.ooxml.POIXMLDocument
getCorePart, getPackage, getProperties, getRelatedByType, load, openPackage, write
-
Methods inherited from class org.apache.poi.ooxml.POIXMLDocumentPart
_invokeOnDocumentRead, addRelation, createRelationship, createRelationship, createRelationship, getNextPartNumber, getPackagePart, getParent, getRelationById, getRelationId, getRelationPartById, getRelationParts, getRelations, getTargetPart, isCommitted, onDocumentCreate, onDocumentRemove, onSave, prepareForCommit, read, rebase, removeRelation, removeRelation, removeRelation, setCommitted, toString
-
-
-
-
Field Detail
-
PICTURE_TYPE_GIF
public static final int PICTURE_TYPE_GIF
Images formats supported by XSSF but not by HSSF- See Also:
- Constant Field Values
-
PICTURE_TYPE_TIFF
public static final int PICTURE_TYPE_TIFF
- See Also:
- Constant Field Values
-
PICTURE_TYPE_EPS
public static final int PICTURE_TYPE_EPS
- See Also:
- Constant Field Values
-
PICTURE_TYPE_BMP
public static final int PICTURE_TYPE_BMP
- See Also:
- Constant Field Values
-
PICTURE_TYPE_WPG
public static final int PICTURE_TYPE_WPG
- See Also:
- Constant Field Values
-
-
Constructor Detail
-
XSSFWorkbook
public XSSFWorkbook()
Create a new SpreadsheetML workbook.
-
XSSFWorkbook
public XSSFWorkbook(XSSFFactory factory)
-
XSSFWorkbook
public XSSFWorkbook(XSSFWorkbookType workbookType)
Create a new SpreadsheetML workbook.- Parameters:
workbookType- The type of workbook to make (.xlsx or .xlsm).
-
XSSFWorkbook
public XSSFWorkbook(OPCPackage pkg) throws IOException
Constructs a XSSFWorkbook object given a OpenXML4JPackageobject, see https://poi.apache.org/oxml4j/.Once you have finished working with the Workbook, you should close the package by calling either
close()orOPCPackage.close(), to avoid leaving file handles open.Creating a XSSFWorkbook from a file-backed OPC Package has a lower memory footprint than an InputStream backed one.
- Parameters:
pkg- the OpenXML4JOPC Packageobject.- Throws:
IOException- If reading data from the package failsPOIXMLException- a RuntimeException that can be caused by invalid OOXML dataRuntimeException- a number of other runtime exceptions can be thrown, especially if there are problems with the input format
-
XSSFWorkbook
public XSSFWorkbook(InputStream is) throws IOException
Constructs a XSSFWorkbook object, by buffering the whole stream into memory and then opening anOPCPackageobject for it.Using an
InputStreamrequires more memory than using a File, so if aFileis available then you should instead do something likeOPCPackage pkg = OPCPackage.open(path); XSSFWorkbook wb = new XSSFWorkbook(pkg); // work with the wb object ...... pkg.close(); // gracefully closes the underlying zip file- Throws:
IOException- If reading data from the stream failsPOIXMLException- a RuntimeException that can be caused by invalid OOXML dataRuntimeException- a number of other runtime exceptions can be thrown, especially if there are problems with the input format
-
XSSFWorkbook
public XSSFWorkbook(File file) throws IOException, InvalidFormatException
Constructs a XSSFWorkbook object from a given file.Once you have finished working with the Workbook, you should close the package by calling
close(), to avoid leaving file handles open.Opening a XSSFWorkbook from a file has a lower memory footprint than opening from an InputStream
- Parameters:
file- the file to open- Throws:
IOException- If reading data from the file failsInvalidFormatException- If the file has a format that cannot be read or if the file is corruptedPOIXMLException- a RuntimeException that can be caused by invalid OOXML dataRuntimeException- a number of other runtime exceptions can be thrown, especially if there are problems with the input format
-
XSSFWorkbook
public XSSFWorkbook(String path) throws IOException
Constructs a XSSFWorkbook object given a file name.Once you have finished working with the Workbook, you should close the package by calling
close(), to avoid leaving file handles open.Opening a XSSFWorkbook from a file has a lower memory footprint than opening from an InputStream
- Parameters:
path- the file name.- Throws:
IOException- If reading data from the file failsPOIXMLException- a RuntimeException that can be caused by invalid OOXML dataRuntimeException- a number of other runtime exceptions can be thrown, especially if there are problems with the input format
-
XSSFWorkbook
public XSSFWorkbook(PackagePart part) throws IOException
Constructs a XSSFWorkbook object using Package Part.- Parameters:
part- package part- Throws:
IOException- If reading data from the Package Part failsPOIXMLException- a RuntimeException that can be caused by invalid OOXML dataRuntimeException- a number of other runtime exceptions can be thrown, especially if there are problems with the input format- Since:
- POI 4.0.0
-
-
Method Detail
-
getXssfFactory
public XSSFFactory getXssfFactory()
- Returns:
- the XSSFFactory
- Since:
- POI 5.1.0
-
beforeDocumentRead
protected void beforeDocumentRead()
-
onDocumentRead
protected void onDocumentRead() throws IOExceptionDescription copied from class:POIXMLDocumentPartFired when a package part is read- Overrides:
onDocumentReadin classPOIXMLDocumentPart- Throws:
IOException- a subclass may throw an IOException when a document is read
-
parseSheet
public void parseSheet(Map<String,XSSFSheet> shIdMap, org.openxmlformats.schemas.spreadsheetml.x2006.main.CTSheet ctSheet)
Not normally to be called externally, but possibly to be overridden to avoid the DOM based parse of large sheets (see examples).- Throws:
POIXMLException- a RuntimeException that can be caused by invalid OOXML dataRuntimeException- a number of other runtime exceptions can be thrown, especially if there are problems with the input format
-
newPackage
protected static OPCPackage newPackage(XSSFWorkbookType workbookType)
Create a new SpreadsheetML package and setup the default minimal content
-
getCTWorkbook
@Internal public org.openxmlformats.schemas.spreadsheetml.x2006.main.CTWorkbook getCTWorkbook()
Return the underlying XML bean- Returns:
- the underlying CTWorkbook bean
-
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.- Returns:
- the index to this picture (0 based), the added picture can be obtained from
getAllPictures(). - See Also:
Workbook.PICTURE_TYPE_EMF,Workbook.PICTURE_TYPE_WMF,Workbook.PICTURE_TYPE_PICT,Workbook.PICTURE_TYPE_JPEG,Workbook.PICTURE_TYPE_PNG,Workbook.PICTURE_TYPE_DIB,getAllPictures()
-
addPicture
public int addPicture(InputStream is, int format) throws IOException
Adds a picture to the workbook.- Parameters:
is- The sream to read image fromformat- The format of the picture.- Returns:
- the index to this picture (0 based), the added picture can be obtained from
getAllPictures(). - Throws:
IOException- See Also:
Workbook.PICTURE_TYPE_EMF,Workbook.PICTURE_TYPE_WMF,Workbook.PICTURE_TYPE_PICT,Workbook.PICTURE_TYPE_JPEG,Workbook.PICTURE_TYPE_PNG,Workbook.PICTURE_TYPE_DIB,getAllPictures()
-
cloneSheet
public XSSFSheet cloneSheet(int sheetNum)
Create an XSSFSheet from an existing sheet in the XSSFWorkbook. The cloned sheet is a deep copy of the original.- Specified by:
cloneSheetin interfaceWorkbook- Parameters:
sheetNum- The index of the sheet to clone- Returns:
- XSSFSheet representing the cloned sheet.
- Throws:
IllegalArgumentException- if the sheet index in invalidPOIXMLException- if there were errors when cloning
-
close
public void close() throws IOExceptionDescription copied from class:POIXMLDocumentCloses the underlyingOPCPackagefrom which this document was read, if there is oneOnce this has been called, no further operations, updates or reads should be performed on the document.
- Specified by:
closein interfaceAutoCloseable- Specified by:
closein interfaceCloseable- Specified by:
closein interfaceWorkbook- Overrides:
closein classPOIXMLDocument- Throws:
IOException- for writable packages, if an IO exception occur during the saving process.
-
cloneSheet
public XSSFSheet cloneSheet(int sheetNum, String newName)
Create an XSSFSheet from an existing sheet in the XSSFWorkbook. The cloned sheet is a deep copy of the original but with a new given name.- Parameters:
sheetNum- The index of the sheet to clonenewName- The name to set for the newly created sheet- Returns:
- XSSFSheet representing the cloned sheet.
- Throws:
IllegalArgumentException- if the sheet index or the sheet name is invalidPOIXMLException- if there were errors when cloning
-
createCellStyle
public XSSFCellStyle createCellStyle()
Create a new XSSFCellStyle and add it to the workbook's style table- Specified by:
createCellStylein interfaceWorkbook- Returns:
- the new XSSFCellStyle object
-
createDataFormat
public XSSFDataFormat createDataFormat()
Returns the workbook's data format table (a factory for creating data format strings).- Specified by:
createDataFormatin interfaceWorkbook- Returns:
- the XSSFDataFormat object
- See Also:
DataFormat
-
createFont
public XSSFFont createFont()
Create a new Font and add it to the workbook's font table- Specified by:
createFontin interfaceWorkbook- Returns:
- new font object
-
createName
public XSSFName createName()
- Specified by:
createNamein interfaceWorkbook
-
createSheet
public XSSFSheet createSheet()
Create an XSSFSheet for this workbook, adds it to the sheets and returns the high level representation. Use this to create new sheets.- Specified by:
createSheetin interfaceWorkbook- Returns:
- XSSFSheet representing the new sheet.
-
createSheet
public XSSFSheet createSheet(String sheetname)
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 (])
See
WorkbookUtil.createSafeSheetName(String nameProposal)for a safe way to create valid names- 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:
WorkbookUtil.createSafeSheetName(String nameProposal)
-
createDialogsheet
protected XSSFDialogsheet createDialogsheet(String sheetname, org.openxmlformats.schemas.spreadsheetml.x2006.main.CTDialogsheet dialogsheet)
-
findFont
public XSSFFont 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
-
getActiveSheetIndex
public int getActiveSheetIndex()
Convenience method to get 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:
getActiveSheetIndexin interfaceWorkbook
-
getAllPictures
public List<XSSFPictureData> getAllPictures()
Gets all pictures from the Workbook.- Specified by:
getAllPicturesin interfaceWorkbook- Returns:
- the list of pictures (a list of
XSSFPictureDataobjects.) - See Also:
addPicture(byte[], int)
-
getCellStyleAt
public XSSFCellStyle getCellStyleAt(int idx)
Get the cell style object at the given index- Specified by:
getCellStyleAtin interfaceWorkbook- Parameters:
idx- index within the set of styles- Returns:
- XSSFCellStyle object at the index
-
getName
public XSSFName getName(String name)
Get the first named range with the given name. Note: names of named ranges are not unique as they are scoped by sheet.getNames(String name)returns all named ranges with the given name.
-
getNames
public List<XSSFName> getNames(String name)
Get the named ranges with the given name. Note:Excel named ranges are case-insensitive and this method performs a case-insensitive search.
-
getAllNames
public List<XSSFName> getAllNames()
Get a list of all the named ranges in the workbook.- Specified by:
getAllNamesin interfaceWorkbook- Returns:
- list of XSSFNames in the workbook
-
getNumCellStyles
public int getNumCellStyles()
Get the number of styles the workbook contains- Specified by:
getNumCellStylesin interfaceWorkbook- Returns:
- count of cell styles
-
getNumberOfFonts
public int getNumberOfFonts()
- Specified by:
getNumberOfFontsin interfaceWorkbook
-
getNumberOfFontsAsInt
@Deprecated @Removal(version="6.0.0") public int getNumberOfFontsAsInt()
Deprecated.- Specified by:
getNumberOfFontsAsIntin interfaceWorkbook
-
getNumberOfNames
public int getNumberOfNames()
Get the number of named ranges in the this workbook- Specified by:
getNumberOfNamesin interfaceWorkbook- Returns:
- number of named ranges
-
getNumberOfSheets
public int getNumberOfSheets()
Get the number of worksheets in the this workbook- Specified by:
getNumberOfSheetsin interfaceWorkbook- Returns:
- number of worksheets
-
getPrintArea
public 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.- 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
-
getSheet
public XSSFSheet getSheet(String name)
Get sheet with the given name (case insensitive match)
-
getSheetAt
public XSSFSheet getSheetAt(int index)
Get the XSSFSheet object at the given index.- Specified by:
getSheetAtin interfaceWorkbook- Parameters:
index- of the sheet number (0-based physical & logical)- Returns:
- XSSFSheet at the provided index
- Throws:
IllegalArgumentException- if the index is out of range (index < 0 || index >= getNumberOfSheets()).
-
getSheetIndex
public int getSheetIndex(String name)
Returns the index of the sheet by his name (case insensitive match)- Specified by:
getSheetIndexin interfaceWorkbook- Parameters:
name- the sheet name- Returns:
- index of the sheet (0 based) or
-1if not found
-
getSheetIndex
public int getSheetIndex(Sheet sheet)
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).
-1if not found
-
getSheetName
public String getSheetName(int sheetIx)
Get the sheet name- Specified by:
getSheetNamein interfaceWorkbook- Parameters:
sheetIx- Number- Returns:
- Sheet name
-
sheetIterator
public Iterator<Sheet> sheetIterator()
Returns an iterator of the sheets in the workbook in sheet order. Includes hidden and very hidden sheets. Note: remove() is not supported on this iterator. UseremoveSheetAt(int)to remove sheets instead.- Specified by:
sheetIteratorin interfaceWorkbook- Returns:
- an iterator of the sheets.
-
iterator
public Iterator<Sheet> iterator()
Alias forsheetIterator()to allow foreach loops Note: remove() is not supported on this iterator. UseremoveSheetAt(int)to remove sheets instead.
-
spliterator
public Spliterator<Sheet> spliterator()
Returns a spliterator of the sheets in the workbook in sheet order. Includes hidden and very hidden sheets.- Specified by:
spliteratorin interfaceIterable<Sheet>- Specified by:
spliteratorin interfaceWorkbook- Returns:
- a spliterator of the sheets.
- Since:
- POI 5.2.0
-
isMacroEnabled
public boolean isMacroEnabled()
Are we a normal workbook (.xlsx), or a macro enabled workbook (.xlsm)?
-
removeName
public void removeName(Name name)
- Specified by:
removeNamein interfaceWorkbook- Parameters:
name- the name to remove.- Throws:
IllegalArgumentException- if the named range is not a part of this XSSFWorkbook
-
removePrintArea
public void removePrintArea(int sheetIndex)
Delete the printarea for the sheet specified- Specified by:
removePrintAreain interfaceWorkbook- Parameters:
sheetIndex- 0-based sheet index (0 = First Sheet)
-
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)
-
getMissingCellPolicy
public Row.MissingCellPolicy 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
public void setMissingCellPolicy(Row.MissingCellPolicy missingCellPolicy)
Sets the policy on what to do when getting missing or blank cells from a row. This will then apply to all calls toRow.getCell(int)}. SeeRow.MissingCellPolicy- Specified by:
setMissingCellPolicyin interfaceWorkbook
-
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
-
getFirstVisibleTab
public int getFirstVisibleTab()
Gets the first tab that is displayed in the list of tabs in excel.- Specified by:
getFirstVisibleTabin interfaceWorkbook- Returns:
- integer that contains the index to the active sheet in this book view.
-
setFirstVisibleTab
public void setFirstVisibleTab(int index)
Sets the first tab that is displayed in the list of tabs in excel.- Specified by:
setFirstVisibleTabin interfaceWorkbook- Parameters:
index- integer that contains the index to the active sheet in this book view.
-
setPrintArea
public void setPrintArea(int sheetIndex, String reference)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:
setPrintArea(int, String)
-
getCellReferenceType
public CellReferenceType getCellReferenceType()
- Specified by:
getCellReferenceTypein interfaceWorkbook
-
setCellReferenceType
public void setCellReferenceType(CellReferenceType cellReferenceType)
- Specified by:
setCellReferenceTypein interfaceWorkbook
-
setSelectedTab
public void setSelectedTab(int index)
We only set one sheet as selected for compatibility with HSSF.- Specified by:
setSelectedTabin interfaceWorkbook
-
setSheetName
public void setSheetName(int sheetIndex, String sheetname)Set the sheet name.- Specified by:
setSheetNamein interfaceWorkbook- Parameters:
sheetIndex- sheet number (0 based)sheetname- the new sheet name- Throws:
IllegalArgumentException- if the name is null or invalid or workbook already contains a sheet with this name- See Also:
createSheet(String),WorkbookUtil.createSafeSheetName(String nameProposal)
-
setSheetOrder
public void setSheetOrder(String sheetname, int pos)
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)
-
commit
protected void commit() throws IOExceptionDescription copied from class:POIXMLDocumentPartSave the content in the underlying package part. Default implementation is empty meaning that the package part is left unmodified.Sub-classes should override and add logic to marshal the "model" into Ooxml4J.
For example, the code saving a generic XML entry may look as follows:
protected void commit() throws IOException { PackagePart part = getPackagePart(); try (OutputStream out = part.getOutputStream()) { XmlObject bean = getXmlBean(); //the "model" which holds changes in memory bean.save(out, DEFAULT_XML_OPTIONS); } }- Overrides:
commitin classPOIXMLDocumentPart- Throws:
IOException- a subclass may throw an IOException if the changes can't be committed
-
getSharedStringSource
@Internal public SharedStringsTable getSharedStringSource()
Returns SharedStringsTable - tha cache of string for this workbook- Returns:
- the shared string table
-
getStylesSource
public StylesTable getStylesSource()
Return a object representing a collection of shared objects used for styling content, e.g. fonts, cell styles, colors, etc.
-
getTheme
public ThemesTable getTheme()
Returns the Theme of current workbook.
-
getCreationHelper
public XSSFCreationHelper getCreationHelper()
Returns an object that handles instantiating concrete classes of the various instances for XSSF.- Specified by:
getCreationHelperin interfaceWorkbook
-
isDate1904
@Internal public boolean isDate1904()
Gets a boolean value that indicates whether the date systems used in the workbook starts in 1904.The default value is false, meaning that the workbook uses the 1900 date system, where 1/1/1900 is the first day in the system..
- Specified by:
isDate1904in interfaceDate1904Support- Returns:
- true if the date systems used in the workbook starts in 1904
-
getAllEmbeddedParts
public List<PackagePart> getAllEmbeddedParts() throws OpenXML4JException
Get the document's embedded files.- Specified by:
getAllEmbeddedPartsin classPOIXMLDocument- Returns:
- the document's embedded files
- Throws:
OpenXML4JException- if the embedded parts can't be determined
-
isHidden
@NotImplemented public boolean isHidden()
-
setHidden
@NotImplemented public void setHidden(boolean hiddenFlag)
-
isSheetHidden
public boolean isSheetHidden(int sheetIx)
- Specified by:
isSheetHiddenin interfaceWorkbook
-
isSheetVeryHidden
public boolean isSheetVeryHidden(int sheetIx)
- Specified by:
isSheetVeryHiddenin interfaceWorkbook
-
getSheetVisibility
public SheetVisibility getSheetVisibility(int sheetIx)
- Specified by:
getSheetVisibilityin interfaceWorkbook
-
setSheetHidden
public void setSheetHidden(int sheetIx, boolean hidden)- Specified by:
setSheetHiddenin interfaceWorkbook
-
setSheetVisibility
public void setSheetVisibility(int sheetIx, SheetVisibility visibility)- Specified by:
setSheetVisibilityin interfaceWorkbook
-
onDeleteFormula
protected void onDeleteFormula(XSSFCell cell)
Fired when a formula is deleted from this workbook, for example when calling cell.setCellFormula(null)- See Also:
CellBase.setCellFormula(String)
-
getCalculationChain
@Internal public CalculationChain getCalculationChain()
Return theCalculationChainobject for this workbookThe calculation chain object specifies the order in which the cells in a workbook were last calculated
- Returns:
- the
CalculationChainobject ornullif not defined
-
getExternalLinksTable
@Internal public List<ExternalLinksTable> getExternalLinksTable()
Returns the list ofExternalLinksTableobject for this workbookThe external links table specifies details of named ranges etc that are referenced from other workbooks, along with the last seen values of what they point to.
Note that Excel uses index 0 for the current workbook, so the first External Links in a formula would be '[1]Foo' which corresponds to entry 0 in this list.
- Returns:
- the
ExternalLinksTablelist, which may be empty
-
getCustomXMLMappings
public Collection<XSSFMap> getCustomXMLMappings()
- Returns:
- a collection of custom XML mappings defined in this workbook
-
getMapInfo
@Internal public MapInfo getMapInfo()
- Returns:
- the helper class used to query the custom XML mapping defined in this workbook
-
linkExternalWorkbook
@Beta public int linkExternalWorkbook(String name, Workbook workbook)
Adds the External Link Table part and relations required to allow formulas referencing the specified external workbook to be added to this one. Allows formulas such as "[MyOtherWorkbook.xlsx]Sheet3!$A$5" to be added to the file, for workbooks not already linked / referenced.This support is still regarded as in beta and may change
see https://bz.apache.org/bugzilla/show_bug.cgi?id=57184
- 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- Returns:
- index position for external workbook
- Since:
- POI 5.1.0
-
isStructureLocked
public boolean isStructureLocked()
Specifies a boolean value that indicates whether structure of workbook is locked.
A value true indicates the structure of the workbook is locked. Worksheets in the workbook can't be moved, deleted, hidden, unhidden, or renamed, and new worksheets can't be inserted.
A value of false indicates the structure of the workbook is not locked.- Returns:
- true if structure of workbook is locked
-
isWindowsLocked
public boolean isWindowsLocked()
Specifies a boolean value that indicates whether the windows that comprise the workbook are locked.
A value of true indicates the workbook windows are locked. Windows are the same size and position each time the workbook is opened.
A value of false indicates the workbook windows are not locked.- Returns:
- true if windows that comprise the workbook are locked
-
isRevisionLocked
public boolean isRevisionLocked()
Specifies a boolean value that indicates whether the workbook is locked for revisions.- Returns:
- true if the workbook is locked for revisions.
-
lockStructure
public void lockStructure()
Locks the structure of workbook.
-
unLockStructure
public void unLockStructure()
Unlocks the structure of workbook.
-
lockWindows
public void lockWindows()
Locks the windows that comprise the workbook.
-
unLockWindows
public void unLockWindows()
Unlocks the windows that comprise the workbook.
-
lockRevision
public void lockRevision()
Locks the workbook for revisions.
-
unLockRevision
public void unLockRevision()
Unlocks the workbook for revisions.
-
setWorkbookPassword
public void setWorkbookPassword(String password, HashAlgorithm hashAlgo)
Sets the workbook password.- Parameters:
password- if null, the password will be removedhashAlgo- if null, the password will be set as XOR password (Excel 2010 and earlier) otherwise the given algorithm is used for calculating the hash password (Excel 2013)
-
validateWorkbookPassword
public boolean validateWorkbookPassword(String password)
Validate the password against the stored hash, the hashing method will be determined by the existing password attributes- Returns:
- true, if the hashes match (... though original password may differ ...)
-
setRevisionsPassword
public void setRevisionsPassword(String password, HashAlgorithm hashAlgo)
Sets the revisions password.- Parameters:
password- if null, the password will be removedhashAlgo- if null, the password will be set as XOR password (Excel 2010 and earlier) otherwise the given algorithm is used for calculating the hash password (Excel 2013)
-
validateRevisionsPassword
public boolean validateRevisionsPassword(String password)
Validate the password against the stored hash, the hashing method will be determined by the existing password attributes- Returns:
- true if the hashes match (... though original password may differ ...)
-
unLock
public void unLock()
Removes the workbook protection settings
-
addToolPack
public void addToolPack(UDFFinder toolpack)
Register a new toolpack in this workbook.- Specified by:
addToolPackin interfaceWorkbook- Parameters:
toolpack- 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
-
addPivotCache
@Beta protected org.openxmlformats.schemas.spreadsheetml.x2006.main.CTPivotCache addPivotCache(String rId)
Add pivotCache to the workbook
-
getPivotTables
@Beta public List<XSSFPivotTable> getPivotTables()
-
setPivotTables
@Beta protected void setPivotTables(List<XSSFPivotTable> pivotTables)
-
getWorkbookType
public XSSFWorkbookType getWorkbookType()
-
setWorkbookType
public void setWorkbookType(XSSFWorkbookType type)
Sets whether the workbook will be an .xlsx or .xlsm (macro-enabled) file.
-
setVBAProject
public void setVBAProject(InputStream vbaProjectStream) throws IOException
Adds a vbaProject.bin file to the workbook. This will change the workbook type if necessary.- Throws:
IOException- If copying data from the stream fails.
-
setVBAProject
public void setVBAProject(XSSFWorkbook macroWorkbook) throws IOException, InvalidFormatException
Adds a vbaProject.bin file taken from another, given workbook to this one.- Throws:
IOException- If copying the VBAProject stream fails.InvalidFormatException- If an error occurs while handling parts of the XSSF format
-
getSpreadsheetVersion
public SpreadsheetVersion getSpreadsheetVersion()
Returns the spreadsheet version (EXCLE2007) of this workbook- Specified by:
getSpreadsheetVersionin interfaceWorkbook- Returns:
- EXCEL2007 SpreadsheetVersion enum
- Since:
- 3.14 beta 2
-
getTable
public XSSFTable getTable(String name)
Returns the data table with the given name (case insensitive).- Parameters:
name- the data table name (case-insensitive)- Returns:
- The Data table in the workbook named
name, ornullif no table is namedname. - Since:
- 3.15 beta 2
-
addOlePackage
public int addOlePackage(byte[] oleData, String label, String fileName, String command) throws IOException- Specified by:
addOlePackagein interfaceWorkbook- Throws:
IOException
-
setCellFormulaValidation
public void setCellFormulaValidation(boolean value)
Whether a call toCellBase.setCellFormula(String)will validate the formula or not.- Parameters:
value- true if the application will validate the formula is correct- Since:
- 3.17
-
getCellFormulaValidation
public boolean getCellFormulaValidation()
Whether a call toCellBase.setCellFormula(String)will validate the formula or not.- Since:
- 3.17
-
createEvaluationWorkbook
public XSSFEvaluationWorkbook createEvaluationWorkbook()
- Specified by:
createEvaluationWorkbookin interfaceWorkbook
-
-