Accessors for class IlvMatrix

Properties

• adjustLast
• allowEdition
• autoColumnSelection
• autoFitToSize
• autoLineSelection
• browseSelect
• directEdition
• dragdrop
• editOnDoubleClick
• editedColumn
• editedRow
• editionDirection
• exclusive
• extendedSelectionOrientation
• gridColor
• hasTooltips
• labelPosition
• showLabel
• showPicture
• spacing
• textField
• Xgrid
• Ygrid

Methods

• add
• columnPosition
• columnSize
• deSelect
• fitToSize
• getItem
• getItemAlignment
• hideTextField
• insertColumn
• insertRow
• isItemFillingBackground
• isItemGrayed
• isItemReadOnly
• isItemRelief
• isItemSelected
• isItemSensitive
• itemBBox
• reinitialize
• remove
• removeColumn
• removeRow
• resizeColumn
• resizeRow
• rowPosition
• rowSize
• selectColumn
• selectItem
• selectRow
• set
• setEditedItem
• setFocus
• setItemAlignment
• setItemFillingBackground
• setItemGrayed
• setItemReadOnly
• setItemRelief
• setItemSensitive
• showTextField

Description

• IlvAbstractMatrixItem

• IlvLabelMatrixItem

• IlvFilledLabelMatrixItem

• IlvBitmapMatrixItem

• IlvIntMatrixItem

• IlvFilledIntMatrixItem

• IlvFloatMatrixItem

• IlvFilledFloatMatrixItem

• IlvDoubleMatrixItem

• IlvFilledDoubleMatrixItem

• IlvGraphicMatrixItem

• IlvGadgetMatrixItem

• IlvGadgetItemMatrixItem

