oracle.dss.gridView
Interface GridViewSizingManager

All Superinterfaces:

Manager

All Known Subinterfaces:

CrosstabSizingManager, TableSizingManager

public interface GridViewSizingManager

extends Manager

This interface defines the API to which a class implementing custom data sizing for a GridView must adhere.

Field Summary

static int

NO_SIZE Indicates that there is no particular size to be applied based on this request to the manager.

Method Summary

void	clearCalculatedSizes() Clear all calculated sizes.
void	clearPreferredSizes() Clear all preferred sizes.
int	getCalculatedColumnWidth(int column) Get the calculated width for a column.
int	getCalculatedRowHeight(int row) Get the calculated height for a row.
int	getColumnWidth(int column) Get the width of a column in the GridView.
int	getDefaultColumnHeaderRowHeight() Get the default height for the column header row(s).
int	getDefaultColumnWidth() Get the default width for all databody columns.
int	getDefaultRowHeaderColumnWidth() Get the default width for the row header column(s).
int	getDefaultRowHeight() Get the default height for all databody rows.
int	getPreferredColumnWidth(int column) Get the preferred width for a column.
int	getPreferredRowHeight(int row) Get the preferred height for a row.
int	getRowHeight(int row) Get the height of a row in the GridView.
void	reset() Reset the manager back to its initial state.
void	setCalculatedColumnWidth(int column, int width) Set the calculated width for a column.
void	setCalculatedRowHeight(int row, int height) Set the calculated height for a row.
void	setDefaultColumnHeaderRowHeight(int height) Set the default height for the column header row(s).
void	setDefaultColumnWidth(int width) Set the default width for all databody columns.
void	setDefaultRowHeaderColumnWidth(int width) Set the default width for the row header column(s).
void	setDefaultRowHeight(int height) Set the default height for all databody rows.
void	setPreferredColumnWidth(int column, int width) Set the preferred width for a column.
void	setPreferredRowHeight(int row, int height) Set the preferred height for a row.

Methods inherited from interface oracle.dss.dataView.Manager

dataSourceChanged

Field Detail

NO_SIZE

public static final int NO_SIZE

Indicates that there is no particular size to be applied based on this request to the manager.

Method Detail

setDefaultRowHeight

public void setDefaultRowHeight(int height)

Set the default height for all databody rows.

Parameters:

height - the new default height for all databody rows, in pixels

getDefaultRowHeight

public int getDefaultRowHeight()

Get the default height for all databody rows.

Returns:

the default height for all databody rows, in pixels

setDefaultColumnWidth

public void setDefaultColumnWidth(int width)

Set the default width for all databody columns.

Parameters:

width - the new default width for all databody columns, in pixels

getDefaultColumnWidth

public int getDefaultColumnWidth()

Get the default width for all databody columns.

Returns:

the default width for all databody columns, in pixels

setCalculatedRowHeight

public void setCalculatedRowHeight(int row,
                                   int height)

Set the calculated height for a row. The GridView uses this method when setting a height calculated by autofit. Applications probably do not need to call this directly.

Parameters:

row - the row whose height will be set

height - the new calculated height for the row, in pixels; can be NO_SIZE in order to clear a previously set value

getCalculatedRowHeight

public int getCalculatedRowHeight(int row)

Get the calculated height for a row. The calculated height is set by the GridView during an autofit. Applications probably do not need to call this directly.

Parameters:

row - the row in question

Returns:

the calculated height for the row, in pixels; returns NO_SIZE if no calculated height has been set for the row

setCalculatedColumnWidth

public void setCalculatedColumnWidth(int column,
                                     int width)

Set the calculated width for a column. The GridView uses this method when setting a width calculated by autofit. Applications probably do not need to call this directly.

Parameters:

column - the column whose width will be set

width - the new calculated width for the column, in pixels; can be NO_SIZE in order to clear a previously set value

getCalculatedColumnWidth

public int getCalculatedColumnWidth(int column)

Get the calculated width for a column. The calculated width is set by the GridView during an autofit. Applications probably do not need to call this directly.

Parameters:

column - the column in question

Returns:

the calculated width for the column, in pixels; returns NO_SIZE if no calculated width has been set for the column

setPreferredRowHeight

public void setPreferredRowHeight(int row,
                                  int height)

Set the preferred height for a row. The preferred height is set by the GridView when the height has been set as a property on the GridView or in response to a user manually resizing a row.

Parameters:

row - row whose height changed.

height - new height, in pixels; can be NO_SIZE in order to clear a previously set value

getPreferredRowHeight

public int getPreferredRowHeight(int row)

Get the preferred height for a row. The preferred height is set by the GridView when the height has been set as a property on the GridView or in response to a user manually resizing a row.

Parameters:

row - the row in question

Returns:

the preferred height for the row, in pixels; can be NO_SIZE if no preferred size has been set for the row

setPreferredColumnWidth

public void setPreferredColumnWidth(int column,
                                    int width)

Set the preferred width for a column. The preferred width is set by the GridView when the width has been set as a property on the GridView or in response to a user manually resizing a column.

Parameters:

column - column whose width changed.

height - new width, in pixels; can be NO_SIZE in order to clear a previously set value

getPreferredColumnWidth

public int getPreferredColumnWidth(int column)

Get the preferred width for a column. The preferred width is set by the GridView when the width has been set as a property on the GridView or in response to a user manually resizing a column.

Parameters:

column - the column in question

Returns:

the preferred width for the column, in pixels; can be NO_SIZE if no preferred size has been set for the column

getRowHeight

public int getRowHeight(int row)

Get the height of a row in the GridView. The height is determined by taking into account default, calculated, and preferred heights for the row, as well as minimum and maximum cell heights on the GridView.

Parameters:

row - row whose height to return

Returns:

height for given row, in pixels

getColumnWidth

public int getColumnWidth(int column)

Get the width of a column in the GridView. The width is determined by taking into account default, calculated, and preferred widths for the column, as well as minimum and maximum cell widths on the GridView.

Parameters:

column - column whose width to return

Returns:

width for given column, in pixels

setDefaultColumnHeaderRowHeight

public void setDefaultColumnHeaderRowHeight(int height)

Set the default height for the column header row(s).

Parameters:

height - the new default height for the column header row(s), in pixels

getDefaultColumnHeaderRowHeight

public int getDefaultColumnHeaderRowHeight()

Get the default height for the column header row(s).

Returns:

the default height for the column header row(s), in pixels

setDefaultRowHeaderColumnWidth

public void setDefaultRowHeaderColumnWidth(int width)

Set the default width for the row header column(s).

Parameters:

width - the new default width for the row header column(s), in pixels

getDefaultRowHeaderColumnWidth

public int getDefaultRowHeaderColumnWidth()

Get the default width for the row header column(s).

Returns:

the default width for the row header column(s), in pixels

clearCalculatedSizes

public void clearCalculatedSizes()

Clear all calculated sizes.

clearPreferredSizes

public void clearPreferredSizes()

Clear all preferred sizes.

reset

public void reset()

Reset the manager back to its initial state.