Java org.apache.poi.hssf.usermodel HSSFSheet fields, constructors, methods, implement or subclass

Introduction

In this page you can find the methods, fields and constructors for org.apache.poi.hssf.usermodel HSSFSheet.

The text is from its open source code.

Method

int	addMergedRegion(CellRangeAddress region) Adds a merged region of cells on a sheet.
void	addValidationData(DataValidation dataValidation) Creates a data validation object
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.
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.
HSSFPatriarch	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).
HSSFRow	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.
boolean	getAlternateExpression() whether alternate expression evaluation is on
boolean	getAlternateFormula() whether alternative formula entry is on
boolean	getAutobreaks() show automatic page breaks or not
int[]	getColumnBreaks()
int	getColumnWidth(int columnIndex) get the width (in units of 1/256th of a character width )
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	getDialog() get whether sheet is a dialog sheet or not
boolean	getDisplayGuts() get whether to display the guts or not
EscherAggregate	getDrawingEscherAggregate() Returns the agregate escher records for this sheet, it there is one.
HSSFPatriarch	getDrawingPatriarch() This will hold any graphics or charts for the sheet.
int	getFirstRowNum() Gets the first row on the sheet
boolean	getFitToPage() fit to page option is on
HSSFFooter	getFooter()
HSSFHeader	getHeader()
boolean	getHorizontallyCenter() Determine whether printed output for this sheet will be horizontally centered.
int	getLastRowNum() Gets the number last row on the sheet.
double	getMargin(short margin) Gets the size of the margin in inches.
CellRangeAddress	getMergedRegion(int index)
int	getNumMergedRegions() returns the number of merged regions
int	getPhysicalNumberOfRows() Returns the number of physically defined rows (NOT the number of rows in the sheet)
HSSFPrintSetup	getPrintSetup() Gets the print setup object.
HSSFRow	getRow(int rowIndex) Returns the logical row (not physical) 0-based.
int[]	getRowBreaks()
boolean	getRowSumsBelow() get if row summaries appear below detail in the outline
boolean	getRowSumsRight() get if col summaries appear right of the detail in the outline
HSSFSheetConditionalFormatting	getSheetConditionalFormatting()
String	getSheetName() Returns the name of this sheet
HSSFWorkbook	getWorkbook() Return the parent workbook
void	groupColumn(int fromColumn, int toColumn) Create an outline for the provided column range.
void	groupRow(int fromRow, int toRow) Tie a range of cell together so that they can be collapsed or expanded
boolean	isColumnHidden(int columnIndex) Get the hidden state for a given column.
boolean	isDisplayFormulas() Returns if formulas are displayed.
boolean	isDisplayGridlines() Returns if gridlines are displayed.
boolean	isDisplayRowColHeadings() Returns if RowColHeadings are displayed.
boolean	isGridsPrinted() get whether gridlines are printed.
boolean	isPrintGridlines() Returns whether gridlines are printed.
Iterator	iterator() Alias for #rowIterator() to allow foreach loops
void	protectSheet(String password) Sets the protection enabled as well as the password
void	removeMergedRegion(int index) removes a merged region of cells (hence letting them free)
void	removeRow(Row row) Remove a row from this sheet.
Iterator	rowIterator()
void	setActive(boolean sel) Sets whether sheet is selected.
void	setAlternativeExpression(boolean b) whether alternate expression evaluation is on
void	setAlternativeFormula(boolean b) whether alternative formula entry is on
void	setAutobreaks(boolean b) show automatic page breaks or not
HSSFAutoFilter	setAutoFilter(CellRangeAddress range)
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) The maximum column width for an individual cell is 255 characters.
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	setDialog(boolean b) set whether sheet is a dialog sheet or not
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 b) set whether to display the guts or not
void	setDisplayRowColHeadings(boolean show) Sets whether the RowColHeadings are shown in a viewer.
void	setFitToPage(boolean b) fit to page option is on
void	setForceFormulaRecalculation(boolean value) Control if Excel should be asked to recalculate all formulas on this sheet when the workbook is opened. Calculating the formula values with 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. It is recommended to force recalcuation of formulas on workbook level using org.apache.poi.ss.usermodel.Workbook#setForceFormulaRecalculation(boolean) to ensure that all cross-worksheet formuals and external dependencies are updated.
void	setGridsPrinted(boolean value) set whether gridlines printed.
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	setRepeatingRows(CellRangeAddress rowRangeRef)
void	setRowBreak(int row) Sets a page break at the indicated row Breaks occur above the specified row and left of the specified column inclusive. For example, `sheet.setColumnBreak(2);` breaks the sheet into two parts with columns A,B,C in the first and D,E,...
void	setRowGroupCollapsed(int rowIndex, boolean collapse)
void	setRowSumsBelow(boolean b) set if row summaries appear below detail in the outline
void	setRowSumsRight(boolean b) set if col summaries appear right of the detail in the outline
void	setSelected(boolean sel) Sets whether sheet is selected.
void	setVerticallyCenter(boolean value) determines whether the output is vertically centered on the page.
void	setZoom(int numerator, int denominator) Sets the zoom magnification for the sheet.
void	shiftRows(int startRow, int endRow, int n) Shifts rows between startRow and endRow n number of rows.
void	shiftRows(int startRow, int endRow, int n, boolean copyRowHeight, boolean resetOriginalRowHeight) Shifts rows between startRow and endRow n number of rows.