/* ====================================================================
Licensed to the Apache Software Foundation (ASF) under one or more
contributor license agreements. See the NOTICE file distributed with
this work for additional information regarding copyright ownership.
The ASF licenses this file to You under the Apache License, Version 2.0
(the "License"); you may not use this file except in compliance with
the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
==================================================================== */
package org.apache.poi.xssf.streaming;
import java.io.IOException;
import java.io.InputStream;
import java.util.Collection;
import java.util.Iterator;
import java.util.List;
import java.util.Map;
import java.util.Set;
import java.util.TreeMap;
import org.apache.poi.hssf.util.PaneInformation;
import org.apache.poi.ss.SpreadsheetVersion;
import org.apache.poi.ss.usermodel.AutoFilter;
import org.apache.poi.ss.usermodel.Cell;
import org.apache.poi.ss.usermodel.CellRange;
import org.apache.poi.ss.usermodel.CellStyle;
import org.apache.poi.ss.usermodel.DataValidation;
import org.apache.poi.ss.usermodel.DataValidationHelper;
import org.apache.poi.ss.usermodel.Drawing;
import org.apache.poi.ss.usermodel.Footer;
import org.apache.poi.ss.usermodel.Header;
import org.apache.poi.ss.usermodel.PrintSetup;
import org.apache.poi.ss.usermodel.Row;
import org.apache.poi.ss.usermodel.Sheet;
import org.apache.poi.ss.usermodel.SheetConditionalFormatting;
import org.apache.poi.ss.usermodel.Workbook;
import org.apache.poi.ss.util.CellAddress;
import org.apache.poi.ss.util.CellRangeAddress;
import org.apache.poi.ss.util.SheetUtil;
import org.apache.poi.util.Internal;
import org.apache.poi.util.NotImplemented;
import org.apache.poi.xssf.usermodel.XSSFComment;
import org.apache.poi.xssf.usermodel.XSSFDataValidation;
import org.apache.poi.xssf.usermodel.XSSFHyperlink;
import org.apache.poi.xssf.usermodel.XSSFSheet;
import org.openxmlformats.schemas.spreadsheetml.x2006.main.CTSheetFormatPr;
import org.openxmlformats.schemas.spreadsheetml.x2006.main.CTWorksheet;
/**
* Streaming version of XSSFSheet implementing the "BigGridDemo" strategy.
*/
public class SXSSFSheet implements Sheet, Cloneable
{
/*package*/ final XSSFSheet _sh;
private final SXSSFWorkbook _workbook;
private final TreeMap
* 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.
*
* Please note, that this method works correctly only for workbooks
* with the default font size (Calibri 11pt for .xlsx).
*
* 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.
*
* 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.
*
* 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.
*
* 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.
* false
if the column is visible
*/
@Override
public boolean isColumnHidden(int columnIndex)
{
return _sh.isColumnHidden(columnIndex);
}
/**
* Set the width (in units of 1/256th of a character width)
* true
if the sheet displays Automatic Page Breaks.
*/
@Override
public void setAutobreaks(boolean value)
{
_sh.setAutobreaks(value);
}
/**
* Set whether to display the guts or not
*
* @param value - guts or no guts
*/
@Override
public void setDisplayGuts(boolean value)
{
_sh.setDisplayGuts(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.
*
* @param value whether to display or hide all zero values on the worksheet
*/
@Override
public void setDisplayZeros(boolean value)
{
_sh.setDisplayZeros(value);
}
/**
* 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.
*
* @return whether all zero values on the worksheet are displayed
*/
@Override
public boolean isDisplayZeros()
{
return _sh.isDisplayZeros();
}
/**
* Sets whether the worksheet is displayed from right to left instead of from left to right.
*
* @param value true for right to left, false otherwise.
*/
@Override
public void setRightToLeft(boolean value)
{
_sh.setRightToLeft(value);
}
/**
* Whether the text is displayed in right-to-left mode in the window
*
* @return whether the text is displayed in right-to-left mode in the window
*/
@Override
public boolean isRightToLeft()
{
return _sh.isRightToLeft();
}
/**
* Flag indicating whether the Fit to Page print option is enabled.
*
* @param value true
if the Fit to Page print option is enabled.
*/
@Override
public void setFitToPage(boolean value)
{
_sh.setFitToPage(value);
}
/**
* Flag indicating whether summary rows appear below detail in an outline, when applying an outline.
*
* true
if row summaries appear below detail in the outline
*/
@Override
public void setRowSumsBelow(boolean value)
{
_sh.setRowSumsBelow(value);
}
/**
* Flag indicating whether summary columns appear to the right of detail in an outline, when applying an outline.
*
* true
if col summaries appear right of the detail in the outline
*/
@Override
public void setRowSumsRight(boolean value)
{
_sh.setRowSumsRight(value);
}
/**
* Flag indicating whether the sheet displays Automatic Page Breaks.
*
* @return true
if the sheet displays Automatic Page Breaks.
*/
@Override
public boolean getAutobreaks()
{
return _sh.getAutobreaks();
}
/**
* Get whether to display the guts or not,
* default value is true
*
* @return boolean - guts or no guts
*/
@Override
public boolean getDisplayGuts()
{
return _sh.getDisplayGuts();
}
/**
* Flag indicating whether the Fit to Page print option is enabled.
*
* @return true
if the Fit to Page print option is enabled.
*/
@Override
public boolean getFitToPage()
{
return _sh.getFitToPage();
}
/**
* Flag indicating whether summary rows appear below detail in an outline, when applying an outline.
*
* true
if row summaries appear below detail in the outline
*/
@Override
public boolean getRowSumsBelow()
{
return _sh.getRowSumsBelow();
}
/**
* Flag indicating whether summary columns appear to the right of detail in an outline, when applying an outline.
*
* true
if col summaries appear right of the detail in the outline
*/
@Override
public boolean getRowSumsRight()
{
return _sh.getRowSumsRight();
}
/**
* Gets the flag indicating whether this sheet displays the lines
* between rows and columns to make editing and reading easier.
*
* @return true
if this sheet displays gridlines.
* @see #isPrintGridlines() to check if printing of gridlines is turned on or off
*/
@Override
public boolean isPrintGridlines()
{
return _sh.isPrintGridlines();
}
/**
* 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 {@link #setPrintGridlines(boolean)}
*
*
* @param show true
if this sheet should display gridlines.
* @see #setPrintGridlines(boolean)
*/
@Override
public void setPrintGridlines(boolean show)
{
_sh.setPrintGridlines(show);
}
/**
* Gets the print setup object.
*
* @return The user model for the print setup object.
*/
@Override
public PrintSetup getPrintSetup()
{
return _sh.getPrintSetup();
}
/**
* Gets the user model for the default document header.
*
* Note that XSSF offers more kinds of document headers than HSSF does
*
null
*/
@Override
public Header getHeader()
{
return _sh.getHeader();
}
/**
* Gets the user model for the default document footer.
*
* Note that XSSF offers more kinds of document footers than HSSF does.
*
* @return the document footer. Never null
*/
@Override
public Footer getFooter()
{
return _sh.getFooter();
}
/**
* 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. *
* @param valuetrue
if this sheet is selected
* @see Workbook#setActiveSheet(int)
*/
@Override
public void setSelected(boolean value)
{
_sh.setSelected(value);
}
/**
* Gets the size of the margin in inches.
*
* @param margin which margin to get
* @return the size of the margin
*/
@Override
public double getMargin(short margin)
{
return _sh.getMargin(margin);
}
/**
* Sets the size of the margin in inches.
*
* @param margin which margin to get
* @param size the size of the margin
*/
@Override
public void setMargin(short margin, double size)
{
_sh.setMargin(margin,size);
}
/**
* Answer whether protection is enabled or disabled
*
* @return true => protection enabled; false => protection disabled
*/
@Override
public boolean getProtect()
{
return _sh.getProtect();
}
/**
* Sets the protection enabled as well as the password
* @param password to set for protection. Pass null
to remove protection
*/
@Override
public void protectSheet(String password)
{
_sh.protectSheet(password);
}
/**
* Answer whether scenario protection is enabled or disabled
*
* @return true => protection enabled; false => protection disabled
*/
@Override
public boolean getScenarioProtect()
{
return _sh.getScenarioProtect();
}
/**
* Sets the zoom magnication 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.
*
* @param numerator The numerator for the zoom magnification.
* @param denominator The denominator for the zoom magnification.
* @deprecated 2015-11-23 (circa POI 3.14beta1). Use {@link #setZoom(int)} instead.
*/
@Override
public void setZoom(int numerator, int denominator)
{
_sh.setZoom(numerator,denominator);
}
/**
* 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. * * @param scale window zoom magnification * @throws IllegalArgumentException if scale is invalid */ @Override public void setZoom(int scale) { _sh.setZoom(scale); } /** * The top row in the visible view when the sheet is * first viewed after opening it in a viewer * * @return short indicating the rownum (0 based) of the top row */ @Override public short getTopRow() { return _sh.getTopRow(); } /** * The left col in the visible view when the sheet is * first viewed after opening it in a viewer * * @return short indicating the rownum (0 based) of the top row */ @Override public short getLeftCol() { return _sh.getLeftCol(); } /** * Sets desktop window pane display area, when the * file is first opened in a viewer. * * @param toprow the top row to show in desktop window pane * @param leftcol the left column to show in desktop window pane */ @Override public void showInPane(int toprow, int leftcol) { _sh.showInPane(toprow, leftcol); } /** * 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 {@link org.apache.poi.ss.usermodel.FormulaEvaluator} is the * recommended solution, but this may be used for certain cases where * evaluation in POI is not possible. */ @Override public void setForceFormulaRecalculation(boolean value) { _sh.setForceFormulaRecalculation(value); } /** * Whether Excel will be asked to recalculate all formulas when the * workbook is opened. */ @Override public boolean getForceFormulaRecalculation() { return _sh.getForceFormulaRecalculation(); } /** * 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). * @param startRow the row to start shifting * @param endRow the row to end shifting * @param n the number of rows to shift */ @NotImplemented @Override public void shiftRows(int startRow, int endRow, int n) { throw new RuntimeException("NotImplemented"); } /** * 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). *
* @param startRow the row to start shifting * @param endRow the row to end shifting * @param n the number of rows to shift * @param copyRowHeight whether to copy the row height during the shift * @param resetOriginalRowHeight whether to set the original row's height to the default */ @NotImplemented @Override public void shiftRows(int startRow, int endRow, int n, boolean copyRowHeight, boolean resetOriginalRowHeight) { throw new RuntimeException("NotImplemented"); } /** * Creates a split (freezepane). Any existing freezepane or split pane is overwritten. * @param colSplit Horizonatal position of split. * @param rowSplit Vertical position of split. * @param leftmostColumn Left column visible in right pane. * @param topRow Top row visible in bottom pane */ @Override public void createFreezePane(int colSplit, int rowSplit, int leftmostColumn, int topRow) { _sh.createFreezePane(colSplit, rowSplit, leftmostColumn, topRow); } /** * Creates a split (freezepane). Any existing freezepane or split pane is overwritten. * @param colSplit Horizonatal position of split. * @param rowSplit Vertical position of split. */ @Override public void createFreezePane(int colSplit, int rowSplit) { _sh.createFreezePane(colSplit,rowSplit); } /** * Creates a split pane. Any existing freezepane or split pane is overwritten. * @param xSplitPos Horizonatal position of split (in 1/20th of a point). * @param ySplitPos Vertical position of split (in 1/20th of a point). * @param topRow Top row visible in bottom pane * @param leftmostColumn Left column visible in right pane. * @param activePane Active pane. One of: PANE_LOWER_RIGHT, * PANE_UPPER_RIGHT, PANE_LOWER_LEFT, PANE_UPPER_LEFT * @see #PANE_LOWER_LEFT * @see #PANE_LOWER_RIGHT * @see #PANE_UPPER_LEFT * @see #PANE_UPPER_RIGHT */ @Override public void createSplitPane(int xSplitPos, int ySplitPos, int leftmostColumn, int topRow, int activePane) { _sh.createSplitPane(xSplitPos, ySplitPos, leftmostColumn, topRow, activePane); } /** * Returns the information regarding the currently configured pane (split or freeze) * * @return null if no pane configured, or the pane information. */ @Override public PaneInformation getPaneInformation() { return _sh.getPaneInformation(); } /** * Sets whether the gridlines are shown in a viewer * * @param show whether to show gridlines or not */ @Override public void setDisplayGridlines(boolean show) { _sh.setDisplayGridlines(show); } /** * Returns if gridlines are displayed * * @return whether gridlines are displayed */ @Override public boolean isDisplayGridlines() { return _sh.isDisplayGridlines(); } /** * Sets whether the formulas are shown in a viewer * * @param show whether to show formulas or not */ @Override public void setDisplayFormulas(boolean show) { _sh.setDisplayFormulas(show); } /** * Returns if formulas are displayed * * @return whether formulas are displayed */ @Override public boolean isDisplayFormulas() { return _sh.isDisplayFormulas(); } /** * Sets whether the RowColHeadings are shown in a viewer * * @param show whether to show RowColHeadings or not */ @Override public void setDisplayRowColHeadings(boolean show) { _sh.setDisplayRowColHeadings(show); } /** * Returns if RowColHeadings are displayed. * @return whether RowColHeadings are displayed */ @Override public boolean isDisplayRowColHeadings() { return _sh.isDisplayRowColHeadings(); } /** * Sets a page break at the indicated row * @param row FIXME: Document this! */ @Override public void setRowBreak(int row) { _sh.setRowBreak(row); } /** * Determines if there is a page break at the indicated row * @param row FIXME: Document this! * @return FIXME: Document this! */ @Override public boolean isRowBroken(int row) { return _sh.isRowBroken(row); } /** * Removes the page break at the indicated row * @param row */ @Override public void removeRowBreak(int row) { _sh.removeRowBreak(row); } /** * Retrieves all the horizontal page breaks * @return all the horizontal page breaks, or null if there are no row page breaks */ @Override public int[] getRowBreaks() { return _sh.getRowBreaks(); } /** * Retrieves all the vertical page breaks * @return all the vertical page breaks, or null if there are no column page breaks */ @Override public int[] getColumnBreaks() { return _sh.getColumnBreaks(); } /** * Sets a page break at the indicated column * @param column */ @Override public void setColumnBreak(int column) { _sh.setColumnBreak(column); } /** * Determines if there is a page break at the indicated column * @param column FIXME: Document this! * @return FIXME: Document this! */ @Override public boolean isColumnBroken(int column) { return _sh.isColumnBroken(column); } /** * Removes a page break at the indicated column * @param column */ @Override public void removeColumnBreak(int column) { _sh.removeColumnBreak(column); } /** * Expands or collapses a column group. * * @param columnNumber One of the columns in the group. * @param collapsed true = collapse group, false = expand group. */ @Override public void setColumnGroupCollapsed(int columnNumber, boolean collapsed) { _sh.setColumnGroupCollapsed(columnNumber, collapsed); } /** * Create an outline for the provided column range. * * @param fromColumn beginning of the column range. * @param toColumn end of the column range. */ @Override public void groupColumn(int fromColumn, int toColumn) { _sh.groupColumn(fromColumn,toColumn); } /** * Ungroup a range of columns that were previously groupped * * @param fromColumn start column (0-based) * @param toColumn end column (0-based) */ @Override public void ungroupColumn(int fromColumn, int toColumn) { _sh.ungroupColumn(fromColumn, toColumn); } /** * 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
*
*
*
*
* @param fromRow start row (0-based)
* @param toRow end row (0-based)
*/
@Override
public void groupRow(int fromRow, int toRow)
{
for(SXSSFRow row : _rows.subMap(fromRow, toRow + 1).values()){
int level = row.getOutlineLevel() + 1;
row.setOutlineLevel(level);
if(level > outlineLevelRow) outlineLevelRow = level;
}
setWorksheetOutlineLevelRow();
}
/**
* 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. *
* * @param rownum index of row to update (0-based) * @param level outline level (> 0) */ public void setRowOutlineLevel(int rownum, int level) { SXSSFRow row = _rows.get(rownum); row.setOutlineLevel(level); if(level > 0 && level > outlineLevelRow) { outlineLevelRow = level; setWorksheetOutlineLevelRow(); } } private void setWorksheetOutlineLevelRow() { CTWorksheet ct = _sh.getCTWorksheet(); CTSheetFormatPr pr = ct.isSetSheetFormatPr() ? ct.getSheetFormatPr() : ct.addNewSheetFormatPr(); if(outlineLevelRow > 0) pr.setOutlineLevelRow((short)outlineLevelRow); } /** * Ungroup a range of rows that were previously groupped * * @param fromRow start row (0-based) * @param toRow end row (0-based) */ @Override public void ungroupRow(int fromRow, int toRow) { _sh.ungroupRow(fromRow, toRow); } /** * Set view state of a groupped range of rows * * @param row start row of a groupped range of rows (0-based) * @param collapse whether to expand/collapse the detail rows */ @Override public void setRowGroupCollapsed(int row, boolean collapse) { if (collapse) { collapseRow(row); } else { //expandRow(rowIndex); throw new RuntimeException("Unable to expand row: Not Implemented"); } } /** * @param rowIndex the zero based row index to collapse */ private void collapseRow(int rowIndex) { SXSSFRow row = getRow(rowIndex); if(row == null) { throw new IllegalArgumentException("Invalid row number("+ rowIndex + "). Row does not exist."); } else { int startRow = findStartOfRowOutlineGroup(rowIndex); // Hide all the columns until the end of the group int lastRow = writeHidden(row, startRow, true); SXSSFRow lastRowObj = getRow(lastRow); if (lastRowObj != null) { lastRowObj.setCollapsed(true); } else { SXSSFRow newRow = createRow(lastRow); newRow.setCollapsed(true); } } } /** * @param rowIndex the zero based row index to find from */ private int findStartOfRowOutlineGroup(int rowIndex) { // Find the start of the group. Row row = getRow(rowIndex); int level = ((SXSSFRow) row).getOutlineLevel(); if(level == 0) { throw new IllegalArgumentException("Outline level is zero for the row (" + rowIndex + ")."); } int currentRow = rowIndex; while (getRow(currentRow) != null) { if (getRow(currentRow).getOutlineLevel() < level) return currentRow + 1; currentRow--; } return currentRow + 1; } private int writeHidden(SXSSFRow xRow, int rowIndex, boolean hidden) { int level = xRow.getOutlineLevel(); SXSSFRow currRow = getRow(rowIndex); while (currRow != null && currRow.getOutlineLevel() >= level) { currRow.setHidden(hidden); rowIndex++; currRow = getRow(rowIndex); } return rowIndex; } /** * Sets the default column style for a given column. POI will only apply this style to new cells added to the sheet. * * @param column the column index * @param style the style to set */ @Override public void setDefaultColumnStyle(int column, CellStyle style) { _sh.setDefaultColumnStyle(column, style); } /** * 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. * Ifcolumn
is already tracked, this call does nothing.
*
* @param column the column to track for auto-sizing
* @since 3.14beta1
* @see #trackColumnsForAutoSizing(Collection)
* @see #trackAllColumnsForAutoSizing()
*/
public void trackColumnForAutoSizing(int column)
{
_autoSizeColumnTracker.trackColumn(column);
}
/**
* 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.
*
* @param columns the columns to track for auto-sizing
* @since 3.14beta1
*/
public void trackColumnsForAutoSizing(Collectioncolumn
is not tracked, it will be ignored by this call.
*
* @param column the index of the column to track for auto-sizing
* @return true if column was tracked prior to this call, false if no action was taken
* @since 3.14beta1
* @see #untrackColumnsForAutoSizing(Collection)
* @see #untrackAllColumnsForAutoSizing()
*/
public boolean untrackColumnForAutoSizing(int column)
{
return _autoSizeColumnTracker.untrackColumn(column);
}
/**
* 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.
*
* @param columns the indices of the columns to track for auto-sizing
* @return true if one or more columns were untracked as a result of this call
* @since 3.14beta1
*/
public boolean untrackColumnsForAutoSizing(Collection* 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 {@link #trackColumnForAutoSizing(int)} or {@link #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.
* * @param column the column index to auto-size */ @Override public void autoSizeColumn(int column) { autoSizeColumn(column, false); } /** * 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 {@link #trackColumnForAutoSizing(int)} or {@link #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.
* * @param column the column index to auto-size * @param useMergedCells whether to use the contents of merged cells when calculating the width of the column */ @Override public void autoSizeColumn(int column, boolean useMergedCells) { // Multiple calls to autoSizeColumn need to look up the best-fit width // of rows already flushed to disk plus re-calculate the best-fit width // of rows in the current window. It isn't safe to update the column // widths before flushing to disk because columns in the random access // window rows may change in best-fit width. The best-fit width of a cell // is only fixed when it becomes inaccessible for modification. // Changes to the shared strings table, styles table, or formulas might // be able to invalidate the auto-size width without the opportunity // to recalculate the best-fit width for the flushed rows. This is an // inherent limitation of SXSSF. If having correct auto-sizing is // critical, the flushed rows would need to be re-read by the read-only // XSSF eventmodel (SAX) or the memory-heavy XSSF usermodel (DOM). final int flushedWidth; try { // get the best fit width of rows already flushed to disk flushedWidth = _autoSizeColumnTracker.getBestFitColumnWidth(column, useMergedCells); } catch (final IllegalStateException e) { throw new IllegalStateException("Could not auto-size column. Make sure the column was tracked prior to auto-sizing the column.", e); } // get the best-fit width of rows currently in the random access window final int activeWidth = (int) (256 * SheetUtil.getColumnWidth(this, column, useMergedCells)); // the best-fit width for both flushed rows and random access window rows // flushedWidth or activeWidth may be negative if column contains only blank cells final int bestFitWidth = Math.max(flushedWidth, activeWidth); if (bestFitWidth > 0) { final int maxColumnWidth = 255*256; // The maximum column width for an individual cell is 255 characters final int width = Math.min(bestFitWidth, maxColumnWidth); setColumnWidth(column, width); } } /** * Returns cell comment for the specified row and column * * @return cell comment ornull
if not found
* @deprecated as of 2015-11-23 (circa POI 3.14beta1). Use {@link #getCellComment(CellAddress)} instead.
*/
@Override
public XSSFComment getCellComment(int row, int column)
{
return getCellComment(new CellAddress(row, column));
}
/**
* Returns cell comment for the specified row and column
*
* @return cell comment or null
if not found
*/
@Override
public XSSFComment getCellComment(CellAddress ref)
{
return _sh.getCellComment(ref);
}
/**
* Returns all cell comments on this sheet.
* @return A map of each Comment in the sheet, keyed on the cell address where
* the comment is located.
*/
@Override
public Maptrue
if this sheet is currently selected
*/
@Override
public boolean isSelected()
{
return _sh.isSelected();
}
/**
* Sets array formula to specified region for result.
*
* @param formula text representation of the formula
* @param range Region of array formula for result.
* @return the {@link CellRange} of cells affected by this change
*/
@Override
public CellRange extends Cell> setArrayFormula(String formula, CellRangeAddress range)
{
return _sh.setArrayFormula(formula, range);
}
/**
* Remove a Array Formula from this sheet. All cells contained in the Array Formula range are removed as well
*
* @param cell any cell within Array Formula range
* @return the {@link CellRange} of cells affected by this change
*/
@Override
public CellRange extends Cell> removeArrayFormula(Cell cell)
{
return _sh.removeArrayFormula(cell);
}
@Override
public DataValidationHelper getDataValidationHelper()
{
return _sh.getDataValidationHelper();
}
@Override
public List