![]() |
||
Home Products Purchase Downloads Demos Forums Blogs Ticket Wiki API Corporate |
|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.aspose.cells.Worksheet
public final class Worksheet
Represents a worksheet.
Method Summary | |
---|---|
void |
addPageBreaks(int row,
int column)
Adds a page break to the worksheet. |
void |
addPageBreaks(java.lang.String cellName)
Adds a page break to the worksheet. |
void |
deleteColumns(int startIndex,
int deletedColumns,
boolean bShift)
Removes columns from the worksheet. |
void |
deleteRows(int startIndex,
int deletedRows,
boolean bShift)
Removes rows from the worksheet. |
void |
freezePanes(int row,
int column,
int freezedRows,
int freezedColumns)
Freezes panes at the specified cell in the worksheet. |
void |
freezePanes(java.lang.String cellName,
int freezedRows,
short freezedColumns)
Freezes panes at the specified cell in the worksheet. |
Cell |
getCell(int rowIndex,
int columnIndex)
Gets the cell object with the specified row index and column index. |
Cell |
getCell(java.lang.String cellName)
Gets the cell object by the cell name(like "A1"). |
Style |
getColumnStyle(int columnIndex)
Gets the style setting for the specified column. |
float |
getColumnWidth(int columnIndex)
Gets the width of the column at the given column index, in unit of characters using default font. |
ConditionalFormattings |
getConditionalFormattings()
Gets the ConditionalFormattings in the worksheet. |
float |
getDefaultColumnWidth()
Returns the default column width of the worksheet, in unit of characters with default font. |
float |
getDefaultRowHeight()
Gets the default row height of the worksheet in points. |
int |
getFirstRowIndex()
Returns the first defined row index. |
short |
getFirstVisibleColumn()
Gets first visible column index. |
int |
getFirstVisibleRow()
Gets first visible row index. |
HPageBreaks |
getHPageBreaks()
Get the HPageBreaks in the worksheet. |
Hyperlinks |
getHyperlinks()
Get the Hyperlinks in the worksheet. |
int |
getLastRowIndex()
Returns the last defined row index. |
java.util.ArrayList |
getMergedCells()
Gets the collection of merged cell ranges in the worksheet. |
java.lang.String |
getName()
Returns the name of the worksheet. |
PageSetup |
getPageSetup()
Get the page setup options in the worksheet. |
Protection |
getProtection()
Gets the current protection settings. |
Row |
getRow(int rowIndex)
Gets the row at the specified row index. |
java.util.Iterator |
getRowIterator()
Returns an iterator which can iterate all defined rows in this worksheet. |
Color |
getTabColor()
Gets the colour of the tab below the sheet containing the sheet name. |
short |
getType()
Returns the type of the worksheet. |
Validations |
getValidations()
Get the Validations in the worksheet. |
VPageBreaks |
getVPageBreaks()
Get the VPageBreaks in the worksheet. |
short |
getZoom()
Gets the scaling factor in percent. |
void |
groupColumns(int startIndex,
int endIndex)
Groups columns. |
void |
groupColumns(int startIndex,
int endIndex,
boolean isHidden)
Groups columns. |
void |
groupRows(int startIndex,
int endIndex)
Groups rows. |
void |
groupRows(int startIndex,
int endIndex,
boolean isHidden)
Groups rows. |
int |
importResultSet(java.sql.ResultSet rs,
int rowIndex,
int columnIndex,
boolean isFieldNameShown)
Imports data in a ResultSet object to the worksheet. |
int |
importResultSet(java.sql.ResultSet rs,
int rowIndex,
int columnIndex,
int rowNum,
int columnNum,
boolean isFieldNameShown)
Imports data in a ResultSet object to the worksheet. |
int |
importResultSet(java.sql.ResultSet rs,
java.lang.String startCell,
boolean isFieldNameShown)
Imports data in a ResultSet object to the worksheet. |
int |
importResultSet(java.sql.ResultSet rs,
java.lang.String startCell,
int rowNum,
int columnNum,
boolean isFieldNameShown)
Imports data in a ResultSet object to the worksheet. |
void |
insertColumns(int columnIndex,
int columnNum)
Inserts multiple columns into the worksheet. |
void |
insertRows(int rowIndex,
int rowNum)
Inserts multiple rows into the worksheet. |
boolean |
isColumnHidden(int columnIndex)
Checks if the specified column is hidden. |
boolean |
isGridlinesVisible()
Gets if the the gride lines are visible. |
boolean |
isPageBreakPreview()
Indicates the specified worksheet is shown in normal view or page break preview. |
boolean |
isRowColumnHeadersVisible()
Gets whether the worksheet will display row and column headers. |
boolean |
isVisible()
Gets if the worksheet is visible. |
void |
protect(Protection protection)
Protects the worksheet. |
void |
removeCell(int rowIndex,
int columnIndex)
Removes a cell at the specified row index and column index from the worksheet. |
void |
removeCell(java.lang.String cellName)
Removes a cell from the worksheet by the cell name. |
void |
removeRow(int rowIndex)
Removes the row at the given position from the worksheet. |
void |
removeSplit()
Removes splitted window. |
void |
setColumnHidden(int columnIndex,
boolean isHidden)
Sets whether the specified column to be hidden or not. |
void |
setColumnStyle(short columnIndex,
Style style)
Sets a style to the specified column. |
void |
setColumnWidth(int columnIndex,
float columnWidth)
Sets the width of the specified column, in unit of characters using default font. |
void |
setDefaultColumnWidth(float defaultColumnWidth)
Sets the default column width of the worksheet, in unit of characters using default font. |
void |
setDefaultRowHeight(float defaultRowHeight)
Sets the default row height of the worksheet, in unit of points. |
void |
setFirstVisibleColumn(int column)
Sets first visible column index. |
void |
setFirstVisibleRow(int row)
Sets first visible row index. |
void |
setGridlinesVisible(boolean gridlinesVisible)
Sets whether the grid lines to be visible or not. |
void |
setName(java.lang.String name)
Sets the worksheet name. |
void |
setPageBreakPreview(boolean pageBreakPreview)
Sets the specified worksheet is shown in normal view or page break preview. |
void |
setRowColumnHeadersVisible(boolean rowColumnHeadersVisible)
Sets whether the worksheet will display row and column headers. |
void |
setStyle(int startRow,
int endRow,
int startColumn,
int endColumn,
Style style)
Sets a style for an area of cells. |
void |
setTabColor(Color tabColor)
Sets the colour of the tab below the sheet containing the sheet name. |
void |
setVisible(boolean visible)
Sets whether the worksheet to be visible or not. |
void |
setZoom(short zoom)
Sets the scaling factor in percent. |
void |
split()
Splits window. |
void |
unFreezePanes()
Unfreezes panes in the worksheet. |
void |
ungroupColumns(int startIndex,
int endIndex)
Ungroups columns. |
void |
ungroupRows(int startIndex,
int endIndex)
Ungroups rows. |
void |
unprotect()
Unprotects the worksheet. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Method Detail |
---|
public Cell getCell(int rowIndex, int columnIndex)
rowIndex
- row indexcolumnIndex
- column index
java.lang.IllegalArgumentException
- if any of the indexes is out of range.
ExcelException
- if the worksheet has been removed.public Cell getCell(java.lang.String cellName)
cellName
- cell name.
java.lang.IllegalArgumentException
- if the cell name is invalid.
ExcelException
- if the worksheet has been removed from the workbook.public Row getRow(int rowIndex)
rowIndex
- row index.
java.lang.IllegalArgumentException
- if index is out of range.
ExcelException
- if the worksheet has been removed from the workbook.public void insertRows(int rowIndex, int rowNum)
rowIndex
- The row index to insert before.rowNum
- Number of rows to be inserted.
ExcelException
- if the worksheet has been removed from the workbook.public void insertColumns(int columnIndex, int columnNum)
columnIndex
- The column index to insert before.columnNum
- Number of columns to be inserted.
ExcelException
- if the worksheet has been removed from the workbook.public void removeRow(int rowIndex)
rowIndex
- row index.
java.lang.IllegalArgumentException
- if row index is out of range.
ExcelException
- if the worksheet has been removed from the workbook.public void deleteRows(int startIndex, int deletedRows, boolean bShift)
startIndex
- the first row index to be removed.deletedRows
- Number of rows to be removed.bShift
- whether the rows after the deleted rows should be shifted up.public void deleteColumns(int startIndex, int deletedColumns, boolean bShift)
startIndex
- the first column index to be removed.deletedColumns
- Number of columns to be removed.bShift
- whether the columns after the deleted columns should be shifted left.public void removeCell(int rowIndex, int columnIndex)
rowIndex
- row index of the cell.columnIndex
- column Index of the cell.
java.lang.IllegalArgumentException
- if any of the indexes is out of range.
ExcelException
- if the worksheet has been removed from the workbook.public void removeCell(java.lang.String cellName)
cellName
- cell name.
java.lang.IllegalArgumentException
- if the cell name is invalid.
ExcelException
- if the worksheet has been removed from the workbook.public void setStyle(int startRow, int endRow, int startColumn, int endColumn, Style style)
startRow
- start row index.endRow
- end row index.startColumn
- start column index.endColumn
- end column index.style
- style to set.
java.lang.IllegalArgumentException
- if any of the indexes is out of range, or start index is
greater than end index.
ExcelException
- if the worksheet has been removed from the workbook.public int importResultSet(java.sql.ResultSet rs, int rowIndex, int columnIndex, int rowNum, int columnNum, boolean isFieldNameShown) throws java.sql.SQLException
rs
- the ResultSet object to import from.rowIndex
- start row index in the worksheet.columnIndex
- start column index in the worksheet.rowNum
- number of rows to import.columnNum
- number of columns to import.isFieldNameShown
- Indicates whether the field name of the resultset will be imported
to the first row.
java.sql.SQLException
- if an error occurs while reading from the resultset.
ExcelException
- if the worksheet has been removed from the workbook.public int importResultSet(java.sql.ResultSet rs, java.lang.String startCell, int rowNum, int columnNum, boolean isFieldNameShown) throws java.sql.SQLException
rs
- the ResultSet object to import from.startCell
- name of start cell to insert the resultset, such as "A1".rowNum
- number of rows to be imported.columnNum
- number of columns to be imported.isFieldNameShown
- Indicates whether the field name of the resultset will be imported
to the first row.
java.sql.SQLException
- if an error occurs while reading from the resultset.
ExcelException
- if the worksheet has been removed from the workbook.public int importResultSet(java.sql.ResultSet rs, int rowIndex, int columnIndex, boolean isFieldNameShown) throws java.sql.SQLException
rs
- the ResultSet object to import from.rowIndex
- start row index in the worksheet.columnIndex
- start column index in the worksheet.isFieldNameShown
- Indicates whether the field name of the resultset will be imported
to the first row.
java.sql.SQLException
- if an error occurs while reading from the resultset.
ExcelException
- if the worksheet has been removed from the workbook.public int importResultSet(java.sql.ResultSet rs, java.lang.String startCell, boolean isFieldNameShown) throws java.sql.SQLException
rs
- the ResultSet object to import from.startCell
- name of start cell to insert the resultset, such as "A1".isFieldNameShown
- Indicates whether the field name of the resultset will be imported
to the first row.
java.sql.SQLException
- if an error occurs while reading from the resultset.
ExcelException
- if the worksheet has been removed from the workbook.public java.util.Iterator getRowIterator()
ExcelException
- if the worksheet has been removed from the workbook.public java.lang.String getName()
public short getType()
SheetType
public boolean isVisible()
public void setName(java.lang.String name)
name
- name of the worksheet. The name length should be 1 to 31.
java.lang.IllegalArgumentException
- if name is invalid
ExcelException
- if the worksheet has been removed from the workbook,
or a worksheet with the same name already exists.public void setVisible(boolean visible)
visible
- true for visible
ExcelException
- if the worksheet has been removed from the workbook.public short getZoom()
public void setZoom(short zoom)
zoom
- the scaling factor in percent.
ExcelException
- if the worksheet has been removed from the workbook.public int getFirstVisibleRow()
public void setFirstVisibleRow(int row)
row
- first visible row index.
java.lang.IllegalArgumentException
- if row index is out of range.
ExcelException
- if the worksheet has been removed from the workbook.public short getFirstVisibleColumn()
public void setFirstVisibleColumn(int column)
column
- first visible column index,zero besed.
java.lang.IllegalArgumentException
- if column index is out of range.
ExcelException
- if the worksheet has been removed from the workbook.public Color getTabColor()
public void setTabColor(Color tabColor)
tabColor
- the colour of the tab below the sheet containing the sheet name.public void split()
ExcelException
- if the worksheet has been removed from the workbook.public void removeSplit()
ExcelException
- if the worksheet has been removed from the workbook.public void freezePanes(int row, int column, int freezedRows, int freezedColumns)
row
- row index.column
- column index.freezedRows
- number of visible rows in top pane, no more than row index.freezedColumns
- number of visible columns in left pane, no more than column index.
java.lang.IllegalArgumentException
- if row index,column index,freezedRows or freezedColumns is out of range.
java.lang.IllegalArgumentException
- if row index and column index all are zero.
number of rows and number of columns all are zero.
ExcelException
- if the worksheet has been removed from the workbook.public void freezePanes(java.lang.String cellName, int freezedRows, short freezedColumns)
cellName
- cell name.freezedRows
- number of visible rows in top pane, no more than row index.freezedColumns
- number of visible columns in left pane, no more than column index.
java.lang.IllegalArgumentException
- if cell name is invalid.freezePanes(int, int, int, int)
public void unFreezePanes()
ExcelException
- if the worksheet has been removed from the workbook.public boolean isPageBreakPreview()
public void setPageBreakPreview(boolean pageBreakPreview)
pageBreakPreview
- whether the specified worksheet is shown in normal view or page break preview.
ExcelException
- if the worksheet has been removed from the workbook.public boolean isGridlinesVisible()
public void setGridlinesVisible(boolean gridlinesVisible)
gridlinesVisible
- whether the grid lines to be visible or not.
ExcelException
- if the worksheet has been removed from the workbook.public boolean isRowColumnHeadersVisible()
public void setRowColumnHeadersVisible(boolean rowColumnHeadersVisible)
rowColumnHeadersVisible
- whether the worksheet
will display row and column headers.
ExcelException
- if the worksheet has been removed from the workbook.public int getFirstRowIndex()
public int getLastRowIndex()
public float getDefaultColumnWidth()
public void setDefaultColumnWidth(float defaultColumnWidth)
defaultColumnWidth
- the default column width of the worksheet in characters. 0-255.
java.lang.IllegalArgumentException
- if the given column width is invalid(< 0 or > 255 ).
ExcelException
- if the worksheet has been removed from the workbook.public float getColumnWidth(int columnIndex)
columnIndex
- column index.
java.lang.IllegalArgumentException
- if column index is out of range.public void setColumnWidth(int columnIndex, float columnWidth)
columnIndex
- column index.columnWidth
- column width in characters(0-255).
java.lang.IllegalArgumentException
- if either column index or column width is invalid.
ExcelException
- if the worksheet has been removed from the workbook.public boolean isColumnHidden(int columnIndex)
columnIndex
- column index.
java.lang.IllegalArgumentException
- if column index is out of range.public void setColumnHidden(int columnIndex, boolean isHidden)
columnIndex
- column index.isHidden
- true for hidden.
java.lang.IllegalArgumentException
- if the column index is out of range.
ExcelException
- if the worksheet has been removed from the workbook.public Style getColumnStyle(int columnIndex)
columnIndex
- column index.
java.lang.IllegalArgumentException
- if column index is out of range.
ExcelException
- if the worksheet has been removed from the workbook.public void setColumnStyle(short columnIndex, Style style)
columnIndex
- column index.style
- style to set.
java.lang.IllegalArgumentException
- if column index is out of range.
ExcelException
- if the worksheet has been removed from the workbook.public float getDefaultRowHeight()
public void setDefaultRowHeight(float defaultRowHeight)
defaultRowHeight
- row height in points(0-409).
java.lang.IllegalArgumentException
- if the row height is invalid.
ExcelException
- if the worksheet has been removed from the workbook.public java.util.ArrayList getMergedCells()
public Hyperlinks getHyperlinks()
public Validations getValidations()
public VPageBreaks getVPageBreaks()
public HPageBreaks getHPageBreaks()
public void addPageBreaks(java.lang.String cellName)
cellName
- cell name.
java.lang.IllegalArgumentException
- if cell name is invalid.public void addPageBreaks(int row, int column)
row
- row index,zero basedcolumn
- column index,zero based.
java.lang.IllegalArgumentException
- if row index or cell indexs is invalid.public PageSetup getPageSetup()
public ConditionalFormattings getConditionalFormattings()
public Protection getProtection()
public void protect(Protection protection)
protection
- protection options.public void unprotect()
public void groupRows(int startIndex, int endIndex)
startIndex
- The first row index to be grouped.endIndex
- The last row index to be grouped.public void groupRows(int startIndex, int endIndex, boolean isHidden)
startIndex
- The first row index to be grouped.endIndex
- The last row index to be grouped.isHidden
- Specifies if the grouped columns are hidden.public void ungroupRows(int startIndex, int endIndex)
startIndex
- The first row index to be ungrouped.endIndex
- The last row index to be ungrouped.public void groupColumns(int startIndex, int endIndex)
startIndex
- The first column index to be grouped.endIndex
- The last column index to be grouped.public void groupColumns(int startIndex, int endIndex, boolean isHidden)
startIndex
- The first column index to be grouped.endIndex
- The last column index to be grouped.isHidden
- Specifies if the grouped columns are hidden.public void ungroupColumns(int startIndex, int endIndex)
startIndex
- The first column index to be ungrouped.endIndex
- The last column index to be ungrouped.
|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |