Package com.groupdocs.cloud.viewer.model

Class SpreadsheetOptions

java.lang.Object

com.groupdocs.cloud.viewer.model.SpreadsheetOptions

public class SpreadsheetOptions
extends Object

Rendering options for Spreadsheet file formats. Spreadsheet file formats include files with extensions: .xls, .xlsx, .xlsm, .xlsb, .csv, .ods, .ots, .xltx, .xltm, .tsv

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	SpreadsheetOptions.TextOverflowModeEnum	The text overflow mode for rendering spreadsheet documents into HTML

Constructor Summary

Constructors

Constructor	Description
SpreadsheetOptions()

Method Summary

Modifier and Type	Method	Description
SpreadsheetOptions	countColumnsPerPage(Integer countColumnsPerPage)
SpreadsheetOptions	countRowsPerPage(Integer countRowsPerPage)
boolean	equals(Object o)
Integer	getCountColumnsPerPage()	The columns count to include into each page when splitting worksheet into pages.
Integer	getCountRowsPerPage()	The number of rows rendered into one page when PaginateSheets is enabled.
Boolean	getPaginateSheets()	Allows to enable worksheets pagination.
Boolean	getRenderEmptyColumns()	By default empty columns are skipped.
Boolean	getRenderEmptyRows()	By default empty rows are skipped.
Boolean	getRenderGridLines()	Indicates whether to render grid lines
Boolean	getRenderHeadings()	Enables headings rendering.
Boolean	getRenderHiddenColumns()	Enables rendering of hidden columns.
Boolean	getRenderHiddenRows()	Enables rendering of hidden rows.
Boolean	getRenderPrintAreaOnly()	Enables rendering worksheet(s) sections which is defined as print area.
SpreadsheetOptions.TextOverflowModeEnum	getTextOverflowMode()	The text overflow mode for rendering spreadsheet documents into HTML
int	hashCode()
SpreadsheetOptions	paginateSheets(Boolean paginateSheets)
SpreadsheetOptions	renderEmptyColumns(Boolean renderEmptyColumns)
SpreadsheetOptions	renderEmptyRows(Boolean renderEmptyRows)
SpreadsheetOptions	renderGridLines(Boolean renderGridLines)
SpreadsheetOptions	renderHeadings(Boolean renderHeadings)
SpreadsheetOptions	renderHiddenColumns(Boolean renderHiddenColumns)
SpreadsheetOptions	renderHiddenRows(Boolean renderHiddenRows)
SpreadsheetOptions	renderPrintAreaOnly(Boolean renderPrintAreaOnly)
void	setCountColumnsPerPage(Integer countColumnsPerPage)
void	setCountRowsPerPage(Integer countRowsPerPage)
void	setPaginateSheets(Boolean paginateSheets)
void	setRenderEmptyColumns(Boolean renderEmptyColumns)
void	setRenderEmptyRows(Boolean renderEmptyRows)
void	setRenderGridLines(Boolean renderGridLines)
void	setRenderHeadings(Boolean renderHeadings)
void	setRenderHiddenColumns(Boolean renderHiddenColumns)
void	setRenderHiddenRows(Boolean renderHiddenRows)
void	setRenderPrintAreaOnly(Boolean renderPrintAreaOnly)
void	setTextOverflowMode(SpreadsheetOptions.TextOverflowModeEnum textOverflowMode)
SpreadsheetOptions	textOverflowMode(SpreadsheetOptions.TextOverflowModeEnum textOverflowMode)
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

SpreadsheetOptions

public SpreadsheetOptions()

Method Detail

paginateSheets

public SpreadsheetOptions paginateSheets(Boolean paginateSheets)

getPaginateSheets

public Boolean getPaginateSheets()

Allows to enable worksheets pagination. By default one worksheet is rendered into one page.

Returns:

paginateSheets

setPaginateSheets

public void setPaginateSheets(Boolean paginateSheets)

countRowsPerPage

public SpreadsheetOptions countRowsPerPage(Integer countRowsPerPage)

getCountRowsPerPage

public Integer getCountRowsPerPage()

The number of rows rendered into one page when PaginateSheets is enabled. Default value is 50.

Returns:

countRowsPerPage

setCountRowsPerPage

public void setCountRowsPerPage(Integer countRowsPerPage)

countColumnsPerPage

public SpreadsheetOptions countColumnsPerPage(Integer countColumnsPerPage)

getCountColumnsPerPage

public Integer getCountColumnsPerPage()

The columns count to include into each page when splitting worksheet into pages.

Returns:

countColumnsPerPage

setCountColumnsPerPage

public void setCountColumnsPerPage(Integer countColumnsPerPage)

renderGridLines

public SpreadsheetOptions renderGridLines(Boolean renderGridLines)

getRenderGridLines

public Boolean getRenderGridLines()

Indicates whether to render grid lines

Returns:

renderGridLines

setRenderGridLines

public void setRenderGridLines(Boolean renderGridLines)

renderEmptyRows

public SpreadsheetOptions renderEmptyRows(Boolean renderEmptyRows)

getRenderEmptyRows

public Boolean getRenderEmptyRows()

By default empty rows are skipped. Enable this option in case you want to render empty rows.

Returns:

renderEmptyRows

setRenderEmptyRows

public void setRenderEmptyRows(Boolean renderEmptyRows)

renderEmptyColumns

public SpreadsheetOptions renderEmptyColumns(Boolean renderEmptyColumns)

getRenderEmptyColumns

public Boolean getRenderEmptyColumns()

By default empty columns are skipped. Enable this option in case you want to render empty columns.

Returns:

renderEmptyColumns

setRenderEmptyColumns

public void setRenderEmptyColumns(Boolean renderEmptyColumns)

renderHiddenRows

public SpreadsheetOptions renderHiddenRows(Boolean renderHiddenRows)

getRenderHiddenRows

public Boolean getRenderHiddenRows()

Enables rendering of hidden rows.

Returns:

renderHiddenRows

setRenderHiddenRows

public void setRenderHiddenRows(Boolean renderHiddenRows)

renderHiddenColumns

public SpreadsheetOptions renderHiddenColumns(Boolean renderHiddenColumns)

getRenderHiddenColumns

public Boolean getRenderHiddenColumns()

Enables rendering of hidden columns.

Returns:

renderHiddenColumns

setRenderHiddenColumns

public void setRenderHiddenColumns(Boolean renderHiddenColumns)

renderHeadings

public SpreadsheetOptions renderHeadings(Boolean renderHeadings)

getRenderHeadings

public Boolean getRenderHeadings()

Enables headings rendering.

Returns:

renderHeadings

setRenderHeadings

public void setRenderHeadings(Boolean renderHeadings)

renderPrintAreaOnly

public SpreadsheetOptions renderPrintAreaOnly(Boolean renderPrintAreaOnly)

getRenderPrintAreaOnly

public Boolean getRenderPrintAreaOnly()

Enables rendering worksheet(s) sections which is defined as print area. Renders each print area in a worksheet as a separate page.

Returns:

renderPrintAreaOnly

setRenderPrintAreaOnly

public void setRenderPrintAreaOnly(Boolean renderPrintAreaOnly)

textOverflowMode

public SpreadsheetOptions textOverflowMode(SpreadsheetOptions.TextOverflowModeEnum textOverflowMode)

getTextOverflowMode

public SpreadsheetOptions.TextOverflowModeEnum getTextOverflowMode()

The text overflow mode for rendering spreadsheet documents into HTML

Returns:

textOverflowMode

setTextOverflowMode

public void setTextOverflowMode(SpreadsheetOptions.TextOverflowModeEnum textOverflowMode)

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object