Oracle™ Business Intelligence Beans Java API Reference
Release 10
g (9.0.4)
Part number B12159_01


oracle.dss.gridView
Class GridView

java.lang.Object
  |
  +--java.awt.Component
        |
        +--java.awt.Container
              |
              +--javax.swing.JComponent
                    |
                    +--javax.swing.JPanel
                          |
                          +--oracle.dss.dataView.Dataview
                                |
                                +--oracle.dss.gridView.GridView
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, UIDataview, UIGridView
Direct Known Subclasses:
Crosstab, Table

public abstract class GridView
extends Dataview
implements UIGridView, Formattable, GridViewCommon

The base tabular view. This class defines methods and fields that are common the the 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.

See Also:
Serialized Form

Inner classes inherited from class javax.swing.JComponent
javax.swing.JComponent.AccessibleJComponent

 

Field Summary
static int AUTOFIT_SCOPE_ALL
          AutoFitScope: Autofit row heights, column widths, column header row heights, and row header column widths.
static int AUTOFIT_SCOPE_COLHDRROWHTS_ROWHDRCOLWDS
          AutoFitScope: Autofit column header row heights and row header column widths.
static int AUTOFIT_SCOPE_COLUMN_HEADER_ROW_HEIGHTS
          AutoFitScope: Autofit column header row heights.
static int AUTOFIT_SCOPE_COLUMN_WIDTHS
          AutoFitScope: Autofit column widths.
static int AUTOFIT_SCOPE_COLWDS_COLHDRROWHTS
          AutoFitScope: Autofit column widths and column header row heights.
static int AUTOFIT_SCOPE_COLWDS_COLHDRROWHTS_ROWHDRCOLWDS
          AutoFitScope: Autofit column widths, column header row heights, and row header column widths.
static int AUTOFIT_SCOPE_COLWDS_ROWHDRCOLWDS
          AutoFitScope: Autofit column widths and row header column widths.
static int AUTOFIT_SCOPE_COLWDS_ROWHTS
          AutoFitScope: Autofit column widths and row heights.
static int AUTOFIT_SCOPE_COLWDS_ROWHTS_COLHDRROWHTS
          AutoFitScope: Autofit column widths, row heights, and column header row heights.
static int AUTOFIT_SCOPE_COLWDS_ROWHTS_ROWHDRCOLWDS
          AutoFitScope: Autofit column widths, row heights, and row header column widths.
static int AUTOFIT_SCOPE_NONE
          AutoFitScope: Do not automatically size any cells.
static int AUTOFIT_SCOPE_ROW_HEADER_COLUMN_WIDTHS
          AutoFitScope: Autofit row header column widths.
static int AUTOFIT_SCOPE_ROW_HEIGHTS
          AutoFitScope: Autofit row heights.
static int AUTOFIT_SCOPE_ROWHTS_COLHDRROWHTS
          AutoFitScope: Autofit row heights and column header row heights.
static int AUTOFIT_SCOPE_ROWHTS_COLHDRROWHTS_ROWHDRCOLWDS
          AutoFitScope: Autofit row heights, column header row heights, and row header column widths.
static int AUTOFIT_SCOPE_ROWHTS_ROWHDRCOLWDS
          AutoFitScope: Autofit row heights and row header column widths.
static int COL_HEADER
          The column header component.
static int COL_HEADER_RANGE
          A range of cells in the column header.
static int DATA_CELL
          A data cell.
static int DATA_CELL_RANGE
          A range of data cells.
static int DATA_COLUMN
          A column of data.
static int DATA_COLUMN_RANGE
          A range of data columns.
static int DATA_ROW
          A row of data.
static int DATA_ROW_RANGE
          A range of data rows.
static int DATABODY
          The databody component.
static int DATABODY_HIGHLIGHTER
          The databody highlighter.
static int FILL_WITH_HASHMARKS
          Use #### in cells that are not large enough to display the data value for the cell.
static int ROW_HEADER
          The row header component.
static int ROW_HEADER_RANGE
          A range of cells in the row header.
static int TRUNCATE_WITH_ELLIPSIS
          Use truncated numbers, with ellipses, in cells that are not large enough to display the data value for the cell.
static int TRUNCATE_WITHOUT_ELLIPSIS
          Use truncated numbers, without ellipses, in cells that are not large enough to display the data value for the cell.

 

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
GridView()
          Constructor.

 

Method Summary
 void addGridViewDataListener(GridViewDataListener l)
          Adds a listener for requests of data changes.
static void applyCSSStyleDefaults(GridViewCommon view, CSSStyleDefaults defaults)
          Applies the styles in a cascading style sheet (CSS) as default values in a GridView.
abstract  void autoFit()
          Calculates sizes for rows and columns in this Crosstab.
 int getAutoFitColumnCount()
          Retrieves the number of columns that are considered when calculating automatic cell sizes.
 AutoFitColumnRangeCallback getAutoFitColumnRangeCallback()
          Retrieves the callback that provides the range of columns to consider during an autofit.
 int getAutoFitRowCount()
          Retrieves the number of rows that are considered when calculating automatic cell sizes.
 AutoFitRowRangeCallback getAutoFitRowRangeCallback()
          Retrieves the callback that provides the range of rows to consider during an autofit.
 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.
 java.lang.String getBackgroundImagePath()
          Retrieves a relative path to a background image for this GridView.
 int getBanding()
          Retrieves the kind of banding that this GridView uses.
 java.lang.String getBaseImageURI()
          Retrieves the base URI for loading images.
 int getCellMaxHeight()
          Retrieves the maximum height for cells in this GridView, in pixels.
 int getCellMaxWidth()
          Retrieves the maximum width for cells in this GridView, in pixels.
 int getCellMinHeight()
          Retrieves the minimum height for cells in this GridView, in pixels.
 int getCellMinWidth()
          Retrieves the minimum width for cells in this GridView, in pixels.
abstract  GridViewHeader getColumnHeader()
          Retrieves the column header for this GridView.
 int getColumnWidth(int index)
          Retrieves the width of a column in the databody.
abstract  java.awt.Color getCornerComponentColor()
          Retrieves the background color of the corner component.
abstract  GridViewDatabody getDatabody()
          Retrieves the databody for this GridView.
 java.awt.Image getDrillImage(int index)
          Retrieves the drill image from the vector of drill images for this GridView.
 java.lang.String getDrillImagePath(int index)
          Retrieves a relative path to a drill image for this GridView.
 java.awt.Image getGraphicImage(int index)
          Retrieves a graphic image from the vector of images for this GridView.
 int getGraphicImageCount()
          Retrieves the number of graphic images that are available for this GridView.
 java.lang.String getGraphicImagePath(int index)
          Retrieves a relative path to a graphic image for this GridView.
 java.awt.Color getGridColor()
          Retrieves the color of the gridlines in this GridView.
 GridViewController getGridViewController()
          Retrieves the controller for this GridView.
 GridViewDatabodyStyleManager getGridViewDatabodyStyleManager()
          Retrieves the style manager that this GridView uses to format databody cells.
 GridViewFormatManager getGridViewFormatManager()
          Retrieves the format manager that this GridView uses.
 GridViewHeaderStyleManager getGridViewHeaderStyleManager()
          Retrieves the style manager that this GridView uses to format headers.
 GridViewModel getGridViewModel()
          Retrieves the model that this GridView uses.
 GridViewSelectionManager getGridViewSelectionManager()
          Retrieves the selection manager that this GridView uses.
 GridViewSizingManager getGridViewSizingManager()
          Retrieves the sizing manager that this GridView uses.
 java.awt.Color getHGridColor()
          Retrieves the color of the horizontal gridlines in this GridView.
 int getHTMLColumnBlockSize()
          Indicates the number of columns that appear at a time in the HTML table that a thin GridView renders.
 int getHTMLColumnSizing()
          Retrieves the HTML column sizing option.
 int getHTMLRowBlockSize()
          Indicates the number of rows that appear at a time in the HTML table that a thin GridView renders.
 java.lang.Integer getHTMLTableCellPadding()
          Retrieves the cell padding of the HTML table that a thin GridView renders.
 java.lang.String getHTMLTableWidth()
          Retrieves the width of the HTML table that a thin GridView renders.
 int getHTMLTextInputSize()
          Retrieves the number of characters displayed in cells that can be edited.
 int getPresentationHeight()
          The height of this GridView, in pixels.
 int getPresentationWidth()
          The width of this GridView, in pixels.
abstract  GridViewHeader getRowHeader()
          Retrieves the row header for this GridView.
 int getRowHeight(int index)
          Retrieves the height of a row in the databody.
 ComponentHandle getSelectedObject()
          Retrieves a handle for the most recently selected component or part of a component in this GridView.
abstract  int getStartColumn()
          Retrieves the first visible column of data that this view currently displays.
abstract  int getStartRow()
          Retrieves the first visible row of data that this view currently displays.
 int getTruncatedNumericDataFormat()
          Retrieves the format that this GridView uses for numeric data that does not fit in its cell.
 java.awt.Color getVGridColor()
          Retrieves the color of the vertical gridlines in this GridView.
 ViewFormat getViewFormat()
          Retrieves the ViewFormat object that this GridView uses to format numbers.
 boolean isCellEditingAllowed()
          Indicates whether users can edit cells in this GridView.
abstract  boolean isColumnHeaderVisible()
          Indicates whether the column header appears in this GridView.
abstract  boolean isColumnVisible(int col)
          Indicates whether a column is visible.
 boolean isGrid3D()
          Indicates whether the gridlines in this GridView have a three-dimensional appearance.
abstract  boolean isHGridVisible()
          Indicates whether horizontal gridlines are visible in this GridView.
 boolean isManualColumnSizingEnabled()
          Indicates whether users can manually resize columns in the databody.
 boolean isManualRowSizingEnabled()
          Indicates whether users can manually resize rows in the databody.
abstract  boolean isRowHeaderVisible()
          Indicates whether the row header appears in this GridView.
abstract  boolean isRowVisible(int row)
          Indicates whether a row is visible.
 boolean isSwapAllowed()
          Indicates whether swapping is allowed in this view.
abstract  boolean isVGridVisible()
          Specifies whether vertical gridlines are visible in this GridView.
 boolean isVisible()
          Indicates whether this GridView is visible.
 void removeGridViewDataListener(GridViewDataListener l)
          Removes the listener for requests of data changes.
 void resetToDefault(int reset)
          Resets properties of this GridView to their default values.
 void setAutoFitColumnCount(int colCount)
          Specifies the number of columns to consider when calculating cell sizes.
 void setAutoFitColumnRangeCallback(AutoFitColumnRangeCallback callback)
          Specifies a callback to get the range of columns to consider during an autofit.
 void setAutoFitRowCount(int rowCount)
          Specifies the number of rows to consider when calculating cell sizes.
 void setAutoFitRowRangeCallback(AutoFitRowRangeCallback callback)
          Specifies a callback to get the range of rows to consider during an autofit.
 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 setBackgroundImagePath(java.lang.String path)
          Specifies the relative path to a background image for this GridView.
 void setBanding(int banding)
          Specifies whether and what kind of banding to use in this GridView.
 void setBaseImageURI(java.lang.String baseImageURI)
          Specifies the base URI for loading images.
abstract  void setCellEditingAllowed(boolean b)
          Specifies whether users can edit cells in this GridView.
 void setCellMaxHeight(int height)
          Specifies the maximum height for cells in this GridView, in pixels.
 void setCellMaxWidth(int width)
          Specifies the maximum width for cells in this GridView, in pixels.
 void setCellMinHeight(int height)
          Specifies the minimum height for cells in this GridView, in pixels.
 void setCellMinWidth(int width)
          Specifies the minimum width for cells in this GridView, in pixels.
abstract  void setColumnHeaderVisible(boolean visible)
          Specifies whether the column header appears in this GridView.
abstract  void setColumnVisible(int column, boolean visible)
          Specifies whether a column appears.
abstract  void setColumnWidth(int index, int width)
          Specifies the width of a column in the databody.
abstract  void setCornerComponentColor(java.awt.Color c)
          Specifies a background color for the corner component.
abstract  void setDefaultCornerComponentColor(java.awt.Color c)
          Specifies a default background color for the corner component.
 void setDrillImage(int index, java.awt.Image image)
          Specifies a drill image for this GridView.
 void setDrillImagePath(int index, java.lang.String path)
          Specifies the relative path to a drill image for this GridView.
 void setEnabled(boolean enabled)
          Specifies whether this GridView is enabled.
 void setGraphicImage(int index, java.awt.Image image)
          Specifies a graphic image for this GridView.
 void setGraphicImagePath(int index, java.lang.String path)
          Specifies the relative path to a graphic image for this GridView.
 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.
abstract  void setHGridVisible(boolean b)
          Specifies whether horizontal gridlines appear in this GridView.
 void setHTMLColumnBlockSize(int size)
          Specifies the number of columns to display at a time in the HTML table that a thin GridView renders.
 void setHTMLColumnSizing(int htmlColumnSizing)
          Specifies the HTML column sizing option.
 void setHTMLRowBlockSize(int size)
          Specifies the number of rows to display at a time in the HTML table that a thin GridView renders.
 void setHTMLTableCellPadding(java.lang.Integer padding)
          Specifies the cell padding of the HTML table that a thin GridView renders.
 void setHTMLTableWidth(java.lang.String width)
          Specifies the width of the HTML table that a thin GridView renders.
 void setHTMLTextInputSize(int size)
          Specifies the number of characters to display in cells that can be edited.
 void setLocale(java.util.Locale loc)
          Specifies the Locale for this Dataview.
abstract  void setManualColumnSizingEnabled(boolean bEnabled)
          Specifies whether users can manually resize columns in the databody.
abstract  void setManualRowSizingEnabled(boolean bEnabled)
          Specifies whether users can manually resize rows in the databody.
abstract  void setRowHeaderVisible(boolean visible)
          Specifies whether the row header appears in this GridView.
abstract  void setRowHeight(int index, int height)
          Specifies the height of a row in the databody, in pixels.
abstract  void setRowVisible(int row, boolean visible)
          Specifies whether a row appears.
abstract  void setStartColumn(int c)
          Specifies the first visible column of data to display in this view.
abstract  void setStartRow(int r)
          Specifies the first visible row of data to display in this view.
 void setSwapAllowed(boolean swap)
          Specifies whether users can swap items in this view.
 void setTruncatedNumericDataFormat(int format)
          Specifies the format to use for numeric data when the complete value does not fit in its cell.
 void setVGridColor(java.awt.Color color)
          Specifies the color of the vertical gridlines in this GridView.
abstract  void setVGridVisible(boolean b)
          Indicates whether vertical gridlines appear in this GridView.
 void setViewFormat(ViewFormat vf)
          Specifies the ViewFormat object for this GridView.
 void setVisible(boolean visible)
          Specifies whether this GridView is visible.

 

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, getViewType, getXML, getXMLAsString, isDrillingEnabled, isHTMLPagingControlAutosubmit, isPagingControlVisible, isXMLValidated, readXML, removeControllerListener, removeDataListener, removeErrorHandler, removePropertyChangeListener, removeViewFocusListener, removeViewKeyListener, removeViewListener, removeViewMouseListener, removeViewMouseMotionListener, selectObject, setDataSource, setDescription, setDrillingEnabled, setHTMLPagingControlAutosubmit, setHTMLPagingControlWidth, setInsertCallBack, setLocalName, setName, setPagingControlPosition, setPagingControlVisible, setPersistableAttributes, setPopupManager, setRolloverTextManager, setTokenSubstitution, setXML, setXMLAsString, 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.gridView.UIGridView
dataAndMetadataStyleChanged, getLocale, getModel, getPagingControl, getToolbarUIFormatCount, getUIFormatCount, getUIFormats, setToolbarUIFormatCount, setUIFormatCount, setUIFormats

 

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, getTokenSubstitution, getViewType, 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

DATABODY

public static final int DATABODY
The databody component.

COL_HEADER

public static final int COL_HEADER
The column header component.

ROW_HEADER

public static final int ROW_HEADER
The row header component.

DATA_CELL

public static final int DATA_CELL
A data cell.

DATABODY_HIGHLIGHTER

public static final int DATABODY_HIGHLIGHTER
The databody highlighter. The databody highlighter allows users to select all of the cells in the databody with one click.

DATA_COLUMN

public static final int DATA_COLUMN
A column of data.

DATA_ROW

public static final int DATA_ROW
A row of data.

DATA_CELL_RANGE

public static final int DATA_CELL_RANGE
A range of data cells.

COL_HEADER_RANGE

public static final int COL_HEADER_RANGE
A range of cells in the column header.

ROW_HEADER_RANGE

public static final int ROW_HEADER_RANGE
A range of cells in the row header.

DATA_COLUMN_RANGE

public static final int DATA_COLUMN_RANGE
A range of data columns.

DATA_ROW_RANGE

public static final int DATA_ROW_RANGE
A range of data rows.

FILL_WITH_HASHMARKS

public static final int FILL_WITH_HASHMARKS
Use #### in cells that are not large enough to display the data value for the cell.

TRUNCATE_WITHOUT_ELLIPSIS

public static final int TRUNCATE_WITHOUT_ELLIPSIS
Use truncated numbers, without ellipses, in cells that are not large enough to display the data value for the cell.

TRUNCATE_WITH_ELLIPSIS

public static final int TRUNCATE_WITH_ELLIPSIS
Use truncated numbers, with ellipses, in cells that are not large enough to display the data value for the cell.

AUTOFIT_SCOPE_NONE

public static final int AUTOFIT_SCOPE_NONE
AutoFitScope: Do not automatically size any cells.

AUTOFIT_SCOPE_ROW_HEIGHTS

public static final int AUTOFIT_SCOPE_ROW_HEIGHTS
AutoFitScope: Autofit row heights.

AUTOFIT_SCOPE_COLUMN_WIDTHS

public static final int AUTOFIT_SCOPE_COLUMN_WIDTHS
AutoFitScope: Autofit column widths.

AUTOFIT_SCOPE_COLUMN_HEADER_ROW_HEIGHTS

public static final int AUTOFIT_SCOPE_COLUMN_HEADER_ROW_HEIGHTS
AutoFitScope: Autofit column header row heights.

AUTOFIT_SCOPE_ROW_HEADER_COLUMN_WIDTHS

public static final int AUTOFIT_SCOPE_ROW_HEADER_COLUMN_WIDTHS
AutoFitScope: Autofit row header column widths.

AUTOFIT_SCOPE_ALL

public static final int AUTOFIT_SCOPE_ALL
AutoFitScope: Autofit row heights, column widths, column header row heights, and row header column widths.

AUTOFIT_SCOPE_COLWDS_ROWHTS

public static final int AUTOFIT_SCOPE_COLWDS_ROWHTS
AutoFitScope: Autofit column widths and row heights.

AUTOFIT_SCOPE_COLWDS_COLHDRROWHTS

public static final int AUTOFIT_SCOPE_COLWDS_COLHDRROWHTS
AutoFitScope: Autofit column widths and column header row heights.

AUTOFIT_SCOPE_COLWDS_ROWHDRCOLWDS

public static final int AUTOFIT_SCOPE_COLWDS_ROWHDRCOLWDS
AutoFitScope: Autofit column widths and row header column widths.

AUTOFIT_SCOPE_ROWHTS_COLHDRROWHTS

public static final int AUTOFIT_SCOPE_ROWHTS_COLHDRROWHTS
AutoFitScope: Autofit row heights and column header row heights.

AUTOFIT_SCOPE_ROWHTS_ROWHDRCOLWDS

public static final int AUTOFIT_SCOPE_ROWHTS_ROWHDRCOLWDS
AutoFitScope: Autofit row heights and row header column widths.

AUTOFIT_SCOPE_COLHDRROWHTS_ROWHDRCOLWDS

public static final int AUTOFIT_SCOPE_COLHDRROWHTS_ROWHDRCOLWDS
AutoFitScope: Autofit column header row heights and row header column widths.

AUTOFIT_SCOPE_COLWDS_ROWHTS_COLHDRROWHTS

public static final int AUTOFIT_SCOPE_COLWDS_ROWHTS_COLHDRROWHTS
AutoFitScope: Autofit column widths, row heights, and column header row heights.

AUTOFIT_SCOPE_COLWDS_ROWHTS_ROWHDRCOLWDS

public static final int AUTOFIT_SCOPE_COLWDS_ROWHTS_ROWHDRCOLWDS
AutoFitScope: Autofit column widths, row heights, and row header column widths.

AUTOFIT_SCOPE_COLWDS_COLHDRROWHTS_ROWHDRCOLWDS

public static final int AUTOFIT_SCOPE_COLWDS_COLHDRROWHTS_ROWHDRCOLWDS
AutoFitScope: Autofit column widths, column header row heights, and row header column widths.

AUTOFIT_SCOPE_ROWHTS_COLHDRROWHTS_ROWHDRCOLWDS

public static final int AUTOFIT_SCOPE_ROWHTS_COLHDRROWHTS_ROWHDRCOLWDS
AutoFitScope: Autofit row heights, column header row heights, and row header column widths.
Constructor Detail

GridView

public GridView()
Constructor. Application developers should call the constructors of the concrete subclasses of this class. Those constructors call this constructor.
Method Detail

getGridViewModel

public GridViewModel getGridViewModel()
Retrieves the model that this GridView 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 GridView uses.

getGridViewController

public GridViewController getGridViewController()
Retrieves the controller for this GridView. In the Model-View-Controller architecture, the controller is responsible for attending to mouse events and key events.
Returns:
The GridViewController for this GridView.

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

getGridViewSelectionManager

public GridViewSelectionManager getGridViewSelectionManager()
Retrieves the selection manager that this GridView uses. The selection manager is responsible for the selection of cells in the GridView.
Returns:
The selection manager that this GridView uses. If this GridView does not have a controller, then this method returns null.

getGridViewSizingManager

public GridViewSizingManager getGridViewSizingManager()
Retrieves the sizing manager that this GridView uses. The sizing manager is responsible for the size of the rows and columns in this GridView.
Returns:
The sizing manager that this GridView uses. If this GridView does not have a controller, then this method returns null.

getGridViewHeaderStyleManager

public GridViewHeaderStyleManager getGridViewHeaderStyleManager()
Retrieves the style manager that this GridView uses to format headers. The style manager is responsible for the formatting of the header cells in this GridView. For example, the ViewStyle object from the style manager determines the background color of a header cell.
Specified by:
getGridViewHeaderStyleManager in interface UIGridView
Returns:
The GridViewHeaderStyleManager 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 to format databody cells. The style manager is responsible for the formatting of the databody cells in this GridView. For example, the ViewStyle object from the style manager determines the background color of a data cell.
Specified by:
getGridViewDatabodyStyleManager in interface UIGridView
Returns:
The GridViewDatabodyStyleManager that this GridView uses. If this GridView does not have a controller, then this method returns null.
See Also:
ViewStyle

setLocale

public void setLocale(java.util.Locale loc)
Description copied from class: Dataview
Specifies the Locale for this Dataview.
Overrides:
setLocale in class Dataview
Following copied from class: oracle.dss.dataView.Dataview
Parameters:
loc - The Locale for this Dataview.

setViewFormat

public void setViewFormat(ViewFormat vf)
Specifies the ViewFormat object for this GridView. The ViewFormat specifies attributes that this GridView 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 GridView.

getViewFormat

public ViewFormat getViewFormat()
Retrieves the ViewFormat object that this GridView uses to format numbers.
Specified by:
getViewFormat in interface Formattable
Returns:
The ViewFormat that this GridView uses.

getPresentationHeight

public int getPresentationHeight()
The height of this GridView, in pixels.
Overrides:
getPresentationHeight in class Dataview
Returns:
The height of this GridView, in pixels.

getPresentationWidth

public int getPresentationWidth()
The width of this GridView, in pixels.
Overrides:
getPresentationWidth in class Dataview
Returns:
The width of this GridView, in pixels.

getSelectedObject

public ComponentHandle getSelectedObject()
Retrieves a handle for the most recently selected component or part of a component in this GridView. For example, the selected item might be the entire databody, or it could be a single data cell.

The subclass of ComponentHandle that this method returns provides access to the selected item as well as access to the selected item.

Specified by:
getSelectedObject in interface UIDataview
Overrides:
getSelectedObject in class Dataview
Returns:
The ComponentHandle that represents the selected object.

setVisible

public void setVisible(boolean visible)
Specifies whether this GridView is visible.
Overrides:
setVisible in class javax.swing.JComponent
Parameters:
visible - true to make this GridView visible, false to hide it.

isVisible

public boolean isVisible()
Indicates whether this GridView is visible.
Overrides:
isVisible in class java.awt.Component
Returns:
true if this GridView is visible, false if it is not.

setHGridVisible

public abstract 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 abstract 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 abstract 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 abstract 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.

setColumnHeaderVisible

public abstract void setColumnHeaderVisible(boolean visible)
Specifies whether the column header appears in this GridView.
Specified by:
setColumnHeaderVisible in interface UIGridView
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 GridView.
Specified by:
isColumnHeaderVisible in interface UIGridView
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 GridView.
Specified by:
setRowHeaderVisible in interface UIGridView
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 GridView.
Specified by:
isRowHeaderVisible in interface UIGridView
Returns:
true if the row header appears, false if it does not.

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.

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.

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 GridViewDatabodyStyle 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:
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.

setBackgroundImagePath

public void setBackgroundImagePath(java.lang.String path)
Specifies the relative path to a background image for this GridView. The relative path is appended to the BaseImageURI to construct the full path to the image. The full path may specify a URL or a resource on the classpath.

For example, the relative path to an image may be "images/myImage.gif". If no BaseImageURI is set, then this method attempts to load the image from the classpath, on the specified path relative to the GridView class, which would be "/oracle/dss/gridView/images/myImage.gif".

If BaseImageURI is "/myPackage/myComponent/", then this method attempts to load the image from the classpath on the specified absolute path, "/myPackage/myComponent/images/myImage.gif".

If BaseImageURI is "http://my.server.com/", then this method attempts to load the image at the given URL, "http://my.server.com/images/myImage.gif".

If an image cannot be loaded, a special "not loaded" image will be used instead.

This method also calls setBackgroundImage to set the actual Image object. If setBackgroundImage is called to set an Image object this method is called, then the path that was set in this method is erased.

Parameters:
path - The relative path to an image file.
See Also:
setBackgroundImage(java.awt.Image), setBaseImageURI(java.lang.String)

getBackgroundImagePath

public java.lang.String getBackgroundImagePath()
Retrieves a relative path to a background image for this GridView. The full path to the image is constructed by appending the relative path to theBaseImageURI.
Returns:
The relative path to the image.
See Also:
getBackgroundImage(), getBaseImageURI()

setCellMaxHeight

public void setCellMaxHeight(int height)
Specifies the maximum height for cells in this GridView, in pixels.
Parameters:
height - The maximum height for cells in this GridView.

getCellMaxHeight

public int getCellMaxHeight()
Retrieves the maximum height for cells in this GridView, in pixels.
Specified by:
getCellMaxHeight in interface GridViewCommon
Returns:
The maximum height for cells in this GridView.

setCellMinHeight

public void setCellMinHeight(int height)
Specifies the minimum height for cells in this GridView, in pixels.
Parameters:
height - The minimum height for cells in this GridView.

getCellMinHeight

public int getCellMinHeight()
Retrieves the minimum height for cells in this GridView, in pixels.
Specified by:
getCellMinHeight in interface GridViewCommon
Returns:
The minimum height for cells in this GridView.

setCellMaxWidth

public void setCellMaxWidth(int width)
Specifies the maximum width for cells in this GridView, in pixels.
Parameters:
width - The maximum width for cells in this GridView.

getCellMaxWidth

public int getCellMaxWidth()
Retrieves the maximum width for cells in this GridView, in pixels.
Specified by:
getCellMaxWidth in interface GridViewCommon
Returns:
The maximum width for cells in this GridView.

setCellMinWidth

public void setCellMinWidth(int width)
Specifies the minimum width for cells in this GridView, in pixels.
Parameters:
The - minimum width for cells in this GridView.

getCellMinWidth

public int getCellMinWidth()
Retrieves the minimum width for cells in this GridView, in pixels.
Specified by:
getCellMinWidth in interface GridViewCommon
Returns:
The minimum width for cells in this GridView.

setEnabled

public void setEnabled(boolean enabled)
Specifies whether this GridView is enabled. When a GridView is disabled, it is visible, but users cannot operate on the GridView. For example, they cannot swap dimensions or edit a cell.
Overrides:
setEnabled in class Dataview
Parameters:
enabled - true to enable this GridView, false to disable it.

getColumnWidth

public int getColumnWidth(int index)
Retrieves the width of a column in the databody.
Parameters:
index - The column whose width you want. Column numbers begin at zero.
Returns:
The width, in pixels, of the specified column.

setColumnWidth

public abstract void setColumnWidth(int index,
                                    int width)
Specifies the width of a column in the databody.
Parameters:
index - The column whose width you want to set. Column numbers begin at zero.
width - The width to set the column, in pixels.

getRowHeight

public int getRowHeight(int index)
Retrieves the height of a row in the databody.
Parameters:
index - The row whose height you want. Row numbers begin with zero.
Returns:
The height of the specified row, in pixels.

setRowHeight

public abstract void setRowHeight(int index,
                                  int height)
Specifies the height of a row in the databody, in pixels.
Parameters:
index - The row whose height you want to set. Row numbers begin with zero.
height - The height to set the row, in pixels.

autoFit

public abstract void autoFit()
Calculates sizes for rows and columns in this Crosstab. 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.

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.

See Also:
setAutoFitScope(int), setAutoFitRowCount(int)

setAutoFitRowCount

public void setAutoFitRowCount(int rowCount)
Specifies the number of rows to consider when calculating cell sizes. The default value is 20. The first row is the first row on screen. If the first row on the screen cannot be determined, then the first row is the first row in the data source, which is row 0.

If the range, starting with the first row, extends beyond valid row indexes in the data source, then the entire range will be pushed back so that all rows in the range are valid. If the value that you set in this method is greater than the number of rows in the data source, then the range is the entire data source.

You can also pass -1 to this method to specify the entire data source as the range.

If you set AutoFitRowCount to any other value less than 1, then this method logs a message with the error handler and does not change the current value.

If you want finer control over the range of rows that are considered in automatic size calculations, then you can register an implementation of the AutoFitRowRangeCallback interface with this GridView. The calculation uses the callback if one is registered. If no callback is registered, or if the callback returns a null range, then the calculation uses the value that you specify in this method.

Parameters:
rowCount - The number of rows to consider during an autofit. Pass -1 to consider all rows. Other values must be 1 or greater.
See Also:
autoFit(), setAutoFitRowRangeCallback(oracle.dss.gridView.AutoFitRowRangeCallback)

getAutoFitRowCount

public int getAutoFitRowCount()
Retrieves the number of rows that are considered when calculating automatic cell sizes.
Returns:
The number of rows to consider when autofitting.

setAutoFitColumnCount

public void setAutoFitColumnCount(int colCount)
Specifies the number of columns to consider when calculating cell sizes. The default value is 20. The first column is the first column on screen. If the first column on the screen cannot be determined, then the first column is the first column in the data source, which is column 0.

If the range, starting with the first column, extends beyond valid column indexes in the data source, then the entire range will be pushed back so that all column in the range are valid. If the value that you set in this method is greater than the number of column in the data source, then the range is the entire data source.

You can also pass -1 to this method to specify the entire data source as the range.

If you set AutoFitColCount to a value less than 1, but not equal to -1, then this method logs a message with the error handler and does not change the current value.

If you want finer control over the range of columns that are considered in automatic size calculations, then you can register an implementation of the AutoFitColumnRangeCallback interface with this GridView. The calculation uses the callback if one is registered. If no callback is registered, or if the callback returns a null range, then the calculation uses the value that you specify in this method.

Parameters:
rowCount - The number of columns to consider during an autofit. Pass -1 to consider all columns. Other values must be 1 or greater.
See Also:
autoFit(), setAutoFitColumnRangeCallback(oracle.dss.gridView.AutoFitColumnRangeCallback)

getAutoFitColumnCount

public int getAutoFitColumnCount()
Retrieves the number of columns that are considered when calculating automatic cell sizes.
Returns:
The number of columns to consider when autofitting.

setAutoFitRowRangeCallback

public void setAutoFitRowRangeCallback(AutoFitRowRangeCallback callback)
Specifies a callback to get the range of rows to consider during an autofit. If no callback is set, or if the callback returns a null range, then the AutoFitRowCount property determines the range of rows that are considered.
Parameters:
callback - The callback that provides the range of rows that should be considered during automatic calculation of cell sizes.
See Also:
setAutoFitRowCount(int), autoFit()

getAutoFitRowRangeCallback

public AutoFitRowRangeCallback getAutoFitRowRangeCallback()
Retrieves the callback that provides the range of rows to consider during an autofit.
Returns:
The callback used to get the range of rows to consider during an autofit operation.

setAutoFitColumnRangeCallback

public void setAutoFitColumnRangeCallback(AutoFitColumnRangeCallback callback)
Specifies a callback to get the range of columns to consider during an autofit. If no callback is set, or if the callback returns a null range, then the AutoFitColumnCount property determines the range of columns that are considered.
Parameters:
callback - The callback that provides the range of columns that should be considered during automatic calculation of cell sizes.
See Also:
setAutoFitColumnCount(int), autoFit()

getAutoFitColumnRangeCallback

public AutoFitColumnRangeCallback getAutoFitColumnRangeCallback()
Retrieves the callback that provides the range of columns to consider during an autofit.
Returns:
The callback used to get the range of columns to consider during an autofit operation.

setAutoFitScope

public void setAutoFitScope(int scope)
Specifies what to automatically set cell sizes for. The autoFit method calculates the sizes of cells, based on the data that will appear in the cells. This method specifies whether autoFit should calculate sizes for row heights, column widths, row header widths, column header heights, or a combination of widths and heights. Constants are listed in the See Also section. They can be set individually or combined, using an OR (|) operator.
Specified by:
setAutoFitScope in interface UIGridView
Parameters:
scope - An integer that identifies what part or parts of this GridView to calculate sizes for.
See Also:
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

getAutoFitScope

public int getAutoFitScope()
Retrieves the scope for which autofitting will calculate sizes. The returned value may be one of the constants that are listed in the See Also section, or it can be a combination, using the OR (|) operator.
Specified by:
getAutoFitScope in interface UIGridView
Returns:
A constant that represents the scope for which autofitting will calculate sizes.
See Also:
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

setColumnVisible

public abstract 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.
Parameters:
column - The column to hide or to reveal. Column numbers begin at zero.
visible - true to show the column, false to hide it.

setRowVisible

public abstract 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.
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 abstract boolean isRowVisible(int row)
Indicates whether a row is visible.
Parameters:
row - The row to check. Row numbers begin with zero.
Returns:
true if the row is visible, false if it is not.

isColumnVisible

public abstract boolean isColumnVisible(int col)
Indicates whether a column is visible.
Parameters:
col - The column to check. Column numbers begin at zero.
Returns:
true if the column is visible, false if it is not.

setTruncatedNumericDataFormat

public void setTruncatedNumericDataFormat(int format)
Specifies the format to use for numeric data when the complete value does not fit in its cell. You can fill the cell with hash marks (##), truncate the number, adding an ellipsis to the end, or truncate the number without any ellipsis.
Parameters:
format - A constant that indicates the format to use.
See Also:
FILL_WITH_HASHMARKS, TRUNCATE_WITH_ELLIPSIS, TRUNCATE_WITHOUT_ELLIPSIS

getTruncatedNumericDataFormat

public int getTruncatedNumericDataFormat()
Retrieves the format that this GridView uses for numeric data that does not fit in its cell.
Returns:
A constant that indicates the format that this GridView uses.
See Also:
FILL_WITH_HASHMARKS, TRUNCATE_WITH_ELLIPSIS, TRUNCATE_WITHOUT_ELLIPSIS

getDatabody

public abstract GridViewDatabody getDatabody()
Retrieves the databody for this GridView.
Specified by:
getDatabody in interface UIGridView
Returns:
The databody for this GridView.

getColumnHeader

public abstract GridViewHeader getColumnHeader()
Retrieves the column header for this GridView.
Specified by:
getColumnHeader in interface UIGridView
Returns:
The column header for this GridView.

getRowHeader

public abstract GridViewHeader getRowHeader()
Retrieves the row header for this GridView.
Specified by:
getRowHeader in interface UIGridView
Returns:
The row header for this GridView.

setGraphicImage

public void setGraphicImage(int index,
                            java.awt.Image image)
Specifies a graphic image for this GridView. Images are stored in a vector of images. Note that images for drill icons are stored in a separate vector.
Parameters:
index - The index, in the image vector, where you want to store an image. 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 to store.
See Also:
setDrillImage(int, java.awt.Image)

getGraphicImage

public java.awt.Image getGraphicImage(int index)
Retrieves a graphic image from the vector of images for this GridView. Note that images for drill icons are stored in a separate vector.
Parameters:
index - The index, in the vector, of the image that you want. Valid values are zero to one less than the size of the vector.
Returns:
The image 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:
getDrillImage(int)

setGraphicImagePath

public void setGraphicImagePath(int index,
                                java.lang.String path)
Specifies the relative path to a graphic image for this GridView. Image paths are stored in a vector of strings. Note that paths for drill icons are stored in a separate vector.

The relative path passed into this method is appended to the BaseImageURI to construct the full path to the image. The full path may specify a URL or a resource on the classpath.

For example, the relative path to an image may be "images/myImage.gif". If no BaseImageURI is set, then this method attempts to load the image from the classpath, on the specified path relative to the GridView class, which would be "/oracle/dss/gridView/images/myImage.gif".

If BaseImageURI is "/myPackage/myComponent/", then this method attempts to load the image from the classpath on the specified absolute path, "/myPackage/myComponent/images/myImage.gif".

If BaseImageURI is "http://my.server.com/", then this method attempts to load the image at the given URL, "http://my.server.com/images/myImage.gif".

If an image cannot be loaded, a special "not loaded" image is used instead.

This method also calls setGraphicImage to set the actual Image object. If setGraphicImage is called to set an Image object at an index for which an image path has already been set, then the path set through this method is erased.

Parameters:
index - The index, in the image vector, where you want to store an image. Negative numbers are ignored. If you pass a number larger than the current vector size, then this method resizes the vector to accommodate the index that you pass.
path - The relative path to an image file, or "" to remove the current image.
See Also:
setBaseImageURI(java.lang.String), setDrillImagePath(int, java.lang.String), setGraphicImage(int, java.awt.Image)

getGraphicImagePath

public java.lang.String getGraphicImagePath(int index)
Retrieves a relative path to a graphic image for this GridView. Note that paths for drill icons are stored in a separate vector. The full path to the image is constructed by appending the relative path to the BaseImageURI.
Parameters:
index - The index, in the vector, of the path that you want. Valid values are zero to one less than the size of the vector.
Returns:
The relative 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:
getBaseImageURI(), getDrillImagePath(int), getGraphicImage(int), setGraphicImagePath(int, java.lang.String)

setBaseImageURI

public void setBaseImageURI(java.lang.String baseImageURI)
Specifies the base URI for loading images. Relative image paths are appended to this URI to construct the full path. The value of this property may be a URL, such as "http://my.server.com/", or it may be a package structure on the classpath, such as "/myApp/myComponent/images/". The default value is "".

This is a runtime property; it is not saved in XML.

Parameters:
baseImageURI - The base URI for loading images.
See Also:
setBackgroundImagePath(java.lang.String), setDrillImagePath(int, java.lang.String), setGraphicImagePath(int, java.lang.String)

getBaseImageURI

public java.lang.String getBaseImageURI()
Retrieves the base URI for loading images. Relative image paths are appended to this URI to construct the full path. The value of this property may be a URL, such as "http://my.server.com/", or it may be a package structure on the classpath, such as "/myApp/myComponent/images/". The default value is "". This is a run-time property; it is not saved in XML.
Returns:
the base URI for loading images
See Also:
getBackgroundImagePath(), getDrillImagePath(int), getGraphicImagePath(int)

getGraphicImageCount

public int getGraphicImageCount()
Retrieves the number of graphic images that are available for this GridView. This method returns the size of the vector of images for this GridView.
Returns:
The number of graphic images for this GridView.

setDrillImage

public void setDrillImage(int index,
                          java.awt.Image image)
Specifies a drill image for this GridView. This method stores an image in a vector of drill images for this GridView. 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.
Parameters:
index - The index in the vector of drill. Use the constants from the DataDirector interface, either DataDirector.DRILLSTATE_DRILLABLE or DataDirector.DRILLSTATE_IS_DRILLED.
image - The image to store.
See Also:
DataDirector.DRILLSTATE_DRILLABLE, DataDirector.DRILLSTATE_IS_DRILLED

getDrillImage

public java.awt.Image getDrillImage(int index)
Retrieves the drill image from the vector of drill images for this GridView.
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 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.DRILLSTATE_DRILLABLE, DataDirector.DRILLSTATE_IS_DRILLED

setDrillImagePath

public void setDrillImagePath(int index,
                              java.lang.String path)
Specifies the relative path to a drill image for this GridView. Image paths are stored in a vector of strings. Note that paths for graphic icons are stored in a separate vector. Index zero is reserved, so you must store drill images at indexes of 1 or greater.

The relative path passed into this method is appended to the BaseImageURI to construct the full path to the image. The full path may specify a URL or a resource on the classpath.

For example, the relative path to an image may be "images/myImage.gif". If no BaseImageURI is set, then this method attempts to load the image from the classpath, on the specified path relative to the GridView class, which would be "/oracle/dss/gridView/images/myImage.gif".

If BaseImageURI is "/myPackage/myComponent/", then this method attempts to load the image from the classpath on the specified absolute path, "/myPackage/myComponent/images/myImage.gif".

If BaseImageURI is "http://my.server.com/", then this method attempts to load the image at the given URL, "http://my.server.com/images/myImage.gif".

If an image cannot be loaded, a special "not loaded" image will be used instead.

This method also calls setDrillImage to set the actual Image object. If setDrillImage is called to set an Image object at an index for which an image path has already been set, then the path that you set with this method will be erased.

Parameters:
index - The index in the vector of drill. Use the constants from the DataDirector interface, either DataDirector.DRILLSTATE_DRILLABLE or DataDirector.DRILLSTATE_IS_DRILLED.
path - The relative path to an image file, or "" to reset the default drilled or drillable image.
See Also:
setBaseImageURI(java.lang.String), setDrillImage(int, java.awt.Image), setGraphicImagePath(int, java.lang.String), DataDirector.DRILLSTATE_DRILLABLE, DataDirector.DRILLSTATE_IS_DRILLED

getDrillImagePath

public java.lang.String getDrillImagePath(int index)
Retrieves a relative path to a drill image for this GridView. Note that paths for graphic icons are stored in a separate vector. The full path to the image is constructed by appending the relative path to the BaseImageURI.
Parameters:
index - The index in the vector of drill. Use the constants from the DataDirector interface, either DataDirector.DRILLSTATE_DRILLABLE or DataDirector.DRILLSTATE_IS_DRILLED.
Returns:
The relative path that is stored at the specified index. Returns null if index is less than 1 or is greater than or equal to the size of the vector.
See Also:
getBaseImageURI(), getDrillImage(int), getGraphicImagePath(int), setDrillImagePath(int, java.lang.String), DataDirector.DRILLSTATE_DRILLABLE, DataDirector.DRILLSTATE_IS_DRILLED

isCellEditingAllowed

public boolean isCellEditingAllowed()
Indicates whether users can edit cells in this GridView.
Returns:
true if cells can be edited, false if they cannot.

setCellEditingAllowed

public abstract void setCellEditingAllowed(boolean b)
Specifies whether users can edit cells in this GridView.
Parameters:
b - true to allow cell editing, false to prohibit it.

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.

resetToDefault

public void resetToDefault(int reset)
Resets properties of this GridView 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 GridView rather than instantiate a new one.

Overrides:
resetToDefault in class Dataview
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

setCornerComponentColor

public abstract void setCornerComponentColor(java.awt.Color c)
Specifies a background color for the corner component.
Parameters:
c - The background color to use for the corner component.

getCornerComponentColor

public abstract java.awt.Color getCornerComponentColor()
Retrieves the background color of the corner component.
Returns:
The background color of the corner component.

setDefaultCornerComponentColor

public abstract 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 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
Parameters:
c - The color to set as the new default background color for the corner component.
See Also:
applyCSSStyleDefaults(oracle.dss.gridView.GridViewCommon, oracle.dss.dataView.CSSStyleDefaults)

setManualRowSizingEnabled

public abstract void setManualRowSizingEnabled(boolean bEnabled)
Specifies whether users can manually resize rows in the databody.
Parameters:
bEnabled - true to allow users to use the mouse to resize rows, false to prevent them from doing so.

isManualRowSizingEnabled

public boolean isManualRowSizingEnabled()
Indicates whether users can manually resize rows in the databody.
Returns:
true if users can manually resize databody rows, false if they cannot.

setManualColumnSizingEnabled

public abstract void setManualColumnSizingEnabled(boolean bEnabled)
Specifies whether users can manually resize columns in the databody.
Parameters:
bEnabled - true to allow users to use the mouse to resize columns, false to prevent them from doing so.

isManualColumnSizingEnabled

public boolean isManualColumnSizingEnabled()
Indicates whether users can manually resize columns in the databody.
Returns:
true if users can use the mouse to resize columns, false if they cannot.

setSwapAllowed

public void setSwapAllowed(boolean swap)
Specifies whether users can swap items in this view. When SwapAllowed is true, then users can click the two items that they want to swap, in order to swap the items. The view will then ask the data source to perform a pivot of type DataDirector.PIVOT_SWAP.

When SwapAllowed is false, then users must move the two items separately, and the view will ask for two separate pivot actions of type DataDirector.PIVOT_MOVE_BEFORE or DataDirector.PIVOT_MOVE_AFTER. By default, swapping is disabled.

Overrides:
setSwapAllowed in class Dataview
Parameters:
swap - true to enable swapping, false to disable it.
See Also:
isSwapAllowed(), DataDirector.PIVOT_SWAP, DataDirector.PIVOT_MOVE_BEFORE, DataDirector.PIVOT_MOVE_AFTER

isSwapAllowed

public boolean isSwapAllowed()
Indicates whether swapping is allowed in this view. When this method returns true, then users can swap items by clicking the two items. When this method returns false, then users must move each item separately.
Overrides:
isSwapAllowed in class Dataview
Returns:
true if swapping is enabled, false if it is not.
See Also:
setSwapAllowed(boolean), DataDirector.PIVOT_SWAP, DataDirector.PIVOT_MOVE_BEFORE, DataDirector.PIVOT_MOVE_AFTER

applyCSSStyleDefaults

public static void applyCSSStyleDefaults(GridViewCommon view,
CSSStyleDefaults defaults)
Applies the styles in a cascading style sheet (CSS) as default values in a GridView. This method changes the default style property values of the components in a view. As default values, these values are not stored in generated XML that saves only values other than default values.

This method is primarily intended to be used by the thin beans, to provide better compatibility when working with the Java-client beans during design time in a development environment.

Parameters:
view - The GridViewCommon to apply defaults to.
defaults - The CSSStyleDefaults object that defines the new default values.

setBanding

public void setBanding(int banding)
Specifies whether and what kind of banding to use in this GridView. This property is currently only used for the thin beans.
Specified by:
setBanding in interface GridViewCommon
Parameters:
banding - A constant that identifies the kind of banding to apply to this GridView. Valid constants are listed in the See Also section.
See Also:
GridViewCommon.ROW_BANDING, GridViewCommon.COLUMN_BANDING, GridViewCommon.NO_BANDING

getBanding

public int getBanding()
Retrieves the kind of banding that this GridView uses. This property is currently only used for the thin beans.
Specified by:
getBanding in interface GridViewCommon
Returns:
A constant that indicates the banding for this GridView. Valid constants are listed in the See Also section.
See Also:
GridViewCommon.ROW_BANDING, GridViewCommon.COLUMN_BANDING, GridViewCommon.NO_BANDING

setHTMLColumnSizing

public void setHTMLColumnSizing(int htmlColumnSizing)
Specifies the HTML column sizing option. This property is used for the thin beans only.

By default, column sizes are determined only by the size of the contents of each column (NO_COLUMN_SIZING).

Note: If this setting causes text to be truncated, most browsers ignore this setting.

Specified by:
setHTMLColumnSizing in interface 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()
Retrieves the HTML column sizing option. This property is used for the thin beans only.

Note: If this setting causes text to be truncated, most browsers ignore this setting.

Specified by:
getHTMLColumnSizing in interface 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

setHTMLRowBlockSize

public void setHTMLRowBlockSize(int size)
Specifies the number of rows to display at a time in the HTML table that a thin GridView renders. This property is used for the thin beans only.
Specified by:
setHTMLRowBlockSize in interface GridViewCommon
Parameters:
size - The number of rows to display.

getHTMLRowBlockSize

public int getHTMLRowBlockSize()
Indicates the number of rows that appear at a time in the HTML table that a thin GridView renders. This property is used for the thin beans only.
Specified by:
getHTMLRowBlockSize in interface GridViewCommon
Returns:
The number of rows that appear in a thin GridView.

setHTMLColumnBlockSize

public void setHTMLColumnBlockSize(int size)
Specifies the number of columns to display at a time in the HTML table that a thin GridView renders. This property is used for the thin beans only.
Parameters:
size - The number of columns to display.

getHTMLColumnBlockSize

public int getHTMLColumnBlockSize()
Indicates the number of columns that appear at a time in the HTML table that a thin GridView renders. This property is used for the thin beans only.
Returns:
The number of columns that appear in a thin GridView.

getHTMLTableCellPadding

public java.lang.Integer getHTMLTableCellPadding()
Retrieves the cell padding of the HTML table that a thin GridView renders. This property is used for the thin beans only.
Specified by:
getHTMLTableCellPadding in interface GridViewCommon

setHTMLTableCellPadding

public void setHTMLTableCellPadding(java.lang.Integer padding)
Specifies the cell padding of the HTML table that a thin GridView renders. This property is used for the thin beans only.
Specified by:
setHTMLTableCellPadding in interface GridViewCommon
Parameters:
padding - The cell padding of the HTML table of the thin GridView.

getHTMLTableWidth

public java.lang.String getHTMLTableWidth()
Retrieves the width of the HTML table that a thin GridView renders. This property is used for the thin beans only.
Specified by:
getHTMLTableWidth in interface GridViewCommon

setHTMLTableWidth

public void setHTMLTableWidth(java.lang.String width)
Specifies the width of the HTML table that a thin GridView renders. This property is used for the thin beans only.
Specified by:
setHTMLTableWidth in interface GridViewCommon
Parameters:
The - width attribute of the HTML table that the thin GridView renders.

setHTMLTextInputSize

public void setHTMLTextInputSize(int size)
Specifies the number of characters to display in cells that can be edited. This property is used for the thin beans only.
Specified by:
setHTMLTextInputSize in interface GridViewCommon
Parameters:
size - The number of characters to display in editable cells.

getHTMLTextInputSize

public int getHTMLTextInputSize()
Retrieves the number of characters displayed in cells that can be edited. This property is used for the thin beans only.
Specified by:
getHTMLTextInputSize in interface GridViewCommon
Returns:
The number of characters that appear in an editable cell.

setStartRow

public abstract void setStartRow(int r)
Specifies the first visible row of data to display in this view. The view attempts to scroll so that the specified row is the first one visible. If the view cannot scroll far enough to make the specified row the first one visible, then the view will scroll as far as possible.
Overrides:
setStartRow in class Dataview
Parameters:
r - The first visible row of data to display.

getStartRow

public abstract int getStartRow()
Retrieves the first visible row of data that this view currently displays.
Overrides:
getStartRow in class Dataview
Returns:
The first visible row of data that this view displays.

setStartColumn

public abstract void setStartColumn(int c)
Specifies the first visible column of data to display in this view. The view attempts to scroll so that the specified column is the first one visible. If the view cannot scroll far enough to make the specified column the first one visible, then the view will scroll as far as possible.
Overrides:
setStartColumn in class Dataview
Parameters:
c - The first visible column of data to display.

getStartColumn

public abstract int getStartColumn()
Retrieves the first visible column of data that this view currently displays.
Overrides:
getStartColumn in class Dataview
Returns:
The first visible column of data that this view displays.

Oracle™ Business Intelligence Beans Java API Reference
Release 10
g (9.0.4)
Part number B12159_01


Copyright © 2003, Oracle. All Rights Reserved.