XSSFSheet (POI API Documentation)

Overview

Package

Class

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.apache.poi.xssf.usermodel
Class XSSFSheet

java.lang.Object
  org.apache.poi.POIXMLDocumentPart
      org.apache.poi.xssf.usermodel.XSSFSheet

All Implemented Interfaces:: java.lang.Iterable<Row>, Sheet

Direct Known Subclasses:: XSSFChartSheet, XSSFDialogsheet

public class XSSFSheet
extends POIXMLDocumentPart
implements Sheet
extends POIXMLDocumentPart
implements Sheet

High level representation of a SpreadsheetML worksheet.

Sheets are the central structures within a workbook, and are where a user does most of his spreadsheet work. The most common type of sheet is the worksheet, which is represented as a grid of cells. Worksheet cells can contain text, numbers, dates, and formulas. Cells can also be formatted.

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.poi.POIXMLDocumentPart
`POIXMLDocumentPart.RelationPart`

Field Summary
`protected org.openxmlformats.schemas.spreadsheetml.x2006.main.CTSheet`	`sheet`
`static int`	`TWIPS_PER_POINT`
`protected org.openxmlformats.schemas.spreadsheetml.x2006.main.CTWorksheet`	`worksheet`

Fields inherited from interface org.apache.poi.ss.usermodel.Sheet
`BottomMargin, FooterMargin, HeaderMargin, LeftMargin, PANE_LOWER_LEFT, PANE_LOWER_RIGHT, PANE_UPPER_LEFT, PANE_UPPER_RIGHT, RightMargin, TopMargin`

Constructor Summary
`protected`	`XSSFSheet()` Creates new XSSFSheet - called by XSSFWorkbook to create a sheet from scratch.
`protected`	`XSSFSheet(PackagePart part)` Creates an XSSFSheet representing the given package part and relationship.
`protected`	`XSSFSheet(PackagePart part, PackageRelationship rel)` Deprecated. in POI 3.14, scheduled for removal in POI 3.16

