SXSSFSheet (POI API Documentation)

java.lang.Object
- org.apache.poi.xssf.streaming.SXSSFSheet

All Implemented Interfaces:

java.lang.Iterable<Row>, Sheet

Direct Known Subclasses:

DeferredSXSSFSheet
```
public class SXSSFSheet
extends java.lang.Object
implements Sheet
```
Streaming version of XSSFSheet implementing the "BigGridDemo" strategy.

Field Summary

Fields
Modifier and Type	Field and Description
`protected org.apache.poi.xssf.streaming.AutoSizeColumnTracker`	`_autoSizeColumnTracker`
`protected SXSSFWorkbook`	`_workbook`
`protected SheetDataWriter`	`_writer`

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

Constructors
Modifier	Constructor and Description
	`SXSSFSheet(SXSSFWorkbook workbook, XSSFSheet xSheet)`
`protected`	`SXSSFSheet(SXSSFWorkbook workbook, XSSFSheet xSheet, int randomAccessWindowSize)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`addMergedRegion(CellRangeAddress region)` Adds a merged region of cells (hence those cells form one)
`int`	`addMergedRegionUnsafe(CellRangeAddress region)` Adds a merged region of cells (hence those cells form one)
`void`	`addValidationData(DataValidation dataValidation)` Creates a data validation object
`boolean`	`areAllRowsFlushed()` Are all rows flushed to disk?
`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.
`void`	`changeRowNum(SXSSFRow row, int newRowNum)`
`SXSSFDrawing`	`createDrawingPatriarch()` Creates the top-level drawing patriarch.
`void`	`createFreezePane(int colSplit, int rowSplit)` Creates a split (freezepane).
`void`	`createFreezePane(int colSplit, int rowSplit, int leftmostColumn, int topRow)` Creates a split (freezepane).
`SXSSFRow`	`createRow(int rownum)` Create a new row within the sheet and return the high level representation
`void`	`createSplitPane(int xSplitPos, int ySplitPos, int leftmostColumn, int topRow, int activePane)` Creates a split pane.
`void`	`disableLocking()` Disable sheet protection
`void`	`enableLocking()` Enable sheet protection
`void`	`flushRows()` Flush all rows to disk.
`void`	`flushRows(int remaining)` Specifies how many rows can be accessed at most via getRow().
`CellAddress`	`getActiveCell()` Return location of the active cell, e.g.
`boolean`	`getAutobreaks()` Flag indicating whether the sheet displays Automatic Page Breaks.
`XSSFComment`	`getCellComment(CellAddress ref)` Returns cell comment for the specified row and column
`java.util.Map<CellAddress,XSSFComment>`	`getCellComments()` Returns all cell comments on this sheet.
`int[]`	`getColumnBreaks()` Retrieves all the vertical page breaks
`int`	`getColumnOutlineLevel(int columnIndex)` Returns the column outline level.
`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 width (in units of 1/256th of a character width )
`float`	`getColumnWidthInPixels(int columnIndex)` Get the actual column width in pixels
`DataValidationHelper`	`getDataValidationHelper()`
`java.util.List<XSSFDataValidation>`	`getDataValidations()` Returns the list of DataValidation in the sheet.
`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 (if the rows do not define their own height) in points.
`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.
`int`	`getFirstRowNum()` Gets the first row on the sheet
`boolean`	`getFitToPage()` Flag indicating whether the Fit to Page print option is enabled.
`Footer`	`getFooter()` Gets the user model for the default document footer.
`boolean`	`getForceFormulaRecalculation()` Whether Excel will be asked to recalculate all formulas when the workbook is opened.
`Header`	`getHeader()` Gets the user model for the default document header.
`boolean`	`getHorizontallyCenter()` Determine whether printed output for this sheet will be horizontally centered.
`XSSFHyperlink`	`getHyperlink(CellAddress addr)` Get a Hyperlink in this sheet located in a cell specified by {code addr}
`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
`int`	`getLastFlushedRowNum()`
`int`	`getLastRowNum()` Gets the last row on the sheet
`short`	`getLeftCol()` The left col in the visible view when the sheet is first viewed after opening it in a viewer
`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.
`int`	`getNumMergedRegions()` Returns the number of merged regions
`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)
`PrintSetup`	`getPrintSetup()` Gets the print setup object.
`boolean`	`getProtect()` Answer whether protection is enabled or disabled
`CellRangeAddress`	`getRepeatingColumns()` Gets the repeating columns used when printing the sheet, as found in File->PageSetup->Sheet.
`CellRangeAddress`	`getRepeatingRows()` Gets the repeating rows used when printing the sheet, as found in File->PageSetup->Sheet.
`SXSSFRow`	`getRow(int rownum)` Returns the logical row (not physical) 0-based.
`int[]`	`getRowBreaks()` Retrieves all the horizontal page breaks
`int`	`getRowNum(SXSSFRow row)`
`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()` Answer whether scenario protection is enabled or disabled
`SheetConditionalFormatting`	`getSheetConditionalFormatting()` The 'Conditional Formatting' facet for this `Sheet`
`java.lang.String`	`getSheetName()` Returns the name of this sheet
`XSSFColor`	`getTabColor()`
`short`	`getTopRow()` The top row in the visible view when the sheet is first viewed after opening it in a viewer
`java.util.Set<java.lang.Integer>`	`getTrackedColumnsForAutoSizing()` Get the currently tracked columns for auto-sizing.
`boolean`	`getVerticallyCenter()` Determine whether printed output for this sheet will be vertically centered.
`SXSSFWorkbook`	`getWorkbook()` Return the parent workbook
`java.io.InputStream`	`getWorksheetXMLInputStream()`
`void`	`groupColumn(int fromColumn, int toColumn)` Create an outline for the provided column range.
`void`	`groupRow(int fromRow, int toRow)` Tie a range of rows together so that they can be collapsed or expanded
`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`	`isColumnTrackedForAutoSizing(int column)` Returns true if column is currently tracked for auto-sizing.
`boolean`	`isDisplayFormulas()` Returns if formulas are displayed
`boolean`	`isDisplayGridlines()` Returns if gridlines are displayed
`boolean`	`isDisplayRowColHeadings()` Returns if RowColHeadings are displayed.
`boolean`	`isDisplayZeros()` Gets the flag indicating whether the window should show 0 (zero) in cells containing zero value.
`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)` Determines if there is a page break at the indicated row
`boolean`	`isSelected()` Note - this is not the same as whether the sheet is focused (isActive)
`java.util.Iterator<Row>`	`iterator()`
`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.
`void`	`protectSheet(java.lang.String password)` Sets the protection enabled as well as the password
`CellRange<? extends Cell>`	`removeArrayFormula(Cell cell)` Remove a Array Formula from this sheet.
`void`	`removeColumnBreak(int column)` Removes a page break at the indicated column
`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 merged region of cells (hence letting them free)
`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()` Returns an iterator of the physical rows
`void`	`setActiveCell(CellAddress address)` Sets location of the active cell
`CellRange<? extends Cell>`	`setArrayFormula(java.lang.String formula, CellRangeAddress range)` Sets array formula to specified region for result.
`void`	`setAutobreaks(boolean value)` Flag indicating whether the sheet displays Automatic Page Breaks.
`AutoFilter`	`setAutoFilter(CellRangeAddress range)` Enable filtering for a range of cells
`void`	`setColumnBreak(int column)` Sets a page break at the indicated column
`void`	`setColumnGroupCollapsed(int columnNumber, boolean collapsed)` Expands or collapses a column group.
`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)` Sets the default column style for a given column.
`void`	`setDefaultColumnWidth(int width)` Set the default column width for the sheet (if the columns do not define their own width) in characters
`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)` Set the default row height for the sheet (if the rows do not define their own height) in points
`void`	`setDisplayFormulas(boolean show)` Sets whether the formulas are shown in a viewer
`void`	`setDisplayGridlines(boolean show)` Sets whether the gridlines are shown in a viewer
`void`	`setDisplayGuts(boolean value)` Set whether to display the guts or not
`void`	`setDisplayRowColHeadings(boolean show)` Sets whether the RowColHeadings are shown in a viewer
`void`	`setDisplayZeros(boolean value)` Set whether the window should show 0 (zero) in cells containing zero value.
`void`	`setFitToPage(boolean value)` 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 when the workbook is opened, via the "sheetCalcPr fullCalcOnLoad" option.
`void`	`setHorizontallyCenter(boolean value)` Determines whether the output is horizontally centered on the page.
`void`	`setMargin(short margin, double size)` Sets the size of the margin in inches.
`void`	`setPrintGridlines(boolean show)` Turns on or off the printing of gridlines.
`void`	`setPrintRowAndColumnHeadings(boolean show)` Turns on or off the printing of row and column headings.
`void`	`setRandomAccessWindowSize(int value)` Specifies how many rows can be accessed at most via getRow().
`void`	`setRepeatingColumns(CellRangeAddress columnRangeRef)` Sets the repeating columns used when printing the sheet, as found in File->PageSetup->Sheet.
`void`	`setRepeatingRows(CellRangeAddress rowRangeRef)` Sets the repeating rows used when printing the sheet, as found in File->PageSetup->Sheet.
`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
`void`	`setRowGroupCollapsed(int row, boolean collapse)` Set view state of a grouped range of rows.
`void`	`setRowOutlineLevel(int rownum, int level)` Set row groupings (like groupRow) in a stream-friendly manner
`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`	`setTabColor(int colorIndex)` Set background color of the sheet tab
`void`	`setTabColor(XSSFColor color)`
`void`	`setVerticallyCenter(boolean value)` Determines whether the output is vertically centered on the page.
`void`	`setZoom(int scale)` Window zoom magnification for current view representing percent values.
`void`	`shiftColumns(int startColumn, int endColumn, int n)` Shifts columns between startColumn and endColumn, n number of columns.
`void`	`shiftRows(int startRow, int endRow, int n)` Not implemented for SXSSFSheets Shifts rows between startRow and endRow n number of rows.
`void`	`shiftRows(int startRow, int endRow, int n, boolean copyRowHeight, boolean resetOriginalRowHeight)` Not implemented for SXSSFSheets Shifts rows between startRow and endRow n number of rows.
`void`	`showInPane(int topRow, int leftCol)` Sets desktop window pane display area, when the file is first opened in a viewer.
`void`	`trackAllColumnsForAutoSizing()` Tracks all columns in the sheet for auto-sizing.
`void`	`trackColumnForAutoSizing(int column)` Track a column in the sheet for auto-sizing.
`void`	`trackColumnsForAutoSizing(java.util.Collection<java.lang.Integer> columns)` Track several columns in the sheet for auto-sizing.
`void`	`ungroupColumn(int fromColumn, int toColumn)` Ungroup a range of columns that were previously groupped
`void`	`ungroupRow(int fromRow, int toRow)` Ungroup a range of rows that were previously groupped
`void`	`untrackAllColumnsForAutoSizing()` Untracks all columns in the sheet for auto-sizing.
`boolean`	`untrackColumnForAutoSizing(int column)` Removes a column that was previously marked for inclusion in auto-size column tracking.
`boolean`	`untrackColumnsForAutoSizing(java.util.Collection<java.lang.Integer> columns)` Untracks several columns in the sheet for auto-sizing.
`void`	`validateMergedRegions()` Verify that merged regions do not intersect multi-cell array formulas and no merged regions intersect another merged region in this sheet.

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

Methods inherited from interface java.lang.Iterable
forEach, spliterator

- Field Detail
  - _workbook
```
protected final SXSSFWorkbook _workbook
```
  - _writer
```
protected SheetDataWriter _writer
```
  - _autoSizeColumnTracker
```
protected final org.apache.poi.xssf.streaming.AutoSizeColumnTracker _autoSizeColumnTracker
```
- Constructor Detail
  - SXSSFSheet
```
protected SXSSFSheet(SXSSFWorkbook workbook,
                     XSSFSheet xSheet,
                     int randomAccessWindowSize)
```
  - SXSSFSheet
```
public SXSSFSheet(SXSSFWorkbook workbook,
                  XSSFSheet xSheet)
           throws java.io.IOException
```
    Throws:
    
    java.io.IOException
- Method Detail
  - getWorksheetXMLInputStream
```
public java.io.InputStream getWorksheetXMLInputStream()
                                               throws java.io.IOException
```
    Throws:
    
    java.io.IOException
  - iterator
```
public java.util.Iterator<Row> iterator()
```
    Specified by:
    
    iterator in interface java.lang.Iterable<Row>
  - createRow
```
public SXSSFRow createRow(int rownum)
```
    Create a new row within the sheet and return the high level representation
    
    Specified by:
    
    createRow in interface Sheet
    
    Parameters:
    
    rownum - row number
    
    Returns:
    
    high level Row object representing a row in the sheet
    
    Throws:
    
    java.lang.IllegalArgumentException - If the max. number of rows is exceeded or a rownum is provided where the row is already flushed to disk.
    
    See Also:
    
    removeRow(Row)
  - 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 - representing a row to remove.
  - getRow
```
public SXSSFRow getRow(int rownum)
```
    Returns the logical row (not physical) 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 (0-based)
    
    Returns:
    
    Row representing the rownumber or null if its not defined on the sheet
  - 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 in this sheet
  - 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 (0-based)
  - getLastRowNum
```
public int getLastRowNum()
```
    Gets the last row on the sheet
    
    Specified by:
    
    getLastRowNum in interface Sheet
    
    Returns:
    
    last row contained n this sheet (0-based)
  - 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
  - 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
  - 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.
    
    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
  - getColumnWidth
```
public int getColumnWidth(int columnIndex)
```
    get the width (in units of 1/256th of a character width )
    
    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
    
    Parameters:
    
    columnIndex - - the column to set (0-based)
    
    Returns:
    
    width in pixels
  - setDefaultColumnWidth
```
public void setDefaultColumnWidth(int width)
```
    Set the default column width for the sheet (if the columns do not define their own width) in characters
    
    Specified by:
    
    setDefaultColumnWidth in interface Sheet
    
    Parameters:
    
    width - default column width measured in characters
  - getDefaultColumnWidth
```
public int getDefaultColumnWidth()
```
    Get the default column width for the sheet (if the columns do not define their own width) in characters
    
    Specified by:
    
    getDefaultColumnWidth in interface Sheet
    
    Returns:
    
    default column width measured in characters
  - 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 measured in twips (1/20 of a point)
  - getDefaultRowHeightInPoints
```
public float getDefaultRowHeightInPoints()
```
    Get the default row height for the sheet (if the rows do not define their own height) in points.
    
    Specified by:
    
    getDefaultRowHeightInPoints in interface Sheet
    
    Returns:
    
    default row height in points
  - 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 measured in twips (1/20 of a point)
  - setDefaultRowHeightInPoints
```
public void setDefaultRowHeightInPoints(float height)
```
    Set the default row height for the sheet (if the rows do not define their own height) in points
    
    Specified by:
    
    setDefaultRowHeightInPoints in interface Sheet
    
    Parameters:
    
    height - default row height
  - 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
  - addMergedRegion
```
public int addMergedRegion(CellRangeAddress region)
```
    Adds a merged region of cells (hence those cells form one)
    
    Specified by:
    
    addMergedRegion in interface Sheet
    
    Parameters:
    
    region - (rowfrom/colfrom-rowto/colto) to merge
    
    Returns:
    
    index of this region
  - addMergedRegionUnsafe
```
public int addMergedRegionUnsafe(CellRangeAddress region)
```
    Adds a merged region of cells (hence those cells form one)
    
    Specified by:
    
    addMergedRegionUnsafe in interface Sheet
    
    Parameters:
    
    region - (rowfrom/colfrom-rowto/colto) to merge
    
    Returns:
    
    index of this region
  - 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
  - setVerticallyCenter
```
public void setVerticallyCenter(boolean value)
```
    Determines whether the output is vertically centered on the page.
    
    Specified by:
    
    setVerticallyCenter in interface Sheet
    
    Parameters:
    
    value - true to vertically center, false otherwise.
  - setHorizontallyCenter
```
public void setHorizontallyCenter(boolean value)
```
    Determines whether the output is horizontally centered on the page.
    
    Specified by:
    
    setHorizontallyCenter in interface Sheet
    
    Parameters:
    
    value - true to horizontally center, false otherwise.
  - getHorizontallyCenter
```
public boolean getHorizontallyCenter()
```
    Determine whether printed output for this sheet will be horizontally centered.
    
    Specified by:
    
    getHorizontallyCenter in interface Sheet
  - getVerticallyCenter
```
public boolean getVerticallyCenter()
```
    Determine whether printed output for this sheet will be vertically centered.
    
    Specified by:
    
    getVerticallyCenter 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 merged region of cells (hence letting them free)
    
    Specified by:
    
    removeMergedRegions in interface Sheet
    
    Parameters:
    
    indices - of the regions to unmerge
  - getNumMergedRegions
```
public int getNumMergedRegions()
```
    Returns the number of merged regions
    
    Specified by:
    
    getNumMergedRegions in interface Sheet
    
    Returns:
    
    number of merged regions
  - 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
  - rowIterator
```
public java.util.Iterator<Row> rowIterator()
```
    Returns an iterator of the physical rows
    
    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.
  - 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.
  - 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
  - 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
  - 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
  - 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
  - setFitToPage
```
public void setFitToPage(boolean value)
```
    Flag indicating whether the Fit to Page print option is enabled.
    
    Specified by:
    
    setFitToPage in interface Sheet
    
    Parameters:
    
    value - true if the Fit to Page print option is enabled.
  - 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
  - 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
  - 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.
  - 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
  - getFitToPage
```
public boolean getFitToPage()
```
    Flag indicating whether the Fit to Page print option is enabled.
    
    Specified by:
    
    getFitToPage in interface Sheet
    
    Returns:
    
    true if the Fit to Page print option is enabled.
  - 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
  - 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
  - isPrintGridlines
```
public boolean isPrintGridlines()
```
    Returns whether gridlines are printed.
    
    Specified by:
    
    isPrintGridlines in interface Sheet
    
    Returns:
    
    whether gridlines are printed
    
    See Also:
    
    to check if gridlines are displayed on screen
  - setPrintGridlines
```
public void setPrintGridlines(boolean show)
```
    Turns on or off the printing of gridlines.
    
    Specified by:
    
    setPrintGridlines in interface Sheet
    
    Parameters:
    
    show - boolean to turn on or off the printing of gridlines
    
    See Also:
    
    to display gridlines on screen
  - 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 show)
```
    Turns on or off the printing of row and column headings.
    
    Specified by:
    
    setPrintRowAndColumnHeadings in interface Sheet
    
    Parameters:
    
    show - boolean to turn on or off the printing of row and column headings
  - getPrintSetup
