Class CardSection

constructor

• new CardSection(name: string, storage?: IStorage): CardSection

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

  Parameters

  • name: string

    Название секции.
  • storage: IStorage = {}

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

  Returns CardSection

Static ReadonlyfieldsKey

Static ReadonlyrowsKey

Static ReadonlysystemChangedKey

Static ReadonlysystemRowSortingTypeKey

Static ReadonlysystemTableTypeKey

fields

• get fields(): FieldStorageMap

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

  Returns FieldStorageMap
• set fields(value: FieldStorageMap): void

  Parameters

  • value: FieldStorageMap

  Returns void

name

• get name(): string

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

  Returns string

rows

• get rows(): StorageArray<CardRow>

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

  Returns StorageArray<CardRow>
• set rows(value: CardRow[]): void

  Parameters

  • value: CardRow[]

  Returns void

rowSortingType

• get rowSortingType(): CardRowSortingType

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

  Returns CardRowSortingType

  Remarks

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

• set rowSortingType(value: CardRowSortingType): void

  Parameters

  • value: CardRowSortingType

  Returns void

tableType

• get tableType(): CardTableType

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

  Returns CardTableType

  Remarks

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

• set tableType(value: CardTableType): void

  Parameters

  • value: CardTableType

  Returns void

type

• get type(): CardSectionType

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

  Returns CardSectionType

  Remarks

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

• set type(value: CardSectionType): void

  Parameters

  • value: CardSectionType

  Returns void

clean

• clean(): void

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

  Returns void

clearChanges

• clearChanges(): IStorageObjectStateProvider

  Returns IStorageObjectStateProvider

  Remarks

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

clone

• clone(): CardSection

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

  Returns CardSection

ensureCacheResolved

• ensureCacheResolved(): void

  Выполняет резолв кеша декораторов для данных объекта-хранилища.

  Returns void

getAllChanges

• getAllChanges(): string[]

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

  Returns string[]

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

hasChanges

• hasChanges(): boolean

  Returns boolean

  Remarks

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

isChanged

• isChanged(key: string): boolean

  Parameters

  • key: string

  Returns boolean

  Remarks

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

isEmpty

• isEmpty(): boolean

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

  Returns boolean

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

notifyStorageUpdated

• notifyStorageUpdated(): void

  Метод, уведомляющий объект о наличии изменений в его хранилище.

  Returns void

removeAllButChanged

• removeAllButChanged(): void

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

  Returns void

  Remarks

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

removeChanges

• removeChanges(deletedHandling?: CardRemoveChangesDeletedHandling): boolean

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

  Parameters

  • deletedHandling: CardRemoveChangesDeletedHandling = CardRemoveChangesDeletedHandling.ResetToNone

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

  Returns boolean

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

setChanged

• setChanged(key: string, isChanged: boolean): IStorageObjectStateProvider

  Parameters

  • key: string
  • isChanged: boolean

  Returns IStorageObjectStateProvider

  Remarks

  Метод доступен только для строковых секций.

setFrom

• setFrom(section: CardSection): void

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

  Parameters

  • section: CardSection

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

  Returns void

tryGetFields

• tryGetFields(): null | FieldStorageMap

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

  Returns null | FieldStorageMap

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

tryGetRows

• tryGetRows(): null | StorageArray<CardRow>

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

  Returns null | StorageArray<CardRow>

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

tryGetRowSortingType

• tryGetRowSortingType(): null | CardRowSortingType

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

  Returns null | CardRowSortingType

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

tryGetTableType

• tryGetTableType(): null | CardTableType

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

  Returns null | CardTableType

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