oracle.dss.gridView
Interface GridViewCommon

All Superinterfaces:

ComponentTypeConverter, DataviewCommon

All Known Subinterfaces:

TableCommon, UICrosstab, UIGridView, UITable

All Known Implementing Classes:

GridView, ThinGridView

public interface GridViewCommon

extends DataviewCommon

Methods that are common to Java-client GridView objects and HTML-client GridView objects.

Field Summary

static int	ABSOLUTE_COLUMN_SIZING HTML column sizing: Use absolute sizing.
static int	COLUMN_BANDING Banding: Highlight every other column in thin tables and crosstab.
static int	NO_BANDING Banding: Do not use any banding in thin tables and crosstabs.
static int	NO_COLUMN_SIZING HTML column sizing: Use no special sizing.
static int	RELATIVE_COLUMN_SIZING HTML column sizing: Use relative sizing.
static int	ROW_BANDING Banding: Highlight every other row in thin tables and crosstab.

Method Summary

int	getBanding() Retrieves the banding option for this GridViewCommon.
int	getCellMaxHeight() Retrieves the maximum height for cells in this GridViewCommon, in pixels.
int	getCellMaxWidth() Retrieves the maximum width for cells in this GridViewCommon, in pixels.
int	getCellMinHeight() Retrieves the minimum height for cells in this GridViewCommon, in pixels.
int	getCellMinWidth() Retrieves the minimum width for cells in this GridViewCommon, in pixels.
int	getHTMLColumnSizing() Retrieves the HTML column sizing option.
int	getHTMLRowBlockSize() Retrieves the number of rows that appear on each page of a printed thin table or crosstab.
java.lang.Integer	getHTMLTableCellPadding() Retrieves the cell padding for thin tables and crosstab.
java.lang.String	getHTMLTableWidth() Retrieves the width of the HTML table in a thin table or crosstab.
int	getHTMLTextInputSize() Retrieves the number of characters that are displayed in editable cells.
void	setBanding(int banding) Specifies the banding option for this ThinGridView.
void	setDefaultCornerComponentColor(java.awt.Color c) Specifies a default background color for the corner component.
void	setHTMLColumnSizing(int htmlColumnSizing) Specifies the HTML column sizing option.
void	setHTMLRowBlockSize(int size) Specifies the number of rows that appear on each page of a printed thin table or crosstab.
void	setHTMLTableCellPadding(java.lang.Integer padding) Retrieves the cell padding for thin tables and crosstab.
void	setHTMLTableWidth(java.lang.String width) Retrieves the width of the HTML table in a thin table or crosstab.
void	setHTMLTextInputSize(int size) Specifies the number of characters to display in editable cells.

Methods inherited from interface oracle.dss.dataView.DataviewCommon

getDataSource, getErrorHandler, getHTMLPagingControlWidth, getLocale, getModel, isHTMLPagingControlAutosubmit, setDataSource, setHTMLPagingControlAutosubmit, setHTMLPagingControlWidth

Methods inherited from interface oracle.dss.rules.ComponentTypeConverter

convertComponentTypeToInteger, convertComponentTypeToString

Field Detail

NO_COLUMN_SIZING

public static final int NO_COLUMN_SIZING

HTML column sizing: Use no special sizing. Column width depends solely on the contents of the cells in the column.

ABSOLUTE_COLUMN_SIZING

public static final int ABSOLUTE_COLUMN_SIZING

HTML column sizing: Use absolute sizing. Column width is specified in pixels. For HMTL tables, using this setting can cause problems with display.

RELATIVE_COLUMN_SIZING

public static final int RELATIVE_COLUMN_SIZING

HTML column sizing: Use relative sizing. Column width is specified in percentages of the table width. If you set the size of columns in a Java-client table or crosstab in JDeveloper, then use this setting to translate the widths to the thin table or crosstab.

NO_BANDING

public static final int NO_BANDING

Banding: Do not use any banding in thin tables and crosstabs.

ROW_BANDING

public static final int ROW_BANDING

Banding: Highlight every other row in thin tables and crosstab.

COLUMN_BANDING

public static final int COLUMN_BANDING

Banding: Highlight every other column in thin tables and crosstab.

Method Detail

getCellMaxHeight

public int getCellMaxHeight()

Retrieves the maximum height for cells in this GridViewCommon, in pixels.

Returns:

The maximum height for cells in this GridViewCommon.

getCellMinHeight

public int getCellMinHeight()

