oracle.dss.thin.beans.gridView
Class ThinGridView

java.lang.Object
  |
  +--oracle.dss.thin.beans.dataView.ThinDataview
        |
        +--oracle.dss.thin.beans.gridView.ThinGridView

All Implemented Interfaces:

CheckpointState, ComponentTypeConverter, DataviewCommon, ErrorHandlerCallback, Formattable, GridViewCommon, Persistable, StringXMLizable, ThinBean, ThinBeanUI, ThinDataviewCommon

Direct Known Subclasses:

ThinCrosstab, ThinTable

public abstract class ThinGridView

extends ThinDataview

implements Formattable, GridViewCommon

The base tabular view. This class defines methods and fields that are common the the thin table and crosstab beans.

Application developers normally work with the concrete subclasses of this class. However, application developers will call some of these methods in the concrete subclasses.

The ThinGridView generates the following events:

• BIConstants.DRILL_EVENT -- generated by drilling on a drillable component of a view
• BIConstants.PAGE_EVENT -- generated by selecting a different page of data to display
• BIConstants.INIT_FIND_MEMBER_EVENT -- generated by the "more..." selection on a page dimension in the paging control. Handled by the FindMember bean
• BIConstants.DATADRILL_EVENT -- generated by clicking on a graphic image in a databody cell
• BIConstants.HEADERDRILL_EVENT -- generated by clicking on a graphic image in a header cell

The ThinGridView handles the following events:

• BIConstants.ROTATE_EVENT - generated by the RotateTool bean
• BIConstants.ROTATE_EVENT -- generated by the RotateTool bean
• BIConstants.DRILL_EVENT - generated by drilling on a drillable component of a view
• BIConstants.PAGE_EVENT -- generated by selecting a different page of data to display
• BIConstants.EXPORT_EVENT -- generated by the ExportOptions bean
• BIConstants.SAVE_EVENT -- generated by the SaveAs and SaveConfirmation beans
• BIConstants.DATADRILL_EVENT -- generated by clicking on a graphic image in a databody cell
• BIConstants.HEADERDRILL_EVENT -- generated by clicking on a graphic image in a header cell

See Also:

ThinDataviewCommon

Field Summary

static int	DRILLSTATE_DRILLABLE_BIDI The drillable image for BiDi locales
static int	DRILLSTATE_IS_DRILLED_BIDI The drilled image for BiDi locales

Fields inherited from interface oracle.dss.gridView.GridViewCommon

ABSOLUTE_COLUMN_SIZING, COLUMN_BANDING, NO_BANDING, NO_COLUMN_SIZING, RELATIVE_COLUMN_SIZING, ROW_BANDING

Fields inherited from interface oracle.dss.thin.beans.dataView.ThinDataviewCommon

INLINE_ERROR_MSG, INLINE_INFO_MSG, INLINE_WARNING_MSG

Fields inherited from interface oracle.dss.thin.beans.ThinBeanUI

EVENT_HANDLED, EVENT_NOT_HANDLED, EVENT_RESPONSE_DONE

Constructor Summary

ThinGridView()
Constructor.

Method Summary

