Skip navigation links

com.oracle.outsidein.options
Class GridWrapInfo

java.lang.Object
com.oracle.outsidein.options.GridWrapInfo

public class GridWrapInfo

extends java.lang.Object

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).

See Also:

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

GridWrapInfo

public GridWrapInfo()

Creates a default grid wrap object with no members initialized

GridWrapInfo

public GridWrapInfo(boolean enabled)

Creates a grid wrap object with the grid wrapping set to either enabled or disabled.

Parameters:

enabled - whether grid wrapping on spreadsheet or database source files is on or off

GridWrapInfo

public GridWrapInfo(boolean enabled,
                    long rows,
                    long columns,
                    GridWrapInfo.AdvanceModeValue advanceMode)

Creates a grid wrap object supplied with all possible grid wrap data.

Parameters:

enabled - whether grid wrapping on spreadsheet or database source files is on or off

rows - the maximum number of rows that each template "grid" should contain

columns - the maximum number of columns that each template "grid" should contain

advanceMode - the method of traversing cells in a source spreadsheet or database when using the grids.next.body template element

Method Detail

getAdvanceMode

public GridWrapInfo.AdvanceModeValue getAdvanceMode()

Obtains the current setting for the method to traverse a source spreadsheet or database when using a grid-enabled template.

Returns:

the method of traversing cells in a spreadsheet or database when using the grids.next.body template element

setAdvanceMode

public 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.

Parameters:

mode - the method of traversing cells in a source spreadsheet or database when using the grids.next.body template element

isWrappingEnabled

public boolean isWrappingEnabled()

setWrappingEnabled

public void setWrappingEnabled(boolean enabled)

Specifies whether the "previous" and "next" relationships "wrap" at the edges of the spreadsheet or database.

getMaxRows

public long getMaxRows()

Obtains the maximum number of rows that each template "grid" (applicable only to spreadsheet or database files) should contain.

Returns:

the number of rows

setMaxRows

public void setMaxRows(long rows)

Specifies the maximum number of rows that each template "grid" (applicable only to spreadsheet or database files) should contain.

Parameters:

rows - the number of rows

getMaxColumns

public long getMaxColumns()

Obtains the maximum number of columms that each template "grid" (applicable only to spreadsheet or database files) should contain.

Returns:

the number of columns

setMaxColumns

public void setMaxColumns(long columns)

Specifies the maximum number of columms that each template "grid" (applicable only to spreadsheet or database files) should contain.

Parameters:

columns - the number of columns

Skip navigation links