Java Doc for HSSFSheet.java in » Collaboration » poi-3.0.2-beta2 » org » apache » poi » hssf » usermodel » Java Source Code / Java DocumentationJava Source Code and Java Documentation

Java Source Code / Java Documentation

1.	6.0 JDK Core
2.	6.0 JDK Modules
3.	6.0 JDK Modules com.sun
4.	6.0 JDK Modules com.sun.java
5.	6.0 JDK Modules sun
6.	6.0 JDK Platform
7.	Ajax
8.	Apache Harmony Java SE
9.	Aspect oriented
10.	Authentication Authorization
11.	Blogger System
12.	Build
13.	Byte Code
14.	Cache
15.	Chart
16.	Chat
17.	Code Analyzer
18.	Collaboration
19.	Content Management System
20.	Database Client
21.	Database DBMS
22.	Database JDBC Connection Pool
23.	Database ORM
24.	Development
25.	EJB Server geronimo
26.	EJB Server GlassFish
27.	EJB Server JBoss 4.2.1
28.	EJB Server resin 3.1.5
29.	ERP CRM Financial
30.	ESB
31.	Forum
32.	GIS
33.	Graphic Library
34.	Groupware
35.	HTML Parser
36.	IDE
37.	IDE Eclipse
38.	IDE Netbeans
39.	Installer
40.	Internationalization Localization
41.	Inversion of Control
42.	Issue Tracking
43.	J2EE
44.	JBoss
45.	JMS
46.	JMX
47.	Library
48.	Mail Clients
49.	Net
50.	Parser
51.	PDF
52.	Portal
53.	Profiler
54.	Project Management
55.	Report
56.	RSS RDF
57.	Rule Engine
58.	Science
59.	Scripting
60.	Search Engine
61.	Security
62.	Sevlet Container
63.	Source Control
64.	Swing Library
65.	Template Engine
66.	Test Coverage
67.	Testing
68.	UML
69.	Web Crawler
70.	Web Framework
71.	Web Mail
72.	Web Server
73.	Web Services
74.	Web Services apache cxf 2.0.1
75.	Web Services AXIS2
76.	Wiki Engine
77.	Workflow Engines
78.	XML
79.	XML UI

Java

Java Tutorial

Illustrator Tutorials

GIMP Tutorials

C# / C Sharp

C# / CSharp Tutorial

C# / CSharp Open Source

SQL Server / T-SQL Tutorial

Oracle PL / SQL

Oracle PL/SQL Tutorial

Flash / Flex / ActionScript

VBA / Excel / Access / Word

XML

XML Tutorial

Microsoft Office PowerPoint 2007 Tutorial

Microsoft Office Excel 2007 Tutorial

Microsoft Office Word 2007 Tutorial

Java Source Code / Java Documentation » Collaboration » poi 3.0.2 beta2 » org.apache.poi.hssf.usermodel

Source Cross Reference Class Diagram Java Document (Java Doc)

java.lang .Object

org.apache.poi.hssf.usermodel .HSSFSheet

HSSFSheet
public class HSSFSheet (Code)
	High level representation of a worksheet. author: Andrew C. Oliver (acoliver at apache dot org) author: Glen Stampoultzis (glens at apache.org) author: Libin Roman (romal at vistaportal.com) author: Shawn Laubach (slaubach at apache dot org) (Just a little) author: Jean-Pierre Paris (jean-pierre.paris at m4x dot org) (Just a little, too) author: Yegor Kozlov (yegor at apache.org) (Autosizing columns)

Field Summary
final public static short	BottomMargin
final public static int	INITIAL_CAPACITY Used for compile-time optimization.
final public static short	LeftMargin
final public static byte	PANE_LOWER_LEFT
final public static byte	PANE_LOWER_RIGHT
final public static byte	PANE_UPPER_LEFT
final public static byte	PANE_UPPER_RIGHT
final public static short	RightMargin
final public static short	TopMargin
protected Workbook	book
protected HSSFWorkbook	workbook

Constructor Summary
protected	HSSFSheet(HSSFWorkbook workbook) Creates new HSSFSheet - called by HSSFWorkbook to create a sheet from scratch.
protected	HSSFSheet(HSSFWorkbook workbook, Sheet sheet) Creates an HSSFSheet representing the given Sheet object.

Method Summary
public int	addMergedRegion(Region region)
public void	addValidationData(HSSFDataValidation obj_validation)
public void	autoSizeColumn(short column) Adjusts the column width to fit the contents.
HSSFSheet	cloneSheet(HSSFWorkbook workbook)
public HSSFPatriarch	createDrawingPatriarch() Creates the toplevel drawing patriarch.
public void	createFreezePane(int colSplit, int rowSplit, int leftmostColumn, int topRow) Creates a split (freezepane).
public void	createFreezePane(int colSplit, int rowSplit) Creates a split (freezepane).
public HSSFRow	createRow(int rownum)
public void	createSplitPane(int xSplitPos, int ySplitPos, int leftmostColumn, int topRow, int activePane) Creates a split pane.
public void	dumpDrawingRecords(boolean fat) Aggregates the drawing records and dumps the escher record hierarchy to the standard output.
public boolean	getAlternateExpression()
public boolean	getAlternateFormula()
public boolean	getAutobreaks()
public HSSFComment	getCellComment(int row, int column)
public short[]	getColumnBreaks()
public short	getColumnWidth(short column)
public short	getDefaultColumnWidth()
public short	getDefaultRowHeight()
public float	getDefaultRowHeightInPoints() get the default row height for the sheet (if the rows do not define their own height) in points.
public boolean	getDialog()
public boolean	getDisplayGuts()
public int	getFirstRowNum()
public boolean	getFitToPage()
public HSSFFooter	getFooter() Gets the user model for the document footer.
public HSSFHeader	getHeader() Gets the user model for the document header.
public boolean	getHorizontallyCenter() Determine whether printed output for this sheet will be horizontally centered.
public int	getLastRowNum()
public short	getLeftCol()
public double	getMargin(short margin) Gets the size of the margin in inches.
public Region	getMergedRegionAt(int index)
public int	getNumMergedRegions()
public boolean	getObjectProtect()
public PaneInformation	getPaneInformation() Returns the information regarding the currently configured pane (split or freeze).
public short	getPassword()
public int	getPhysicalNumberOfRows()
public HSSFPrintSetup	getPrintSetup() Gets the print setup object.
public boolean	getProtect()
public HSSFRow	getRow(int rownum) Returns the logical row (not physical) 0-based.
public int[]	getRowBreaks()
public boolean	getRowSumsBelow()
public boolean	getRowSumsRight()
public boolean	getScenarioProtect()
protected Sheet	getSheet() used internally in the API to get the low level Sheet record represented by this Object.
public short	getTopRow()
public boolean	getVerticallyCenter(boolean value) Determine whether printed output for this sheet will be vertically centered.
public void	groupColumn(short fromColumn, short toColumn) Create an outline for the provided column range.
public void	groupRow(int fromRow, int toRow)
protected void	insertChartRecords(List records)
public boolean	isColumnBroken(short column)
public boolean	isColumnHidden(short column) Get the hidden state for a given column.
public boolean	isDisplayFormulas() Returns if formulas are displayed.
public boolean	isDisplayGridlines() Returns if gridlines are displayed.
public boolean	isDisplayRowColHeadings() Returns if RowColHeadings are displayed.
public boolean	isGridsPrinted() get whether gridlines are printed.
public boolean	isPrintGridlines() Returns whether gridlines are printed.
public boolean	isRowBroken(int row)
public void	protectSheet(String password)
public void	removeColumnBreak(short column)
public void	removeMergedRegion(int index)
public void	removeRow(HSSFRow row) Remove a row from this sheet.
public void	removeRowBreak(int row)
public Iterator	rowIterator() an iterator of the PHYSICAL rows.
public void	setAlternativeExpression(boolean b)
public void	setAlternativeFormula(boolean b)
public void	setAutobreaks(boolean b)
public void	setColumnBreak(short column)
public void	setColumnGroupCollapsed(short columnNumber, boolean collapsed) Expands or collapses a column group.
public void	setColumnHidden(short column, boolean hidden) Get the visibility state for a given column.
public void	setColumnWidth(short column, short width)
public void	setDefaultColumnStyle(short column, HSSFCellStyle style) Sets the default column style for a given column.
public void	setDefaultColumnWidth(short width)
public void	setDefaultRowHeight(short height)
public void	setDefaultRowHeightInPoints(float height)
public void	setDialog(boolean b)
public void	setDisplayFormulas(boolean show) Sets whether the formulas are shown in a viewer.
public void	setDisplayGridlines(boolean show) Sets whether the gridlines are shown in a viewer.
public void	setDisplayGuts(boolean b)
public void	setDisplayRowColHeadings(boolean show) Sets whether the RowColHeadings are shown in a viewer.
public void	setFitToPage(boolean b)
public void	setGridsPrinted(boolean value) set whether gridlines printed.
public void	setHorizontallyCenter(boolean value) determines whether the output is horizontally centered on the page.
public void	setMargin(short margin, double size) Sets the size of the margin in inches.
public void	setPrintGridlines(boolean newPrintGridlines) Turns on or off the printing of gridlines.
public void	setProtect(boolean protect)
public void	setRowBreak(int row)
public void	setRowGroupCollapsed(int row, boolean collapse)
public void	setRowSumsBelow(boolean b)
public void	setRowSumsRight(boolean b)
public void	setSelected(boolean sel) Sets whether sheet is selected.
public void	setVerticallyCenter(boolean value) determines whether the output is vertically centered on the page.
public void	setZoom(int numerator, int denominator) Sets the zoom magnication for the sheet.
protected void	shiftMerged(int startRow, int endRow, int n, boolean isRow)
public void	shiftRows(int startRow, int endRow, int n) Shifts rows between startRow and endRow n number of rows. If you use a negative number, it will shift rows up. Code ensures that rows don't wrap around. Calls shiftRows(startRow, endRow, n, false, false); Additionally shifts merged regions that are completely defined in these rows (ie.
public void	shiftRows(int startRow, int endRow, int n, boolean copyRowHeight, boolean resetOriginalRowHeight) Shifts rows between startRow and endRow n number of rows. If you use a negative number, it will shift rows up. Code ensures that rows don't wrap around Additionally shifts merged regions that are completely defined in these rows (ie.
public void	showInPane(short toprow, short leftcol) Sets desktop window pane display area, when the file is first opened in a viewer.
public void	ungroupColumn(short fromColumn, short toColumn)
public void	ungroupRow(int fromRow, int toRow)
protected void	validateColumn(short column)
protected void	validateRow(int row)

Field Detail

BottomMargin
final public static short BottomMargin(Code)

INITIAL_CAPACITY
final public static int INITIAL_CAPACITY(Code)
	Used for compile-time optimization. This is the initial size for the collection of rows. It is currently set to 20. If you generate larger sheets you may benefit by setting this to a higher number and recompiling a custom edition of HSSFSheet.

LeftMargin
final public static short LeftMargin(Code)

PANE_LOWER_LEFT
final public static byte PANE_LOWER_LEFT(Code)

PANE_LOWER_RIGHT
final public static byte PANE_LOWER_RIGHT(Code)

PANE_UPPER_LEFT
final public static byte PANE_UPPER_LEFT(Code)

PANE_UPPER_RIGHT
final public static byte PANE_UPPER_RIGHT(Code)

RightMargin
final public static short RightMargin(Code)

TopMargin
final public static short TopMargin(Code)

book
protected Workbook book(Code)

workbook
protected HSSFWorkbook workbook(Code)

Constructor Detail

HSSFSheet
protected HSSFSheet(HSSFWorkbook workbook)(Code)
	Creates new HSSFSheet - called by HSSFWorkbook to create a sheet from scratch. You should not be calling this from application code (its protected anyhow). Parameters: workbook - - The HSSF Workbook object associated with the sheet. See Also: org.apache.poi.hssf.usermodel.HSSFWorkbook.createSheet

HSSFSheet
protected HSSFSheet(HSSFWorkbook workbook, Sheet sheet)(Code)
	Creates an HSSFSheet representing the given Sheet object. Should only be called by HSSFWorkbook when reading in an exisiting file. Parameters: workbook - - The HSSF Workbook object associated with the sheet. Parameters: sheet - - lowlevel Sheet object this sheet will represent See Also: org.apache.poi.hssf.usermodel.HSSFWorkbook.createSheet

Method Detail

addMergedRegion
public int addMergedRegion(Region region)(Code)
	adds a merged region of cells (hence those cells form one) Parameters: region - (rowfrom/colfrom-rowto/colto) to merge index of this region

addValidationData
public void addValidationData(HSSFDataValidation obj_validation)(Code)
	Creates a data validation object Parameters: obj_validation - The Data validation object settings

autoSizeColumn
public void autoSizeColumn(short column)(Code)
	Adjusts the column width to fit the contents. 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. Parameters: column - the column index

cloneSheet
HSSFSheet cloneSheet(HSSFWorkbook workbook)(Code)

createDrawingPatriarch
public HSSFPatriarch createDrawingPatriarch()(Code)
	Creates the toplevel drawing patriarch. This will have the effect of removing any existing drawings on this sheet. The new patriarch.

createFreezePane
public void createFreezePane(int colSplit, int rowSplit, int leftmostColumn, int topRow)(Code)
	Creates a split (freezepane). Any existing freezepane or split pane is overwritten. Parameters: colSplit - Horizonatal position of split. Parameters: rowSplit - Vertical position of split. Parameters: topRow - Top row visible in bottom pane Parameters: leftmostColumn - Left column visible in right pane.

createFreezePane
public void createFreezePane(int colSplit, int rowSplit)(Code)
	Creates a split (freezepane). Any existing freezepane or split pane is overwritten. Parameters: colSplit - Horizonatal position of split. Parameters: rowSplit - Vertical position of split.

createRow
public HSSFRow createRow(int rownum)(Code)
	Create a new row within the sheet and return the high level representation Parameters: rownum - row number High level HSSFRow object representing a row in the sheet See Also: org.apache.poi.hssf.usermodel.HSSFRow See Also: HSSFSheet.removeRow(HSSFRow)

createSplitPane
public void createSplitPane(int xSplitPos, int ySplitPos, int leftmostColumn, int topRow, int activePane)(Code)
	Creates a split pane. Any existing freezepane or split pane is overwritten. Parameters: xSplitPos - Horizonatal position of split (in 1/20th of a point). Parameters: ySplitPos - Vertical position of split (in 1/20th of a point). Parameters: topRow - Top row visible in bottom pane Parameters: leftmostColumn - Left column visible in right pane. Parameters: activePane - Active pane. One of: PANE_LOWER_RIGHT,PANE_UPPER_RIGHT, PANE_LOWER_LEFT, PANE_UPPER_LEFT See Also: HSSFSheet.PANE_LOWER_LEFT See Also: HSSFSheet.PANE_LOWER_RIGHT See Also: HSSFSheet.PANE_UPPER_LEFT See Also: HSSFSheet.PANE_UPPER_RIGHT

dumpDrawingRecords
public void dumpDrawingRecords(boolean fat)(Code)
	Aggregates the drawing records and dumps the escher record hierarchy to the standard output.

getAlternateExpression
public boolean getAlternateExpression()(Code)
	whether alternate expression evaluation is on alternative expression evaluation or not

getAlternateFormula
public boolean getAlternateFormula()(Code)
	whether alternative formula entry is on alternative formulas or not

getAutobreaks
public boolean getAutobreaks()(Code)
	show automatic page breaks or not whether to show auto page breaks

getCellComment
public HSSFComment getCellComment(int row, int column)(Code)
	Returns cell comment for the specified row and column cell comment or `null` if not found

getColumnBreaks
public short[] getColumnBreaks()(Code)
	Retrieves all the vertical page breaks all the vertical page breaks, or null if there are no column page breaks

getColumnWidth
public short getColumnWidth(short column)(Code)
	get the width (in units of 1/256th of a character width ) Parameters: column - - the column to set (0-based) width - the width in units of 1/256th of a character width

getDefaultColumnWidth
public short getDefaultColumnWidth()(Code)
	get the default column width for the sheet (if the columns do not define their own width) in characters default column width

getDefaultRowHeight
public short getDefaultRowHeight()(Code)
	get the default row height for the sheet (if the rows do not define their own height) in twips (1/20 of a point) default row height

getDefaultRowHeightInPoints
public float getDefaultRowHeightInPoints()(Code)
	get the default row height for the sheet (if the rows do not define their own height) in points. default row height in points

getDialog
public boolean getDialog()(Code)
	get whether sheet is a dialog sheet or not isDialog or not

getDisplayGuts
public boolean getDisplayGuts()(Code)
	get whether to display the guts or not guts or no guts (or glory)

getFirstRowNum
public int getFirstRowNum()(Code)
	gets the first row on the sheet the number of the first logical row on the sheet

getFitToPage
public boolean getFitToPage()(Code)
	fit to page option is on fit or not

getFooter
public HSSFFooter getFooter()(Code)
	Gets the user model for the document footer. The Document footer.

getHeader
public HSSFHeader getHeader()(Code)
	Gets the user model for the document header. The Document header.

getHorizontallyCenter
public boolean getHorizontallyCenter()(Code)
	Determine whether printed output for this sheet will be horizontally centered.

getLastRowNum
public int getLastRowNum()(Code)
	gets the last row on the sheet last row contained n this sheet.

getLeftCol
public short getLeftCol()(Code)
	The left col in the visible view when the sheet is first viewed after opening it in a viewer short indicating the rownum (0 based) of the top row

getMargin
public double getMargin(short margin)(Code)
	Gets the size of the margin in inches. Parameters: margin - which margin to get the size of the margin

getMergedRegionAt
public Region getMergedRegionAt(int index)(Code)
	gets the region at a particular index Parameters: index - of the region to fetch the merged region (simple eh?)

getNumMergedRegions
public int getNumMergedRegions()(Code)
	returns the number of merged regions number of merged regions

getObjectProtect
public boolean getObjectProtect()(Code)
	Answer whether object protection is enabled or disabled true => protection enabled; false => protection disabled

getPaneInformation
public PaneInformation getPaneInformation()(Code)
	Returns the information regarding the currently configured pane (split or freeze). null if no pane configured, or the pane information.

getPassword
public short getPassword()(Code)
	hashed password

getPhysicalNumberOfRows
public int getPhysicalNumberOfRows()(Code)
	Returns the number of phsyically defined rows (NOT the number of rows in the sheet)

getPrintSetup
public HSSFPrintSetup getPrintSetup()(Code)
	Gets the print setup object. The user model for the print setup object.

getProtect
public boolean getProtect()(Code)
	Answer whether protection is enabled or disabled true => protection enabled; false => protection disabled

getRow
public HSSFRow getRow(int rownum)(Code)
	Returns the logical row (not physical) 0-based. If you ask for a row that is not defined you get a null. This is to say row 4 represents the fifth row on a sheet. Parameters: rownum - row to get HSSFRow representing the rownumber or null if its not defined on the sheet

getRowBreaks
public int[] getRowBreaks()(Code)
	Retrieves all the horizontal page breaks all the horizontal page breaks, or null if there are no row page breaks

getRowSumsBelow
public boolean getRowSumsBelow()(Code)
	get if row summaries appear below detail in the outline below or not

getRowSumsRight
public boolean getRowSumsRight()(Code)
	get if col summaries appear right of the detail in the outline right or not

getScenarioProtect
public boolean getScenarioProtect()(Code)
	Answer whether scenario protection is enabled or disabled true => protection enabled; false => protection disabled

getSheet
protected Sheet getSheet()(Code)
	used internally in the API to get the low level Sheet record represented by this Object. Sheet - low level representation of this HSSFSheet.

getTopRow
public short getTopRow()(Code)
	The top row in the visible view when the sheet is first viewed after opening it in a viewer short indicating the rownum (0 based) of the top row

getVerticallyCenter
public boolean getVerticallyCenter(boolean value)(Code)
	Determine whether printed output for this sheet will be vertically centered.

groupColumn
public void groupColumn(short fromColumn, short toColumn)(Code)
	Create an outline for the provided column range. Parameters: fromColumn - beginning of the column range. Parameters: toColumn - end of the column range.

groupRow
public void groupRow(int fromRow, int toRow)(Code)

insertChartRecords
protected void insertChartRecords(List records)(Code)

isColumnBroken
public boolean isColumnBroken(short column)(Code)
	Determines if there is a page break at the indicated column Parameters: column - FIXME: Document this! FIXME: Document this!

isColumnHidden
public boolean isColumnHidden(short column)(Code)
	Get the hidden state for a given column. Parameters: column - - the column to set (0-based) hidden - the visiblity state of the column

isDisplayFormulas
public boolean isDisplayFormulas()(Code)
	Returns if formulas are displayed. whether formulas are displayed

isDisplayGridlines
public boolean isDisplayGridlines()(Code)
	Returns if gridlines are displayed. whether gridlines are displayed

isDisplayRowColHeadings
public boolean isDisplayRowColHeadings()(Code)
	Returns if RowColHeadings are displayed. whether RowColHeadings are displayed

isGridsPrinted
public boolean isGridsPrinted()(Code)
	get whether gridlines are printed. true if printed

isPrintGridlines
public boolean isPrintGridlines()(Code)
	Returns whether gridlines are printed. Gridlines are printed

isRowBroken
public boolean isRowBroken(int row)(Code)
	Determines if there is a page break at the indicated row Parameters: row - FIXME: Document this! FIXME: Document this!

protectSheet
public void protectSheet(String password)(Code)
	Sets the protection enabled as well as the password Parameters: password - to set for protection

removeColumnBreak
public void removeColumnBreak(short column)(Code)
	Removes a page break at the indicated column Parameters: column -

removeMergedRegion
public void removeMergedRegion(int index)(Code)
	removes a merged region of cells (hence letting them free) Parameters: index - of the region to unmerge

removeRow
public void removeRow(HSSFRow row)(Code)
	Remove a row from this sheet. All cells contained in the row are removed as well Parameters: row - representing a row to remove.

removeRowBreak
public void removeRowBreak(int row)(Code)
	Removes the page break at the indicated row Parameters: row -

rowIterator
public Iterator rowIterator()(Code)
	an iterator of the PHYSICAL rows. Meaning the 3rd element may notbe the third row if say for instance the second row is undefined.

setAlternativeExpression
public void setAlternativeExpression(boolean b)(Code)
	whether alternate expression evaluation is on Parameters: b - alternative expression evaluation or not

setAlternativeFormula
public void setAlternativeFormula(boolean b)(Code)
	whether alternative formula entry is on Parameters: b - alternative formulas or not

setAutobreaks
public void setAutobreaks(boolean b)(Code)
	show automatic page breaks or not Parameters: b - whether to show auto page breaks

setColumnBreak
public void setColumnBreak(short column)(Code)
	Sets a page break at the indicated column Parameters: column -

setColumnGroupCollapsed
public void setColumnGroupCollapsed(short columnNumber, boolean collapsed)(Code)
	Expands or collapses a column group. Parameters: columnNumber - One of the columns in the group. Parameters: collapsed - true = collapse group, false = expand group.

setColumnHidden
public void setColumnHidden(short column, boolean hidden)(Code)
	Get the visibility state for a given column. Parameters: column - - the column to get (0-based) Parameters: hidden - - the visiblity state of the column

setColumnWidth
public void setColumnWidth(short column, short width)(Code)
	set the width (in units of 1/256th of a character width) Parameters: column - - the column to set (0-based) Parameters: width - - the width in units of 1/256th of a character width

setDefaultColumnStyle
public void setDefaultColumnStyle(short column, HSSFCellStyle style)(Code)
	Sets the default column style for a given column. POI will only apply this style to new cells added to the sheet. Parameters: column - the column index Parameters: style - the style to set

setDefaultColumnWidth
public void setDefaultColumnWidth(short width)(Code)
	set the default column width for the sheet (if the columns do not define their own width) in characters Parameters: width - default column width

setDefaultRowHeight
public void setDefaultRowHeight(short height)(Code)
	set the default row height for the sheet (if the rows do not define their own height) in twips (1/20 of a point) Parameters: height - default row height

setDefaultRowHeightInPoints
public void setDefaultRowHeightInPoints(float height)(Code)
	set the default row height for the sheet (if the rows do not define their own height) in points Parameters: height - default row height

setDialog
public void setDialog(boolean b)(Code)
	set whether sheet is a dialog sheet or not Parameters: b - isDialog or not

setDisplayFormulas
public void setDisplayFormulas(boolean show)(Code)
	Sets whether the formulas are shown in a viewer. Parameters: show - whether to show formulas or not

setDisplayGridlines
public void setDisplayGridlines(boolean show)(Code)
	Sets whether the gridlines are shown in a viewer. Parameters: show - whether to show gridlines or not

setDisplayGuts
public void setDisplayGuts(boolean b)(Code)
	set whether to display the guts or not Parameters: b - guts or no guts (or glory)

setDisplayRowColHeadings
public void setDisplayRowColHeadings(boolean show)(Code)
	Sets whether the RowColHeadings are shown in a viewer. Parameters: show - whether to show RowColHeadings or not

setFitToPage
public void setFitToPage(boolean b)(Code)
	fit to page option is on Parameters: b - fit or not

setGridsPrinted
public void setGridsPrinted(boolean value)(Code)
	set whether gridlines printed. Parameters: value - false if not printed.

setHorizontallyCenter
public void setHorizontallyCenter(boolean value)(Code)
	determines whether the output is horizontally centered on the page. Parameters: value - true to horizontally center, false otherwise.

setMargin
public void setMargin(short margin, double size)(Code)
	Sets the size of the margin in inches. Parameters: margin - which margin to get Parameters: size - the size of the margin