Type	Name	Description	Notes
Void	add(IlvAbstractMatrixItem item)	Adds item to the first free location in the matrix. This location is the left-most and top-most empty cell.
Boolean	adjustLast	When a matrix is being resized and adjustLast is set to true, tit adjusts the width of the last column to fit the whole width of the matrix.
Boolean	allowEdition	Specifies whether editing is allowed (true) or not (false).
Boolean	autoColumnSelection	Sets the matrix so that automatic column selection is possible (true). Returns true if the matrix has automatic column selection set.
Boolean	autoFitToSize	Sets the automatic resizing flag. The default value is false. Returns true if the cells of the matrix are automatically resized when the size of the matrix is modified. Otherwise, it returns false.
Boolean	autoLineSelection	Returns true if the matrix has automatic line selection set. Sets the matrix so that automatic line selection is possible, if it is true.
Boolean	browseSelect	Sets the matrix so that it is in browse selection mode. In this mode, the user can add an item to the selection (non exclusive) simply by clicking on the item or by dragging the mouse. Returns true if the matrix is in browse selection mode. When the matrix is not in browse selection mode, clicking on an item deselects all other items before selecting the clicked item. In this case, the user must press the Control key when clicking to add an item to the selection.
UInt	columnPosition(UInt col)	Returns the distance between the left side of the column col and the left side of the first column. When col is equal to 0, it returns 0.
UInt	columnSize(UInt col)	Returns the width of the column col.
Void	deSelect()	Deselects all the items in the matrix.
Boolean	directEdition	Sets the edit mode to direct editing mode (true). Returns true if the matrix is in direct editing mode. If a matrix is not in direct editing mode, you must click on a matrix item to edit it. However with direct editing mode, an item can be edited at any time after the user has clicked on it.
Boolean	dragdrop	Specifies whether drag-and-drop operations are allowed for the matrix.
Boolean	editOnDoubleClick	Returns true if the matrix allows item editing on a double-click event.
UInt	editedColumn	UInt editedColumn
UInt	editedRow	Get the location of the matrix item (row or column) that is currently being edited.
Direction	editionDirection	Sets or returns the editing direction for the matrix. The editing direction is the direction to which the selection moves in the matrix, when you validate an item.
Boolean	exclusive	Sets the exclusive state of the matrix. Returns true if the matrix is exclusive, that is, when you cannot select more than one item at a time.
Direction	extendedSelectionOrientation	Sets the direction to which a selection in the matrix is extended. The default value is IlvHorizontal, meaning that the selection is extended along a line. Other possible extension directions are IlvVertical (column extension) and IlvBadPosition (square extension). Returns the direction to which the selection will be extended.
Void	fitToSize()	Computes a new size for the columns and rows so that they fit the size of the matrix.
IlvAbstractMatrixItem	getItem(UInt col, UInt row)	Returns the item located at col, row in the matrix, or NULL if there is no such item.
Direction	getItemAlignment(UInt col, UInt row)	Returns the alignment of the item located at col, row in the matrix.
Color	gridColor	Gets or sets the color of the grid.
Boolean	hasTooltips	Specifies whether the matrix uses tooltips (true) or not (false).
Void	hideTextField()	Hides the editing text field, if there is one.
Void	insertColumn(UInt col, UInt count)	Inserts the number of columns specified by count before column col. If col exceeds the number of columns, the new columns are added to the end of the matrix.
Void	insertRow(UInt row, UInt count)	Inserts the number of rows specified by count before row row. If row exceeds the number of rows, the new rows are added to the end of the matrix.
Boolean	isItemFillingBackground(UInt col, UInt row)	Returns true if the filled matrix item, specified by col and row, is using its palette for the text foreground (text color and font), and for the item background. This method does not apply to matrix items that are not filled.
Boolean	isItemGrayed(UInt col, UInt row)	Returns true if the item at the position specified by col and row is gray.
Boolean	isItemReadOnly(UInt col, UInt row)	Returns the read-only state of the item located at col, row in the matrix.
Boolean	isItemRelief(UInt col, UInt row)	Returns a Boolean value that indicates whether the item located at col, row in the matrix is displayed with a relief effect.
Boolean	isItemSelected(UInt col, UInt row)	Returns true if the item located at col, row in the matrix is selected, and false otherwise.
Boolean	isItemSensitive(UInt col, UInt row)	Returns true if the item located at col, row in the matrix is sensitive, and false otherwise.
IlvRect	itemBBox(UInt col, UInt row)	Returns the bounding box of the item located at col, row in this matrix.
Direction	labelPosition	Sets or returns the default position of the matrix item labels (IlvGadgetItemMatrixItem object only) relative to their picture.
Void	reinitialize(UInt col, UInt row)	Sets the matrix dimensions to col and row. The items that are in the removed columns and rows are destroyed.
Boolean	remove(UInt col, UInt row, Boolean destroy)	Removes the item located at col, row in the matrix. The item is deleted if destroy is omitted or set to true. This method returns true if the operation is successful, and false if there is no item at the location specified.
Void	removeColumn(UInt col, Boolean destroy)	Removes the column col. The items that this column contains are deleted if destroy is omitted or set to true.
Void	removeRow(UInt row, Boolean destroy)	Removes the row row. The items that this row contains are deleted if destroy is omitted or set to true. Note that a matrix always has at least one row and one column. Therefore, if row is the last row in the matrix, it will not be removed.
Void	resizeColumn(UInt col, UInt size)	Sets the width of the column col-1 to size. When col is equal to 0, this function does nothing.
Void	resizeRow(UInt row, UInt size)	Sets the height of the row row-1 to size. When row is equal to 0, this function does nothing.
UInt	rowPosition(UInt row)	Returns the distance between the top border of the row row and the top border of the first row. When row is equal to 0, it returns 0.
UInt	rowSize(UInt row)	Returns the height of the row row.
Void	selectColumn(UInt col, Boolean select)	Sets the selection state of the entire column col to select.
Void	selectItem(UInt col, UInt row, Boolean select)	Sets the selection state of the item located at col, row in the matrix to select.
Void	selectRow(UInt row, Boolean select)	Sets the selection state of the entire row row to select.
Void	set(UInt col, UInt row, IlvAbstractMatrixItem item)	Adds item to the matrix at the location specified by col, row. If there is a matrix item at this location, this item is deleted before item is inserted.
Void	setEditedItem(UInt col, UInt row)	Sets the item at the location specified by col and row as the current editable item. See the allowEdition property.
Void	setFocus(UInt column, UInt row, IlvGadgetMatrixItem gadItem)	Sets the gadget matrix item that has the focus to gadItem . The parameter col and row specify the location of the item in the matrix.
Void	setItemAlignment(UInt col, UInt row, Direction align)	Sets the alignment of the item located at col, row in the matrix to align.
Void	setItemFillingBackground(UInt col, UInt row, Boolean filling)	Sets the matrix item specified by col and row so that it only uses its palette for the foreground of the text (text color and font), and for the item background. This method applies only to filled matrix items.
Void	setItemGrayed(UInt col, UInt row, Boolean grayed)	Sets the item at the position specified by col and row to grayed, if grayed is true. If grayed is false, the item is set to its original color. This method is automatically called with grayed set to true when the IlvMatrix::setItemSensitive method is called with false, resulting in an item that is grayed and insensitive. However if you require an item that is insensitive and not gray, you must first call the IlvMatrix::setItemSensitive method with false, and then the setItemGrayed method with grayed set to false.
Void	setItemReadOnly(UInt col, UInt row, Boolean readOnly)	Sets the item located at col, row in the matrix to readOnly. If readOnly is true, IlvLabelMatrixItem objects can be selected but not edited. There is no effect on IlvGadgetMatrixItem objects.
Void	setItemRelief(UInt col, UInt row, Boolean relief)	Sets the item located at col, row in the matrix to relief.
Void	setItemSensitive(UInt col, UInt row, Boolean sensitive)	Sets the item located at col, row in the matrix to sensitive. If sensitive is set to false, IlvLabelMatrixItem objects are shown dimmed.
Boolean	showLabel	Specifies whether the labels associated with the matrix items (IlvGadgetItemMatrixItem object only) are displayed (true) or not (false).
Boolean	showPicture	Specifies whether the pictures associated with the matrix items (IlvGadgetItemMatrixItem object only) are displayed (true) or not (false).
Void	showTextField()	Pops up the associated text field at the location of the current editable item.
UInt	spacing	Sets or gets the spacing between two cells.
Object	textField	Returns the IlvTextField object used for editing.
UInt	Xgrid	Sets or gets the width of the columns, if they have the same dimensions.
UInt	Ygrid	Sets or gets the height of the rows, if they have the same dimensions.