```
public PrintSetup getPrintSetup()
```
    Gets the print setup object.
    
    Specified by:
    
    getPrintSetup in interface Sheet
    
    Returns:
    
    The user model for the print setup object.
  - getHeader
```
public Header getHeader()
```
    Gets the user model for the default document header.
    Note that XSSF offers more kinds of document headers than HSSF does
    
    Specified by:
    
    getHeader in interface Sheet
    
    Returns:
    
    the document header. Never null
  - getFooter
```
public Footer getFooter()
```
    Gets the user model for the default document footer.
    Note that XSSF offers more kinds of document footers than HSSF does.
    
    Specified by:
    
    getFooter in interface Sheet
    
    Returns:
    
    the document footer. Never null
  - setSelected
```
public void setSelected(boolean value)
```
    Sets a flag indicating whether this sheet is selected.
    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
    
    See Also:
    
    Workbook.setActiveSheet(int)
  - 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
  - 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
  - getProtect
```
public boolean getProtect()
```
    Answer whether protection is enabled or disabled
    
    Specified by:
    
    getProtect in interface Sheet
    
    Returns:
    
    true means protection enabled; false means protection disabled
  - protectSheet
```
public void protectSheet(java.lang.String password)
```
    Sets the protection enabled as well as the password
    
    Specified by:
    
    protectSheet in interface Sheet
    
    Parameters:
    
    password - to set for protection. Pass null to remove protection
  - getScenarioProtect
```
public boolean getScenarioProtect()
```
    Answer whether scenario protection is enabled or disabled
    
    Specified by:
    
    getScenarioProtect in interface Sheet
    
    Returns:
    
    true means protection enabled; false means protection disabled
  - setZoom
```
public void setZoom(int scale)
```
    Window zoom magnification for current view representing percent values. Valid values range from 10 to 400. Horizontal and 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
  - 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:
    
    short indicating the rownum (0 based) of the top row
  - getLeftCol
```
public short getLeftCol()
```
    The left col in the visible view when the sheet is first viewed after opening it in a viewer
    
    Specified by:
    
    getLeftCol in interface Sheet
    
    Returns:
    
    short indicating the rownum (0 based) of the top row
  - showInPane
```
public void showInPane(int topRow,
                       int leftCol)
```
    Sets desktop window pane display area, when the file is first opened in a viewer.
    
    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
  - setForceFormulaRecalculation
```
public void setForceFormulaRecalculation(boolean value)
```
    Control if Excel should be asked to recalculate all formulas when the workbook is opened, via the "sheetCalcPr fullCalcOnLoad" option. 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.
    
    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
    
    Returns:
    
    true if the Sheet has the recalculate-flag set.
  - shiftRows
```
@NotImplemented
public void shiftRows(int startRow,
                                      int endRow,
                                      int n)
```
    Not implemented for SXSSFSheets 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
```
@NotImplemented
public void shiftRows(int startRow,
                                      int endRow,
                                      int n,
                                      boolean copyRowHeight,
                                      boolean resetOriginalRowHeight)
```
    Not implemented for SXSSFSheets 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). All merged regions that are completely overlaid by shifting will be deleted.
    
    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
  - createFreezePane
```
public void createFreezePane(int colSplit,
                             int rowSplit,
                             int leftmostColumn,
                             int topRow)
```
    Creates a split (freezepane). Any existing freezepane or split pane is overwritten.
    
    Specified by:
    
    createFreezePane in interface Sheet
    
    Parameters:
    
    colSplit - Horizonatal position of split.
    
    rowSplit - Vertical position of split.
    
    leftmostColumn - Left column visible in right pane.
    
    topRow - Top row visible in bottom pane
  - 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 - Horizonatal position of split.
    
    rowSplit - Vertical position of split.
  - 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 - Horizonatal 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
  - 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.
  - setDisplayGridlines
```
public void setDisplayGridlines(boolean show)
```
    Sets whether the gridlines are shown in a viewer
    
    Specified by:
    
    setDisplayGridlines in interface Sheet
    
    Parameters:
    
    show - whether to show gridlines or not
  - isDisplayGridlines
```
public boolean isDisplayGridlines()
```
    Returns if gridlines are displayed
    
    Specified by:
    
    isDisplayGridlines in interface Sheet
    
    Returns:
    
    whether gridlines are displayed
  - setDisplayFormulas
