public class XSSFSheet extends POIXMLDocumentPart implements Sheet
Sheets are the central structures within a workbook, and are where a user does most of his spreadsheet work. The most common type of sheet is the worksheet, which is represented as a grid of cells. Worksheet cells can contain text, numbers, dates, and formulas. Cells can also be formatted.
Modifier and Type | Field and Description |
---|---|
protected List<XSSFHyperlink> |
hyperlinks |
protected org.openxmlformats.schemas.spreadsheetml.x2006.main.CTSheet |
sheet |
protected org.openxmlformats.schemas.spreadsheetml.x2006.main.CTWorksheet |
worksheet |
DEFAULT_XML_OPTIONS
BottomMargin, FooterMargin, HeaderMargin, LeftMargin, PANE_LOWER_LEFT, PANE_LOWER_RIGHT, PANE_UPPER_LEFT, PANE_UPPER_RIGHT, RightMargin, TopMargin
Modifier | Constructor and Description |
---|---|
protected |
XSSFSheet()
Creates new XSSFSheet - called by XSSFWorkbook to create a sheet from scratch.
|
protected |
XSSFSheet(PackagePart part,
PackageRelationship rel)
Creates an XSSFSheet representing the given package part and relationship.
|
Modifier and Type | Method and Description |
---|---|
void |
addCondtionalFormatting(XSSFConditionalFormatting cf) |
void |
addHyperlink(XSSFHyperlink hyperlink)
Register a hyperlink in the collection of hyperlinks on this sheet
|
int |
addMergedRegion(CellRangeAddress region)
Adds a merged region of cells (hence those cells form one).
|
void |
addValidationData(DataValidation dataValidation)
Creates a data validation object
|
void |
autoSizeColumn(int column)
Adjusts the column width to fit the contents.
|
void |
autoSizeColumn(int column,
boolean useMergedCells)
Adjusts the column width to fit the contents.
|
protected void |
commit()
Save the content in the underlying package part.
|
XSSFComment |
createComment()
Deprecated.
since Nov 2009 this method is not compatible with the common SS interfaces,
use
(org.zkoss.poi.ss.usermodel.ClientAnchor) instead |
XSSFDrawing |
createDrawingPatriarch()
Create a new SpreadsheetML drawing.
|
void |
createFreezePane(int colSplit,
int rowSplit)
Creates a split (freezepane).
|
void |
createFreezePane(int colSplit,
int rowSplit,
int leftmostColumn,
int topRow)
Creates a split (freezepane).
|
PivotTable |
createPivotTable(CellReference destination,
String name,
PivotCache pivotCache) |
XSSFRow |
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.
|
XSSFTable |
createTable()
Creates a new Table, and associates it with this Sheet
|
void |
disableLocking()
Disable sheet protection
|
void |
enableLocking()
Enable sheet protection
|
int |
findEndOfRowOutlineGroup(int row) |
String |
getActiveCell()
Return location of the active cell, e.g.
|
String |
getAlgName() |
boolean |
getAutobreaks()
Flag indicating whether the sheet displays Automatic Page Breaks.
|
AutoFilter |
getAutoFilter()
Returns AutoFilter of this sheet; null if not exist.
|
XSSFComment |
getCellComment(int row,
int column)
Returns cell comment for the specified row and column
|
int[] |
getColumnBreaks()
Vertical page break information used for print layout view, page layout view, drawing print breaks
in normal view, and for printing the worksheet.
|
ColumnHelper |
getColumnHelper() |
CellStyle |
getColumnStyle(int column)
Returns the CellStyle that applies to the given
(0 based) column, or null if no style has been
set for that column
|
int |
getColumnWidth(int columnIndex)
Get the actual column width (in units of 1/256th of a character width )
|
protected CommentsTable |
getCommentsTable(boolean create)
Returns the sheet's comments object if there is one,
or null if not
|
List<XSSFConditionalFormatting> |
getConditionalFormattings() |
protected org.openxmlformats.schemas.spreadsheetml.x2006.main.CTDrawing |
getCTDrawing() |
protected org.openxmlformats.schemas.spreadsheetml.x2006.main.CTLegacyDrawing |
getCTLegacyDrawing() |
org.openxmlformats.schemas.spreadsheetml.x2006.main.CTWorksheet |
getCTWorksheet()
Provide access to the CTWorksheet bean holding this sheet's data
|
DataValidation |
getDataValidation(int row,
int col) |
DataValidationHelper |
getDataValidationHelper() |
List<DataValidation> |
getDataValidations() |
int |
getDefaultColumnWidth()
Get the default column width for the sheet (if the columns do not define their own width) in
characters.
|
short |
getDefaultRowHeight()
Get the default row height for the sheet (if the rows do not define their own height) in
twips (1/20 of a point)
|
float |
getDefaultRowHeightInPoints()
Get the default row height for the sheet measued in point size (if the rows do not define their own height).
|
boolean |
getDisplayGuts()
Get whether to display the guts or not,
default value is true
|
Footer |
getEvenFooter()
Returns the even footer.
|
Header |
getEvenHeader()
Returns the even header.
|
Footer |
getFirstFooter()
Returns the first page footer.
|
Header |
getFirstHeader()
Returns the first page header.
|
int |
getFirstRowNum()
Gets the first row on the sheet
|
boolean |
getFitToPage()
Flag indicating whether the Fit to Page print option is enabled.
|
Footer |
getFooter()
Returns the default footer for the sheet,
creating one as needed.
|
boolean |
getForceFormulaRecalculation()
Whether Excel will be asked to recalculate all formulas when the
workbook is opened.
|
String |
getHashValue() |
Header |
getHeader()
Returns the default header for the sheet,
creating one as needed.
|
boolean |
getHorizontallyCenter()
Determine whether printed output for this sheet will be horizontally centered.
|
XSSFHyperlink |
getHyperlink(int row,
int column) |
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
|
protected int |
getNumberOfComments() |
int |
getNumHyperlinks() |
int |
getNumMergedRegions()
Returns the number of merged regions defined in this worksheet
|
Footer |
getOddFooter()
Returns the odd footer.
|
Header |
getOddHeader()
Returns the odd header.
|
SheetProtection |
getOrCreateSheetProtection() |
PaneInformation |
getPaneInformation()
Returns the information regarding the currently configured pane (split or freeze).
|
short |
getPasswordHash() |
int |
getPhysicalNumberOfRows()
Returns the number of phsyically defined rows (NOT the number of rows in the sheet)
|
List<PivotTable> |
getPivotTables() |
XSSFPrintSetup |
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.
|
XSSFRow |
getRow(int rownum)
Returns the logical row ( 0-based).
|
int[] |
getRowBreaks()
Horizontal page break information used for print layout view, page layout view, drawing print breaks in normal
view, and for printing the worksheet.
|
protected TreeMap<Integer,XSSFRow> |
getRows() |
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.
|
String |
getSaltValue() |
boolean |
getScenarioProtect()
A flag indicating whether scenarios are locked when the sheet is protected.
|
XSSFSheetConditionalFormatting |
getSheetConditionalFormatting()
The 'Conditional Formatting' facet for this Sheet
|
String |
getSheetName()
Returns the name of this sheet
|
String |
getSpinCount() |
XSSFTable |
getTableByRowCol(int rowIdx,
int colIdx) |
List<XSSFTable> |
getTables()
Returns any tables associated with this Sheet
|
short |
getTopRow()
The top row in the visible view when the sheet is
first viewed after opening it in a viewer
|
boolean |
getVerticallyCenter()
Determine whether printed output for this sheet will be vertically centered.
|
protected XSSFVMLDrawing |
getVMLDrawing(boolean autoCreate)
Get VML drawing for this sheet (aka 'legacy' drawig)
|
XSSFWorkbook |
getWorkbook()
Returns the parent XSSFWorkbook
|
double |
getXssfDefaultColumnWidth() |
double |
getXssfDefaultColumnWidthPerBaseColWidth(int baseWidth) |
void |
groupColumn(int fromColumn,
int toColumn)
Group between (0 based) columns
|
void |
groupRow(int fromRow,
int toRow)
Tie a range of cell together so that they can be collapsed or expanded
|
boolean |
hasComments()
Does this sheet have any comments on it? We need to know,
so we can decide about writing it to disk or not
|
boolean |
isAlignMargins() |
boolean |
isAutoFilterLocked() |
boolean |
isAutoFilterMode() |
boolean |
isColumnBroken(int column)
Determines if there is a page break at the indicated column
|
boolean |
isColumnCustom(int columnIndex) |
boolean |
isColumnHidden(int columnIndex)
Get the hidden state for a given column.
|
boolean |
isDeleteColumnsLocked() |
boolean |
isDeleteRowsLocked() |
boolean |
isDiffFirst() |
boolean |
isDiffOddEven() |
boolean |
isDisplayFormulas()
Gets the flag indicating whether this sheet should display formulas.
|
boolean |
isDisplayGridlines()
Gets the flag indicating whether this sheet displays the lines
between rows and columns to make editing and reading easier.
|
boolean |
isDisplayRowColHeadings()
Gets the flag indicating whether this sheet should display row and column headings.
|
boolean |
isDisplayZeros()
Gets the flag indicating whether the window should show 0 (zero) in cells containing zero value.
|
boolean |
isFilterMode() |
boolean |
isFormatCellsLocked() |
boolean |
isFormatColumnsLocked() |
boolean |
isFormatRowsLocked() |
boolean |
isInsertColumnsLocked() |
boolean |
isInsertHyperlinksLocked() |
boolean |
isInsertRowsLocked() |
boolean |
isObjectsLocked() |
boolean |
isPivotTablesLocked() |
boolean |
isPrintGridlines()
Returns whether gridlines are printed.
|
boolean |
isPrintHeadings()
Returns whether gridlines are printed.
|
boolean |
isRightToLeft()
Whether the text is displayed in right-to-left mode in the window
|
boolean |
isRowBroken(int row)
Tests if there is a page break at the indicated row
|
boolean |
isScaleWithDoc() |
boolean |
isScenariosLocked() |
boolean |
isSelected()
Returns a flag indicating whether this sheet is selected.
|
boolean |
isSelectLockedCellsLocked() |
boolean |
isSelectUnlockedCellsLocked() |
boolean |
isSheetLocked() |
boolean |
isSortLocked() |
Iterator<Row> |
iterator()
Alias for
rowIterator() to
allow foreach loops |
void |
lockAutoFilter()
Enable Autofilters locking.
|
void |
lockDeleteColumns()
Enable Deleting columns locking.
|
void |
lockDeleteRows()
Enable Deleting rows locking.
|
void |
lockFormatCells()
Enable Formatting cells locking.
|
void |
lockFormatColumns()
Enable Formatting columns locking.
|
void |
lockFormatRows()
Enable Formatting rows locking.
|
void |
lockInsertColumns()
Enable Inserting columns locking.
|
void |
lockInsertHyperlinks()
Enable Inserting hyperlinks locking.
|
void |
lockInsertRows()
Enable Inserting rows locking.
|
void |
lockObjects()
Enable Objects locking.
|
void |
lockPivotTables()
Enable Pivot Tables locking.
|
void |
lockScenarios()
Enable Scenarios locking.
|
void |
lockSelectLockedCells()
Enable Selection of locked cells locking.
|
void |
lockSelectUnlockedCells()
Enable Selection of unlocked cells locking.
|
void |
lockSort()
Enable Sort locking.
|
protected void |
onDocumentCreate()
Initialize worksheet data when creating a new sheet.
|
protected void |
onDocumentRead()
Initialize worksheet data when reading in an exisiting file.
|
void |
protectSheet(String password)
Enables sheet protection and sets the password for the sheet.
|
protected void |
read(InputStream is) |
CellRange<XSSFCell> |
removeArrayFormula(Cell cell)
Remove a Array Formula from this sheet.
|
CellRangeAddress |
removeAutoFilter()
remove the autoFilter
|
void |
removeCellComment(int row,
int column) |
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 |
removeRow(Row row)
Remove a row from this sheet.
|
void |
removeRowBreak(int row)
Removes the page break at the indicated row
|
void |
removeValidationData(DataValidation dataValidation) |
Iterator<Row> |
rowIterator()
Returns an iterator of the physical rows
|
void |
setActiveCell(String cellRef)
Sets location of the active cell
|
void |
setAlgName(String algName) |
void |
setAlignMargins(boolean flag) |
CellRange<XSSFCell> |
setArrayFormula(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 |
setAutoFilterMode(boolean b)
Set false to remove AutoFilter; set true is ignored.
|
static void |
setCellComment(String cellRef,
XSSFComment comment)
Deprecated.
since Nov 2009 use
XSSFCell.setCellComment(org.zkoss.poi.ss.usermodel.Comment) instead |
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)
Specifies the number of characters of the maximum digit width of the normal style's font.
|
void |
setDefaultRowHeight(short height)
Set the default row height for the sheet (if the rows do not define their own height) in
twips (1/20 of a point)
|
void |
setDefaultRowHeightInPoints(float height)
Sets default row height measured in point size.
|
void |
setDiffFirst(boolean flag) |
void |
setDiffOddEven(boolean flag) |
void |
setDisplayFormulas(boolean show)
Sets the flag indicating whether this sheet should display formulas.
|
void |
setDisplayGridlines(boolean show)
Sets the flag indicating whether this sheet should display the lines
between rows and columns to make editing and reading easier.
|
void |
setDisplayGuts(boolean value)
Set whether to display the guts or not
|
void |
setDisplayRowColHeadings(boolean show)
Sets the flag indicating whether this sheet should display row and column headings.
|
void |
setDisplayZeros(boolean value)
Set whether the window should show 0 (zero) in cells containing zero value.
|
void |
setFitToPage(boolean b)
Flag indicating whether the Fit to Page print option is enabled.
|
void |
setForceFormulaRecalculation(boolean value)
Control if Excel should be asked to recalculate all formulas on this sheet
when the workbook is opened.
|
void |
setHashValue(String hashValue) |
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 |
setPasswordHash(short hashpass) |
void |
setPrintGridlines(boolean value)
Turns on or off the printing of gridlines.
|
void |
setPrintHeadings(boolean value)
Turns on or off the printing of gridlines.
|
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
Breaks occur above the specified row and left of the specified column inclusive.
|
void |
setRowGroupCollapsed(int rowIndex,
boolean collapse)
group the row It is possible for collapsed to be false and yet still have
the rows in question hidden.
|
protected void |
setRows(TreeMap<Integer,XSSFRow> rows) |
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 |
setSaltValue(String saltValue) |
void |
setScalWithDoc(boolean flag) |
void |
setSelected(boolean value)
Sets a flag indicating whether this sheet is selected.
|
void |
setSpinCount(String spinCount) |
void |
setTabColor(int colorIndex)
Set background color of the sheet tab
|
void |
setVerticallyCenter(boolean value)
Whether the output is vertically centered on the page.
|
void |
setZoom(int scale)
Window zoom magnification for current view representing percent values.
|
void |
setZoom(int numerator,
int denominator)
Sets the zoom magnication 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.
|
void |
showInPane(short toprow,
short leftcol)
Location of the top left visible cell Location of the top left visible cell in the bottom right
pane (when in Left-to-Right mode).
|
void |
ungroupColumn(int fromColumn,
int toColumn)
Ungroup a range of columns that were previously groupped
|
void |
ungroupRow(int fromRow,
int toRow)
Ungroup a range of rows that were previously groupped
|
protected void |
write(OutputStream out) |
addRelation, clearMemoryPackagePart, createRelationship, createRelationship, createRelationship, getPackagePart, getPackageRelationship, getParent, getRelationById, getRelationCounter, getRelationId, getRelations, getTargetPart, onDocumentRemove, onSave, read, rebase, removeRelation, removeRelation, toString
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
forEach, spliterator
protected org.openxmlformats.schemas.spreadsheetml.x2006.main.CTSheet sheet
protected org.openxmlformats.schemas.spreadsheetml.x2006.main.CTWorksheet worksheet
protected List<XSSFHyperlink> hyperlinks
protected XSSFSheet()
XSSFWorkbook.createSheet()
protected XSSFSheet(PackagePart part, PackageRelationship rel)
part
- - The package part that holds xml data represenring this sheet.rel
- - the relationship of the given package part in the underlying OPC packagepublic XSSFWorkbook getWorkbook()
getWorkbook
in interface Sheet
protected void onDocumentRead()
onDocumentRead
in class POIXMLDocumentPart
protected void read(InputStream is) throws IOException
IOException
protected void onDocumentCreate()
onDocumentCreate
in class POIXMLDocumentPart
@Internal public org.openxmlformats.schemas.spreadsheetml.x2006.main.CTWorksheet getCTWorksheet()
public ColumnHelper getColumnHelper()
public String getSheetName()
getSheetName
in interface Sheet
public int addMergedRegion(CellRangeAddress region)
addMergedRegion
in interface Sheet
region
- (rowfrom/colfrom-rowto/colto) to mergepublic void autoSizeColumn(int column)
autoSizeColumn
in interface Sheet
column
- the column indexpublic void autoSizeColumn(int column, boolean useMergedCells)
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.autoSizeColumn
in interface Sheet
column
- the column indexuseMergedCells
- whether to use the contents of merged cells when calculating the width of the columnpublic XSSFDrawing createDrawingPatriarch()
createDrawingPatriarch
in interface Sheet
protected XSSFVMLDrawing getVMLDrawing(boolean autoCreate)
autoCreate
- if true, then a new VML drawing part is creatednull
if the drawing was not found and autoCreate=falseprotected org.openxmlformats.schemas.spreadsheetml.x2006.main.CTDrawing getCTDrawing()
protected org.openxmlformats.schemas.spreadsheetml.x2006.main.CTLegacyDrawing getCTLegacyDrawing()
public void createFreezePane(int colSplit, int rowSplit)
createFreezePane
in interface Sheet
colSplit
- Horizonatal position of split.rowSplit
- Vertical position of split.public void createFreezePane(int colSplit, int rowSplit, int leftmostColumn, int topRow)
If both colSplit and rowSplit are zero then the existing freeze pane is removed
createFreezePane
in interface Sheet
colSplit
- Horizonatal position of split.rowSplit
- Vertical position of split.leftmostColumn
- Left column visible in right pane.topRow
- Top row visible in bottom pane@Deprecated public XSSFComment createComment()
(org.zkoss.poi.ss.usermodel.ClientAnchor)
insteadpublic XSSFRow createRow(int rownum)
createRow
in interface Sheet
rownum
- row numberXSSFRow
object representing a row in the sheetremoveRow(org.zkoss.poi.ss.usermodel.Row)
public void createSplitPane(int xSplitPos, int ySplitPos, int leftmostColumn, int topRow, int activePane)
createSplitPane
in interface Sheet
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 paneleftmostColumn
- Left column visible in right pane.activePane
- Active pane. One of: PANE_LOWER_RIGHT,
PANE_UPPER_RIGHT, PANE_LOWER_LEFT, PANE_UPPER_LEFTSheet.PANE_LOWER_LEFT
,
Sheet.PANE_LOWER_RIGHT
,
Sheet.PANE_UPPER_LEFT
,
Sheet.PANE_UPPER_RIGHT
public XSSFComment getCellComment(int row, int column)
Sheet
getCellComment
in interface Sheet
null
if not foundpublic void removeCellComment(int row, int column)
public XSSFHyperlink getHyperlink(int row, int column)
public int[] getColumnBreaks()
getColumnBreaks
in interface Sheet
null
public int getColumnWidth(int columnIndex)
Actual column width measured as the number of characters of the maximum digit width of the numbers 0, 1, 2, ..., 9 as rendered in the normal style's font which includes 4 pixels of margin padding (two on each side), plus 1 pixel padding for the gridlines.
getColumnWidth
in interface Sheet
columnIndex
- - the column to set (0-based)public int getDefaultColumnWidth()
Note, this value is different from getColumnWidth(int)
. The latter is always greater and includes
4 pixels of margin padding (two on each side), plus 1 pixel padding for the gridlines.
getDefaultColumnWidth
in interface Sheet
public short getDefaultRowHeight()
getDefaultRowHeight
in interface Sheet
public float getDefaultRowHeightInPoints()
getDefaultRowHeightInPoints
in interface Sheet
public CellStyle getColumnStyle(int column)
getColumnStyle
in interface Sheet
public void setRightToLeft(boolean value)
setRightToLeft
in interface Sheet
value
- true for right to left, false otherwise.public boolean isRightToLeft()
isRightToLeft
in interface Sheet
public boolean getDisplayGuts()
getDisplayGuts
in interface Sheet
public void setDisplayGuts(boolean value)
setDisplayGuts
in interface Sheet
value
- - guts or no gutspublic boolean isDisplayZeros()
isDisplayZeros
in interface Sheet
public void setDisplayZeros(boolean value)
setDisplayZeros
in interface Sheet
value
- whether to display or hide all zero values on the worksheetpublic int getFirstRowNum()
getFirstRowNum
in interface Sheet
public boolean getFitToPage()
getFitToPage
in interface Sheet
true
public Footer getFooter()
getFirstFooter()
,
getOddFooter()
and
getEvenFooter()
public Header getHeader()
getFirstHeader()
,
getOddHeader()
and
getEvenHeader()
public Footer getOddFooter()
public Footer getEvenFooter()
getEvenFooter
in interface Sheet
public Footer getFirstFooter()
getFirstFooter
in interface Sheet
public Header getOddHeader()
public Header getEvenHeader()
getEvenHeader
in interface Sheet
public Header getFirstHeader()
getFirstHeader
in interface Sheet
public boolean getHorizontallyCenter()
getHorizontallyCenter
in interface Sheet
public int getLastRowNum()
Sheet
getLastRowNum
in interface Sheet
public short getLeftCol()
Sheet
getLeftCol
in interface Sheet
public double getMargin(short margin)
getMargin
in interface Sheet
margin
- which margin to getSheet.LeftMargin
,
Sheet.RightMargin
,
Sheet.TopMargin
,
Sheet.BottomMargin
,
Sheet.HeaderMargin
,
Sheet.FooterMargin
public void setMargin(short margin, double size)
setMargin
in interface Sheet
margin
- which margin to getsize
- the size of the marginSheet.LeftMargin
,
Sheet.RightMargin
,
Sheet.TopMargin
,
Sheet.BottomMargin
,
Sheet.HeaderMargin
,
Sheet.FooterMargin
public CellRangeAddress getMergedRegion(int index)
Sheet
getMergedRegion
in interface Sheet
IllegalStateException
- if this worksheet does not contain merged regionspublic int getNumMergedRegions()
getNumMergedRegions
in interface Sheet
public int getNumHyperlinks()
public PaneInformation getPaneInformation()
getPaneInformation
in interface Sheet
public int getPhysicalNumberOfRows()
getPhysicalNumberOfRows
in interface Sheet
public XSSFPrintSetup getPrintSetup()
getPrintSetup
in interface Sheet
public boolean getProtect()
getProtect
in interface Sheet
public void protectSheet(String password)
CTSheetProtection
that correspond to
the default values used by ExcelprotectSheet
in interface Sheet
password
- to set for protection. Pass null
to remove protectionpublic XSSFRow getRow(int rownum)
public int[] getRowBreaks()
getRowBreaks
in interface Sheet
null
public boolean getRowSumsBelow()
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.
getRowSumsBelow
in interface Sheet
true
if row summaries appear below detail in the outlinepublic void setRowSumsBelow(boolean value)
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.
setRowSumsBelow
in interface Sheet
value
- true
if row summaries appear below detail in the outlinepublic boolean getRowSumsRight()
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.
getRowSumsRight
in interface Sheet
true
if col summaries appear right of the detail in the outlinepublic void setRowSumsRight(boolean value)
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.
setRowSumsRight
in interface Sheet
value
- true
if col summaries appear right of the detail in the outlinepublic boolean getScenarioProtect()
getScenarioProtect
in interface Sheet
public short getTopRow()
public boolean getVerticallyCenter()
getVerticallyCenter
in interface Sheet
public void groupColumn(int fromColumn, int toColumn)
groupColumn
in interface Sheet
fromColumn
- beginning of the column range.toColumn
- end of the column range.public void groupRow(int fromRow, int toRow)
public boolean isColumnBroken(int column)
isColumnBroken
in interface Sheet
column
- FIXME: Document this!public boolean isColumnHidden(int columnIndex)
isColumnHidden
in interface Sheet
columnIndex
- - the column to set (0-based)false
if the column is visiblepublic boolean isDisplayFormulas()
isDisplayFormulas
in interface Sheet
true
if this sheet should display formulas.public boolean isDisplayGridlines()
isDisplayGridlines
in interface Sheet
true
if this sheet displays gridlines.to check if printing of gridlines is turned on or off
public void setDisplayGridlines(boolean show)
setPrintGridlines(boolean)
setDisplayGridlines
in interface Sheet
show
- true
if this sheet should display gridlines.setPrintGridlines(boolean)
public boolean isDisplayRowColHeadings()
Row heading are the row numbers to the side of the sheet
Column heading are the letters or numbers that appear above the columns of the sheet
isDisplayRowColHeadings
in interface Sheet
true
if this sheet should display row and column headings.public void setDisplayRowColHeadings(boolean show)
Row heading are the row numbers to the side of the sheet
Column heading are the letters or numbers that appear above the columns of the sheet
setDisplayRowColHeadings
in interface Sheet
show
- true
if this sheet should display row and column headings.public boolean isPrintGridlines()
isPrintGridlines
in interface Sheet
to check if printing of gridlines is turned on or off
public void setPrintGridlines(boolean value)
setPrintGridlines
in interface Sheet
value
- boolean to turn on or off the printing of gridlinesSheet.setPrintGridlines(boolean)
public boolean isRowBroken(int row)
isRowBroken
in interface Sheet
row
- index of the row to testtrue
if there is a page break at the indicated rowpublic void setRowBreak(int row)
sheet.setColumnBreak(2);
breaks the sheet into two parts
with columns A,B,C in the first and D,E,... in the second. Simuilar, sheet.setRowBreak(2);
breaks the sheet into two parts with first three rows (rownum=1...3) in the first part
and rows starting with rownum=4 in the second.setRowBreak
in interface Sheet
row
- the row to break, inclusivepublic void removeColumnBreak(int column)
removeColumnBreak
in interface Sheet
public void removeMergedRegion(int index)
removeMergedRegion
in interface Sheet
index
- of the region to unmergepublic void removeRow(Row row)
public void removeRowBreak(int row)
removeRowBreak
in interface Sheet
public void setForceFormulaRecalculation(boolean value)
Calculating the formula values with FormulaEvaluator
is the
recommended solution, but this may be used for certain cases where
evaluation in POI is not possible.
It is recommended to force recalcuation of formulas on workbook level using
Workbook.setForceFormulaRecalculation(boolean)
to ensure that all cross-worksheet formuals and external dependencies are updated.
setForceFormulaRecalculation
in interface Sheet
value
- true if the application will perform a full recalculation of
this worksheet values when the workbook is openedWorkbook.setForceFormulaRecalculation(boolean)
public boolean getForceFormulaRecalculation()
getForceFormulaRecalculation
in interface Sheet
public Iterator<Row> rowIterator()
Sheet
rowIterator
in interface Sheet
public Iterator<Row> iterator()
rowIterator()
to
allow foreach loopspublic boolean getAutobreaks()
getAutobreaks
in interface Sheet
true
if the sheet displays Automatic Page Breaks.public void setAutobreaks(boolean value)
setAutobreaks
in interface Sheet
value
- true
if the sheet displays Automatic Page Breaks.public void setColumnBreak(int column)
sheet.setColumnBreak(2);
breaks the sheet into two parts
with columns A,B,C in the first and D,E,... in the second. Simuilar, sheet.setRowBreak(2);
breaks the sheet into two parts with first three rows (rownum=1...3) in the first part
and rows starting with rownum=4 in the second.setColumnBreak
in interface Sheet
column
- the column to break, inclusivepublic void setColumnGroupCollapsed(int columnNumber, boolean collapsed)
Sheet
setColumnGroupCollapsed
in interface Sheet
columnNumber
- One of the columns in the group.collapsed
- true = collapse group, false = expand group.public void setColumnHidden(int columnIndex, boolean hidden)
setColumnHidden
in interface Sheet
columnIndex
- - the column to get (0-based)hidden
- - the visiblity state of the columnpublic void setColumnWidth(int columnIndex, int width)
The maximum column width for an individual cell is 255 characters. This value represents the number of characters that can be displayed in a cell that is formatted with the standard font (first font in the workbook).
Character width is defined as the maximum digit width
of the numbers 0, 1, 2, ... 9
as rendered
using the default font (first font in the workbook).
Unless you are using a very special font, the default character is '0' (zero),
this is true for Arial (default font font in HSSF) and Calibri (default font in XSSF)
Please note, that the width set by this method includes 4 pixels of margin padding (two on each side), plus 1 pixel padding for the gridlines (Section 3.3.1.12 of the OOXML spec). This results is a slightly less value of visible characters than passed to this method (approx. 1/2 of a character).
To compute the actual number of visible characters, Excel uses the following formula (Section 3.3.1.12 of the OOXML spec):
width = Truncate([{Number of Visible Characters} *
{Maximum Digit Width} + {5 pixel padding}]/{Maximum Digit Width}*256)/256
Using the Calibri font as an example, the maximum digit width of 11 point font size is 7 pixels (at 96 dpi).
If you set a column width to be eight characters wide, e.g. setColumnWidth(columnIndex, 8*256)
,
then the actual value of visible characters (the value shown in Excel) is derived from the following equation:
Truncate([numChars*7+5]/7*256)/256 = 8;
which gives 7.29
.
setColumnWidth
in interface Sheet
columnIndex
- - the column to set (0-based)width
- - the width in units of 1/256th of a character widthIllegalArgumentException
- if width > 255*256 (the maximum column width in Excel is 255 characters)public void setDefaultColumnStyle(int column, CellStyle style)
Sheet
setDefaultColumnStyle
in interface Sheet
column
- the column indexstyle
- the style to setpublic void setDefaultColumnWidth(int width)
setDefaultColumnWidth
in interface Sheet
width
- the number of characters. Default value is 8
.public void setDefaultRowHeight(short height)
setDefaultRowHeight
in interface Sheet
height
- default row height in twips (1/20 of a point)public void setDefaultRowHeightInPoints(float height)
setDefaultRowHeightInPoints
in interface Sheet
height
- default row height measured in point size.public void setDisplayFormulas(boolean show)
setDisplayFormulas
in interface Sheet
show
- true
if this sheet should display formulas.public void setFitToPage(boolean b)
setFitToPage
in interface Sheet
b
- true
if the Fit to Page print option is enabled.public void setHorizontallyCenter(boolean value)
setHorizontallyCenter
in interface Sheet
value
- whether to center on page horizontally when printing.public void setVerticallyCenter(boolean value)
setVerticallyCenter
in interface Sheet
value
- true to vertically center, false otherwise.public void setRowGroupCollapsed(int rowIndex, boolean collapse)
setRowGroupCollapsed
in interface Sheet
rowIndex
- -
the row involved, 0 basedcollapse
- -
boolean value for collapsepublic int findEndOfRowOutlineGroup(int row)
row
- the zero based row index to find frompublic void setZoom(int numerator, int denominator)
setZoom
in interface Sheet
numerator
- The numerator for the zoom magnification.denominator
- The denominator for the zoom magnification.setZoom(int)
public void setZoom(int scale)
10 - 10% 20 - 20% ... 100 - 100% ... 400 - 400%Current view can be Normal, Page Layout, or Page Break Preview.
scale
- window zoom magnificationIllegalArgumentException
- if scale is invalidpublic void shiftRows(int startRow, int endRow, int n)
Additionally shifts merged regions that are completely defined in these rows (ie. merged 2 cells on a row to be shifted).
public void shiftRows(int startRow, int endRow, int n, boolean copyRowHeight, boolean resetOriginalRowHeight)
Additionally shifts merged regions that are completely defined in these rows (ie. merged 2 cells on a row to be shifted).
shiftRows
in interface Sheet
startRow
- the row to start shiftingendRow
- the row to end shiftingn
- the number of rows to shiftcopyRowHeight
- whether to copy the row height during the shiftresetOriginalRowHeight
- whether to set the original row's height to the defaultpublic void showInPane(short toprow, short leftcol)
showInPane
in interface Sheet
toprow
- the top row to show in desktop window paneleftcol
- the left column to show in desktop window panepublic void ungroupColumn(int fromColumn, int toColumn)
Sheet
ungroupColumn
in interface Sheet
fromColumn
- start column (0-based)toColumn
- end column (0-based)public void ungroupRow(int fromRow, int toRow)
ungroupRow
in interface Sheet
fromRow
- start row (0-based)toRow
- end row (0-based)public boolean isSelected()
When only 1 sheet is selected and active, this value should be in synch with the activeTab value. In case of a conflict, the Start Part setting wins and sets the active sheet tab.
Note: multiple sheets can be selected, but only one sheet can be active at one time.isSelected
in interface Sheet
true
if this sheet is selectedpublic void setSelected(boolean value)
When only 1 sheet is selected and active, this value should be in synch with the activeTab value. In case of a conflict, the Start Part setting wins and sets the active sheet tab.
Note: multiple sheets can be selected, but only one sheet can be active at one time.setSelected
in interface Sheet
value
- true
if this sheet is selectedWorkbook.setActiveSheet(int)
@Deprecated public static void setCellComment(String cellRef, XSSFComment comment)
XSSFCell.setCellComment(org.zkoss.poi.ss.usermodel.Comment)
insteadcellRef
- cell regioncomment
- the comment to assign@Internal public void addHyperlink(XSSFHyperlink hyperlink)
hyperlink
- the link to addpublic String getActiveCell()
A1
.public void setActiveCell(String cellRef)
cellRef
- the location of the active cell, e.g. A1
..public boolean hasComments()
protected int getNumberOfComments()
protected CommentsTable getCommentsTable(boolean create)
create
- create a new comments table if it does not existprotected void commit() throws IOException
POIXMLDocumentPart
protected void commit() throws IOException {
PackagePart part = getPackagePart();
OutputStream out = part.getOutputStream();
XmlObject bean = getXmlBean(); //the "model" which holds changes in memory
bean.save(out, DEFAULT_XML_OPTIONS);
out.close();
}
commit
in class POIXMLDocumentPart
IOException
protected void write(OutputStream out) throws IOException
IOException
public boolean isAutoFilterLocked()
public boolean isDeleteColumnsLocked()
public boolean isDeleteRowsLocked()
public boolean isFormatCellsLocked()
public boolean isFormatColumnsLocked()
public boolean isFormatRowsLocked()
public boolean isInsertColumnsLocked()
public boolean isInsertHyperlinksLocked()
public boolean isInsertRowsLocked()
public boolean isPivotTablesLocked()
public boolean isSortLocked()
public boolean isObjectsLocked()
public boolean isScenariosLocked()
public boolean isSelectLockedCellsLocked()
public boolean isSelectUnlockedCellsLocked()
public boolean isSheetLocked()
public void enableLocking()
public void disableLocking()
public void lockAutoFilter()
enableLocking()
public void lockDeleteColumns()
enableLocking()
public void lockDeleteRows()
enableLocking()
public void lockFormatCells()
enableLocking()
public void lockFormatColumns()
enableLocking()
public void lockFormatRows()
enableLocking()
public void lockInsertColumns()
enableLocking()
public void lockInsertHyperlinks()
enableLocking()
public void lockInsertRows()
enableLocking()
public void lockPivotTables()
enableLocking()
public void lockSort()
enableLocking()
public void lockObjects()
enableLocking()
public void lockScenarios()
enableLocking()
public void lockSelectLockedCells()
enableLocking()
public void lockSelectUnlockedCells()
enableLocking()
public CellRange<XSSFCell> setArrayFormula(String formula, CellRangeAddress range)
Sheet
setArrayFormula
in interface Sheet
formula
- text representation of the formularange
- Region of array formula for result.CellRange
of cells affected by this changepublic CellRange<XSSFCell> removeArrayFormula(Cell cell)
Sheet
removeArrayFormula
in interface Sheet
cell
- any cell within Array Formula rangeCellRange
of cells affected by this changepublic DataValidationHelper getDataValidationHelper()
getDataValidationHelper
in interface Sheet
public List<DataValidation> getDataValidations()
getDataValidations
in interface Sheet
public void addValidationData(DataValidation dataValidation)
Sheet
addValidationData
in interface Sheet
dataValidation
- The Data validation object settingspublic XSSFTable createTable()
public XSSFSheetConditionalFormatting getSheetConditionalFormatting()
Sheet
getSheetConditionalFormatting
in interface Sheet
public void setTabColor(int colorIndex)
colorIndex
- the indexed color to set, must be a constant from IndexedColors
public CellRangeAddress getRepeatingRows()
Sheet
Sheet1!$1:$1 Sheet2!$5:$8The
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.getRepeatingRows
in interface Sheet
CellRangeAddress
containing the repeating rows for the
Sheet, or null.public CellRangeAddress getRepeatingColumns()
Sheet
Sheet1!$A:$A Sheet2!$C:$FThe
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.getRepeatingColumns
in interface Sheet
CellRangeAddress
containing the repeating columns for
the Sheet, or null.public void setRepeatingRows(CellRangeAddress rowRangeRef)
Sheet
Sheet1!$1:$1 Sheet2!$5:$8The 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);
setRepeatingRows
in interface Sheet
rowRangeRef
- a CellRangeAddress
containing the repeating
rows for the Sheet, or null.public void setRepeatingColumns(CellRangeAddress columnRangeRef)
Sheet
Sheet1!$A:$A Sheet2!$C:$FThe 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);
setRepeatingColumns
in interface Sheet
columnRangeRef
- a CellRangeAddress
containing the repeating
columns for the Sheet, or null.public boolean isAutoFilterMode()
isAutoFilterMode
in interface Sheet
true
if the sheet already has an autofilterpublic CellRangeAddress removeAutoFilter()
Sheet
removeAutoFilter
in interface Sheet
CellRange
of cells affected by this changepublic AutoFilter getAutoFilter()
Sheet
getAutoFilter
in interface Sheet
public void setAutoFilterMode(boolean b)
b
- false to remove current AutoFilter; set true is ignored.public boolean isFilterMode()
public void removeValidationData(DataValidation dataValidation)
removeValidationData
in interface Sheet
public AutoFilter setAutoFilter(CellRangeAddress range)
Sheet
setAutoFilter
in interface Sheet
range
- the range of cells to filterpublic DataValidation getDataValidation(int row, int col)
getDataValidation
in interface Sheet
public List<PivotTable> getPivotTables()
getPivotTables
in interface Sheet
public PivotTable createPivotTable(CellReference destination, String name, PivotCache pivotCache)
createPivotTable
in interface Sheet
public boolean isColumnCustom(int columnIndex)
isColumnCustom
in interface Sheet
public SheetProtection getOrCreateSheetProtection()
getOrCreateSheetProtection
in interface Sheet
public void setPasswordHash(short hashpass)
public short getPasswordHash()
public boolean isDiffOddEven()
isDiffOddEven
in interface Sheet
public void setDiffOddEven(boolean flag)
setDiffOddEven
in interface Sheet
public boolean isDiffFirst()
isDiffFirst
in interface Sheet
public void setDiffFirst(boolean flag)
setDiffFirst
in interface Sheet
public boolean isScaleWithDoc()
isScaleWithDoc
in interface Sheet
public void setScalWithDoc(boolean flag)
setScalWithDoc
in interface Sheet
public boolean isAlignMargins()
isAlignMargins
in interface Sheet
public void setAlignMargins(boolean flag)
setAlignMargins
in interface Sheet
public boolean isPrintHeadings()
isPrintHeadings
in interface Sheet
public void setPrintHeadings(boolean value)
setPrintHeadings
in interface Sheet
value
- boolean to turn on or off the printing of gridlinespublic double getXssfDefaultColumnWidth()
public XSSFTable getTableByRowCol(int rowIdx, int colIdx)
public String getHashValue()
public void setHashValue(String hashValue)
public String getSaltValue()
public void setSaltValue(String saltValue)
public String getSpinCount()
public void setSpinCount(String spinCount)
public String getAlgName()
public void setAlgName(String algName)
public double getXssfDefaultColumnWidthPerBaseColWidth(int baseWidth)
public List<XSSFConditionalFormatting> getConditionalFormattings()
public void addCondtionalFormatting(XSSFConditionalFormatting cf)
Copyright © 2020. All rights reserved.