|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.poi.hssf.usermodel.HSSFSheet
High level representation of a worksheet.
Field Summary | |
static short |
BottomMargin
|
static int |
INITIAL_CAPACITY
Used for compile-time optimization. |
static short |
LeftMargin
|
static byte |
PANE_LOWER_LEFT
|
static byte |
PANE_LOWER_RIGHT
|
static byte |
PANE_UPPER_LEFT
|
static byte |
PANE_UPPER_RIGHT
|
static short |
RightMargin
|
static short |
TopMargin
|
Constructor Summary | |
protected |
HSSFSheet(Workbook book)
Creates new HSSFSheet - called by HSSFWorkbook to create a sheet from scratch. |
protected |
HSSFSheet(Workbook book,
Sheet sheet)
Creates an HSSFSheet representing the given Sheet object. |
Method Summary | |
int |
addMergedRegion(Region region)
adds a merged region of cells (hence those cells form one) |
HSSFPatriarch |
createDrawingPatriarch()
Creates the toplevel drawing patriarch. |
void |
createFreezePane(int colSplit,
int rowSplit)
Creates a split (freezepane). |
void |
createFreezePane(int colSplit,
int rowSplit,
int leftmostColumn,
int topRow)
Creates a split (freezepane). |
HSSFRow |
createRow(int rownum)
Create a new row within the sheet and return the high level representation |
void |
createSplitPane(int xSplitPos,
int ySplitPos,
int leftmostColumn,
int topRow,
int activePane)
Creates a split pane. |
void |
dumpDrawingRecords()
Aggregates the drawing records and dumps the escher record hierarchy to the standard output. |
boolean |
getAlternateExpression()
whether alternate expression evaluation is on |
boolean |
getAlternateFormula()
whether alternative formula entry is on |
boolean |
getAutobreaks()
show automatic page breaks or not |
short[] |
getColumnBreaks()
Retrieves all the vertical page breaks |
short |
getColumnWidth(short column)
get the width (in units of 1/256th of a character width ) |
short |
getDefaultColumnWidth()
get the default column width for the sheet (if the columns do not define their own width) in characters |
short |
getDefaultRowHeight()
get the default row height for the sheet (if the rows do not define their own height) in twips (1/20 of a point) |
float |
getDefaultRowHeightInPoints()
get the default row height for the sheet (if the rows do not define their own height) in points. |
boolean |
getDialog()
get whether sheet is a dialog sheet or not |
boolean |
getDisplayGuts()
get whether to display the guts or not |
int |
getFirstRowNum()
gets the first row on the sheet |
boolean |
getFitToPage()
fit to page option is on |
HSSFFooter |
getFooter()
Gets the user model for the document footer. |
HSSFHeader |
getHeader()
Gets the user model for the document header. |
boolean |
getHorizontallyCenter()
Determine whether printed output for this sheet will be horizontally centered. |
int |
getLastRowNum()
gets the last row on the sheet |
double |
getMargin(short margin)
Gets the size of the margin in inches. |
Region |
getMergedRegionAt(int index)
gets the region at a particular index |
int |
getNumMergedRegions()
returns the number of merged regions |
int |
getPhysicalNumberOfRows()
Returns the number of phsyically defined rows (NOT the number of rows in the sheet) |
HSSFPrintSetup |
getPrintSetup()
Gets the print setup object. |
boolean |
getProtect()
Answer whether protection is enabled or disabled |
HSSFRow |
getRow(int rownum)
Returns the logical row (not physical) 0-based. |
int[] |
getRowBreaks()
Retrieves all the horizontal page breaks |
boolean |
getRowSumsBelow()
get if row summaries appear below detail in the outline |
boolean |
getRowSumsRight()
get if col summaries appear right of the detail in the outline |
protected Sheet |
getSheet()
used internally in the API to get the low level Sheet record represented by this Object. |
boolean |
getVerticallyCenter(boolean value)
Determine whether printed output for this sheet will be vertically centered. |
void |
groupColumn(short fromColumn,
short toColumn)
Create an outline for the provided column range. |
void |
groupRow(int fromRow,
int toRow)
|
protected void |
insertChartRecords(java.util.List records)
|
boolean |
isColumnBroken(short column)
Determines if there is a page break at the indicated column |
boolean |
isDisplayFormulas()
Returns if formulas are displayed. |
boolean |
isDisplayGridlines()
Returns if gridlines are displayed. |
boolean |
isDisplayRowColHeadings()
Returns if RowColHeadings are displayed. |
boolean |
isGridsPrinted()
get whether gridlines are printed. |
boolean |
isPrintGridlines()
Returns whether gridlines are printed. |
boolean |
isRowBroken(int row)
Determines if there is a page break at the indicated row |
void |
removeColumnBreak(short 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(HSSFRow row)
Remove a row from this sheet. |
void |
removeRowBreak(int row)
Removes the page break at the indicated row |
java.util.Iterator |
rowIterator()
|
void |
setAlternativeExpression(boolean b)
whether alternate expression evaluation is on |
void |
setAlternativeFormula(boolean b)
whether alternative formula entry is on |
void |
setAutobreaks(boolean b)
show automatic page breaks or not |
void |
setColumnBreak(short column)
Sets a page break at the indicated column |
void |
setColumnGroupCollapsed(short columnNumber,
boolean collapsed)
Expands or collapses a column group. |
void |
setColumnWidth(short column,
short width)
set the width (in units of 1/256th of a character width) |
void |
setDefaultColumnWidth(short width)
set the default column width for the sheet (if the columns do not define their own width) in characters |
void |
setDefaultRowHeight(short height)
set the default row height for the sheet (if the rows do not define their own height) in twips (1/20 of a point) |
void |
setDefaultRowHeightInPoints(float height)
set the default row height for the sheet (if the rows do not define their own height) in points |
void |
setDialog(boolean b)
set whether sheet is a dialog sheet or not |
void |
setDisplayFormulas(boolean show)
Sets whether the formulas are shown in a viewer. |
void |
setDisplayGridlines(boolean show)
Sets whether the gridlines are shown in a viewer. |
void |
setDisplayGuts(boolean b)
set whether to display the guts or not |
void |
setDisplayRowColHeadings(boolean show)
Sets whether the RowColHeadings are shown in a viewer. |
void |
setFitToPage(boolean b)
fit to page option is on |
void |
setGridsPrinted(boolean value)
set whether gridlines printed. |
void |
setHorizontallyCenter(boolean value)
determines whether the output is horizontally centered on the page. |
void |
setMargin(short margin,
double size)
Sets the size of the margin in inches. |
void |
setPrintGridlines(boolean newPrintGridlines)
Turns on or off the printing of gridlines. |
void |
setProtect(boolean protect)
Sets the protection on enabled or disabled |
void |
setRowBreak(int row)
Sets a page break at the indicated row |
void |
setRowGroupCollapsed(int row,
boolean collapse)
|
void |
setRowSumsBelow(boolean b)
set if row summaries appear below detail in the outline |
void |
setRowSumsRight(boolean b)
set if col summaries appear right of the detail in the outline |
void |
setSelected(boolean sel)
Sets whether sheet is selected. |
void |
setVerticallyCenter(boolean value)
determines whether the output is vertically centered on the page. |
void |
setZoom(int numerator,
int denominator)
Sets the zoom magnication for the sheet. |
protected void |
shiftMerged(int startRow,
int endRow,
int n,
boolean isRow)
Shifts the merged regions left or right depending on mode |
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 |
ungroupColumn(short fromColumn,
short toColumn)
|
void |
ungroupRow(int fromRow,
int toRow)
|
protected void |
validateColumn(short column)
Runs a bounds check for column numbers |
protected void |
validateRow(int row)
Runs a bounds check for row numbers |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
public static final short LeftMargin
public static final short RightMargin
public static final short TopMargin
public static final short BottomMargin
public static final byte PANE_LOWER_RIGHT
public static final byte PANE_UPPER_RIGHT
public static final byte PANE_LOWER_LEFT
public static final byte PANE_UPPER_LEFT
public static final int INITIAL_CAPACITY
Constructor Detail |
protected HSSFSheet(Workbook book)
book
- - lowlevel Workbook object associated with the sheet.HSSFWorkbook.createSheet()
protected HSSFSheet(Workbook book, Sheet sheet)
book
- - lowlevel Workbook object associated with the sheet.sheet
- - lowlevel Sheet object this sheet will representHSSFWorkbook.createSheet()
Method Detail |
public HSSFRow createRow(int rownum)
rownum
- row number
HSSFRow
,
removeRow(HSSFRow)
public void removeRow(HSSFRow row)
row
- representing a row to remove.public HSSFRow getRow(int rownum)
rownum
- row to get
public int getPhysicalNumberOfRows()
public int getFirstRowNum()
public int getLastRowNum()
public void setColumnWidth(short column, short width)
column
- - the column to set (0-based)width
- - the width in units of 1/256th of a character widthpublic short getColumnWidth(short column)
column
- - the column to set (0-based)
public short getDefaultColumnWidth()
public short getDefaultRowHeight()
public float getDefaultRowHeightInPoints()
public void setDefaultColumnWidth(short width)
width
- default column widthpublic void setDefaultRowHeight(short height)
height
- default row heightpublic void setDefaultRowHeightInPoints(float height)
height
- default row heightpublic boolean isGridsPrinted()
public void setGridsPrinted(boolean value)
value
- false if not printed.public int addMergedRegion(Region region)
region
- (rowfrom/colfrom-rowto/colto) to merge
public void setVerticallyCenter(boolean value)
value
- true to vertically center, false otherwise.public boolean getVerticallyCenter(boolean value)
public void setHorizontallyCenter(boolean value)
value
- true to horizontally center, false otherwise.public boolean getHorizontallyCenter()
public void removeMergedRegion(int index)
index
- of the region to unmergepublic int getNumMergedRegions()
public Region getMergedRegionAt(int index)
index
- of the region to fetch
public java.util.Iterator rowIterator()
protected Sheet getSheet()
public void setAlternativeExpression(boolean b)
b
- alternative expression evaluation or notpublic void setAlternativeFormula(boolean b)
b
- alternative formulas or notpublic void setAutobreaks(boolean b)
b
- whether to show auto page breakspublic void setDialog(boolean b)
b
- isDialog or notpublic void setDisplayGuts(boolean b)
b
- guts or no guts (or glory)public void setFitToPage(boolean b)
b
- fit or notpublic void setRowSumsBelow(boolean b)
b
- below or notpublic void setRowSumsRight(boolean b)
b
- right or notpublic boolean getAlternateExpression()
public boolean getAlternateFormula()
public boolean getAutobreaks()
public boolean getDialog()
public boolean getDisplayGuts()
public boolean getFitToPage()
public boolean getRowSumsBelow()
public boolean getRowSumsRight()
public boolean isPrintGridlines()
public void setPrintGridlines(boolean newPrintGridlines)
newPrintGridlines
- boolean to turn on or off the printing of
gridlinespublic HSSFPrintSetup getPrintSetup()
public HSSFHeader getHeader()
public HSSFFooter getFooter()
public void setSelected(boolean sel)
sel
- Whether to select the sheet or deselect the sheet.public double getMargin(short margin)
margin
- which margin to get
public void setMargin(short margin, double size)
margin
- which margin to getsize
- the size of the marginpublic boolean getProtect()
public void setProtect(boolean protect)
protect
- true => protection enabled; false => protection disabledpublic void setZoom(int numerator, int denominator)
numerator
- The numerator for the zoom magnification.denominator
- The denominator for the zoom magnification.protected void shiftMerged(int startRow, int endRow, int n, boolean isRow)
TODO: MODE , this is only row specific
startRow
- endRow
- n
- isRow
- 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).
startRow
- the row to start shiftingendRow
- the row to end shiftingn
- the number of rows to shiftpublic 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).
TODO Might want to add bounds checking here
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 defaultprotected void insertChartRecords(java.util.List records)
public void createFreezePane(int colSplit, int rowSplit, int leftmostColumn, int topRow)
colSplit
- Horizonatal position of split.rowSplit
- Vertical position of split.topRow
- Top row visible in bottom paneleftmostColumn
- Left column visible in right pane.public void createFreezePane(int colSplit, int rowSplit)
colSplit
- Horizonatal position of split.rowSplit
- Vertical position of split.public void createSplitPane(int xSplitPos, int ySplitPos, int leftmostColumn, int topRow, int activePane)
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_LEFTPANE_LOWER_LEFT
,
PANE_LOWER_RIGHT
,
PANE_UPPER_LEFT
,
PANE_UPPER_RIGHT
public void setDisplayGridlines(boolean show)
show
- whether to show gridlines or notpublic boolean isDisplayGridlines()
public void setDisplayFormulas(boolean show)
show
- whether to show formulas or notpublic boolean isDisplayFormulas()
public void setDisplayRowColHeadings(boolean show)
show
- whether to show RowColHeadings or notpublic boolean isDisplayRowColHeadings()
public void setRowBreak(int row)
row
- public boolean isRowBroken(int row)
row
-
public void removeRowBreak(int row)
row
- public int[] getRowBreaks()
public short[] getColumnBreaks()
public void setColumnBreak(short column)
column
- public boolean isColumnBroken(short column)
column
-
public void removeColumnBreak(short column)
column
- protected void validateRow(int row)
row
- protected void validateColumn(short column)
column
- public void dumpDrawingRecords()
public HSSFPatriarch createDrawingPatriarch()
public void setColumnGroupCollapsed(short columnNumber, boolean collapsed)
columnNumber
- One of the columns in the group.collapsed
- true = collapse group, false = expand group.public void groupColumn(short fromColumn, short toColumn)
fromColumn
- beginning of the column range.toColumn
- end of the column range.public void ungroupColumn(short fromColumn, short toColumn)
public void groupRow(int fromRow, int toRow)
public void ungroupRow(int fromRow, int toRow)
public void setRowGroupCollapsed(int row, boolean collapse)
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |