Java org.apache.poi.xssf.usermodel XSSFSheet fields, constructors, methods, implement or subclass

Introduction

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

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)
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.
XSSFDrawing	createDrawingPatriarch() Create a new SpreadsheetML drawing.
void	createFreezePane(int colSplit, int rowSplit) Creates a split (freezepane).
XSSFPivotTable	createPivotTable(AreaReference source, CellReference position) Create a pivot table using the AreaReference range, at the given position.
XSSFPivotTable	createPivotTable(Name source, CellReference position) Create a pivot table using the Name range, at the given position.
XSSFPivotTable	createPivotTable(final Table source, CellReference position) Create a pivot table using the Table, at the given position.
XSSFPivotTable	createPivotTable(final AreaReference source, CellReference position, Sheet sourceSheet) Create a pivot table using the AreaReference range on sourceSheet, at the given position.
XSSFPivotTable	createPivotTable(CellReference position, Sheet sourceSheet, PivotTableReferenceConfigurator refConfig) Create a pivot table using the AreaReference or named/table range on sourceSheet, at the given position.
XSSFPivotTable	createPivotTable(final Name source, CellReference position, Sheet sourceSheet) Create a pivot table using the Name range reference on sourceSheet, at the given position.
XSSFRow	createRow(int rownum) Create a new row within the sheet and return the high level representation Note: If a row already exists at this position, it is removed/overwritten and any existing cell is removed!
XSSFTable	createTable() Creates a new Table, and associates it with this Sheet.
void	enableLocking() Enable sheet protection
CellAddress	getActiveCell() Return location of the active cell, e.g.
XSSFComment	getCellComment(CellAddress address) Return cell comment at row, column, if one exists.
Map	getCellComments() Returns all cell comments on this sheet.
ColumnHelper	getColumnHelper()
int	getColumnWidth(int columnIndex) Get the actual column width (in units of 1/256th of a character width ) Note, the returned value is always gerater that #getDefaultColumnWidth() because the latter does not include margins.
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).
CTWorksheet	getCTWorksheet() Provide access to the CTWorksheet bean holding this sheet's data
XSSFDrawing	getDrawingPatriarch() Return the sheet's existing drawing, or null if there isn't yet one.
Footer	getEvenFooter() Returns the even footer.
Header	getEvenHeader() Returns the even header.
Footer	getFirstFooter() Returns the first page footer.
Header	getFirstHeader() Returns the first page header.
int	getFirstRowNum() Gets the first row on the sheet
Header	getHeader() Returns the default header for the sheet, creating one as needed.
int	getLastRowNum()
short	getLeftCol()
double	getMargin(short margin) Gets the size of the margin in inches.
CellRangeAddress	getMergedRegion(int index) Returns the merged region at the specified index.
int	getNumMergedRegions() Returns the number of merged regions defined in this worksheet
Footer	getOddFooter() Returns the odd footer.
Header	getOddHeader() Returns the odd header.
PackagePart	getPackagePart() Provides access to the underlying PackagePart
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)
XSSFPrintSetup	getPrintSetup() Gets the print setup object.
List	getRelations() Returns the list of child relations for this POIXMLDocumentPart
XSSFRow	getRow(int rownum) Returns the logical row ( 0-based).
boolean	getRowSumsBelow() Flag indicating whether summary rows appear below detail in an outline, when applying an outline.
XSSFSheetConditionalFormatting	getSheetConditionalFormatting()
String	getSheetName() Returns the name of this sheet
List	getTables() Returns any tables associated with this Sheet
short	getTopRow() The top row in the visible view when the sheet is first viewed after opening it in a viewer
XSSFWorkbook	getWorkbook() Returns the parent XSSFWorkbook
void	groupRow(int fromRow, int toRow) Tie a range of cell together so that they can be collapsed or expanded
boolean	hasComments() Does this sheet have any comments on it?
boolean	isDisplayGridlines() Gets the flag indicating whether this sheet displays the lines between rows and columns to make editing and reading easier.
boolean	isSelected() Returns a flag indicating whether this sheet is selected.
Iterator	iterator() Alias for #rowIterator() to allow foreach loops
void	protectSheet(String password) Enables sheet protection and sets the password for the sheet.
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	setActiveCell(CellAddress address)
void	setAutobreaks(boolean value) Flag indicating whether the sheet displays Automatic Page Breaks.
XSSFAutoFilter	setAutoFilter(CellRangeAddress range)
void	setColumnBreak(int column) Sets a page break at the indicated column.
void	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)
void	setDefaultColumnWidth(int width) Specifies the number of characters of the maximum digit width of the normal style's font.
void	setDefaultRowHeight(short height) Set the default row height for the sheet (if the rows do not define their own height) in twips (1/20 of a point)
void	setDisplayGridlines(boolean show) Sets the flag indicating whether this sheet should display the lines between rows and columns to make editing and reading easier.
void	setFitToPage(boolean b) Flag indicating whether the Fit to Page print option is enabled.
void	setForceFormulaRecalculation(boolean value) Control if Excel should be asked to recalculate all formulas on this sheet when the workbook is opened.
void	setHorizontallyCenter(boolean value) Center on page horizontally when printing.
void	setMargin(short margin, double size) Sets the size of the margin in inches.
void	setPrintGridlines(boolean value) Turns on or off the printing of gridlines.
void	setRepeatingRows(CellRangeAddress rowRangeRef)
void	setRowGroupCollapsed(int rowIndex, boolean collapse) group the row It is possible for collapsed to be false and yet still have the rows in question hidden.
void	setRowSumsBelow(boolean value) Flag indicating whether summary rows appear below detail in an outline, when applying an outline.
void	setSelected(boolean value) Sets a flag indicating whether this sheet is selected.
void	setZoom(int scale) Window zoom magnification for current view representing percent values.
void	shiftRows(int startRow, int endRow, int n) Shifts rows between startRow and endRow n number of rows.
void	shiftRows(int startRow, int endRow, final int n, boolean copyRowHeight, boolean resetOriginalRowHeight) Shifts rows between startRow and endRow n number of rows.
void	showInPane(int toprow, int leftcol) Location of the top left visible cell Location of the top left visible cell in the bottom right pane (when in Left-to-Right mode).
String	toString()