void	addGridViewDataListener(GridViewDataListener l) Adds a listener for requests of data changes.
void	applyCSSStyleDefaults(CSSStyleDefaults defaults) This method applies CSS style defaults to the ThinGridView, so that the ViewStyles of GridView components are set to the values defined for the components in bistyles.xss, the XML file that defines the GridView's CSS styles.
void	checkpointState() Initiates tracking of checkpoint state.
int	getBanding() Retrieves the banding option that can enable row banding, column banding, or no banding
int	getCellMaxWidth() Retrieves the maximum width for cells in this ThinGridView, in pixels.
int	getCellMinWidth() Retrieves the minimum width for cells in this ThinGridView, in pixels.
java.lang.String	getCheckpointState() Retrieves state differences since the last call to checkpointState.
abstract GridViewHeader	getColumnHeader() Retrieves the column header for this ThinGridView.
java.awt.Color	getCornerComponentColor() Specifies a background color for the corner component.
abstract GridViewDatabody	getDatabody() Retrieves the databody for this ThinGridView.
java.lang.String	getDrillImagePath(int index) Retrieves the drill image path from the vector of drill images for this ThinGridView.
DrillOutCallback	getDrillOutCallback() Retrieves the DrillOutCallback interface that has been registered with the GridView.
int	getGraphicImageCount() Retrieves the number of graphic images that are available for this ThinGridView.
java.lang.String	getGraphicImagePath(int index) Retrieves a graphic image path from the vector of image paths for this ThinGridView.
java.awt.Color	getGridColor() Retrieves the color of the gridlines in this ThinGridView.
GridViewDatabodyStyleManager	getGridViewDatabodyStyleManager() Retrieves the databody style manager that this ThinGridView uses.
GridViewFormatManager	getGridViewFormatManager() Retrieves the format manager that this ThinGridView uses.
GridViewHeaderStyleManager	getGridViewHeaderStyleManager() Retrieves the header style manager that this ThinGridView uses.
GridViewModel	getGridViewModel() Retrieves the model that this ThinGridView uses.
GridViewSizingManager	getGridViewSizingManager() Retrieves the sizing manager that this ThinGridView uses.
int	getHTMLColumnBlockSize() Get the column block size of this ThinGridView.
int	getHTMLColumnSizing() Retrieve the HTML sizing option.
int	getHTMLRowBlockSize() Get the row block size of this ThinGridView.
java.lang.Integer	getHTMLTableCellPadding() Gets the cell padding of the gridview's HTML table.
java.lang.String	getHTMLTableWidth() Gets the width of the gridview's HTML table.
int	getHTMLTextInputSize() Retrieves the number of characters displayed in edittable cells
abstract GridViewHeader	getRowHeader() Retrieves the row header for this ThinGridView.
int	getStartColumn() Retrieves the index of the first column that this gridview displays.
int	getStartRow() Retrieves the index of the first row that this gridview displays.
java.lang.String	getState() Retrieves the state of this thin bean.
ViewFormat	getViewFormat() Retrieves the ViewFormat object that this ThinGridView uses to format numbers.
boolean	isCellEditingAllowed() Indicates whether users can edit cells in this ThinGridView.
abstract boolean	isColumnHeaderVisible() Indicates whether the column header appears in this ThinGridView.
boolean	isEnabled() Retrieves the value of whether this ThinGridView is enabled.
boolean	isHGridVisible() Indicates whether horizontal gridlines are visible in this gridview.
abstract boolean	isRowHeaderVisible() Indicates whether the row header appears in this ThinGridView.
boolean	isVGridVisible() Specifies whether vertical gridlines are visible in this gridview.
boolean	isVisible() Indicates whether this ThinGridView is visible.
void	removeGridViewDataListener(GridViewDataListener l) Removes the listener for requests of data changes.
void	resetToDefault(int reset) Resets properties of this ThinDataview to their default values.
void	setBanding(int banding) Sets the banding option that can enable row banding, column banding, or no banding
void	setBaseState() Establishes a base state for the ThinBean, from which state changes are tracked.
void	setCellEditingAllowed(boolean b) Specifies whether users can edit cells in this ThinGridView.
void	setCellMaxWidth(int width) Specifies the maximum width for cells in this ThinGridView, in pixels.
void	setCellMinWidth(int width) Specifies the minimum width for cells in this ThinGridView, in pixels.
void	setCheckpointState(java.lang.String state) Sets on this thin bean the state changes since the last call to checkpointState.
abstract void	setColumnHeaderVisible(boolean visible) Specifies whether the column header appears in this ThinGridView.
void	setCornerComponentColor(java.awt.Color c) Retrieves the background color of the corner component.
void	setDrillImagePath(int index, java.lang.String imagePath) Specifies a drill image path for this ThinGridView.
void	setDrillOutCallback(DrillOutCallback callback) Registers a DrillOutCallback interface with the GridView.
void	setEnabled(boolean enabled) Specifies whether this ThinGridView is enabled.
void	setGraphicImagePath(int index, java.lang.String imagePath) Specifies a graphic image path for this ThinGridView.
void	setGridColor(java.awt.Color color) Specifies the color of the gridlines in this ThinGridView.
void	setHGridVisible(boolean b) Specifies whether horizontal gridlines appear in this gridview Note : This property is not supported in Netscape 4.x browsers
void	setHTMLColumnBlockSize(int size) Set the column block size of this ThinGridView.
void	setHTMLColumnSizing(int htmlColumnSizing) Set the HTML sizing option.
void	setHTMLRowBlockSize(int size) Set the row block size of this ThinGridView.
void	setHTMLTableCellPadding(java.lang.Integer padding) Sets the cell padding of the gridview's HTML table.
void	setHTMLTableWidth(java.lang.String width) Sets the width of the gridview's HTML table.
void	setHTMLTextInputSize(int size) Specifies the number of characters displayed in edittable cells
void	setLocale(java.util.Locale loc) Specifies the Locale for this ThinDataviewCommon.
abstract void	setRowHeaderVisible(boolean visible) Specifies whether the row header appears in this ThinGridView.
void	setStartColumn(int c) Specifies the first column of data for this gridview to display.
void	setStartRow(int r) Specifies the first row of data to display in this gridview.
void	setState(java.lang.String state) Sets the state of this ThinBean.
void	setVGridVisible(boolean b) Specifies whether vertical gridlines appear in this gridview.
void	setViewFormat(ViewFormat vf) Specifies the ViewFormat object for this ThinGridView.
void	setVisible(boolean visible) Specifies whether this ThinGridView is visible.

