oracle.dss.table
Class Table

java.lang.Object
  |
  +--java.awt.Component
        |
        +--java.awt.Container
              |
              +--javax.swing.JComponent
                    |
                    +--javax.swing.JPanel
                          |
                          +--oracle.dss.dataView.Dataview
                                |
                                +--oracle.dss.gridView.GridView
                                      |
                                      +--oracle.dss.table.Table

All Implemented Interfaces:

javax.accessibility.Accessible, ComponentTypeConverter, DataviewCommon, ErrorHandlerCallback, Formattable, GridViewAttribute, GridViewCommon, java.awt.image.ImageObserver, java.awt.MenuContainer, PagingControlAttributes, Persistable, java.io.Serializable, StringXMLizable, TableCommon, UIDataview, UIGridView, UITable

Direct Known Subclasses:

TableRef

public class Table

extends GridView

implements GridViewAttribute, TableCommon, UITable

The table bean class. The table displays data in the form of a relational table.

To display data in this table, call the setDataSource method of its superclass, or use the table constructor that takes a DataSource as a parameter. You can use the BI Beans DataSource bean, or you can supply your own data source. The DataAccess and DataAccess interfaces, in the oracle.dss.util package, define the methods and constants that a data source must provide.

You can set attributes on the table to customize its appearance and behavior. In addition, the table has several components, whose attributes you can also set in order to customize the table.

See Also:

getDatabody(), Dataview.getDataviewTitle(), Dataview.getDataviewSubtitle(), Dataview.getDataviewFootnote(), DataAccess, DataDirector, Serialized Form

Inner classes inherited from class javax.swing.JComponent

javax.swing.JComponent.AccessibleJComponent

Field Summary

static int

TABLE This table.

Fields inherited from class oracle.dss.gridView.GridView

AUTOFIT_SCOPE_ALL, AUTOFIT_SCOPE_COLHDRROWHTS_ROWHDRCOLWDS, AUTOFIT_SCOPE_COLUMN_HEADER_ROW_HEIGHTS, AUTOFIT_SCOPE_COLUMN_WIDTHS, AUTOFIT_SCOPE_COLWDS_COLHDRROWHTS, AUTOFIT_SCOPE_COLWDS_COLHDRROWHTS_ROWHDRCOLWDS, AUTOFIT_SCOPE_COLWDS_ROWHDRCOLWDS, AUTOFIT_SCOPE_COLWDS_ROWHTS, AUTOFIT_SCOPE_COLWDS_ROWHTS_COLHDRROWHTS, AUTOFIT_SCOPE_COLWDS_ROWHTS_ROWHDRCOLWDS, AUTOFIT_SCOPE_NONE, AUTOFIT_SCOPE_ROW_HEADER_COLUMN_WIDTHS, AUTOFIT_SCOPE_ROW_HEIGHTS, AUTOFIT_SCOPE_ROWHTS_COLHDRROWHTS, AUTOFIT_SCOPE_ROWHTS_COLHDRROWHTS_ROWHDRCOLWDS, AUTOFIT_SCOPE_ROWHTS_ROWHDRCOLWDS, COL_HEADER, COL_HEADER_RANGE, DATA_CELL, DATA_CELL_RANGE, DATA_COLUMN, DATA_COLUMN_RANGE, DATA_ROW, DATA_ROW_RANGE, DATABODY, DATABODY_HIGHLIGHTER, FILL_WITH_HASHMARKS, ROW_HEADER, ROW_HEADER_RANGE, TRUNCATE_WITH_ELLIPSIS, TRUNCATE_WITHOUT_ELLIPSIS

Fields inherited from class oracle.dss.dataView.Dataview

DATAVIEW_FOOTNOTE, DATAVIEW_FOOTNOTE_NAME, DATAVIEW_SUBTITLE, DATAVIEW_SUBTITLE_NAME, DATAVIEW_TITLE, DATAVIEW_TITLE_NAME, DEFAULT_ZOOM_FACTOR, FOOTNOTE, FOOTNOTE_NAME, PAGE_CONTROL, PAGE_HEADER, PAGE_HEADER_NAME, PAGE_ITEM, PAGE_ITEM_NAME, PAGING_COMPONENT_NAME, PAGING_CONTROL_ABOVE_TITLES, PAGING_CONTROL_BELOW_TITLES, RESET_EVERYTHING, RESET_NONE, RESET_XML_PROPERTIES, SUBTITLE, SUBTITLE_NAME, TITLE, TITLE_NAME, VIEW_TYPE_CROSSTAB, VIEW_TYPE_GRAPH, VIEW_TYPE_TABLE