Retrieves the minimum height for cells in this GridViewCommon, in pixels.

Returns:

The minimum height for cells in this GridViewCommon.

getCellMaxWidth

public int getCellMaxWidth()

Retrieves the maximum width for cells in this GridViewCommon, in pixels.

Returns:

The maximum width for cells in this GridViewCommon.

getCellMinWidth

public int getCellMinWidth()

Retrieves the minimum width for cells in this GridViewCommon, in pixels.

Returns:

The minimum width for cells in this GridViewCommon.

setDefaultCornerComponentColor

public void setDefaultCornerComponentColor(java.awt.Color c)

Specifies a default background color for the corner component. The color that you pass is set as the new corner component color, and it becomes the default value. When the GridViewCommon generates XML of the changed property values, it will not contain the color component property.

Parameters:

c - The default background color to use for the corner component.

setBanding

public void setBanding(int banding)

Specifies the banding option for this ThinGridView. This property is currently only used for the thin beans.

Banding can highlight every other row or every other column.

Parameters:

banding - A constant that identifies the kind of banding to use. Valid constants are listed in the See Also section.

See Also:

ROW_BANDING, COLUMN_BANDING, NO_BANDING

getBanding

public int getBanding()

Retrieves the banding option for this GridViewCommon. This property is currently only used for the thin beans.

Returns:

A constant that identifies the kind of banding that this GridViewCommon uses. Valid constants are listed in the See Also section.

See Also:

ROW_BANDING, COLUMN_BANDING, NO_BANDING

setHTMLColumnSizing

public void setHTMLColumnSizing(int htmlColumnSizing)

Specifies the HTML column sizing option. This property is used for the thin beans only.

By default, column sizes are determined only by the size of the contents of each column (NO_COLUMN_SIZING).

Note: If this setting causes text to be truncated, most browsers ignore this setting.

Parameters:

htmlColumnSizing - A constant that specifies the kind of column-sizing to use in thin tables and crosstabs. Valid values are listed in the See Also section.

See Also:

NO_COLUMN_SIZING, ABSOLUTE_COLUMN_SIZING, RELATIVE_COLUMN_SIZING

getHTMLColumnSizing

public int getHTMLColumnSizing()

Retrieves the HTML column sizing option. This property is used for the thin beans only.

Note: If this setting causes text to be truncated, most browsers ignore this setting.

Returns:

A constant that specifies the kind of column-sizing that this GridViewCommon uses.

See Also:

NO_COLUMN_SIZING, ABSOLUTE_COLUMN_SIZING, RELATIVE_COLUMN_SIZING

setHTMLRowBlockSize

public void setHTMLRowBlockSize(int size)

Specifies the number of rows that appear on each page of a printed thin table or crosstab. This property is used for the thin beans only.

Parameters:

size - The number of rows to print on a page of a thin table or crosstab.

getHTMLRowBlockSize

public int getHTMLRowBlockSize()

Retrieves the number of rows that appear on each page of a printed thin table or crosstab. This property is used for the thin beans only.

getHTMLTableCellPadding

public java.lang.Integer getHTMLTableCellPadding()

Retrieves the cell padding for thin tables and crosstab. Cell padding is the area between the text and the cell borders. This property is used for the thin beans only.

setHTMLTableCellPadding

public void setHTMLTableCellPadding(java.lang.Integer padding)

Retrieves the cell padding for thin tables and crosstab. Cell padding is the area between the text and the cell borders. This property is used for the thin beans only.

Parameters:

padding - The number of pixels that you want between the text and the borders of the cell.

getHTMLTableWidth

public java.lang.String getHTMLTableWidth()

Retrieves the width of the HTML table in a thin table or crosstab. This property is used for the thin beans only.

Note: If this setting causes text to be truncated, most browsers ignore this setting.

setHTMLTableWidth

public void setHTMLTableWidth(java.lang.String width)

Retrieves the width of the HTML table in a thin table or crosstab. This property is used for the thin beans only.

Note: If this setting causes text to be truncated, most browsers ignore this setting.

Parameters:

width - The width of the HTML table, in pixels.

setHTMLTextInputSize

public void setHTMLTextInputSize(int size)

Specifies the number of characters to display in editable cells. This property is used for the thin beans only.

Parameters:

size - The number of characters to display in editable cells.

getHTMLTextInputSize

public int getHTMLTextInputSize()

Retrieves the number of characters that are displayed in editable cells. This property is used for the thin beans only.

Returns:

The number of characters to display in editable cells.