oracle.dss.gridView
Class UIGridViewAdapter

java.lang.Object
  |
  +--oracle.dss.util.PagingControlAttributesAdapter
        |
        +--oracle.dss.dataView.UIDataviewAdapter
              |
              +--oracle.dss.gridView.UIGridViewAdapter

All Implemented Interfaces:

ComponentTypeConverter, DataviewCommon, GridViewAttribute, GridViewCommon, PagingControlAttributes, UIDataview, UIGridView

Direct Known Subclasses:

UICrosstabAdapter, UITableAdapter

public abstract class UIGridViewAdapter

extends UIDataviewAdapter

implements UIGridView

Adapter for a GridView. The default user adapter for the crosstab or table bean. Instantiate this adapter class to construct UI panels before creating a GridView object.

Fields inherited from interface oracle.dss.gridView.GridViewCommon

ABSOLUTE_COLUMN_SIZING, COLUMN_BANDING, NO_BANDING, NO_COLUMN_SIZING, RELATIVE_COLUMN_SIZING, ROW_BANDING

Constructor Summary

UIGridViewAdapter()
Empty Constructor

UIGridViewAdapter(UIGridView gridView)
Create adapter from an existing view

Method Summary

void	applyToGridView(UIGridView gridview) Apply properties of this adapter to a UIGridView.
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.
java.lang.Object	getComponentFromID(int ID) Get a view component specified by its integer ID.
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.
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.
void	initFromGridView(UIGridView gridview) Initialize the properties of this adapter from a UIGridView.
boolean	isColumnHeaderVisible() Return if the 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	setDefaultCornerComponentColor(java.awt.Color c) Specifies a default background color for the corner component.
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	setLocale(java.util.Locale locale) Set the Locale for this UIGridView.
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 class oracle.dss.dataView.UIDataviewAdapter

addControllerListener, applyToDataview, convertComponentTypeToInteger, convertComponentTypeToString, getDataSource, getDataviewFootnote, getDataviewSubtitle, getDataviewTitle, getLocale, getSelectedObject, getTokenSubstitution, getViewType, getZoomFactor, initFromDataview, removeControllerListener, selectObject, setDataSource, setTokenSubstitution

Methods inherited from class oracle.dss.util.PagingControlAttributesAdapter

applyToPagingControlAttributes, initFromPagingControlAttributes, isPagingControlVisible, setPagingControlVisible

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface oracle.dss.gridView.UIGridView

getLocale

Methods inherited from interface oracle.dss.gridView.GridViewCommon

getBanding, getCellMaxHeight, getCellMaxWidth, getCellMinHeight, getCellMinWidth, getHTMLColumnSizing, getHTMLRowBlockSize, getHTMLTableCellPadding, getHTMLTableWidth, getHTMLTextInputSize, setBanding, 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

Constructor Detail

UIGridViewAdapter

public UIGridViewAdapter()

Empty Constructor

UIGridViewAdapter

public UIGridViewAdapter(UIGridView gridView)

Create adapter from an existing view

Method Detail

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

Specified by:

setAutoFitScope in interface UIGridView

getAutoFitScope

public int getAutoFitScope()

Retrieves the scope for which autofitting will calculate sizes.

Specified by:

getAutoFitScope in interface UIGridView

dataAndMetadataStyleChanged

public void dataAndMetadataStyleChanged()

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

Specified by:

dataAndMetadataStyleChanged in interface UIGridView

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.

Specified by:

setBackgroundImage in interface UIGridView

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.

Specified by:

getBackgroundImage in interface UIGridView

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.

Specified by:

setGrid3D in interface UIGridView

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.

Specified by:

isGrid3D in interface UIGridView

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.

Specified by:

setGridColor in interface UIGridView

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.

Specified by:

getGridColor in interface UIGridView

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.

Specified by:

setVGridColor in interface UIGridView

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.

Specified by:

setHGridColor in interface UIGridView

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.

Specified by:

getVGridColor in interface UIGridView

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.

Specified by:

getHGridColor in interface UIGridView

Returns:

The color of the horizontal gridlines in this GridView.

setHGridVisible

public void setHGridVisible(boolean b)

Specifies whether horizontal gridlines appear in this GridView.

Specified by:

setHGridVisible in interface UIGridView

Parameters:

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

isHGridVisible

public boolean isHGridVisible()