Fields inherited from class javax.swing.JComponent

TOOL_TIP_TEXT_KEY, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW

Fields inherited from class java.awt.Component

BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

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 java.awt.image.ImageObserver

ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH

Constructor Summary

Table()
Constructor.

Method Summary

void	addTableDataListener(TableDataListener l) Adds a listener for a user clicks that affect data.
void	autoFit() Calculates sizes for rows and columns in this Table.
GridViewHeader	getColumnHeader() Retrieves the column header component for this table.
int	getColumnHeaderRowHeight() Retrieves the height of a row in the column header.
java.awt.Color	getCornerComponentColor() Retrieves the background color of the corner component.
GridViewDatabody	getDatabody() Retrieves the databody component for this table.
int	getFetchIncrement() Retrieves the number of rows to fetched in an incremental fetch.
java.lang.String	getFetchMessage() Retrieves the message that appears in the incremental fetch row.
GridViewSelectionManager	getGridViewSelectionManager() Retrieves the selection manager that this table uses.
GridViewHeader	getRowHeader() Retrieves the row header component for this table.
int	getRowHeaderColumnWidth() Retrieves the width of the column in the row header.
int	getStartColumn() Retrieves the index of the first column that this table displays.
int	getStartRow() Retrieves the index of the first row that this table displays.
TableController	getTableController() Retrieves the controller for this table.
TableModel	getTableModel() Retrieves the model that this table uses.
TableSizingManager	getTableSizingManager() Retrieves the sizing manager that this table uses.
int	getViewType() Retrieves the type of this view.
boolean	isColumnHeaderVisible() Indicates whether the column header appears in this table.
boolean	isColumnVisible(int column) Indicates whether a column is visible.
boolean	isHGridVisible() Indicates whether horizontal gridlines are visible in this table.
boolean	isIncrementalFetchEnabled() Indicates whether incremental fetch is enabled.
boolean	isIncrementalFetchRowVisible() Determine whether the incremental fetch row is currently visible
boolean	isRowHeaderVisible() Indicates whether the row header appears in this table.
boolean	isRowVisible(int row) Indicates whether a row is visible.
boolean	isVGridVisible() Specifies whether vertical gridlines are visible in this table.
boolean	readXML(java.io.InputStream stream, boolean reset) Deprecated. As of 1.7.0.12, replaced by readXML(InputStream, int)
boolean	readXML(java.io.InputStream stream, int reset) Applies XML to this Crosstab, from a String.
void	removeTableDataListener(TableDataListener l) Removes the listener for requests of data changes.
void	resetToDefault(int reset) Resets properties of this Crosstab to their default values.
boolean	selectObject(ComponentHandle id) Selects a component or part of a component in this table.
void	setBackgroundImage(java.awt.Image image) Specifies an image to display in the databody for this table.
void	setCellEditingAllowed(boolean b) Specifies whether any cells in this table can be edited by a user.
void	setColumnHeaderRowHeight(int height) Specifies the height of a row in the column header.
void	setColumnHeaderVisible(boolean visible) Specifies whether the column header appears in this table.
void	setColumnVisible(int column, boolean visible) Specifies whether a column appears.
void	setColumnWidth(int index, int width) Specifies the width of a column in the databody.
void	setCornerComponentColor(java.awt.Color c) Specifies a background color for the corner component.
void	setDefaultCornerComponentColor(java.awt.Color c) Specifies a default background color for the corner component.
void	setFetchIncrement(int i) Specifies the number of rows of data to fetch in an incremental fetch.
void	setFetchMessage(java.lang.String s) Specifies the message that appears in the incremental fetch row.
void	setHGridVisible(boolean b) Specifies whether horizontal gridlines appear in this table.
void	setIncrementalFetchEnabled(boolean b) Specifies whether incremental fetch is enabled.
void	setLocale(java.util.Locale loc) Specifies the Locale for this Dataview.
void	setManualColumnSizingEnabled(boolean bEnabled) Specifies whether users can manually resize columns in the databody.
void	setManualRowSizingEnabled(boolean bEnabled) Specifies whether users can manually resize rows in the databody.
void	setRowHeaderColumnWidth(int width) Specifies the width of the column in the row header.
void	setRowHeaderVisible(boolean visible) Specifies whether the row header appears in this table.
void	setRowHeight(int index, int height) Specifies the height of a row in the databody, in pixels.
void	setRowVisible(int row, boolean visible) Specifies whether a row appears.
void	setStartColumn(int c) Specifies the first column of data for this table to display.
void	setStartRow(int r) Specifies the first row of data to display in this table.
void	setVGridVisible(boolean b) Indicates whether vertical gridlines appear in this table.
boolean	setXML(java.lang.String xmlString, boolean reset) Deprecated. As of 1.7.0.12, replaced by setXML(String, int)
boolean	setXML(java.lang.String xmlString, int reset) Applies XML to this Table, from a String.
boolean	setXMLAsString(java.lang.String xml) Specifies the XML representation of this Table.

Methods inherited from class oracle.dss.gridView.GridView

addGridViewDataListener, applyCSSStyleDefaults, getAutoFitColumnCount, getAutoFitColumnRangeCallback, getAutoFitRowCount, getAutoFitRowRangeCallback, getAutoFitScope, getBackgroundImage, getBackgroundImagePath, getBanding, getBaseImageURI, getCellMaxHeight, getCellMaxWidth, getCellMinHeight, getCellMinWidth, getColumnWidth, getDrillImage, getDrillImagePath, getGraphicImage, getGraphicImageCount, getGraphicImagePath, getGridColor, getGridViewController, getGridViewDatabodyStyleManager, getGridViewFormatManager, getGridViewHeaderStyleManager, getGridViewModel, getGridViewSizingManager, getHGridColor, getHTMLColumnBlockSize, getHTMLColumnSizing, getHTMLRowBlockSize, getHTMLTableCellPadding, getHTMLTableWidth, getHTMLTextInputSize, getPresentationHeight, getPresentationWidth, getRowHeight, getSelectedObject, getTruncatedNumericDataFormat, getVGridColor, getViewFormat, isCellEditingAllowed, isGrid3D, isManualColumnSizingEnabled, isManualRowSizingEnabled, isSwapAllowed, isVisible, removeGridViewDataListener, setAutoFitColumnCount, setAutoFitColumnRangeCallback, setAutoFitRowCount, setAutoFitRowRangeCallback, setAutoFitScope, setBackgroundImagePath, setBanding, setBaseImageURI, setCellMaxHeight, setCellMaxWidth, setCellMinHeight, setCellMinWidth, setDrillImage, setDrillImagePath, setEnabled, setGraphicImage, setGraphicImagePath, setGrid3D, setGridColor, setHGridColor, setHTMLColumnBlockSize, setHTMLColumnSizing, setHTMLRowBlockSize, setHTMLTableCellPadding, setHTMLTableWidth, setHTMLTextInputSize, setSwapAllowed, setTruncatedNumericDataFormat, setVGridColor, setViewFormat, setVisible

Methods inherited from class oracle.dss.dataView.Dataview

addControllerListener, addDataListener, addErrorHandler, addPropertyChangeListener, addViewFocusListener, addViewKeyListener, addViewListener, addViewMouseListener, addViewMouseMotionListener, cleanUp, getController, getDataDirector, getDataSource, getDataviewFootnote, getDataviewSubtitle, getDataviewTitle, getDescription, getHTMLPagingControlWidth, getInsertCallBack, getLocale, getLocalName, getModel, getName, getPagingControl, getPagingControlPosition, getPersistableAttributes, getPersistableComponents, getPhysicalComponents, getPopupManager, getRolloverTextManager, getTokenSubstitution, getXML, getXMLAsString, isDrillingEnabled, isHTMLPagingControlAutosubmit, isPagingControlVisible, isXMLValidated, removeControllerListener, removeDataListener, removeErrorHandler, removePropertyChangeListener, removeViewFocusListener, removeViewKeyListener, removeViewListener, removeViewMouseListener, removeViewMouseMotionListener, setDataSource, setDescription, setDrillingEnabled, setHTMLPagingControlAutosubmit, setHTMLPagingControlWidth, setInsertCallBack, setLocalName, setName, setPagingControlPosition, setPagingControlVisible, setPersistableAttributes, setPopupManager, setRolloverTextManager, setTokenSubstitution, setXMLValidated, writeXML

Methods inherited from class javax.swing.JPanel

getAccessibleContext, getUIClassID, updateUI

Methods inherited from class javax.swing.JComponent

