|
Oracle Outside In Java API Reference 8.5.4 F11002-01 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object
com.oracle.outsidein.options.GridWrapInfo
public class GridWrapInfo
Describes the method of wrapping grids in a spreadsheet or database source file. Specifying the grid wrap information is only useful when exporting to the FileFormat.FI_HTML
destination format and when a grid-enabled template has been specified in OptionsCache.setExportTemplate(java.io.File)
.
OptionsCache.getGridWrap()
, OptionsCache.setGridWrap(GridWrapInfo)
Nested Class Summary | |
---|---|
static class |
GridWrapInfo.AdvanceModeValue Values indicating how the grids.next.body template element is used when traversing a source spreadsheet or database. |
Constructor Summary | |
---|---|
GridWrapInfo() Creates a default grid wrap object with no members initialized |
|
GridWrapInfo(boolean enabled) Creates a grid wrap object with the grid wrapping set to either enabled or disabled. |
|
GridWrapInfo(boolean enabled, long rows, long columns, GridWrapInfo.AdvanceModeValue advanceMode) Creates a grid wrap object supplied with all possible grid wrap data. |
Method Summary | |
---|---|
GridWrapInfo.AdvanceModeValue |
getAdvanceMode() Obtains the current setting for the method to traverse a source spreadsheet or database when using a grid-enabled template. |
long |
getMaxColumns() Obtains the maximum number of columms that each template "grid" (applicable only to spreadsheet or database files) should contain. |
long |
getMaxRows() Obtains the maximum number of rows that each template "grid" (applicable only to spreadsheet or database files) should contain. |
boolean |
isWrappingEnabled() |
void |
setAdvanceMode(GridWrapInfo.AdvanceModeValue mode) Specifies how the technology will interpret the "previous" and "next" grid cells for a spreadsheet or database source file when using a grid-enabled template. |
void |
setMaxColumns(long columns) Specifies the maximum number of columms that each template "grid" (applicable only to spreadsheet or database files) should contain. |
void |
setMaxRows(long rows) Specifies the maximum number of rows that each template "grid" (applicable only to spreadsheet or database files) should contain. |
void |
setWrappingEnabled(boolean enabled) Specifies whether the "previous" and "next" relationships "wrap" at the edges of the spreadsheet or database. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public GridWrapInfo()
public GridWrapInfo(boolean enabled)
enabled
- whether grid wrapping on spreadsheet or database source files is on or offpublic GridWrapInfo(boolean enabled, long rows, long columns, GridWrapInfo.AdvanceModeValue advanceMode)
enabled
- whether grid wrapping on spreadsheet or database source files is on or offrows
- the maximum number of rows that each template "grid" should containcolumns
- the maximum number of columns that each template "grid" should containadvanceMode
- the method of traversing cells in a source spreadsheet or database when using the grids.next.body template elementMethod Detail |
---|
public GridWrapInfo.AdvanceModeValue getAdvanceMode()
public void setAdvanceMode(GridWrapInfo.AdvanceModeValue mode)
mode
- the method of traversing cells in a source spreadsheet or database when using the grids.next.body template elementpublic boolean isWrappingEnabled()
public void setWrappingEnabled(boolean enabled)
public long getMaxRows()
public void setMaxRows(long rows)
rows
- the number of rowspublic long getMaxColumns()
public void setMaxColumns(long columns)
columns
- the number of columns
|
Oracle Outside In Java API Reference 8.5.4 F11002-01 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |