oracle.dss.gridView
Interface UIGridView

All Superinterfaces:

ComponentTypeConverter, DataviewCommon, GridViewAttribute, GridViewCommon, PagingControlAttributes, UIDataview

All Known Subinterfaces:

UICrosstab, UITable

All Known Implementing Classes:

GridView, UIGridViewAdapter

public interface UIGridView

extends GridViewCommon, GridViewAttribute, UIDataview

Interface for a GridView. The user interface panels for the crosstab and table call the methods in this interface as it interacts with the view. Implement this interface if you provide a proxy so that the UI panels can be displayed before a view is constructed. This interface is implemented internally and is used by the BI Beans user interface panels. Application developers should not implement this interface.

Fields inherited from interface oracle.dss.gridView.GridViewCommon

ABSOLUTE_COLUMN_SIZING, COLUMN_BANDING, NO_BANDING, NO_COLUMN_SIZING, RELATIVE_COLUMN_SIZING, ROW_BANDING

Method Summary

void	dataAndMetadataStyleChanged() Notifies the view that its data and metadata styles have changed.
int	getAutoFitScope() Retrieves the scope for which autofitting will calculate sizes.
java.awt.Image	getBackgroundImage() Retrieves the background Image for the databody of this GridView.
GridViewHeader	getColumnHeader() Retrieves the column header for this GridView.
GridViewDatabody	getDatabody() Retrieves the databody for this GridView.
java.awt.Color	getGridColor() Retrieves the color of the gridlines in this GridView.
GridViewDatabodyStyleManager	getGridViewDatabodyStyleManager() Retrieves the style manager that this GridView uses.
GridViewFormatManager	getGridViewFormatManager() Retrieves the format manager that this GridView uses.
GridViewHeaderStyleManager	getGridViewHeaderStyleManager() Retrieves the style manager that this GridView uses.
java.awt.Color	getHGridColor() Retrieves the color of the horizontal gridlines in this GridView.
java.util.Locale	getLocale() Retrieves the Locale that this UIDataview uses.
Model	getModel() Get the model for the common view.
PagingControl	getPagingControl() Retrieves the paging control for this GridView.
GridViewHeader	getRowHeader() Retrieves the row header for this GridView.
int	getToolbarUIFormatCount() Retrieves the count of UI defined formats
int	getUIFormatCount() Retrieves the count of UI defined formats
java.util.Vector	getUIFormats() Retrieves the format bundle of UI panel defined formats
java.awt.Color	getVGridColor() Retrieves the color of the vertical gridlines in this GridView.
boolean	isColumnHeaderVisible() Return if column header is visible
boolean	isGrid3D() Indicates whether the gridlines in this GridView have a three-dimensional appearance.
boolean	isHGridVisible() Indicates whether horizontal gridlines are visible in this GridView.
boolean	isRowHeaderVisible() Return if row header is visible
boolean	isVGridVisible() Specifies whether vertical gridlines are visible in this GridView.
void	setAutoFitScope(int scope) Specifies what to automatically set cell sizes for.
void	setBackgroundImage(java.awt.Image image) Specifies an image to display in the databody for this GridView.
void	setColumnHeaderVisible(boolean visible) Set column header visible
void	setGrid3D(boolean b) Specifies whether the gridlines in this GridView appear to be three-dimensional.
void	setGridColor(java.awt.Color color) Specifies the color of the gridlines in this GridView.
void	setHGridColor(java.awt.Color color) Specifies the color of the horizonal gridlines in this GridView.
void	setHGridVisible(boolean b) Specifies whether horizontal gridlines appear in this GridView.
void	setRowHeaderVisible(boolean visible) Set row header visible
void	setToolbarUIFormatCount(int count) Set count of Toolbar defined formats
void	setUIFormatCount(int count) Set count of UI defined formats
void	setUIFormats(java.util.Vector formats) Set format bundle of UI panel defined formats
void	setVGridColor(java.awt.Color color) Specifies the color of the vertical gridlines in this GridView.
void	setVGridVisible(boolean b) Indicates whether vertical gridlines appear in this GridView.

Methods inherited from interface oracle.dss.gridView.GridViewCommon