addAncestorListener, addNotify, addPropertyChangeListener, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAutoscrolls, getBorder, getBounds, getClientProperty, getConditionForKeyStroke, getDebugGraphicsOptions, getGraphics, getHeight, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPreferredSize, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getVerifyInputWhenFocusTarget, getVisibleRect, getWidth, getX, getY, grabFocus, hasFocus, hide, isDoubleBuffered, isFocusCycleRoot, isFocusTraversable, isLightweightComponent, isManagingFocus, isMaximumSizeSet, isMinimumSizeSet, isOpaque, isOptimizedDrawingEnabled, isPaintingTile, isPreferredSizeSet, isRequestFocusEnabled, isValidateRoot, paint, paintImmediately, paintImmediately, print, printAll, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removePropertyChangeListener, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setDebugGraphicsOptions, setDoubleBuffered, setFont, setForeground, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setVerifyInputWhenFocusTarget, unregisterKeyboardAction, update

Methods inherited from class java.awt.Container

add, add, add, add, add, addContainerListener, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getLayout, insets, invalidate, isAncestorOf, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, remove, remove, removeAll, removeContainerListener, setLayout, validate

Methods inherited from class java.awt.Component

action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, bounds, checkImage, checkImage, contains, createImage, createImage, dispatchEvent, enable, enableInputMethods, getBackground, getBounds, getColorModel, getComponentOrientation, getCursor, getDropTarget, getFont, getFontMetrics, getForeground, getGraphicsConfiguration, getInputContext, getInputMethodRequests, getLocation, getLocationOnScreen, getParent, getPeer, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, imageUpdate, inside, isDisplayable, isEnabled, isLightweight, isShowing, isValid, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, repaint, repaint, repaint, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setLocation, setLocation, setSize, setSize, show, show, size, toString, transferFocus

Methods inherited from class java.lang.Object

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

Methods inherited from interface oracle.dss.dataView.GridViewAttribute

applyViewFormat, applyViewStyle, getComponentViewFormat, getComponentViewStyle

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, getLocale, getModel, isHTMLPagingControlAutosubmit, setDataSource, setHTMLPagingControlAutosubmit, setHTMLPagingControlWidth

Methods inherited from interface oracle.dss.rules.ComponentTypeConverter

convertComponentTypeToInteger, convertComponentTypeToString

Methods inherited from interface oracle.dss.gridView.UIGridView

dataAndMetadataStyleChanged, getAutoFitScope, getBackgroundImage, getGridColor, getGridViewDatabodyStyleManager, getGridViewFormatManager, getGridViewHeaderStyleManager, getHGridColor, getLocale, getModel, getPagingControl, getToolbarUIFormatCount, getUIFormatCount, getUIFormats, getVGridColor, isGrid3D, setAutoFitScope, setGrid3D, setGridColor, setHGridColor, setToolbarUIFormatCount, setUIFormatCount, setUIFormats, setVGridColor

Methods inherited from interface oracle.dss.dataView.UIDataview

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

Methods inherited from interface oracle.dss.util.PagingControlAttributes

isPagingControlVisible, setPagingControlVisible

Methods inherited from interface oracle.dss.util.persistence.Persistable

initialize, setPersistableComponents

Field Detail

TABLE

public static final int TABLE

This table.

Constructor Detail

Table

public Table()

Constructor. Call the setDataSource method to specify the data that this table displays.

See Also:

Dataview.setDataSource(oracle.dss.util.DataSource)

Method Detail

getTableModel

public TableModel getTableModel()

Retrieves the model that this table 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 TableModel that this table uses.

getTableController

public TableController getTableController()

Retrieves the controller for this table. In the Model-View-Controller architecture, the controller is responsible for attending to mouse events and keyboard events.

Returns:

The TableController for this table.

getGridViewSelectionManager

public GridViewSelectionManager getGridViewSelectionManager()

Retrieves the selection manager that this table uses. The selection manager is responsible for information about what can be selected. A GridViewSelectionManager also manages whether a cell can be edited by a user.

Overrides:

getGridViewSelectionManager in class GridView

Returns:

The selection manager that this table uses.

setLocale

public void setLocale(java.util.Locale loc)

Description copied from class: Dataview

Specifies the Locale for this Dataview.

Overrides:

setLocale in class GridView

Following copied from class: oracle.dss.dataView.Dataview

Parameters:

loc - The Locale for this Dataview.

getTableSizingManager

public TableSizingManager getTableSizingManager()

