TESSA Web API
    Preparing search index...

    Class CardSection

    Содержит данные строковой, коллекционной или древовидной секции карточки.

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    constructor

    Properties - Other

    cachedMemberChanged fieldChanged

    Properties - Static Keys

    fieldsKey rowsKey systemChangedKey systemRowSortingTypeKey systemTableTypeKey

    Accessors

    cachedMembers fields isObservable name rows rowSortingType tableType type

    Methods

    clean clearChanges clone ensureCacheResolved getAllChanges getStorage getStorageSettings hasChanges isChanged isEmpty isValid notifyStorageUpdated removeAllButChanged removeChanges setChanged setFrom tryGetFields tryGetRows tryGetRowSortingType tryGetTableType validate

    Constructors

    • Создаёт экземпляр класса с указанием хранилища, декоратором для которого является создаваемый объект.

      Parameters

      • name: string

        Название секции.

      • storage: IStorage = {}

        Хранилище, декоратором для которого является создаваемый объект.

      Returns CardSection

    Properties - Other

    cachedMemberChanged: EventHandler<
        { fieldName: string; newValue: unknown; oldValue: unknown },
    >
    fieldChanged: EventHandler<
        { fieldName: string; newValue: unknown; oldValue: unknown },
    >

    Properties - Static Keys

    fieldsKey: "Fields" = 'Fields'
    rowsKey: "Rows" = 'Rows'
    systemChangedKey: string = ...
    systemRowSortingTypeKey: string = ...
    systemTableTypeKey: string = ...

    Accessors

    • get cachedMembers(): ReadonlyMap<string, unknown>

      Returns ReadonlyMap<string, unknown>

    • get fields(): FieldStorageMap

      Значения полей для строковой секции. Если секция является коллекционной или древовидной, то вызывается исключение.

      Returns FieldStorageMap

    • set fields(value: FieldStorageMap): void

      Parameters

      Returns void

    • get isObservable(): boolean

      Определяет, является ли хранилище наблюдаемым, то есть поддерживает механизм автоматического оповещения о своих изменениях.

      Если значение этого свойства равно true, то объект класса может быть подписан на изменения, и соответствующие обработчики будут вызываться при каждом изменении состояния объекта.

      В противном случае, если значение false, объект считается ненаблюдаемым, и изменения в его состоянии не будут автоматически передаваться другим частям программы.

      Returns boolean

    • set isObservable(value: boolean): void

      Parameters

      • value: boolean

      Returns void

    • get name(): string

      Название секции.

      Returns string

    • get rows(): StorageArray<CardRow>

      Строки и их значения для коллекционной и древовидной секций. Если секция является строковой, то вызывается исключение.

      Returns StorageArray<CardRow>

    • set rows(value: CardRow[]): void

      Parameters

      Returns void

    • get rowSortingType(): CardRowSortingType

      Тип сортировки строк для коллекционной или древовидной секции.

      Returns CardRowSortingType

      Значение по умолчанию CardRowSortingType.Auto возвращается даже в том случае, если объект с соответствующим ключом отсутствует в хранилище.

    • set rowSortingType(value: CardRowSortingType): void

      Parameters

      Returns void

    • get tableType(): CardTableType

      Тип коллекционной или древовидной секции. Для строковой секции всегда возвращается значение CardTableType.Unspecified.

      Returns CardTableType

      Значение по умолчанию CardTableType.Unspecified возвращается даже в том случае, если объект с соответствующим ключом отсутствует в хранилище.

    • set tableType(value: CardTableType): void

      Parameters

      Returns void

    • get type(): CardSectionType

      Тип секции карточки. Не содержится в пакете и вычисляется на основании наличия в пакете определённых полей.

      Returns CardSectionType

      По умолчанию равно CardSectionType.Entry.

    • set type(value: CardSectionType): void

      Parameters

      Returns void

    Methods

    • Выполняет очистку хранилища от избыточных данных.

      Returns void

    • Создает новый объект, который является копией текущего экземпляра.

      Returns CardSection

    • Возвращает коллекцию ключей всех объектов, значения которых были изменены.

      Returns string[]

      Коллекция ключей всех объектов, значения которых были изменены.

    • Возвращает хранилище IStorage, декоратором для которого является текущий объект.

      Returns IStorage

      Хранилище IStorage, декоратором для которого является текущий объект.

    • Returns boolean

      Для строковой секции проверяется наличие изменений в её полях, а для коллекционной и древовидной секции - наличие изменений хотя бы в одной её строке.

    • Parameters

      • key: string

      Returns boolean

      Если тип секции type отличен от CardSectionType.Entry, то метод всегда будет возвращать false.

    • Возвращает признак того, что объект не содержит значимых данных для метода очистки.

      Returns boolean

      true, если объект не содержит значимых для метода очистки данных; false в противном случае.

    • Выполняет проверку объекта на валидность и возвращает признак того, что объект является валидным.

      Returns boolean

      true, если объект прошёл проверку на валидность; false в противном случае.

    • Удаляет информацию о всех полях или строках секции, которые не были изменены посредством IStorageObjectStateProvider.

      Returns void

      Метод удаляет информацию об изменённых полях, поэтому повторный его вызов приведёт к удалению всех полей. Для коллекционных и древовидных секций метод удаляет строки, у которых CardRow.state равен CardRowState.None, или CardRow.state равен CardRowState.Modified и отсутствуют изменённые поля. Метод удаляет всю информацию, кроме служебной, о строках, у которых CardRow.state равен CardRowState.Deleted, и не удаляет информацию у строк CardRowState.Inserted. Рекомендуется вызывать этот метод перед вызовом clean.

    • Выполняет удаление информации по состояниям, из которой можно было бы определить, что секция изменена. Возвращает признак того, что при этом были внесены изменения.

      Parameters

      • deletedHandling: CardRemoveChangesDeletedHandling = CardRemoveChangesDeletedHandling.ResetToNone

        Способ обработки удалённых строк, файлов и заданий.

      Returns boolean

      true, если в процессе удаления были внесены изменения; false в противном случае.

    • Устанавливает состояние текущего объекта идентичным состоянию заданной секции. При этом копируется заданная секция со всеми её данными.

      Parameters

      • section: CardSection

        Секция, состояние которой используется для копирования в текущий объект.

      Returns void

    • Возвращает значения полей для строковой секции или null, если значения ещё не были заданы или секция не является строковой.

      Returns null | FieldStorageMap

      Значения полей для строковой секции или null, если значения ещё не были заданы или секция не является строковой.

    • Возвращает коллекцию строк для коллекционной или древовидной секции или null, если коллекция ещё не была создана или секция не является коллекционной или древовидной.

      Returns null | StorageArray<CardRow>

      Коллекция строк для коллекционной или древовидной секции или null, если коллекция ещё не была создана или секция не является коллекционной или древовидной.

    • Возвращает тип сортировки строк для коллекционной или древовидной секции. или null, если значение ещё не было задано или секция не является коллекционной или древовидной.

      Returns null | CardRowSortingType

      Тип сортировки строк для коллекционной или древовидной секции. или null, если значение ещё не было задано или секция не является коллекционной или древовидной.

    • Возвращает тип коллекционной или древовидной секции. или null, если значение ещё не было задано или секция не является коллекционной или древовидной.

      Returns null | CardTableType

      Тип коллекционной или древовидной секции. или null, если значение ещё не было задано или секция не является коллекционной или древовидной.

    • Выполняет валидацию текущего объекта и всех его дочерних объектов.

      Returns ValidationResult

      Объект, выполняющий построение результата валидации.

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties - Other
    Properties - Static Keys
    Accessors
    Methods