Interface CCOutlineViewDelegate<Item>

Use this interface to receive messages on certain events from an outline view.

interface CCOutlineViewDelegate<Item extends AnyNotNil> {
    canSelectItem?(table: CCOutlineView<Item>, item: Item): boolean;
    menuForItem?(table: CCOutlineView<Item>, item: Item): CCMenu | undefined;
    onItemDoubleClicked?(table: CCOutlineView<Item>, item: Item): void;
    onItemSelected?(table: CCOutlineView<Item>, item: Item): void;
}

Type Parameters

Item extends AnyNotNil
Type of object that the data source provides

Index

Methods

canSelectItem? menuForItem? onItemDoubleClicked? onItemSelected?

Methods

`Optional`canSelectItem

canSelectItem?(table: CCOutlineView<Item>, item: Item): boolean
Called to determine whether an item is selectable.
Parameters
- table: CCOutlineView<Item>
  The table being called on
- item: Item
  The item that may be selected
Returns boolean
Whether the item can be selected (will trigger onItemSelected)
- Defined in CCOutlineViewDelegate.ts:16

`Optional`menuForItem

menuForItem?(table: CCOutlineView<Item>, item: Item): CCMenu | undefined
Called when an item is right-clicked to get its context menu.
Parameters
- table: CCOutlineView<Item>
  The table being called on
- item: Item
  The item that was selected
Returns CCMenu | undefined
A menu to display, or nil for no menu
- Defined in CCOutlineViewDelegate.ts:38

`Optional`onItemDoubleClicked

onItemDoubleClicked?(table: CCOutlineView<Item>, item: Item): void
Called when an item is double-clicked.
Parameters
- table: CCOutlineView<Item>
  The table being called on
- item: Item
  The item that was selected
Returns void
- Defined in CCOutlineViewDelegate.ts:30

`Optional`onItemSelected

onItemSelected?(table: CCOutlineView<Item>, item: Item): void
Called when an item is selected.
Parameters
- table: CCOutlineView<Item>
  The table being called on
- item: Item
  The item that was selected
Returns void
- Defined in CCOutlineViewDelegate.ts:23