Class CardTypeTableControl

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

Hierarchy

CardTypeControl
- CardTypeTableControl

Implements

ICloneable<CardTypeTableControl>

Index

Constructors

constructor

new CardTypeTableControl(): CardTypeTableControl
Returns CardTypeTableControl
Overrides CardTypeControl.constructor
- Defined in @tessa/platform/src/cards/types/cardTypeTableControl.ts:20

Properties

caption

caption: null | string = null

Отображаемое имя объекта.

flags

flags: CardTypeTableControlFlags = 0

Флаги, определяющие дополнительные атрибуты.

Remarks

Настройки, связанные с UI.

name

name: null | string = null

Имя элемента управления или null, если имя не задано. Рекомендуется задавать имя, уникальное для формы.

requiredText

requiredText: null | string = null

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

sectionId

sectionId: string = Guid.empty

Идентификатор секции.

toolTip

toolTip: null | string = null

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

Accessors

blockSettings

get blockSettings(): IStorage<unknown>
Настройки блока CardTypeBlock, которые задаются для каждого включённого в его состав объекта.

Returns IStorage<unknown>
Inherited from CardTypeControl.blockSettings
- Defined in @tessa/platform/src/cards/types/cardTypeControl.ts:63
set blockSettings(value: IStorage<unknown>): void
Parameters
- value: IStorage<unknown>
Returns void
Inherited from CardTypeControl.blockSettings
- Defined in @tessa/platform/src/cards/types/cardTypeControl.ts:66

columns

get columns(): CardTypeColumn[]
Объекты, описывающие информацию о колонках коллекционных или древовидных секций карточки.

Returns CardTypeColumn[]
- Defined in @tessa/platform/src/cards/types/cardTypeTableControl.ts:68
set columns(value: CardTypeColumn[]): void
Parameters
- value: CardTypeColumn[]
Returns void
- Defined in @tessa/platform/src/cards/types/cardTypeTableControl.ts:71

controlSettings

get controlSettings(): IStorage<unknown>
Настройки используемого элемента управления, тип которого задан в свойстве type.

Returns IStorage<unknown>
Inherited from CardTypeControl.controlSettings
- Defined in @tessa/platform/src/cards/types/cardTypeControl.ts:53
set controlSettings(value: IStorage<unknown>): void
Parameters
- value: IStorage<unknown>
Returns void
Inherited from CardTypeControl.controlSettings
- Defined in @tessa/platform/src/cards/types/cardTypeControl.ts:56

form

get form(): CardTypeTableForm
Объект, описывающий пользовательский интерфейс для редактирования строки коллекционной или древовидной секции.

Returns CardTypeTableForm
- Defined in @tessa/platform/src/cards/types/cardTypeTableControl.ts:58
set form(value: CardTypeTableForm): void
Parameters
- value: CardTypeTableForm
Returns void
- Defined in @tessa/platform/src/cards/types/cardTypeTableControl.ts:61

type

get type(): CardControlType
Тип используемого элемента управления.

Returns CardControlType
Inherited from CardTypeControl.type
- Defined in @tessa/platform/src/cards/types/cardTypeControl.ts:43
set type(value: CardControlType): void
Parameters
- value: CardControlType
Returns void
Inherited from CardTypeControl.type
- Defined in @tessa/platform/src/cards/types/cardTypeControl.ts:46

Methods

clone

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

Returns CardTypeTableControl
Implementation of ICloneable.clone
- Defined in @tessa/platform/src/cards/types/cardTypeTableControl.ts:145

deserializeFromStorage

deserializeFromStorage(storage: IStorage<unknown>, context?: StorageSerializableContext): CardTypeTableControl
Parameters
- storage: IStorage<unknown>
- Optional context: StorageSerializableContext
Returns CardTypeTableControl
Inherited from CardTypeControl.deserializeFromStorage
- Defined in @tessa/core/src/serialization/storageSerializable.ts:54

getSourceInfo

getSourceInfo(): CardControlSourceInfo
Метод для получения информации об источнике данных контрола с учетом возможной регистрации кастомного метода для получения источника данных в CardControlTypeRegistry.

Returns
Возвращает информацию об источнике данных контрола.