Retrieves the sizing manager that this table uses. The sizing manager is responsible for the height of the rows and the width of the columns in the table.

Returns:

The sizing manager that this table uses.

selectObject

public boolean selectObject(ComponentHandle id)

Selects a component or part of a component in this table. For example, you can select a range of cells.

Overrides:

selectObject in class Dataview

Parameters:

id - The ComponentHandle that represents the component that you want to select.

Returns:

true if the component is successfully selected, false if id has a structural problem. For example, this method returns false if id is a RowComponentHandle that seems to represent a column instead of a row.

setStartRow

public void setStartRow(int r)

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

Overrides:

setStartRow in class 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 Table, 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 table displays. Row indexes begin at zero.

Overrides:

getStartRow in class GridView

Returns:

The index of the first row that this table displays.

setStartColumn

public void setStartColumn(int c)

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

Overrides:

setStartColumn in class GridView

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 Table, 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 table displays. Column indexes begin at zero.

Overrides:

getStartColumn in class GridView

Returns:

The index of the first column that this table displays.

setHGridVisible

public void setHGridVisible(boolean b)

Specifies whether horizontal gridlines appear in this table.

Specified by:

setHGridVisible in interface UIGridView

Overrides:

setHGridVisible in class GridView

Parameters:

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

isHGridVisible

public boolean isHGridVisible()

Indicates whether horizontal gridlines are visible in this table.

Specified by:

isHGridVisible in interface UIGridView

Overrides:

isHGridVisible in class 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 table.

Specified by:

setVGridVisible in interface UIGridView

Overrides:

setVGridVisible in class 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 table.

Specified by:

isVGridVisible in interface UIGridView

Overrides:

isVGridVisible in class GridView

Returns:

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

setIncrementalFetchEnabled

public void setIncrementalFetchEnabled(boolean b)

Specifies whether incremental fetch is enabled. If you set the IncrementalFetch attribute to true, then you must add a TableDataListener to this table, to support the incremental fetch. You should add the listener and call this method before you display this table.

When incremental fetch is enabled, the table displays the number of rows that you specify in the setFetchIncrement method. Below the fetched rows, the table displays an "incremental fetch" row, which instructs the users to click in that row to display more data. The table then notifies any TableDataListener that has been added. The TableDataListener should request more rows of data from the data source to display in this table.

To specify the message that is displayed in the incremental fetch row, call the setFetchMessage method.

Parameters:

b - true to enable incremental fetch, false to disable it.

See Also:

addTableDataListener(oracle.dss.table.TableDataListener), setFetchIncrement(int), setFetchMessage(java.lang.String)

isIncrementalFetchEnabled

public boolean isIncrementalFetchEnabled()

Indicates whether incremental fetch is enabled. When incremental fetch is enabled, only a certain number of rows of data appears in the table, and users can click on the last row to see more rows of data.

Specified by:

isIncrementalFetchEnabled in interface TableCommon

Returns:

true if incremental fetch is enabled, false if it is not.

See Also:

setIncrementalFetchEnabled(boolean)

isIncrementalFetchRowVisible

public boolean isIncrementalFetchRowVisible()

Determine whether the incremental fetch row is currently visible

Specified by:

isIncrementalFetchRowVisible in interface TableCommon

Returns:

true if the incremental fetch row is visible

setFetchMessage

public void setFetchMessage(java.lang.String s)

Specifies the message that appears in the incremental fetch row.

Parameters:

s - The message to display in the incremental fetch row.

See Also:

setIncrementalFetchEnabled(boolean)

getFetchMessage

public java.lang.String getFetchMessage()

Retrieves the message that appears in the incremental fetch row.

Returns:

The message that appears in the incremental fetch row.

See Also:

setIncrementalFetchEnabled(boolean)

setFetchIncrement

public void setFetchIncrement(int i)

Specifies the number of rows of data to fetch in an incremental fetch.

Parameters:

i - The number of rows to fetch.

See Also:

setIncrementalFetchEnabled(boolean)

getFetchIncrement

public int getFetchIncrement()

Retrieves the number of rows to fetched in an incremental fetch.

Returns:

The number of rows to fetch.

See Also:

setIncrementalFetchEnabled(boolean)

setCellEditingAllowed

public void setCellEditingAllowed(boolean b)

Specifies whether any cells in this table can be edited by a user.

Overrides:

setCellEditingAllowed in class GridView

Parameters:

b - true to allow users to edit cells, false to prevent any cell editing.

getDatabody

public GridViewDatabody getDatabody()

Retrieves the databody component for this table.

Specified by:

getDatabody in interface UIGridView

Overrides:

getDatabody in class GridView

Returns:

The databody component for this table.

See Also:

TableDatabody

getColumnHeader

public GridViewHeader getColumnHeader()

Retrieves the column header component for this table.

Specified by:

getColumnHeader in interface UIGridView

Overrides:

getColumnHeader in class GridView

Returns:

The column header component for this table.

See Also:

ColHeader

getRowHeader

public GridViewHeader getRowHeader()

Retrieves the row header component for this table.

Specified by:

getRowHeader in interface UIGridView

Overrides:

getRowHeader in class GridView

Returns:

The row header component for this table.

See Also:

RowHeader

setColumnHeaderVisible

public void setColumnHeaderVisible(boolean visible)

Specifies whether the column header appears in this table.

Specified by:

setColumnHeaderVisible in interface UIGridView

Overrides:

setColumnHeaderVisible in class GridView

Parameters:

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

isColumnHeaderVisible

public boolean isColumnHeaderVisible()

Indicates whether the column header appears in this table.

Specified by:

isColumnHeaderVisible in interface UIGridView

Overrides:

isColumnHeaderVisible in class GridView

Returns:

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

setRowHeaderVisible

public void setRowHeaderVisible(boolean visible)

Specifies whether the row header appears in this table.

Specified by:

setRowHeaderVisible in interface UIGridView

Overrides:

setRowHeaderVisible in class GridView

Parameters:

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

isRowHeaderVisible

public boolean isRowHeaderVisible()

Indicates whether the row header appears in this table.

Specified by:

isRowHeaderVisible in interface UIGridView

Overrides:

isRowHeaderVisible in class GridView

Returns:

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

setBackgroundImage

public void setBackgroundImage(java.awt.Image image)

Specifies an image to display in the databody for this table. 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 table.

Specified by:

setBackgroundImage in interface UIGridView

Overrides:

setBackgroundImage in class GridView

Parameters:

image - The background image.

See Also:

GridView.getGridViewDatabodyStyleManager(), TableDatabody.getViewStyle(), ViewStyle, DiscriminatorRule

setCornerComponentColor

public void setCornerComponentColor(java.awt.Color c)

Specifies a background color for the corner component.

Overrides:

setCornerComponentColor in class GridView

Parameters:

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

getCornerComponentColor

public java.awt.Color getCornerComponentColor()

Retrieves the background color of the corner component.

Overrides:

getCornerComponentColor in class GridView

Returns:

The background color of the corner component.

setDefaultCornerComponentColor

public void setDefaultCornerComponentColor(java.awt.Color c)

Specifies a default background color for the corner component. The color that you specify in this method is set as the new corner component color. It counts as the default value when this crosstab is saved as XML.

The GridView.applyCSSStyleDefaults method calls this method to set the new default value. Application developers do not need to call this method directly.

Specified by:

setDefaultCornerComponentColor in interface GridViewCommon

Overrides:

setDefaultCornerComponentColor in class GridView

Parameters:

c - The color to set as the new default background color for the corner component.

See Also:

GridView.applyCSSStyleDefaults(oracle.dss.gridView.GridViewCommon, oracle.dss.dataView.CSSStyleDefaults)

setColumnWidth

public void setColumnWidth(int index,
                           int width)

Specifies the width of a column in the databody.

Overrides:

setColumnWidth in class GridView

Parameters:

index - The column whose width you want to set. Column numbers begin at zero.

width - The width to set the column, in pixels.

setRowHeaderColumnWidth

public void setRowHeaderColumnWidth(int width)

Specifies the width of the column in the row header.

Parameters:

width - The width to set the column, in pixels.

getRowHeaderColumnWidth

public int getRowHeaderColumnWidth()

Retrieves the width of the column in the row header.

Returns:

The width of the specified column, in pixels.

setRowHeight

public void setRowHeight(int index,
                         int height)

Specifies the height of a row in the databody, in pixels.

Overrides:

setRowHeight in class GridView

Parameters:

index - The row whose height you want to set. Row numbers begin with zero.

height - The height to set the row, in pixels.

setColumnHeaderRowHeight

public void setColumnHeaderRowHeight(int height)

Specifies the height of a row in the column header.

Parameters:

index - The row whose height you want to set. Row numbers begin at zero.

height - The height to set the row, in pixels.

getColumnHeaderRowHeight

public int getColumnHeaderRowHeight()

Retrieves the height of a row in the column header.

Parameters:

index - The row whose height you want to retrieve. Row numbers begin at zero.

Returns:

The height of the specified row, in pixels.

autoFit

public void autoFit()

Calculates sizes for rows and columns in this Table. This method can calculate the heights of rows, the widths of columns, the width of the row headers, the heights of column headers, or a combination of all of these, depending on the value of the AutoFitScope property.

Calculated sizes are checked against the minimum and maximum cell sizes. If the calculated sizes are not within that range, then the calculated size is changed to be within the minimum and maximum sizes.

This method sets the calculated sizes on the TableSizingManager and then resizes the Table through the sizing manager. If the TableSizingManager is null, then this method does nothing. The average calculated row height is set on the TableSizingManager as the default row height. This is to minimize the difference between heights of rows that have not been calculated yet and the heights of those rows once they are calculated.

The range of rows used for autofitting is determined by the AutoFitRowRangeCallback, if one is set, or if not, by the value of the AutoFitRowCount. If the first row in the range is greater than the last row, this method logs a message with the error handler and then returns.

If there are no sizes to be calculated, for instance if AutoFitScope is set to AUTOFIT_SCOPE_NONE, then this method does nothing.

Overrides:

autoFit in class GridView

See Also:

TableSizingManager, AutoFitRowRangeCallback, GridView.setAutoFitScope(int), GridView.setCellMaxHeight(int), GridView.setCellMinHeight(int), GridView.setCellMaxWidth(int), GridView.setCellMinWidth(int)

setColumnVisible

public void setColumnVisible(int column,
                             boolean visible)

Specifies whether a column appears. This method hides or reveals a column in the databody and its corresponding column in the column header.

Overrides:

setColumnVisible in class GridView

Parameters:

column - The column to hide or to reveal. Column numbers begin at zero.

visible - true to show the column, false to hide it.

isColumnVisible

public boolean isColumnVisible(int column)

Indicates whether a column is visible.

Overrides:

isColumnVisible in class GridView

Parameters:

col - The column to check. Column numbers begin at zero.

Returns:

true if the column is visible, false if it is not.

setRowVisible

public void setRowVisible(int row,
                          boolean visible)

Specifies whether a row appears. This method hides or reveals a row in the databody and its corresponding row in the row header.

Overrides:

setRowVisible in class GridView

Parameters:

row - The row to hide or to reveal. Row numbers begin at zero.

visible - true to show the row, false to hide it.

isRowVisible

public boolean isRowVisible(int row)

Indicates whether a row is visible.

Overrides:

isRowVisible in class GridView

Parameters:

row - The row to check. Row numbers begin with zero.

Returns:

true if the row is visible, false if it is not.

addTableDataListener

public void addTableDataListener(TableDataListener l)

Adds a listener for a user clicks that affect data. For example, to implement incremental fetch, you would add a listener for mouse clicks on an incremental fetch row.

Parameters:

l - The listener to add.

See Also:

setIncrementalFetchEnabled(boolean)

removeTableDataListener

public void removeTableDataListener(TableDataListener l)

Removes the listener for requests of data changes.

Parameters:

l - The listener to remove.

setManualRowSizingEnabled

public void setManualRowSizingEnabled(boolean bEnabled)

Specifies whether users can manually resize rows in the databody.

Overrides:

setManualRowSizingEnabled in class GridView

Parameters:

bEnabled - true to allow users to use the mouse to resize rows, false to prevent them from doing so.

setManualColumnSizingEnabled

public void setManualColumnSizingEnabled(boolean bEnabled)

Specifies whether users can manually resize columns in the databody.

Overrides:

setManualColumnSizingEnabled in class GridView

Parameters:

bEnabled - true to allow users to use the mouse to resize columns, false to prevent them from doing so.

getViewType

public int getViewType()

Retrieves the type of this view. This method returns Dataview.VIEW_TYPE_TABLE.

Specified by:

getViewType in interface UIDataview

Overrides:

getViewType in class Dataview

Returns:

The constant Dataview.VIEW_TYPE_TABLE

See Also:

Dataview.VIEW_TYPE_TABLE

setXML

public boolean setXML(java.lang.String xmlString,
                      boolean reset)
               throws BIIOException,
BISAXException,
BIParseException

