|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectorg.apache.poi.POIXMLDocumentPart
org.apache.poi.xssf.usermodel.XSSFSheet
public class XSSFSheet
High level representation of a SpreadsheetML worksheet.
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.
| Field Summary | |
|---|---|
protected org.openxmlformats.schemas.spreadsheetml.x2006.main.CTSheet |
sheet
|
protected org.openxmlformats.schemas.spreadsheetml.x2006.main.CTWorksheet |
worksheet
|
| Fields inherited from class org.apache.poi.POIXMLDocumentPart |
|---|
DEFAULT_XML_OPTIONS |
| Fields inherited from interface org.apache.poi.ss.usermodel.Sheet |
|---|
BottomMargin, FooterMargin, HeaderMargin, LeftMargin, PANE_LOWER_LEFT, PANE_LOWER_RIGHT, PANE_UPPER_LEFT, PANE_UPPER_RIGHT, RightMargin, TopMargin |
| Constructor Summary | |
|---|---|
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. |
| Method Summary | |
|---|---|
int |
addMergedRegion(CellRangeAddress cra)
Adds a merged region of cells (hence those cells form one). |
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()
Creates a new comment for this sheet. |
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). |
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. |
int |
findEndOfRowOutlineGroup(int row)
|
java.lang.String |
getActiveCell()
Return location of the active cell, e.g. |
boolean |
getAutobreaks()
Flag indicating whether the sheet displays Automatic Page Breaks. |
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()
Returns the sheet's comments object if there is one, or null if not |
org.openxmlformats.schemas.spreadsheetml.x2006.main.CTWorksheet |
getCTWorksheet()
Provide access to the CTWorksheet bean holding this sheet's data |
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. |
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. |
PaneInformation |
getPaneInformation()
Returns the information regarding the currently configured pane (split or freeze). |
int |
getPhysicalNumberOfRows()
Returns the number of phsyically defined rows (NOT the number of rows in the sheet) |
XSSFPrintSetup |
getPrintSetup()
Gets the print setup object. |
boolean |
getProtect()
Answer whether protection is enabled or disabled |
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. |
boolean |
getRowSumsBelow()
Flag indicating whether summary rows appear below detail in an outline, when applying an outline. |
boolean |
getRowSumsRight()
Flag indicating whether summary columns appear to the right of detail in an outline, when applying an outline. |
boolean |
getScenarioProtect()
A flag indicating whether scenarios are locked when the sheet is protected. |
java.lang.String |
getSheetName()
Returns the name of 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. |
XSSFWorkbook |
getWorkbook()
Returns the parent XSSFWorkbook |
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 |
isColumnBroken(int column)
Determines if there is a page break at the indicated column |
boolean |
isColumnHidden(int columnIndex)
Get the hidden state for a given column. |
boolean |
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 |
isPrintGridlines()
Returns whether gridlines are printed. |
boolean |
isRowBroken(int row)
Tests if there is a page break at the indicated row |
boolean |
isSelected()
Returns a flag indicating whether this sheet is selected. |
java.util.Iterator<Row> |
iterator()
Alias for rowIterator() to
allow foreach loops |
protected void |
onDocumentCreate()
Initialize worksheet data when creating a new sheet. |
protected void |
onDocumentRead()
Initialize worksheet data when reading in an exisiting file. |
protected void |
read(java.io.InputStream is)
|
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 |
java.util.Iterator<Row> |
rowIterator()
Returns an iterator of the physical rows |
void |
setActiveCell(java.lang.String cellRef)
Sets location of the active cell |
void |
setAutobreaks(boolean value)
Flag indicating whether the sheet displays Automatic Page Breaks. |
void |
setCellComment(java.lang.String cellRef,
XSSFComment comment)
Assign a cell comment to a cell region in this worksheet |
protected void |
setCellHyperlink(XSSFHyperlink hyperlink)
|
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 |
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 |
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 |
setRowBreak(int row)
Sets a page break at the indicated row |
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 |
setRowSumsRight(boolean value)
Flag indicating whether summary columns appear to the right of detail in an outline, when applying an outline. |
void |
setSelected(boolean value)
Sets a flag indicating whether this sheet is selected. |
void |
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(java.io.OutputStream out)
|
| Methods inherited from class org.apache.poi.POIXMLDocumentPart |
|---|
addRelation, createRelationship, createRelationship, createRelationship, getPackagePart, getPackageRelationship, getParent, getRelations, onSave, read, removeRelation, toString |
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
| Field Detail |
|---|
protected org.openxmlformats.schemas.spreadsheetml.x2006.main.CTSheet sheet
protected org.openxmlformats.schemas.spreadsheetml.x2006.main.CTWorksheet worksheet
| Constructor Detail |
|---|
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 package| Method Detail |
|---|
public XSSFWorkbook getWorkbook()
getWorkbook in interface Sheetprotected void onDocumentRead()
onDocumentRead in class POIXMLDocumentPart
protected void read(java.io.InputStream is)
throws java.io.IOException
java.io.IOExceptionprotected void onDocumentCreate()
onDocumentCreate in class POIXMLDocumentPartpublic org.openxmlformats.schemas.spreadsheetml.x2006.main.CTWorksheet getCTWorksheet()
public ColumnHelper getColumnHelper()
public java.lang.String getSheetName()
getSheetName in interface Sheetpublic int addMergedRegion(CellRangeAddress cra)
addMergedRegion in interface Sheetcra - (rowfrom/colfrom-rowto/colto) to merge
public void autoSizeColumn(int column)
autoSizeColumn in interface Sheetcolumn - the column index
public 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 Sheetcolumn - the column indexuseMergedCells - whether to use the contents of merged cells when calculating the width of the columnpublic XSSFDrawing createDrawingPatriarch()
createDrawingPatriarch in interface Sheet
public void createFreezePane(int colSplit,
int rowSplit)
createFreezePane in interface SheetcolSplit - Horizonatal position of split.rowSplit - Vertical position of split.
public void createFreezePane(int colSplit,
int rowSplit,
int leftmostColumn,
int topRow)
createFreezePane in interface SheetcolSplit - Horizonatal position of split.rowSplit - Vertical position of split.topRow - Top row visible in bottom paneleftmostColumn - Left column visible in right pane.public XSSFComment createComment()
public XSSFRow createRow(int rownum)
createRow in interface Sheetrownum - row number
XSSFRow object representing a row in the sheetremoveRow(org.apache.poi.ss.usermodel.Row)
public void createSplitPane(int xSplitPos,
int ySplitPos,
int leftmostColumn,
int topRow,
int activePane)
createSplitPane in interface SheetxSplitPos - 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 Sheetnull if not found
public XSSFHyperlink getHyperlink(int row,
int column)
public int[] getColumnBreaks()
getColumnBreaks in interface Sheetnullpublic int getColumnWidth(int columnIndex)
Note, the returned value is always gerater that getDefaultColumnWidth() because the latter does not include margins.
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. There are 4 pixels of margin
padding (two on each side), plus 1 pixel padding for the gridlines.
getColumnWidth in interface SheetcolumnIndex - - 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 Sheetpublic short getDefaultRowHeight()
getDefaultRowHeight in interface Sheetpublic float getDefaultRowHeightInPoints()
getDefaultRowHeightInPoints in interface Sheetpublic CellStyle getColumnStyle(int column)
getColumnStyle in interface Sheetpublic boolean getDisplayGuts()
getDisplayGuts in interface Sheetpublic void setDisplayGuts(boolean value)
setDisplayGuts in interface Sheetvalue - - guts or no gutspublic boolean isDisplayZeros()
isDisplayZeros in interface Sheetpublic void setDisplayZeros(boolean value)
setDisplayZeros in interface Sheetvalue - whether to display or hide all zero values on the worksheetpublic int getFirstRowNum()
getFirstRowNum in interface Sheetpublic boolean getFitToPage()
getFitToPage in interface Sheettruepublic Footer getFooter()
getFirstFooter(),
getOddFooter() and
getEvenFooter()
getFooter in interface Sheetnullpublic Header getHeader()
getFirstHeader(),
getOddHeader() and
getEvenHeader()
getHeader in interface Sheetnullpublic Footer getOddFooter()
public Footer getEvenFooter()
public Footer getFirstFooter()
public Header getOddHeader()
public Header getEvenHeader()
public Header getFirstHeader()
public boolean getHorizontallyCenter()
getHorizontallyCenter in interface Sheetpublic int getLastRowNum()
Sheet
getLastRowNum in interface Sheetpublic short getLeftCol()
Sheet
getLeftCol in interface Sheetpublic double getMargin(short margin)
getMargin in interface Sheetmargin - which margin to get
Sheet.LeftMargin,
Sheet.RightMargin,
Sheet.TopMargin,
Sheet.BottomMargin,
Sheet.HeaderMargin,
Sheet.FooterMargin
public void setMargin(short margin,
double size)
setMargin in interface Sheetmargin - which margin to getsize - the size of the marginSheet.LeftMargin,
Sheet.RightMargin,
Sheet.TopMargin,
Sheet.BottomMargin,
Sheet.HeaderMargin,
Sheet.FooterMarginpublic CellRangeAddress getMergedRegion(int index)
Sheet
getMergedRegion in interface Sheetjava.lang.IllegalStateException - if this worksheet does not contain merged regionspublic int getNumMergedRegions()
getNumMergedRegions in interface Sheetpublic int getNumHyperlinks()
public PaneInformation getPaneInformation()
getPaneInformation in interface Sheetpublic int getPhysicalNumberOfRows()
getPhysicalNumberOfRows in interface Sheetpublic XSSFPrintSetup getPrintSetup()
getPrintSetup in interface Sheetpublic boolean getProtect()
getProtect in interface Sheetpublic XSSFRow getRow(int rownum)
getRow in interface Sheetrownum - row to get
XSSFRow representing the rownumber or null if its not defined on the sheetpublic int[] getRowBreaks()
getRowBreaks in interface Sheetnullpublic 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 Sheettrue 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 Sheetvalue - 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 Sheettrue 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 Sheetvalue - true if col summaries appear right of the detail in the outlinepublic boolean getScenarioProtect()
getScenarioProtect in interface Sheetpublic short getTopRow()
getTopRow in interface Sheetpublic boolean getVerticallyCenter()
getVerticallyCenter in interface Sheet
public void groupColumn(int fromColumn,
int toColumn)
groupColumn in interface SheetfromColumn - beginning of the column range.toColumn - end of the column range.
public void groupRow(int fromRow,
int toRow)
groupRow in interface SheetfromRow - start row (0-based)toRow - end row (0-based)public boolean isColumnBroken(int column)
isColumnBroken in interface Sheetcolumn - FIXME: Document this!
public boolean isColumnHidden(int columnIndex)
isColumnHidden in interface SheetcolumnIndex - - the column to set (0-based)
false if the column is visiblepublic boolean isDisplayFormulas()
isDisplayFormulas in interface Sheettrue if this sheet should display formulas.public boolean isDisplayGridlines()
isDisplayGridlines in interface Sheettrue if this sheet displays gridlines.to check if printing of gridlines is turned on or offpublic void setDisplayGridlines(boolean show)
setPrintGridlines(boolean)
setDisplayGridlines in interface Sheetshow - 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 Sheettrue 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 Sheetshow - true if this sheet should display row and column headings.public boolean isPrintGridlines()
isPrintGridlines in interface Sheetto check if printing of gridlines is turned on or offpublic void setPrintGridlines(boolean value)
setPrintGridlines in interface Sheetvalue - boolean to turn on or off the printing of gridlinesSheet.setPrintGridlines(boolean)public boolean isRowBroken(int row)
isRowBroken in interface Sheetrow - index of the row to test
true if there is a page break at the indicated rowpublic void setRowBreak(int row)
setRowBreak in interface Sheetrow - FIXME: Document this!public void removeColumnBreak(int column)
removeColumnBreak in interface Sheetpublic void removeMergedRegion(int index)
removeMergedRegion in interface Sheetindex - of the region to unmergepublic void removeRow(Row row)
removeRow in interface Sheetrow - the row to remove.public void removeRowBreak(int row)
removeRowBreak in interface Sheetpublic java.util.Iterator<Row> rowIterator()
Sheet
rowIterator in interface Sheetpublic java.util.Iterator<Row> iterator()
rowIterator() to
allow foreach loops
iterator in interface java.lang.Iterable<Row>public boolean getAutobreaks()
getAutobreaks in interface Sheettrue if the sheet displays Automatic Page Breaks.public void setAutobreaks(boolean value)
setAutobreaks in interface Sheetvalue - true if the sheet displays Automatic Page Breaks.public void setColumnBreak(int column)
setColumnBreak in interface Sheetcolumn - the column to break
public void setColumnGroupCollapsed(int columnNumber,
boolean collapsed)
Sheet
setColumnGroupCollapsed in interface SheetcolumnNumber - One of the columns in the group.collapsed - true = collapse group, false = expand group.
public void setColumnHidden(int columnIndex,
boolean hidden)
setColumnHidden in interface SheetcolumnIndex - - the column to get (0-based)hidden - - the visiblity state of the column
public 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.
setColumnWidth in interface SheetcolumnIndex - - the column to set (0-based)width - - the width in units of 1/256th of a character width
java.lang.IllegalArgumentException - if width > 65536 (the maximum column width in Excel)
public void setDefaultColumnStyle(int column,
CellStyle style)
Sheet
setDefaultColumnStyle in interface Sheetcolumn - the column indexstyle - the style to setpublic void setDefaultColumnWidth(int width)
setDefaultColumnWidth in interface Sheetwidth - the number of characters. Default value is 8.public void setDefaultRowHeight(short height)
setDefaultRowHeight in interface Sheetheight - default row height in twips (1/20 of a point)public void setDefaultRowHeightInPoints(float height)
setDefaultRowHeightInPoints in interface Sheetheight - default row height measured in point size.public void setDisplayFormulas(boolean show)
setDisplayFormulas in interface Sheetshow - true if this sheet should display formulas.public void setFitToPage(boolean b)
setFitToPage in interface Sheetb - true if the Fit to Page print option is enabled.public void setHorizontallyCenter(boolean value)
setHorizontallyCenter in interface Sheetvalue - whether to center on page horizontally when printing.public void setVerticallyCenter(boolean value)
setVerticallyCenter in interface Sheetvalue - true to vertically center, false otherwise.
public void setRowGroupCollapsed(int rowIndex,
boolean collapse)
setRowGroupCollapsed in interface SheetrowIndex - -
the row involved, 0 basedcollapse - -
boolean value for collapsepublic int findEndOfRowOutlineGroup(int row)
rowIndex - the zero based row index to find from
public void setZoom(int numerator,
int denominator)
setZoom in interface Sheetnumerator - 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 magnification
java.lang.IllegalArgumentException - if scale is invalid
public 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).
shiftRows in interface SheetstartRow - the row to start shiftingendRow - the row to end shiftingn - the number of rows to shift
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 SheetstartRow - 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 default
public void showInPane(short toprow,
short leftcol)
showInPane in interface Sheettoprow - the top row to show in desktop window paneleftcol - the left column to show in desktop window pane
public void ungroupColumn(int fromColumn,
int toColumn)
Sheet
ungroupColumn in interface SheetfromColumn - start column (0-based)toColumn - end column (0-based)
public void ungroupRow(int fromRow,
int toRow)
ungroupRow in interface SheetfromRow - 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 Sheettrue 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 Sheetvalue - true if this sheet is selectedWorkbook.setActiveSheet(int)
public void setCellComment(java.lang.String cellRef,
XSSFComment comment)
cellRef - cell regioncomment - the comment to assignprotected void setCellHyperlink(XSSFHyperlink hyperlink)
public java.lang.String getActiveCell()
A1.
public void setActiveCell(java.lang.String cellRef)
cellRef - the location of the active cell, e.g. A1..public boolean hasComments()
protected int getNumberOfComments()
protected CommentsTable getCommentsTable()
protected void commit()
throws java.io.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 POIXMLDocumentPartjava.io.IOException
protected void write(java.io.OutputStream out)
throws java.io.IOException
java.io.IOException
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||