Class InListControls<TItem>Abstract

Input list controls.

Type Parameters

  • TItem

    Model item type.

Hierarchy

Implements

Constructors

Properties

on: OnEvent<[InList.Entry<TItem>[], InList.Entry<TItem>[]]>

An OnEvent sender of container updates.

Sends two arrays on each container update: the first one contains added control entries, while the second one contains removed control entries.

The [OnEvent__symbol] property is an alias of this one.

read: AfterEvent<[InList.Snapshot<TItem>]>

An AfterEvent keeper of input container contents.

The [AfterEvent__symbol] property is an alias of this one.

Methods

  • Inserts input controls at the given position.

    Parameters

    • index: number

      An index to insert controls at.

    • Rest ...controls: InControl<TItem>[]

      Input controls to add after the last one.

    Returns Supply

    A supply of just inserted controls that removes them once cut off. Cut off supply when no controls inserted.

  • Removes input controls starting at the given index.

    Parameters

    • start: number

      An index of the first control to remove.

    • Optional end: number

      An index of the control next to the last one to remove. Only one control will be removed if omitted.

    Returns void

  • Sets input control with the given index.

    Replaces existing control if already present.

    Parameters

    • index: number

      An index of input control to set. I.e. corresponding model item index.

    • control: InControl<TItem>

      Input control to add.

    Returns Supply

    A supply of just added control that removes it once cut off.

  • Changes the contents of controls array by removing or replacing existing controls and/or adding new ones.

    Parameters

    • start: number

      The index at which to start changing the array.

    • Optional deleteCount: number

      An integer indicating the number of elements in the array to remove from start. If omitted then all controls from start will be removed.

    • Rest ...controls: InControl<TItem>[]

      Controls to add.

    Returns Supply

    A supply of just added controls that removes them once cut off. Cut off supply when no controls added.

Generated using TypeDoc