Deprecated. As of 1.7.0.12, replaced by setXML(String, int)

The setXML method that takes an int for the reset parameter allows you to specify how much and how far to reset the view before you apply XML.

Throws:

BIIOException - If an error occurs in reading xmlString.

BISAXException - If a general SAX exception occurs in parsing the XML.

BIParseException - If the XML syntax is not correct, or if the XML is not valid according to the DTD that is specified in the XML.

setXML

public boolean setXML(java.lang.String xmlString,
                      int reset)
               throws BIIOException,
BISAXException,
BIParseException

Applies XML to this Table, from a String. This method reads the XML from xmlString and applies its attribute settings to this Table. The reset parameter determines how much of the Table to reset before applying XML. In general, you can:

• Apply the XML to the current Table without resetting anything to default values
• Reset property values only, leaving registered listeners and callbacks
• Reset property values and remove any listeners and callbacks that have been registered with this Table

Resetting returns property values in the Table to the default values for the version that is specified in the XML.

Overrides:

setXML in class Dataview

Parameters:

xmlString - The XML to apply to this Table.

reset - A constant that indicates how much and how far to reset the view before applying XML. Valid constants appear in the See Also section. If you pass an invalid constant, then this method logs a message with the error handler and does not reset any property values.

Returns:

true if the XML is successfully applied to this Table, false if an IO exception occurs.

Throws:

BIIOException - If an error occurs in reading xmlString.

BISAXException - If a general SAX exception occurs in parsing the XML.

BIParseException - If the XML syntax is not correct, or if the XML is not valid according to the DTD that is specified in the XML.

See Also:

Dataview.RESET_NONE, Dataview.RESET_XML_PROPERTIES, Dataview.RESET_EVERYTHING

readXML

public boolean readXML(java.io.InputStream stream,
                       boolean reset)
                throws BIIOException,
BISAXException,
BIParseException

Deprecated. As of 1.7.0.12, replaced by readXML(InputStream, int)

The readXML method that takes an int for the reset parameter allows you to specify how much and how far to reset the view before you apply XML.

Throws:

BIIOException - If an error occurs in reading xmlString.

BISAXException - If a general SAX exception occurs in parsing the XML.

BIParseException - If the XML syntax is not correct, or if the XML is not valid according to the DTD that is specified in the XML.

readXML

public boolean readXML(java.io.InputStream stream,
                       int reset)
                throws BIIOException,
BISAXException,
BIParseException

Applies XML to this Crosstab, from a String. This method reads the XML from xmlString and applies its attribute settings to this Crosstab. The reset parameter determines how much of the Crosstab to reset before applying XML. In general, you can:

• Apply the XML to the current Table without resetting anything to default values
• Reset property values only, leaving registered listeners and callbacks
• Reset property values and remove any listeners and callbacks that have been registered with this Table

Resetting returns property values in the Table to the default values for the version that is specified in the XML.

Overrides:

readXML in class Dataview

Parameters:

stream - The XML to apply to this Table.

reset - A constant that indicates how much and how far to reset the view before applying XML. Valid constants appear in the See Also section. If you pass an invalid constant, then this method logs a message with the error handler and does not reset any property values.

Returns:

true if the XML is successfully applied to this Table, false if an IO exception occurs.

Throws:

BIIOException - If an error occurs in reading xmlString.

BISAXException - If a general SAX exception occurs in parsing the XML.

BIParseException - If the XML syntax is not correct, or if the XML is not valid according to the DTD that is specified in the XML.

See Also:

Dataview.RESET_NONE, Dataview.RESET_XML_PROPERTIES, Dataview.RESET_EVERYTHING

resetToDefault

public void resetToDefault(int reset)

Resets properties of this Crosstab 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.

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

Overrides:

resetToDefault in class GridView

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

setXMLAsString

public boolean setXMLAsString(java.lang.String xml)
                       throws BIPersistenceException

Specifies the XML representation of this Table. The persistence service calls this method when the view is restored from the BI Beans Catalog. This method does not reset any properties before applying the XML to this Table.

Application developers should not call this method. To load XML from a file, call setXML or readXML.

Overrides:

setXMLAsString in class Dataview

Parameters:

xml - The XML representation of the view.

Returns:

true if the XML was successfully set, false if not.

Throws:

BIPersistenceException - If a problem occurs in setting the XML.

See Also:

readXML(java.io.InputStream, boolean), setXML(java.lang.String, boolean)