Class TypedAggregationBindingInfo<T>

Represents an aggregation binding info object with aggregation type.

Use TypedModel.aggregationBinding to create an instance.

Type Parameters

  • T

Hierarchy

  • AggregationBindingInfo
    • TypedAggregationBindingInfo

Implements

  • AggregationBindingInfo

Constructors

constructor

Properties

events? factory? filters? groupHeaderFactory? key? length? model? parameters? path sorter? startIndex? suspended? template? templateShareable? typedModel

Constructors

Private constructor

Properties

Optional events

events?: Record<string, Function>

Map of event handler functions keyed by the name of the binding events that they should be attached to

Optional factory

factory?: ((p1, p2) => default)

Type declaration

    • (p1, p2): default

    • A factory function that will be called to create an object for each item in the aggregation; this is an alternative to providing a template object and can be used when the objects should differ depending on the binding context; the factory function will be called with two parameters: an ID that should be used for the created object and the binding context for which the object has to be created; the function must return an object appropriate for the bound aggregation

      Parameters

      • p1: string
      • p2: default

      Returns default

Optional filters

filters?: default | default[]

The predefined filters for this aggregation (optional)

Optional groupHeaderFactory

groupHeaderFactory?: ((p1) => default)

Type declaration

    • (p1): default

    • A factory function to generate custom group visualization (optional). It should return a control suitable to visualize a group header (e.g. a sap.m.GroupHeaderListItem for a sap.m.List).

      Parameters

      • p1: {
            key: string;
        }
        • key: string

      Returns default

Optional key

key?: string | ((p1) => string)

Name of the key property or a function getting the context as only parameter to calculate a key for entries. This can be used to improve update behaviour in models, where a key is not already available.

Type declaration

    • (p1): string

    • Parameters

      • p1: default

      Returns string

Optional length

length?: number

The amount of entries to be created (may exceed the size limit of the model)

Optional model

model?: string

Name of the model to bind against; when undefined or omitted, the default model is used

Optional parameters

parameters?: object

Map of additional parameters for this binding; the names and value ranges of the supported parameters depend on the model implementation, they should be documented with the bindList method of the corresponding model class or with the model specific subclass of sap.ui.model.ListBinding

path

path: string

Path in the model to bind to, either an absolute path or relative to the binding context for the corresponding model; when the path contains a '>' sign, the string preceding it will override the model property and the remainder after the '>' will be used as binding path

Optional sorter

sorter?: default | default[]

The initial sort order (optional)

Optional startIndex

startIndex?: number

the first entry of the list to be created

Optional suspended

suspended?: boolean

Whether the binding should be suspended initially

Optional template

template?: default

The template to clone for each item in the aggregation; either a template or a factory must be given

Optional templateShareable

templateShareable?: boolean

Whether the framework should assume that the application takes care of the lifecycle of the given template; when set to true, the template can be used in multiple bindings, either in parallel or over time, and the framework won't clone it when this ManagedObject is cloned; when set to false, the lifecycle of the template is bound to the lifecycle of the binding, when the aggregation is unbound or when this ManagedObject is destroyed, the template also will be destroyed, and when this ManagedObject is cloned, the template will be cloned as well; the third option (undefined) only exists for compatibility reasons, its behavior is not fully reliable and it may leak the template

Readonly typedModel

typedModel: TypedModel<any, any>

The corresponding TypedModel of the binding.

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc