$image\bbj40.gif$ BBjGrid

Description

In BBj 7.0 and higher, the BBjGrid is the abstract base class for BBjStandardGrid, BBjDataAwareGrid and BBjDataBoundGrid. BBjGrid contains the methods that are common to BBjStandardGrid, BBjDataAwareGrid, and BBjDataBoundGrid.

Implemented Interfaces

Focusable, MouseWheelEnabled, TabTraversable

Methods of BBjGrid – Drag and Drop

Return Value	Method
string	getDragType(int column)
string	getDragType(int row, int column)
BBjVector	getDropTypes(int column)
BBjVector	getDropTypes(int row, int column)
void	setDragType(int column, string type)
void	setDragType(int row, int column, string type)
void	setDropTypes(int column, BBjVector types)
void	setDropTypes(int row, int column, BBjVector types)

Methods of BBjGrid – Grid Headers

Return Value	Method
int	getColumnGutter()
BBjGridHeader	getColumnHeader()
int	getHasColumnHeader()
void	setColumnGutter(int gutter)
void	setHasColumnHeader(int header)

Methods of BBjGrid – Grid Rows and Columns

Return Value	Method
void	adjustSpacesWhenDisplaying(int p_column, boolean p_stripLeading, boolean p_stripTrailing, boolean p_collapseMultipleSpaces, boolean p_removeAllSpaces)
void	adjustSpacesWhenSaving(int p_column, boolean p_stripLeading, boolean p_stripTrailing, boolean p_collapseMultipleSpaces, boolean p_removeAllSpaces)
void	doLowerCaseWhenDisplaying(int column)
void	doLowerCaseWhenSaving(int column)
void	doUpperCaseWhenDisplaying(int column)
void	doUpperCaseWhenSaving(int column)
void	fillGridWithColumns(int fit)
int	getBottomRow()
int	getDefaultColumnWidth()
int	getColumnHeaderHeight()
int	getColumnWidth(int column)
int	getHorizontalCellSpacing()
int	getHorizontalLinesVisible()
int	getInterspace() – deprecated, use getHorizontalCellSpacing
int	getLeftColumn()
int	getNumColumns()
int	getNumRows()
int	getRowHeight()
int	getRowHeight(int row)
int	getShouldHighlightSelectedRow()
int	getTopRow()
int	getVerticalCellSpacing()
int	getVerticalLinesVisible()
int	getVisibleRowCount()
int	isColumnVisible(int column)
int	isFitToGrid()
int	isRowVisible(int row)
int	isUserResizable()
void	replaceCommasWhenDisplaying(int column, string valueString)
void	replaceCommasWhenSaving(int column, string valueString)
void	replaceDecimalsWhenDisplaying(int column, string valueString)
void	replaceDecimalsWhenSaving(int column, string valueString)
void	setColumnHeaderHeight(int height)
void	setColumnWidth(int column, int width)
void	setColumnVisible(int column)
void	setDefaultColumnWidth(int width)
void	setFitToGrid(int fit)
void	setHorizontalCellSpacing(int spacing)
void	setHorizontalLinesVisible(int visible)
void	setInterspace(int interspace) – deprecated, use setHorizontalCellSpacing
void	setLeftColumn(int column)
void	setMouseCapture(boolean capture)
void	setRowHeight(int height)
void	setRowHeight (int row, int height)
void	setRowVisible(int row)
void	setShouldHighlightSelectedRow(int should)
void	setTopRow(int row)
void	setUserResizable(int resize)
void	setVerticalCellSpacing(int spacing)
void	setVerticalLinesVisible(int visible)

Methods of BBjGrid – Grid Scrolling

Return Value	Method
int	getHorizontalScrollable()
int	getHorizontalScrollBarAlways()
int	getPagingAmount()
int	getScrollOutside()
int	getScrollUpdate()
int	getVerticalScrollable()
int	getVerticalScrollBarAlways()
int	isPaging()
void	scrollToBottom()
void	setHorizontalScrollable(int scroll)
void	setHorizontalScrollBarAlways(int always)
void	setPaging(int page)
void	setPagingAmount(int lines)
void	setScrollOutside(int outside)
void	setScrollUpdate(int update)
void	setVerticalScrollable(int scroll)
void	setVerticalScrollBarAlways(int always)
void	suppressUpdatesWhileScrolling(int suppress)

Methods of BBjGrid – Grid Cell Contents

Return Value	Method
string	getCellText(int row, int column)
string	getColumnHeaderCellText(int column)
string	getColumnMask(int column)
int	getInsertMode()
boolean	getShowMaskWhenRendering() – deprecated in BBj 7.0
void	setInsertMode(int mode)
void	setColumnHeaderCellText(int column, string text)
void	setColumnHeaderText(BBjVector strings!)
void	setColumnMask(int column, string mask)
void	getShowMaskWhenRendering(int shouldShow) – deprecated in BBj 7.0

Methods of BBjGrid – Grid Cell Editing

Return Value	Method
int	getEditClickCount()
string	getEditText()
int	isColumnEditable(int column)
int	isEditable()
void	setColumnEditable(int column, int editable)
void	setEditClickCount(int count)
void	setEditable(int editable)

Methods of BBjGrid – Grid Cell Style

Return Value	Method
int	getColumnHeaderCellStyle(int column)
int	getColumnHeaderStyle()
void	setColumnHeaderCellStyle(int column, int style)
void	setColumnHeaderStyle(int style)

Methods of BBjGrid – Grid Cell Alignment

Return Value	Method
int	getColumnAlignment(int column)
int	getColumnHeaderAlignment()
int	getColumnHeaderCellAlignment(int column)
int	getColumnHeaderCellVerticalAlignment(int align)
int	getColumnHeaderVerticalAlignment()
int	getMainGridAlignment()
int	getMainGridVerticalAlignment()
void	setColumnAlignment(int column, int align)
void	setColumnHeaderAlignment(int align)
void	setColumnHeaderCellAlignment(int column, int align)
void	setColumnHeaderCellVerticalAlignment(int column, int align)
void	setColumnHeaderVerticalAlignment(int align)
void	setDefaultAlignment(int align)
void	setMainGridAlignment(int align)
void	setMainGridVerticalAlignment(int align)

Methods of BBjGrid – Grid Cell Selection

Return Value	Method
void	deselectAllCells()
int	getHeaderSelection()
int	getHighlightMethod()
int	getSelectedColumn()
BBjVector	getSelectedColumns()
int	getSelectedRow()
BBjVector	getSelectedRows()
int	getSelectionMode()
int	getTabAction()
int	getTabActionSkipsNonEditableCells()
int	isMultipleSelectionAllowed()
void	moveToNextCell()
void	setHeaderSelection(int select)
void	setHighlightMethod(int highlight)
void	setMultipleSelection(int multiple)
void	setSelectedCell(int row, int column)
void	setSelectedColumn(int column)
void	setSelectedRow(int row)
void	setSelectionMode(int mode)
void	setTabAction(int action)
void	setTabActionSkipsNonEditableCells(int skips)

Methods of BBjGrid – Grid Colors

Return Value	Method
BBjColor	getColumnBackColor(int column)
BBjColor	getColumnForeColor(int column)
BBjColor	getColumnHeaderBackColor()
BBjColor	getColumnHeaderCellBackColor(int column)
BBjColor	getColumnHeaderCellForeColor(int column)
BBjColor	getColumnHeaderForeColor()
BBjColor	getLineColor()
BBjColor	getMainGridBackColor()
BBjColor	getMainGridForeColor()
void	setColumnBackColor(int column, BBjColor color!)
void	setColumnForeColor(int column, BBjColor color!)
void	setColumnHeaderBackColor(BBjColor color!)
void	setColumnHeaderCellBackColor(int column, BBjColor color!)
void	setColumnHeaderCellForeColor(int column, BBjColor color!)
void	setColumnHeaderForeColor(BBjColor color!)
void	setLineColor(BBjColor color!)
void	setMainGridBackColor(BBjColor color!)
void	setMainGridForeColor(BBjColor color!)

Methods of BBSimplejGrid – Grid Fonts

Return Value	Method
BBjFont	getColumnFont(int column)
BBjFont	getColumnHeaderFont()
BBjFont	getMainGridFont()
void	setColumnFont(int col,BBjFont font!)
void	setColumnHeaderFont(BBjFont font!)
void	setMainGridFont(BBjFont font!)

Methods of BBjGrid – Icon Functions

Return Value	Method
void	setColumnHeaderCellIcon(int imageListID, int index, int column)
void	setColumnHeaderCellImage(int column, BBjImage image)

Methods of BBjGrid – Miscellaneous Grid Functions

Return Value	Method
boolean	getTrimBlankSpace()
boolean	isDataAware()
void	setTrimBlankSpace(boolean shouldTrim)

Methods of BBjGrid implemented for Focusable

Return Value	Method
boolean	isFocusable()
void	setFocusable(boolean p_focus)

Methods of BBjGrid implemented for MouseWheelEnabled

Return Value	Method
int	getScrollWheelBehavior()
void	setScrollWheelBehavior(int trav)

Methods of BBjGrid implemented for TabTraversable

Return Value	Method
boolean	isTabTraversable()
void	setTabTraversable(boolean trav)

Methods of BBjGrid inherited from BBjControl

Events

Callback Code	Object-oriented Event	Read Record Event	Code
ON_CONTROL_VALIDATION	BBjControlValidationEvent	Control Validation Event	v
ON_GAINED_FOCUS	BBjGainedFocusEvent	Control Focus Gained/Lost Event	f
ON_GRID_CELL_VALIDATION	BBjGridCellValidationEvent	Grid Cell Validation Event	N (Notify code 32)
ON_GRID_CELL_MODIFY	BBjGridCellModifyEvent	EDITCHANGE Grid Notify Event	N (Notify code 5)
ON_GRID_CHECK_OFF	BBjGridCheckOffEvent	CELLCHECKED Grid Control Event	N (Notify code 30)
ON_GRID_CHECK_ON	BBjGridCheckOnEvent	CELLCHECKED Grid Control Event	N (Notify code 30)
ON_GRID_COLUMN_SIZE	BBjGridColumnSizeEvent	COLUMNSIZED Grid Notify Event	N (Notify code 1)
ON_GRID_DOUBLE_CLICK	BBjGridDoubleClickEvent	DCLICKED Grid Notify Event	N (Notify code 3)
ON_GRID_DRAG_DROP	BBjGridDragDropEvent	DRAGDROP Grid Notify Event	N (Notify code 4)
ON_GRID_EDIT_START	BBjGridEditStartEvent	EDITSET Grid Notify Event	N (Notify code 8)
ON_GRID_EDIT_STOP	BBjGridEditStopEvent	EDITKILL Grid Notify Event	N (Notify code 7)
ON_GRID_ENTER_KEY	BBjGridEnterKeyEvent	ENTER Grid Notify Event	N (Notify code 9)
ON_GRID_ERROR	N/A	ERROR Grid Notify Event	N (Notify code 29)
ON_GRID_GAINED_FOCUS	BBjGridGainedFocusEvent	SETFOCUS	N (Notify code 20)
ON_GRID_HIT_BOTTOM	BBjGridHitBottomEvent	HITBOTTOM Grid Notify Event	N (Notify code 10)
ON_GRID_HIT_TOP	BBjGridHitTopEvent	HITTOP Grid Notify Event	N (Notify code 11)
ON_GRID_KEYPRESS	BBjGridKeypressEvent	KEYBOARD Grid Notify Event	N (Notify code 12)
ON_GRID_LEFT_COLUMN_CHANGE	BBjGridLeftColumnChangeEvent	LEFTCOLCHANGE Grid Notify Event	N (Notify code 16)
ON_GRID_LOST_FOCUS	BBjGridLostFocusEvent	KILLFOCUS	N (Notify code 13)
ON_GRID_MOUSE_DOWN	BBjGridMouseDownEvent	LCLICKED Grid Notify Event	N (Notify code 14)
ON_GRID_MOUSE_DOWN	BBjGridMouseDownEvent	LCLICKED2 Grid Notify Event	N (Notify code 15)
ON_GRID_MOUSE_DRAG	BBjGridMouseDragEvent	MOUSECAPTURE Grid Notify Event	N (Notify code 17)
ON_GRID_MOUSE_MOVE	BBjGridMouseMoveEvent	MOUSECAPTURE Grid Notify Event	N (Notify code 17)
ON_GRID_MOUSE_UP	BBjGridMouseUpEvent	LCLICKED Grid Notify Event	N (Notify code 14)
ON_GRID_RIGHT_MOUSE_DOWN	BBjGridRightMouseDownEvent	RCLICKED Grid Notify Event	N (Notify code 18)
ON_GRID_RIGHT_MOUSE_UP	BBjGridRightMouseUpEvent	RCLICKED Grid Notify Event	N (Notify code 18)
ON_GRID_SELECT_COLUMN	BBjGridSelectColumnEvent	COLCHANGE Grid Notify Event	N (Notify code 2)
ON_GRID_SELECT_ROW	BBjGridSelectRowEvent	ROWCHANGE Grid Notify Event	N (Notify code 19)
ON_GRID_SPECIAL_KEY	BBjGridSpecialKeyEvent	EDITKEY Grid Notify Event	N (Notify code 6)
ON_GRID_TOP_ROW_CHANGE	BBjGridTopRowChangeEvent	TOPROWCHANGE Grid Notify Event	N (Notify code 21)
ON_GRID_UPDATE	BBjGridUpdateEvent	TABLEUPDATE Grid Notify Event	N (Notify code 22)
ON_LOST_FOCUS	BBjLostFocusEvent	Control Focus Gained/Lost Event	f
ON_MOUSE_ENTER	BBjMouseEnterEvent	Mouse Enter/Exit Event	E
ON_MOUSE_EXIT	BBjMouseExitEvent	Mouse Enter/Exit Event	E
ON_POPUP_REQUEST	BBjPopupRequestEvent	Popup Request Event	r
ON_RIGHT_MOUSE_DOWN