Class RecordComponent<TName, TKey, TRecord, TInput>

Represents a component of type Record

Type Parameters

Hierarchy

Implements

Constructors

constructor

Properties

name

Methods

getAllRecords getRecordByKey getSelectedKey getValue onRecordsChanged onSelectedKeyChanged onValueChanged setInput setSelectedKey

Constructors

constructor

Properties

Readonly name

name: TName

Methods

getAllRecords

  • Returns Promise<undefined | TRecord[]>

getRecordByKey

  • Returns the data of a specific record

    Returns

    The record (key-value-pair) or undefined if no record with the given key was found

    Parameters

    • key: TKey

      The key value of the wanted record

    Returns Promise<undefined | TRecord>

getSelectedKey

  • Get the key of the currently selected record

    Returns Promise<undefined | TKey>

getValue

onRecordsChanged

  • With this function a listener can be assigned which is executed whenever the data of a record component changes

    Parameters

    • listener: CmpRecordsChangedListener<TRecord[]>

      Called whenever the records of the given record cmp has changed

    • callImmediately: boolean = false

      True: The listener is immediately called with the current records of the record cmp at the time, the listener is added
      False: The listener will be called for the first time when the records of the cmp actually change

    Returns void

onSelectedKeyChanged

  • With this function a listener can be assigned which is executed whenever the selected key of a record component changes

    Parameters

    • listener: CmpRecordKeyChangedListener<TKey, TRecord>

      Called whenever the selected key of the given record component has changed

    • callImmediately: boolean = false

      True: The listener is immediately called with the current key and value of the cmp at the time, the listener is added
      False: The listener will be called for the first time when the key of the cmp actually changes

    • Optional condition: CmpRecordKeyChangedCondition<TKey, TRecord>

      A predicate function which is given the new cmp key and value.
      The function can decide on whether the listener is called or not by returning true or false.

    Returns void

onValueChanged

  • Parameters

    • listener: CmpValueChangedListener<TRecord>

      Called whenever the value of the given cmp has changed

    • callImmediately: boolean = false

      True: The listener is immediately called with the current value of the cmp at the time, the listener is added
      False: The listener will be called for the first time when the value of the cmp actually changes

    • Optional condition: CmpValueChangedCondition<TRecord>

      A predicate function which is given the new cmp value.
      The function can decide on whether the listener is called or not by returning true or false.

    Returns void

setInput

  • Sends the ChangeConfigurationValue request to the server

    Parameters

    • value: undefined | TInput
    • defer: boolean = true

      Defers the actual request after the current execution context.
      All values from subsequent calls to setCmpInput within the same execution context will be sent as 1 batch request if defer = true.

    Returns Promise<void>

setSelectedKey

  • Parameters

    • key: TKey
    • defer: boolean = true

    Returns Promise<void>

Settings

Member Visibility

Theme

Generated using TypeDoc