public class SpreadsheetOptions extends Object
Provides options for rendering spreadsheets.
Modifier and Type | Field and Description |
---|---|
static int |
CountRowsPerPageDefault |
Modifier and Type | Method and Description |
---|---|
static SpreadsheetOptions |
forOnePagePerSheet()
Initializes new instance of
SpreadsheetOptions class for rendering whole sheet into page. |
static SpreadsheetOptions |
forRenderingPrintArea()
Initializes new instance of
SpreadsheetOptions for rendering print areas only. |
static SpreadsheetOptions |
forSplitSheetIntoPages(int countRowsPerPage)
Initializes new instance of
SpreadsheetOptions for rendering sheet into pages. |
int |
getCountRowsPerPage()
The rows count to include into each page when splitting worksheet into pages.
|
TextOverflowMode |
getTextOverflowMode()
The text overflow mode for rendering spreadsheet documents into HTML.
|
boolean |
isOnePagePerSheet()
Indicates that one sheet is rendered into one page.
|
boolean |
isRenderGridLines()
Enables grid lines rendering.
|
boolean |
isRenderHiddenColumns()
Enables hidden columns rendering.
|
boolean |
isRenderHiddenRows()
Enables hidden rows rendering.
|
boolean |
isRenderPrintAreaOnly()
Indicates that only print areas are rendered.
|
boolean |
isSkipEmptyColumns()
Disables empty columns rendering.
|
boolean |
isSkipEmptyRows()
Disables empty rows rendering.
|
boolean |
isSplitIntoPages() |
void |
setRenderGridLines(boolean value)
Enables grid lines rendering.
|
void |
setRenderHiddenColumns(boolean value)
Enables hidden columns rendering.
|
void |
setRenderHiddenRows(boolean value)
Enables hidden rows rendering.
|
void |
setSkipEmptyColumns(boolean value)
Disables empty columns rendering.
|
void |
setSkipEmptyRows(boolean value)
Disables empty rows rendering.
|
void |
setTextOverflowMode(TextOverflowMode value)
The text overflow mode for rendering spreadsheet documents into HTML.
|
public static final int CountRowsPerPageDefault
public static SpreadsheetOptions forOnePagePerSheet()
Initializes new instance of SpreadsheetOptions
class for rendering whole sheet into page.
SpreadsheetOptions
class for rendering one sheet into one page.public static SpreadsheetOptions forRenderingPrintArea()
Initializes new instance of SpreadsheetOptions
for rendering print areas only.
SpreadsheetOptions
for rendering print areas only.public static SpreadsheetOptions forSplitSheetIntoPages(int countRowsPerPage) throws IllegalArgumentException
Initializes new instance of SpreadsheetOptions
for rendering sheet into pages.
countRowsPerPage
- Rows count to include into each page.SpreadsheetOptions
for rendering sheet into pages.IllegalArgumentException
- Thrown when countRowsPerPage is equals or less than zero.public final int getCountRowsPerPage()
The rows count to include into each page when splitting worksheet into pages.
public final TextOverflowMode getTextOverflowMode()
The text overflow mode for rendering spreadsheet documents into HTML.
public final boolean isOnePagePerSheet()
Indicates that one sheet is rendered into one page.
public final boolean isRenderGridLines()
Enables grid lines rendering.
public final boolean isRenderHiddenColumns()
Enables hidden columns rendering.
public final boolean isRenderHiddenRows()
Enables hidden rows rendering.
public final boolean isRenderPrintAreaOnly()
Indicates that only print areas are rendered.
public final boolean isSkipEmptyColumns()
Disables empty columns rendering.
public final boolean isSkipEmptyRows()
Disables empty rows rendering.
public boolean isSplitIntoPages()
public final void setRenderGridLines(boolean value)
Enables grid lines rendering.
public final void setRenderHiddenColumns(boolean value)
Enables hidden columns rendering.
public final void setRenderHiddenRows(boolean value)
Enables hidden rows rendering.
public final void setSkipEmptyColumns(boolean value)
Disables empty columns rendering.
public final void setSkipEmptyRows(boolean value)
Disables empty rows rendering.
public final void setTextOverflowMode(TextOverflowMode value)
The text overflow mode for rendering spreadsheet documents into HTML.
value
- The text overflow mode for rendering spreadsheet documents into HTML.