Accessors for class IlvTreeGadget

Properties

callbackItem
dragdrop
editable
firstSelectedItem
firstVisible
hasToolTips
indentation
itemsCount
linesAtRoot
linkedRoots
root
selectionMode
showLabel
showPicture
visibleButtons
visibleLines

Methods

addItem
deSelectAll
expandItem
getItemByName
removeAllItems
removeItem
selectItem
shrinkItem

Description

An IlvTreeGadget is a gadget that displays a hierarchical list of items. Each item is an instance of the IlvTreeGadgetItem class. Each tree gadget item displays a label and an optional bitmap, and has a list of sub-items. The user can expand or shrink the item in order to show or hide the sub-items.

Type Name Description Notes

IlvTreeGadgetItem addItem(IlvTreeGadgetItem parent, String label, Int index, Bitmap bitmap, Bitmap selectionBitmap) Adds a sub-item to the parent item. bitmap and selectionBitmap are the bitmaps of the new item. If the new item has sub-items and if it is expanded, then selectionBitmap is displayed, otherwise bitmap is displayed. index indicates the required position for the new item in the list of child items. If index is -1 then the item is added to the end of the list.

Object callbackItem Returns the item that is affected by the callback. This property should be used only in the callback.

Void deSelectAll() Deselects all the selected items.

Boolean dragdrop Specifies whether drag-and-drop operations are allowed (true) or not (false).

Boolean editable Gets or sets the tree gadget's edit status.

Void expandItem(IlvTreeGadgetItem item) Expands the item to show the child items.

Object firstSelectedItem Returns the first selected item in the tree if there is one, otherwise it returns NULL.

Object firstVisible Returns the first visible item of the tree.

Object getItemByName Returns the tree item whose name is given as argument.

Boolean hasToolTips Specifies whether the tree gadget handles tooltips (true).

UInt indentation Gets or sets the amount of pixels that child items are indented from their parent. If indentation is less than the minimum, indentation is set to the minimum.

UInt itemsCount Returns the number of items in the tree.

Direction labelPosition Sets or returns the default position of the tree item labels relative to their picture.

Callback Boolean Sets or removes the lines that are drawn to link the root item and its children.
Returns true if lines are drawn to link the root item and its children.

Boolean linkedRoots Links or unlinks the children of the root.
Returns true if the children of the root item are linked together.

Void removeAllItems() Removes all the items in the tree. Note that the root item is never deleted.

Void removeItem(IlvTreeGadgetItem item) Removes item from the tree. The item and all its children are removed and deleted.

IlvTreeGadgetItem root Returns the root item of the tree.

Void selectItem(IlvTreeGadgetItem item, Boolean set, Boolean deselectAll) Selects or deselects the item item. If set is true the item will be selected, otherwise the item will be deselected. If set is true and deselectAll is true then other selected items will be deselected.

Boolean selectionMode Sets or returns the selection mode of the tree.

Void shrinkItem(IlvTreeGadgetItem item) Shrinks the item so that children are no longer visible.

Boolean showLabel Specifies whether the labels associated with the tree items are displayed (true) or not (false).

Boolean showPicture Specifies whether the pictures associated with the tree items are displayed (true) or not (false).

Boolean visibleButtons Shows or hides the buttons to the left of each item. Returns true if the buttons to the left of each item are visible.

Boolean visibleLines Shows or hides the lines that link items to their parents.
Returns true if lines are drawn to link the items and their parents.

Type	Name	Description
`IlvTreeGadgetItem`	`addItem(IlvTreeGadgetItem parent, String label, Int index, Bitmap bitmap, Bitmap selectionBitmap)`	Adds a sub-item to the `parent` item. `bitmap` and `selectionBitmap` are the bitmaps of the new item. If the new item has sub-items and if it is expanded, then `selectionBitmap` is displayed, otherwise `bitmap` is displayed. `index` indicates the required position for the new item in the list of child items. If `index` is `-1` then the item is added to the end of the list.
`Object`	`callbackItem`	Returns the item that is affected by the callback. This property should be used only in the callback.
`Void`	`deSelectAll()`	Deselects all the selected items.
`Boolean`	`dragdrop`	Specifies whether drag-and-drop operations are allowed (`true`) or not (`false`).
`Boolean`	`editable`	Gets or sets the tree gadget's edit status.
`Void`	`expandItem(IlvTreeGadgetItem item)`	Expands the item to show the child items.
`Object`	`firstSelectedItem`	Returns the first selected item in the tree if there is one, otherwise it returns `NULL`.
`Object`	`firstVisible`	Returns the first visible item of the tree.
`Object`	`getItemByName`	Returns the tree item whose name is given as argument.
`Boolean`	`hasToolTips`	Specifies whether the tree gadget handles tooltips (`true`).
`UInt`	`indentation`	Gets or sets the amount of pixels that child items are indented from their parent. If `indentation` is less than the minimum, indentation is set to the minimum.
`UInt`	`itemsCount`	Returns the number of items in the tree.
`Direction`	`labelPosition`	Sets or returns the default position of the tree item labels relative to their picture.
`Callback`	`Boolean`	Sets or removes the lines that are drawn to link the root item and its children. Returns `true` if lines are drawn to link the root item and its children.
`Boolean`	`linkedRoots`	Links or unlinks the children of the root. Returns `true` if the children of the root item are linked together.
`Void`	`removeAllItems()`	Removes all the items in the tree. Note that the root item is never deleted.
`Void`	`removeItem(IlvTreeGadgetItem item)`	Removes `item` from the tree. The item and all its children are removed and deleted.
`IlvTreeGadgetItem`	`root`	Returns the root item of the tree.
`Void`	`selectItem(IlvTreeGadgetItem item, Boolean set, Boolean deselectAll)`	Selects or deselects the item `item`. If `set` is `true` the item will be selected, otherwise the item will be deselected. If `set` is `true` and `deselectAll` is `true` then other selected items will be deselected.
`Boolean`	`selectionMode`	Sets or returns the selection mode of the tree.
`Void`	`shrinkItem(IlvTreeGadgetItem item)`	Shrinks the item so that children are no longer visible.
`Boolean`	`showLabel`	Specifies whether the labels associated with the tree items are displayed (`true`) or not (`false`).
`Boolean`	`showPicture`	Specifies whether the pictures associated with the tree items are displayed (`true`) or not (`false`).
`Boolean`	`visibleButtons`	Shows or hides the buttons to the left of each item. Returns `true` if the buttons to the left of each item are visible.
`Boolean`	`visibleLines`	Shows or hides the lines that link items to their parents. Returns `true` if lines are drawn to link the items and their parents.