getBanding, getCellMaxHeight, getCellMaxWidth, getCellMinHeight, getCellMinWidth, getHTMLColumnSizing, getHTMLRowBlockSize, getHTMLTableCellPadding, getHTMLTableWidth, getHTMLTextInputSize, setBanding, setDefaultCornerComponentColor, setHTMLColumnSizing, setHTMLRowBlockSize, setHTMLTableCellPadding, setHTMLTableWidth, setHTMLTextInputSize

Methods inherited from interface oracle.dss.dataView.DataviewCommon

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

Methods inherited from interface oracle.dss.rules.ComponentTypeConverter

convertComponentTypeToInteger, convertComponentTypeToString

Methods inherited from interface oracle.dss.dataView.GridViewAttribute

applyViewFormat, applyViewStyle, getComponentViewFormat, getComponentViewStyle

Methods inherited from interface oracle.dss.dataView.UIDataview

addControllerListener, getDataviewFootnote, getDataviewSubtitle, getDataviewTitle, getSelectedObject, getTokenSubstitution, getViewType, removeControllerListener, setTokenSubstitution

Methods inherited from interface oracle.dss.util.PagingControlAttributes

isPagingControlVisible, setPagingControlVisible

Method Detail

getLocale

public java.util.Locale getLocale()

Retrieves the Locale that this UIDataview uses.

Specified by:

getLocale in interface DataviewCommon

Returns:

loc The Locale for this UIDataview.

setAutoFitScope

public void setAutoFitScope(int scope)

Specifies what to automatically set cell sizes for. The constants are defined in GridView and they begin with AUTOFIT_.

getAutoFitScope

public int getAutoFitScope()

Retrieves the scope for which autofitting will calculate sizes.

dataAndMetadataStyleChanged

public void dataAndMetadataStyleChanged()

Notifies the view that its data and metadata styles have changed.

setBackgroundImage

public void setBackgroundImage(java.awt.Image image)

Specifies an image to display in the databody for this GridView. The image is tiled. It appears in transparent cells, that is, on cells whose Background attribute is null. To make all the cells in the databody transparent, set the Background attribute in the ViewStyle for the databody. To make individual cells transparent, create rules and set them in the style manager for this GridView.

Parameters:

image - The background image.

See Also:

getGridViewHeaderStyleManager(), getGridViewDatabodyStyleManager(), ViewStyle, DiscriminatorRule

getBackgroundImage

public java.awt.Image getBackgroundImage()

Retrieves the background Image for the databody of this GridView. The image is tiled. It appears in transparent cells, that is, on cells whose Background attribute is null. To make all the cells in the databody transparent, set the Background attribute in the ViewStyle for the databody. To make individual cells transparent, create rules and set them in the style manager for this GridView.

Returns:

The background image for the databody of this GridView. If no background image has been set for this GridView, then this method returns null.

setGrid3D

public void setGrid3D(boolean b)

Specifies whether the gridlines in this GridView appear to be three-dimensional.

Parameters:

b - true to make gridlines appear to be three-dimensional, false to make them appear to be flat.

isGrid3D

public boolean isGrid3D()

Indicates whether the gridlines in this GridView have a three-dimensional appearance.

Returns:

true if gridlines appear to be three-dimensional, false if they appear to be flat.

setGridColor

public void setGridColor(java.awt.Color color)

Specifies the color of the gridlines in this GridView.

Parameters:

color - The Color for the gridlines in this GridView.

getGridColor

public java.awt.Color getGridColor()

Retrieves the color of the gridlines in this GridView.

Returns:

The color of the gridlines in this GridView.

setVGridColor

public void setVGridColor(java.awt.Color color)

Specifies the color of the vertical gridlines in this GridView.

Parameters:

color - The Color for the gridlines in this GridView.

setHGridColor

public void setHGridColor(java.awt.Color color)

Specifies the color of the horizonal gridlines in this GridView.

Parameters:

color - The Color for the gridlines in this GridView.

getVGridColor

public java.awt.Color getVGridColor()

Retrieves the color of the vertical gridlines in this GridView.

Returns:

The color of the vertical gridlines in this GridView.

getHGridColor

public java.awt.Color getHGridColor()

Retrieves the color of the horizontal gridlines in this GridView.

Returns:

The color of the horizontal gridlines in this GridView.

setHGridVisible

public void setHGridVisible(boolean b)

Specifies whether horizontal gridlines appear in this GridView.

Parameters:

b - true to display horizontal gridlines, false to hide them.

isHGridVisible

public boolean isHGridVisible()

Indicates whether horizontal gridlines are visible in this GridView.

Returns:

true horizontal gridlines are visible, false if they are not visible.

setVGridVisible

public void setVGridVisible(boolean b)

Indicates whether vertical gridlines appear in this GridView.

Parameters:

b - true if vertical gridlines are visible, false if they are not.

isVGridVisible

public boolean isVGridVisible()

Specifies whether vertical gridlines are visible in this GridView.

Returns:

true if vertical gridlines are visible, false if they are not visible.

getDatabody

public GridViewDatabody getDatabody()

Retrieves the databody for this GridView.

Returns:

The databody for this GridView.

getColumnHeader

public GridViewHeader getColumnHeader()

Retrieves the column header for this GridView.

Returns:

The column header for this GridView.

getRowHeader

public GridViewHeader getRowHeader()

Retrieves the row header for this GridView.

Returns:

The row header for this GridView.

getPagingControl

public PagingControl getPagingControl()

Retrieves the paging control for this GridView.

Returns:

The paging control for this GridView.

setColumnHeaderVisible

public void setColumnHeaderVisible(boolean visible)

Set column header visible

isColumnHeaderVisible

public boolean isColumnHeaderVisible()

Return if column header is visible

setRowHeaderVisible

public void setRowHeaderVisible(boolean visible)

Set row header visible

isRowHeaderVisible

public boolean isRowHeaderVisible()

Return if row header is visible

getGridViewHeaderStyleManager

public GridViewHeaderStyleManager getGridViewHeaderStyleManager()

Retrieves the style manager that this GridView uses. The style manager is responsible for the formatting of the cells in this GridView. For example, the ViewStyle object from the style manager determines the background color of a cell.

Returns:

The GridViewStyleManager that this GridView uses. If this GridView does not have a controller, then this method returns null.

See Also:

ViewStyle

getGridViewDatabodyStyleManager

public GridViewDatabodyStyleManager getGridViewDatabodyStyleManager()

Retrieves the style manager that this GridView uses. The style manager is responsible for the formatting of the cells in this GridView. For example, the ViewStyle object from the style manager determines the background color of a cell.

Returns:

The GridViewStyleManager that this GridView uses. If this GridView does not have a controller, then this method returns null.

See Also:

ViewStyle

getGridViewFormatManager

public GridViewFormatManager getGridViewFormatManager()

Retrieves the format manager that this GridView uses. The format manager is responsible for the format of the numbers that are displayed in the GridView. For example, the ViewFormat object from the format manager determines whether a number appears as a plain number or as currency.

Returns:

The GridViewFormatManager that this GridView uses. If this GridView does not have a controller, then this method returns null.

See Also:

ViewFormat

getModel

public Model getModel()

Get the model for the common view.

Specified by:

getModel in interface DataviewCommon

Returns:

the common view's model

getUIFormatCount

public int getUIFormatCount()

Retrieves the count of UI defined formats

Returns:

the number of UIFormat defined.

setUIFormatCount

public void setUIFormatCount(int count)

Set count of UI defined formats

Parameters:

the - number of UIFormat defined.

getToolbarUIFormatCount

public int getToolbarUIFormatCount()

Retrieves the count of UI defined formats

Returns:

the number of UIFormat defined.

setToolbarUIFormatCount

public void setToolbarUIFormatCount(int count)

Set count of Toolbar defined formats

Parameters:

the - number of UIFormat defined.

setUIFormats

public void setUIFormats(java.util.Vector formats)

Set format bundle of UI panel defined formats

Parameters:

Vector - of UIFormat

getUIFormats

public java.util.Vector getUIFormats()

Retrieves the format bundle of UI panel defined formats

Returns:

the vector of UIFormat defined.