Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ListBase

List base

Hierarchy

Index

Constructors

constructor

Properties

actionTemplate

actionTemplate: TemplateRef<any>

The name of the template containing actions for each item

itemTemplate

itemTemplate: TemplateRef<any>

The name of the template containing item layout

items

items: any[]

An array of items to display in the list

onActionSelect

onActionSelect: EventEmitter<Object> = new EventEmitter()

The event emitted when an action (e.g., button, kebab, etc.) has been selected

onClick

onClick: EventEmitter<Object> = new EventEmitter()

The event emitted when an item has been clicked

onDblClick

onDblClick: EventEmitter<Object> = new EventEmitter()

The event emitted when an item is double clicked

onSelectionChange

onSelectionChange: EventEmitter<Object> = new EventEmitter()

The event emitted when an item selection has been changed

Accessors

itemsEmpty

  • get itemsEmpty(): boolean
  • Get the flag indicating list has no items

    Returns boolean

    The flag indicating list has no items

Methods

Protected checkboxChange

  • checkboxChange(item: any): void
  • Helper to generate selection change event

    Parameters

    • item: any

      The selected item

    Returns void

Protected dblClick

  • dblClick($event: MouseEvent, item: any): void
  • Helper to generate double click event

    Parameters

    • $event: MouseEvent

      The triggered event

    • item: any

      The double clicked item

    Returns void

Protected deselectItems

  • deselectItems(items: any[]): void
  • Helper to deselect given items items and children

    Parameters

    • items: any[]

      The items to be deselected

    Returns void

Protected getConfig

Protected getSelectedItems

  • getSelectedItems(items: any[]): any[]
  • Helper to retrieve selected items

    Parameters

    • items: any[]

      The items containing possible selections

    Returns any[]

    A list of selected items

Protected handleAction

  • handleAction(action: Action): void

Protected radioButtonChange

  • radioButtonChange(item: any): void
  • Helper to generate selection change event

    Parameters

    • item: any

      The selected item

    Returns void

selectItem

  • selectItem(item: any, selected: boolean): void
  • Select or deselect an item

    Parameters

    • item: any

      The item to select or deselect

    • selected: boolean

      True if item should be selected

    Returns void

Protected selectSingleItem

  • selectSingleItem(item: any): void
  • Helper to select a single item and deselect all others

    Parameters

    • item: any

      The item to select

    Returns void

Protected setupConfig

  • setupConfig(): void

Protected toggleSelection

  • toggleSelection($event: MouseEvent, item: any): void
  • Helper to toggle item selection

    Parameters

    • $event: MouseEvent

      The triggered event

    • item: any

      The item to select

    Returns void

Generated using TypeDoc