Returns CardControlSourceInfo
Inherited from CardTypeControl.getSourceInfo
- Defined in @tessa/platform/src/cards/_extensionsCard.ts:37

isRequired

isRequired(): boolean
Возвращает признак того, что значение, редактируемое элементом управления, является обязательным для заполнения.

Returns
Признак того, что значение, редактируемое элементом управления, является обязательным для заполнения.

Returns boolean
Overrides CardTypeControl.isRequired
- Defined in @tessa/platform/src/cards/types/cardTypeTableControl.ts:79

isSealed

isSealed(): boolean
Returns boolean
Inherited from CardTypeControl.isSealed
- Defined in @tessa/core/src/serialization/storageSerializable.ts:102

isVisible

isVisible(): boolean
Возвращает признак того, что элемент управления является видимым в интерфейсе.

Returns
Признак того, что элемент управления является видимым в интерфейсе.

Returns boolean
Overrides CardTypeControl.isVisible
- Defined in @tessa/platform/src/cards/types/cardTypeTableControl.ts:83

seal

seal(): CardTypeTableControl
Returns CardTypeTableControl
Inherited from CardTypeControl.seal
- Defined in @tessa/core/src/serialization/storageSerializable.ts:85

serializeToStorage

serializeToStorage(storage?: IStorage<unknown>, context?: StorageSerializableContext): IStorage<unknown>
Parameters
- storage: IStorage<unknown> = {}
- Optional context: StorageSerializableContext
Returns IStorage<unknown>
Inherited from CardTypeControl.serializeToStorage
- Defined in @tessa/core/src/serialization/storageSerializable.ts:44

setRequired

setRequired(required: boolean): CardTypeTableControl
Устанавливает признак того, что значение, редактируемое элементом управления, является обязательным для заполнения. Если элемент управления не поддерживает установку такого признака, то действий не выполняется.

Returns
Текущий объект для цепочки вызовов.
Parameters
- required: boolean
  
  Признак того, что значение, редактируемое элементом управления, является обязательным для заполнения.
Returns CardTypeTableControl
Overrides CardTypeControl.setRequired
- Defined in @tessa/platform/src/cards/types/cardTypeTableControl.ts:87

setVisible

setVisible(visible: boolean): CardTypeTableControl
Устанавливает признак того, что элемент управления является видимым в интерфейсе. Если элемент управления не поддерживает установку такого признака, то действий не выполняется.

Returns
Текущий объект для цепочки вызовов.
Parameters
- visible: boolean
  
  Признак того, что элемент управления является видимым в интерфейсе.
Returns CardTypeTableControl
Overrides CardTypeControl.setVisible
- Defined in @tessa/platform/src/cards/types/cardTypeTableControl.ts:92

Class CardTypeTableControl

Hierarchy

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Returns CardTypeTableControl

Properties

caption

flags

Remarks

name

requiredText

sectionId

toolTip

Accessors

blockSettings

Returns IStorage<unknown>

Parameters

value: IStorage<unknown>

Returns void

columns

Returns CardTypeColumn[]

Parameters

value: CardTypeColumn[]

Returns void

controlSettings

Returns IStorage<unknown>

Parameters

value: IStorage<unknown>

Returns void

form

Returns CardTypeTableForm

Parameters

value: CardTypeTableForm

Returns void

type

Returns CardControlType

Parameters

value: CardControlType

Returns void

Methods

clone

Returns CardTypeTableControl

deserializeFromStorage

Parameters

storage: IStorage<unknown>

Optional context: StorageSerializableContext

Returns CardTypeTableControl

getSourceInfo

Returns

Returns CardControlSourceInfo

isRequired

Returns

Returns boolean

isSealed

Returns boolean

isVisible

Returns

Returns boolean

seal

Returns CardTypeTableControl

serializeToStorage

Parameters

storage: IStorage<unknown> = {}

Optional context: StorageSerializableContext

Returns IStorage<unknown>

setRequired

Returns

Parameters

required: boolean

Returns CardTypeTableControl

setVisible

Returns

Parameters

visible: boolean

`Optional` context: StorageSerializableContext

`Optional` context: StorageSerializableContext