Methods inherited from class oracle.dss.thin.beans.dataView.ThinDataview

addDataListener, addErrorHandler, addThinViewListener, cleanUp, getDataDirector, getDataSource, getDataviewFootnote, getDataviewSubtitle, getDataviewTitle, getDescription, getErrorHandler, getEventTarget, getExportCharacterEncoding, getHTMLPagingControlWidth, getInlineMessage, getInlineMessageType, getLocale, getLocalName, getModel, getName, getPagingControl, getPagingControlPosition, getPersistableAttributes, getPersistableComponents, getThinBeanName, getTokenSubstitution, getViewType, getXML, getXMLAsString, handleEvent, initialize, isDrillingEnabled, isExternalFootnoteVisible, isExternalSubtitleVisible, isExternalTitleVisible, isHTMLPagingControlAutosubmit, isPagingControlVisible, isPropertyOverrideFlag, isXMLValidated, readXML, removeDataListener, removeErrorHandler, removeThinViewListener, setDataSource, setDescription, setDrillingEnabled, setEventTarget, setExportCharacterEncoding, setExternalFootnoteVisible, setExternalSubtitleVisible, setExternalTitleVisible, setHTMLPagingControlAutosubmit, setHTMLPagingControlWidth, setInlineMessage, setInlineMessageType, setLocalName, setName, setPagingControlPosition, setPagingControlVisible, setPersistableAttributes, setPersistableComponents, setThinBeanName, setTokenSubstitution, setXML, setXMLAsString, setXMLValidated, writeXML

Methods inherited from class java.lang.Object

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

Methods inherited from interface oracle.dss.gridView.GridViewCommon

getCellMaxHeight, getCellMinHeight, setDefaultCornerComponentColor

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

DRILLSTATE_DRILLABLE_BIDI

public static final int DRILLSTATE_DRILLABLE_BIDI

The drillable image for BiDi locales

See Also:

setDrillImagePath(int, java.lang.String), getDrillImagePath(int)

DRILLSTATE_IS_DRILLED_BIDI

public static final int DRILLSTATE_IS_DRILLED_BIDI

The drilled image for BiDi locales

See Also:

setDrillImagePath(int, java.lang.String), getDrillImagePath(int)

Constructor Detail

ThinGridView

public ThinGridView()

Constructor. Application developers should call the constructors of the concrete subclasses of this class. Those constructors call this constructor.

Method Detail

setBaseState

public void setBaseState()

Description copied from interface: ThinBean

Establishes a base state for the ThinBean, from which state changes are tracked. This method clears the current state string for the thin bean.

Whenever you instantiate a thin bean, call this method. If you perform standard initialization every time you load a thin bean, then call this method after the standard initialization code. If you do custom initialization on some, but not all, thin beans, then call this method before the custom initialization code. Any changes that you make to a thin bean state after you call this method are added to the state string that the getState method returns.

setState

public void setState(java.lang.String state)

Description copied from interface: ThinBean

Sets the state of this ThinBean. This method takes the state information from a state string and sets it on this thin bean. The state string represents changes that have been made to this thin bean since the last call to the setBaseState method.

Where you get the state string depends on whether you store state information directly in the URL or in an oracle.cabo.servlet.state.State object. If you store state in the URL, then the state string comes from the URL. If you store state in a State object and store the ID of that object in the URL, then the state comes from the State object. In either case, the stored information originally should have come from a call to the getState method of this thin bean.

Setting the state of a thin bean lets you recreate a previously displayed page.

Call this method before you handle any thin-bean events. Thin-bean events often change the state of thin beans, so calling this method after you handle events causes the effects of the event handling to be overwritten.

Following copied from interface: oracle.dss.thin.beans.ThinBean

Parameters:

state - The string that represents the state of this thin bean.

See Also:

ThinBean.getState()

getState

public java.lang.String getState()

Description copied from interface: ThinBean

Retrieves the state of this thin bean. The String that this method returns represents changes that have been made to this thin bean since the last call to its setBaseState method. Call this method after you handle any thin-bean events to get the current state of this thin bean.

You can store this state information directly in the URL, or you can store the state string in an oracle.cabo.servlet.state.State, and store the ID of the State in the URL.

