@sankhyalabs/sankhyablocks 9.2.0-dev.12 → 9.2.0-dev.13
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/cjs/snk-personalized-filter.cjs.entry.js +10 -2
- package/dist/cjs/snk-simple-crud.cjs.entry.js +45 -8
- package/dist/collection/components/snk-personalized-filter/snk-personalized-filter.js +83 -21
- package/dist/collection/components/snk-simple-crud/snk-simple-crud.js +414 -119
- package/dist/components/snk-personalized-filter2.js +10 -2
- package/dist/components/snk-simple-crud2.js +45 -8
- package/dist/esm/snk-personalized-filter.entry.js +10 -2
- package/dist/esm/snk-simple-crud.entry.js +45 -8
- package/dist/types/components/snk-personalized-filter/snk-personalized-filter.d.ts +53 -5
- package/dist/types/components/snk-simple-crud/snk-simple-crud.d.ts +100 -43
- package/dist/types/components.d.ts +180 -70
- package/package.json +1 -1
@@ -45,8 +45,10 @@ const SnkPersonalizedFilter = /*@__PURE__*/ proxyCustomElement(class extends HTM
|
|
45
45
|
this.resourceID = undefined;
|
46
46
|
this.isDefaultFilter = false;
|
47
47
|
}
|
48
|
-
|
49
|
-
* Cria um novo filtro
|
48
|
+
/**
|
49
|
+
* Cria um novo filtro personalizado caso não exista nenhum.
|
50
|
+
* @method
|
51
|
+
* @returns {Promise<void>}
|
50
52
|
*/
|
51
53
|
async createPersonalizedFilter() {
|
52
54
|
const newPersonalizedFilter = {
|
@@ -82,6 +84,12 @@ const SnkPersonalizedFilter = /*@__PURE__*/ proxyCustomElement(class extends HTM
|
|
82
84
|
this._originalFilterAssistent = ObjectUtils.copy(newPersonalizedFilter);
|
83
85
|
this._filterAssistent = ObjectUtils.copy(newPersonalizedFilter);
|
84
86
|
}
|
87
|
+
/**
|
88
|
+
* Carrega o filtro personalizado com base no identificador informado.
|
89
|
+
* @watch filterId
|
90
|
+
* @param newValue Novo valor do filtroId.
|
91
|
+
* @param oldValue Valor anterior do filtroId.
|
92
|
+
*/
|
85
93
|
loadFilter(newValue, oldValue) {
|
86
94
|
if (newValue == null || oldValue == newValue || this.resourceID == undefined) {
|
87
95
|
return;
|
@@ -86,7 +86,10 @@ const SnkSimpleCrud = /*@__PURE__*/ proxyCustomElement(class extends HTMLElement
|
|
86
86
|
this.outlineMode = false;
|
87
87
|
}
|
88
88
|
/**
|
89
|
-
* Registra um editor customizado para campos da grade e formulário.
|
89
|
+
* @description Registra um editor customizado para campos da grade e do formulário.
|
90
|
+
* @param {string} fieldName - O nome do campo.
|
91
|
+
* @param {ICustomEditor} customEditor - A instância do editor customizado.
|
92
|
+
* @returns {Promise<void>}
|
90
93
|
*/
|
91
94
|
async addCustomEditor(fieldName, customEditor) {
|
92
95
|
if (this._grid && this._form) {
|
@@ -99,7 +102,10 @@ const SnkSimpleCrud = /*@__PURE__*/ proxyCustomElement(class extends HTMLElement
|
|
99
102
|
this._customEditors = newCustomEditors;
|
100
103
|
}
|
101
104
|
/**
|
102
|
-
* Registra um
|
105
|
+
* @description Registra um renderizador customizado para colunas da grade.
|
106
|
+
* @param {string} fieldName - O nome do campo.
|
107
|
+
* @param {ICustomRender} customRender - A instância do renderizador customizado.
|
108
|
+
* @returns {Promise<void>}
|
103
109
|
*/
|
104
110
|
async addGridCustomRender(fieldName, customRender) {
|
105
111
|
if (this._grid) {
|
@@ -121,19 +127,28 @@ const SnkSimpleCrud = /*@__PURE__*/ proxyCustomElement(class extends HTMLElement
|
|
121
127
|
await this.loadGridConfig(true);
|
122
128
|
}
|
123
129
|
/**
|
124
|
-
* Registra um formatador de valores para uma coluna da
|
130
|
+
* @description Registra um formatador de valores para uma coluna da grade.
|
131
|
+
* @param {string} columnName - O nome da coluna.
|
132
|
+
* @param {ICustomFormatter} customFormatter - A instância do formatador customizado.
|
133
|
+
* @returns {Promise<void>}
|
125
134
|
*/
|
126
135
|
async addCustomValueFormatter(columnName, customFormatter) {
|
127
136
|
this._grid.addCustomValueFormatter(columnName, customFormatter);
|
128
137
|
}
|
129
138
|
/**
|
130
|
-
* Remove o formatador de valores de uma coluna da
|
139
|
+
* @description Remove o formatador de valores de uma coluna da grade.
|
140
|
+
* @param {string} columnName - O nome da coluna.
|
141
|
+
* @returns {Promise<void>}
|
131
142
|
*/
|
132
143
|
async removeCustomValueFormatter(columnName) {
|
133
144
|
this._grid.removeCustomValueFormatter(columnName);
|
134
145
|
}
|
135
146
|
/**
|
136
|
-
* Altera/adiciona uma propriedade nos metadados do campo.
|
147
|
+
* @description Altera/adiciona uma propriedade nos metadados do campo.
|
148
|
+
* @param {string} fieldName - O nome do campo.
|
149
|
+
* @param {string} propName - O nome da propriedade.
|
150
|
+
* @param {any} value - O valor da propriedade.
|
151
|
+
* @returns {Promise<void>}
|
137
152
|
*/
|
138
153
|
async setFieldProp(fieldName, propName, value) {
|
139
154
|
const newCustomFieldProps = new Map(this._fieldsProps);
|
@@ -190,7 +205,9 @@ const SnkSimpleCrud = /*@__PURE__*/ proxyCustomElement(class extends HTMLElement
|
|
190
205
|
return newTaskBarConfig;
|
191
206
|
}
|
192
207
|
/**
|
193
|
-
* Usado para alternar a visão entre GRID e FORM externamente.
|
208
|
+
* @description Usado para alternar a visão entre GRID e FORM externamente.
|
209
|
+
* @param {VIEW_MODE} view - A visão para a qual navegar.
|
210
|
+
* @returns {Promise<void>}
|
194
211
|
*/
|
195
212
|
async goToView(view) {
|
196
213
|
this._currentViewMode = view;
|
@@ -464,6 +481,11 @@ const SnkSimpleCrud = /*@__PURE__*/ proxyCustomElement(class extends HTMLElement
|
|
464
481
|
this.dataUnit = this._inMemoryLoader.dataUnit;
|
465
482
|
this.dataUnitReady.emit(this.dataUnit);
|
466
483
|
}
|
484
|
+
/**
|
485
|
+
* @description Define os metadados do DataUnit.
|
486
|
+
* @param {UnitMetadata} metadata - Os metadados a serem definidos.
|
487
|
+
* @returns {Promise<void>}
|
488
|
+
*/
|
467
489
|
setMetadata(metadata) {
|
468
490
|
if (this._inMemoryLoader) {
|
469
491
|
this._inMemoryLoader.metadata = metadata;
|
@@ -473,6 +495,11 @@ const SnkSimpleCrud = /*@__PURE__*/ proxyCustomElement(class extends HTMLElement
|
|
473
495
|
}
|
474
496
|
return Promise.resolve();
|
475
497
|
}
|
498
|
+
/**
|
499
|
+
* @description Define os registros do DataUnit.
|
500
|
+
* @param {Array<Record>} records - Os registros a serem definidos.
|
501
|
+
* @returns {Promise<void>}
|
502
|
+
*/
|
476
503
|
setRecords(records) {
|
477
504
|
if (this._inMemoryLoader) {
|
478
505
|
this._inMemoryLoader.records = records;
|
@@ -482,23 +509,33 @@ const SnkSimpleCrud = /*@__PURE__*/ proxyCustomElement(class extends HTMLElement
|
|
482
509
|
}
|
483
510
|
return Promise.resolve();
|
484
511
|
}
|
512
|
+
/**
|
513
|
+
* @description Obtém os registros do DataUnit.
|
514
|
+
* @returns {Promise<Array<Record>>} Uma promessa que resolve com a lista de registros.
|
515
|
+
*/
|
485
516
|
getRecords() {
|
486
517
|
return Promise.resolve(this.dataUnit.records);
|
487
518
|
}
|
488
519
|
/**
|
489
|
-
* Usado para abrir o
|
520
|
+
* @description Usado para abrir o configurador do CRUD.
|
521
|
+
* @returns {Promise<void>}
|
490
522
|
*/
|
491
523
|
async openConfigurator() {
|
492
524
|
var _a;
|
493
525
|
(_a = this._snkConfigurator) === null || _a === void 0 ? void 0 : _a.open();
|
494
526
|
}
|
495
527
|
/**
|
496
|
-
* Usado para fechar o
|
528
|
+
* @description Usado para fechar o configurador do CRUD.
|
529
|
+
* @returns {Promise<void>}
|
497
530
|
*/
|
498
531
|
async closeConfigurator() {
|
499
532
|
var _a;
|
500
533
|
(_a = this._snkConfigurator) === null || _a === void 0 ? void 0 : _a.close();
|
501
534
|
}
|
535
|
+
/**
|
536
|
+
* @description Atualiza a configuração do formulário.
|
537
|
+
* @returns {Promise<void>}
|
538
|
+
*/
|
502
539
|
async updateConfig() {
|
503
540
|
if (this._formConfigManager == undefined) {
|
504
541
|
this._formConfigManager = new SnkFormConfigManager(this.configName, this.resolveResourceID());
|
@@ -43,8 +43,10 @@ const SnkPersonalizedFilter = class {
|
|
43
43
|
this.resourceID = undefined;
|
44
44
|
this.isDefaultFilter = false;
|
45
45
|
}
|
46
|
-
|
47
|
-
* Cria um novo filtro
|
46
|
+
/**
|
47
|
+
* Cria um novo filtro personalizado caso não exista nenhum.
|
48
|
+
* @method
|
49
|
+
* @returns {Promise<void>}
|
48
50
|
*/
|
49
51
|
async createPersonalizedFilter() {
|
50
52
|
const newPersonalizedFilter = {
|
@@ -80,6 +82,12 @@ const SnkPersonalizedFilter = class {
|
|
80
82
|
this._originalFilterAssistent = ObjectUtils.copy(newPersonalizedFilter);
|
81
83
|
this._filterAssistent = ObjectUtils.copy(newPersonalizedFilter);
|
82
84
|
}
|
85
|
+
/**
|
86
|
+
* Carrega o filtro personalizado com base no identificador informado.
|
87
|
+
* @watch filterId
|
88
|
+
* @param newValue Novo valor do filtroId.
|
89
|
+
* @param oldValue Valor anterior do filtroId.
|
90
|
+
*/
|
83
91
|
loadFilter(newValue, oldValue) {
|
84
92
|
if (newValue == null || oldValue == newValue || this.resourceID == undefined) {
|
85
93
|
return;
|
@@ -82,7 +82,10 @@ const SnkSimpleCrud = class {
|
|
82
82
|
this.outlineMode = false;
|
83
83
|
}
|
84
84
|
/**
|
85
|
-
* Registra um editor customizado para campos da grade e formulário.
|
85
|
+
* @description Registra um editor customizado para campos da grade e do formulário.
|
86
|
+
* @param {string} fieldName - O nome do campo.
|
87
|
+
* @param {ICustomEditor} customEditor - A instância do editor customizado.
|
88
|
+
* @returns {Promise<void>}
|
86
89
|
*/
|
87
90
|
async addCustomEditor(fieldName, customEditor) {
|
88
91
|
if (this._grid && this._form) {
|
@@ -95,7 +98,10 @@ const SnkSimpleCrud = class {
|
|
95
98
|
this._customEditors = newCustomEditors;
|
96
99
|
}
|
97
100
|
/**
|
98
|
-
* Registra um
|
101
|
+
* @description Registra um renderizador customizado para colunas da grade.
|
102
|
+
* @param {string} fieldName - O nome do campo.
|
103
|
+
* @param {ICustomRender} customRender - A instância do renderizador customizado.
|
104
|
+
* @returns {Promise<void>}
|
99
105
|
*/
|
100
106
|
async addGridCustomRender(fieldName, customRender) {
|
101
107
|
if (this._grid) {
|
@@ -117,19 +123,28 @@ const SnkSimpleCrud = class {
|
|
117
123
|
await this.loadGridConfig(true);
|
118
124
|
}
|
119
125
|
/**
|
120
|
-
* Registra um formatador de valores para uma coluna da
|
126
|
+
* @description Registra um formatador de valores para uma coluna da grade.
|
127
|
+
* @param {string} columnName - O nome da coluna.
|
128
|
+
* @param {ICustomFormatter} customFormatter - A instância do formatador customizado.
|
129
|
+
* @returns {Promise<void>}
|
121
130
|
*/
|
122
131
|
async addCustomValueFormatter(columnName, customFormatter) {
|
123
132
|
this._grid.addCustomValueFormatter(columnName, customFormatter);
|
124
133
|
}
|
125
134
|
/**
|
126
|
-
* Remove o formatador de valores de uma coluna da
|
135
|
+
* @description Remove o formatador de valores de uma coluna da grade.
|
136
|
+
* @param {string} columnName - O nome da coluna.
|
137
|
+
* @returns {Promise<void>}
|
127
138
|
*/
|
128
139
|
async removeCustomValueFormatter(columnName) {
|
129
140
|
this._grid.removeCustomValueFormatter(columnName);
|
130
141
|
}
|
131
142
|
/**
|
132
|
-
* Altera/adiciona uma propriedade nos metadados do campo.
|
143
|
+
* @description Altera/adiciona uma propriedade nos metadados do campo.
|
144
|
+
* @param {string} fieldName - O nome do campo.
|
145
|
+
* @param {string} propName - O nome da propriedade.
|
146
|
+
* @param {any} value - O valor da propriedade.
|
147
|
+
* @returns {Promise<void>}
|
133
148
|
*/
|
134
149
|
async setFieldProp(fieldName, propName, value) {
|
135
150
|
const newCustomFieldProps = new Map(this._fieldsProps);
|
@@ -186,7 +201,9 @@ const SnkSimpleCrud = class {
|
|
186
201
|
return newTaskBarConfig;
|
187
202
|
}
|
188
203
|
/**
|
189
|
-
* Usado para alternar a visão entre GRID e FORM externamente.
|
204
|
+
* @description Usado para alternar a visão entre GRID e FORM externamente.
|
205
|
+
* @param {VIEW_MODE} view - A visão para a qual navegar.
|
206
|
+
* @returns {Promise<void>}
|
190
207
|
*/
|
191
208
|
async goToView(view) {
|
192
209
|
this._currentViewMode = view;
|
@@ -460,6 +477,11 @@ const SnkSimpleCrud = class {
|
|
460
477
|
this.dataUnit = this._inMemoryLoader.dataUnit;
|
461
478
|
this.dataUnitReady.emit(this.dataUnit);
|
462
479
|
}
|
480
|
+
/**
|
481
|
+
* @description Define os metadados do DataUnit.
|
482
|
+
* @param {UnitMetadata} metadata - Os metadados a serem definidos.
|
483
|
+
* @returns {Promise<void>}
|
484
|
+
*/
|
463
485
|
setMetadata(metadata) {
|
464
486
|
if (this._inMemoryLoader) {
|
465
487
|
this._inMemoryLoader.metadata = metadata;
|
@@ -469,6 +491,11 @@ const SnkSimpleCrud = class {
|
|
469
491
|
}
|
470
492
|
return Promise.resolve();
|
471
493
|
}
|
494
|
+
/**
|
495
|
+
* @description Define os registros do DataUnit.
|
496
|
+
* @param {Array<Record>} records - Os registros a serem definidos.
|
497
|
+
* @returns {Promise<void>}
|
498
|
+
*/
|
472
499
|
setRecords(records) {
|
473
500
|
if (this._inMemoryLoader) {
|
474
501
|
this._inMemoryLoader.records = records;
|
@@ -478,23 +505,33 @@ const SnkSimpleCrud = class {
|
|
478
505
|
}
|
479
506
|
return Promise.resolve();
|
480
507
|
}
|
508
|
+
/**
|
509
|
+
* @description Obtém os registros do DataUnit.
|
510
|
+
* @returns {Promise<Array<Record>>} Uma promessa que resolve com a lista de registros.
|
511
|
+
*/
|
481
512
|
getRecords() {
|
482
513
|
return Promise.resolve(this.dataUnit.records);
|
483
514
|
}
|
484
515
|
/**
|
485
|
-
* Usado para abrir o
|
516
|
+
* @description Usado para abrir o configurador do CRUD.
|
517
|
+
* @returns {Promise<void>}
|
486
518
|
*/
|
487
519
|
async openConfigurator() {
|
488
520
|
var _a;
|
489
521
|
(_a = this._snkConfigurator) === null || _a === void 0 ? void 0 : _a.open();
|
490
522
|
}
|
491
523
|
/**
|
492
|
-
* Usado para fechar o
|
524
|
+
* @description Usado para fechar o configurador do CRUD.
|
525
|
+
* @returns {Promise<void>}
|
493
526
|
*/
|
494
527
|
async closeConfigurator() {
|
495
528
|
var _a;
|
496
529
|
(_a = this._snkConfigurator) === null || _a === void 0 ? void 0 : _a.close();
|
497
530
|
}
|
531
|
+
/**
|
532
|
+
* @description Atualiza a configuração do formulário.
|
533
|
+
* @returns {Promise<void>}
|
534
|
+
*/
|
498
535
|
async updateConfig() {
|
499
536
|
if (this._formConfigManager == undefined) {
|
500
537
|
this._formConfigManager = new SnkFormConfigManager(this.configName, this.resolveResourceID());
|
@@ -1,3 +1,21 @@
|
|
1
|
+
/**
|
2
|
+
* Componente responsável pela criação, edição e gerenciamento de filtros personalizados.
|
3
|
+
*
|
4
|
+
* Permite alternar entre os modos assistente e avançado, salvar, cancelar e manipular filtros.
|
5
|
+
*
|
6
|
+
* @component
|
7
|
+
* @example
|
8
|
+
* <snk-personalized-filter
|
9
|
+
* entityUri="sua/entidade"
|
10
|
+
* filterId="idFiltro"
|
11
|
+
* configName="nomeConfig"
|
12
|
+
* resourceID="resourceId"
|
13
|
+
* isDefaultFilter={false}
|
14
|
+
* messagesBuilder={messagesBuilderInstance}
|
15
|
+
* onEzSave={handler}
|
16
|
+
* onEzCancel={handler}
|
17
|
+
* />
|
18
|
+
*/
|
1
19
|
import { EventEmitter } from '../../stencil-public-runtime';
|
2
20
|
import { IFilterLink, IFilterField, FilterFieldsDataSource } from "../snk-filter-field-search/interfaces";
|
3
21
|
import { SnkMessageBuilder } from '../../lib/message/SnkMessageBuilder';
|
@@ -16,32 +34,62 @@ export declare class SnkPersonalizedFilter {
|
|
16
34
|
private _filterAssistent;
|
17
35
|
/**
|
18
36
|
* Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção.
|
37
|
+
* @property
|
19
38
|
*/
|
20
39
|
messagesBuilder: SnkMessageBuilder;
|
21
40
|
/**
|
22
|
-
*
|
41
|
+
* URI da entidade utilizada para buscar os campos disponíveis para filtro.
|
42
|
+
* @property
|
23
43
|
*/
|
24
44
|
entityUri: string;
|
25
45
|
/**
|
26
|
-
*
|
46
|
+
* Identificador do filtro a ser carregado.
|
47
|
+
* @property
|
27
48
|
*/
|
28
49
|
filterId: string;
|
29
50
|
/**
|
30
|
-
* Nome da configuração
|
51
|
+
* Nome da configuração, utilizado para distinguir múltiplas instâncias do componente.
|
52
|
+
* @property
|
31
53
|
*/
|
32
54
|
configName: string;
|
33
55
|
/**
|
34
|
-
*
|
56
|
+
* Identificador do recurso utilizado para salvar e recuperar filtros.
|
57
|
+
* @property
|
35
58
|
*/
|
36
59
|
resourceID: string;
|
37
60
|
/**
|
38
|
-
*
|
61
|
+
* Indica se o filtro é o filtro padrão do sistema.
|
62
|
+
* @property
|
63
|
+
* @default false
|
39
64
|
*/
|
40
65
|
isDefaultFilter: boolean;
|
66
|
+
/**
|
67
|
+
* Evento emitido ao cancelar a personalização do filtro.
|
68
|
+
* @event
|
69
|
+
*/
|
41
70
|
ezCancel: EventEmitter<void>;
|
71
|
+
/**
|
72
|
+
* Evento emitido ao salvar as alterações do filtro personalizado.
|
73
|
+
* @event
|
74
|
+
*/
|
42
75
|
ezSave: EventEmitter<string>;
|
76
|
+
/**
|
77
|
+
* Evento emitido após salvar as alterações do filtro personalizado.
|
78
|
+
* @event
|
79
|
+
*/
|
43
80
|
ezAfterSave: EventEmitter<void>;
|
81
|
+
/**
|
82
|
+
* Cria um novo filtro personalizado caso não exista nenhum.
|
83
|
+
* @method
|
84
|
+
* @returns {Promise<void>}
|
85
|
+
*/
|
44
86
|
createPersonalizedFilter(): Promise<void>;
|
87
|
+
/**
|
88
|
+
* Carrega o filtro personalizado com base no identificador informado.
|
89
|
+
* @watch filterId
|
90
|
+
* @param newValue Novo valor do filtroId.
|
91
|
+
* @param oldValue Valor anterior do filtroId.
|
92
|
+
*/
|
45
93
|
loadFilter(newValue: string, oldValue: string): void;
|
46
94
|
_dataSourceFetcher: FilterFieldsDataSource;
|
47
95
|
componentWillLoad(): void;
|
@@ -46,152 +46,187 @@ export declare class SnkSimpleCrud {
|
|
46
46
|
_fieldToGetFocus: string;
|
47
47
|
_customContainerId: string;
|
48
48
|
/**
|
49
|
-
* Define se o componente deve usar o LockManager para controle de carregamento da aplicação
|
49
|
+
* @description Define se o componente deve usar o LockManager para controle de carregamento da aplicação.
|
50
50
|
*/
|
51
51
|
enableLockManagerLoadingComp?: boolean;
|
52
52
|
/**
|
53
|
-
* Ativa o gerenciamento de locks na grade pela Taskbar.
|
53
|
+
* @description Ativa o gerenciamento de locks na grade pela Taskbar.
|
54
54
|
*/
|
55
55
|
enableLockManagerTaskbarClick?: boolean;
|
56
|
+
/**
|
57
|
+
* @description Estado atual dos dados.
|
58
|
+
*/
|
56
59
|
dataState: DataState;
|
60
|
+
/**
|
61
|
+
* @description Instância do DataUnit a ser utilizada pelo componente.
|
62
|
+
*/
|
57
63
|
dataUnit: DataUnit;
|
58
64
|
/**
|
59
|
-
* Define o nome da entidade que o componente vai utilizar para fazer as operações de CRUD
|
65
|
+
* @description Define o nome da entidade que o componente vai utilizar para fazer as operações de CRUD.
|
60
66
|
*/
|
61
67
|
entityName: string;
|
68
|
+
/**
|
69
|
+
* @description Define o modo de operação do CRUD (servidor ou em memória).
|
70
|
+
*/
|
62
71
|
mode: SIMPLE_CRUD_MODE;
|
72
|
+
/**
|
73
|
+
* @description Configuração da grade.
|
74
|
+
*/
|
63
75
|
gridConfig: IGridConfig;
|
76
|
+
/**
|
77
|
+
* @description Configuração do formulário.
|
78
|
+
*/
|
64
79
|
formConfig: IFormConfig;
|
65
80
|
_formFields: IFieldConfig[];
|
66
81
|
private _fieldsProps;
|
82
|
+
/**
|
83
|
+
* @description Habilita a inserção contínua de registros.
|
84
|
+
*/
|
67
85
|
enableContinuousInsert: boolean;
|
68
86
|
/**
|
69
|
-
* Determina se pode haver mais de uma linha selecionada na grade.
|
87
|
+
* @description Determina se pode haver mais de uma linha selecionada na grade.
|
70
88
|
*/
|
71
89
|
multipleSelection: boolean;
|
90
|
+
/**
|
91
|
+
* @description Determina se será usada mensagem de confirmação padrão na tentativa de cancelar a edição.
|
92
|
+
*/
|
72
93
|
useCancelConfirm: boolean;
|
73
94
|
/**
|
74
|
-
* Determina quantas linhas são retornadas por página.
|
95
|
+
* @description Determina quantas linhas são retornadas por página.
|
75
96
|
*/
|
76
97
|
pageSize: number;
|
77
98
|
/**
|
78
|
-
* Identificador de recursos como configurações e acesso.
|
99
|
+
* @description Identificador de recursos como configurações e acesso.
|
79
100
|
*/
|
80
101
|
resourceID: string;
|
81
102
|
/**
|
82
|
-
* Ativa inserção de registros no modo grade.
|
103
|
+
* @description Ativa a inserção de registros no modo grade.
|
83
104
|
*/
|
84
105
|
enableGridInsert?: boolean;
|
85
106
|
/**
|
86
|
-
* Define
|
107
|
+
* @description Define o modo de exibição do contador de paginação.
|
87
108
|
*/
|
88
109
|
paginationCounterMode?: 'show' | 'hidden' | 'auto';
|
89
110
|
/**
|
90
|
-
* Emitido quando há qualquer mudança de estado no DataUnit.
|
111
|
+
* @description Emitido quando há qualquer mudança de estado no DataUnit.
|
91
112
|
*/
|
92
113
|
dataStateChange: EventEmitter<DataState>;
|
93
114
|
/**
|
94
|
-
* Emitido quando o DataUnit está pronto.
|
115
|
+
* @description Emitido quando o DataUnit está pronto.
|
95
116
|
*/
|
96
117
|
dataUnitReady: EventEmitter<DataUnit>;
|
97
118
|
/**
|
98
|
-
* Emitido sempre que houver
|
119
|
+
* @description Emitido sempre que houver clique de botão ou ação na barra de tarefas.
|
99
120
|
*/
|
100
121
|
actionClick: EventEmitter<string>;
|
101
122
|
/**
|
102
|
-
* Responsável por notificar quando ocorrer a renderização de itens do formulário.
|
123
|
+
* @description Responsável por notificar quando ocorrer a renderização de itens do formulário.
|
103
124
|
*/
|
104
125
|
formItemsReady: EventEmitter<Array<HTMLElement>>;
|
105
126
|
/**
|
106
|
-
* Emitido quando
|
127
|
+
* @description Emitido quando a configuração no configurador do CRUD é salva.
|
107
128
|
*/
|
108
129
|
configuratorSave: EventEmitter<any>;
|
109
130
|
/**
|
110
|
-
* Emitido quando
|
131
|
+
* @description Emitido quando o salvamento da configuração no configurador do CRUD é cancelado.
|
111
132
|
*/
|
112
133
|
configuratorCancel: EventEmitter<any>;
|
113
134
|
/**
|
114
|
-
|
115
|
-
|
116
|
-
*/
|
135
|
+
* @description Gerenciador das barras de tarefas. É possível determinar botões específicos ou mesmo gerenciar o estado dos botões.
|
136
|
+
*/
|
117
137
|
taskbarManager: TaskbarManager;
|
118
138
|
/**
|
119
|
-
* Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção.
|
139
|
+
* @description Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção.
|
120
140
|
*/
|
121
141
|
messagesBuilder: SnkMessageBuilder;
|
122
142
|
/**
|
123
|
-
* Quando verdadeiro, o ENTER fará a navegação como se fosse a tecla TAB na grade.
|
143
|
+
* @description Quando verdadeiro, o ENTER fará a navegação como se fosse a tecla TAB na grade.
|
124
144
|
*/
|
125
145
|
useEnterLikeTab: boolean;
|
126
146
|
/**
|
127
|
-
* Ações a serem colocadas no botão "Mais opções" do componente snk-taskbar.
|
147
|
+
* @description Ações a serem colocadas no botão "Mais opções" do componente snk-taskbar.
|
128
148
|
*/
|
129
149
|
actionsList: Array<Action>;
|
130
150
|
/**
|
131
|
-
* Usado para salvar as configurações dos blocos de construção.
|
151
|
+
* @description Usado para salvar as configurações dos blocos de construção.
|
132
152
|
*/
|
133
153
|
configName: string;
|
134
154
|
/**
|
135
|
-
* Usado para exibir os botões de ação do snk-configurator.
|
155
|
+
* @description Usado para exibir os botões de ação do snk-configurator.
|
136
156
|
*/
|
137
157
|
showConfiguratorButtons: boolean;
|
138
158
|
/**
|
139
|
-
* Chave da configuração
|
159
|
+
* @description Chave da configuração legada da grade.
|
140
160
|
*/
|
141
161
|
gridLegacyConfigName: string;
|
142
162
|
/**
|
143
|
-
* Chave da configuração
|
163
|
+
* @description Chave da configuração legada do formulário.
|
144
164
|
*/
|
145
165
|
formLegacyConfigName: string;
|
146
166
|
/**
|
147
|
-
* Ignora os campos "somente leitura" no modo de inserção.
|
167
|
+
* @description Ignora os campos "somente leitura" no modo de inserção.
|
148
168
|
*/
|
149
169
|
ignoreReadOnlyFormFields: boolean;
|
150
170
|
/**
|
151
|
-
* Define se a
|
171
|
+
* @description Define se a grade será focada ao ser carregada.
|
152
172
|
*/
|
153
173
|
autoFocus?: boolean;
|
154
174
|
/**
|
155
|
-
|
156
|
-
|
175
|
+
* @description Define a chave customizada para sobrescrever as mensagens (não pegando pela entidade).
|
176
|
+
*/
|
157
177
|
domainMessagesBuilder: string;
|
158
178
|
/**
|
159
|
-
* Habilita a edição de múltiplos registros simultâneos.
|
179
|
+
* @description Habilita a edição de múltiplos registros simultâneos.
|
160
180
|
*/
|
161
181
|
multipleEditionEnabled: boolean;
|
162
182
|
/**
|
163
|
-
* Define se o LayoutFormConfig será exibido no configurador.
|
183
|
+
* @description Define se o LayoutFormConfig será exibido no configurador.
|
164
184
|
*/
|
165
185
|
layoutFormConfig: boolean;
|
166
186
|
/**
|
167
|
-
* Registra um editor customizado para campos da grade e formulário.
|
187
|
+
* @description Registra um editor customizado para campos da grade e do formulário.
|
188
|
+
* @param {string} fieldName - O nome do campo.
|
189
|
+
* @param {ICustomEditor} customEditor - A instância do editor customizado.
|
190
|
+
* @returns {Promise<void>}
|
168
191
|
*/
|
169
192
|
addCustomEditor(fieldName: string, customEditor: ICustomEditor): Promise<void>;
|
170
193
|
/**
|
171
|
-
* Registra um
|
194
|
+
* @description Registra um renderizador customizado para colunas da grade.
|
195
|
+
* @param {string} fieldName - O nome do campo.
|
196
|
+
* @param {ICustomRender} customRender - A instância do renderizador customizado.
|
197
|
+
* @returns {Promise<void>}
|
172
198
|
*/
|
173
199
|
addGridCustomRender(fieldName: string, customRender: ICustomRender): Promise<void>;
|
174
200
|
/**
|
175
|
-
* Define se a carga dos dados será feita assim que o componente for carregado.
|
201
|
+
* @description Define se a carga dos dados será feita assim que o componente for carregado.
|
176
202
|
*/
|
177
203
|
autoLoad?: boolean;
|
178
204
|
/**
|
179
|
-
|
180
|
-
|
181
|
-
|
182
|
-
|
205
|
+
* @description Altera visualmente as sombras e bordas do componente.
|
206
|
+
* Quando `false`, aplica o padrão de sombras ao componente (utilizar quando for o elemento principal do layout).
|
207
|
+
* Quando `true`, aplica o padrão de contorno ao componente (utilizar quando estiver contido em outro elemento como um painel ou pop-up).
|
208
|
+
*/
|
183
209
|
outlineMode?: boolean;
|
184
210
|
handleResourceIDChanged(newValue: string, oldValue: string): Promise<void>;
|
185
211
|
/**
|
186
|
-
* Registra um formatador de valores para uma coluna da
|
212
|
+
* @description Registra um formatador de valores para uma coluna da grade.
|
213
|
+
* @param {string} columnName - O nome da coluna.
|
214
|
+
* @param {ICustomFormatter} customFormatter - A instância do formatador customizado.
|
215
|
+
* @returns {Promise<void>}
|
187
216
|
*/
|
188
217
|
addCustomValueFormatter(columnName: string, customFormatter: ICustomFormatter): Promise<void>;
|
189
218
|
/**
|
190
|
-
* Remove o formatador de valores de uma coluna da
|
219
|
+
* @description Remove o formatador de valores de uma coluna da grade.
|
220
|
+
* @param {string} columnName - O nome da coluna.
|
221
|
+
* @returns {Promise<void>}
|
191
222
|
*/
|
192
223
|
removeCustomValueFormatter(columnName: string): Promise<void>;
|
193
224
|
/**
|
194
|
-
* Altera/adiciona uma propriedade nos metadados do campo.
|
225
|
+
* @description Altera/adiciona uma propriedade nos metadados do campo.
|
226
|
+
* @param {string} fieldName - O nome do campo.
|
227
|
+
* @param {string} propName - O nome da propriedade.
|
228
|
+
* @param {any} value - O valor da propriedade.
|
229
|
+
* @returns {Promise<void>}
|
195
230
|
*/
|
196
231
|
setFieldProp(fieldName: string, propName: string, value: any): Promise<void>;
|
197
232
|
private loadTaskbarProcessor;
|
@@ -202,7 +237,9 @@ export declare class SnkSimpleCrud {
|
|
202
237
|
private get application();
|
203
238
|
resolveInMemoryBtns(taskbarButtons: Array<string>): Array<string>;
|
204
239
|
/**
|
205
|
-
* Usado para alternar a visão entre GRID e FORM externamente.
|
240
|
+
* @description Usado para alternar a visão entre GRID e FORM externamente.
|
241
|
+
* @param {VIEW_MODE} view - A visão para a qual navegar.
|
242
|
+
* @returns {Promise<void>}
|
206
243
|
*/
|
207
244
|
goToView(view: VIEW_MODE): Promise<void>;
|
208
245
|
actionClickListener(evt: CustomEvent): void;
|
@@ -236,17 +273,37 @@ export declare class SnkSimpleCrud {
|
|
236
273
|
private setFieldsProps;
|
237
274
|
getTaskBarId(): string;
|
238
275
|
initInMemoryDataUnit(): void;
|
276
|
+
/**
|
277
|
+
* @description Define os metadados do DataUnit.
|
278
|
+
* @param {UnitMetadata} metadata - Os metadados a serem definidos.
|
279
|
+
* @returns {Promise<void>}
|
280
|
+
*/
|
239
281
|
setMetadata(metadata: UnitMetadata): Promise<void>;
|
282
|
+
/**
|
283
|
+
* @description Define os registros do DataUnit.
|
284
|
+
* @param {Array<Record>} records - Os registros a serem definidos.
|
285
|
+
* @returns {Promise<void>}
|
286
|
+
*/
|
240
287
|
setRecords(records: Array<Record>): Promise<void>;
|
288
|
+
/**
|
289
|
+
* @description Obtém os registros do DataUnit.
|
290
|
+
* @returns {Promise<Array<Record>>} Uma promessa que resolve com a lista de registros.
|
291
|
+
*/
|
241
292
|
getRecords(): Promise<Array<Record>>;
|
242
293
|
/**
|
243
|
-
* Usado para abrir o
|
294
|
+
* @description Usado para abrir o configurador do CRUD.
|
295
|
+
* @returns {Promise<void>}
|
244
296
|
*/
|
245
297
|
openConfigurator(): Promise<void>;
|
246
298
|
/**
|
247
|
-
* Usado para fechar o
|
299
|
+
* @description Usado para fechar o configurador do CRUD.
|
300
|
+
* @returns {Promise<void>}
|
248
301
|
*/
|
249
302
|
closeConfigurator(): Promise<void>;
|
303
|
+
/**
|
304
|
+
* @description Atualiza a configuração do formulário.
|
305
|
+
* @returns {Promise<void>}
|
306
|
+
*/
|
250
307
|
updateConfig(): Promise<void>;
|
251
308
|
processMetadata(): void;
|
252
309
|
private addGridCustomValueFormattters;
|