Class CardSection

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

Hierarchy

Implements

Constructors

constructor

Properties - Static Keys

fieldsKey rowsKey systemChangedKey systemRowSortingTypeKey systemTableTypeKey

Accessors

fields name rowSortingType rows tableType type

Methods

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

Constructors

constructor

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

    Parameters

    • name: string

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

    • storage: IStorage<unknown> = {}

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

    Returns CardSection

Static Keys Properties

Static Readonly fieldsKey

fieldsKey: "Fields" = 'Fields'

Static Readonly rowsKey

rowsKey: "Rows" = 'Rows'

Static Readonly systemChangedKey

systemChangedKey: string = ...

Static Readonly systemRowSortingTypeKey

systemRowSortingTypeKey: string = ...

Static Readonly systemTableTypeKey

systemTableTypeKey: string = ...

Accessors

fields

  • get fields(): FieldStorageMap

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

    Returns FieldStorageMap

  • set fields(value: FieldStorageMap): void

  • Parameters

    Returns void

name

  • get name(): string

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

    Returns string

rowSortingType

  • get rowSortingType(): CardRowSortingType

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

    Remarks

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

    Returns CardRowSortingType

  • set rowSortingType(value: CardRowSortingType): void

  • Parameters

    Returns void

rows

  • get rows(): StorageArray<CardRow>

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

    Returns StorageArray<CardRow>

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

  • Parameters

    Returns void

tableType

  • get tableType(): CardTableType

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

    Remarks

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

    Returns CardTableType

  • set tableType(value: CardTableType): void

  • Parameters

    Returns void

type

  • get type(): CardSectionType

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

    Remarks

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

    Returns CardSectionType

  • set type(value: CardSectionType): void

  • Parameters

    Returns void

Methods

clean

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

    Returns void

clearChanges

clone

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

    Returns CardSection

ensureCacheResolved

getAllChanges

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

    Returns

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

    Returns string[]

getStorage

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

    Returns

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

    Returns IStorage<unknown>

getStorageSettings

hasChanges

  • Remarks

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

    Returns boolean

isChanged

  • Remarks

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

    Parameters

    • key: string

    Returns boolean

isEmpty

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

    Returns

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

    Returns boolean

isValid

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

    Returns

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

    Returns boolean

notifyStorageUpdated

removeAllButChanged

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

    Remarks

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

    Returns void

removeChanges

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

    Returns

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

    Parameters

    • deletedHandling: CardRemoveChangesDeletedHandling = CardRemoveChangesDeletedHandling.ResetToNone

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

    Returns boolean

setChanged

setFrom

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

    Parameters

    • section: CardSection

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

    Returns void

tryGetFields

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

    Returns

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

    Returns null | FieldStorageMap

tryGetRowSortingType

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

    Returns

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

    Returns null | CardRowSortingType

tryGetRows

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

    Returns

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

    Returns null | StorageArray<CardRow>

tryGetTableType

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

    Returns

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

    Returns null | CardTableType

validate

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

    Returns

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

    Returns ValidationResult

Generated using TypeDoc