setPrintGridlines
public void setPrintGridlines(boolean newPrintGridlines)(Code)
	Turns on or off the printing of gridlines. Parameters: newPrintGridlines - boolean to turn on or off the printing ofgridlines

setProtect
public void setProtect(boolean protect)(Code)
	Sets the protection on enabled or disabled Parameters: protect - true => protection enabled; false => protection disabled

setRowBreak
public void setRowBreak(int row)(Code)
	Sets a page break at the indicated row Parameters: row - FIXME: Document this!

setRowGroupCollapsed
public void setRowGroupCollapsed(int row, boolean collapse)(Code)

setRowSumsBelow
public void setRowSumsBelow(boolean b)(Code)
	set if row summaries appear below detail in the outline Parameters: b - below or not

setRowSumsRight
public void setRowSumsRight(boolean b)(Code)
	set if col summaries appear right of the detail in the outline Parameters: b - right or not

setSelected
public void setSelected(boolean sel)(Code)
	Sets whether sheet is selected. Parameters: sel - Whether to select the sheet or deselect the sheet.

setVerticallyCenter
public void setVerticallyCenter(boolean value)(Code)
	determines whether the output is vertically centered on the page. Parameters: value - true to vertically center, false otherwise.

setZoom
public void setZoom(int numerator, int denominator)(Code)
	Sets the zoom magnication for the sheet. The zoom is expressed as a fraction. For example to express a zoom of 75% use 3 for the numerator and 4 for the denominator. Parameters: numerator - The numerator for the zoom magnification. Parameters: denominator - The denominator for the zoom magnification.

shiftMerged
protected void shiftMerged(int startRow, int endRow, int n, boolean isRow)(Code)
	Shifts the merged regions left or right depending on mode TODO: MODE , this is only row specific Parameters: startRow - Parameters: endRow - Parameters: n - Parameters: isRow -

shiftRows
public void shiftRows(int startRow, int endRow, int n)(Code)
	Shifts rows between startRow and endRow n number of rows. If you use a negative number, it will shift rows up. Code ensures that rows don't wrap around. Calls shiftRows(startRow, endRow, n, false, false); Additionally shifts merged regions that are completely defined in these rows (ie. merged 2 cells on a row to be shifted). Parameters: startRow - the row to start shifting Parameters: endRow - the row to end shifting Parameters: n - the number of rows to shift

shiftRows

public void shiftRows(int startRow, int endRow, int n, boolean copyRowHeight, boolean resetOriginalRowHeight)(Code)

Shifts rows between startRow and endRow n number of rows. If you use a negative number, it will shift rows up. Code ensures that rows don't wrap around

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
Parameters:
  startRow - the row to start shifting
Parameters:
  endRow - the row to end shifting
Parameters:
  n - the number of rows to shift
Parameters:
  copyRowHeight - whether to copy the row height during the shift
Parameters:
  resetOriginalRowHeight - whether to set the original row's height to the default

showInPane
public void showInPane(short toprow, short leftcol)(Code)
	Sets desktop window pane display area, when the file is first opened in a viewer. Parameters: toprow - the top row to show in desktop window pane Parameters: leftcol - the left column to show in desktop window pane

ungroupColumn
public void ungroupColumn(short fromColumn, short toColumn)(Code)

ungroupRow
public void ungroupRow(int fromRow, int toRow)(Code)

validateColumn
protected void validateColumn(short column)(Code)
	Runs a bounds check for column numbers Parameters: column -

validateRow
protected void validateRow(int row)(Code)
	Runs a bounds check for row numbers Parameters: row -

Methods inherited from java.lang.Object

native protected Object clone() throws CloneNotSupportedException(Code)(Java Doc)
public boolean equals(Object obj)(Code)(Java Doc)
protected void finalize() throws Throwable(Code)(Java Doc)
final native public Class getClass()(Code)(Java Doc)
native public int hashCode()(Code)(Java Doc)
final native public void notify()(Code)(Java Doc)
final native public void notifyAll()(Code)(Java Doc)
public String toString()(Code)(Java Doc)
final native public void wait(long timeout) throws InterruptedException(Code)(Java Doc)
final public void wait(long timeout, int nanos) throws InterruptedException(Code)(Java Doc)
final public void wait() throws InterruptedException(Code)(Java Doc)

www.java2java.com | Contact Us

All other trademarks are property of their respective owners.