```
public void setDisplayFormulas(boolean show)
```
    Sets whether the formulas are shown in a viewer
    
    Specified by:
    
    setDisplayFormulas in interface Sheet
    
    Parameters:
    
    show - whether to show formulas or not
  - isDisplayFormulas
```
public boolean isDisplayFormulas()
```
    Returns if formulas are displayed
    
    Specified by:
    
    isDisplayFormulas in interface Sheet
    
    Returns:
    
    whether formulas are displayed
  - setDisplayRowColHeadings
```
public void setDisplayRowColHeadings(boolean show)
```
    Sets whether the RowColHeadings are shown in a viewer
    
    Specified by:
    
    setDisplayRowColHeadings in interface Sheet
    
    Parameters:
    
    show - whether to show RowColHeadings or not
  - isDisplayRowColHeadings
```
public boolean isDisplayRowColHeadings()
```
    Returns if RowColHeadings are displayed.
    
    Specified by:
    
    isDisplayRowColHeadings in interface Sheet
    
    Returns:
    
    whether RowColHeadings are displayed
  - setRowBreak
```
public void setRowBreak(int row)
```
    Sets a page break at the indicated row
    
    Specified by:
    
    setRowBreak in interface Sheet
    
    Parameters:
    
    row - FIXME: Document this!
  - isRowBroken
```
public boolean isRowBroken(int row)
```
    Determines if there is a page break at the indicated row
    
    Specified by:
    
    isRowBroken in interface Sheet
    
    Parameters:
    
    row - The row to check
    
    Returns:
    
    true if there is a page-break at the given row, false otherwise
  - removeRowBreak
```
public void removeRowBreak(int row)
```
    Removes the page break at the indicated row
    
    Specified by:
    
    removeRowBreak in interface Sheet
    
    Parameters:
    
    row - The row to remove page breaks from
  - getRowBreaks
```
public int[] getRowBreaks()
```
    Retrieves all the horizontal page breaks
    
    Specified by:
    
    getRowBreaks in interface Sheet
    
    Returns:
    
    all the horizontal page breaks, or null if there are no row page breaks
  - getColumnBreaks
```
public int[] getColumnBreaks()
```
    Retrieves all the vertical page breaks
    
    Specified by:
    
    getColumnBreaks in interface Sheet
    
    Returns:
    
    all the vertical page breaks, or null if there are no column page breaks
  - setColumnBreak
```
public void setColumnBreak(int column)
```
    Sets a page break at the indicated column
    
    Specified by:
    
    setColumnBreak in interface Sheet
    
    Parameters:
    
    column - The column to work on
  - isColumnBroken
```
public boolean isColumnBroken(int column)
```
    Determines if there is a page break at the indicated column
    
    Specified by:
    
    isColumnBroken in interface Sheet
    
    Parameters:
    
    column - The column to check for page breaks
    
    Returns:
    
    true if there is a page break at the given column, false otherwise
  - removeColumnBreak
```
public void removeColumnBreak(int column)
```
    Removes a page break at the indicated column
    
    Specified by:
    
    removeColumnBreak in interface Sheet
    
    Parameters:
    
    column - The column to remove a page break from
  - setColumnGroupCollapsed
```
public void setColumnGroupCollapsed(int columnNumber,
                                    boolean collapsed)
```
    Expands or collapses a column group.
    
    Specified by:
    
    setColumnGroupCollapsed in interface Sheet
    
    Parameters:
    
    columnNumber - One of the columns in the group.
    
    collapsed - true = collapse group, false = expand group.
  - groupColumn
```
public void groupColumn(int fromColumn,
                        int toColumn)
```
    Create an outline for the provided column range.
    
    Specified by:
    
    groupColumn in interface Sheet
    
    Parameters:
    
    fromColumn - beginning of the column range.
    
    toColumn - end of the column range.
  - ungroupColumn
```
public void ungroupColumn(int fromColumn,
                          int toColumn)
```
    Ungroup a range of columns that were previously groupped
    
    Specified by:
    
    ungroupColumn in interface Sheet
    
    Parameters:
    
    fromColumn - start column (0-based)
    
    toColumn - end column (0-based)
  - groupRow
```
public void groupRow(int fromRow,
                     int toRow)
```
    Tie a range of rows together so that they can be collapsed or expanded
    Please note the rows being grouped must be in the current window, if the rows are already flushed then groupRow has no effect.
    Correct code:
```
       Workbook wb = new SXSSFWorkbook(100);  // keep 100 rows in memory
       Sheet sh = wb.createSheet();
       for (int rownum = 0; rownum < 1000; rownum++) {
           Row row = sh.createRow(rownum);
           if(rownum == 200)  {
               sh.groupRow(100, 200);
           }
       }

      
```
    Incorrect code:
```
       Workbook wb = new SXSSFWorkbook(100);  // keep 100 rows in memory
       Sheet sh = wb.createSheet();
       for (int rownum = 0; rownum < 1000; rownum++) {
           Row row = sh.createRow(rownum);
       }
       sh.groupRow(100, 200); // the rows in the range [100, 200] are already flushed and groupRows has no effect

      
```
    Specified by:
    
    groupRow in interface Sheet
    
    Parameters:
    
    fromRow - start row (0-based)
    
    toRow - end row (0-based)
  - setRowOutlineLevel
```
public void setRowOutlineLevel(int rownum,
                               int level)
```
    Set row groupings (like groupRow) in a stream-friendly manner
    groupRows requires all rows in the group to be in the current window. This is not always practical. Instead use setRowOutlineLevel to explicitly set the group level. Level 1 is the top level group, followed by 2, etc. It is up to the user to ensure that level 2 groups are correctly nested under level 1, etc.
    
    Parameters:
    
    rownum - index of row to update (0-based)
    
    level - outline level (greater than 0)
  - 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)
  - setRowGroupCollapsed
