public class QVGrid implements BBjControl
QuickView Grid utility class
Constructor and Description |
---|
QVGrid(BBjWindow parentWin!, BBjChildWindow compWin!) Constructs QVGrid component on passed parent window in existing child window. |
QVGrid(BBjWindow parentWin!, BBjNumber comp_id, BBjNumber comp_x, BBjNumber comp_y, BBjNumber comp_w, BBjNumber comp_h) Constructs QVGrid component on passed parent window using given id and dimensions. |
QVGrid(BBjWindow parentWin!, BBjChildWindow compWin!, BBjNumber comp_id, BBjNumber comp_x, BBjNumber comp_y, BBjNumber comp_w, BBjNumber comp_h) Constructs QVGrid component on passed parent window in existing child window using given id and dimensions. |
Modifier and Type | Method and Description |
---|---|
void | accept(BBjNumber valid) Used to accept or reject the value that the user has just entered into the grid control Note: The QVGrid is not editable, so this method has no effect. |
void | addCellStyleName(BBjNumber row, BBjNumber column, BBjString styleName$) Adds a CSS style name to a grid cell |
void | addColumnStyleName(BBjNumber column, BBjString styleName$) Adds a CSS style name to a grid column |
BBjPopupMenu | addPopupMenu() Adds a popup menu to the grid control |
void | addRowStyleName(BBjNumber row, BBjString styleName$) Adds a CSS style name to a grid row |
BBjNumber | addStyle(String styleName!) Adds a CSS style name to the grid control |
void | adjustSpacesWhenDisplaying(BBjNumber column, BBjNumber stripLeading, BBjNumber stripTrailing, BBjNumber collapseMultipleSpaces, BBjNumber removeAllSpaces) Adjusts, for a given column, the spaces contained in data before displaying within a cell |
void | adjustSpacesWhenSaving(BBjNumber column, BBjNumber stripLeading, BBjNumber stripTrailing, BBjNumber collapseMultipleSpaces, BBjNumber removeAllSpaces) Adjusts, for a given column, the spaces the user entered before returning it to the program |
void | buildGrid() Constructs grid based on the current resultset metadata. Handles optional column-level attributes that have been set in the metadata, including: HIDE - if 1, then doesn't add this column to the grid NOTITLE - if 1, then suppresses the column title MASK - Sets the column mask with the string value ALIGN - Sets the column header cell alignement with the numeric value STYLE - Sets the column style with the numeric value BACKCOLOR - Sets the column background color to the color name FORECOLOR - Sets the column foreground color to the color name |
void | clearCallback(int eventType!) Unregisters the callback routine for a specified event |
void | clearCellStyleNames(BBjNumber row, BBjNumber column) Clears CSS styles from a grid cell |
void | clearColumnStyleNames(BBjNumber column) Clears CSS styles from a grid column |
void | clearGrid() Removes all data from the cells |
void | clearMainGrid() Removes all data from the main grid cells, leaving headers intact |
void | clearProcCallback(BBjNumber eventType) Unregisters the custom event callback routine for a specified 'processing' event |
void | clearRowStyleNames(BBjNumber row) Clears CSS styles from a grid row |
void | clearStyles() Clears CSS styles from the grid control |
void | columnHeaderSelectColumn(BBjGridMouseUpEvent ev!) Grid column header mouse up handler |
BBjDataAwareGrid | convertToDataAware(BBjNumber channel, BBjString template$) Converts grid to a BBjDataAwareGrid |
void | deleteColumn(BBjNumber column) Deletes a column |
void | deleteRow(BBjNumber row) Deletes a row Note: The QVGrid completely handles the grid content displayed, so this method has no effect. |
void | deselectAllCells() Deselects all of the cells in the grid |
void | destroy() Destroys the QVGrid component child window |
void | doLowerCaseWhenDisplaying(BBjNumber column) Adjusts, for a given column, the data to lowercase before displaying to the user |
void | doLowerCaseWhenSaving(BBjNumber column) Adjusts, for a given column, the data to lowercase before returning it to the program |
void | doUpperCaseWhenDisplaying(BBjNumber column) Adjusts, for a given column, the data to uppercase before displaying to the user |
void | doUpperCaseWhenSaving(BBjNumber column) Adjusts, for a given column, the data to uppercase before returning it to the program |
void | endEdit(BBjNumber suppress) Ends any editing of the grid Note: The QVGrid is not editable, so this method has no effect. |
void | endEdit() Ends any editing of the grid Note: The QVGrid is not editable, so this method has no effect. |
void | fillGridWithColumns(BBjNumber fit) Specifies whether to fit all columns into the displayed width of the grid |
void | focus() Sets the focus on the grid control |
BBjString | getAttribute(String attribute!) Returns a control attribute previously set with setAttribute() for the grid control |
BBjColor | getBackColor() Returns the background color of the grid control |
BBjNumber | getBeepOnValidationFailure() Returns whether the grid will beep when the program calls 'accept(0)' in response to a validation event |
BBjNumber | getBottomRow() Returns the current visible bottom row |
BBjNumber | getCausesControlValidation() Returns whether entering the grid control will trigger control validation on the control that previously had focus |
BBjNumber | getCellAlignment(BBjNumber row, BBjNumber column) Returns the alignment of a cell |
BBjColor | getCellBackColor(BBjNumber row, BBjNumber column) Returns the background color of a cell |
BBjFont | getCellFont(BBjNumber row, BBjNumber column) Returns the font of a cell |
BBjColor | getCellForeColor(BBjNumber row, BBjNumber column) Returns the foreground color of a cell |
BBjNumber | getCellHasQuery(BBjNumber row, BBjNumber column) Returns whether a BBjStandardGrid cell has an associated query button |
BBjComboBox | getCellListControl(BBjNumber row, BBjNumber column) Returns the list control for a cell |
BBjNumber | getCellListSelection(BBjNumber row, BBjNumber column) Returns the list selection for a list control in a cell |
BBjString | getCellMask(BBjNumber row, BBjNumber column) Returns the mask for a cell |
BBjString | getCellRelated(BBjNumber row, BBjNumber column) Returns the "related" text associated with a cell |
BBjString | getCellRestore(BBjNumber row, BBjNumber column) Returns the restore value for a cell |
BBjNumber | getCellState(BBjNumber row, BBjNumber column) Returns the checked state of a check box or button style cell |
BBjNumber | getCellStyle(BBjNumber row, BBjNumber column) Returns the style of a cell |
BBjVector | getCellStyleNames(BBjNumber row, BBjNumber column) Returns a list of all CSS style names that have been added to a grid cell |
BBjString | getCellText(BBjNumber row, BBjNumber column) Returns the value of the text stored in the specified cell |
BBjNumber | getCellVerticalAlignment(BBjNumber row, BBjNumber column) Returns the vertical alignment of a cell |
BBjNumber | getClientEdge() Returns whether the client (lowered) border is set for the grid control |
Object | getClientProperty(Object p_key!) see BBjControl |
BBjNumber | getColumnAlignment(BBjNumber column) Returns the default horizontal alignment for a column |
BBjColor | getColumnBackColor(BBjNumber column) Returns the default background color of a column |
BBjFont | getColumnFont(BBjNumber column) Returns the default font of a column |
BBjColor | getColumnForeColor(BBjNumber column) Returns the default foreground color of a column |
BBjNumber | getColumnGutter() Returns the number of pixels separating the column header and the main grid area |
BBjNumber | getColumnHasQuery(BBjNumber column) Returns whether all cells in the specified column have associated query buttons |
BBjGridHeader | getColumnHeader() Returns the column header object for the grid |
BBjNumber | getColumnHeaderAlignment() Returns the default column header horizontal alignment |
BBjColor | getColumnHeaderBackColor() Returns the default background color of the column header |
BBjNumber | getColumnHeaderCellAlignment(BBjNumber column) Returns the horizontal alignment for a column header cell |
BBjColor | getColumnHeaderCellBackColor(BBjNumber column) Returns the background color of a column header cell |
BBjColor | getColumnHeaderCellForeColor(BBjNumber column) Returns the foreground color of a column header cell |
BBjNumber | getColumnHeaderCellStyle(BBjNumber column) Returns the style of a column header cell |
BBjString | getColumnHeaderCellText(BBjNumber column) Returns the text displayed in a column header cell |
BBjNumber | getColumnHeaderCellVerticalAlignment(BBjNumber column) Returns the vertical alignment for a column header cell |
BBjFont | getColumnHeaderFont() Returns the default font of the column header |
BBjColor | getColumnHeaderForeColor() Returns the default foreground color of the column header |
BBjNumber | getColumnHeaderHeight() Returns the height of the column header |
BBjNumber | getColumnHeaderStyle() Returns the style used by default for the column headers |
BBjNumber | getColumnHeaderVerticalAlignment() Returns the default column header vertical alignment |
BBjComboBox | getColumnListControl(BBjNumber column) Returns the list control for a column |
BBjNumber | getColumnListSelection(BBjNumber column) Returns the default selected index for the list control in the column |
BBjString | getColumnMask(BBjNumber column) Returns the default mask for a column |
BBjNumber | getColumnStyle(BBjNumber column) Returns the default style of a column in the grid |
BBjVector | getColumnStyleNames(BBjNumber column) Returns a list of all CSS styles names that have been added to a grid column |
BBjNumber | getColumnVerticalAlignment(BBjNumber column) Returns the default vertical alignment for all of the cells in a particular column |
BBjNumber | getColumnWidth(BBjNumber column) Retrieves the width of a specified column |
BBjVector | getColumnWidths() Returns a vector containing the column widths within a grid |
String | getComputedStyle(String arg0!) see BBjControl |
BBjNumber | getContextID() Returns the context ID of the QVGrid component child window |
BBjNumber | getControlType() Returns the control type of the grid control Note: For a listing of control type constants, see Constants in BBjControl. |
BBjNumber | getDefaultColumnWidth() Returns the default column width |
BBjNumber | getDefaultGridStyle() Returns the default style of cells in the grid |
BBjNumber | getDragAccept() Returns whether the grid accepts drag and drop operations |
BBjNumber | getDragActions() Returns the actions that are currently available when dragging from the grid control |
BBjNumber | getDragEnabled() Returns whether the grid control should allow drag operations |
BBjString | getDragType(BBjNumber row, BBjNumber column) Returns the drag type that was set for a particular cell in a previous call to setDragType() |
BBjString | getDragType(BBjNumber column) Returns the drag type that was set for a particular column in a previous call to setDragType() |
BBjString | getDragType() Returns an optional type string, previously set with setDragType(), that the grid control advertises to potential drop targets when it acts as a drag source |
BBjNumber | getDropActions() Returns the actions that are currently available when dropping to the grid control. Returns ACTION_NONE if the control is disabled or non-editable. |
BBjVector | getDropTypes(BBjNumber row, BBjNumber column) Returns the drop types that were set for a particular cell in a previous call to setDropTypes() |
BBjVector | getDropTypes(BBjNumber column) Returns the drop types that were set for a particular column in a previous call to setDropTypes() |
BBjVector | getDropTypes() Returns the drop types that were set in a previous call to setDropTypes() |
BBjNumber | getEditClickCount() Returns the number of mouse clicks needed to begin editing a cell Note: the QVGrid is not editable, so this method has no effect. |
BBjString | getEditText() Returns the current edit text associated with the grid Note: The QVGrid is not editable, so this method has no meaning |
BBjFont | getFont() Returns the font of the grid control |
BBjColor | getForeColor() Returns the foreground (text) color of the grid control |
BBjStandardGrid | getGrid() Returns the underlying BBjStandardGrid object |
BBjNumber | getHasColumnHeader() Returns whether the grid has a column header |
BBjNumber | getHasRowHeader() Returns whether the grid has a row header |
BBjNumber | getHeaderSelection() Returns whether header selection is active |
BBjNumber | getHeight() Returns the height of the QVGrid component child window |
BBjNumber | getHighlightMethod() Returns which selection highlight method is currently being used |
BBjNumber | getHorizontalCellSpacing() Returns the amount of horizontal space between the columns |
BBjNumber | getHorizontalLinesVisible() Returns whether horizontal lines between the rows are visible |
BBjNumber | getHorizontalScrollable() Returns whether the horizontal scrollbar will appear if there are more columns than can be displayed in the visible area of the grid |
BBjNumber | getHorizontalScrollBarAlways() Returns whether to always show a horizontal scrollbar enabled using setHorizontalScrollable(), or to only show as needed |
BBjNumber | getID() Returns the control ID of the QVGrid component child window |
BBjNumber | getInputNBeep() Returns an indication of whether InputN style cells will beep when user enters an invalid character |
BBjString | getInputNCommaCharacter() Returns the character that InputN style cells will display as their 'thousands' separator |
BBjString | getInputNDotCharacter() Returns the character that InputN style cells will display as their decimal separator |
BBjNumber | getInputNUseEditCommas() Returns an indication of whether InputN style cells will display a character at each 'thousands' position |
BBjNumber | getInsertMode() Returns whether the editor is in insert mode |
BBjNumber | getInterspace() Method getInterspace: Note: This method has been deprecated since BBj 5.0. Use getHorizontalCellSpacing(). |
BBjNumber | getLeftColumn() Returns the current visible left-most column |
BBjColor | getLineColor() Returns the color of the separator lines |
BBjString | getLongCue() Returns the text that appears in the status bar when the mouse pointer hovers over the grid control |
BBjNumber | getMainGridAlignment() Returns the default horizontal alignment of the cells in the main part of the grid, i.e. not including any row or column headers. |
BBjColor | getMainGridBackColor() Returns the default background color of the grid |
BBjFont | getMainGridFont() Returns the default font of the grid |
BBjColor | getMainGridForeColor() Returns the default foreground color of the grid |
BBjColor | getMainGridStripeColor() Returns the background stripe color of the grid |
BBjNumber | getMainGridVerticalAlignment() Returns the default vertical alignment of the cells in the main part of the grid, i.e. not including any row or column headerthe default vertical alignment of the cells in the main part of the grid, i.e. not including any row or column headers.s. |
BBjNumber | getMaxColumns() Returns the maximum number of columns allowed in the grid Note: In BBj 12.0 and higher, this method is deprecated and always returns 2147483647. |
BBjNumber | getMaxRows() Returns the maximum number of rows allowed in the data set |
BBjString | getName() Returns the control name of the grid control |
BBjNumber | getNoEdge() Returns whether the grid control has no border |
BBjNumber | getNumColumns() Returns the number of columns in the grid |
BBjNumber | getNumRows() Returns the number of rows in the grid |
BBjNumber | getPagingAmount() Returns the number of lines to scroll when scrolling by page Note: The QVGrid has its own paging logic, so this method has no meaning |
BBjWindow | getParentWindow() see BBjControl |
BBjPopupMenu | getPopupMenu() Retrieves a popup menu from the grid control |
BBjNumber | getRaisedEdge() Returns whether the grid control has a raised border |
BBjString | getRecord() Retrieves the current record data |
BBjString | getRecordTemplate() Retrieves the current record template definition |
BBjNumber | getRowAlignment(BBjNumber row) Returns the horizontal alignment of a row |
BBjFont | getRowFont(BBjNumber row) Returns the default font of a row |
BBjNumber | getRowGutter() Returns the number of pixels separating the row header and the main grid area |
BBjGridHeader | getRowHeader() Returns the BBjGridHeader object for this grid |
BBjNumber | getRowHeaderAlignment() Returns the default alignment of the row header |
BBjColor | getRowHeaderBackColor() Returns the default background color of the row header |
BBjNumber | getRowHeaderCellAlignment(BBjNumber row) Returns the alignment of a row header cell |
BBjColor | getRowHeaderCellBackColor(BBjNumber row) Returns the background color for a row header cell |
BBjColor | getRowHeaderCellForeColor(BBjNumber row) Returns the foreground color of a row header cell |
BBjNumber | getRowHeaderCellStyle(BBjNumber row) Returns the style of a row header cell |
BBjString | getRowHeaderCellText(BBjNumber row) Returns the text displayed in a row header cell |
BBjNumber | getRowHeaderCellVerticalAlignment(BBjNumber row) Returns the vertical alignment of the row header cell |
BBjFont | getRowHeaderFont() Returns the default font of the row header |
BBjColor | getRowHeaderForeColor() Returns the default foreground color of the row header |
BBjNumber | getRowHeaderStyle() Returns the default style of the row header |
BBjNumber | getRowHeaderVerticalAlignment() Returns the vertical alignment of the row header |
BBjNumber | getRowHeaderWidth() Returns the width of the row header |
BBjNumber | getRowHeight(BBjNumber row) Returns the height of a row in pixels |
BBjNumber | getRowHeight() Returns the default height in pixels of the rows |
BBjString | getRowKey(BBjNumber row) Retrieves the row key for the specified resultset row |
BBjNumber | getRowModelIndexFromViewIndex(BBjNumber index) Maps the view index of a row to the model index |
BBjVector | getRowStyleNames(BBjNumber row) Returns a vector of style names that have been added to a row |
BBjNumber | getRowVerticalAlignment(BBjNumber row) Returns the default vertical alignment for a row |
BBjNumber | getRowViewIndexFromModelIndex(BBjNumber index) Maps the model index of a row to the view index |
BBjNumber | getScreenX() Returns the X coordinate of the the QVGrid component child window on the screen |
BBjNumber | getScreenY() Returns the Y coordinate of the the QVGrid component child window on the screen |
BBjNumber | getScrollOutside() Returns whether the grid will scroll when the mouse cursor is moved outside the bounds of the grid during a drag and drop operation |
BBjNumber | getScrollUpdate() Returns whether the grid updates the display of data in the cells while being scrolled |
BBjNumber | getScrollWheelBehavior() Returns a constant indicating under what situations the grid control will respond to the mouse scroll wheel |
BBjNumber | getSelectedColumn() Returns the currently selected column |
BBjVector | getSelectedColumns() Returns a BBjVector containing selected columns |
BBjNumber | getSelectedRow() Returns the currently selected row |
BBjVector | getSelectedRows() Returns a vector containing the selected rows in a grid |
BBjNumber | getSelectionMode() Returns the current selection mode |
BBjString | getShortCue() Returns the text that appears above the grid control when the mouse pointer hovers over the control Note: Same as getToolTipText(). |
BBjNumber | getShouldHighlightSelectedColumn() Returns whether the grid should highlight the entire column of the currently selected cell |
BBjNumber | getShouldHighlightSelectedRow() Returns whether the grid should highlight the entire row of the currently selected cell |
BBjNumber | getShowMaskWhenRendering() Returns whether input style cells display the decoration characters of their mask in non-edit mode Note: This method has been deprecated. |
BBjNumber | getSnapToRowHeight() Returns whether the gird will adjust its height so that only full rows appear in the grid Note: The QVGird always shows only complete rows, so this method always returns the default of TRUE. |
BBjNumber | getSortByMultipleColumns() Returns an indication of whether this grid sorts by multiple columns |
BBjNumber | getStartEditSelectionMode() Returns the selection mode that will be used when starting to edit a cell Note: The QVGrid is not editable, so this method has no further meaning |
BBjNumber | getStringWidth(BBjString text$) Returns the width of a string in pixels |
BBjNumber | getStripeCount() Returns the number of grid rows to alternate between the stripe color and the default background color |
String | getStyle(String arg!) see BBjControl |
BBjVector | getStyles() Gets a vector of all CSS style names that have been added to the grid control |
BBjNumber | getTabAction() Returns the current tab action of the grid |
BBjNumber | getTabActionSkipsNonEditableCells() When the user presses the [Tab] key while focus is on a grid cell, the focus will move based on the current "tab action" of the grid. If the program has called setTabActionSkipsNonEditableCells(TRUE) then the focus will skip any cells that are not editable. Note: The QVGrid is not editable, so this method is not influenced by a previous setTabActionSkipsNonEditableCells(). |
BBjString | getText() Returns the control text assigned to the grid control Note: The relevance of this method for a grid is questionable, but provided for compatability. |
BBjString | getToolTipText(BBjNumber row!, BBjNumber column!) Returns the tooltip text (also known as short cue) for a cell |
BBjString | getToolTipText(BBjNumber column!) Returns the tooltip text (also known as short cue) for a column |
BBjString | getToolTipText() Returns the tooltip text (also known as short cue) for the grid control |
BBjNumber | getTopRow() Returns the current top visible row |
BBjNumber | getTrimBlankSpace() Returns whether the grid will trim its size if it is larger than the size needed to display the data, all headers and all scrollbars |
BBjNumber | getUpdateCached() Returns whether the grid sends table update events |
Object | getUserData() Retrieves user data associated with the grid control after having called setUserData() |
BBjString | getValidationText() Returns the value that the user just entered into the grid control Note: The QVGrid is not editable and a grid control always returns an empty string, so this method has no meaning |
BBjNumber | getVerticalCellSpacing() Returns the amount of vertical space between the rows |
BBjNumber | getVerticalLinesVisible() Returns whether the vertical lines between columns are visible |
BBjNumber | getVerticalScrollable() Returns whether the vertical scrollbar can be enabled if there are more rows than can be displayed in the visible rows of the grid |
BBjNumber | getVerticalScrollBarAlways() Returns whether to always show a vertical scrollbar enabled using setVerticalScrollable(), or to only show the vertical scrollbar as needed Note: The QVGrid maintains a separate vertical scrollbar control that is always visible, so 1 (true) is always returned. |
BBjNumber | getVisibleRowCount() Returns the number of rows that are currently visible in the grid |
BBjNumber | getWidth() Returns the width of the QVGrid component child window |
BBjNumber | getX() Returns the X coordinate of the QVGrid component child window |
BBjNumber | getY() Returns the Y coordinate of the QVGrid component child window |
void | grdScrolled(BBjScrollWheelEvent ev!) Mouse scroll wheel event handler |
void | hitBottom(BBjGridHitBottomEvent ev!) Hit bottom event handler |
void | hitTop(BBjGridHitTopEvent ev!) Hit top event handler |
void | insertColumn(BBjNumber index) Inserts a column |
void | insertRow(BBjNumber index) Inserts a row |
BBjNumber | isCellEditable(BBjNumber row, BBjNumber column) Returns whether a cell is editable |
BBjNumber | isColumnEditable(BBjNumber column) Returns whether a column is editable Note: The QVGird is not editable, so this method always returns FALSE |
BBjNumber | isColumnSortedByRelatedData(BBjNumber column) Returns an indication of whether a given column is sorted by related data rather than by cell text |
BBjNumber | isColumnUserSortable(BBjNumber column) Returns whether the grid sorts a specified column when the user clicks in the header of that column |
BBjNumber | isColumnVisible(BBjNumber column) Returns whether a column is visible |
BBjNumber | isDataAware() Returns whether the grid is data aware Note: The QVGird is a BBjStandardGrid, so this method returns FALSE. |
BBjNumber | isDataBound() Returns whether the grid is data bound Note: The QVGird cannot be configured as a data bound control, so this method returns FALSE. |
BBjNumber | isDestroyed() Returns whether the QVGrid component child window has been destroyed |
BBjNumber | isEditable() Returns whether the grid is editable Note: The QVGrid is not editable, so this always returns FALSE. |
BBjNumber | isEditing() Returns whether the grid is currently in edit mode Note: The QVGird is not editable, so this method always returns FALSE |
BBjNumber | isEnabled() Returns whether the grid control is enabled |
BBjNumber | isEnterAsTab() Returns whether pressing [Enter] while focus is on the grid will be interpreted as though the user had pressed [Tab] |
BBjNumber | isFitToGrid() Returns all columns are fitted into the displayed width of the grid |
BBjNumber | isFocusable() Returns a value indicating whether or not the user can focus the grid control |
BBjNumber | isGridEditable() This method is deprecated. Use isEditable() instead. Note: The QVGrid is not editable, so FALSE is always returned. |
boolean | isGrouped() see BBjControl |
BBjNumber | isMultipleSelectionAllowed() Returns whether multiple selection is allowed |
BBjNumber | isOpaque() Returns the opaque property of the grid control |
BBjNumber | isPaging() Returns whether the grid can be scrolled by paging Note: The QVGrid has its own paging logic, so this method has no meaning |
BBjNumber | isRowEditable(BBjNumber row) Returns whether a row is editable Note: The QVGrid is not editable, so FALSE is always returned. |
BBjNumber | isRowVisible(BBjNumber row) Returns whether a row is currently visible in the grid |
BBjNumber | isTabTraversable() Returns a value indicating whether or not the user can navigate to the grid control using the tab key |
BBjNumber | isUserResizable() Returns whether the columns in the grid can be resized by the user |
BBjNumber | isVisible() Returns whether the QVGrid component child window is visible |
void | loadGrid() Loads grid initally |
void | moveToNextCell() Moves the selection to the next cell |
void | putClientProperty(Object p_key!, Object p_value!) see BBjControl |
void | removeAttribute(String attribute!) Removes a control attribute from the grid control |
void | removeCellStyleName(BBjNumber row, BBjNumber column, BBjString styleName$) Removes a CSS style name from a grid cell |
void | removeColumnStyleName(BBjNumber column, BBjString styleName$) Removes a CSS style name from a grid column |
void | removePopupMenu() Removes a popup menu from the grid control |
void | removeRowStyleName(BBjNumber row, BBjString styleName$) Removes a CSS style name from a grid row |
BBjNumber | removeStyle(String styleName!) Removes a CSS style name from the grid control |
void | resort() Re-sorts the grid If a user edits a grid cell after a grid is sorted, the row display order does not automatically change to reposition the edited cell. Calling resort() caused the grid to re-apply all sorting so that the newly edited data appears in the correct sort order. Note: This method has little effect with the QVGrid because the grid only contains at most the number of visible rows. |
void | restoreCell(BBjNumber row, BBjNumber column) Restores a cell to its previous value |
void | restoreRow(BBjNumber row) Restores all cell values in a row |
void | rowSelected(BBjGridSelectRowEvent ev!) Event handler for a row selection |
void | scrollTo(BBjNumber pos) Scroll grid to a given position |
void | scrollToBottom() Scrolls down in order to set the bottom row visible |
void | setAllColumnsUserSortable(BBjNumber sortable) Sets user-sortable indicator for all columns |
void | setAttribute(String attribute!, String value!) Sets a control attribute for the grid control |
void | setBackColor(BBjColor color!) Sets the background color for the grid control |
void | setBeepOnValidationFailure(BBjNumber shouldBeep) Sets whether the grid should beep when the program calls 'accept(0)' in response to a validation event |
void | setCallback(int eventType!, String subRoutineName!) Registers a legacy callback routine for a specified event in the grid |
void | setCallback(int eventType!, CustomObject customObj!, String methodName!) Registers an object oriented callback routine for a specified event in the grid |
void | setCausesControlValidation(boolean causesValidation!) Sets whether entering this grid control will trigger control validation on the control that previously had focus Note: This feature is typically used with controls like the Cancel button that should let the user exit without forcing valid data to be entered first. |
void | setCellAlignment(BBjNumber row, BBjNumber column, BBjNumber align) Sets the alignment of a cell |
void | setCellBackColor(BBjNumber row, BBjNumber column, BBjColor color!) Sets the background color of a cell |
void | setCellData(BBjNumber row, BBjNumber column, BBjString text$, BBjString related$) Sets both the displayed and related text of a cell |
void | setCellEditable(BBjNumber row, BBjNumber column, BBjNumber editable) Sets whether a cell is editable Note: The QVGrid is non-editable, so this method does not change any state. |
void | setCellFont(BBjNumber row, BBjNumber column, BBjFont font!) Sets the font of a cell |
void | setCellForeColor(BBjNumber row, BBjNumber column, BBjColor color!) Sets the foreground color of a cell |
void | setCellHasQuery(BBjNumber row, BBjNumber column, BBjNumber hasQuery) Specifies whether a cell should have an associated query button |
void | setCellIcon(BBjNumber imageListID, BBjNumber index, BBjNumber row, BBjNumber column) Sets the icon for a cell |
void | setCellImage(BBjNumber row, BBjNumber column, BBjImage image!) Sets the image displayed in a cell |
void | setCellListControl(BBjNumber row, BBjNumber column, BBjComboBox list!) Sets a list control for a cell so that the cell will display as a list control when edited |
void | setCellListSelection(BBjNumber row, BBjNumber column, BBjNumber sel, BBjNumber repaint) Sets the list selection for a list control in a cell |
void | setCellMask(BBjNumber row, BBjNumber column, BBjString mask$) Sets the cell mask for both displaying and editing Note: Only applicable to InputD, InputE, and InputN style cells. |
void | setCellRelated(BBjNumber row, BBjNumber column, BBjString text$) Sets the "related" text that is associated with a cell |
void | setCellRelated(BBjNumber row, BBjNumber column, BBjVector strings!) Sets the "related" text that for a range of cells |
void | setCellRestore(BBjNumber row, BBjNumber column, BBjString restore$) Sets the restore value for a cell |
void | setCellState(BBjNumber row, BBjNumber column, BBjNumber state) Sets the checked state of a check box or button style cell |
void | setCellStyle(BBjNumber row, BBjNumber column, BBjNumber style) Sets the style of a cell |
void | setCellText(BBjVector strings!) Sets the text displayed in cells Sets the text for as many cells as there are strings in the BBjVector going from left to right. If there are more strings than cells, then the remaining strings are ignored. This method will begin at the currently selected cell. If there is no currently selected cell then it will start at cell (0, 0). |
void | setCellText(BBjNumber row, BBjNumber column, BBjVector strings!) Sets the text displayed in cells Sets the text for as many cells as there are strings in the BBjVector going from left to right, beginning at the specified start row and column. If there are more strings than cells, then the remaining strings are ignored. This method will begin at the currently selected cell. If there is no currently selected cell then it will start at cell (0, 0). |
void | setCellText(BBjNumber row, BBjNumber column, BBjString text$) Sets the text displayed in a cell |
void | setCellVerticalAlignment(BBjNumber row, BBjNumber column, BBjNumber align) Sets vertical alignment in a cell |
void | setClientEdge(boolean client!) Sets the grid control to have a client (lowered) border |
void | setColumnAlignment(BBjNumber column, BBjNumber align) Sets the default horizontal alignment for a column |
void | setColumnBackColor(BBjNumber column, BBjColor color!) Sets the default background color of a column |
void | setColumnEditable(BBjNumber column, BBjNumber editable) Sets whether a column is editable Note: The QVGird is not editable, so this method has no effect. |
void | setColumnFont(BBjNumber column, BBjFont font!) Sets the default font of a column |
void | setColumnForeColor(BBjNumber column, BBjColor color!) Sets the default foreground color for a colum |
void | setColumnGutter(BBjNumber pixels) Sets the number of pixels separating the column header and the main grid area |
void | setColumnHasQuery(BBjNumber column, BBjNumber hasQuery) Specifies whether all cells in the specified column should have associated query buttons |
void | setColumnHeaderAlignment(BBjNumber align) Sets the default column header horizontal alignment |
void | setColumnHeaderBackColor(BBjColor color!) Sets the default background color of the column header |
void | setColumnHeaderCellAlignment(BBjNumber column, BBjNumber align) Sets the horizontal alignment for the column header cell |
void | setColumnHeaderCellBackColor(BBjNumber column, BBjColor color!) Sets the background color of a column header cell |
void | setColumnHeaderCellForeColor(BBjNumber column, BBjColor color!) Sets the foreground color of a column header cell |
void | setColumnHeaderCellIcon(BBjNumber imageListID, BBjNumber index, BBjNumber column) Sets the icon in a column header cell |
void | setColumnHeaderCellImage(BBjNumber column, BBjImage image!) Sets the image displayed in a column header cell |
void | setColumnHeaderCellStyle(BBjNumber column, BBjNumber style) Sets the cell style used for a column header cell |
void | setColumnHeaderCellText(BBjNumber column, BBjString text$) Sets the text to be displayed in a column header cell |
void | setColumnHeaderCellVerticalAlignment(BBjNumber column, BBjNumber align) Sets the vertical alignment for a column header cell |
void | setColumnHeaderFont(BBjFont font!) Sets the default font of the column header |
void | setColumnHeaderForeColor(BBjColor color!) Sets the default foreground color of the column header |
void | setColumnHeaderHeight(BBjNumber height) Sets the height of the column header |
void | setColumnHeaderStyle(BBjNumber style) Sets the style used by default for the column headers |
void | setColumnHeaderText(BBjVector strings!) Sets multiple column header cell text The first element will go in column 0, the second in column 1, etc., up to the lesser of the number of header columns or the number of strings in the vector. |
void | setColumnHeaderVerticalAlignment(BBjNumber align) Sets the default vertical alignment for the column header |
void | setColumnListControl(BBjNumber column, BBjComboBox list!) Sets a list control for a column so that each cell in the column will display as a list button when editing |
void | setColumnListSelection(BBjNumber column, BBjNumber index, BBjNumber repaint) Sets the selected index for the list control in the specified column |
void | setColumnMask(BBjNumber column, BBjString mask$) Sets the default mask for all cells in a column |
void | setColumnSortedByRelatedData(BBjNumber column, BBjNumber sortByRelated) Specifies whether a particular column is to be sorted by related data rather than by the text in the cells |
void | setColumnStyle(BBjNumber column, BBjNumber style) Sets the default style of a column in the grid |
void | setColumnUserSortable(BBjNumber column, BBjNumber sortable) Causes the grid to sort a specified column when the user clicks in the header of that column |
void | setColumnVerticalAlignment(BBjNumber column, BBjNumber align) Sets the default vertical alignment for all of the cells in a particular column |
void | setColumnVisible(BBjNumber column) Sets a column in the grid to be visible |
void | setColumnWidth(BBjNumber column, BBjNumber width) Sets the width of a column |
void | setCursor(int cursor!) Sets the cursor style on the grid control |
void | setDebug(BBjNumber debug) Sets the general debug flag and brings up the BBjSysConsole, if not running in BUI |
void | setDefaultAlignment(BBjNumber align) Sets the default horizontal alignment for all of the cells in the grid |
void | setDefaultColumnText(BBjNumber col, BBjString text$) Sets the default text that is displayed in a column |
void | setDefaultColumnWidth(BBjNumber width) Sets the default width of all columns |
void | setDefaultGridStyle(BBjNumber style) Sets the default style of all the cells in the grid |
void | setDefaultVerticalAlignment(BBjNumber align) Sets the default vertical alignment for all of the cells in the grid |
void | setDragAccept(BBjNumber drag) Sets whether the grid will accept drag and drop operations |
void | setDragActions(BBjNumber actions) Sets the available drag actions for the grid control |
void | setDragEnabled(BBjNumber mode) Sets whether the grid control should allow drag operations |
void | setDragType(BBjNumber row, BBjNumber column, BBjString type$) Sets an optional type string that an individual grid cell advertises to potential drop targets when the grid acts as a drag source |
void | setDragType(BBjNumber column, BBjString type$) Sets an optional type string that an individual grid column advertises to potential drop targets when the grid acts as a drag source |
void | setDragType(BBjString type$) Sets an optional type string that the grid control advertises to potential drop targets when it acts as a drag source |
void | setDropActions(BBjNumber actions) Sets the actions that will be allowed when the grid control acts as a drop target |
void | setDropTypes(BBjNumber column, BBjVector types!) Stipulates the types that an individual grid column is willing to accept from a drag source when the grid acts as a drop target. If no drop types are set, the grid will accept data of any type. |
void | setDropTypes(BBjNumber row, BBjNumber column, BBjVector types!) Stipulates the types that an individual grid cell is willing to accept from a drag source when the grid acts as a drop target. If no drop types are set, the grid will accept data of any type. |
void | setDropTypes(BBjVector types!) Sets the types that the grid control is willing to accept from a drag source when it acts as a drop target. If no drop types are set, it will accept data of any type. |
void | setEditable(BBjNumber editable) Sets whether the cells in the grid are editable Note: The QVGrid is not editable, so this method has no effect. |
void | setEditClickCount(BBjNumber count) Sets the number of mouse clicks needed to begin editing a cell Note: the QVGrid is not editable, so this method has no effect. |
void | setEnabled(boolean enabled!) Sets whether the grid control is to be enabled or disabled |
void | setEnterAsTab(BBjNumber enterAsTab) Sets whether pressing [Enter] while focus is on the grid will be interpreted as though the user had pressed [Tab] |
void | setFitToGrid(BBjNumber fit) Specifies whether to fit all columns into the displayed width of the grid |
void | setFocusable(BBjNumber canFocus) Sets whether the grid control can be focused |
void | setFont(BBjFont font!) Sets the font for the grid control |
void | setForeColor(BBjColor color!) Sets the foreground (text) color for the grid control |
void | setGridEditable(BBjNumber editable) This method is deprecated. Use setEditable() instead. Note: The QVGrid is not editable, so this has no effect. |
void | setGrouped(boolean arg0!) see BBjControl |
void | setHasColumnHeader(BBjNumber hasHeader) Sets whether the grid has a column header |
void | setHasRowHeader(BBjNumber hasHeader) Sets whether the grid has a row header |
void | setHeaderSelection(BBjNumber select) Sets whether a header cell will display as recessed if the row/column is selected |
void | setHighlightMethod(BBjNumber highlight) Sets the selection highlight method |
void | setHorizontalCellSpacing(BBjNumber space) Sets the amount of horizontal space between the columns |
void | setHorizontalLinesVisible(BBjNumber visible) Sets whether the horizontal lines between the rows are to be visible |
void | setHorizontalScrollable(BBjNumber scrollable) Sets whether the horizontal scrollbar will appear if there are more columns than can be displayed in the visible area of the grid |
void | setHorizontalScrollBarAlways(BBjNumber always) Sets whether to always show a horizontal scrollbar enabled using setHorizontalScrollable(), or to only show as needed |
void | setInputNBeep(BBjNumber shouldBeep) Determines whether InputN style cells will beep when the user enters an invalid character public void QVGrid.setInputNBeep(BBjNumber) throws BBjException |
void | setInputNCommaCharacter(BBjString charString$) Sets the 'thousands' replacement character for all InputN style grid cells |
void | setInputNDotCharacter(BBjString charString$) Sets the decimal character for all InputN style grid cells |
void | setInputNUseEditCommas(BBjNumber shouldUse) Determines whether InputN style cells in the grid will display a character at each 'thousands' position |
void | setInsertMode(BBjNumber shouldInsert) Controls whether the editor is in insert mode Note: The QVGrid is not editable, so this method has no effect. |
void | setInterspace(BBjNumber param_0!) Method setInterspace: Note: This method has been deprecated since BBj 5.0. Use setHorizontalCellSpacing(). |
void | setLeftColumn(BBjNumber column) Sets a column in the grid to be the left-most visible column |
void | setLineColor(BBjColor color!) Sets the line color of the vertical and horizontal lines |
void | setLocation(BBjNumber x!, BBjNumber y!) Sets the location of the QVGrid component child window |
void | setLongCue(String text!) Sets the text that appears in the status bar when the mouse pointer hovers over the grid control |
void | setMainGridAlignment(BBjNumber align) Sets the default horizontal alignment of the cells in the main part of the grid, i.e. not including any row or column headers. |
void | setMainGridBackColor(BBjColor color!) Sets the default background color of the grid |
void | setMainGridFont(BBjFont font!) Sets the default font used in the grid |
void | setMainGridForeColor(BBjColor color!) Sets the default foreground color of the grid |
void | setMainGridStripeColor(BBjColor color!) Sets the background stripe color of the grid |
void | setMainGridVerticalAlignment(BBjNumber align) Sets the default vertical alignment of the cells in the main part of the grid, i.e. not including any row or column headers. |
void | setMaxColumns(BBjNumber max) Sets the maximum number of columns allowed in the grid Note: In BBj 12.0 and higher, this method is deprecated as it is not necessary to set a maximum number of columns. Any calls to it will be ignored. |
void | setMaxRows(BBjNumber max) Sets the maximum number of rows allowed in the data set |
void | setMouseCapture(BBjNumber capture) Sets whether to capture mouse movement events |
void | setMultipleSelection(BBjNumber multiple) Sets whether multiple cells/rows/columns can be selected |
void | setName(String name!) Sets the name of the grid control |
void | setNoEdge(boolean noEdge!) Sets the grid control to have no border |
void | setNumColumns(BBjNumber columns) Sets the number of columns in the grid |
void | setNumRows(BBjNumber rows) Sets the number of rows in the grid Note: The QVGrid sets the number of grid rows to be at most those that are visible, so this method has no influence. |
void | setOpaque(boolean opaque!) Sets the opaque property of the grid control |
void | setPaging(BBjNumber page) Sets whether the BBjGrid can be scrolled by paging Note: The QVGrid has its own paging logic, so this method has no effect |
void | setPagingAmount(BBjNumber lines) Sets number of lines to scroll when scrolling by page Note: The QVGrid has its own paging logic, so this method has no effect |
void | setPopupMenu(BBjPopupMenu popupMenu!) Binds a pre-existing popup menu to the grid control |
void | setProcCallback(BBjNumber eventType, BBjString subRoutineName$) Registers a legacy custom event callback routine for a specified 'processing' event |
void | setProcCallback(BBjNumber eventType, CustomObject customObj!, BBjString methodName$) Registers an object oriented custom event callback routine for a specified 'processing' event |
void | setRaisedEdge(boolean raised!) Sets the grid control to have a raised border |
void | setResultSet(ResultSet bcrs!) Registers the underlying BASIS Components ResultSet |
void | setRowAlignment(BBjNumber row, BBjNumber align) Sets the horizontal alignment of a row |
void | setRowBackColor(BBjNumber row, BBjColor color!) Sets the background color of a row |
void | setRowEditable(BBjNumber row, BBjNumber editable) Sets whether a row is editable Note: The QVGrid is not editable, so this has no effect. |
void | setRowFont(BBjNumber row, BBjFont font!) Sets the default font of a row |
void | setRowForeColor(BBjNumber row, BBjColor color!) Sets the foreground color of a row |
void | setRowGutter(BBjNumber pixels) Sets the number of pixels separating the row header and the main grid area |
void | setRowHeaderAlignment(BBjNumber align) Sets the default alignment of the row header |
void | setRowHeaderBackColor(BBjColor color!) Sets the default background color of the row header |
void | setRowHeaderCellAlignment(BBjNumber row, BBjNumber align) Sets the alignment of a row header cell |
void | setRowHeaderCellBackColor(BBjNumber row, BBjColor color!) Sets the background color of a row header cell |
void | setRowHeaderCellForeColor(BBjNumber row, BBjColor color!) Sets the foreground color of a row header cell |
void | setRowHeaderCellIcon(BBjNumber imageListID, BBjNumber index, BBjNumber row) Sets the icon in a row header cell |
void | setRowHeaderCellImage(BBjNumber row, BBjImage image!) Sets the image displayed in a row header cell |
void | setRowHeaderCellStyle(BBjNumber row, BBjNumber style) Sets the style of a row header cell |
void | setRowHeaderCellText(BBjNumber row, BBjString text$) Sets the text to be displayed in a row header cell |
void | setRowHeaderCellVerticalAlignment(BBjNumber row, BBjNumber align) Sets the vertical alignment of the row header cell |
void | setRowHeaderFont(BBjFont font!) Sets the default font of the row header |
void | setRowHeaderForeColor(BBjColor color!) Sets the default foreground color of the row header |
void | setRowHeaderStyle(BBjNumber style) Sets the style of the row header |
void | setRowHeaderText(BBjVector strings!) Sets the row header text |
void | setRowHeaderVerticalAlignment(BBjNumber align) Sets the vertical alignment of the row header |
void | setRowHeaderWidth(BBjNumber width) Sets the width of the row header |
void | setRowHeight(BBjNumber height) Sets the height of the rows in the grid Note: The QVGrid only uses this method signature, i.e. setRowHeight(int index, int height) is not offered. |
void | setRowListener(BBjString listener$) Registers row listener to CALL when processing a data row on its way to the grid |
void | setRowListener(Object listener!) Registers row listener object to invoke when processing a data row on its way to the grid |
void | setRowStyle(BBjNumber row, BBjNumber style) Sets the default style of a row |
void | setRowVerticalAlignment(BBjNumber row, BBjNumber align) Sets the default vertical alignment for a row |
void | setRowVisible(BBjNumber row) Sets a row to be visible in the grid If the row is not already visible, then it will be made the top row or made visible if on the last grid page. |
void | setScrollOutside(BBjNumber outside) Sets whether the grid scrolls during a drag and drop operation when the mouse cursor is moved outside the bounds of the grid Note: The QVGrid handles scrolling itself, so this method has no effect. |
void | setScrollUpdate(BBjNumber update) Sets whether the grid updates the display of data in the cells while being scrolled Note: The QVGrid uses the default of "off", so this method has no effect. |
void | setScrollWheelBehavior(BBjNumber mode) Configures under what situations the grid control will respond to the mouse scroll wheel |
void | setSelectedCell(BBjNumber row, BBjNumber col) Selects a cell |
void | setSelectedColumn(BBjNumber column) Selects a column |
void | setSelectedColumns(BBjVector selection!) Selects multiple columns |
void | setSelectedRow(BBjNumber row) Selects a row |
void | setSelectedRows(BBjVector selections!) Selects multiple rows in the grid |
void | setSelectionMode(BBjNumber mode) Sets the method to select cells Note: The QVGrid always uses row selection (GRID_SELECT_ROW), so this method has no effect |
void | setShortCue(String cue!) Sets the text that appears above the grid control when the mouse pointer hovers over the control Note: Same as setToolTipText(). |
void | setShouldHighlightSelectedColumn(BBjNumber should) Sets whether the grid will highlight the entire column containing the currently selected cell |
void | setShouldHighlightSelectedRow(BBjNumber should) Sets whether the grid should highlight the entire row containing the currently selected cell |
void | setShowMaskWhenRendering(BBjNumber show) Controls whether the input style cells display decoration characters of their mask in non-edit mode Note: This method has been deprecated. |
void | setSize(BBjNumber width!, BBjNumber height!) Sets the size of the QVGrid component child window |
void | setSnapToRowHeight(BBjNumber shouldSnap) Sets whether the grid will adjust its height so that it does not display any partial rows Note: The QVGird always shows only complete rows, so this method has no effect. |
void | setSortByMultipleColumns(BBjNumber sortByMultiple) Sets whether a grid allows sorting by multiple columns |
void | setStartEditSelectionMode(BBjNumber mode) Sets the selection mode that will be used when a cell is edited Note: The QVGrid is not editable, so this method as no effect. |
void | setStripeCount(BBjNumber count) Sets the number of grid rows to alternate between the stripe color and the default background color |
void | setStyle(String arg!, String style!) see BBjControl |
void | setTabAction(BBjNumber action) Sets the current tab action of the grid |
void | setTabActionSkipsNonEditableCells(BBjNumber skips) When the user presses the [Tab] key while focus is on a grid cell, the focus will move based on the current "tab action" of the grid. If the program has called setTabActionSkipsNonEditableCells(TRUE) then the focus will skip any cells that are not editable. Note: The QVGrid is not editable, so this method has no effect. |
void | setTabTraversable(BBjNumber trav) Sets a value indicating whether or not the user can navigate to the grid control using the tab key |
void | setText(String text!) Sets the control text for the grid control Note: The relevance of this method for a grid control is questionable, but provided for compatibility. |
void | setToolTipText(BBjNumber row!, BBjNumber column!, BBjString text!) Sets the tooltip text (also known as short cue) for a cell |
void | setToolTipText(BBjNumber column!, BBjString text!) Sets the tooltip text (also known as short cue) for a column |
void | setToolTipText(String text!) Sets the tooltip text (also known as short cue) for the grid control |
void | setTopRow(BBjNumber row) Sets a row to be the top visible row or at least shown if on the last grid page. |
void | setTrimBlankSpace(BBjNumber shouldTrim) When a grid is larger in size than the size required to display the data and all required headers and scrollbars, this method controls whether the grid will be trimmed to the minimum size to display everything. |
void | setUpdateCached(BBjNumber update) Sets whether the grid sends table update notification events when cells already have data |
void | setUserData(Object userData!) Associates an object as user data with the grid control |
void | setUserResizable(BBjNumber resizable) Sets whether the columns in the grid can be resized by the user |
void | setVerticalCellSpacing(BBjNumber space) Sets the amount of vertical space between the rows |
void | setVerticalLinesVisible(BBjNumber visible) Sets whether the vertical lines between the columns are to be visible |
void | setVerticalScrollable(BBjNumber scrollable) Sets whether the vertical scrollbar can be enabled if there are more rows than can be displayed in the visible rows of the grid Note: The QVGrid maintains a separate vertical scrollbar control. Setting 'scrollable' to 0 (false) here, disables the scrollbar. |
void | setVerticalScrollBarAlways(BBjNumber always) Sets whether to always show a vertical scrollbar enabled using setVerticalScrollable(), or to only show the vertical scrollbar as needed Note: The QVGrid maintains a separate vertical scrollbar control that is always visible, so this method has no effect. |
void | setVisible(boolean visible!) Sets whether the QVGrid component child window is visible |
void | showToolTipText(BBjNumber x!, BBjNumber y!) Shows the tooltip text (also known as short cue) for the grid control |
void | showToolTipText() Shows the tooltip text (also known as short cue) for the grid control |
void | sortByColumn(BBjNumber column, BBjNumber sortOrder) Sorts the grid by the content of a given column Note: This method has little effect with the QVGrid because the grid only contains at most the number of visible rows. |
void | startEdit(BBjNumber row, BBjNumber column) Begins editing an editable cell in the grid Note: The QVGrid is not editable, so this method has no effect. |
void | suppressUpdatesWhileScrolling(BBjNumber shouldSuppress) Suppresses update requests to the program while the user scrolls |
void | unsort() Removes all sorting directives and displays the grid in its unsorted row order. This method is equivalent to unsort(TRUE, FALSE). Note: This method has little effect with the QVGrid because the grid only contains at most the number of visible rows. |
void | unsort(BBjNumber revertAllSortByRelated, BBjNumber revertAllUserSortable) Removes all sorting directives and displays the grid in its unsorted row order Note: This method has little effect with the QVGrid because the grid only contains at most the number of visible rows. |
void | vScrolled(BBjControlScrollEvent ev!) Scroll event handler for the vertical scrollbar |
void | vScrollTimer(BBjTimerEvent ev!) Scroll timer event handler |
public QVGrid(BBjWindow parentWin!, BBjChildWindow compWin!)
Constructs QVGrid component on passed parent window in existing child window.
parentWin!
Parent windowcompWin!
Component child windowpublic QVGrid(BBjWindow parentWin!, BBjNumber comp_id, BBjNumber comp_x, BBjNumber comp_y, BBjNumber comp_w, BBjNumber comp_h)
Constructs QVGrid component on passed parent window using given id and dimensions.
parentWin!
Parent windowcomp_id
Component (base) control IDcomp_x
Component x-coordcomp_y
Component y-coordcomp_w
Component widthcomp_h
Component heightpublic QVGrid(BBjWindow parentWin!, BBjChildWindow compWin!, BBjNumber comp_id, BBjNumber comp_x, BBjNumber comp_y, BBjNumber comp_w, BBjNumber comp_h)
Constructs QVGrid component on passed parent window in existing child window using given id and dimensions.
parentWin!
Parent windowcompWin!
Component child windowcomp_id
Component (base) control ID. Defaults to next available control ID.comp_x
Component x-coordcomp_y
Component y-coordcomp_w
Component widthcomp_h
Component heightpublic void accept(BBjNumber valid)
Used to accept or reject the value that the user has just entered into the grid control Note: The QVGrid is not editable, so this method has no effect.
valid
0 = Invalid; focus may not leave the control, 1 = Valid; focus may leave the controlpublic void addCellStyleName(BBjNumber row, BBjNumber column, BBjString styleName$)
Adds a CSS style name to a grid cell
row
Specifies the row numbercolumn
Specifies the column numberstyleName$
Specifies the style name to add to the grid cellpublic void addColumnStyleName(BBjNumber column, BBjString styleName$)
Adds a CSS style name to a grid column
column
Specifies the column numberstyleName$
Specifies the style name to add to the grid columnpublic BBjPopupMenu addPopupMenu()
Adds a popup menu to the grid control
public void addRowStyleName(BBjNumber row, BBjString styleName$)
Adds a CSS style name to a grid row
row
Specifies the row numberstyleName$
Specifies the style name to add to the grid rowpublic BBjNumber addStyle(String styleName!)
Adds a CSS style name to the grid control
styleName$
Specifies a style name to be added to the controlpublic void adjustSpacesWhenDisplaying(BBjNumber column, BBjNumber stripLeading, BBjNumber stripTrailing, BBjNumber collapseMultipleSpaces, BBjNumber removeAllSpaces)
Adjusts, for a given column, the spaces contained in data before displaying within a cell
column
The column to affectstripLeading
An indication of whether leading spaces should be removedstripTrailing
An indication of whether tailing spaces should be removedcollapseMultipleSpaces
An indication of whether contiguous spaces should be collapsed into a single spaceremoveAllSpaces
An indication of whether all spaces should be removedpublic void adjustSpacesWhenSaving(BBjNumber column, BBjNumber stripLeading, BBjNumber stripTrailing, BBjNumber collapseMultipleSpaces, BBjNumber removeAllSpaces)
Adjusts, for a given column, the spaces the user entered before returning it to the program
column
The column to affectstripLeading
An indication of whether leading spaces should be removedstripTrailing
An indication of whether tailing spaces should be removedcollapseMultipleSpaces
An indication of whether contiguous spaces should be collapsed into a single spaceremoveAllSpaces
An indication of whether all spaces should be removedpublic void buildGrid()
Constructs grid based on the current resultset metadata. Handles optional column-level attributes that have been set in the metadata, including: HIDE - if 1, then doesn't add this column to the grid NOTITLE - if 1, then suppresses the column title MASK - Sets the column mask with the string value ALIGN - Sets the column header cell alignement with the numeric value STYLE - Sets the column style with the numeric value BACKCOLOR - Sets the column background color to the color name FORECOLOR - Sets the column foreground color to the color name
public void clearCallback(int eventType!)
Unregisters the callback routine for a specified event
eventType
Event type for which the callback is to be unregisteredpublic void clearCellStyleNames(BBjNumber row, BBjNumber column)
Clears CSS styles from a grid cell
row
Specifies the 0-based row numbercolumn
Specifies the 0-based column numberpublic void clearColumnStyleNames(BBjNumber column)
Clears CSS styles from a grid column
column
Specifies the column numberpublic void clearGrid()
Removes all data from the cells
public void clearMainGrid()
Removes all data from the main grid cells, leaving headers intact
public void clearProcCallback(BBjNumber eventType)
Unregisters the custom event callback routine for a specified 'processing' event
eventType
Event type for which the custom event callback is to be unregisteredpublic void clearRowStyleNames(BBjNumber row)
Clears CSS styles from a grid row
row
Specifies the 0-based row numberpublic void clearStyles()
Clears CSS styles from the grid control
public void columnHeaderSelectColumn(BBjGridMouseUpEvent ev!)
Grid column header mouse up handler
ev!
Grid Mouse Up event objectpublic BBjDataAwareGrid convertToDataAware(BBjNumber channel, BBjString template$)
Converts grid to a BBjDataAwareGrid
channel
Specifies the data channeltemplate
Specifies the template description string used to set the field propertiespublic void deleteColumn(BBjNumber column)
Deletes a column
column
Specifies the 0-based columnpublic void deleteRow(BBjNumber row)
Deletes a row Note: The QVGrid completely handles the grid content displayed, so this method has no effect.
row
Specifies the 0-based rowpublic void deselectAllCells()
Deselects all of the cells in the grid
public void destroy()
Destroys the QVGrid component child window
public void doLowerCaseWhenDisplaying(BBjNumber column)
Adjusts, for a given column, the data to lowercase before displaying to the user
column
The column to affectpublic void doLowerCaseWhenSaving(BBjNumber column)
Adjusts, for a given column, the data to lowercase before returning it to the program
column
The column to affectpublic void doUpperCaseWhenDisplaying(BBjNumber column)
Adjusts, for a given column, the data to uppercase before displaying to the user
column
The column to affectpublic void doUpperCaseWhenSaving(BBjNumber column)
Adjusts, for a given column, the data to uppercase before returning it to the program
column
The column to affectpublic void endEdit(BBjNumber suppress)
Ends any editing of the grid Note: The QVGrid is not editable, so this method has no effect.
suppress
Specifies whether to suppress the EDIT KILL eventpublic void endEdit()
Ends any editing of the grid Note: The QVGrid is not editable, so this method has no effect.
public void fillGridWithColumns(BBjNumber fit)
Specifies whether to fit all columns into the displayed width of the grid
fit
Specifies whether to fit all columns into the displayed width of the gridpublic void focus()
Sets the focus on the grid control
public BBjString getAttribute(String attribute!)
Returns a control attribute previously set with setAttribute() for the grid control
attribute$
Specifies an attribute to be retrieved from the controlpublic BBjColor getBackColor()
Returns the background color of the grid control
public BBjNumber getBeepOnValidationFailure()
Returns whether the grid will beep when the program calls 'accept(0)' in response to a validation event
public BBjNumber getBottomRow()
Returns the current visible bottom row
public BBjNumber getCausesControlValidation()
Returns whether entering the grid control will trigger control validation on the control that previously had focus
public BBjNumber getCellAlignment(BBjNumber row, BBjNumber column)
Returns the alignment of a cell
row
Specifies the 0-based rowcolumn
Specifies the 0-based columnpublic BBjColor getCellBackColor(BBjNumber row, BBjNumber column)
Returns the background color of a cell
row
Specifies the 0-based rowcolumn
Specifies the 0-based columnpublic BBjFont getCellFont(BBjNumber row, BBjNumber column)
Returns the font of a cell
row
Specifies the 0-based rowcolumn
Specifies the 0-based columnpublic BBjColor getCellForeColor(BBjNumber row, BBjNumber column)
Returns the foreground color of a cell
row
Specifies the 0-based rocolumn
Specifies the 0-based columnpublic BBjNumber getCellHasQuery(BBjNumber row, BBjNumber column)
Returns whether a BBjStandardGrid cell has an associated query button
row
Specifies the 0-based rowcolumn
Specifies the 0-based columnpublic BBjComboBox getCellListControl(BBjNumber row, BBjNumber column)
Returns the list control for a cell
row
Specifies the 0-based rowcolumn
Specifies the 0-based columnpublic BBjNumber getCellListSelection(BBjNumber row, BBjNumber column)
Returns the list selection for a list control in a cell
row
column
public BBjString getCellMask(BBjNumber row, BBjNumber column)
Returns the mask for a cell
row
Specifies the 0-based rowcolumn
Specifies the 0-based columnpublic BBjString getCellRelated(BBjNumber row, BBjNumber column)
Returns the "related" text associated with a cell
row
Specifies the 0-based rowcolumn
Specifies the 0-based columnpublic BBjString getCellRestore(BBjNumber row, BBjNumber column)
Returns the restore value for a cell
row
Specifies the 0-based rowcolumn
Specifies the 0-based columnpublic BBjNumber getCellState(BBjNumber row, BBjNumber column)
Returns the checked state of a check box or button style cell
row
Specifies the 0-based rowcolumn
Specifies the 0-based columnpublic BBjNumber getCellStyle(BBjNumber row, BBjNumber column)
Returns the style of a cell
row
Specifies the 0-based rocolumn
Specifies the 0-based columnpublic BBjVector getCellStyleNames(BBjNumber row, BBjNumber column)
Returns a list of all CSS style names that have been added to a grid cell
row
Specifies the 0-based row numbercolumn
Specifies the 0-based column numberpublic BBjString getCellText(BBjNumber row, BBjNumber column)
Returns the value of the text stored in the specified cell
row
Specifies the 0-based rowcolumn
Specifies the 0-based columnpublic BBjNumber getCellVerticalAlignment(BBjNumber row, BBjNumber column)
Returns the vertical alignment of a cell
row
Specifies the 0-based rowcolumn
Specifies the 0-based columnpublic BBjNumber getClientEdge()
Returns whether the client (lowered) border is set for the grid control
public Object getClientProperty(Object p_key!)
see BBjControl
public BBjNumber getColumnAlignment(BBjNumber column)
Returns the default horizontal alignment for a column
column
public BBjColor getColumnBackColor(BBjNumber column)
Returns the default background color of a column
column
Specifies the 0-based columnpublic BBjFont getColumnFont(BBjNumber column)
Returns the default font of a column
column
Specifies the 0-based columnpublic BBjColor getColumnForeColor(BBjNumber column)
Returns the default foreground color of a column
column
Specifies the 0-based columnpublic BBjNumber getColumnGutter()
Returns the number of pixels separating the column header and the main grid area
public BBjNumber getColumnHasQuery(BBjNumber column)
Returns whether all cells in the specified column have associated query buttons
column
Specifies the 0-based columnpublic BBjGridHeader getColumnHeader()
Returns the column header object for the grid
public BBjNumber getColumnHeaderAlignment()
Returns the default column header horizontal alignment
public BBjColor getColumnHeaderBackColor()
Returns the default background color of the column header
public BBjNumber getColumnHeaderCellAlignment(BBjNumber column)
Returns the horizontal alignment for a column header cell
column
public BBjColor getColumnHeaderCellBackColor(BBjNumber column)
Returns the background color of a column header cell
column
public BBjColor getColumnHeaderCellForeColor(BBjNumber column)
Returns the foreground color of a column header cell
column
Specifies the 0-based columnpublic BBjNumber getColumnHeaderCellStyle(BBjNumber column)
Returns the style of a column header cell
column
Specifies the 0-based columnpublic BBjString getColumnHeaderCellText(BBjNumber column)
Returns the text displayed in a column header cell
column
Specifies the 0-based columnpublic BBjNumber getColumnHeaderCellVerticalAlignment(BBjNumber column)
Returns the vertical alignment for a column header cell
column
Specifies the 0-based columnpublic BBjFont getColumnHeaderFont()
Returns the default font of the column header
public BBjColor getColumnHeaderForeColor()
Returns the default foreground color of the column header
public BBjNumber getColumnHeaderHeight()
Returns the height of the column header
public BBjNumber getColumnHeaderStyle()
Returns the style used by default for the column headers
public BBjNumber getColumnHeaderVerticalAlignment()
Returns the default column header vertical alignment
public BBjComboBox getColumnListControl(BBjNumber column)
Returns the list control for a column
column
Specifies the 0-based columnpublic BBjNumber getColumnListSelection(BBjNumber column)
Returns the default selected index for the list control in the column
column
public BBjString getColumnMask(BBjNumber column)
Returns the default mask for a column
column
Specifies the 0-based columnpublic BBjNumber getColumnStyle(BBjNumber column)
Returns the default style of a column in the grid
column
Specifies the 0-based columnpublic BBjVector getColumnStyleNames(BBjNumber column)
Returns a list of all CSS styles names that have been added to a grid column
column
Specifies the column numberpublic BBjNumber getColumnVerticalAlignment(BBjNumber column)
Returns the default vertical alignment for all of the cells in a particular column
column
Specifies the 0-based columnpublic BBjNumber getColumnWidth(BBjNumber column)
Retrieves the width of a specified column
column
Specifies the columnpublic BBjVector getColumnWidths()
Returns a vector containing the column widths within a grid
public String getComputedStyle(String arg0!)
see BBjControl
public BBjNumber getContextID()
Returns the context ID of the QVGrid component child window
public BBjNumber getControlType()
Returns the control type of the grid control Note: For a listing of control type constants, see Constants in BBjControl.
public BBjNumber getDefaultColumnWidth()
Returns the default column width
public BBjNumber getDefaultGridStyle()
Returns the default style of cells in the grid
public BBjNumber getDragAccept()
Returns whether the grid accepts drag and drop operations
public BBjNumber getDragActions()
Returns the actions that are currently available when dragging from the grid control
public BBjNumber getDragEnabled()
Returns whether the grid control should allow drag operations
public BBjString getDragType(BBjNumber row, BBjNumber column)
Returns the drag type that was set for a particular cell in a previous call to setDragType()
row
Specifies the 0-based rowcolumn
Specifies the 0-based columnpublic BBjString getDragType(BBjNumber column)
Returns the drag type that was set for a particular column in a previous call to setDragType()
column
Specifies the 0-based columnpublic BBjString getDragType()
Returns an optional type string, previously set with setDragType(), that the grid control advertises to potential drop targets when it acts as a drag source
public BBjNumber getDropActions()
Returns the actions that are currently available when dropping to the grid control. Returns ACTION_NONE if the control is disabled or non-editable.
public BBjVector getDropTypes(BBjNumber row, BBjNumber column)
Returns the drop types that were set for a particular cell in a previous call to setDropTypes()
row
Specifies the 0-based rowcolumn
Specifies the 0-based columnpublic BBjVector getDropTypes(BBjNumber column)
Returns the drop types that were set for a particular column in a previous call to setDropTypes()
column
Specifies the 0-based columnpublic BBjVector getDropTypes()
Returns the drop types that were set in a previous call to setDropTypes()
public BBjNumber getEditClickCount()
Returns the number of mouse clicks needed to begin editing a cell Note: the QVGrid is not editable, so this method has no effect.
public BBjString getEditText()
Returns the current edit text associated with the grid Note: The QVGrid is not editable, so this method has no meaning
public BBjFont getFont()
Returns the font of the grid control
public BBjColor getForeColor()
Returns the foreground (text) color of the grid control
public BBjStandardGrid getGrid()
Returns the underlying BBjStandardGrid object
public BBjNumber getHasColumnHeader()
Returns whether the grid has a column header
public BBjNumber getHasRowHeader()
Returns whether the grid has a row header
public BBjNumber getHeaderSelection()
Returns whether header selection is active
public BBjNumber getHeight()
Returns the height of the QVGrid component child window
public BBjNumber getHighlightMethod()
Returns which selection highlight method is currently being used
public BBjNumber getHorizontalCellSpacing()
Returns the amount of horizontal space between the columns
public BBjNumber getHorizontalLinesVisible()
Returns whether horizontal lines between the rows are visible
public BBjNumber getHorizontalScrollable()
Returns whether the horizontal scrollbar will appear if there are more columns than can be displayed in the visible area of the grid
public BBjNumber getHorizontalScrollBarAlways()
Returns whether to always show a horizontal scrollbar enabled using setHorizontalScrollable(), or to only show as needed
public BBjNumber getID()
Returns the control ID of the QVGrid component child window
public BBjNumber getInputNBeep()
Returns an indication of whether InputN style cells will beep when user enters an invalid character
public BBjString getInputNCommaCharacter()
Returns the character that InputN style cells will display as their 'thousands' separator
public BBjString getInputNDotCharacter()
Returns the character that InputN style cells will display as their decimal separator
public BBjNumber getInputNUseEditCommas()
Returns an indication of whether InputN style cells will display a character at each 'thousands' position
public BBjNumber getInsertMode()
Returns whether the editor is in insert mode
public BBjNumber getInterspace()
Method getInterspace: Note: This method has been deprecated since BBj 5.0. Use getHorizontalCellSpacing().
public BBjNumber getLeftColumn()
Returns the current visible left-most column
public BBjColor getLineColor()
Returns the color of the separator lines
public BBjString getLongCue()
Returns the text that appears in the status bar when the mouse pointer hovers over the grid control
public BBjNumber getMainGridAlignment()
Returns the default horizontal alignment of the cells in the main part of the grid, i.e. not including any row or column headers.
public BBjColor getMainGridBackColor()
Returns the default background color of the grid
public BBjFont getMainGridFont()
Returns the default font of the grid
public BBjColor getMainGridForeColor()
Returns the default foreground color of the grid
public BBjColor getMainGridStripeColor()
Returns the background stripe color of the grid
public BBjNumber getMainGridVerticalAlignment()
Returns the default vertical alignment of the cells in the main part of the grid, i.e. not including any row or column headerthe default vertical alignment of the cells in the main part of the grid, i.e. not including any row or column headers.s.
public BBjNumber getMaxColumns()
Returns the maximum number of columns allowed in the grid Note: In BBj 12.0 and higher, this method is deprecated and always returns 2147483647.
public BBjNumber getMaxRows()
Returns the maximum number of rows allowed in the data set
public BBjString getName()
Returns the control name of the grid control
public BBjNumber getNoEdge()
Returns whether the grid control has no border
public BBjNumber getNumColumns()
Returns the number of columns in the grid
public BBjNumber getNumRows()
Returns the number of rows in the grid
public BBjNumber getPagingAmount()
Returns the number of lines to scroll when scrolling by page Note: The QVGrid has its own paging logic, so this method has no meaning
public BBjWindow getParentWindow()
see BBjControl
public BBjPopupMenu getPopupMenu()
Retrieves a popup menu from the grid control
public BBjNumber getRaisedEdge()
Returns whether the grid control has a raised border
public BBjString getRecord()
Retrieves the current record data
public BBjString getRecordTemplate()
Retrieves the current record template definition
public BBjNumber getRowAlignment(BBjNumber row)
Returns the horizontal alignment of a row
row
Specifies the 0-based rowpublic BBjFont getRowFont(BBjNumber row)
Returns the default font of a row
row
Specifies the 0-based rowpublic BBjNumber getRowGutter()
Returns the number of pixels separating the row header and the main grid area
public BBjGridHeader getRowHeader()
Returns the BBjGridHeader object for this grid
public BBjNumber getRowHeaderAlignment()
Returns the default alignment of the row header
public BBjColor getRowHeaderBackColor()
Returns the default background color of the row header
public BBjNumber getRowHeaderCellAlignment(BBjNumber row)
Returns the alignment of a row header cell
row
Specifies the 0-based rowpublic BBjColor getRowHeaderCellBackColor(BBjNumber row)
Returns the background color for a row header cell
row
Specifies the 0-based rowpublic BBjColor getRowHeaderCellForeColor(BBjNumber row)
Returns the foreground color of a row header cell
row
Specifies the 0-based rowpublic BBjNumber getRowHeaderCellStyle(BBjNumber row)
Returns the style of a row header cell
row
Specifies the 0-based rowpublic BBjString getRowHeaderCellText(BBjNumber row)
Returns the text displayed in a row header cell
row
Specifies the 0-based rowpublic BBjNumber getRowHeaderCellVerticalAlignment(BBjNumber row)
Returns the vertical alignment of the row header cell
row
Specifies the 0-based rowpublic BBjFont getRowHeaderFont()
Returns the default font of the row header
public BBjColor getRowHeaderForeColor()
Returns the default foreground color of the row header
public BBjNumber getRowHeaderStyle()
Returns the default style of the row header
public BBjNumber getRowHeaderVerticalAlignment()
Returns the vertical alignment of the row header
public BBjNumber getRowHeaderWidth()
Returns the width of the row header
public BBjNumber getRowHeight(BBjNumber row)
Returns the height of a row in pixels
row
Specifies the 0-based rowpublic BBjNumber getRowHeight()
Returns the default height in pixels of the rows
public BBjString getRowKey(BBjNumber row)
Retrieves the row key for the specified resultset row
row
Result set row number (0-based)public BBjNumber getRowModelIndexFromViewIndex(BBjNumber index)
Maps the view index of a row to the model index
index
The index of a row as the user sees itpublic BBjVector getRowStyleNames(BBjNumber row)
Returns a vector of style names that have been added to a row
row
Specifies the row numberpublic BBjNumber getRowVerticalAlignment(BBjNumber row)
Returns the default vertical alignment for a row
row
Specifies the 0-based rowpublic BBjNumber getRowViewIndexFromModelIndex(BBjNumber index)
Maps the model index of a row to the view index
index
The index of a row as the program sees itpublic BBjNumber getScreenX()
Returns the X coordinate of the the QVGrid component child window on the screen
public BBjNumber getScreenY()
Returns the Y coordinate of the the QVGrid component child window on the screen
public BBjNumber getScrollOutside()
Returns whether the grid will scroll when the mouse cursor is moved outside the bounds of the grid during a drag and drop operation
public BBjNumber getScrollUpdate()
Returns whether the grid updates the display of data in the cells while being scrolled
public BBjNumber getScrollWheelBehavior()
Returns a constant indicating under what situations the grid control will respond to the mouse scroll wheel
public BBjNumber getSelectedColumn()
Returns the currently selected column
public BBjVector getSelectedColumns()
Returns a BBjVector containing selected columns
public BBjNumber getSelectedRow()
Returns the currently selected row
public BBjVector getSelectedRows()
Returns a vector containing the selected rows in a grid
public BBjNumber getSelectionMode()
Returns the current selection mode
public BBjString getShortCue()
Returns the text that appears above the grid control when the mouse pointer hovers over the control Note: Same as getToolTipText().
public BBjNumber getShouldHighlightSelectedColumn()
Returns whether the grid should highlight the entire column of the currently selected cell
public BBjNumber getShouldHighlightSelectedRow()
Returns whether the grid should highlight the entire row of the currently selected cell
public BBjNumber getShowMaskWhenRendering()
Returns whether input style cells display the decoration characters of their mask in non-edit mode Note: This method has been deprecated.
public BBjNumber getSnapToRowHeight()
Returns whether the gird will adjust its height so that only full rows appear in the grid Note: The QVGird always shows only complete rows, so this method always returns the default of TRUE.
public BBjNumber getSortByMultipleColumns()
Returns an indication of whether this grid sorts by multiple columns
public BBjNumber getStartEditSelectionMode()
Returns the selection mode that will be used when starting to edit a cell Note: The QVGrid is not editable, so this method has no further meaning
public BBjNumber getStringWidth(BBjString text$)
Returns the width of a string in pixels
text$
Specifies the text stringpublic BBjNumber getStripeCount()
Returns the number of grid rows to alternate between the stripe color and the default background color
public String getStyle(String arg!)
see BBjControl
public BBjVector getStyles()
Gets a vector of all CSS style names that have been added to the grid control
public BBjNumber getTabAction()
Returns the current tab action of the grid
public BBjNumber getTabActionSkipsNonEditableCells()
When the user presses the [Tab] key while focus is on a grid cell, the focus will move based on the current "tab action" of the grid. If the program has called setTabActionSkipsNonEditableCells(TRUE) then the focus will skip any cells that are not editable. Note: The QVGrid is not editable, so this method is not influenced by a previous setTabActionSkipsNonEditableCells().
public BBjString getText()
Returns the control text assigned to the grid control Note: The relevance of this method for a grid is questionable, but provided for compatability.
public BBjString getToolTipText(BBjNumber row!, BBjNumber column!)
Returns the tooltip text (also known as short cue) for a cell
row
Specifies the 0-based rowcolumn
Specifies the 0-based columnpublic BBjString getToolTipText(BBjNumber column!)
Returns the tooltip text (also known as short cue) for a column
column
Specifies the 0-based columnpublic BBjString getToolTipText()
Returns the tooltip text (also known as short cue) for the grid control
public BBjNumber getTopRow()
Returns the current top visible row
public BBjNumber getTrimBlankSpace()
Returns whether the grid will trim its size if it is larger than the size needed to display the data, all headers and all scrollbars
public BBjNumber getUpdateCached()
Returns whether the grid sends table update events
public Object getUserData()
Retrieves user data associated with the grid control after having called setUserData()
public BBjString getValidationText()
Returns the value that the user just entered into the grid control Note: The QVGrid is not editable and a grid control always returns an empty string, so this method has no meaning
public BBjNumber getVerticalCellSpacing()
Returns the amount of vertical space between the rows
public BBjNumber getVerticalLinesVisible()
Returns whether the vertical lines between columns are visible
public BBjNumber getVerticalScrollable()
Returns whether the vertical scrollbar can be enabled if there are more rows than can be displayed in the visible rows of the grid
public BBjNumber getVerticalScrollBarAlways()
Returns whether to always show a vertical scrollbar enabled using setVerticalScrollable(), or to only show the vertical scrollbar as needed Note: The QVGrid maintains a separate vertical scrollbar control that is always visible, so 1 (true) is always returned.
public BBjNumber getVisibleRowCount()
Returns the number of rows that are currently visible in the grid
public BBjNumber getWidth()
Returns the width of the QVGrid component child window
public BBjNumber getX()
Returns the X coordinate of the QVGrid component child window
public BBjNumber getY()
Returns the Y coordinate of the QVGrid component child window
public void grdScrolled(BBjScrollWheelEvent ev!)
Mouse scroll wheel event handler
ev!
Mouse scroll wheel event objectpublic void hitBottom(BBjGridHitBottomEvent ev!)
Hit bottom event handler
ev!
Hit bottom event objectpublic void hitTop(BBjGridHitTopEvent ev!)
Hit top event handler
ev!
Hit top event objectpublic void insertColumn(BBjNumber index)
Inserts a column
index
Specifies the 0-based index at which the column will be insertedpublic void insertRow(BBjNumber index)
Inserts a row
index
Specifies the 0-based index at which the row will be insertedpublic BBjNumber isCellEditable(BBjNumber row, BBjNumber column)
Returns whether a cell is editable
row
Specifies the 0-based rowcolumn
Specifies the 0-based columnpublic BBjNumber isColumnEditable(BBjNumber column)
Returns whether a column is editable Note: The QVGird is not editable, so this method always returns FALSE
column
Specifies the 0-based columnpublic BBjNumber isColumnSortedByRelatedData(BBjNumber column)
Returns an indication of whether a given column is sorted by related data rather than by cell text
column
Specifies the 0-based columnpublic BBjNumber isColumnUserSortable(BBjNumber column)
Returns whether the grid sorts a specified column when the user clicks in the header of that column
column
Specifies the 0-based columnpublic BBjNumber isColumnVisible(BBjNumber column)
Returns whether a column is visible
column
Specifies the 0-based columnpublic BBjNumber isDataAware()
Returns whether the grid is data aware Note: The QVGird is a BBjStandardGrid, so this method returns FALSE.
public BBjNumber isDataBound()
Returns whether the grid is data bound Note: The QVGird cannot be configured as a data bound control, so this method returns FALSE.
public BBjNumber isDestroyed()
Returns whether the QVGrid component child window has been destroyed
public BBjNumber isEditable()
Returns whether the grid is editable Note: The QVGrid is not editable, so this always returns FALSE.
public BBjNumber isEditing()
Returns whether the grid is currently in edit mode Note: The QVGird is not editable, so this method always returns FALSE
public BBjNumber isEnabled()
Returns whether the grid control is enabled
public BBjNumber isEnterAsTab()
Returns whether pressing [Enter] while focus is on the grid will be interpreted as though the user had pressed [Tab]
public BBjNumber isFitToGrid()
Returns all columns are fitted into the displayed width of the grid
public BBjNumber isFocusable()
Returns a value indicating whether or not the user can focus the grid control
public BBjNumber isGridEditable()
This method is deprecated. Use isEditable() instead. Note: The QVGrid is not editable, so FALSE is always returned.
isEditable()
public boolean isGrouped()
see BBjControl
public BBjNumber isMultipleSelectionAllowed()
Returns whether multiple selection is allowed
public BBjNumber isOpaque()
Returns the opaque property of the grid control
public BBjNumber isPaging()
Returns whether the grid can be scrolled by paging Note: The QVGrid has its own paging logic, so this method has no meaning
public BBjNumber isRowEditable(BBjNumber row)
Returns whether a row is editable Note: The QVGrid is not editable, so FALSE is always returned.
row
Specifies the 0-based rowpublic BBjNumber isRowVisible(BBjNumber row)
Returns whether a row is currently visible in the grid
row
Specifies the 0-based rowpublic BBjNumber isTabTraversable()
Returns a value indicating whether or not the user can navigate to the grid control using the tab key
public BBjNumber isUserResizable()
Returns whether the columns in the grid can be resized by the user
public BBjNumber isVisible()
Returns whether the QVGrid component child window is visible
public void loadGrid()
Loads grid initally
public void moveToNextCell()
Moves the selection to the next cell
public void putClientProperty(Object p_key!, Object p_value!)
see BBjControl
public void removeAttribute(String attribute!)
Removes a control attribute from the grid control
attribute$
Specifies an attribute to be removedpublic void removeCellStyleName(BBjNumber row, BBjNumber column, BBjString styleName$)
Removes a CSS style name from a grid cell
row
Specifies the 0-based row numbercolumn
Specifies the 0-based column numberstyleName$
Specifies the style name to remove from the grid cellpublic void removeColumnStyleName(BBjNumber column, BBjString styleName$)
Removes a CSS style name from a grid column
column
Specifies the column numberstyleName$
Specifies the style name to remove from the grid columnpublic void removePopupMenu()
Removes a popup menu from the grid control
public void removeRowStyleName(BBjNumber row, BBjString styleName$)
Removes a CSS style name from a grid row
row
Specifies the 0-based row numberstyleName$
Specifies the style name to remove from the grid rowpublic BBjNumber removeStyle(String styleName!)
Removes a CSS style name from the grid control
styleName$
Specifies a style name to be removed from the controlpublic void resort()
Re-sorts the grid If a user edits a grid cell after a grid is sorted, the row display order does not automatically change to reposition the edited cell. Calling resort() caused the grid to re-apply all sorting so that the newly edited data appears in the correct sort order. Note: This method has little effect with the QVGrid because the grid only contains at most the number of visible rows.
public void restoreCell(BBjNumber row, BBjNumber column)
Restores a cell to its previous value
row
Specifies the 0-based rowcolumn
Specifies the 0-based columnpublic void restoreRow(BBjNumber row)
Restores all cell values in a row
row
Specifies the 0-based rowpublic void rowSelected(BBjGridSelectRowEvent ev!)
Event handler for a row selection
ev!
Select row event objectpublic void scrollTo(BBjNumber pos)
Scroll grid to a given position
pos
position to scroll topublic void scrollToBottom()
Scrolls down in order to set the bottom row visible
public void setAllColumnsUserSortable(BBjNumber sortable)
Sets user-sortable indicator for all columns
sortable
Indicates whether the user can sort any column by clicking in the headerpublic void setAttribute(String attribute!, String value!)
Sets a control attribute for the grid control
attribute$
Specifies an attribute to be setvalue$
Specifies the value of the attributepublic void setBackColor(BBjColor color!)
Sets the background color for the grid control
color!
The background colorpublic void setBeepOnValidationFailure(BBjNumber shouldBeep)
Sets whether the grid should beep when the program calls 'accept(0)' in response to a validation event
shouldBeep
Indicates whether the grid should beeppublic void setCallback(int eventType!, String subRoutineName!)
Registers a legacy callback routine for a specified event in the grid
eventType
Event type for which the callback is to be registeredsubRoutineName$
Name of the subroutine to be called when the event is processed by process_eventspublic void setCallback(int eventType!, CustomObject customObj!, String methodName!)
Registers an object oriented callback routine for a specified event in the grid
eventType
Event type for which the callback is to be registeredcustomObj!
A CustomObject containing the method to be called when the event is processed by process_eventsmethodName$
The name of the method that is to be called when the event is processed by process_eventspublic void setCausesControlValidation(boolean causesValidation!)
Sets whether entering this grid control will trigger control validation on the control that previously had focus Note: This feature is typically used with controls like the Cancel button that should let the user exit without forcing valid data to be entered first.
causesValidation
FALSE = Entering this control should not cause control validation, TRUE = Entering this control should cause control validationpublic void setCellAlignment(BBjNumber row, BBjNumber column, BBjNumber align)
Sets the alignment of a cell
row
Specifies the 0-based rowcolumn
Specifies the 0-based columnalign
Specifies the grid alignment value of the cellpublic void setCellBackColor(BBjNumber row, BBjNumber column, BBjColor color!)
Sets the background color of a cell
row
Specifies the 0-based rowcolumn
Specifies the 0-based columncolor!
Specifies the background color as a BBjColor objectpublic void setCellData(BBjNumber row, BBjNumber column, BBjString text$, BBjString related$)
Sets both the displayed and related text of a cell
row
Specifies the 0-based rowcolumn
Specifies the 0-based columntext$
Specifies the display textrelated$
Specifies the related textpublic void setCellEditable(BBjNumber row, BBjNumber column, BBjNumber editable)
Sets whether a cell is editable Note: The QVGrid is non-editable, so this method does not change any state.
row
Specifies the 0-based rowcolumn
Specifies the 0-based columneditable
Specifies the editability of the cellpublic void setCellFont(BBjNumber row, BBjNumber column, BBjFont font!)
Sets the font of a cell
row
Specifies the 0-based rowcolumn
Specifies the 0-based columnfont!
Specifies the font as BBjFont objectpublic void setCellForeColor(BBjNumber row, BBjNumber column, BBjColor color!)
Sets the foreground color of a cell
row
Specifies the 0-based rowcolumn
Specifies the 0-based columncolor!
Specifies the foreground color as a BBjColor objectpublic void setCellHasQuery(BBjNumber row, BBjNumber column, BBjNumber hasQuery)
Specifies whether a cell should have an associated query button
row
Specifies the 0-based rowcolumn
Specifies the 0-based columnhasQuery
Specifies whether this cell has a query buttonpublic void setCellIcon(BBjNumber imageListID, BBjNumber index, BBjNumber row, BBjNumber column)
Sets the icon for a cell
imageListID
Specifies the imagelist IDindex
Specifies the 0-based index of the icon in the image listrow
Specifies the 0-based rowcolumn
Specifies the 0-based columnpublic void setCellImage(BBjNumber row, BBjNumber column, BBjImage image!)
Sets the image displayed in a cell
row
Specifies the 0-based start rowcolumn
Specifies the 0-based start columnimage!
Image to display in the cellpublic void setCellListControl(BBjNumber row, BBjNumber column, BBjComboBox list!)
Sets a list control for a cell so that the cell will display as a list control when edited
row
Specifies the 0-based rowcolumn
Specifies the 0-based columnlist!
Specifies the BBjListButton or BBjListEdit control object to usepublic void setCellListSelection(BBjNumber row, BBjNumber column, BBjNumber sel, BBjNumber repaint)
Sets the list selection for a list control in a cell
row
Specifies the 0-based row of the cellcolumn
Specifies the 0-based column of the cellsel
Specifies list 0-based selectionrepaint
Specifies whether to repaint the cell to display selected indexpublic void setCellMask(BBjNumber row, BBjNumber column, BBjString mask$)
Sets the cell mask for both displaying and editing Note: Only applicable to InputD, InputE, and InputN style cells.
row
Specifies the 0-based rowcolumn
Specifies the 0-based columnmask$
Specifies the maskpublic void setCellRelated(BBjNumber row, BBjNumber column, BBjString text$)
Sets the "related" text that is associated with a cell
row
Specifies the 0-based rowcolumn
Specifies the 0-based columntext$
The "related" text associated with the specified cellpublic void setCellRelated(BBjNumber row, BBjNumber column, BBjVector strings!)
Sets the "related" text that for a range of cells
row
Specifies the 0-based start rowcolumn
Specifies the 0-based start columnstrings!
Specifies the vector that contains the text for the cellspublic void setCellRestore(BBjNumber row, BBjNumber column, BBjString restore$)
Sets the restore value for a cell
row
Specifies the 0-based rowcolumn
Specifies the 0-based columnrestore$
Specifies the restore valuepublic void setCellState(BBjNumber row, BBjNumber column, BBjNumber state)
Sets the checked state of a check box or button style cell
row
Specifies the 0-based rowcolumn
Specifies the 0-based columnstate
Specifies the checked/toggle state (0=off, 1=on)public void setCellStyle(BBjNumber row, BBjNumber column, BBjNumber style)
Sets the style of a cell
row
Specifies the 0-based rowcolumn
Specifies the 0-based columnstyle
Specifies grid style valuepublic void setCellText(BBjVector strings!)
Sets the text displayed in cells Sets the text for as many cells as there are strings in the BBjVector going from left to right. If there are more strings than cells, then the remaining strings are ignored. This method will begin at the currently selected cell. If there is no currently selected cell then it will start at cell (0, 0).
strings!
Specifies the vector that contains the text for the cellspublic void setCellText(BBjNumber row, BBjNumber column, BBjVector strings!)
Sets the text displayed in cells Sets the text for as many cells as there are strings in the BBjVector going from left to right, beginning at the specified start row and column. If there are more strings than cells, then the remaining strings are ignored. This method will begin at the currently selected cell. If there is no currently selected cell then it will start at cell (0, 0).
row
Specifies the 0-based rowcolumn
Specifies the 0-based columnstrings!
Specifies the vector that contains the text for the cellspublic void setCellText(BBjNumber row, BBjNumber column, BBjString text$)
Sets the text displayed in a cell
row
Specifies the 0-based rowcolumn
Specifies the 0-based columntext$
Specifies the text to display in the cellpublic void setCellVerticalAlignment(BBjNumber row, BBjNumber column, BBjNumber align)
Sets vertical alignment in a cell
row
Specifies the 0-based row of the cellcolumn
Specifies the 0-based column of the cellalign
Specifies the vertical alignment valuepublic void setClientEdge(boolean client!)
Sets the grid control to have a client (lowered) border
client
FALSE = No client border, TRUE = Client borderpublic void setColumnAlignment(BBjNumber column, BBjNumber align)
Sets the default horizontal alignment for a column
column
Specifies the 0-based columnalign
Specifies the horizontal alignment valuepublic void setColumnBackColor(BBjNumber column, BBjColor color!)
Sets the default background color of a column
column
Specifies the 0-based columncolor!
Specifies the colorpublic void setColumnEditable(BBjNumber column, BBjNumber editable)
Sets whether a column is editable Note: The QVGird is not editable, so this method has no effect.
column
Specifies the 0-based columneditable
Specifies whether the column is editablepublic void setColumnFont(BBjNumber column, BBjFont font!)
Sets the default font of a column
column
Specifies the 0-based columfont!
Specifies the fontpublic void setColumnForeColor(BBjNumber column, BBjColor color!)
Sets the default foreground color for a colum
column
Specifies the 0-based columncolor!
Specifies the colorpublic void setColumnGutter(BBjNumber pixels)
Sets the number of pixels separating the column header and the main grid area
pixels
Specifies the number of pixelspublic void setColumnHasQuery(BBjNumber column, BBjNumber hasQuery)
Specifies whether all cells in the specified column should have associated query buttons
column
Specifies the 0-based columnhasQuery
Specifies whether this column should have associated query buttonspublic void setColumnHeaderAlignment(BBjNumber align)
Sets the default column header horizontal alignment
align
Specifies the default cell alignment valuepublic void setColumnHeaderBackColor(BBjColor color!)
Sets the default background color of the column header
color!
Specifies the colorpublic void setColumnHeaderCellAlignment(BBjNumber column, BBjNumber align)
Sets the horizontal alignment for the column header cell
column
Specifies the 0-based columnalign
Specifies the cell horizontal alignment valuepublic void setColumnHeaderCellBackColor(BBjNumber column, BBjColor color!)
Sets the background color of a column header cell
column
color!
public void setColumnHeaderCellForeColor(BBjNumber column, BBjColor color!)
Sets the foreground color of a column header cell
column
Specifies the 0-based columncolor!
Specifies the colorpublic void setColumnHeaderCellIcon(BBjNumber imageListID, BBjNumber index, BBjNumber column)
Sets the icon in a column header cell
imageListID
Specifies the imagelist IDindex
Specifies the 0-based index at the icon in the image listcolumn
Specifies the 0-based columnpublic void setColumnHeaderCellImage(BBjNumber column, BBjImage image!)
Sets the image displayed in a column header cell
column
Specifies the 0-based columnimage!
Specifies the image to display in the cellpublic void setColumnHeaderCellStyle(BBjNumber column, BBjNumber style)
Sets the cell style used for a column header cell
column
Specifies the 0-based columnstyle
Specifies the cell style valuepublic void setColumnHeaderCellText(BBjNumber column, BBjString text$)
Sets the text to be displayed in a column header cell
column
Specifies the 0-based columntext$
Specifies the text to be displayed in the specified column header cellpublic void setColumnHeaderCellVerticalAlignment(BBjNumber column, BBjNumber align)
Sets the vertical alignment for a column header cell
column
Specifies the 0-based columnalign
Specifies the vertical alignment valuepublic void setColumnHeaderFont(BBjFont font!)
Sets the default font of the column header
font!
public void setColumnHeaderForeColor(BBjColor color!)
Sets the default foreground color of the column header
color!
public void setColumnHeaderHeight(BBjNumber height)
Sets the height of the column header
height
Specifies the height in pixelspublic void setColumnHeaderStyle(BBjNumber style)
Sets the style used by default for the column headers
style
Specifies default cell style valuepublic void setColumnHeaderText(BBjVector strings!)
Sets multiple column header cell text The first element will go in column 0, the second in column 1, etc., up to the lesser of the number of header columns or the number of strings in the vector.
strings!
Specifies a BBjVector containing the text for the column header cellspublic void setColumnHeaderVerticalAlignment(BBjNumber align)
Sets the default vertical alignment for the column header
align
Specifies the default vertical alignment valuepublic void setColumnListControl(BBjNumber column, BBjComboBox list!)
Sets a list control for a column so that each cell in the column will display as a list button when editing
column
Specifies the 0-based columnlist!
Specifies the BBjListButton or BBjListEdit control object to usepublic void setColumnListSelection(BBjNumber column, BBjNumber index, BBjNumber repaint)
Sets the selected index for the list control in the specified column
column
Specifies the 0-based columindex
Specifies the 0-based index to select in the listrepaint
Specifies whether to repaint the column to display selected indexpublic void setColumnMask(BBjNumber column, BBjString mask$)
Sets the default mask for all cells in a column
column
Specifies the 0-based columnmask$
Specifies the maskpublic void setColumnSortedByRelatedData(BBjNumber column, BBjNumber sortByRelated)
Specifies whether a particular column is to be sorted by related data rather than by the text in the cells
column
Specifies the 0-based column on which to sortsortByRelated
Indicates whether data should be sorted by related datapublic void setColumnStyle(BBjNumber column, BBjNumber style)
Sets the default style of a column in the grid
column
Specifies the 0-based columnstyle
Specifies the default style value for the columnpublic void setColumnUserSortable(BBjNumber column, BBjNumber sortable)
Causes the grid to sort a specified column when the user clicks in the header of that column
column
Specifies the 0-based columnsortable
Indicates whether user can sort the column by clicking in the headerpublic void setColumnVerticalAlignment(BBjNumber column, BBjNumber align)
Sets the default vertical alignment for all of the cells in a particular column
column
Specifies the 0-based columnalign
Specifies the vertical alignment valuepublic void setColumnVisible(BBjNumber column)
Sets a column in the grid to be visible
column
Specifies the 0-based columnpublic void setColumnWidth(BBjNumber column, BBjNumber width)
Sets the width of a column
column
Specifies the 0-based columnwidth
Specifies the width in pixelspublic void setCursor(int cursor!)
Sets the cursor style on the grid control
cursor
Specifies the cursor idpublic void setDebug(BBjNumber debug)
Sets the general debug flag and brings up the BBjSysConsole, if not running in BUI
Debug
boolean (0/1)public void setDefaultAlignment(BBjNumber align)
Sets the default horizontal alignment for all of the cells in the grid
align
Specifies the horizontal alignment valuepublic void setDefaultColumnText(BBjNumber col, BBjString text$)
Sets the default text that is displayed in a column
col
Specifies the 0-based columntext$
Specifies the default textpublic void setDefaultColumnWidth(BBjNumber width)
Sets the default width of all columns
width
Specifies the default column width in pixelspublic void setDefaultGridStyle(BBjNumber style)
Sets the default style of all the cells in the grid
style
Specifies the grid style valuepublic void setDefaultVerticalAlignment(BBjNumber align)
Sets the default vertical alignment for all of the cells in the grid
align
Specifies the vertical alignment valuepublic void setDragAccept(BBjNumber drag)
Sets whether the grid will accept drag and drop operations
drag
Specifies whether the grid will accept drag and drop operationspublic void setDragActions(BBjNumber actions)
Sets the available drag actions for the grid control
actions
Either the constant ACTION_NONE or the sum of one or more of the constants ACTION_MOVE, ACTION_COPY, and ACTION_LINKpublic void setDragEnabled(BBjNumber mode)
Sets whether the grid control should allow drag operations
mode
0 = Drag Drop disabled (default), 1 = Drag Drop enabledpublic void setDragType(BBjNumber row, BBjNumber column, BBjString type$)
Sets an optional type string that an individual grid cell advertises to potential drop targets when the grid acts as a drag source
row
Specifies the 0-based rowcolumn
Specifies the 0-based columntype$
Application-defined alphanumeric drag type stringpublic void setDragType(BBjNumber column, BBjString type$)
Sets an optional type string that an individual grid column advertises to potential drop targets when the grid acts as a drag source
column
Specifies the 0-based columntype$
Application-defined alphanumeric drag type stringpublic void setDragType(BBjString type$)
Sets an optional type string that the grid control advertises to potential drop targets when it acts as a drag source
type$
public void setDropActions(BBjNumber actions)
Sets the actions that will be allowed when the grid control acts as a drop target
actions
Either the constant ACTION_NONE or the sum of one or more of the constants ACTION_MOVE, ACTION_COPY, and ACTION_LINKpublic void setDropTypes(BBjNumber column, BBjVector types!)
Stipulates the types that an individual grid column is willing to accept from a drag source when the grid acts as a drop target. If no drop types are set, the grid will accept data of any type.
column
Specifies the 0-based columntypes!
A BBjVector containing any number of application-defined alphanumeric type stringspublic void setDropTypes(BBjNumber row, BBjNumber column, BBjVector types!)
Stipulates the types that an individual grid cell is willing to accept from a drag source when the grid acts as a drop target. If no drop types are set, the grid will accept data of any type.
row
Specifies the 0-based rowcolumn
Specifies the 0-based columntypes!
A BBjVector containing any number of application-defined alphanumeric type stringspublic void setDropTypes(BBjVector types!)
Sets the types that the grid control is willing to accept from a drag source when it acts as a drop target. If no drop types are set, it will accept data of any type.
types!
A BBjVector containing any number of application-defined alphanumeric type stringspublic void setEditable(BBjNumber editable)
Sets whether the cells in the grid are editable Note: The QVGrid is not editable, so this method has no effect.
editable
Specifies whether the cells in the grid are editablepublic void setEditClickCount(BBjNumber count)
Sets the number of mouse clicks needed to begin editing a cell Note: the QVGrid is not editable, so this method has no effect.
count
Number of mouse clickspublic void setEnabled(boolean enabled!)
Sets whether the grid control is to be enabled or disabled
enabled
TRUE = enable, FALSE = disablepublic void setEnterAsTab(BBjNumber enterAsTab)
Sets whether pressing [Enter] while focus is on the grid will be interpreted as though the user had pressed [Tab]
enterAsTab
Specifies whether the ENTER key should be interpreted as a TAB keypublic void setFitToGrid(BBjNumber fit)
Specifies whether to fit all columns into the displayed width of the grid
fit
Specifies an AUTO_RESIZE style value to apply to columns as the grid is resizedpublic void setFocusable(BBjNumber canFocus)
Sets whether the grid control can be focused
canFocus
0 = the control is not focusable, 1 = the control is focusablepublic void setFont(BBjFont font!)
Sets the font for the grid control
font!
Font to be used in the foreground (text)public void setForeColor(BBjColor color!)
Sets the foreground (text) color for the grid control
color!
The foreground colorpublic void setGridEditable(BBjNumber editable)
This method is deprecated. Use setEditable() instead. Note: The QVGrid is not editable, so this has no effect.
editable
setEditable()
public void setGrouped(boolean arg0!)
see BBjControl
public void setHasColumnHeader(BBjNumber hasHeader)
Sets whether the grid has a column header
hasHeader
Specifies whether the grid has a column headerpublic void setHasRowHeader(BBjNumber hasHeader)
Sets whether the grid has a row header
hasHeader
Specifies whether the grid has a row headerpublic void setHeaderSelection(BBjNumber select)
Sets whether a header cell will display as recessed if the row/column is selected
select
Specifies whether the header cell will display as recessed if the row/column is selectedpublic void setHighlightMethod(BBjNumber highlight)
Sets the selection highlight method
highlight
Specifies the highlight method to be usedpublic void setHorizontalCellSpacing(BBjNumber space)
Sets the amount of horizontal space between the columns
space
Specifies the amount of space in pixelspublic void setHorizontalLinesVisible(BBjNumber visible)
Sets whether the horizontal lines between the rows are to be visible
visible
Specifies whether the horizontal lines between the rows are to be visiblepublic void setHorizontalScrollable(BBjNumber scrollable)
Sets whether the horizontal scrollbar will appear if there are more columns than can be displayed in the visible area of the grid
scrollable
Specifies whether the grid is scrollable horizontallypublic void setHorizontalScrollBarAlways(BBjNumber always)
Sets whether to always show a horizontal scrollbar enabled using setHorizontalScrollable(), or to only show as needed
always
Specifies whether the horizontal scrollbar is always shownpublic void setInputNBeep(BBjNumber shouldBeep)
Determines whether InputN style cells will beep when the user enters an invalid character public void QVGrid.setInputNBeep(BBjNumber) throws BBjException
shouldBeep
Specifies whether InputN style cells should beep when incorrect data is enteredpublic void setInputNCommaCharacter(BBjString charString$)
Sets the 'thousands' replacement character for all InputN style grid cells
charString$
The first char of charString will be used as the 'thousands' characterpublic void setInputNDotCharacter(BBjString charString$)
Sets the decimal character for all InputN style grid cells
charString$
The first char of charString$ will be used as the decimal characterpublic void setInputNUseEditCommas(BBjNumber shouldUse)
Determines whether InputN style cells in the grid will display a character at each 'thousands' position
shouldUse
Indication of whether InputN style cells should display a character at each 'thousands' positionpublic void setInsertMode(BBjNumber shouldInsert)
Controls whether the editor is in insert mode Note: The QVGrid is not editable, so this method has no effect.
shouldInsert
Indicates whether editors should be placed in insert modepublic void setInterspace(BBjNumber param_0!)
Method setInterspace: Note: This method has been deprecated since BBj 5.0. Use setHorizontalCellSpacing().
BBjNumber
public void setLeftColumn(BBjNumber column)
Sets a column in the grid to be the left-most visible column
column
Specifies the 0-based columnpublic void setLineColor(BBjColor color!)
Sets the line color of the vertical and horizontal lines
color!
Specifies the colorpublic void setLocation(BBjNumber x!, BBjNumber y!)
Sets the location of the QVGrid component child window
x
Horizontal position in current unitsy
Vertical position in current unitspublic void setLongCue(String text!)
Sets the text that appears in the status bar when the mouse pointer hovers over the grid control
text$
Specifies the text that will appear in the status barpublic void setMainGridAlignment(BBjNumber align)
Sets the default horizontal alignment of the cells in the main part of the grid, i.e. not including any row or column headers.
align
Specifies the horizontal alignment valuepublic void setMainGridBackColor(BBjColor color!)
Sets the default background color of the grid
color!
Specifies the color as BBjColor objectpublic void setMainGridFont(BBjFont font!)
Sets the default font used in the grid
font!
Specifies the fontpublic void setMainGridForeColor(BBjColor color!)
Sets the default foreground color of the grid
color!
Specifies the colorpublic void setMainGridStripeColor(BBjColor color!)
Sets the background stripe color of the grid
color!
Specifies the colorpublic void setMainGridVerticalAlignment(BBjNumber align)
Sets the default vertical alignment of the cells in the main part of the grid, i.e. not including any row or column headers.
align
Specifies the vertical alignment valuepublic void setMaxColumns(BBjNumber max)
Sets the maximum number of columns allowed in the grid Note: In BBj 12.0 and higher, this method is deprecated as it is not necessary to set a maximum number of columns. Any calls to it will be ignored.
max
Specifies the maximum number of columnspublic void setMaxRows(BBjNumber max)
Sets the maximum number of rows allowed in the data set
max
Specifies the maximum number of rowspublic void setMouseCapture(BBjNumber capture)
Sets whether to capture mouse movement events
capture
Specifies whether to capture mouse movement eventspublic void setMultipleSelection(BBjNumber multiple)
Sets whether multiple cells/rows/columns can be selected
multiple
Specifies whether multiple cells/rows/columns can be selected, depending on the current selection modepublic void setName(String name!)
Sets the name of the grid control
name$
The name propertypublic void setNoEdge(boolean noEdge!)
Sets the grid control to have no border
noEdge
FALSE = Border, TRUE = No borderpublic void setNumColumns(BBjNumber columns)
Sets the number of columns in the grid
columns
Specifies the number of columnspublic void setNumRows(BBjNumber rows)
Sets the number of rows in the grid Note: The QVGrid sets the number of grid rows to be at most those that are visible, so this method has no influence.
rows
Specifies the number of rowspublic void setOpaque(boolean opaque!)
Sets the opaque property of the grid control
opaque
FALSE = Not opaque (transparent), TRUE = Opaquepublic void setPaging(BBjNumber page)
Sets whether the BBjGrid can be scrolled by paging Note: The QVGrid has its own paging logic, so this method has no effect
page
Specifies whether the grid can be scrolled by pagingpublic void setPagingAmount(BBjNumber lines)
Sets number of lines to scroll when scrolling by page Note: The QVGrid has its own paging logic, so this method has no effect
lines
Specifies the number of lines to scroll while paging is onpublic void setPopupMenu(BBjPopupMenu popupMenu!)
Binds a pre-existing popup menu to the grid control
popupMenu!
Specifies the popup menu to be bound to the grid controlpublic void setProcCallback(BBjNumber eventType, BBjString subRoutineName$)
Registers a legacy custom event callback routine for a specified 'processing' event
eventType
Event type for which the callback is to be registeredsubRoutineName$
Name of the subroutine to be called when the event is processed by the QVGridpublic void setProcCallback(BBjNumber eventType, CustomObject customObj!, BBjString methodName$)
Registers an object oriented custom event callback routine for a specified 'processing' event
eventType
Event type for which the callback is to be registeredcustomObj!
A CustomObject containing the method to be called when the event is processedmethodName$
The name of the method that is to be called when the event is processedpublic void setRaisedEdge(boolean raised!)
Sets the grid control to have a raised border
raised
FALSE = No raised border, TRUE = Raised borderpublic void setResultSet(ResultSet bcrs!)
Registers the underlying BASIS Components ResultSet
bcrs!
BASIS Components ResultSet objectpublic void setRowAlignment(BBjNumber row, BBjNumber align)
Sets the horizontal alignment of a row
row
Specifies the 0-based rowalign
Specifies the horizontal alignment valuepublic void setRowBackColor(BBjNumber row, BBjColor color!)
Sets the background color of a row
row
Specifies the 0-based rowcolor!
Specifies the background color as BBjColor objectpublic void setRowEditable(BBjNumber row, BBjNumber editable)
Sets whether a row is editable Note: The QVGrid is not editable, so this has no effect.
row
Specifies the 0-based roweditable
Specifies whether the row is editablepublic void setRowFont(BBjNumber row, BBjFont font!)
Sets the default font of a row
row
Specifies the 0-based rowfont!
Specifies the BBjFont objectpublic void setRowForeColor(BBjNumber row, BBjColor color!)
Sets the foreground color of a row
row
Specifies the 0-based rowcolor!
Specifies the foreground color as BBjColor objectpublic void setRowGutter(BBjNumber pixels)
Sets the number of pixels separating the row header and the main grid area
pixels
Specifies the number of pixelspublic void setRowHeaderAlignment(BBjNumber align)
Sets the default alignment of the row header
align
Horizontal alignment valuepublic void setRowHeaderBackColor(BBjColor color!)
Sets the default background color of the row header
color!
The default background color as BBjColor objectpublic void setRowHeaderCellAlignment(BBjNumber row, BBjNumber align)
Sets the alignment of a row header cell
row
Specifies the 0-based rowalign
Horizontal alignment valuepublic void setRowHeaderCellBackColor(BBjNumber row, BBjColor color!)
Sets the background color of a row header cell
row
Specifies the 0-based rowcolor!
Specifies the background color as BBjColor objectpublic void setRowHeaderCellForeColor(BBjNumber row, BBjColor color!)
Sets the foreground color of a row header cell
row
Specifies the 0-based rowcolor!
The foreground color as BBjColor objectpublic void setRowHeaderCellIcon(BBjNumber imageListID, BBjNumber index, BBjNumber row)
Sets the icon in a row header cell
imageListID
Specifies the imagelist IDindex
Specifies the 0-based index of the item in the image listrow
Specifies the 0-based rowpublic void setRowHeaderCellImage(BBjNumber row, BBjImage image!)
Sets the image displayed in a row header cell
row
Specifies the row of cell for which image is setimage!
Specifies the BBjImage object to display in the cellpublic void setRowHeaderCellStyle(BBjNumber row, BBjNumber style)
Sets the style of a row header cell
row
Specifies the 0-based rowstyle
Specifies the grid cell style for the specified row header cellpublic void setRowHeaderCellText(BBjNumber row, BBjString text$)
Sets the text to be displayed in a row header cell
row
Specifies the 0-based rowtext$
Text to be displayed in the specified row header cellpublic void setRowHeaderCellVerticalAlignment(BBjNumber row, BBjNumber align)
Sets the vertical alignment of the row header cell
row
Specifies the 0-based rowalign
Specifies the vertical alignment valuepublic void setRowHeaderFont(BBjFont font!)
Sets the default font of the row header
font!
Specifies the font as BBjFont objectpublic void setRowHeaderForeColor(BBjColor color!)
Sets the default foreground color of the row header
color!
The default foreground color as BBjColor objectpublic void setRowHeaderStyle(BBjNumber style)
Sets the style of the row header
style
Grid style for the row headerpublic void setRowHeaderText(BBjVector strings!)
Sets the row header text
strings!
Specifies the vector containing the text for the row header cellspublic void setRowHeaderVerticalAlignment(BBjNumber align)
Sets the vertical alignment of the row header
align
Vertical alignment valuepublic void setRowHeaderWidth(BBjNumber width)
Sets the width of the row header
width
Specifies the width for the row headerpublic void setRowHeight(BBjNumber height)
Sets the height of the rows in the grid Note: The QVGrid only uses this method signature, i.e. setRowHeight(int index, int height) is not offered.
height
Specifies the height in pixelspublic void setRowListener(BBjString listener$)
Registers row listener to CALL when processing a data row on its way to the grid
listener$
Program pathpublic void setRowListener(Object listener!)
Registers row listener object to invoke when processing a data row on its way to the grid
listener!
RowListener objectpublic void setRowStyle(BBjNumber row, BBjNumber style)
Sets the default style of a row
row
Specifies the 0-based rowstyle
Specifies the grid style valuepublic void setRowVerticalAlignment(BBjNumber row, BBjNumber align)
Sets the default vertical alignment for a row
row
Specifies the 0-based rowalign
Specifies the vertical alignment valuepublic void setRowVisible(BBjNumber row)
Sets a row to be visible in the grid If the row is not already visible, then it will be made the top row or made visible if on the last grid page.
row
Specifies the 0-based rowpublic void setScrollOutside(BBjNumber outside)
Sets whether the grid scrolls during a drag and drop operation when the mouse cursor is moved outside the bounds of the grid Note: The QVGrid handles scrolling itself, so this method has no effect.
outside
Specifies whether the grid should scrollpublic void setScrollUpdate(BBjNumber update)
Sets whether the grid updates the display of data in the cells while being scrolled Note: The QVGrid uses the default of "off", so this method has no effect.
update
Specifies whether the grid should update the displaypublic void setScrollWheelBehavior(BBjNumber mode)
Configures under what situations the grid control will respond to the mouse scroll wheel
mode
ScrollWheelBehavior response property (See MouseWheelEnabled for constants)public void setSelectedCell(BBjNumber row, BBjNumber col)
Selects a cell
row
Specifies the 0-based rowcol
Specifies the 0-based columnpublic void setSelectedColumn(BBjNumber column)
Selects a column
column
Specifies the 0-based columnpublic void setSelectedColumns(BBjVector selection!)
Selects multiple columns
selection!
Specifies a vector of 0-based columnspublic void setSelectedRow(BBjNumber row)
Selects a row
row
Specifies the 0-based rowpublic void setSelectedRows(BBjVector selections!)
Selects multiple rows in the grid
selections!
Specifies a vector of 0-based row numbers to be selectedpublic void setSelectionMode(BBjNumber mode)
Sets the method to select cells Note: The QVGrid always uses row selection (GRID_SELECT_ROW), so this method has no effect
mode
Specifies the selection mode valuepublic void setShortCue(String cue!)
Sets the text that appears above the grid control when the mouse pointer hovers over the control Note: Same as setToolTipText().
cue$
Specifies the text to be displayedpublic void setShouldHighlightSelectedColumn(BBjNumber should)
Sets whether the grid will highlight the entire column containing the currently selected cell
should
Indicates whether the grid should highlight the entire columnpublic void setShouldHighlightSelectedRow(BBjNumber should)
Sets whether the grid should highlight the entire row containing the currently selected cell
should
Indicates whether the grid should highlight the entire rowpublic void setShowMaskWhenRendering(BBjNumber show)
Controls whether the input style cells display decoration characters of their mask in non-edit mode Note: This method has been deprecated.
show
Specifies whether decoration characters will displaypublic void setSize(BBjNumber width!, BBjNumber height!)
Sets the size of the QVGrid component child window
width
Specifies the width in pixelsheight
Specifies the heigh in pixelspublic void setSnapToRowHeight(BBjNumber shouldSnap)
Sets whether the grid will adjust its height so that it does not display any partial rows Note: The QVGird always shows only complete rows, so this method has no effect.
shouldSnap
Specifies whether the grid should modify its size to show only complete rowspublic void setSortByMultipleColumns(BBjNumber sortByMultiple)
Sets whether a grid allows sorting by multiple columns
sortByMultiple
Specifies whether the grid is to sort by multiple columnspublic void setStartEditSelectionMode(BBjNumber mode)
Sets the selection mode that will be used when a cell is edited Note: The QVGrid is not editable, so this method as no effect.
mode
Specifies the selection modepublic void setStripeCount(BBjNumber count)
Sets the number of grid rows to alternate between the stripe color and the default background color
count
Specifies the number of rows to paint in each alternating background colorpublic void setStyle(String arg!, String style!)
see BBjControl
public void setTabAction(BBjNumber action)
Sets the current tab action of the grid
action
Grid tab action valuepublic void setTabActionSkipsNonEditableCells(BBjNumber skips)
When the user presses the [Tab] key while focus is on a grid cell, the focus will move based on the current "tab action" of the grid. If the program has called setTabActionSkipsNonEditableCells(TRUE) then the focus will skip any cells that are not editable. Note: The QVGrid is not editable, so this method has no effect.
skips
An indicator whether cells are to be skipped or not getTabAction ()
setTabAction ()
public void setTabTraversable(BBjNumber trav)
Sets a value indicating whether or not the user can navigate to the grid control using the tab key
trav
0 = navigation will pass over the control, 1 = navigation will stop at the controlpublic void setText(String text!)
Sets the control text for the grid control Note: The relevance of this method for a grid control is questionable, but provided for compatibility.
text$
The text to be displayed in the controlpublic void setToolTipText(BBjNumber row!, BBjNumber column!, BBjString text!)
Sets the tooltip text (also known as short cue) for a cell
row
Specifies the 0-based rowcolumn
Specifies the 0-based columntext$
Specifies the text to be displayed when the mouse pointer hovers over the cellpublic void setToolTipText(BBjNumber column!, BBjString text!)
Sets the tooltip text (also known as short cue) for a column
column
Specifies the 0-based columntext$
Specifies the text to be displayed when the mouse pointer hovers over the columnpublic void setToolTipText(String text!)
Sets the tooltip text (also known as short cue) for the grid control
text$
The tool tip textpublic void setTopRow(BBjNumber row)
Sets a row to be the top visible row or at least shown if on the last grid page.
row
Specifies the 0-based rowpublic void setTrimBlankSpace(BBjNumber shouldTrim)
When a grid is larger in size than the size required to display the data and all required headers and scrollbars, this method controls whether the grid will be trimmed to the minimum size to display everything.
shouldTrim
Indicator whether the grid should trim blank spacepublic void setUpdateCached(BBjNumber update)
Sets whether the grid sends table update notification events when cells already have data
update
Specifies whether the grid sends Table Update (Grid Notify Event 22) if the cells already have datapublic void setUserData(Object userData!)
Associates an object as user data with the grid control
userData!
Specifies the object to be associatedpublic void setUserResizable(BBjNumber resizable)
Sets whether the columns in the grid can be resized by the user
resizable
Specifies whether the columns in the grid are user resizablepublic void setVerticalCellSpacing(BBjNumber space)
Sets the amount of vertical space between the rows
space
Specifies the amount of space in pixelspublic void setVerticalLinesVisible(BBjNumber visible)
Sets whether the vertical lines between the columns are to be visible
visible
Specifies whether the vertical lines between the columns are to be visiblepublic void setVerticalScrollable(BBjNumber scrollable)
Sets whether the vertical scrollbar can be enabled if there are more rows than can be displayed in the visible rows of the grid Note: The QVGrid maintains a separate vertical scrollbar control. Setting 'scrollable' to 0 (false) here, disables the scrollbar.
scrollable
Specifies whether the the vertical scrollbar is scrollablepublic void setVerticalScrollBarAlways(BBjNumber always)
Sets whether to always show a vertical scrollbar enabled using setVerticalScrollable(), or to only show the vertical scrollbar as needed Note: The QVGrid maintains a separate vertical scrollbar control that is always visible, so this method has no effect.
always
Specifies whether the vertical scrollbar is always shownpublic void setVisible(boolean visible!)
Sets whether the QVGrid component child window is visible
visible
FALSE = invisible, TRUE = visiblepublic void showToolTipText(BBjNumber x!, BBjNumber y!)
Shows the tooltip text (also known as short cue) for the grid control
x
Horizontal position (in current units, relative to the control)y
Vertical position (in current units, relative to the control)public void showToolTipText()
Shows the tooltip text (also known as short cue) for the grid control
public void sortByColumn(BBjNumber column, BBjNumber sortOrder)
Sorts the grid by the content of a given column Note: This method has little effect with the QVGrid because the grid only contains at most the number of visible rows.
column
Specifies the 0-based columnsortOrder
Specifies the sort order valuepublic void startEdit(BBjNumber row, BBjNumber column)
Begins editing an editable cell in the grid Note: The QVGrid is not editable, so this method has no effect.
row
Specifies the 0-based rowcolumn
Specifies the 0-based columnpublic void suppressUpdatesWhileScrolling(BBjNumber shouldSuppress)
Suppresses update requests to the program while the user scrolls
shouldSuppress
Indication of whether to suppress updates during scrollingpublic void unsort()
Removes all sorting directives and displays the grid in its unsorted row order. This method is equivalent to unsort(TRUE, FALSE). Note: This method has little effect with the QVGrid because the grid only contains at most the number of visible rows.
public void unsort(BBjNumber revertAllSortByRelated, BBjNumber revertAllUserSortable)
Removes all sorting directives and displays the grid in its unsorted row order Note: This method has little effect with the QVGrid because the grid only contains at most the number of visible rows.
revertAllSortByRelated
revertAllUserSortable
public void vScrolled(BBjControlScrollEvent ev!)
Scroll event handler for the vertical scrollbar
ev!
Scroll event objectpublic void vScrollTimer(BBjTimerEvent ev!)
Scroll timer event handler
ev!
Timer event object