Method Summary
`void`	`addHyperlink(XSSFHyperlink hyperlink)` Register a hyperlink in the collection of hyperlinks on this sheet
`void`	`addIgnoredErrors(CellRangeAddress region, IgnoredErrorType... ignoredErrorTypes)` Ignore errors across a range of cells.
`void`	`addIgnoredErrors(CellReference cell, IgnoredErrorType... ignoredErrorTypes)` Add ignored errors (usually to suppress them in the UI of a consuming application).
`int`	`addMergedRegion(CellRangeAddress region)` Adds a merged region of cells on a sheet.
`int`	`addMergedRegionUnsafe(CellRangeAddress region)` Adds a merged region of cells (hence those cells form one).
`void`	`addValidationData(DataValidation dataValidation)`
`void`	`autoSizeColumn(int column)` Adjusts the column width to fit the contents.
`void`	`autoSizeColumn(int column, boolean useMergedCells)` Adjusts the column width to fit the contents.
`protected void`	`commit()` Save the content in the underlying package part.
`void`	`copyRows(int srcStartRow, int srcEndRow, int destStartRow, CellCopyPolicy cellCopyPolicy)` Copies rows between srcStartRow and srcEndRow to the same sheet, starting at destStartRow Convenience function for `copyRows(List, int, CellCopyPolicy)` Equivalent to copyRows(getRows(srcStartRow, srcEndRow, false), destStartRow, cellCopyPolicy)
`void`	`copyRows(java.util.List<? extends Row> srcRows, int destStartRow, CellCopyPolicy policy)` copyRows rows from srcRows to this sheet starting at destStartRow Additionally copies merged regions that are completely defined in these rows (ie.
`XSSFDrawing`	`createDrawingPatriarch()` Create a new SpreadsheetML drawing.
`void`	`createFreezePane(int colSplit, int rowSplit)` Creates a split (freezepane).
`void`	`createFreezePane(int colSplit, int rowSplit, int leftmostColumn, int topRow)` Creates a split (freezepane).
`XSSFPivotTable`	`createPivotTable(AreaReference source, CellReference position)` Create a pivot table and set area of source and a position for pivot table
`XSSFPivotTable`	`createPivotTable(AreaReference source, CellReference position, Sheet sourceSheet)` Create a pivot table and set area of source, source sheet and a position for pivot table
`XSSFRow`	`createRow(int rownum)` Create a new row within the sheet and return the high level representation Note: If a row already exists at this position, it is removed/overwritten and any existing cell is removed!
`void`	`createSplitPane(int xSplitPos, int ySplitPos, int leftmostColumn, int topRow, int activePane)` Creates a split pane.
`XSSFTable`	`createTable()` Creates a new Table, and associates it with this Sheet
`void`	`disableLocking()` Disable sheet protection
`void`	`enableLocking()` Enable sheet protection
`int`	`findEndOfRowOutlineGroup(int row)`
`CellAddress`	`getActiveCell()` Return location of the active cell, e.g.
`boolean`	`getAutobreaks()` Flag indicating whether the sheet displays Automatic Page Breaks.
`XSSFComment`	`getCellComment(CellAddress address)` Return cell comment at row, column, if one exists.
`XSSFComment`	`getCellComment(int row, int column)` Deprecated. as of 2015-11-23 (circa POI 3.14beta1). Use `getCellComment(CellAddress)` instead.
`java.util.Map<CellAddress,XSSFComment>`	`getCellComments()` Returns all cell comments on this sheet.
`int[]`	`getColumnBreaks()` Vertical page break information used for print layout view, page layout view, drawing print breaks in normal view, and for printing the worksheet.
`ColumnHelper`	`getColumnHelper()`
`int`	`getColumnOutlineLevel(int columnIndex)`
`CellStyle`	`getColumnStyle(int column)` Returns the CellStyle that applies to the given (0 based) column, or null if no style has been set for that column
`int`	`getColumnWidth(int columnIndex)` Get the actual column width (in units of 1/256th of a character width )
`float`	`getColumnWidthInPixels(int columnIndex)` Get the actual column width in pixels
`protected CommentsTable`	`getCommentsTable(boolean create)` Returns the sheet's comments object if there is one, or null if not
`protected org.openxmlformats.schemas.spreadsheetml.x2006.main.CTDrawing`	`getCTDrawing()`
`protected org.openxmlformats.schemas.spreadsheetml.x2006.main.CTLegacyDrawing`	`getCTLegacyDrawing()`
`org.openxmlformats.schemas.spreadsheetml.x2006.main.CTWorksheet`	`getCTWorksheet()` Provide access to the CTWorksheet bean holding this sheet's data
`DataValidationHelper`	`getDataValidationHelper()`
`java.util.List<XSSFDataValidation>`	`getDataValidations()`
`int`	`getDefaultColumnWidth()` Get the default column width for the sheet (if the columns do not define their own width) in characters.
`short`	`getDefaultRowHeight()` Get the default row height for the sheet (if the rows do not define their own height) in twips (1/20 of a point)
`float`	`getDefaultRowHeightInPoints()` Get the default row height for the sheet measued in point size (if the rows do not define their own height).
`boolean`	`getDisplayGuts()` Get whether to display the guts or not, default value is true
`XSSFDrawing`	`getDrawingPatriarch()` Return the sheet's existing drawing, or null if there isn't yet one.
`Footer`	`getEvenFooter()` Returns the even footer.
`Header`	`getEvenHeader()` Returns the even header.
`Footer`	`getFirstFooter()` Returns the first page footer.
`Header`	`getFirstHeader()` Returns the first page header.
`int`	`getFirstRowNum()` Gets the first row on the sheet
`boolean`	`getFitToPage()` Flag indicating whether the Fit to Page print option is enabled.
`Footer`	`getFooter()` Returns the default footer for the sheet, creating one as needed.
`boolean`	`getForceFormulaRecalculation()` Whether Excel will be asked to recalculate all formulas when the workbook is opened.
`Header`	`getHeader()` Returns the default header for the sheet, creating one as needed.
`boolean`	`getHorizontallyCenter()` Determine whether printed output for this sheet will be horizontally centered.
`XSSFHyperlink`	`getHyperlink(int row, int column)` Get a Hyperlink in this sheet anchored at row, column
`java.util.List<XSSFHyperlink>`	`getHyperlinkList()` Get a list of Hyperlinks in this sheet
`java.util.Map<IgnoredErrorType,java.util.Set<CellRangeAddress>>`	`getIgnoredErrors()` Returns the errors currently being ignored and the ranges where they are ignored.
`int`	`getLastRowNum()`
`short`	`getLeftCol()`
`double`	`getMargin(short margin)` Gets the size of the margin in inches.
`CellRangeAddress`	`getMergedRegion(int index)` Returns the merged region at the specified index.
`java.util.List<CellRangeAddress>`	`getMergedRegions()` Returns the list of merged regions.
`protected int`	`getNumberOfComments()`
`int`	`getNumHyperlinks()`
`int`	`getNumMergedRegions()` Returns the number of merged regions defined in this worksheet
`Footer`	`getOddFooter()` Returns the odd footer.
`Header`	`getOddHeader()` Returns the odd header.
`PaneInformation`	`getPaneInformation()` Returns the information regarding the currently configured pane (split or freeze).
`int`	`getPhysicalNumberOfRows()` Returns the number of physically defined rows (NOT the number of rows in the sheet)
`java.util.List<XSSFPivotTable>`	`getPivotTables()` Returns all the pivot tables for this Sheet
`XSSFPrintSetup`	`getPrintSetup()` Gets the print setup object.
`boolean`	`getProtect()` Answer whether protection is enabled or disabled
`CellRangeAddress`	`getRepeatingColumns()`
`CellRangeAddress`	`getRepeatingRows()`
`XSSFRow`	`getRow(int rownum)` Returns the logical row ( 0-based).
`int[]`	`getRowBreaks()` Horizontal page break information used for print layout view, page layout view, drawing print breaks in normal view, and for printing the worksheet.
`boolean`	`getRowSumsBelow()` Flag indicating whether summary rows appear below detail in an outline, when applying an outline.
`boolean`	`getRowSumsRight()` Flag indicating whether summary columns appear to the right of detail in an outline, when applying an outline.
`boolean`	`getScenarioProtect()` A flag indicating whether scenarios are locked when the sheet is protected.
`org.openxmlformats.schemas.spreadsheetml.x2006.main.CTCellFormula`	`getSharedFormula(int sid)` Return a master shared formula by index
`XSSFSheetConditionalFormatting`	`getSheetConditionalFormatting()`
`java.lang.String`	`getSheetName()` Returns the name of this sheet
`XSSFColor`	`getTabColor()` Get background color of the sheet tab.
`java.util.List<XSSFTable>`	`getTables()` Returns any tables associated with this Sheet
`short`	`getTopRow()` The top row in the visible view when the sheet is first viewed after opening it in a viewer
`boolean`	`getVerticallyCenter()` Determine whether printed output for this sheet will be vertically centered.
`protected XSSFVMLDrawing`	`getVMLDrawing(boolean autoCreate)` Get VML drawing for this sheet (aka 'legacy' drawig)
`XSSFWorkbook`	`getWorkbook()` Returns the parent XSSFWorkbook
`void`	`groupColumn(int fromColumn, int toColumn)` Group between (0 based) columns
`void`	`groupRow(int fromRow, int toRow)` Tie a range of cell together so that they can be collapsed or expanded
`boolean`	`hasComments()` Does this sheet have any comments on it? We need to know, so we can decide about writing it to disk or not
`boolean`	`isAutoFilterLocked()`
`boolean`	`isColumnBroken(int column)` Determines if there is a page break at the indicated column
`boolean`	`isColumnHidden(int columnIndex)` Get the hidden state for a given column.
`boolean`	`isDeleteColumnsLocked()`
`boolean`	`isDeleteRowsLocked()`
`boolean`	`isDisplayFormulas()` Gets the flag indicating whether this sheet should display formulas.
`boolean`	`isDisplayGridlines()` Gets the flag indicating whether this sheet displays the lines between rows and columns to make editing and reading easier.
`boolean`	`isDisplayRowColHeadings()` Gets the flag indicating whether this sheet should display row and column headings.
`boolean`	`isDisplayZeros()` Gets the flag indicating whether the window should show 0 (zero) in cells containing zero value.
`boolean`	`isFormatCellsLocked()`
`boolean`	`isFormatColumnsLocked()`
`boolean`	`isFormatRowsLocked()`
`boolean`	`isInsertColumnsLocked()`
`boolean`	`isInsertHyperlinksLocked()`
`boolean`	`isInsertRowsLocked()`
`boolean`	`isObjectsLocked()`
`boolean`	`isPivotTablesLocked()`
`boolean`	`isPrintGridlines()` Returns whether gridlines are printed.
`boolean`	`isPrintRowAndColumnHeadings()` Returns whether row and column headings are printed.
`boolean`	`isRightToLeft()` Whether the text is displayed in right-to-left mode in the window
`boolean`	`isRowBroken(int row)` Tests if there is a page break at the indicated row
`boolean`	`isScenariosLocked()`
`boolean`	`isSelected()` Returns a flag indicating whether this sheet is selected.
`boolean`	`isSelectLockedCellsLocked()`
`boolean`	`isSelectUnlockedCellsLocked()`
`boolean`	`isSheetLocked()`
`boolean`	`isSortLocked()`
`java.util.Iterator<Row>`	`iterator()` Alias for `rowIterator()` to allow foreach loops
`void`	`lockAutoFilter(boolean enabled)` Enable or disable Autofilters locking.
`void`	`lockDeleteColumns(boolean enabled)` Enable or disable Deleting columns locking.
`void`	`lockDeleteRows(boolean enabled)` Enable or disable Deleting rows locking.
`void`	`lockFormatCells(boolean enabled)` Enable or disable Formatting cells locking.
`void`	`lockFormatColumns(boolean enabled)` Enable or disable Formatting columns locking.
`void`	`lockFormatRows(boolean enabled)` Enable or disable Formatting rows locking.
`void`	`lockInsertColumns(boolean enabled)` Enable or disable Inserting columns locking.
`void`	`lockInsertHyperlinks(boolean enabled)` Enable or disable Inserting hyperlinks locking.
`void`	`lockInsertRows(boolean enabled)` Enable or disable Inserting rows locking.
`void`	`lockObjects(boolean enabled)` Enable or disable Objects locking.
`void`	`lockPivotTables(boolean enabled)` Enable or disable Pivot Tables locking.
`void`	`lockScenarios(boolean enabled)` Enable or disable Scenarios locking.
`void`	`lockSelectLockedCells(boolean enabled)` Enable or disable Selection of locked cells locking.
`void`	`lockSelectUnlockedCells(boolean enabled)` Enable or disable Selection of unlocked cells locking.
`void`	`lockSort(boolean enabled)` Enable or disable Sort locking.
`protected void`	`onDocumentCreate()` Initialize worksheet data when creating a new sheet.
`protected void`	`onDocumentRead()` Initialize worksheet data when reading in an exisiting file.
`void`	`protectSheet(java.lang.String password)` Enables sheet protection and sets the password for the sheet.
`protected void`	`read(java.io.InputStream is)`
`CellRange<XSSFCell>`	`removeArrayFormula(Cell cell)`
`void`	`removeColumnBreak(int column)` Removes a page break at the indicated column
`void`	`removeHyperlink(int row, int column)` Removes a hyperlink in the collection of hyperlinks on this sheet
`void`	`removeMergedRegion(int index)` Removes a merged region of cells (hence letting them free)
`void`	`removeMergedRegions(java.util.Collection<java.lang.Integer> indices)` Removes a number of merged regions of cells (hence letting them free) This method can be used to bulk-remove merged regions in a way much faster than calling removeMergedRegion() for every single merged region.
`void`	`removeRow(Row row)` Remove a row from this sheet.
`void`	`removeRowBreak(int row)` Removes the page break at the indicated row
`java.util.Iterator<Row>`	`rowIterator()`
`void`	`setActiveCell(CellAddress address)`
`void`	`setActiveCell(java.lang.String cellRef)` Deprecated. 3.14beta2 (circa 2015-12-05). Use `setActiveCell(CellAddress)` instead.
`CellRange<XSSFCell>`	`setArrayFormula(java.lang.String formula, CellRangeAddress range)`
`void`	`setAutobreaks(boolean value)` Flag indicating whether the sheet displays Automatic Page Breaks.
`XSSFAutoFilter`	`setAutoFilter(CellRangeAddress range)`
`void`	`setColumnBreak(int column)` Sets a page break at the indicated column.
`void`	`setColumnGroupCollapsed(int columnNumber, boolean collapsed)`
`void`	`setColumnHidden(int columnIndex, boolean hidden)` Get the visibility state for a given column.
`void`	`setColumnWidth(int columnIndex, int width)` Set the width (in units of 1/256th of a character width)
`void`	`setDefaultColumnStyle(int column, CellStyle style)`
`void`	`setDefaultColumnWidth(int width)` Specifies the number of characters of the maximum digit width of the normal style's font.
`void`	`setDefaultRowHeight(short height)` Set the default row height for the sheet (if the rows do not define their own height) in twips (1/20 of a point)
`void`	`setDefaultRowHeightInPoints(float height)` Sets default row height measured in point size.
`void`	`setDisplayFormulas(boolean show)` Sets the flag indicating whether this sheet should display formulas.
`void`	`setDisplayGridlines(boolean show)` Sets the flag indicating whether this sheet should display the lines between rows and columns to make editing and reading easier.
`void`	`setDisplayGuts(boolean value)` Set whether to display the guts or not
`void`	`setDisplayRowColHeadings(boolean show)` Sets the flag indicating whether this sheet should display row and column headings.
`void`	`setDisplayZeros(boolean value)` Set whether the window should show 0 (zero) in cells containing zero value.
`void`	`setFitToPage(boolean b)` Flag indicating whether the Fit to Page print option is enabled.
`void`	`setForceFormulaRecalculation(boolean value)` Control if Excel should be asked to recalculate all formulas on this sheet when the workbook is opened.
`void`	`setHorizontallyCenter(boolean value)` Center on page horizontally when printing.
`void`	`setMargin(short margin, double size)` Sets the size of the margin in inches.
`void`	`setPrintGridlines(boolean value)` Turns on or off the printing of gridlines.
`void`	`setPrintRowAndColumnHeadings(boolean value)` Turns on or off the printing of row and column headings.
`void`	`setRepeatingColumns(CellRangeAddress columnRangeRef)`
`void`	`setRepeatingRows(CellRangeAddress rowRangeRef)`
`void`	`setRightToLeft(boolean value)` Sets whether the worksheet is displayed from right to left instead of from left to right.
`void`	`setRowBreak(int row)` Sets a page break at the indicated row Breaks occur above the specified row and left of the specified column inclusive.
`void`	`setRowGroupCollapsed(int rowIndex, boolean collapse)` group the row It is possible for collapsed to be false and yet still have the rows in question hidden.
`void`	`setRowSumsBelow(boolean value)` Flag indicating whether summary rows appear below detail in an outline, when applying an outline.
`void`	`setRowSumsRight(boolean value)` Flag indicating whether summary columns appear to the right of detail in an outline, when applying an outline.
`void`	`setSelected(boolean value)` Sets a flag indicating whether this sheet is selected.
`void`	`setSheetPassword(java.lang.String password, HashAlgorithm hashAlgo)` Sets the sheet password.
`void`	`setTabColor(int colorIndex)` Deprecated. 3.15-beta2. Removed in 3.17. Use `setTabColor(XSSFColor)`.
`void`	`setTabColor(XSSFColor color)` Set background color of the sheet tab
`void`	`setVerticallyCenter(boolean value)` Whether the output is vertically centered on the page.
`void`	`setZoom(int scale)` Window zoom magnification for current view representing percent values.
`void`	`setZoom(int numerator, int denominator)` Deprecated. 2015-11-23 (circa POI 3.14beta1). Use `setZoom(int)` instead.
`void`	`shiftRows(int startRow, int endRow, int n)` Shifts rows between startRow and endRow n number of rows.
`void`	`shiftRows(int startRow, int endRow, int n, boolean copyRowHeight, boolean resetOriginalRowHeight)` Shifts rows between startRow and endRow n number of rows.
`void`	`showInPane(int toprow, int leftcol)` Location of the top left visible cell Location of the top left visible cell in the bottom right pane (when in Left-to-Right mode).
`void`	`ungroupColumn(int fromColumn, int toColumn)`
`void`	`ungroupRow(int fromRow, int toRow)` Ungroup a range of rows that were previously groupped
`void`	`validateMergedRegions()` Verify that merged regions do not intersect multi-cell array formulas and no merged regions intersect another merged region in this sheet.
`boolean`	`validateSheetPassword(java.lang.String password)` Validate the password against the stored hash, the hashing method will be determined by the existing password attributes
`protected void`	`write(java.io.OutputStream out)`

Methods inherited from class org.apache.poi.POIXMLDocumentPart
`_invokeOnDocumentRead, addRelation, addRelation, createRelationship, createRelationship, createRelationship, getPackagePart, getPackageRelationship, getParent, getRelationById, getRelationId, getRelationParts, getRelations, getTargetPart, onDocumentRemove, onSave, prepareForCommit, read, rebase, removeRelation, removeRelation, toString`

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait`

Field Detail

TWIPS_PER_POINT

public static final int TWIPS_PER_POINT

See Also:: Constant Field Values

sheet

protected org.openxmlformats.schemas.spreadsheetml.x2006.main.CTSheet sheet

worksheet

protected org.openxmlformats.schemas.spreadsheetml.x2006.main.CTWorksheet worksheet

Constructor Detail

XSSFSheet

protected XSSFSheet()

Creates new XSSFSheet - called by XSSFWorkbook to create a sheet from scratch.

See Also:: XSSFWorkbook.createSheet()

XSSFSheet

protected XSSFSheet(PackagePart part)

Creates an XSSFSheet representing the given package part and relationship. Should only be called by XSSFWorkbook when reading in an existing file.

Parameters:: part - - The package part that holds xml data representing this sheet.
Since:: POI 3.14-Beta1

XSSFSheet

@Deprecated
protected XSSFSheet(PackagePart part,
                               PackageRelationship rel)

Deprecated. in POI 3.14, scheduled for removal in POI 3.16

Method Detail

getWorkbook

public XSSFWorkbook getWorkbook()

Returns the parent XSSFWorkbook

Specified by:: getWorkbook in interface Sheet

Returns:: the parent XSSFWorkbook

onDocumentRead

protected void onDocumentRead()

Initialize worksheet data when reading in an exisiting file.

Overrides:: onDocumentRead in class POIXMLDocumentPart

read

protected void read(java.io.InputStream is)
             throws java.io.IOException

Throws:: java.io.IOException

onDocumentCreate

protected void onDocumentCreate()

Initialize worksheet data when creating a new sheet.

Overrides:: onDocumentCreate in class POIXMLDocumentPart

getCTWorksheet

@Internal
public org.openxmlformats.schemas.spreadsheetml.x2006.main.CTWorksheet getCTWorksheet()

Provide access to the CTWorksheet bean holding this sheet's data

Returns:: the CTWorksheet bean holding this sheet's data

getColumnHelper

public ColumnHelper getColumnHelper()

getSheetName

public java.lang.String getSheetName()

Returns the name of this sheet

Specified by:: getSheetName in interface Sheet

Returns:: the name of this sheet

addMergedRegion

public int addMergedRegion(CellRangeAddress region)

Adds a merged region of cells on a sheet.

Specified by:: addMergedRegion in interface Sheet

Parameters:: region - to merge
Returns:: index of this region
Throws:: java.lang.IllegalArgumentException - if region contains fewer than 2 cells; java.lang.IllegalStateException - if region intersects with a multi-cell array formula; java.lang.IllegalStateException - if region intersects with an existing region on this sheet

addMergedRegionUnsafe

public int addMergedRegionUnsafe(CellRangeAddress region)

Adds a merged region of cells (hence those cells form one). Skips validation. It is possible to create overlapping merged regions or create a merged region that intersects a multi-cell array formula with this formula, which may result in a corrupt workbook. To check for merged regions overlapping array formulas or other merged regions after addMergedRegionUnsafe has been called, call validateMergedRegions(), which runs in O(n^2) time.

Specified by:: addMergedRegionUnsafe in interface Sheet

Parameters:: region - to merge
Returns:: index of this region
Throws:: java.lang.IllegalArgumentException - if region contains fewer than 2 cells

validateMergedRegions

public void validateMergedRegions()

Verify that merged regions do not intersect multi-cell array formulas and no merged regions intersect another merged region in this sheet.

Specified by:: validateMergedRegions in interface Sheet

Throws:: java.lang.IllegalStateException - if region intersects with a multi-cell array formula; java.lang.IllegalStateException - if at least one region intersects with another merged region in this sheet

autoSizeColumn

public void autoSizeColumn(int column)

Adjusts the column width to fit the contents. This process can be relatively slow on large sheets, so this should normally only be called once per column, at the end of your processing.

Specified by:: autoSizeColumn in interface Sheet

Parameters:: column - the column index

autoSizeColumn

public void autoSizeColumn(int column,
                           boolean useMergedCells)

Adjusts the column width to fit the contents.

This process can be relatively slow on large sheets, so this should normally only be called once per column, at the end of your processing.

You can specify whether the content of merged cells should be considered or ignored. Default is to ignore merged cells.

Specified by:: autoSizeColumn in interface Sheet

Parameters:: column - the column index; useMergedCells - whether to use the contents of merged cells when calculating the width of the column

getDrawingPatriarch

public XSSFDrawing getDrawingPatriarch()

Return the sheet's existing drawing, or null if there isn't yet one. Use createDrawingPatriarch() to get or create

Specified by:: getDrawingPatriarch in interface Sheet

Returns:: a SpreadsheetML drawing

createDrawingPatriarch

public XSSFDrawing createDrawingPatriarch()

Create a new SpreadsheetML drawing. If this sheet already contains a drawing - return that.

Specified by:: createDrawingPatriarch in interface Sheet

Returns:: a SpreadsheetML drawing

getVMLDrawing

protected XSSFVMLDrawing getVMLDrawing(boolean autoCreate)

Get VML drawing for this sheet (aka 'legacy' drawig)

Parameters:: autoCreate - if true, then a new VML drawing part is created
Returns:: the VML drawing of null if the drawing was not found and autoCreate=false

getCTDrawing

protected org.openxmlformats.schemas.spreadsheetml.x2006.main.CTDrawing getCTDrawing()

getCTLegacyDrawing

protected org.openxmlformats.schemas.spreadsheetml.x2006.main.CTLegacyDrawing getCTLegacyDrawing()

createFreezePane

public void createFreezePane(int colSplit,
                             int rowSplit)

Creates a split (freezepane). Any existing freezepane or split pane is overwritten.

Specified by:: createFreezePane in interface Sheet

Parameters:: colSplit - Horizontal position of split.; rowSplit - Vertical position of split.

createFreezePane

public void createFreezePane(int colSplit,
                             int rowSplit,
                             int leftmostColumn,
                             int topRow)

Creates a split (freezepane). Any existing freezepane or split pane is overwritten.

If both colSplit and rowSplit are zero then the existing freeze pane is removed

Specified by:: createFreezePane in interface Sheet

Parameters:: colSplit - Horizontal position of split.; rowSplit - Vertical position of split.; leftmostColumn - Left column visible in right pane.; topRow - Top row visible in bottom pane

createRow

public XSSFRow createRow(int rownum)

Create a new row within the sheet and return the high level representation Note: If a row already exists at this position, it is removed/overwritten and any existing cell is removed!

Specified by:: createRow in interface Sheet

Parameters:: rownum - row number
Returns:: High level XSSFRow object representing a row in the sheet
See Also:: removeRow(org.apache.poi.ss.usermodel.Row)

createSplitPane

public void createSplitPane(int xSplitPos,
                            int ySplitPos,
                            int leftmostColumn,
                            int topRow,
                            int activePane)

Creates a split pane. Any existing freezepane or split pane is overwritten.

Specified by:: createSplitPane in interface Sheet

Parameters:: xSplitPos - Horizontal position of split (in 1/20th of a point).; ySplitPos - Vertical position of split (in 1/20th of a point).; topRow - Top row visible in bottom pane; leftmostColumn - Left column visible in right pane.; activePane - Active pane. One of: PANE_LOWER_RIGHT, PANE_UPPER_RIGHT, PANE_LOWER_LEFT, PANE_UPPER_LEFT
See Also:: Sheet.PANE_LOWER_LEFT, Sheet.PANE_LOWER_RIGHT, Sheet.PANE_UPPER_LEFT, Sheet.PANE_UPPER_RIGHT

getCellComment

public XSSFComment getCellComment(int row,
                                  int column)

Deprecated. as of 2015-11-23 (circa POI 3.14beta1). Use getCellComment(CellAddress) instead.

Return cell comment at row, column, if one exists. Otherwise returns null.

Specified by:: getCellComment in interface Sheet

Parameters:: row - the row where the comment is located; column - the column where the comment is located
Returns:: the cell comment, if one exists. Otherwise return null.

getCellComment

public XSSFComment getCellComment(CellAddress address)

Return cell comment at row, column, if one exists. Otherwise returns null.

Specified by:: getCellComment in interface Sheet

Parameters:: address - the location of the cell comment
Returns:: the cell comment, if one exists. Otherwise return null.

getCellComments

public java.util.Map<CellAddress,XSSFComment> getCellComments()

Returns all cell comments on this sheet.

Specified by:: getCellComments in interface Sheet

Returns:: A map of each Comment in the sheet, keyed on the cell address where the comment is located.

getHyperlink

public XSSFHyperlink getHyperlink(int row,
                                  int column)

Get a Hyperlink in this sheet anchored at row, column

Specified by:: getHyperlink in interface Sheet

Parameters:: row -; column -
Returns:: hyperlink if there is a hyperlink anchored at row, column; otherwise returns null

getHyperlinkList

public java.util.List<XSSFHyperlink> getHyperlinkList()

Get a list of Hyperlinks in this sheet

Specified by:: getHyperlinkList in interface Sheet

Returns:: Hyperlinks for the sheet

getColumnBreaks

public int[] getColumnBreaks()

Vertical page break information used for print layout view, page layout view, drawing print breaks in normal view, and for printing the worksheet.

Specified by:: getColumnBreaks in interface Sheet

Returns:: column indexes of all the vertical page breaks, never null

getColumnWidth

public int getColumnWidth(int columnIndex)

Get the actual column width (in units of 1/256th of a character width )

Note, the returned value is always gerater that getDefaultColumnWidth() because the latter does not include margins. Actual column width measured as the number of characters of the maximum digit width of the numbers 0, 1, 2, ..., 9 as rendered in the normal style's font. There are 4 pixels of margin padding (two on each side), plus 1 pixel padding for the gridlines.

Specified by:: getColumnWidth in interface Sheet

Parameters:: columnIndex - - the column to set (0-based)
Returns:: width - the width in units of 1/256th of a character width

getColumnWidthInPixels

public float getColumnWidthInPixels(int columnIndex)

Get the actual column width in pixels

Please note, that this method works correctly only for workbooks with the default font size (Calibri 11pt for .xlsx).

Specified by:: getColumnWidthInPixels in interface Sheet

getDefaultColumnWidth

public int getDefaultColumnWidth()

Get the default column width for the sheet (if the columns do not define their own width) in characters.

Note, this value is different from getColumnWidth(int). The latter is always greater and includes 4 pixels of margin padding (two on each side), plus 1 pixel padding for the gridlines.

Specified by:: getDefaultColumnWidth in interface Sheet

Returns:: column width, default value is 8

getDefaultRowHeight

public short getDefaultRowHeight()

Get the default row height for the sheet (if the rows do not define their own height) in twips (1/20 of a point)

Specified by:: getDefaultRowHeight in interface Sheet

Returns:: default row height

getDefaultRowHeightInPoints

public float getDefaultRowHeightInPoints()

Get the default row height for the sheet measued in point size (if the rows do not define their own height).

Specified by:: getDefaultRowHeightInPoints in interface Sheet

Returns:: default row height in points

getColumnStyle

public CellStyle getColumnStyle(int column)

Returns the CellStyle that applies to the given (0 based) column, or null if no style has been set for that column

Specified by:: getColumnStyle in interface Sheet

setRightToLeft

public void setRightToLeft(boolean value)

Sets whether the worksheet is displayed from right to left instead of from left to right.

Specified by:: setRightToLeft in interface Sheet

Parameters:: value - true for right to left, false otherwise.

isRightToLeft

public boolean isRightToLeft()

Whether the text is displayed in right-to-left mode in the window

Specified by:: isRightToLeft in interface Sheet

Returns:: whether the text is displayed in right-to-left mode in the window

getDisplayGuts

public boolean getDisplayGuts()

Get whether to display the guts or not, default value is true

Specified by:: getDisplayGuts in interface Sheet

Returns:: boolean - guts or no guts

setDisplayGuts

public void setDisplayGuts(boolean value)

Set whether to display the guts or not

Specified by:: setDisplayGuts in interface Sheet

Parameters:: value - - guts or no guts

isDisplayZeros

public boolean isDisplayZeros()

Gets the flag indicating whether the window should show 0 (zero) in cells containing zero value. When false, cells with zero value appear blank instead of showing the number zero.

Specified by:: isDisplayZeros in interface Sheet

Returns:: whether all zero values on the worksheet are displayed

setDisplayZeros

public void setDisplayZeros(boolean value)

Set whether the window should show 0 (zero) in cells containing zero value. When false, cells with zero value appear blank instead of showing the number zero.

Specified by:: setDisplayZeros in interface Sheet

Parameters:: value - whether to display or hide all zero values on the worksheet

getFirstRowNum

public int getFirstRowNum()

Gets the first row on the sheet

Specified by:: getFirstRowNum in interface Sheet

Returns:: the number of the first logical row on the sheet, zero based

getFitToPage

public boolean getFitToPage()

Flag indicating whether the Fit to Page print option is enabled.

Specified by:: getFitToPage in interface Sheet

Returns:: true

getFooter

public Footer getFooter()

Returns the default footer for the sheet, creating one as needed. You may also want to look at getFirstFooter(), getOddFooter() and getEvenFooter()

Specified by:: getFooter in interface Sheet

getHeader

public Header getHeader()

Returns the default header for the sheet, creating one as needed. You may also want to look at getFirstHeader(), getOddHeader() and getEvenHeader()

Specified by:: getHeader in interface Sheet

getOddFooter

public Footer getOddFooter()

Returns the odd footer. Used on all pages unless other footers also present, when used on only odd pages.

getEvenFooter

public Footer getEvenFooter()

Returns the even footer. Not there by default, but when set, used on even pages.

getFirstFooter

public Footer getFirstFooter()

Returns the first page footer. Not there by default, but when set, used on the first page.

getOddHeader

public Header getOddHeader()

Returns the odd header. Used on all pages unless other headers also present, when used on only odd pages.

getEvenHeader

public Header getEvenHeader()

Returns the even header. Not there by default, but when set, used on even pages.

getFirstHeader

public Header getFirstHeader()

Returns the first page header. Not there by default, but when set, used on the first page.

getHorizontallyCenter

public boolean getHorizontallyCenter()

Determine whether printed output for this sheet will be horizontally centered.

Specified by:: getHorizontallyCenter in interface Sheet

getLastRowNum

public int getLastRowNum()

Specified by:: getLastRowNum in interface Sheet

getLeftCol

public short getLeftCol()

Specified by:: getLeftCol in interface Sheet

getMargin

public double getMargin(short margin)

Gets the size of the margin in inches.

Specified by:: getMargin in interface Sheet

Parameters:: margin - which margin to get
Returns:: the size of the margin
See Also:: Sheet.LeftMargin, Sheet.RightMargin, Sheet.TopMargin, Sheet.BottomMargin, Sheet.HeaderMargin, Sheet.FooterMargin

setMargin

public void setMargin(short margin,
                      double size)

Sets the size of the margin in inches.

Specified by:: setMargin in interface Sheet

Parameters:: margin - which margin to get; size - the size of the margin
See Also:: Sheet.LeftMargin, Sheet.RightMargin, Sheet.TopMargin, Sheet.BottomMargin, Sheet.HeaderMargin, Sheet.FooterMargin

getMergedRegion

public CellRangeAddress getMergedRegion(int index)

Returns the merged region at the specified index. If you want multiple regions, it is faster to call getMergedRegions() than to call this each time.

Specified by:: getMergedRegion in interface Sheet

Returns:: the merged region at the specified index

getMergedRegions

public java.util.List<CellRangeAddress> getMergedRegions()

Returns the list of merged regions. If you want multiple regions, this is faster than calling getMergedRegion(int) each time.

Specified by:: getMergedRegions in interface Sheet

Returns:: the list of merged regions

getNumMergedRegions

public int getNumMergedRegions()

Returns the number of merged regions defined in this worksheet

Specified by:: getNumMergedRegions in interface Sheet

Returns:: number of merged regions in this worksheet

getNumHyperlinks

public int getNumHyperlinks()

getPaneInformation

public PaneInformation getPaneInformation()

Returns the information regarding the currently configured pane (split or freeze).

Specified by:: getPaneInformation in interface Sheet

Returns:: null if no pane configured, or the pane information.

getPhysicalNumberOfRows

public int getPhysicalNumberOfRows()

Returns the number of physically defined rows (NOT the number of rows in the sheet)

Specified by:: getPhysicalNumberOfRows in interface Sheet

Returns:: the number of physically defined rows

getPrintSetup

public XSSFPrintSetup getPrintSetup()

Gets the print setup object.

Specified by:: getPrintSetup in interface Sheet

Returns:: The user model for the print setup object.

getProtect

public boolean getProtect()

Answer whether protection is enabled or disabled

Specified by:: getProtect in interface Sheet

Returns:: true => protection enabled; false => protection disabled

protectSheet

public void protectSheet(java.lang.String password)

Enables sheet protection and sets the password for the sheet. Also sets some attributes on the CTSheetProtection that correspond to the default values used by Excel

Specified by:: protectSheet in interface Sheet

Parameters:: password - to set for protection. Pass null to remove protection

setSheetPassword

public void setSheetPassword(java.lang.String password,
                             HashAlgorithm hashAlgo)

Sets the sheet password.

Parameters:: password - if null, the password will be removed; hashAlgo - 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)

validateSheetPassword

public boolean validateSheetPassword(java.lang.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 ...)

getRow

public XSSFRow getRow(int rownum)

Returns the logical row ( 0-based). If you ask for a row that is not defined you get a null. This is to say row 4 represents the fifth row on a sheet.

Specified by:: getRow in interface Sheet

Parameters:: rownum - row to get
Returns:: XSSFRow representing the rownumber or null if its not defined on the sheet

getRowBreaks

public int[] getRowBreaks()

Horizontal page break information used for print layout view, page layout view, drawing print breaks in normal view, and for printing the worksheet.

Specified by:: getRowBreaks in interface Sheet

Returns:: row indexes of all the horizontal page breaks, never null

getRowSumsBelow

public boolean getRowSumsBelow()

Flag indicating whether summary rows appear below detail in an outline, when applying an outline.

When true a summary row is inserted below the detailed data being summarized and a new outline level is established on that row.

When false a summary row is inserted above the detailed data being summarized and a new outline level is established on that row.

Specified by:: getRowSumsBelow in interface Sheet

Returns:: true if row summaries appear below detail in the outline

setRowSumsBelow

public void setRowSumsBelow(boolean value)

Flag indicating whether summary rows appear below detail in an outline, when applying an outline.

When true a summary row is inserted below the detailed data being summarized and a new outline level is established on that row.

When false a summary row is inserted above the detailed data being summarized and a new outline level is established on that row.

Specified by:: setRowSumsBelow in interface Sheet

Parameters:: value - true if row summaries appear below detail in the outline

getRowSumsRight

public boolean getRowSumsRight()

Flag indicating whether summary columns appear to the right of detail in an outline, when applying an outline.

When true a summary column is inserted to the right of the detailed data being summarized and a new outline level is established on that column.

When false a summary column is inserted to the left of the detailed data being summarized and a new outline level is established on that column.

Specified by:: getRowSumsRight in interface Sheet

Returns:: true if col summaries appear right of the detail in the outline

setRowSumsRight

public void setRowSumsRight(boolean value)

Flag indicating whether summary columns appear to the right of detail in an outline, when applying an outline.

When true a summary column is inserted to the right of the detailed data being summarized and a new outline level is established on that column.

When false a summary column is inserted to the left of the detailed data being summarized and a new outline level is established on that column.

Specified by:: setRowSumsRight in interface Sheet

Parameters:: value - true if col summaries appear right of the detail in the outline

getScenarioProtect

public boolean getScenarioProtect()

A flag indicating whether scenarios are locked when the sheet is protected.

Specified by:: getScenarioProtect in interface Sheet

Returns:: true => protection enabled; false => protection disabled

getTopRow

public short getTopRow()

The top row in the visible view when the sheet is first viewed after opening it in a viewer

Specified by:: getTopRow in interface Sheet

Returns:: integer indicating the rownum (0 based) of the top row

getVerticallyCenter

public boolean getVerticallyCenter()

Determine whether printed output for this sheet will be vertically centered.

Specified by:: getVerticallyCenter in interface Sheet

Returns:: whether printed output for this sheet will be vertically centered.

groupColumn

public void groupColumn(int fromColumn,
                        int toColumn)

Group between (0 based) columns

Specified by:: groupColumn in interface Sheet

groupRow

public void groupRow(int fromRow,
                     int toRow)

Tie a range of cell together so that they can be collapsed or expanded

Specified by:: groupRow in interface Sheet

Parameters:: fromRow - start row (0-based); toRow - end row (0-based)

isColumnBroken

public boolean isColumnBroken(int column)

Determines if there is a page break at the indicated column

Specified by:: isColumnBroken in interface Sheet

isColumnHidden

public boolean isColumnHidden(int columnIndex)

Get the hidden state for a given column.

Specified by:: isColumnHidden in interface Sheet

Parameters:: columnIndex - - the column to set (0-based)
Returns:: hidden - false if the column is visible

isDisplayFormulas

public boolean isDisplayFormulas()

Gets the flag indicating whether this sheet should display formulas.

Specified by:: isDisplayFormulas in interface Sheet

Returns:: true if this sheet should display formulas.

isDisplayGridlines

public boolean isDisplayGridlines()

Gets the flag indicating whether this sheet displays the lines between rows and columns to make editing and reading easier.

Specified by:: isDisplayGridlines in interface Sheet

Returns:: true if this sheet displays gridlines.
See Also:: to check if printing of gridlines is turned on or off

setDisplayGridlines

public void setDisplayGridlines(boolean show)

Sets the flag indicating whether this sheet should display the lines between rows and columns to make editing and reading easier. To turn printing of gridlines use setPrintGridlines(boolean)

Specified by:: setDisplayGridlines in interface Sheet

Parameters:: show - true if this sheet should display gridlines.
See Also:: setPrintGridlines(boolean)

isDisplayRowColHeadings

public boolean isDisplayRowColHeadings()

Gets the flag indicating whether this sheet should display row and column headings.

Row heading are the row numbers to the side of the sheet

Column heading are the letters or numbers that appear above the columns of the sheet

Specified by:: isDisplayRowColHeadings in interface Sheet

Returns:: true if this sheet should display row and column headings.

setDisplayRowColHeadings

public void setDisplayRowColHeadings(boolean show)

Sets the flag indicating whether this sheet should display row and column headings.

Row heading are the row numbers to the side of the sheet

Column heading are the letters or numbers that appear above the columns of the sheet

Specified by:: setDisplayRowColHeadings in interface Sheet

Parameters:: show - true if this sheet should display row and column headings.

isPrintGridlines

public boolean isPrintGridlines()

Returns whether gridlines are printed.

Specified by:: isPrintGridlines in interface Sheet

Returns:: whether gridlines are printed

setPrintGridlines

public void setPrintGridlines(boolean value)

Turns on or off the printing of gridlines.

Specified by:: setPrintGridlines in interface Sheet

Parameters:: value - boolean to turn on or off the printing of gridlines

isPrintRowAndColumnHeadings

public boolean isPrintRowAndColumnHeadings()

Returns whether row and column headings are printed.

Specified by:: isPrintRowAndColumnHeadings in interface Sheet

Returns:: whether row and column headings are printed

setPrintRowAndColumnHeadings

public void setPrintRowAndColumnHeadings(boolean value)

Turns on or off the printing of row and column headings.

Specified by:: setPrintRowAndColumnHeadings in interface Sheet

Parameters:: value - boolean to turn on or off the printing of row and column headings

isRowBroken

public boolean isRowBroken(int row)

Tests if there is a page break at the indicated row

Specified by:: isRowBroken in interface Sheet

Parameters:: row - index of the row to test
Returns:: true if there is a page break at the indicated row

setRowBreak

public void setRowBreak(int row)

Sets a page break at the indicated row Breaks occur above the specified row and left of the specified column inclusive. For example, sheet.setColumnBreak(2); breaks the sheet into two parts with columns A,B,C in the first and D,E,... in the second. Simuilar, sheet.setRowBreak(2); breaks the sheet into two parts with first three rows (rownum=1...3) in the first part and rows starting with rownum=4 in the second.

Specified by:: setRowBreak in interface Sheet

Parameters:: row - the row to break, inclusive

removeColumnBreak

public void removeColumnBreak(int column)

Removes a page break at the indicated column

Specified by:: removeColumnBreak in interface Sheet

removeMergedRegion

public void removeMergedRegion(int index)

Removes a merged region of cells (hence letting them free)

Specified by:: removeMergedRegion in interface Sheet

Parameters:: index - of the region to unmerge

removeMergedRegions

public void removeMergedRegions(java.util.Collection<java.lang.Integer> indices)

Removes a number of merged regions of cells (hence letting them free) This method can be used to bulk-remove merged regions in a way much faster than calling removeMergedRegion() for every single merged region.

Specified by:: removeMergedRegions in interface Sheet

Parameters:: indices - A set of the regions to unmerge

removeRow

public void removeRow(Row row)

Remove a row from this sheet. All cells contained in the row are removed as well

Specified by:: removeRow in interface Sheet

Parameters:: row - the row to remove.

removeRowBreak

public void removeRowBreak(int row)

Removes the page break at the indicated row

Specified by:: removeRowBreak in interface Sheet

setForceFormulaRecalculation

public void setForceFormulaRecalculation(boolean value)

Control if Excel should be asked to recalculate all formulas on this sheet when the workbook is opened.

Calculating the formula values with FormulaEvaluator is the recommended solution, but this may be used for certain cases where evaluation in POI is not possible.

It is recommended to force recalcuation of formulas on workbook level using Workbook.setForceFormulaRecalculation(boolean) to ensure that all cross-worksheet formuals and external dependencies are updated.

Specified by:: setForceFormulaRecalculation in interface Sheet

Parameters:: value - true if the application will perform a full recalculation of this worksheet values when the workbook is opened
See Also:: Workbook.setForceFormulaRecalculation(boolean)

getForceFormulaRecalculation

public boolean getForceFormulaRecalculation()

Whether Excel will be asked to recalculate all formulas when the workbook is opened.

Specified by:: getForceFormulaRecalculation in interface Sheet

rowIterator

public java.util.Iterator<Row> rowIterator()

Specified by:: rowIterator in interface Sheet

Returns:: an iterator of the PHYSICAL rows. Meaning the 3rd element may not be the third row if say for instance the second row is undefined. Call getRowNum() on each row if you care which one it is.

iterator

public java.util.Iterator<Row> iterator()

Alias for rowIterator() to allow foreach loops

Specified by:: iterator in interface java.lang.Iterable<Row>

getAutobreaks

public boolean getAutobreaks()

Flag indicating whether the sheet displays Automatic Page Breaks.

Specified by:: getAutobreaks in interface Sheet

Returns:: true if the sheet displays Automatic Page Breaks.

setAutobreaks

public void setAutobreaks(boolean value)

Flag indicating whether the sheet displays Automatic Page Breaks.

Specified by:: setAutobreaks in interface Sheet

Parameters:: value - true if the sheet displays Automatic Page Breaks.

setColumnBreak

public void setColumnBreak(int column)

Sets a page break at the indicated column. Breaks occur above the specified row and left of the specified column inclusive. For example, sheet.setColumnBreak(2); breaks the sheet into two parts with columns A,B,C in the first and D,E,... in the second. Simuilar, sheet.setRowBreak(2); breaks the sheet into two parts with first three rows (rownum=1...3) in the first part and rows starting with rownum=4 in the second.

Specified by:: setColumnBreak in interface Sheet

Parameters:: column - the column to break, inclusive

setColumnGroupCollapsed

public void setColumnGroupCollapsed(int columnNumber,
                                    boolean collapsed)

Specified by:: setColumnGroupCollapsed in interface Sheet

setColumnHidden

public void setColumnHidden(int columnIndex,
                            boolean hidden)

Get the visibility state for a given column.

Specified by:: setColumnHidden in interface Sheet

Parameters:: columnIndex - - the column to get (0-based); hidden - - the visiblity state of the column

setColumnWidth

public void setColumnWidth(int columnIndex,
                           int width)

Set the width (in units of 1/256th of a character width)

The maximum column width for an individual cell is 255 characters. This value represents the number of characters that can be displayed in a cell that is formatted with the standard font (first font in the workbook).

Character width is defined as the maximum digit width of the numbers 0, 1, 2, ... 9 as rendered using the default font (first font in the workbook).
Unless you are using a very special font, the default character is '0' (zero), this is true for Arial (default font font in HSSF) and Calibri (default font in XSSF)

Please note, that the width set by this method includes 4 pixels of margin padding (two on each side), plus 1 pixel padding for the gridlines (Section 3.3.1.12 of the OOXML spec). This results is a slightly less value of visible characters than passed to this method (approx. 1/2 of a character).

To compute the actual number of visible characters, Excel uses the following formula (Section 3.3.1.12 of the OOXML spec):


     width = Truncate([{Number of Visible Characters} *
      {Maximum Digit Width} + {5 pixel padding}]/{Maximum Digit Width}*256)/256

Using the Calibri font as an example, the maximum digit width of 11 point font size is 7 pixels (at 96 dpi). If you set a column width to be eight characters wide, e.g. setColumnWidth(columnIndex, 8*256), then the actual value of visible characters (the value shown in Excel) is derived from the following equation: Truncate([numChars*7+5]/7*256)/256 = 8; which gives 7.29.

Specified by:: setColumnWidth in interface Sheet

Parameters:: columnIndex - - the column to set (0-based); width - - the width in units of 1/256th of a character width
Throws:: java.lang.IllegalArgumentException - if width > 255*256 (the maximum column width in Excel is 255 characters)

setDefaultColumnStyle

public void setDefaultColumnStyle(int column,
                                  CellStyle style)

Specified by:: setDefaultColumnStyle in interface Sheet

setDefaultColumnWidth

public void setDefaultColumnWidth(int width)

Specifies the number of characters of the maximum digit width of the normal style's font. This value does not include margin padding or extra padding for gridlines. It is only the number of characters.

Specified by:: setDefaultColumnWidth in interface Sheet

Parameters:: width - the number of characters. Default value is 8.

setDefaultRowHeight

public void setDefaultRowHeight(short height)

Set the default row height for the sheet (if the rows do not define their own height) in twips (1/20 of a point)

Specified by:: setDefaultRowHeight in interface Sheet

Parameters:: height - default row height in twips (1/20 of a point)

setDefaultRowHeightInPoints

public void setDefaultRowHeightInPoints(float height)

Sets default row height measured in point size.

Specified by:: setDefaultRowHeightInPoints in interface Sheet

Parameters:: height - default row height measured in point size.

setDisplayFormulas

public void setDisplayFormulas(boolean show)

Sets the flag indicating whether this sheet should display formulas.

Specified by:: setDisplayFormulas in interface Sheet

Parameters:: show - true if this sheet should display formulas.

setFitToPage

public void setFitToPage(boolean b)

Flag indicating whether the Fit to Page print option is enabled.

Specified by:: setFitToPage in interface Sheet

Parameters:: b - true if the Fit to Page print option is enabled.

setHorizontallyCenter

public void setHorizontallyCenter(boolean value)

Center on page horizontally when printing.

Specified by:: setHorizontallyCenter in interface Sheet

Parameters:: value - whether to center on page horizontally when printing.

setVerticallyCenter

public void setVerticallyCenter(boolean value)

Whether the output is vertically centered on the page.

Specified by:: setVerticallyCenter in interface Sheet

Parameters:: value - true to vertically center, false otherwise.

setRowGroupCollapsed

public void setRowGroupCollapsed(int rowIndex,
                                 boolean collapse)

group the row It is possible for collapsed to be false and yet still have the rows in question hidden. This can be achieved by having a lower outline level collapsed, thus hiding all the child rows. Note that in this case, if the lowest level were expanded, the middle level would remain collapsed.

Specified by:: setRowGroupCollapsed in interface Sheet

Parameters:: rowIndex - - the row involved, 0 based; collapse - - boolean value for collapse

findEndOfRowOutlineGroup

public int findEndOfRowOutlineGroup(int row)

Parameters:: row - the zero based row index to find from

setZoom

public void setZoom(int numerator,
                    int denominator)

Deprecated. 2015-11-23 (circa POI 3.14beta1). Use setZoom(int) instead.

Sets the zoom magnification for the sheet. The zoom is expressed as a fraction. For example to express a zoom of 75% use 3 for the numerator and 4 for the denominator.

Specified by:: setZoom in interface Sheet

Parameters:: numerator - The numerator for the zoom magnification.; denominator - The denominator for the zoom magnification.

setZoom

public void setZoom(int scale)

Window zoom magnification for current view representing percent values. Valid values range from 10 to 400. Horizontal & Vertical scale together. For example:

 10 - 10%
 20 - 20%
 ...
 100 - 100%
 ...
 400 - 400%

Current view can be Normal, Page Layout, or Page Break Preview.

Specified by:: setZoom in interface Sheet

Parameters:: scale - window zoom magnification
Throws:: java.lang.IllegalArgumentException - if scale is invalid

copyRows

@Beta
public void copyRows(java.util.List<? extends Row> srcRows,
                          int destStartRow,
                          CellCopyPolicy policy)

copyRows rows from srcRows to this sheet starting at destStartRow Additionally copies merged regions that are completely defined in these rows (ie. merged 2 cells on a row to be shifted).

Parameters:: srcRows - the rows to copy. Formulas will be offset by the difference in the row number of the first row in srcRows and destStartRow (even if srcRows are from a different sheet).; destStartRow - the row in this sheet to paste the first row of srcRows the remainder of srcRows will be pasted below destStartRow per the cell copy policy; policy - is the cell copy policy, which can be used to merge the source and destination when the source is blank, copy styles only, paste as value, etc

copyRows

@Beta
public void copyRows(int srcStartRow,
                          int srcEndRow,
                          int destStartRow,
                          CellCopyPolicy cellCopyPolicy)

Copies rows between srcStartRow and srcEndRow to the same sheet, starting at destStartRow Convenience function for copyRows(List, int, CellCopyPolicy) Equivalent to copyRows(getRows(srcStartRow, srcEndRow, false), destStartRow, cellCopyPolicy)

Parameters:: srcStartRow - the index of the first row to copy the cells from in this sheet; srcEndRow - the index of the last row to copy the cells from in this sheet; destStartRow - the index of the first row to copy the cells to in this sheet; cellCopyPolicy - the policy to use to determine how cells are copied

shiftRows

public void shiftRows(int startRow,
                      int endRow,
                      int n)

Shifts rows between startRow and endRow n number of rows. If you use a negative number, it will shift rows up. Code ensures that rows don't wrap around. Calls shiftRows(startRow, endRow, n, false, false);

Additionally shifts merged regions that are completely defined in these rows (ie. merged 2 cells on a row to be shifted).

Specified by:: shiftRows in interface Sheet

Parameters:: startRow - the row to start shifting; endRow - the row to end shifting; n - the number of rows to shift

shiftRows

public void shiftRows(int startRow,
                      int endRow,
                      int n,
                      boolean copyRowHeight,
                      boolean resetOriginalRowHeight)

Shifts rows between startRow and endRow n number of rows. If you use a negative number, it will shift rows up. Code ensures that rows don't wrap around

Additionally shifts merged regions that are completely defined in these rows (ie. merged 2 cells on a row to be shifted).

Specified by:: shiftRows in interface Sheet

Parameters:: startRow - the row to start shifting; endRow - the row to end shifting; n - the number of rows to shift; copyRowHeight - whether to copy the row height during the shift; resetOriginalRowHeight - whether to set the original row's height to the default

showInPane

public void showInPane(int toprow,
                       int leftcol)

Location of the top left visible cell Location of the top left visible cell in the bottom right pane (when in Left-to-Right mode).

Specified by:: showInPane in interface Sheet

Parameters:: toprow - the top row to show in desktop window pane; leftcol - the left column to show in desktop window pane

ungroupColumn

public void ungroupColumn(int fromColumn,
                          int toColumn)

Specified by:: ungroupColumn in interface Sheet

ungroupRow

public void ungroupRow(int fromRow,
                       int toRow)

Ungroup a range of rows that were previously groupped

Specified by:: ungroupRow in interface Sheet

Parameters:: fromRow - start row (0-based); toRow - end row (0-based)

isSelected

public boolean isSelected()

Returns a flag indicating whether this sheet is selected.

When only 1 sheet is selected and active, this value should be in synch with the activeTab value. In case of a conflict, the Start Part setting wins and sets the active sheet tab.

Note: multiple sheets can be selected, but only one sheet can be active at one time.

Specified by:: isSelected in interface Sheet

Returns:: true if this sheet is selected

setSelected

public void setSelected(boolean value)

Sets a flag indicating whether this sheet is selected.

When only 1 sheet is selected and active, this value should be in synch with the activeTab value. In case of a conflict, the Start Part setting wins and sets the active sheet tab.

Note: multiple sheets can be selected, but only one sheet can be active at one time.

Specified by:: setSelected in interface Sheet

Parameters:: value - true if this sheet is selected

addHyperlink

@Internal
public void addHyperlink(XSSFHyperlink hyperlink)

Parameters:: hyperlink - the link to add

removeHyperlink

@Internal
public void removeHyperlink(int row,
                                     int column)

Removes a hyperlink in the collection of hyperlinks on this sheet

Parameters:: row - row index; column - column index

getActiveCell

public CellAddress getActiveCell()

Return location of the active cell, e.g. A1.

Specified by:: getActiveCell in interface Sheet

Returns:: the location of the active cell.

setActiveCell

public void setActiveCell(java.lang.String cellRef)

Deprecated. 3.14beta2 (circa 2015-12-05). Use setActiveCell(CellAddress) instead.

Sets location of the active cell

Parameters:: cellRef - the location of the active cell, e.g. A1..

setActiveCell

public void setActiveCell(CellAddress address)

Specified by:: setActiveCell in interface Sheet

hasComments

public boolean hasComments()

Does this sheet have any comments on it? We need to know, so we can decide about writing it to disk or not

getNumberOfComments

protected int getNumberOfComments()

getCommentsTable

protected CommentsTable getCommentsTable(boolean create)

Returns the sheet's comments object if there is one, or null if not

Parameters:: create - create a new comments table if it does not exist

getSharedFormula

@Internal
public org.openxmlformats.schemas.spreadsheetml.x2006.main.CTCellFormula getSharedFormula(int sid)

Return a master shared formula by index

Parameters:: sid - shared group index
Returns:: a CTCellFormula bean holding shared formula or null if not found

commit

protected void commit()
               throws java.io.IOException

Description copied from class: POIXMLDocumentPart

Save 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();
   OutputStream out = part.getOutputStream();
   XmlObject bean = getXmlBean(); //the "model" which holds changes in memory
   bean.save(out, DEFAULT_XML_OPTIONS);
   out.close();
 }

Overrides:: commit in class POIXMLDocumentPart

Throws:: java.io.IOException - a subclass may throw an IOException if the changes can't be committed

write

protected void write(java.io.OutputStream out)
              throws java.io.IOException

Throws:: java.io.IOException

isAutoFilterLocked

public boolean isAutoFilterLocked()

Returns:: true when Autofilters are locked and the sheet is protected.

isDeleteColumnsLocked

public boolean isDeleteColumnsLocked()

Returns:: true when Deleting columns is locked and the sheet is protected.

isDeleteRowsLocked

public boolean isDeleteRowsLocked()

Returns:: true when Deleting rows is locked and the sheet is protected.

isFormatCellsLocked

public boolean isFormatCellsLocked()

Returns:: true when Formatting cells is locked and the sheet is protected.

isFormatColumnsLocked

public boolean isFormatColumnsLocked()

Returns:: true when Formatting columns is locked and the sheet is protected.

isFormatRowsLocked

public boolean isFormatRowsLocked()

Returns:: true when Formatting rows is locked and the sheet is protected.

isInsertColumnsLocked

public boolean isInsertColumnsLocked()

Returns:: true when Inserting columns is locked and the sheet is protected.

isInsertHyperlinksLocked

public boolean isInsertHyperlinksLocked()

Returns:: true when Inserting hyperlinks is locked and the sheet is protected.

isInsertRowsLocked

public boolean isInsertRowsLocked()

Returns:: true when Inserting rows is locked and the sheet is protected.

isPivotTablesLocked

public boolean isPivotTablesLocked()

Returns:: true when Pivot tables are locked and the sheet is protected.

isSortLocked

public boolean isSortLocked()

Returns:: true when Sorting is locked and the sheet is protected.

isObjectsLocked

public boolean isObjectsLocked()

Returns:: true when Objects are locked and the sheet is protected.

isScenariosLocked

public boolean isScenariosLocked()

Returns:: true when Scenarios are locked and the sheet is protected.

isSelectLockedCellsLocked

public boolean isSelectLockedCellsLocked()

Returns:: true when Selection of locked cells is locked and the sheet is protected.

isSelectUnlockedCellsLocked

public boolean isSelectUnlockedCellsLocked()

Returns:: true when Selection of unlocked cells is locked and the sheet is protected.

isSheetLocked

public boolean isSheetLocked()

Returns:: true when Sheet is Protected.

enableLocking

public void enableLocking()

Enable sheet protection

disableLocking

public void disableLocking()

Disable sheet protection

lockAutoFilter

public void lockAutoFilter(boolean enabled)

Enable or disable Autofilters locking. This does not modify sheet protection status. To enforce this un-/locking, call disableLocking() or enableLocking()

lockDeleteColumns

public void lockDeleteColumns(boolean enabled)

Enable or disable Deleting columns locking. This does not modify sheet protection status. To enforce this un-/locking, call disableLocking() or enableLocking()

lockDeleteRows

public void lockDeleteRows(boolean enabled)

Enable or disable Deleting rows locking. This does not modify sheet protection status. To enforce this un-/locking, call disableLocking() or enableLocking()

lockFormatCells

public void lockFormatCells(boolean enabled)

Enable or disable Formatting cells locking. This does not modify sheet protection status. To enforce this un-/locking, call disableLocking() or enableLocking()

lockFormatColumns

public void lockFormatColumns(boolean enabled)

Enable or disable Formatting columns locking. This does not modify sheet protection status. To enforce this un-/locking, call disableLocking() or enableLocking()

lockFormatRows

public void lockFormatRows(boolean enabled)

Enable or disable Formatting rows locking. This does not modify sheet protection status. To enforce this un-/locking, call disableLocking() or enableLocking()

lockInsertColumns

public void lockInsertColumns(boolean enabled)

Enable or disable Inserting columns locking. This does not modify sheet protection status. To enforce this un-/locking, call disableLocking() or enableLocking()

lockInsertHyperlinks

public void lockInsertHyperlinks(boolean enabled)

Enable or disable Inserting hyperlinks locking. This does not modify sheet protection status. To enforce this un-/locking, call disableLocking() or enableLocking()

lockInsertRows

public void lockInsertRows(boolean enabled)

Enable or disable Inserting rows locking. This does not modify sheet protection status. To enforce this un-/locking, call disableLocking() or enableLocking()

lockPivotTables

public void lockPivotTables(boolean enabled)

Enable or disable Pivot Tables locking. This does not modify sheet protection status. To enforce this un-/locking, call disableLocking() or enableLocking()

lockSort

public void lockSort(boolean enabled)

Enable or disable Sort locking. This does not modify sheet protection status. To enforce this un-/locking, call disableLocking() or enableLocking()

lockObjects

public void lockObjects(boolean enabled)

Enable or disable Objects locking. This does not modify sheet protection status. To enforce this un-/locking, call disableLocking() or enableLocking()

lockScenarios

public void lockScenarios(boolean enabled)

Enable or disable Scenarios locking. This does not modify sheet protection status. To enforce this un-/locking, call disableLocking() or enableLocking()

lockSelectLockedCells

public void lockSelectLockedCells(boolean enabled)

Enable or disable Selection of locked cells locking. This does not modify sheet protection status. To enforce this un-/locking, call disableLocking() or enableLocking()

lockSelectUnlockedCells

public void lockSelectUnlockedCells(boolean enabled)

Enable or disable Selection of unlocked cells locking. This does not modify sheet protection status. To enforce this un-/locking, call disableLocking() or enableLocking()

setArrayFormula

public CellRange<XSSFCell> setArrayFormula(java.lang.String formula,
                                           CellRangeAddress range)

Specified by:: setArrayFormula in interface Sheet

removeArrayFormula

public CellRange<XSSFCell> removeArrayFormula(Cell cell)

Specified by:: removeArrayFormula in interface Sheet

getDataValidationHelper

public DataValidationHelper getDataValidationHelper()

Specified by:: getDataValidationHelper in interface Sheet

getDataValidations

public java.util.List<XSSFDataValidation> getDataValidations()

Specified by:: getDataValidations in interface Sheet

addValidationData

public void addValidationData(DataValidation dataValidation)

Specified by:: addValidationData in interface Sheet

setAutoFilter

public XSSFAutoFilter setAutoFilter(CellRangeAddress range)

Specified by:: setAutoFilter in interface Sheet

createTable

public XSSFTable createTable()

Creates a new Table, and associates it with this Sheet

getTables

public java.util.List<XSSFTable> getTables()

Returns any tables associated with this Sheet

getSheetConditionalFormatting

public XSSFSheetConditionalFormatting getSheetConditionalFormatting()

Specified by:: getSheetConditionalFormatting in interface Sheet

getTabColor

public XSSFColor getTabColor()

Get background color of the sheet tab. Returns null if no sheet tab color is set.

Returns:: the background color of the sheet tab

setTabColor

public void setTabColor(int colorIndex)

Deprecated. 3.15-beta2. Removed in 3.17. Use setTabColor(XSSFColor).

Set background color of the sheet tab

Parameters:: colorIndex - the indexed color to set, must be a constant from IndexedColors

setTabColor

public void setTabColor(XSSFColor color)

Set background color of the sheet tab

Parameters:: color - the color to set

getRepeatingRows

public CellRangeAddress getRepeatingRows()

Specified by:: getRepeatingRows in interface Sheet

getRepeatingColumns

public CellRangeAddress getRepeatingColumns()

Specified by:: getRepeatingColumns in interface Sheet

setRepeatingRows

public void setRepeatingRows(CellRangeAddress rowRangeRef)

Specified by:: setRepeatingRows in interface Sheet

setRepeatingColumns

public void setRepeatingColumns(CellRangeAddress columnRangeRef)

Specified by:: setRepeatingColumns in interface Sheet

createPivotTable

@Beta
public XSSFPivotTable createPivotTable(AreaReference source,
                                            CellReference position,
                                            Sheet sourceSheet)

Create a pivot table and set area of source, source sheet and a position for pivot table

Parameters:: source - Area from where data will be collected; position - A reference to the cell where the table will start; sourceSheet - The sheet where source will be collected from
Returns:: The pivot table

createPivotTable

@Beta
public XSSFPivotTable createPivotTable(AreaReference source,
                                            CellReference position)

Create a pivot table and set area of source and a position for pivot table

Parameters:: source - Area from where data will be collected; position - A reference to the cell where the table will start
Returns:: The pivot table

getPivotTables

@Beta
public java.util.List<XSSFPivotTable> getPivotTables()

Returns all the pivot tables for this Sheet

getColumnOutlineLevel

public int getColumnOutlineLevel(int columnIndex)

Specified by:: getColumnOutlineLevel in interface Sheet

addIgnoredErrors

public void addIgnoredErrors(CellReference cell,
                             IgnoredErrorType... ignoredErrorTypes)

Add ignored errors (usually to suppress them in the UI of a consuming application).

Parameters:: cell - Cell.; ignoredErrorTypes - Types of error to ignore there.

addIgnoredErrors

public void addIgnoredErrors(CellRangeAddress region,
                             IgnoredErrorType... ignoredErrorTypes)

Ignore errors across a range of cells.

Parameters:: region - Range of cells.; ignoredErrorTypes - Types of error to ignore there.

getIgnoredErrors

public java.util.Map<IgnoredErrorType,java.util.Set<CellRangeAddress>> getIgnoredErrors()

Returns the errors currently being ignored and the ranges where they are ignored.

Returns:: Map of error type to the range(s) where they are ignored.

Overview

Package

Class

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.apache.poi.xssf.usermodel Class XSSFSheet

TWIPS_PER_POINT

sheet

worksheet

XSSFSheet

XSSFSheet

XSSFSheet

getWorkbook

onDocumentRead

read

onDocumentCreate

getCTWorksheet

getColumnHelper

getSheetName

addMergedRegion

addMergedRegionUnsafe

validateMergedRegions

autoSizeColumn

autoSizeColumn

getDrawingPatriarch

createDrawingPatriarch

getVMLDrawing

getCTDrawing

getCTLegacyDrawing

createFreezePane

createFreezePane

createRow

createSplitPane

getCellComment

getCellComment

getCellComments

getHyperlink

getHyperlinkList

getColumnBreaks

getColumnWidth

getColumnWidthInPixels

getDefaultColumnWidth

getDefaultRowHeight

getDefaultRowHeightInPoints

getColumnStyle

setRightToLeft

isRightToLeft

getDisplayGuts

setDisplayGuts

isDisplayZeros

setDisplayZeros

getFirstRowNum

getFitToPage

getFooter

getHeader

getOddFooter

getEvenFooter

getFirstFooter

getOddHeader

getEvenHeader

getFirstHeader

getHorizontallyCenter

getLastRowNum

getLeftCol

getMargin

setMargin

getMergedRegion

getMergedRegions

getNumMergedRegions

getNumHyperlinks

getPaneInformation

getPhysicalNumberOfRows

getPrintSetup

getProtect

protectSheet

setSheetPassword

validateSheetPassword

getRow

getRowBreaks

getRowSumsBelow

setRowSumsBelow

getRowSumsRight

setRowSumsRight

getScenarioProtect

getTopRow

org.apache.poi.xssf.usermodel
Class XSSFSheet