```
public void setRowGroupCollapsed(int row,
                                 boolean collapse)
```
    Set view state of a grouped range of rows. Not implemented for expanding (i.e. collapse == false)
    
    Specified by:
    
    setRowGroupCollapsed in interface Sheet
    
    Parameters:
    
    row - start row of a groupped range of rows (0-based)
    
    collapse - whether to expand/collapse the detail rows
    
    Throws:
    
    java.lang.RuntimeException - if collapse is false as this is not implemented for SXSSF.
  - setDefaultColumnStyle
```
public void setDefaultColumnStyle(int column,
                                  CellStyle style)
```
    Sets the default column style for a given column. POI will only apply this style to new cells added to the sheet.
    
    Specified by:
    
    setDefaultColumnStyle in interface Sheet
    
    Parameters:
    
    column - the column index
    
    style - the style to set
  - trackColumnForAutoSizing
```
public void trackColumnForAutoSizing(int column)
```
    Track a column in the sheet for auto-sizing. Note this has undefined behavior if a column is tracked after one or more rows are written to the sheet. If column is already tracked, this call does nothing.
    
    Parameters:
    
    column - the column to track for auto-sizing
    
    Since:
    
    3.14beta1
    
    See Also:
    
    trackColumnsForAutoSizing(Collection), trackAllColumnsForAutoSizing()
  - trackColumnsForAutoSizing
```
public void trackColumnsForAutoSizing(java.util.Collection<java.lang.Integer> columns)
```
    Track several columns in the sheet for auto-sizing. Note this has undefined behavior if columns are tracked after one or more rows are written to the sheet. Any column in columns that are already tracked are ignored by this call.
    
    Parameters:
    
    columns - the columns to track for auto-sizing
    
    Since:
    
    3.14beta1
  - trackAllColumnsForAutoSizing
```
public void trackAllColumnsForAutoSizing()
```
    Tracks all columns in the sheet for auto-sizing. If this is called, individual columns do not need to be tracked. Because determining the best-fit width for a cell is expensive, this may affect the performance.
    
    Since:
    
    3.14beta1
  - untrackColumnForAutoSizing
```
public boolean untrackColumnForAutoSizing(int column)
```
    Removes a column that was previously marked for inclusion in auto-size column tracking. When a column is untracked, the best-fit width is forgotten. If column is not tracked, it will be ignored by this call.
    
    Parameters:
    
    column - the index of the column to track for auto-sizing
    
    Returns:
    
    true if column was tracked prior to this call, false if no action was taken
    
    Since:
    
    3.14beta1
    
    See Also:
    
    untrackColumnsForAutoSizing(Collection), untrackAllColumnsForAutoSizing()
  - untrackColumnsForAutoSizing
```
public boolean untrackColumnsForAutoSizing(java.util.Collection<java.lang.Integer> columns)
```
    Untracks several columns in the sheet for auto-sizing. When a column is untracked, the best-fit width is forgotten. Any column in columns that is not tracked will be ignored by this call.
    
    Parameters:
    
    columns - the indices of the columns to track for auto-sizing
    
    Returns:
    
    true if one or more columns were untracked as a result of this call
    
    Since:
    
    3.14beta1
  - untrackAllColumnsForAutoSizing
```
public void untrackAllColumnsForAutoSizing()
```
    Untracks all columns in the sheet for auto-sizing. Best-fit column widths are forgotten. If this is called, individual columns do not need to be untracked.
    
    Since:
    
    3.14beta1
  - isColumnTrackedForAutoSizing
```
public boolean isColumnTrackedForAutoSizing(int column)
```
    Returns true if column is currently tracked for auto-sizing.
    
    Parameters:
    
    column - the index of the column to check
    
    Returns:
    
    true if column is tracked
    
    Since:
    
    3.14beta1
  - getTrackedColumnsForAutoSizing
```
public java.util.Set<java.lang.Integer> getTrackedColumnsForAutoSizing()
```
    Get the currently tracked columns for auto-sizing. Note if all columns are tracked, this will only return the columns that have been explicitly or implicitly tracked, which is probably only columns containing 1 or more non-blank values
    
    Returns:
    
    a set of the indices of all tracked columns
    
    Since:
    
    3.14beta1
  - 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.
    You can specify whether the content of merged cells should be considered or ignored. Default is to ignore merged cells.
    Special note about SXSSF implementation: You must register the columns you wish to track with the SXSSFSheet using trackColumnForAutoSizing(int) or trackAllColumnsForAutoSizing(). This is needed because the rows needed to compute the column width may have fallen outside the random access window and been flushed to disk. Tracking columns is required even if all rows are in the random access window.
    
    New in POI 3.14 beta 1: auto-sizes columns using cells from current and flushed rows.
    
    Specified by:
    
    autoSizeColumn in interface Sheet
    
    Parameters:
    
    column - the column index to auto-size
  - 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.
    Special note about SXSSF implementation: You must register the columns you wish to track with the SXSSFSheet using trackColumnForAutoSizing(int) or trackAllColumnsForAutoSizing(). This is needed because the rows needed to compute the column width may have fallen outside the random access window and been flushed to disk. Tracking columns is required even if all rows are in the random access window.
    
    New in POI 3.14 beta 1: auto-sizes columns using cells from current and flushed rows.
    
    Specified by:
    
    autoSizeColumn in interface Sheet
    
    Parameters:
    
    column - the column index to auto-size
    
    useMergedCells - whether to use the contents of merged cells when calculating the width of the column
  - getCellComment
```
public XSSFComment getCellComment(CellAddress ref)
```
    Returns cell comment for the specified row and column
    
    Specified by:
    
    getCellComment in interface Sheet
    
    Returns:
    
    cell comment or null if not found
  - 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 - The 0-base row number
    
    column - The 0-based column number
    
    Returns:
    
    hyperlink if there is a hyperlink anchored at row, column; otherwise returns null
  - getHyperlink