The state information accrues as a user interacts with a thin bean, so the String that this method returns grows larger with each request that involves this thin bean. For example, the state of a Query might include information about the measures and selections in the query. If a user drills, then the drill information is added to the state string. If a user changes the layout of the query, then the new layout information is added as well. Each modification to the thin bean adds to the state string. If you store the state of all of the thin beans in your application in the URL, then you must be careful to avoid exceeding the URL limit for any browser that your application supports.

Call this method after you handle any thin-bean events.

Following copied from interface: oracle.dss.thin.beans.ThinBean

Returns:

The state changes for this thin bean since the last call to setBaseState. Unless you use checkpointing, the returned state string represents the current state of this thin bean.

See Also:

ThinBean.setState(java.lang.String), ThinBean.setBaseState(), CheckpointState

checkpointState

public void checkpointState()

Description copied from interface: CheckpointState

Initiates tracking of checkpoint state. Before you call this method, call the getState method of the thin bean. Save the state string that getState returns in an oracle.cabo.servlet.state.MutableState object. Save the MutableState to the BI Beans Catalog, by calling the saveState method of the BIStateManager. Then, call this method to keep track of changes that occur after you save the state string in the Catalog.

Following copied from interface: oracle.dss.thin.beans.CheckpointState

See Also:

ThinBean.getState(), BIStateManager

setCheckpointState

public void setCheckpointState(java.lang.String state)
                        throws ThinException

Description copied from interface: CheckpointState

Sets on this thin bean the state changes since the last call to checkpointState.

Following copied from interface: oracle.dss.thin.beans.CheckpointState

Parameters:

state - The state differences from the last call to checkpointState.

Throws:

ThinException - If the state could not be set.

See Also:

ThinBean.setState(java.lang.String)

getCheckpointState

public java.lang.String getCheckpointState()

Description copied from interface: CheckpointState

Retrieves state differences since the last call to checkpointState.

You normally store the returned String in the URL. The return value from this method, together with the return value from the getState method, describe all of the state changes that have been made to this thin bean since it was initialized (since the last call to setBaseState).

Following copied from interface: oracle.dss.thin.beans.CheckpointState

Returns:

Changes that have been made to the state of this thin bean since checkpointState was last called.

See Also:

CheckpointState.checkpointState(), ThinBean.getState(), ThinBean.setBaseState()

getGridViewModel

public GridViewModel getGridViewModel()

Retrieves the model that this ThinGridView uses. In the Model-View-Controller architecture, the model is responsible for handling the data that is displayed in a view. In the full BI Beans set, the DataSource is the "big" model. The model that this method returns interacts with the DataSource, retrieving data and having the data formatted so that the view can display it.

Returns:

The GridViewModel that this ThinGridView uses.

addGridViewDataListener

public void addGridViewDataListener(GridViewDataListener l)

Adds a listener for requests of data changes.

Parameters:

l - The listener to add.

removeGridViewDataListener

public void removeGridViewDataListener(GridViewDataListener l)

Removes the listener for requests of data changes.

Parameters:

l - The listener to remove.

getGridViewFormatManager

public GridViewFormatManager getGridViewFormatManager()

Retrieves the format manager that this ThinGridView uses. The format manager is responsible for the format of the numbers that are displayed in the ThinGridView. 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 ThinGridView uses. If this ThinGridView does not have a controller, then this method returns null.

See Also:

ViewFormat

getGridViewDatabodyStyleManager

public GridViewDatabodyStyleManager getGridViewDatabodyStyleManager()

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

Returns:

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

See Also:

ViewStyle

getGridViewHeaderStyleManager

public GridViewHeaderStyleManager getGridViewHeaderStyleManager()

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

Returns:

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

See Also:

ViewStyle

getGridViewSizingManager

public GridViewSizingManager getGridViewSizingManager()

Retrieves the sizing manager that this ThinGridView uses. The sizing manager is responsible for the size of the columns in this ThinGridView. Note : The sizing manager is shared with the Java Client GridView, so it does contain sizing rules for cell heights. ThinGridView does not support sizing of cell heights.

Returns:

The sizing manager that this ThinGridView uses. If this ThinGridView does not have a controller, then this method returns null.

setLocale

public void setLocale(java.util.Locale loc)

Description copied from interface: ThinDataviewCommon

Specifies the Locale for this ThinDataviewCommon.

Overrides:

setLocale in class ThinDataview

Following copied from interface: oracle.dss.thin.beans.dataView.ThinDataviewCommon

Parameters:

loc - The Locale for this ThinDataviewCommon.

setViewFormat

public void setViewFormat(ViewFormat vf)