Indicates whether horizontal gridlines are visible in this GridView.

Specified by:

isHGridVisible in interface UIGridView

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.

Specified by:

setVGridVisible in interface UIGridView

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.

Specified by:

isVGridVisible in interface UIGridView

Returns:

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

setLocale

public void setLocale(java.util.Locale locale)

Set the Locale for this UIGridView.

Overrides:

setLocale in class UIDataviewAdapter

Returns:

The Locale for this UIGridView.

getDatabody

public GridViewDatabody getDatabody()

Retrieves the databody for this GridView.

Specified by:

getDatabody in interface UIGridView

Returns:

The databody for this GridView.

getColumnHeader

public GridViewHeader getColumnHeader()

Retrieves the column header for this GridView.

Specified by:

getColumnHeader in interface UIGridView

Returns:

The column header for this GridView.

getRowHeader

public GridViewHeader getRowHeader()

Retrieves the row header for this GridView.

Specified by:

getRowHeader in interface UIGridView

Returns:

The row header for this GridView.

getPagingControl

public PagingControl getPagingControl()

Retrieves the paging control for this GridView.

Specified by:

getPagingControl in interface UIGridView

Returns:

The paging control for this GridView.

setColumnHeaderVisible

public void setColumnHeaderVisible(boolean visible)

Set column header visible

Specified by:

setColumnHeaderVisible in interface UIGridView

isColumnHeaderVisible

public boolean isColumnHeaderVisible()

Return if the column header is visible

Specified by:

isColumnHeaderVisible in interface UIGridView

setRowHeaderVisible

public void setRowHeaderVisible(boolean visible)

Set row header visible

Specified by:

setRowHeaderVisible in interface UIGridView

isRowHeaderVisible

public boolean isRowHeaderVisible()

Return if row header is visible

Specified by:

isRowHeaderVisible in interface UIGridView

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.

Specified by:

getGridViewHeaderStyleManager in interface UIGridView

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.

Specified by:

getGridViewDatabodyStyleManager in interface UIGridView

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.

Specified by:

getGridViewFormatManager in interface UIGridView

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 UIGridView

Overrides:

getModel in class UIDataviewAdapter

Returns:

the common view's model

getComponentFromID

public java.lang.Object getComponentFromID(int ID)

Get a view component specified by its integer ID.

Parameters:

ID - the ID of the desired view component

Returns:

the desired view component

setDefaultCornerComponentColor

public void setDefaultCornerComponentColor(java.awt.Color c)

Specifies a default background color for the corner component. The color specified will be set as the new corner component color, and will be used as the default value when generating delta XML.

Specified by:

setDefaultCornerComponentColor in interface GridViewCommon

Parameters:

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

getUIFormatCount

public int getUIFormatCount()

Retrieves the count of UI defined formats

Specified by:

getUIFormatCount in interface UIGridView

Returns:

the number of UIFormat defined.

setUIFormatCount

public void setUIFormatCount(int count)

Set count of UI defined formats

Specified by:

setUIFormatCount in interface UIGridView

Parameters:

the - number of UIFormat defined.

getToolbarUIFormatCount

public int getToolbarUIFormatCount()

Retrieves the count of UI defined formats

Specified by:

getToolbarUIFormatCount in interface UIGridView

Returns:

the number of UIFormat defined.

setToolbarUIFormatCount

public void setToolbarUIFormatCount(int count)

Set count of Toolbar defined formats

Specified by:

setToolbarUIFormatCount in interface UIGridView

Parameters:

the - number of UIFormat defined.

setUIFormats

public void setUIFormats(java.util.Vector formats)

Set format bundle of UI panel defined formats

Specified by:

setUIFormats in interface UIGridView

Parameters:

Vector - of UIFormat

getUIFormats

public java.util.Vector getUIFormats()

Retrieves the format bundle of UI panel defined formats

Specified by:

getUIFormats in interface UIGridView

Returns:

the vector of UIFormat defined.

initFromGridView

public void initFromGridView(UIGridView gridview)

Initialize the properties of this adapter from a UIGridView. This method calls the superclass initFromDataview method.

Parameters:

gridview - the UIGridView used to initialize this adapter

applyToGridView

public void applyToGridView(UIGridView gridview)

Apply properties of this adapter to a UIGridView. This method calls the superclass applyToDataview method.

Parameters:

gridview - the UIGridView to which properties of this adapter will be applied