```
public XSSFHyperlink getHyperlink(CellAddress addr)
```
    Get a Hyperlink in this sheet located in a cell specified by {code addr}
    
    Specified by:
    
    getHyperlink in interface Sheet
    
    Parameters:
    
    addr - The address of the cell containing the hyperlink
    
    Returns:
    
    hyperlink if there is a hyperlink anchored at addr; otherwise returns null
    
    Since:
    
    POI 3.15 beta 3
  - 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
  - getDrawingPatriarch
```
public XSSFDrawing getDrawingPatriarch()
```
    Return the sheet's existing drawing, or null if there isn't yet one. Use Sheet.createDrawingPatriarch() to get or create
    
    Specified by:
    
    getDrawingPatriarch in interface Sheet
    
    Returns:
    
    a SpreadsheetML drawing
  - createDrawingPatriarch
```
public SXSSFDrawing createDrawingPatriarch()
```
    Creates the top-level drawing patriarch.
    
    Specified by:
    
    createDrawingPatriarch in interface Sheet
    
    Returns:
    
    The new drawing patriarch.
  - getWorkbook
```
public SXSSFWorkbook getWorkbook()
```
    Return the parent workbook
    
    Specified by:
    
    getWorkbook in interface Sheet
    
    Returns:
    
    the parent workbook
  - getSheetName
```
public java.lang.String getSheetName()
```
    Returns the name of this sheet
    
    Specified by:
    
    getSheetName in interface Sheet
    
    Returns:
    
    the name of this sheet
  - isSelected
```
public boolean isSelected()
```
    Note - this is not the same as whether the sheet is focused (isActive)
    
    Specified by:
    
    isSelected in interface Sheet
    
    Returns:
    
    true if this sheet is currently selected
  - setArrayFormula
```
public CellRange<? extends Cell> setArrayFormula(java.lang.String formula,
                                                 CellRangeAddress range)
```
    Sets array formula to specified region for result.
    
    Specified by:
    
    setArrayFormula in interface Sheet
    
    Parameters:
    
    formula - text representation of the formula
    
    range - Region of array formula for result.
    
    Returns:
    
    the CellRange of cells affected by this change
  - removeArrayFormula
```
public CellRange<? extends Cell> removeArrayFormula(Cell cell)
```
    Remove a Array Formula from this sheet. All cells contained in the Array Formula range are removed as well
    
    Specified by:
    
    removeArrayFormula in interface Sheet
    
    Parameters:
    
    cell - any cell within Array Formula range
    
    Returns:
    
    the CellRange of cells affected by this change
  - getDataValidationHelper
```
public DataValidationHelper getDataValidationHelper()
```
    Specified by:
    
    getDataValidationHelper in interface Sheet
  - getDataValidations
```
public java.util.List<XSSFDataValidation> getDataValidations()
```
    Description copied from interface: Sheet
    
    Returns the list of DataValidation in the sheet.
    
    Specified by:
    
    getDataValidations in interface Sheet
    
    Returns:
    
    list of DataValidation in the sheet
  - addValidationData
```
public void addValidationData(DataValidation dataValidation)
```
    Creates a data validation object
    
    Specified by:
    
    addValidationData in interface Sheet
    
    Parameters:
    
    dataValidation - The Data validation object settings
  - setAutoFilter
```
public AutoFilter setAutoFilter(CellRangeAddress range)
```
    Enable filtering for a range of cells
    
    Specified by:
    
    setAutoFilter in interface Sheet
    
    Parameters:
    
    range - the range of cells to filter
  - getSheetConditionalFormatting
```
public SheetConditionalFormatting getSheetConditionalFormatting()
```
    Description copied from interface: Sheet
    
    The 'Conditional Formatting' facet for this Sheet
    
    Specified by:
    
    getSheetConditionalFormatting in interface Sheet
    
    Returns:
    
    conditional formatting rule for this sheet
  - getRepeatingRows
```
public CellRangeAddress getRepeatingRows()
```
    Description copied from interface: Sheet
    Gets the repeating rows used when printing the sheet, as found in File->PageSetup->Sheet.
    Repeating rows cover a range of contiguous rows, e.g.:
```
 Sheet1!$1:$1
 Sheet2!$5:$8
 
```
    The CellRangeAddress returned contains a column part which spans all columns, and a row part which specifies the contiguous range of repeating rows.
    If the Sheet does not have any repeating rows defined, null is returned.
    Specified by:
    
    getRepeatingRows in interface Sheet
    
    Returns:
    
    an CellRangeAddress containing the repeating rows for the Sheet, or null.
  - getRepeatingColumns
```
public CellRangeAddress getRepeatingColumns()
```
    Description copied from interface: Sheet
    Gets the repeating columns used when printing the sheet, as found in File->PageSetup->Sheet.
    Repeating columns cover a range of contiguous columns, e.g.:
```
 Sheet1!$A:$A
 Sheet2!$C:$F
 
```
    The CellRangeAddress returned contains a row part which spans all rows, and a column part which specifies the contiguous range of repeating columns.
    If the Sheet does not have any repeating columns defined, null is returned.
    Specified by:
    
    getRepeatingColumns in interface Sheet
    
    Returns:
    
    an CellRangeAddress containing the repeating columns for the Sheet, or null.
  - setRepeatingRows
```
public void setRepeatingRows(CellRangeAddress rowRangeRef)
```
    Description copied from interface: Sheet
    Sets the repeating rows used when printing the sheet, as found in File->PageSetup->Sheet.
    Repeating rows cover a range of contiguous rows, e.g.:
```
 Sheet1!$1:$1
 Sheet2!$5:$8
```
    The parameter CellRangeAddress should specify a column part which spans all columns, and a row part which specifies the contiguous range of repeating rows, e.g.:
```
 sheet.setRepeatingRows(CellRangeAddress.valueOf("2:3"));
```
    A null parameter value indicates that repeating rows should be removed from the Sheet:
```
 sheet.setRepeatingRows(null);
```
    Specified by:
    
    setRepeatingRows in interface Sheet
    
    Parameters:
    
    rowRangeRef - a CellRangeAddress containing the repeating rows for the Sheet, or null.
  - setRepeatingColumns
```
public void setRepeatingColumns(CellRangeAddress columnRangeRef)
```
    Description copied from interface: Sheet
    Sets the repeating columns used when printing the sheet, as found in File->PageSetup->Sheet.
    Repeating columns cover a range of contiguous columns, e.g.:
```
 Sheet1!$A:$A
 Sheet2!$C:$F
```
    The parameter CellRangeAddress should specify a row part which spans all rows, and a column part which specifies the contiguous range of repeating columns, e.g.:
```
 sheet.setRepeatingColumns(CellRangeAddress.valueOf("B:C"));
```
    A null parameter value indicates that repeating columns should be removed from the Sheet:
```
 sheet.setRepeatingColumns(null);
```
    Specified by:
    
    setRepeatingColumns in interface Sheet
    
    Parameters:
    
    columnRangeRef - a CellRangeAddress containing the repeating columns for the Sheet, or null.
  - setRandomAccessWindowSize
```
public void setRandomAccessWindowSize(int value)
```
    Specifies how many rows can be accessed at most via getRow(). When a new node is created via createRow() and the total number of unflushed records would exeed the specified value, then the row with the lowest index value is flushed and cannot be accessed via getRow() anymore. A value of -1 indicates unlimited access. In this case all records that have not been flushed by a call to flush() are available for random access. A value of 0 is not allowed because it would flush any newly created row without having a chance to specify any cells.
  - areAllRowsFlushed
```
public boolean areAllRowsFlushed()
```
    Are all rows flushed to disk?
  - getLastFlushedRowNum
```
public int getLastFlushedRowNum()
```
    Returns:
    
    Last row number to be flushed to disk, or -1 if none flushed yet
  - flushRows
```
public void flushRows(int remaining)
               throws java.io.IOException
```
    Specifies how many rows can be accessed at most via getRow(). The exeeding rows (if any) are flushed to the disk while rows with lower index values are flushed first.
    
    Throws:
    
    java.io.IOException
  - flushRows
```
public void flushRows()
               throws java.io.IOException
```
    Flush all rows to disk. After this call no rows can be accessed via getRow()
    
    Throws:
    
    java.io.IOException - If an I/O error occurs
  - changeRowNum
```
public void changeRowNum(SXSSFRow row,
                         int newRowNum)
```
  - getRowNum
```
public int getRowNum(SXSSFRow row)
```
  - getColumnOutlineLevel
```
public int getColumnOutlineLevel(int columnIndex)
```
    Description copied from interface: Sheet
    
    Returns the column outline level. Increased as you put it into more groups (outlines), reduced as you take it out of them.
    
    Specified by:
    
    getColumnOutlineLevel in interface Sheet
  - 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(CellAddress address)
```
    Sets location of the active cell
    
    Specified by:
    
    setActiveCell in interface Sheet
    
    Parameters:
    
    address - the location of the active cell, e.g. A1.
  - getTabColor
```
public XSSFColor getTabColor()
```
  - setTabColor
```
public void setTabColor(XSSFColor color)
```
  - 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()
  - setTabColor
```
public void setTabColor(int colorIndex)
```
    Set background color of the sheet tab
    
    Parameters:
    
    colorIndex - the indexed color to set, must be a constant from IndexedColors
  - shiftColumns
```
@NotImplemented
public void shiftColumns(int startColumn,
                                         int endColumn,
                                         int n)
```
    Description copied from interface: Sheet
    
    Shifts columns between startColumn and endColumn, n number of columns. If you use a negative number, it will shift columns left. Code ensures that columns don't wrap around
    
    Specified by:
    
    shiftColumns in interface Sheet
    
    Parameters:
    
    startColumn - the column to start shifting
    
    endColumn - the column to end shifting
    
    n - the number of columns to shift

Class SXSSFSheet

Field Summary

Fields inherited from interface org.apache.poi.ss.usermodel.Sheet

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface java.lang.Iterable

Field Detail

_workbook

_writer

_autoSizeColumnTracker

Constructor Detail

SXSSFSheet

SXSSFSheet

Method Detail

getWorksheetXMLInputStream

iterator

createRow

removeRow

getRow

getPhysicalNumberOfRows

getFirstRowNum

getLastRowNum

setColumnHidden

isColumnHidden

setColumnWidth

getColumnWidth

getColumnWidthInPixels

setDefaultColumnWidth

getDefaultColumnWidth

getDefaultRowHeight

getDefaultRowHeightInPoints

setDefaultRowHeight

setDefaultRowHeightInPoints

getColumnStyle

addMergedRegion

addMergedRegionUnsafe

validateMergedRegions

setVerticallyCenter

setHorizontallyCenter

getHorizontallyCenter

getVerticallyCenter

removeMergedRegion

removeMergedRegions

getNumMergedRegions

getMergedRegion

getMergedRegions

rowIterator

setAutobreaks

setDisplayGuts

setDisplayZeros

isDisplayZeros

setRightToLeft

isRightToLeft

setFitToPage

setRowSumsBelow

setRowSumsRight

getAutobreaks

getDisplayGuts

getFitToPage

getRowSumsBelow

getRowSumsRight

isPrintGridlines

setPrintGridlines

isPrintRowAndColumnHeadings

setPrintRowAndColumnHeadings

getPrintSetup

getHeader

getFooter

setSelected

getMargin

setMargin

getProtect

protectSheet

getScenarioProtect

setZoom

getTopRow

getLeftCol

showInPane

setForceFormulaRecalculation