Specifies the ViewFormat object for this ThinGridView. The ViewFormat specifies attributes that this ThinGridView uses to format the numbers that it displays. If you use rules to format individual cells, the ViewFormat object that you specify in this method is the default ViewFormat that the rules modify and return to the view.

Specified by:

setViewFormat in interface Formattable

Parameters:

vf - The ViewFormat to use to format numbers in this ThinGridView.

getViewFormat

public ViewFormat getViewFormat()

Retrieves the ViewFormat object that this ThinGridView uses to format numbers.

Specified by:

getViewFormat in interface Formattable

Returns:

The ViewFormat that this ThinGridView uses.

setVisible

public void setVisible(boolean visible)

Specifies whether this ThinGridView is visible.

Parameters:

visible - true to make this ThinGridView visible, false to hide it.

isVisible

public boolean isVisible()

Indicates whether this ThinGridView is visible.

Returns:

true if this ThinGridView is visible, false if it is not.

setGridColor

public void setGridColor(java.awt.Color color)

Specifies the color of the gridlines in this ThinGridView. Note : This property is not supported in Netscape 4.x browsers

Parameters:

color - The Color for the gridlines in this ThinGridView.

getGridColor

public java.awt.Color getGridColor()

Retrieves the color of the gridlines in this ThinGridView. Note : This property is not supported in Netscape 4.x browsers

Returns:

The color of the gridlines in this ThinGridView.

setHTMLTextInputSize

public void setHTMLTextInputSize(int size)

Specifies the number of characters displayed in edittable cells

Specified by:

setHTMLTextInputSize in interface GridViewCommon

Parameters:

size - the number of characters

getHTMLTextInputSize

public int getHTMLTextInputSize()

Retrieves the number of characters displayed in edittable cells

Specified by:

getHTMLTextInputSize in interface GridViewCommon

Returns:

the number of characters

getHTMLTableCellPadding

public java.lang.Integer getHTMLTableCellPadding()

Gets the cell padding of the gridview's HTML table. The cell padding is the number of pixels between the cell contents and the cell gridlines.

Specified by:

getHTMLTableCellPadding in interface GridViewCommon

setHTMLTableCellPadding

public void setHTMLTableCellPadding(java.lang.Integer padding)

Sets the cell padding of the gridview's HTML table. The cell padding is the number of pixels between the cell contents and the cell gridlines.

Specified by:

setHTMLTableCellPadding in interface GridViewCommon

Parameters:

the - new cell padding of the gridview's HTML table

getHTMLTableWidth

public java.lang.String getHTMLTableWidth()

Gets the width of the gridview's HTML table. The width of the HTML table directly cooresponds to the HTML table tag's width attribute. It can either be specified in pixels ("500") or as a relative size ("50%").

Specified by:

getHTMLTableWidth in interface GridViewCommon

setHTMLTableWidth

public void setHTMLTableWidth(java.lang.String width)

Sets the width of the gridview's HTML table. The width of the HTML table directly cooresponds to the HTML table tag's width attribute. It can either be specified in pixels ("500") or as a relative size ("50%").

Specified by:

setHTMLTableWidth in interface GridViewCommon

Parameters:

the - new width of the gridview HTML table

setEnabled

public void setEnabled(boolean enabled)

Specifies whether this ThinGridView is enabled. When a ThinGridView is disabled, it is visible, but users cannot operate on the ThinGridView. For example, they cannot swap dimensions or edit a cell.

Overrides:

setEnabled in class ThinDataview

Parameters:

enabled - true to enable this ThinGridView, false to disable it.

isEnabled

public boolean isEnabled()

Retrieves the value of whether this ThinGridView is enabled. When a ThinGridView is disabled, it is visible, but users cannot operate on the ThinGridView. For example, they cannot swap dimensions or drill.

Overrides:

isEnabled in class ThinDataview

Returns:

True or false

setDrillOutCallback

public void setDrillOutCallback(DrillOutCallback callback)

Registers a DrillOutCallback interface with the GridView. If a DrillOutCallback is registered, then the gridview will ask the callback for a URI to set on the graphic image. The application then has the opportunity to either return a URI or return null, which means that the gridview's standard drill out events will be generated instead. The DrillOutCallback is null by default.

Parameters:

callback - an instance of a DrillOutCallback interface

See Also:

DrillOutCallback

getDrillOutCallback

public DrillOutCallback getDrillOutCallback()

Retrieves the DrillOutCallback interface that has been registered with the GridView. If a DrillOutCallback is registered, then the gridview will ask the callback for a URI to set on the graphic image. The application then has the opportunity to either return a URI or return null, which means that the gridview's standard drill out events will be generated instead.

Returns:

an instance of a DrillOutCallback interface

