public class QVGrid extends Object
Constructor and Description |
---|
QVGrid(BBjWindow parentWin!,
BBjChildWindow compWin!)
Constructs QVGrid component on passed parent window in existing child window.
|
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.
|
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.
|
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.
|
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()
Ends any editing of the grid
Note: The QVGrid is not editable, so this method has no effect.
|
void |
endEdit(BBjNumber suppress)
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
|
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
|
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()
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
|
BBjString |
getDragType(BBjNumber column)
Returns the drag type that was set for a particular column in a previous call to setDragType()
|
BBjString |
getDragType(BBjNumber row,
BBjNumber column)
Returns the drag type that was set for a particular cell in a previous call to setDragType()
|
BBjNumber |
getDropActions()
Returns the actions that are currently available when dropping to the grid control.
|
BBjVector |
getDropTypes()
Returns the drop types that were set 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(BBjNumber row,
BBjNumber column)
Returns the drop types that were set for a particular cell 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.
|
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.
|
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.
|
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
|
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()
Returns the default height in pixels of the rows
|
BBjNumber |
getRowHeight(BBjNumber row)
Returns the height of a row in pixels
|
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
|
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.
|
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()
Returns the tooltip text (also known as short cue) for the grid control
|
BBjString |
getToolTipText(BBjNumber column!)
Returns the tooltip text (also known as short cue) for a column
|
BBjString |
getToolTipText(BBjNumber row!,
BBjNumber column!)
Returns the tooltip text (also known as short cue) for a cell
|
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.
|
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 |
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.
|
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!,
CustomObject customObj!,
String methodName!)
Registers an object oriented callback routine for a specified event in the grid
|
void |
setCallback(int eventType!,
String subRoutineName!)
Registers a legacy 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(BBjNumber row,
BBjNumber column,
BBjString text$)
Sets the text displayed in a cell
|
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.
|
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.
|
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 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.
|
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.
|
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.
|
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.
|
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.
|
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.
|
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.
|
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.
|
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.
|
void |
setRowListener(BBjString listener$)
Registers row listener to CALL 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 |
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.
|
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.
|
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()
Shows the tooltip text (also known as short cue) for the grid control
|
void |
showToolTipText(BBjNumber x!,
BBjNumber y!)
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.
|
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!)
parentWin!
- Parent windowcompWin!
- Component child windowpublic QVGrid(BBjWindow parentWin!, BBjNumber comp_id, BBjNumber comp_x, BBjNumber comp_y, BBjNumber comp_w, BBjNumber comp_h)
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)
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 rowSelected(BBjGridSelectRowEvent ev!)
ev!
- Select row event objectpublic void hitTop(BBjGridHitTopEvent ev!)
ev!
- Hit top event objectpublic void hitBottom(BBjGridHitBottomEvent ev!)
ev!
- Hit bottom event objectpublic void grdScrolled(BBjScrollWheelEvent ev!)
ev!
- Mouse scroll wheel event objectpublic void vScrolled(BBjControlScrollEvent ev!)
ev!
- Scroll event objectpublic void vScrollTimer(BBjTimerEvent ev!)
ev!
- Timer event objectpublic void scrollTo(BBjNumber pos)
pos
- position to scroll topublic void columnHeaderSelectColumn(BBjGridMouseUpEvent ev!)
ev!
- Grid Mouse Up event objectpublic void setResultSet(ResultSet bcrs!)
bcrs!
- BASIS Components ResultSet objectpublic void setRowListener(BBjString listener$)
listener$
- Program pathpublic void buildGrid()
public void loadGrid()
public BBjString getRowKey(BBjNumber row)
row
- Result set row number (0-based)public BBjString getRecordTemplate()
public BBjString getRecord()
public void setDebug(BBjNumber debug)
Debug
- boolean (0/1)public BBjString getRowHeaderCellText(BBjNumber row)
row
- Specifies the 0-based rowpublic void setRowHeaderCellText(BBjNumber row, BBjString text$)
row
- Specifies the 0-based rowtext$
- Text to be displayed in the specified row header cellpublic void setDefaultColumnText(BBjNumber col, BBjString text$)
col
- Specifies the 0-based columntext$
- Specifies the default textpublic BBjNumber getRowHeaderCellStyle(BBjNumber row)
row
- Specifies the 0-based rowpublic void setRowHeaderCellStyle(BBjNumber row, BBjNumber style)
row
- Specifies the 0-based rowstyle
- Specifies the grid cell style for the specified row header cellpublic BBjNumber getRowHeaderStyle()
public void setRowHeaderStyle(BBjNumber style)
style
- Grid style for the row headerpublic void setRowHeaderCellAlignment(BBjNumber row, BBjNumber align)
row
- Specifies the 0-based rowalign
- Horizontal alignment valuepublic BBjNumber getRowHeaderCellAlignment(BBjNumber row)
row
- Specifies the 0-based rowpublic BBjNumber getRowHeaderAlignment()
public void setRowHeaderAlignment(BBjNumber align)
align
- Horizontal alignment valuepublic BBjNumber getRowHeaderVerticalAlignment()
public void setRowHeaderVerticalAlignment(BBjNumber align)
align
- Vertical alignment valuepublic BBjComboBox getCellListControl(BBjNumber row, BBjNumber column)
row
- Specifies the 0-based rowcolumn
- Specifies the 0-based columnpublic void setCellListControl(BBjNumber row, BBjNumber column, BBjComboBox list!)
row
- Specifies the 0-based rowcolumn
- Specifies the 0-based columnlist!
- Specifies the BBjListButton or BBjListEdit control object to usepublic BBjComboBox getColumnListControl(BBjNumber column)
column
- Specifies the 0-based columnpublic void setColumnListControl(BBjNumber column, BBjComboBox list!)
column
- Specifies the 0-based columnlist!
- Specifies the BBjListButton or BBjListEdit control object to usepublic BBjNumber getColumnListSelection(BBjNumber column)
column
- public void setColumnListSelection(BBjNumber column, BBjNumber index, BBjNumber repaint)
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 BBjNumber getCellListSelection(BBjNumber row, BBjNumber column)
row
- column
- public void setCellListSelection(BBjNumber row, BBjNumber column, BBjNumber sel, BBjNumber repaint)
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 setCellVerticalAlignment(BBjNumber row, BBjNumber column, BBjNumber align)
row
- Specifies the 0-based row of the cellcolumn
- Specifies the 0-based column of the cellalign
- Specifies the vertical alignment valuepublic BBjDataAwareGrid convertToDataAware(BBjNumber channel, BBjString template$)
channel
- Specifies the data channeltemplate
- Specifies the template description string used to set the field propertiespublic void setRowHeaderCellIcon(BBjNumber imageListID, BBjNumber index, BBjNumber row)
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!)
row
- Specifies the row of cell for which image is setimage!
- Specifies the BBjImage object to display in the cellpublic BBjColor getRowHeaderCellBackColor(BBjNumber row)
row
- Specifies the 0-based rowpublic void setRowHeaderCellBackColor(BBjNumber row, BBjColor color!)
row
- Specifies the 0-based rowcolor!
- Specifies the background color as BBjColor objectpublic BBjColor getRowHeaderCellForeColor(BBjNumber row)
row
- Specifies the 0-based rowpublic void setRowHeaderCellForeColor(BBjNumber row, BBjColor color!)
row
- Specifies the 0-based rowcolor!
- The foreground color as BBjColor objectpublic BBjColor getRowHeaderBackColor()
public void setRowHeaderBackColor(BBjColor color!)
color!
- The default background color as BBjColor objectpublic BBjColor getRowHeaderForeColor()
public void setRowHeaderForeColor(BBjColor color!)
color!
- The default foreground color as BBjColor objectpublic BBjNumber getRowHeaderWidth()
public void setRowHeaderWidth(BBjNumber width)
width
- Specifies the width for the row headerpublic void setColumnSortedByRelatedData(BBjNumber column, BBjNumber sortByRelated)
column
- Specifies the 0-based column on which to sortsortByRelated
- Indicates whether data should be sorted by related datapublic BBjNumber isColumnSortedByRelatedData(BBjNumber column)
column
- Specifies the 0-based columnpublic void setColumnUserSortable(BBjNumber column, BBjNumber sortable)
column
- Specifies the 0-based columnsortable
- Indicates whether user can sort the column by clicking in the headerpublic BBjNumber isColumnUserSortable(BBjNumber column)
column
- Specifies the 0-based columnpublic void setAllColumnsUserSortable(BBjNumber sortable)
sortable
- Indicates whether the user can sort any column by clicking in the headerpublic BBjNumber getRowModelIndexFromViewIndex(BBjNumber index)
index
- The index of a row as the user sees itpublic BBjNumber getRowViewIndexFromModelIndex(BBjNumber index)
index
- The index of a row as the program sees itpublic BBjNumber getSortByMultipleColumns()
public void setSortByMultipleColumns(BBjNumber sortByMultiple)
sortByMultiple
- Specifies whether the grid is to sort by multiple columnspublic void setInputNDotCharacter(BBjString charString$)
charString$
- The first char of charString$ will be used as the decimal characterpublic BBjString getInputNDotCharacter()
public void setInputNCommaCharacter(BBjString charString$)
charString$
- The first char of charString will be used as the 'thousands' characterpublic BBjString getInputNCommaCharacter()
public void setInputNUseEditCommas(BBjNumber shouldUse)
shouldUse
- Indication of whether InputN style cells should display a character at each 'thousands' positionpublic BBjNumber getInputNUseEditCommas()
public void setColumnHasQuery(BBjNumber column, BBjNumber hasQuery)
column
- Specifies the 0-based columnhasQuery
- Specifies whether this column should have associated query buttonspublic BBjNumber getColumnHasQuery(BBjNumber column)
column
- Specifies the 0-based columnpublic void setDefaultGridStyle(BBjNumber style)
style
- Specifies the grid style valuepublic void insertRow(BBjNumber index)
index
- Specifies the 0-based index at which the row will be insertedpublic void setCellAlignment(BBjNumber row, BBjNumber column, BBjNumber align)
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!)
row
- Specifies the 0-based rowcolumn
- Specifies the 0-based columncolor!
- Specifies the background color as a BBjColor objectpublic void setCellForeColor(BBjNumber row, BBjNumber column, BBjColor color!)
row
- Specifies the 0-based rowcolumn
- Specifies the 0-based columncolor!
- Specifies the foreground color as a BBjColor objectpublic void setCellIcon(BBjNumber imageListID, BBjNumber index, BBjNumber row, BBjNumber column)
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 setCellStyle(BBjNumber row, BBjNumber column, BBjNumber style)
row
- Specifies the 0-based rowcolumn
- Specifies the 0-based columnstyle
- Specifies grid style valuepublic void setCellText(BBjVector strings!)
strings!
- Specifies the vector that contains the text for the cellspublic void setCellText(BBjNumber row, BBjNumber column, BBjVector strings!)
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$)
row
- Specifies the 0-based rowcolumn
- Specifies the 0-based columntext$
- Specifies the text to display in the cellpublic BBjNumber getHasRowHeader()
public void setHasRowHeader(BBjNumber hasHeader)
hasHeader
- Specifies whether the grid has a row headerpublic BBjNumber isCellEditable(BBjNumber row, BBjNumber column)
row
- Specifies the 0-based rowcolumn
- Specifies the 0-based columnpublic void setCellEditable(BBjNumber row, BBjNumber column, BBjNumber editable)
row
- Specifies the 0-based rowcolumn
- Specifies the 0-based columneditable
- Specifies the editability of the cellpublic void setCellData(BBjNumber row, BBjNumber column, BBjString text$, BBjString related$)
row
- Specifies the 0-based rowcolumn
- Specifies the 0-based columntext$
- Specifies the display textrelated$
- Specifies the related textpublic void setRowHeaderText(BBjVector strings!)
strings!
- Specifies the vector containing the text for the row header cellspublic BBjNumber getMaxRows()
public void setMaxRows(BBjNumber max)
max
- Specifies the maximum number of rowspublic void setNumRows(BBjNumber rows)
rows
- Specifies the number of rowspublic void setNumColumns(BBjNumber columns)
columns
- Specifies the number of columnspublic BBjNumber getMaxColumns()
public void setMaxColumns(BBjNumber max)
max
- Specifies the maximum number of columnspublic void setRowStyle(BBjNumber row, BBjNumber style)
row
- Specifies the 0-based rowstyle
- Specifies the grid style valuepublic void restoreCell(BBjNumber row, BBjNumber column)
row
- Specifies the 0-based rowcolumn
- Specifies the 0-based columnpublic void restoreRow(BBjNumber row)
row
- Specifies the 0-based rowpublic BBjString getCellRestore(BBjNumber row, BBjNumber column)
row
- Specifies the 0-based rowcolumn
- Specifies the 0-based columnpublic void setCellRestore(BBjNumber row, BBjNumber column, BBjString restore$)
row
- Specifies the 0-based rowcolumn
- Specifies the 0-based columnrestore$
- Specifies the restore valuepublic void setCellMask(BBjNumber row, BBjNumber column, BBjString mask$)
row
- Specifies the 0-based rowcolumn
- Specifies the 0-based columnmask$
- Specifies the maskpublic void clearGrid()
public void clearMainGrid()
public void insertColumn(BBjNumber index)
index
- Specifies the 0-based index at which the column will be insertedpublic void deleteColumn(BBjNumber column)
column
- Specifies the 0-based columnpublic BBjNumber getUpdateCached()
public void setUpdateCached(BBjNumber update)
update
- Specifies whether the grid sends Table Update (Grid Notify Event 22) if the cells already have datapublic void setCellState(BBjNumber row, BBjNumber column, BBjNumber state)
row
- Specifies the 0-based rowcolumn
- Specifies the 0-based columnstate
- Specifies the checked/toggle state (0 = off, 1 = on)public BBjFont getRowFont(BBjNumber row)
row
- Specifies the 0-based rowpublic void setRowFont(BBjNumber row, BBjFont font!)
row
- Specifies the 0-based rowfont!
- Specifies the BBjFont objectpublic void setRowBackColor(BBjNumber row, BBjColor color!)
row
- Specifies the 0-based rowcolor!
- Specifies the background color as BBjColor objectpublic void setRowForeColor(BBjNumber row, BBjColor color!)
row
- Specifies the 0-based rowcolor!
- Specifies the foreground color as BBjColor objectpublic void setCellFont(BBjNumber row, BBjNumber column, BBjFont font!)
row
- Specifies the 0-based rowcolumn
- Specifies the 0-based columnfont!
- Specifies the font as BBjFont objectpublic BBjFont getRowHeaderFont()
public void setRowHeaderFont(BBjFont font!)
font!
- Specifies the font as BBjFont objectpublic BBjString getCellRelated(BBjNumber row, BBjNumber column)
row
- Specifies the 0-based rowcolumn
- Specifies the 0-based columnpublic void setCellRelated(BBjNumber row, BBjNumber column, BBjString text$)
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!)
row
- Specifies the 0-based start rowcolumn
- Specifies the 0-based start columnstrings!
- Specifies the vector that contains the text for the cellspublic void setCellImage(BBjNumber row, BBjNumber column, BBjImage image!)
row
- Specifies the 0-based start rowcolumn
- Specifies the 0-based start columnimage!
- Image to display in the cellpublic void sortByColumn(BBjNumber column, BBjNumber sortOrder)
column
- Specifies the 0-based columnsortOrder
- Specifies the sort order valuepublic void resort()
public void unsort()
public void unsort(BBjNumber revertAllSortByRelated, BBjNumber revertAllUserSortable)
revertAllSortByRelated
- revertAllUserSortable
- public void setInputNBeep(BBjNumber shouldBeep)
shouldBeep
- Specifies whether InputN style cells should beep when incorrect data is enteredpublic BBjNumber getInputNBeep()
public void setCellHasQuery(BBjNumber row, BBjNumber column, BBjNumber hasQuery)
row
- Specifies the 0-based rowcolumn
- Specifies the 0-based columnhasQuery
- Specifies whether this cell has a query buttonpublic BBjNumber getCellHasQuery(BBjNumber row, BBjNumber column)
row
- Specifies the 0-based rowcolumn
- Specifies the 0-based columnpublic void setRowHeaderCellVerticalAlignment(BBjNumber row, BBjNumber align)
row
- Specifies the 0-based rowalign
- Specifies the vertical alignment valuepublic BBjNumber getRowHeaderCellVerticalAlignment(BBjNumber row)
row
- Specifies the 0-based rowpublic BBjNumber isGridEditable()
isEditable()
public void setGridEditable(BBjNumber editable)
editable
- setEditable()
public BBjNumber isRowEditable(BBjNumber row)
row
- Specifies the 0-based rowpublic void setRowEditable(BBjNumber row, BBjNumber editable)
row
- Specifies the 0-based roweditable
- Specifies whether the row is editablepublic void setSelectedCell(BBjNumber row, BBjNumber col)
row
- Specifies the 0-based rowcol
- Specifies the 0-based columnpublic void deleteRow(BBjNumber row)
row
- Specifies the 0-based rowpublic BBjGridHeader getRowHeader()
public void setDropTypes(BBjNumber column, BBjVector types!)
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!)
row
- Specifies the 0-based rowcolumn
- Specifies the 0-based columntypes!
- A BBjVector containing any number of application-defined alphanumeric type stringspublic BBjVector getDropTypes(BBjNumber row, BBjNumber column)
row
- Specifies the 0-based rowcolumn
- Specifies the 0-based columnpublic BBjVector getDropTypes(BBjNumber column)
column
- Specifies the 0-based columnpublic void setEditable(BBjNumber editable)
editable
- Specifies whether the cells in the grid are editablepublic BBjNumber isEditable()
public void setDragType(BBjNumber row, BBjNumber column, BBjString type$)
row
- Specifies the 0-based rowcolumn
- Specifies the 0-based columntype$
- Application-defined alphanumeric drag type stringpublic void setDragType(BBjNumber column, BBjString type$)
column
- Specifies the 0-based columntype$
- Application-defined alphanumeric drag type stringpublic BBjString getDragType(BBjNumber row, BBjNumber column)
row
- Specifies the 0-based rowcolumn
- Specifies the 0-based columnpublic BBjString getDragType(BBjNumber column)
column
- Specifies the 0-based columnpublic BBjNumber getColumnHeaderCellVerticalAlignment(BBjNumber column)
column
- Specifies the 0-based columnpublic void setColumnHeaderCellVerticalAlignment(BBjNumber column, BBjNumber align)
column
- Specifies the 0-based columnalign
- Specifies the vertical alignment valuepublic void setTabActionSkipsNonEditableCells(BBjNumber skips)
skips
- An indicator whether cells are to be skipped or not()
,
()
public BBjNumber getTabActionSkipsNonEditableCells()
public void setVerticalScrollable(BBjNumber scrollable)
scrollable
- Specifies whether the the vertical scrollbar is scrollablepublic BBjNumber getVerticalScrollable()
public void setVerticalScrollBarAlways(BBjNumber always)
always
- Specifies whether the vertical scrollbar is always shownpublic BBjNumber getVerticalScrollBarAlways()
public void setHorizontalScrollable(BBjNumber scrollable)
scrollable
- Specifies whether the grid is scrollable horizontallypublic BBjNumber getHorizontalScrollable()
public void setHorizontalScrollBarAlways(BBjNumber always)
always
- Specifies whether the horizontal scrollbar is always shownpublic BBjNumber getHorizontalScrollBarAlways()
public void setColumnEditable(BBjNumber column, BBjNumber editable)
column
- Specifies the 0-based columneditable
- Specifies whether the column is editablepublic BBjNumber getHasColumnHeader()
public void setHasColumnHeader(BBjNumber hasHeader)
hasHeader
- Specifies whether the grid has a column headerpublic BBjString getColumnHeaderCellText(BBjNumber column)
column
- Specifies the 0-based columnpublic void setColumnHeaderCellText(BBjNumber column, BBjString text$)
column
- Specifies the 0-based columntext$
- Specifies the text to be displayed in the specified column header cellpublic void setColumnHeaderText(BBjVector strings!)
strings!
- Specifies a BBjVector containing the text for the column header cellspublic BBjNumber getColumnHeaderCellStyle(BBjNumber column)
column
- Specifies the 0-based columnpublic void setColumnHeaderCellStyle(BBjNumber column, BBjNumber style)
column
- Specifies the 0-based columnstyle
- Specifies the cell style valuepublic BBjNumber getColumnHeaderStyle()
public void setColumnHeaderStyle(BBjNumber style)
style
- Specifies default cell style valuepublic BBjNumber getColumnHeaderCellAlignment(BBjNumber column)
column
- public void setColumnHeaderCellAlignment(BBjNumber column, BBjNumber align)
column
- Specifies the 0-based columnalign
- Specifies the cell horizontal alignment valuepublic BBjNumber getColumnHeaderAlignment()
public void setColumnHeaderAlignment(BBjNumber align)
align
- Specifies the default cell alignment valuepublic BBjNumber getColumnHeaderVerticalAlignment()
public void setColumnHeaderVerticalAlignment(BBjNumber align)
align
- Specifies the default vertical alignment valuepublic BBjNumber getColumnHeaderHeight()
public void setColumnHeaderHeight(BBjNumber height)
height
- Specifies the height in pixelspublic BBjNumber getDefaultColumnWidth()
public void setDefaultColumnWidth(BBjNumber width)
width
- Specifies the default column width in pixelspublic void fillGridWithColumns(BBjNumber fit)
fit
- Specifies whether to fit all columns into the displayed width of the gridpublic BBjNumber getColumnAlignment(BBjNumber column)
column
- public void setColumnAlignment(BBjNumber column, BBjNumber align)
column
- Specifies the 0-based columnalign
- Specifies the horizontal alignment valuepublic BBjNumber getRowVerticalAlignment(BBjNumber row)
row
- Specifies the 0-based rowpublic void setRowVerticalAlignment(BBjNumber row, BBjNumber align)
row
- Specifies the 0-based rowalign
- Specifies the vertical alignment valuepublic BBjNumber getMainGridAlignment()
public void setMainGridAlignment(BBjNumber align)
align
- Specifies the horizontal alignment valuepublic void setDefaultAlignment(BBjNumber align)
align
- Specifies the horizontal alignment valuepublic BBjNumber getColumnVerticalAlignment(BBjNumber column)
column
- Specifies the 0-based columnpublic void setColumnVerticalAlignment(BBjNumber column, BBjNumber align)
column
- Specifies the 0-based columnalign
- Specifies the vertical alignment valuepublic BBjNumber getMainGridVerticalAlignment()
public void setMainGridVerticalAlignment(BBjNumber align)
align
- Specifies the vertical alignment valuepublic void setDefaultVerticalAlignment(BBjNumber align)
align
- Specifies the vertical alignment valuepublic BBjNumber getSelectedColumn()
public void setSelectedColumn(BBjNumber column)
column
- Specifies the 0-based columnpublic BBjVector getSelectedColumns()
public void setSelectedColumns(BBjVector selection!)
selection!
- Specifies a vector of 0-based columnspublic void setMultipleSelection(BBjNumber multiple)
multiple
- Specifies whether multiple cells/rows/columns can be selected, depending on the current selection modepublic BBjNumber isMultipleSelectionAllowed()
public BBjNumber getHighlightMethod()
public void setHighlightMethod(BBjNumber highlight)
highlight
- Specifies the highlight method to be usedpublic BBjNumber getHeaderSelection()
public void setHeaderSelection(BBjNumber select)
select
- Specifies whether the header cell will display as recessed if the row/column is selectedpublic BBjNumber getHorizontalCellSpacing()
public void setHorizontalCellSpacing(BBjNumber space)
space
- Specifies the amount of space in pixelspublic BBjNumber getVerticalCellSpacing()
public void setVerticalCellSpacing(BBjNumber space)
space
- Specifies the amount of space in pixelspublic BBjNumber getHorizontalLinesVisible()
public void setHorizontalLinesVisible(BBjNumber visible)
visible
- Specifies whether the horizontal lines between the rows are to be visiblepublic BBjNumber getVerticalLinesVisible()
public void setVerticalLinesVisible(BBjNumber visible)
visible
- Specifies whether the vertical lines between the columns are to be visiblepublic BBjNumber getVisibleRowCount()
public BBjNumber getEditClickCount()
public void setEditClickCount(BBjNumber count)
count
- Number of mouse clickspublic BBjColor getMainGridBackColor()
public void setMainGridBackColor(BBjColor color!)
color!
- Specifies the color as BBjColor objectpublic BBjColor getMainGridStripeColor()
public void setMainGridStripeColor(BBjColor color!)
color!
- Specifies the colorpublic BBjColor getColumnBackColor(BBjNumber column)
column
- Specifies the 0-based columnpublic void setColumnBackColor(BBjNumber column, BBjColor color!)
column
- Specifies the 0-based columncolor!
- Specifies the colorpublic BBjColor getMainGridForeColor()
public void setMainGridForeColor(BBjColor color!)
color!
- Specifies the colorpublic BBjColor getColumnForeColor(BBjNumber column)
column
- Specifies the 0-based columnpublic void setColumnForeColor(BBjNumber column, BBjColor color!)
column
- Specifies the 0-based columncolor!
- Specifies the colorpublic BBjColor getColumnHeaderCellBackColor(BBjNumber column)
column
- public void setColumnHeaderCellBackColor(BBjNumber column, BBjColor color!)
column
- color!
- public BBjColor getColumnHeaderCellForeColor(BBjNumber column)
column
- Specifies the 0-based columnpublic void setColumnHeaderCellForeColor(BBjNumber column, BBjColor color!)
column
- Specifies the 0-based columncolor!
- Specifies the colorpublic BBjColor getColumnHeaderBackColor()
public void setColumnHeaderBackColor(BBjColor color!)
color!
- Specifies the colorpublic BBjColor getColumnHeaderForeColor()
public void setColumnHeaderForeColor(BBjColor color!)
color!
- public BBjFont getColumnHeaderFont()
public void setColumnHeaderFont(BBjFont font!)
font!
- public void setColumnHeaderCellIcon(BBjNumber imageListID, BBjNumber index, BBjNumber column)
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!)
column
- Specifies the 0-based columnimage!
- Specifies the image to display in the cellpublic void suppressUpdatesWhileScrolling(BBjNumber shouldSuppress)
shouldSuppress
- Indication of whether to suppress updates during scrollingpublic void adjustSpacesWhenDisplaying(BBjNumber column, BBjNumber stripLeading, BBjNumber stripTrailing, BBjNumber collapseMultipleSpaces, BBjNumber removeAllSpaces)
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)
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 doLowerCaseWhenDisplaying(BBjNumber column)
column
- The column to affectpublic void doLowerCaseWhenSaving(BBjNumber column)
column
- The column to affectpublic void doUpperCaseWhenDisplaying(BBjNumber column)
column
- The column to affectpublic void doUpperCaseWhenSaving(BBjNumber column)
column
- The column to affectpublic BBjNumber getBeepOnValidationFailure()
public void setBeepOnValidationFailure(BBjNumber shouldBeep)
shouldBeep
- Indicates whether the grid should beeppublic BBjNumber getShouldHighlightSelectedRow()
public void setShouldHighlightSelectedRow(BBjNumber should)
should
- Indicates whether the grid should highlight the entire rowpublic BBjNumber getShouldHighlightSelectedColumn()
public void setShouldHighlightSelectedColumn(BBjNumber should)
should
- Indicates whether the grid should highlight the entire columnpublic void setSnapToRowHeight(BBjNumber shouldSnap)
shouldSnap
- Specifies whether the grid should modify its size to show only complete rowspublic BBjNumber getSnapToRowHeight()
public void setShowMaskWhenRendering(BBjNumber show)
show
- Specifies whether decoration characters will displaypublic BBjNumber getShowMaskWhenRendering()
public BBjNumber getCellVerticalAlignment(BBjNumber row, BBjNumber column)
row
- Specifies the 0-based rowcolumn
- Specifies the 0-based columnpublic BBjNumber getStartEditSelectionMode()
public void setTrimBlankSpace(BBjNumber shouldTrim)
shouldTrim
- Indicator whether the grid should trim blank spacepublic BBjNumber getTrimBlankSpace()
public void setStartEditSelectionMode(BBjNumber mode)
mode
- Specifies the selection modepublic void removeCellStyleName(BBjNumber row, BBjNumber column, BBjString styleName$)
row
- Specifies the 0-based row numbercolumn
- Specifies the 0-based column numberstyleName$
- Specifies the style name to remove from the grid cellpublic void clearCellStyleNames(BBjNumber row, BBjNumber column)
row
- Specifies the 0-based row numbercolumn
- Specifies the 0-based column numberpublic BBjVector getCellStyleNames(BBjNumber row, BBjNumber column)
row
- Specifies the 0-based row numbercolumn
- Specifies the 0-based column numberpublic void removeRowStyleName(BBjNumber row, BBjString styleName$)
row
- Specifies the 0-based row numberstyleName$
- Specifies the style name to remove from the grid rowpublic void clearRowStyleNames(BBjNumber row)
row
- Specifies the 0-based row numberpublic void addColumnStyleName(BBjNumber column, BBjString styleName$)
column
- Specifies the column numberstyleName$
- Specifies the style name to add to the grid columnpublic void removeColumnStyleName(BBjNumber column, BBjString styleName$)
column
- Specifies the column numberstyleName$
- Specifies the style name to remove from the grid columnpublic void clearColumnStyleNames(BBjNumber column)
column
- Specifies the column numberpublic BBjVector getColumnStyleNames(BBjNumber column)
column
- Specifies the column numberpublic BBjNumber isEnterAsTab()
public void setEnterAsTab(BBjNumber enterAsTab)
enterAsTab
- Specifies whether the ENTER key should be interpreted as a TAB keypublic BBjNumber isPaging()
public void setPaging(BBjNumber page)
page
- Specifies whether the grid can be scrolled by pagingpublic BBjNumber getPagingAmount()
public void setPagingAmount(BBjNumber lines)
lines
- Specifies the number of lines to scroll while paging is onpublic void scrollToBottom()
public BBjNumber isEditing()
public BBjNumber isColumnEditable(BBjNumber column)
column
- Specifies the 0-based columnpublic BBjNumber isUserResizable()
public void setUserResizable(BBjNumber resizable)
resizable
- Specifies whether the columns in the grid are user resizablepublic BBjString getCellText(BBjNumber row, BBjNumber column)
row
- Specifies the 0-based rowcolumn
- Specifies the 0-based columnpublic BBjNumber getColumnWidth(BBjNumber column)
column
- Specifies the columnpublic BBjVector getColumnWidths()
public void setColumnWidth(BBjNumber column, BBjNumber width)
column
- Specifies the 0-based columnwidth
- Specifies the width in pixelspublic void setFitToGrid(BBjNumber fit)
fit
- Specifies an AUTO_RESIZE style value to apply to columns as the grid is resizedpublic BBjNumber isFitToGrid()
public BBjNumber getRowAlignment(BBjNumber row)
row
- Specifies the 0-based rowpublic void setRowAlignment(BBjNumber row, BBjNumber align)
row
- Specifies the 0-based rowalign
- Specifies the horizontal alignment valuepublic BBjString getColumnMask(BBjNumber column)
column
- Specifies the 0-based columnpublic void setColumnMask(BBjNumber column, BBjString mask$)
column
- Specifies the 0-based columnmask$
- Specifies the maskpublic BBjNumber getSelectedRow()
public void setSelectedRow(BBjNumber row)
row
- Specifies the 0-based rowpublic BBjVector getSelectedRows()
public void setSelectedRows(BBjVector selections!)
selections!
- Specifies a vector of 0-based row numbers to be selectedpublic void deselectAllCells()
public BBjNumber getSelectionMode()
public void setSelectionMode(BBjNumber mode)
mode
- Specifies the selection mode valuepublic BBjNumber getDragAccept()
public void setDragAccept(BBjNumber drag)
drag
- Specifies whether the grid will accept drag and drop operationspublic BBjNumber getScrollUpdate()
public void setScrollUpdate(BBjNumber update)
update
- Specifies whether the grid should update the displaypublic BBjNumber getScrollOutside()
public void setScrollOutside(BBjNumber outside)
outside
- Specifies whether the grid should scrollpublic BBjNumber getInterspace()
public void setInterspace(BBjNumber param_0!)
BBjNumber
- public void moveToNextCell()
public BBjNumber getTopRow()
public void setTopRow(BBjNumber row)
row
- Specifies the 0-based rowpublic BBjNumber getBottomRow()
public BBjNumber isRowVisible(BBjNumber row)
row
- Specifies the 0-based rowpublic void setRowVisible(BBjNumber row)
row
- Specifies the 0-based rowpublic BBjNumber getLeftColumn()
public void setLeftColumn(BBjNumber column)
column
- Specifies the 0-based columnpublic BBjNumber isColumnVisible(BBjNumber column)
column
- Specifies the 0-based columnpublic void setColumnVisible(BBjNumber column)
column
- Specifies the 0-based columnpublic BBjNumber getStringWidth(BBjString text$)
text$
- Specifies the text stringpublic void setMouseCapture(BBjNumber capture)
capture
- Specifies whether to capture mouse movement eventspublic BBjNumber getStripeCount()
public void setStripeCount(BBjNumber count)
count
- Specifies the number of rows to paint in each alternating background colorpublic BBjColor getLineColor()
public void setLineColor(BBjColor color!)
color!
- Specifies the colorpublic BBjFont getMainGridFont()
public void setMainGridFont(BBjFont font!)
font!
- Specifies the fontpublic void setColumnFont(BBjNumber column, BBjFont font!)
column
- Specifies the 0-based columfont!
- Specifies the fontpublic BBjFont getColumnFont(BBjNumber column)
column
- Specifies the 0-based columnpublic BBjNumber getNumColumns()
public BBjNumber getNumRows()
public BBjNumber getRowHeight(BBjNumber row)
row
- Specifies the 0-based rowpublic BBjNumber getRowHeight()
public void setRowHeight(BBjNumber height)
height
- Specifies the height in pixelspublic BBjString getEditText()
public BBjGridHeader getColumnHeader()
public void setInsertMode(BBjNumber shouldInsert)
shouldInsert
- Indicates whether editors should be placed in insert modepublic BBjNumber getInsertMode()
public void setRowGutter(BBjNumber pixels)
pixels
- Specifies the number of pixelspublic BBjNumber getRowGutter()
public void setColumnGutter(BBjNumber pixels)
pixels
- Specifies the number of pixelspublic BBjNumber getColumnGutter()
public void setTabAction(BBjNumber action)
action
- Grid tab action valuepublic BBjNumber getTabAction()
public BBjColor getCellBackColor(BBjNumber row, BBjNumber column)
row
- Specifies the 0-based rowcolumn
- Specifies the 0-based columnpublic BBjColor getCellForeColor(BBjNumber row, BBjNumber column)
row
- Specifies the 0-based rocolumn
- Specifies the 0-based columnpublic BBjNumber getCellStyle(BBjNumber row, BBjNumber column)
row
- Specifies the 0-based rocolumn
- Specifies the 0-based columnpublic BBjNumber getCellAlignment(BBjNumber row, BBjNumber column)
row
- Specifies the 0-based rowcolumn
- Specifies the 0-based columnpublic BBjString getCellMask(BBjNumber row, BBjNumber column)
row
- Specifies the 0-based rowcolumn
- Specifies the 0-based columnpublic BBjNumber getCellState(BBjNumber row, BBjNumber column)
row
- Specifies the 0-based rowcolumn
- Specifies the 0-based columnpublic BBjFont getCellFont(BBjNumber row, BBjNumber column)
row
- Specifies the 0-based rowcolumn
- Specifies the 0-based columnpublic BBjNumber isDataAware()
public BBjNumber isDataBound()
public void addCellStyleName(BBjNumber row, BBjNumber column, BBjString styleName$)
row
- Specifies the row numbercolumn
- Specifies the column numberstyleName$
- Specifies the style name to add to the grid cellpublic void addRowStyleName(BBjNumber row, BBjString styleName$)
row
- Specifies the row numberstyleName$
- Specifies the style name to add to the grid rowpublic BBjVector getRowStyleNames(BBjNumber row)
row
- Specifies the row numberpublic void setToolTipText(BBjNumber row!, BBjNumber column!, BBjString text!)
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!)
column
- Specifies the 0-based columntext$
- Specifies the text to be displayed when the mouse pointer hovers over the columnpublic BBjString getToolTipText(BBjNumber row!, BBjNumber column!)
row
- Specifies the 0-based rowcolumn
- Specifies the 0-based columnpublic BBjString getToolTipText(BBjNumber column!)
column
- Specifies the 0-based columnpublic BBjString getName()
public void destroy()
public void setName(String name!)
name$
- The name propertypublic BBjNumber isDestroyed()
public BBjNumber isOpaque()
public void setSize(BBjNumber width!, BBjNumber height!)
width
- Specifies the width in pixelsheight
- Specifies the heigh in pixelspublic BBjNumber getID()
public BBjStandardGrid getGrid()
public Object getUserData()
public void setUserData(Object userData!)
userData!
- Specifies the object to be associatedpublic void setAttribute(String attribute!, String value!)
attribute$
- Specifies an attribute to be setvalue$
- Specifies the value of the attributepublic BBjNumber isEnabled()
public BBjFont getFont()
public BBjString getAttribute(String attribute!)
attribute$
- Specifies an attribute to be retrieved from the controlpublic BBjNumber isVisible()
public void setCursor(int cursor!)
cursor
- Specifies the cursor idpublic void setEnabled(boolean enabled!)
enabled
- TRUE = enable, FALSE = disablepublic void setFont(BBjFont font!)
font!
- Font to be used in the foreground (text)public void setLocation(BBjNumber x!, BBjNumber y!)
x
- Horizontal position in current unitsy
- Vertical position in current unitspublic BBjNumber getHeight()
public BBjNumber getWidth()
public BBjNumber getX()
public BBjNumber getY()
public void setText(String text!)
text$
- The text to be displayed in the controlpublic void setVisible(boolean visible!)
visible
- FALSE = invisible, TRUE = visiblepublic void setCallback(int eventType!, String subRoutineName!)
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!)
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 setProcCallback(BBjNumber eventType, BBjString subRoutineName$)
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$)
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 clearCallback(int eventType!)
eventType
- Event type for which the callback is to be unregisteredpublic void clearProcCallback(BBjNumber eventType)
eventType
- Event type for which the custom event callback is to be unregisteredpublic BBjNumber getContextID()
public BBjPopupMenu addPopupMenu()
public void setPopupMenu(BBjPopupMenu popupMenu!)
popupMenu!
- Specifies the popup menu to be bound to the grid controlpublic BBjPopupMenu getPopupMenu()
public void removePopupMenu()
public BBjString getText()
public BBjColor getBackColor()
public void setBackColor(BBjColor color!)
color!
- The background colorpublic void setForeColor(BBjColor color!)
color!
- The foreground colorpublic BBjColor getForeColor()
public void setToolTipText(String text!)
text$
- The tool tip textpublic BBjString getToolTipText()
public void showToolTipText(BBjNumber x!, BBjNumber y!)
x
- Horizontal position (in current units, relative to the control)y
- Vertical position (in current units, relative to the control)public void showToolTipText()
public void setShortCue(String cue!)
cue$
- Specifies the text to be displayedpublic BBjString getShortCue()
public void setLongCue(String text!)
text$
- Specifies the text that will appear in the status barpublic BBjString getLongCue()
public BBjNumber getScreenX()
public BBjNumber getScreenY()
public void setClientEdge(boolean client!)
client
- FALSE = No client border, TRUE = Client borderpublic BBjNumber getClientEdge()
public void setRaisedEdge(boolean raised!)
raised
- FALSE = No raised border, TRUE = Raised borderpublic BBjNumber getRaisedEdge()
public void setNoEdge(boolean noEdge!)
noEdge
- FALSE = Border, TRUE = No borderpublic BBjNumber getNoEdge()
public void setOpaque(boolean opaque!)
opaque
- FALSE = Not opaque (transparent), TRUE = Opaquepublic void focus()
public BBjNumber getControlType()
public BBjNumber addStyle(String styleName!)
styleName$
- Specifies a style name to be added to the controlpublic BBjNumber removeStyle(String styleName!)
styleName$
- Specifies a style name to be removed from the controlpublic void clearStyles()
public BBjVector getStyles()
public void setCausesControlValidation(boolean causesValidation!)
causesValidation
- FALSE = Entering this control should not cause control validation, TRUE = Entering this control should cause control validationpublic BBjNumber getCausesControlValidation()
public BBjNumber isFocusable()
public void setFocusable(BBjNumber canFocus)
canFocus
- 0 = the control is not focusable, 1 = the control is focusablepublic BBjNumber isTabTraversable()
public void setTabTraversable(BBjNumber trav)
trav
- 0 = navigation will pass over the control, 1 = navigation will stop at the controlpublic BBjString getValidationText()
public void accept(BBjNumber valid)
valid
- 0 = Invalid; focus may not leave the control, 1 = Valid; focus may leave the controlpublic void setScrollWheelBehavior(BBjNumber mode)
mode
- ScrollWheelBehavior response property (See MouseWheelEnabled for constants)public BBjNumber getScrollWheelBehavior()
public void setDragEnabled(BBjNumber mode)
mode
- 0 = Drag Drop disabled (default), 1 = Drag Drop enabledpublic BBjNumber getDragEnabled()
public void setDragActions(BBjNumber actions)
actions
- Either the constant ACTION_NONE or the sum of one or more of the constants ACTION_MOVE, ACTION_COPY, and ACTION_LINKpublic BBjNumber getDragActions()
public void setDragType(BBjString type$)
type$
- public BBjString getDragType()
public void setDropActions(BBjNumber actions)
actions
- Either the constant ACTION_NONE or the sum of one or more of the constants ACTION_MOVE, ACTION_COPY, and ACTION_LINKpublic BBjNumber getDropActions()
public void setDropTypes(BBjVector types!)
types!
- A BBjVector containing any number of application-defined alphanumeric type stringspublic BBjVector getDropTypes()
public void endEdit(BBjNumber suppress)
suppress
- Specifies whether to suppress the EDIT KILL eventpublic void endEdit()
public void startEdit(BBjNumber row, BBjNumber column)
row
- Specifies the 0-based rowcolumn
- Specifies the 0-based columnpublic BBjNumber getDefaultGridStyle()
public BBjNumber getColumnStyle(BBjNumber column)
column
- Specifies the 0-based columnpublic void setColumnStyle(BBjNumber column, BBjNumber style)
column
- Specifies the 0-based columnstyle
- Specifies the default style value for the column