See Also:

DrillOutCallback

setGraphicImagePath

public void setGraphicImagePath(int index,
                                java.lang.String imagePath)

Specifies a graphic image path for this ThinGridView. Images are stored in a vector of image paths. Note that images for drill icons are stored in a separate vector. Note : The graphic image path is a relative path with the UIX images directory as its root. For example, if the UIX image directory was "d:\myWebServer\cabo\images" and the graphic image path is "myApplicationImages\myGraphicImage.gif", then the physical image location is "d:\myWebServer\cabo\images\myApplicationImages\myGraphicImage.gif".

Parameters:

index - The index, in the image vector, where you want to store an image path. Negative numbers are ignored. If you pass a number larger than the current vector size, this method resizes the vector to accommodate the index that you pass.

image - The image path to store.

See Also:

setDrillImagePath(int, java.lang.String)

getGraphicImagePath

public java.lang.String getGraphicImagePath(int index)

Retrieves a graphic image path from the vector of image paths for this ThinGridView. Note that images for drill icons are stored in a separate vector. Note : The graphic image path is a relative path with the UIX images directory as its root. For example, if the UIX image directory was "d:\myWebServer\cabo\images" and the graphic image path is "myApplicationImages\myGraphicImage.gif", then the physical image location is "d:\myWebServer\cabo\images\myApplicationImages\myGraphicImage.gif".

Parameters:

index - The index, in the vector, of the image path that you want. Valid values are zero to one less than the size of the vector.

Returns:

The image path that is stored at the specified index. Returns null if index is less than zero or is greater than or equal to the size of the vector.

See Also:

getDrillImagePath(int)

getGraphicImageCount

public int getGraphicImageCount()

Retrieves the number of graphic images that are available for this ThinGridView. This method returns the size of the vector of images for this ThinGridView.

Returns:

The number of graphic images for this ThinGridView.

setDrillImagePath

public void setDrillImagePath(int index,
                              java.lang.String imagePath)

Specifies a drill image path for this ThinGridView. This method stores an image in a vector of drill images for this ThinGridView. Index zero is reserved, so you must store drill images at indexes of 1 or greater. This means that you should not use the constant DataDirector.DRILLSTATE_NOT_DRILLABLE. Note : The drill image path is a relative path with the UIX images directory as its root. For example, if the UIX image directory was "d:\myWebServer\cabo\images" and the drill image path is "myApplicationImages\myDrillImage.gif", then the physical image location is "d:\myWebServer\cabo\images\myApplicationImages\myDrillImage.gif".

Parameters:

index - The index in the vector of drill. Use the constants from the DataDirector interface, either DataDirector.DRILLSTATE_DRILLABLE or DataDirector.DRILLSTATE_DRILLED.

image - The image path to store.

See Also:

DataDirector

getDrillImagePath

public java.lang.String getDrillImagePath(int index)

Retrieves the drill image path from the vector of drill images for this ThinGridView. Note : The drill image path is a relative path with the UIX images directory as its root. For example, if the UIX image directory was "d:\myWebServer\cabo\images" and the drill image path is "myApplicationImages\myDrillImage.gif", then the physical image location is "d:\myWebServer\cabo\images\myApplicationImages\myDrillImage.gif".

Parameters:

index - The index of the image that you want. Use the constants from the DataDirector interface, either DataDirector.DRILLSTATE_DRILLABLE or DataDirector.DRILLSTATE_DRILLED.

Returns:

The drill image path stored at index. Returns null if there is no image stored at index, or if index is less than 1 or is greater than or equal to the size of the vector.

See Also:

DataDirector

getDatabody

public abstract GridViewDatabody getDatabody()

Retrieves the databody for this ThinGridView.

Returns:

The databody for this ThinGridView.

getColumnHeader

public abstract GridViewHeader getColumnHeader()

Retrieves the column header for this ThinGridView.

Returns:

The column header for this ThinGridView.

getRowHeader

public abstract GridViewHeader getRowHeader()

Retrieves the row header for this ThinGridView.

Returns:

The row header for this ThinGridView.

setCellMaxWidth

public void setCellMaxWidth(int width)

Specifies the maximum width for cells in this ThinGridView, in pixels.

Note : If the contents of a cell are larger than can fit in the minumum width then the browser will automatically make the cell wide enough to fit all of the contents. In order to reduce a cell's size either its font can be changed or word wrapping can be enabled.

Parameters:

width - The maximum width for cells in this ThinGridView.

getCellMaxWidth

public int getCellMaxWidth()

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

Note : If the contents of a cell are larger than can fit in the minumum width then the browser will automatically make the cell wide enough to fit all of the contents. In order to reduce a cell's size either its font can be changed or word wrapping can be enabled.

Specified by:

getCellMaxWidth in interface GridViewCommon

Returns:

The maximum width for cells in this ThinGridView.

setCellMinWidth

public void setCellMinWidth(int width)

Specifies the minimum width for cells in this ThinGridView, in pixels.

Note : If the contents of a cell are larger than can fit in the minumum width then the browser will automatically make the cell wide enough to fit all of the contents. In order to reduce a cell's size either its font can be changed or word wrapping can be enabled.

Parameters:

The - minimum width for cells in this ThinGridView.

getCellMinWidth

public int getCellMinWidth()

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

Note : If the contents of a cell are larger than can fit in the minumum width then the browser will automatically make the cell wide enough to fit all of the contents. In order to reduce a cell's size either its font can be changed or word wrapping can be enabled.

Specified by:

getCellMinWidth in interface GridViewCommon

Returns:

The minimum width for cells in this ThinGridView.

resetToDefault

public void resetToDefault(int reset)

Description copied from class: ThinDataview

Resets properties of this ThinDataview to their default values. The reset parameter determines whether to reset only the properties or to reset the properties and remove registered listeners and callbacks.

When reset is RESET_EVERYTHING, then this method removes event targets as well.

This method is helpful when you want to reuse a ThinDataview rather than instantiate a new one.

Overrides:

resetToDefault in class ThinDataview

Following copied from class: oracle.dss.thin.beans.dataView.ThinDataview

Parameters:

reset - A constant that indicates how much to reset. Valid constants are listed in the See Also section. If you pass an invalid value or RESET_NONE, then this method logs a message with the error handler and does not change any properties.

See Also:

Dataview.RESET_XML_PROPERTIES, Dataview.RESET_EVERYTHING

setHTMLRowBlockSize

public void setHTMLRowBlockSize(int size)

Set the row block size of this ThinGridView. The block size is 25 by default. If the block size is 0, then all rows are displayed.

Specified by:

setHTMLRowBlockSize in interface GridViewCommon

Following copied from interface: oracle.dss.gridView.GridViewCommon

Parameters:

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

getHTMLRowBlockSize

public int getHTMLRowBlockSize()

Get the row block size of this ThinGridView.

Specified by:

getHTMLRowBlockSize in interface GridViewCommon

setHTMLColumnBlockSize

public void setHTMLColumnBlockSize(int size)

Set the column block size of this ThinGridView. The block size is 6 by default. If the block size is 0, then all columns are displayed.

Currently this property is only supported in ThinCrosstabs.

getHTMLColumnBlockSize

public int getHTMLColumnBlockSize()

Get the column block size of this ThinGridView.

Currently this property is only supported in ThinCrosstabs.

setBanding

public void setBanding(int banding)

Sets the banding option that can enable row banding, column banding, or no banding

Specified by:

setBanding in interface GridViewCommon

Parameters:

option - can either be ROW_BANDING, COLUMN_BANDING, or NO_BANDING

getBanding

public int getBanding()

Retrieves the banding option that can enable row banding, column banding, or no banding

Specified by:

getBanding in interface GridViewCommon

Returns:

either be ROW_BANDING, COLUMN_BANDING, or NO_BANDING

setHTMLColumnSizing

public void setHTMLColumnSizing(int htmlColumnSizing)

Set the HTML sizing option. Valid options are NO_COLUMN_SIZING, ABSOLUTE_COLUMN_SIZING, and RELATIVE_COLUMN_SIZING. The default is NO_COLUMN_SIZING Note : If sizing is set to RELATIVE_COLUMN_SIZING, then the width percentages (10%) will be used to size the HTML Table's columns. If the percentage specified is smaller than the size needed to display the contents of the column, the browser will automatically make the column large enough to fit all of the contents of the column. Note : If sizing is set to ABSOLUTE_COLUMN_SIZING, then the pixel sizes will be used to size the HTML Table's columns. If the pixel size specified is smaller than the size needed to display the contents of the column, the browser will automatically make the column large enough to fit all of the contents of the column.

Specified by:

setHTMLColumnSizing in interface GridViewCommon

Following copied from interface: oracle.dss.gridView.GridViewCommon

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:

GridViewCommon.NO_COLUMN_SIZING, GridViewCommon.ABSOLUTE_COLUMN_SIZING, GridViewCommon.RELATIVE_COLUMN_SIZING

getHTMLColumnSizing

public int getHTMLColumnSizing()

Retrieve the HTML sizing option. Valid options are NO_COLUMN_SIZING, ABSOLUTE_COLUMN_SIZING, and RELATIVE_COLUMN_SIZING. The default is NO_COLUMN_SIZING

Specified by:

getHTMLColumnSizing in interface GridViewCommon

Following copied from interface: oracle.dss.gridView.GridViewCommon

Returns:

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

See Also:

GridViewCommon.NO_COLUMN_SIZING, GridViewCommon.ABSOLUTE_COLUMN_SIZING, GridViewCommon.RELATIVE_COLUMN_SIZING

setHGridVisible

public void setHGridVisible(boolean b)

Specifies whether horizontal gridlines appear in this gridview Note : This property is not supported in Netscape 4.x browsers

Parameters:

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

isHGridVisible

public boolean isHGridVisible()

Indicates whether horizontal gridlines are visible in this gridview. Note : This property is not supported in Netscape 4.x browsers

Returns:

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

setVGridVisible

public void setVGridVisible(boolean b)

Specifies whether vertical gridlines appear in this gridview. Note : This property is not supported in Netscape 4.x browsers

Parameters:

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

isVGridVisible

public boolean isVGridVisible()

Specifies whether vertical gridlines are visible in this gridview. Note : This property is not supported in Netscape 4.x browsers

Returns:

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

setStartRow

public void setStartRow(int r)

Specifies the first row of data to display in this gridview.

Parameters:

r - The index of the first row to display. Row indexes begin at zero. If r is less than zero or greater than the number of rows in the ThinGridView, then this method logs a message with the error handler, and StartRow keeps its previous value.

getStartRow

public int getStartRow()

Retrieves the index of the first row that this gridview displays. Row indexes begin at zero.

Returns:

The index of the first row that this gridview displays.

setStartColumn

public void setStartColumn(int c)

Specifies the first column of data for this gridview to display. Column indexes begin at zero.

Parameters:

c - The index of the first column to display. If c is less than zero or greater than the number of columns in the ThinGridView, then this method logs a message with the error handler, and StartColumn keeps its previous value.

getStartColumn

public int getStartColumn()

Retrieves the index of the first column that this gridview displays. Column indexes begin at zero.

Returns:

The index of the first column that this gridview displays.

getCornerComponentColor

public java.awt.Color getCornerComponentColor()

Specifies a background color for the corner component. Note : Until oracle.dss.dataView.CSSStyleDefaults are applied to the view the Color that is returned from this method will not have the correct default value.

Parameters:

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

setCornerComponentColor

public void setCornerComponentColor(java.awt.Color c)

Retrieves the background color of the corner component.

Returns:

The background color of the corner component.

applyCSSStyleDefaults

public void applyCSSStyleDefaults(CSSStyleDefaults defaults)

This method applies CSS style defaults to the ThinGridView, so that the ViewStyles of GridView components are set to the values defined for the components in bistyles.xss, the XML file that defines the GridView's CSS styles. For example, before applyCSSStyleDefaults() is called, the column header ViewStyle's background would be set to white, even though the column header's background was light brown, as defined in the CSS file. After applyCSSStyleDefaults() is called, the column header ViewStyle's background would be light brown. Note: If getXML() is called with allProperties specified to be true, then the GridView will generate XML for all of its properties. If applyCSSStyleDefaults() is not called before the XML is generated, then the ViewStyle properties for the GridView components will not write out their correct values, since the actual styles are determined by the CSS file. A default implementation of the CSSStyleDefaults interface is CSSStyleDefaultsImpl

Parameters:

defaults - the CSSStyleDefaults object providing the new defaults

See Also:

CSSStyleDefaultsImpl

isCellEditingAllowed

public boolean isCellEditingAllowed()

Indicates whether users can edit cells in this ThinGridView.

Returns:

true if cells can be edited, false if they cannot.

setCellEditingAllowed

public void setCellEditingAllowed(boolean b)

Specifies whether users can edit cells in this ThinGridView.

Parameters:

b - true to allow cell editing, false to prohibit it.

setColumnHeaderVisible

public abstract void setColumnHeaderVisible(boolean visible)

Specifies whether the column header appears in this ThinGridView.

Parameters:

visible - true to display the column header, false to hide it.

isColumnHeaderVisible

public abstract boolean isColumnHeaderVisible()

Indicates whether the column header appears in this ThinGridView.

Returns:

true if the column header appears, false if it does not.

setRowHeaderVisible

public abstract void setRowHeaderVisible(boolean visible)

Specifies whether the row header appears in this ThinGridView.

Parameters:

visible - true to display the row header, false to hide it.

isRowHeaderVisible

public abstract boolean isRowHeaderVisible()

Indicates whether the row header appears in this ThinGridView.

Returns:

true if the row header appears, false if it does not.