@sankhyalabs/sankhyablocks 9.2.0-dev.15 → 9.2.0-dev.2
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/loader.cjs.js +1 -1
- package/dist/cjs/sankhyablocks.cjs.js +1 -1
- package/dist/cjs/snk-application.cjs.entry.js +3 -0
- package/dist/cjs/snk-data-exporter.cjs.entry.js +1 -1
- package/dist/cjs/{snk-data-unit-72715da9.js → snk-data-unit-448fce74.js} +1 -11
- package/dist/cjs/snk-data-unit.cjs.entry.js +1 -1
- package/dist/cjs/snk-filter-bar_4.cjs.entry.js +15 -25
- package/dist/cjs/snk-form_2.cjs.entry.js +1 -27
- package/dist/cjs/snk-grid.cjs.entry.js +7 -55
- package/dist/cjs/snk-personalized-filter.cjs.entry.js +2 -10
- package/dist/cjs/snk-simple-bar.cjs.entry.js +5 -5
- package/dist/cjs/snk-simple-crud.cjs.entry.js +8 -45
- package/dist/collection/components/snk-application/snk-application.js +2 -0
- package/dist/collection/components/snk-data-unit/snk-data-unit.js +28 -173
- package/dist/collection/components/snk-filter-bar/snk-filter-bar.js +63 -210
- package/dist/collection/components/snk-form/snk-form.js +22 -133
- package/dist/collection/components/snk-grid/snk-grid.js +83 -333
- package/dist/collection/components/snk-personalized-filter/snk-personalized-filter.js +21 -83
- package/dist/collection/components/snk-pesquisa/snk-pesquisa.js +14 -80
- package/dist/collection/components/snk-simple-bar/snk-simple-bar.js +9 -9
- package/dist/collection/components/snk-simple-crud/snk-simple-crud.js +119 -414
- package/dist/collection/components/snk-taskbar/snk-taskbar.js +36 -102
- package/dist/collection/lib/licenses/sankhyalicense.module.js +1 -0
- package/dist/components/snk-application2.js +3 -0
- package/dist/components/snk-data-unit2.js +1 -11
- package/dist/components/snk-filter-bar2.js +15 -26
- package/dist/components/snk-form.js +2 -29
- package/dist/components/snk-grid2.js +7 -57
- package/dist/components/snk-personalized-filter2.js +2 -10
- package/dist/components/snk-simple-bar2.js +5 -5
- package/dist/components/snk-simple-crud2.js +8 -45
- package/dist/esm/loader.js +1 -1
- package/dist/esm/sankhyablocks.js +1 -1
- package/dist/esm/snk-application.entry.js +3 -0
- package/dist/esm/snk-data-exporter.entry.js +1 -1
- package/dist/esm/{snk-data-unit-d31619fb.js → snk-data-unit-b7e6e7a6.js} +1 -11
- package/dist/esm/snk-data-unit.entry.js +1 -1
- package/dist/esm/snk-filter-bar_4.entry.js +15 -25
- package/dist/esm/snk-form_2.entry.js +1 -27
- package/dist/esm/snk-grid.entry.js +7 -55
- package/dist/esm/snk-personalized-filter.entry.js +2 -10
- package/dist/esm/snk-simple-bar.entry.js +5 -5
- package/dist/esm/snk-simple-crud.entry.js +8 -45
- package/dist/sankhyablocks/p-012208e0.entry.js +1 -0
- package/dist/sankhyablocks/{p-a2e8c7a7.entry.js → p-158adf33.entry.js} +1 -1
- package/dist/sankhyablocks/p-81769310.entry.js +11 -0
- package/dist/sankhyablocks/{p-69b815ab.entry.js → p-8d1508aa.entry.js} +1 -1
- package/dist/sankhyablocks/p-a86eee47.entry.js +1 -0
- package/dist/sankhyablocks/p-fa18530e.entry.js +1 -0
- package/dist/sankhyablocks/sankhyablocks.esm.js +1 -1
- package/dist/types/components/snk-data-unit/snk-data-unit.d.ts +3 -46
- package/dist/types/components/snk-filter-bar/snk-filter-bar.d.ts +28 -45
- package/dist/types/components/snk-form/snk-form.d.ts +4 -29
- package/dist/types/components/snk-grid/snk-grid.d.ts +45 -104
- package/dist/types/components/snk-personalized-filter/snk-personalized-filter.d.ts +5 -53
- package/dist/types/components/snk-pesquisa/snk-pesquisa.d.ts +6 -44
- package/dist/types/components/snk-simple-bar/snk-simple-bar.d.ts +15 -15
- package/dist/types/components/snk-simple-crud/snk-simple-crud.d.ts +43 -100
- package/dist/types/components/snk-taskbar/snk-taskbar.d.ts +21 -23
- package/dist/types/components.d.ts +238 -569
- package/package.json +3 -4
- package/dist/sankhyablocks/p-51464e95.entry.js +0 -1
- package/dist/sankhyablocks/p-665dd170.entry.js +0 -11
- package/dist/sankhyablocks/p-6fa3d474.entry.js +0 -1
- package/dist/sankhyablocks/p-cf7063a4.entry.js +0 -1
- /package/dist/sankhyablocks/{p-8b601472.js → p-0e495575.js} +0 -0
@@ -23,69 +23,60 @@ export declare class SnkFilterBar implements FilterProvider {
|
|
23
23
|
private hasValidValue;
|
24
24
|
_filtersComparator: (a: SnkFilterItemConfig, b: SnkFilterItemConfig) => number;
|
25
25
|
/**
|
26
|
-
*
|
26
|
+
* Define se o componente deve usar o LockManager para controle de carregamento
|
27
27
|
*/
|
28
28
|
enableLockManagerLoadingComp?: boolean;
|
29
29
|
/**
|
30
|
-
*
|
31
|
-
* @param {string} configName - Nome da configuração.
|
32
|
-
* @param {string} resourceId - ID do recurso.
|
33
|
-
* @param {any} options - Opções adicionais.
|
34
|
-
* @returns {Promise<Array<SnkFilterItemConfig>>} Retorna a configuração dos filtros.
|
30
|
+
* Loader customizado para carregar as configurações
|
35
31
|
*/
|
36
32
|
customFilterBarConfig?: (configName: string, resourceId: string, options: any) => Promise<Array<SnkFilterItemConfig>>;
|
37
33
|
/**
|
38
|
-
*
|
34
|
+
* Recebe o DataUnit do ambiente. Se não for informado, procura pela referência
|
39
35
|
* do SnkDataUnit. Necessário para se registrar como provedor de filtros.
|
40
36
|
*/
|
41
37
|
dataUnit: DataUnit;
|
42
38
|
/**
|
43
|
-
*
|
39
|
+
* Título que será apresentado na barra de filtros
|
44
40
|
*/
|
45
41
|
title: string;
|
46
42
|
/**
|
47
|
-
*
|
43
|
+
* Eventualmente poderemos ter mais de uma barra de filtros. Essa propriedade
|
48
44
|
* serve para separar a configuração de cada uma.
|
49
45
|
*/
|
50
46
|
configName: string;
|
51
47
|
/**
|
52
|
-
*
|
48
|
+
* Identificador de recursos como configurações e acesso.
|
53
49
|
*/
|
54
50
|
resourceID: string;
|
55
51
|
/**
|
56
|
-
*
|
52
|
+
* Modo de apresentação da filterbar.
|
57
53
|
*/
|
58
54
|
mode: "regular" | "button" | "hidden";
|
59
55
|
/**
|
60
|
-
*
|
56
|
+
* Lista todos os filtros disponíveis ao usuário.
|
61
57
|
*/
|
62
58
|
filterConfig: Array<SnkFilterItemConfig>;
|
63
59
|
/**
|
64
|
-
*
|
60
|
+
* Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção.
|
65
61
|
*/
|
66
62
|
messagesBuilder: SnkMessageBuilder;
|
67
63
|
/**
|
68
|
-
*
|
64
|
+
* Desabilita a apresentação da opção de filtros personalizados na filter bar (chip de filtros)
|
69
65
|
* e no modal lateral de filtros (container de filtros personalizados).
|
70
66
|
*/
|
71
67
|
disablePersonalizedFilter: boolean;
|
72
68
|
/**
|
73
|
-
*
|
69
|
+
* Chave da configuração legado da barra de filtros.
|
74
70
|
*/
|
75
71
|
filterBarLegacyConfigName: string;
|
76
72
|
/**
|
77
|
-
*
|
73
|
+
* Define se a carga dos dados será feita assim que o componente for carregado.
|
78
74
|
*/
|
79
75
|
autoLoad?: boolean;
|
80
76
|
/**
|
81
|
-
*
|
77
|
+
* Função chamada depois de aplicar os filtros.
|
82
78
|
*/
|
83
79
|
afterApplyConfig?: () => void;
|
84
|
-
/**
|
85
|
-
* @description Evento emitido quando a configuração dos filtros é atualizada.
|
86
|
-
* @param {SnkFilterItemConfig[]} configs - Lista de configurações de filtros atualizadas.
|
87
|
-
* @event
|
88
|
-
*/
|
89
80
|
configUpdated: EventEmitter<SnkFilterItemConfig[]>;
|
90
81
|
allowDefault: boolean;
|
91
82
|
scrollerLocked: boolean;
|
@@ -94,37 +85,31 @@ export declare class SnkFilterBar implements FilterProvider {
|
|
94
85
|
observeFilterConfig(newValue: Array<SnkFilterItemConfig>, oldValue: Array<SnkFilterItemConfig>): void;
|
95
86
|
private handleFilterConfigsChanged;
|
96
87
|
/**
|
97
|
-
*
|
98
|
-
* @async
|
99
|
-
* @return {Promise<void>} Retorna uma Promise que resolve quando o recarregamento for concluído.
|
88
|
+
* Faz o recarregamento da filterbar buscando o state no servidor.
|
100
89
|
*/
|
101
90
|
reload(): Promise<void>;
|
102
91
|
/**
|
103
|
-
*
|
104
|
-
* @async
|
105
|
-
* @param {string} id - ID do item de filtro.
|
106
|
-
* @returns {Promise<SnkFilterItemConfig | undefined>} O item de filtro correspondente ou undefined se não for encontrado.
|
92
|
+
* Retorna um item de filtro pelo ID.
|
107
93
|
*/
|
108
94
|
getFilterItem(id: string): Promise<SnkFilterItemConfig | undefined>;
|
109
95
|
/**
|
110
|
-
*
|
111
|
-
*
|
112
|
-
* @param
|
113
|
-
* @return {Promise<void>} Retorna uma Promise que resolve quando a atualização for concluída.
|
96
|
+
* Atualiza um item do filtro.
|
97
|
+
*
|
98
|
+
* @param filterItem - Item com as informações atualizadas, caso o item não seja encontrado no array ele mão será modificado
|
114
99
|
*/
|
115
100
|
updateFilterItem(newFilterItem: SnkFilterItemConfig): Promise<void>;
|
116
101
|
/**
|
117
|
-
*
|
118
|
-
*
|
119
|
-
* @param
|
120
|
-
* @return {Promise<void>} Retorna uma Promise que resolve quando o item for adicionado.
|
102
|
+
* Adiciona um item de filtro.
|
103
|
+
*
|
104
|
+
* @param filterItem - Item a ser adicionado, caso o item já exista com o ID ele não será adicionado novamente
|
121
105
|
*/
|
122
106
|
addFilterItem(filterItem: SnkFilterItemConfig): Promise<void>;
|
123
107
|
/**
|
124
|
-
*
|
125
|
-
*
|
126
|
-
* @param
|
127
|
-
*
|
108
|
+
* Remove um item de filtro.
|
109
|
+
*
|
110
|
+
* @param filterID - ID do a ser adicionado
|
111
|
+
*
|
112
|
+
* @returns {Promise<SnkFilterItemConfig|undefined>} - Retorna o item de filtro removido, ou undefined caso não encontrado.
|
128
113
|
*/
|
129
114
|
removeFilterItem(filterID: string): Promise<SnkFilterItemConfig | undefined>;
|
130
115
|
componentDidLoad(): void;
|
@@ -134,12 +119,11 @@ export declare class SnkFilterBar implements FilterProvider {
|
|
134
119
|
private doLoadData;
|
135
120
|
/**
|
136
121
|
* Conforme mecanismo de mensagens, é possível customizar as mensagens dos blocos de construção
|
137
|
-
* através de um pequeno
|
122
|
+
* através de um pequeno modulo na estrutura da aplicação:
|
138
123
|
* - Criar um arquivo no seguinte caminho: /messages/appmessages.msg.js.
|
139
124
|
* Para conhecer os detalhes do módulo, vide o arquivo neste projeto "/src/lib/message/resources/snk-filter-bar.msg.ts"
|
140
125
|
*/
|
141
126
|
private getMessage;
|
142
|
-
getFilters(): Promise<Filter[]>;
|
143
127
|
getFilter(_dataUnit: string): Array<Filter>;
|
144
128
|
private isActiveFilter;
|
145
129
|
private registryFilterProvider;
|
@@ -160,8 +144,7 @@ export declare class SnkFilterBar implements FilterProvider {
|
|
160
144
|
*/
|
161
145
|
filterChangeListener(evt: CustomEvent): void;
|
162
146
|
/**
|
163
|
-
*
|
164
|
-
* @async
|
147
|
+
* Abre o modal de filtros
|
165
148
|
*/
|
166
149
|
showFilterModal(): Promise<void>;
|
167
150
|
addPersonalizedFilter(isDefault?: boolean): void;
|
@@ -27,7 +27,7 @@ export declare class SnkForm {
|
|
27
27
|
*/
|
28
28
|
messagesBuilder: SnkMessageBuilder;
|
29
29
|
/**
|
30
|
-
* Chave da configuração
|
30
|
+
* Chave da configuração legado do formulário.
|
31
31
|
*/
|
32
32
|
formLegacyConfigName: string;
|
33
33
|
/**
|
@@ -35,58 +35,33 @@ export declare class SnkForm {
|
|
35
35
|
*/
|
36
36
|
resourceID: string;
|
37
37
|
/**
|
38
|
-
*
|
38
|
+
* Emitido quando o botão de voltar é acionado.
|
39
39
|
*/
|
40
40
|
exit: EventEmitter<void>;
|
41
41
|
/**
|
42
|
-
*
|
42
|
+
* Emitido sempre que houver click de botão ou ação.
|
43
43
|
*/
|
44
44
|
actionClick: EventEmitter<string>;
|
45
45
|
/**
|
46
46
|
* Responsável por notificar quando ocorrer a renderização de itens do formulário.
|
47
|
-
* OBS: Emitido no subcomponente snk-form-view
|
48
47
|
*/
|
49
48
|
formItemsReady: EventEmitter<Array<HTMLElement>>;
|
50
49
|
/**
|
51
50
|
* Exibe a janela de configurações do formulário.
|
52
|
-
* @async
|
53
|
-
* @returns {Promise<void>}
|
54
51
|
*/
|
55
52
|
showConfig(): Promise<void>;
|
56
53
|
/**
|
57
54
|
* Fecha a janela de configurações do formulário.
|
58
|
-
* @async
|
59
|
-
* @returns {Promise<void>}
|
60
55
|
*/
|
61
56
|
hideConfig(): Promise<void>;
|
62
57
|
/**
|
63
|
-
* Registra um editor customizado para campos
|
64
|
-
* @async
|
65
|
-
* @param {string} fieldName - Nome do campo.
|
66
|
-
* @param {ICustomEditor} customEditor - Editor customizado.
|
67
|
-
* @returns {Promise<void>}
|
58
|
+
* Registra um editor customizado para campos da grade e formulário.
|
68
59
|
*/
|
69
60
|
addCustomEditor(fieldName: string, customEditor: ICustomEditor): Promise<void>;
|
70
61
|
/**
|
71
62
|
* Altera/adiciona uma propriedade nos metadados do campo.
|
72
|
-
* @async
|
73
|
-
* @param {string} fieldName - Nome do campo.
|
74
|
-
* @param {string} propName - Nome da propriedade.
|
75
|
-
* @param {any} value - Valor da propriedade.
|
76
|
-
* @returns {Promise<void>}
|
77
63
|
*/
|
78
64
|
setFieldProp(fieldName: string, propName: string, value: any): Promise<void>;
|
79
|
-
/**
|
80
|
-
* Valida o formulário.
|
81
|
-
* @async
|
82
|
-
* @returns {Promise<void>}
|
83
|
-
* @description
|
84
|
-
* Este método executa a validação do formulário, verificando se todos os campos estão
|
85
|
-
* preenchidos corretamente de acordo com as regras definidas.
|
86
|
-
* Se a validação falhar, uma exceção será lançada com os detalhes dos erros encontrados.
|
87
|
-
* Caso contrário, o método será resolvido sem erros.
|
88
|
-
*/
|
89
|
-
validate(): Promise<void>;
|
90
65
|
private closeConfig;
|
91
66
|
private dataunitReady;
|
92
67
|
private setCustomEditors;
|
@@ -44,13 +44,9 @@ export declare class SnkGrid {
|
|
44
44
|
_showSnkFilterBar: boolean;
|
45
45
|
_enableContinuousInsert: boolean;
|
46
46
|
_application: SnkApplication;
|
47
|
-
/**
|
48
|
-
* Define o data source para o filtro de colunas.
|
49
|
-
*/
|
50
47
|
columnFilterDataSource: IMultiSelectionListDataSource;
|
51
|
-
refreshColumnFilterDataSource(): Promise<void>;
|
52
48
|
/**
|
53
|
-
* Define se o componente deve usar o LockManager para controle de carregamento da aplicação
|
49
|
+
* Define se o componente deve usar o LockManager para controle de carregamento da aplicação
|
54
50
|
*/
|
55
51
|
enableLockManagerLoadingComp?: boolean;
|
56
52
|
/**
|
@@ -58,48 +54,45 @@ export declare class SnkGrid {
|
|
58
54
|
*/
|
59
55
|
enableLockManagerTaskbarClick?: boolean;
|
60
56
|
/**
|
61
|
-
* Nome usado para salvar
|
57
|
+
* Nome usado para salvar/recuperar a configuração.
|
62
58
|
*/
|
63
59
|
configName: string;
|
64
60
|
/**
|
65
|
-
* Título que será apresentado na barra de filtros
|
61
|
+
* Título que será apresentado na barra de filtros
|
66
62
|
*/
|
67
63
|
filterBarTitle: string;
|
68
64
|
/**
|
69
|
-
* Identificador de recursos
|
65
|
+
* Identificador de recursos como configurações e acesso.
|
70
66
|
*/
|
71
67
|
resourceID: string;
|
72
68
|
/**
|
73
|
-
* Configuração
|
69
|
+
* Configuração da seleção de grade no toast.
|
74
70
|
*/
|
75
71
|
selectionToastConfig: ISelectionToastConfig;
|
76
72
|
/**
|
77
|
-
* Lista de ações que devem ser usadas no botão "Mais opções" do
|
73
|
+
* Lista de ações que devem ser usadas no botão "Mais opções" do componente snk-taskbar.
|
78
74
|
*/
|
79
75
|
actionsList: Array<Action>;
|
80
76
|
/**
|
81
|
-
* Determina se a grade está vinculada a um detalhe
|
77
|
+
* Determina se a grade está vinculada a um detalhe.
|
82
78
|
*/
|
83
79
|
isDetail: boolean;
|
84
80
|
/**
|
85
|
-
* Gerenciador das barras de tarefas.
|
86
|
-
* ou gerenciar o estado dos botões.
|
81
|
+
* Gerenciador das barras de tarefas. É possível determinar botões específicos
|
82
|
+
* ou mesmo gerenciar o estado dos botões.
|
87
83
|
*/
|
88
84
|
taskbarManager: TaskbarManager;
|
89
85
|
/**
|
90
|
-
*
|
91
|
-
*
|
92
|
-
* ```json
|
93
|
-
* '{ "RECDESP": { "-1" : "#BD0025", "1" : "#157A00" } }'
|
94
|
-
* ```
|
86
|
+
* Configuração do valor da coluna de status.
|
87
|
+
* Exemplo: '{ "RECDESP": { "-1" : "#BD0025", "1" : "#157A00" } }'
|
95
88
|
*/
|
96
89
|
statusResolver: IStatusResolver | StatusResolverFunction;
|
97
90
|
/**
|
98
|
-
* Determina se
|
91
|
+
* Determina se pode haver mais de uma linha selecionada.
|
99
92
|
*/
|
100
93
|
multipleSelection: boolean;
|
101
94
|
/**
|
102
|
-
* Altera o modo de apresentação dos botões do
|
95
|
+
* Altera o modo de apresentação dos botões do snk-taskbar.
|
103
96
|
*/
|
104
97
|
presentationMode: PresentationMode;
|
105
98
|
/**
|
@@ -107,191 +100,139 @@ export declare class SnkGrid {
|
|
107
100
|
*/
|
108
101
|
messagesBuilder: SnkMessageBuilder;
|
109
102
|
/**
|
110
|
-
* Quando
|
103
|
+
* Quando verdadeiro, o ENTER fará a navegação como se fosse a tecla TAB na grade.
|
111
104
|
*/
|
112
105
|
useEnterLikeTab: boolean;
|
113
106
|
/**
|
114
|
-
* Validador responsável por
|
107
|
+
* Validador responsável por checar a integridade das informações do registro.
|
115
108
|
*/
|
116
109
|
recordsValidator: IRecordValidator;
|
117
110
|
/**
|
118
|
-
* Define se a edição
|
111
|
+
* Define se a edição está habilitada na grid.
|
119
112
|
*/
|
120
113
|
canEdit: boolean;
|
121
114
|
/**
|
122
|
-
* Define o identificador do
|
115
|
+
* Define o identificador do container de elementos customizados da Taskbar.
|
123
116
|
*/
|
124
117
|
taskbarCustomContainerId: string;
|
125
118
|
/**
|
126
|
-
*
|
119
|
+
* Nome do slot de elementos customizados da Taskbar do cabeçalho da grade.
|
127
120
|
*/
|
128
121
|
gridHeaderCustomSlotId: string;
|
129
122
|
/**
|
130
|
-
*
|
123
|
+
* Nome do slot de elementos customizados da Taskbar principal do componente.
|
131
124
|
*/
|
132
125
|
topTaskbarCustomSlotId: string;
|
133
126
|
/**
|
134
|
-
* Desabilita a apresentação da opção de filtros personalizados na
|
135
|
-
* e no modal lateral de filtros (
|
127
|
+
* Desabilita a apresentação da opção de filtros personalizados na filter bar (chip de filtros)
|
128
|
+
* e no modal lateral de filtros (container de filtros personalizados).
|
136
129
|
*/
|
137
130
|
disablePersonalizedFilter: boolean;
|
138
131
|
/**
|
139
|
-
* Chave da configuração
|
132
|
+
* Chave da configuração legado da grade.
|
140
133
|
*/
|
141
134
|
gridLegacyConfigName: string;
|
142
135
|
/**
|
143
|
-
* Chave da configuração
|
136
|
+
* Chave da configuração legado da barra de filtros.
|
144
137
|
*/
|
145
138
|
filterBarLegacyConfigName: string;
|
146
139
|
/**
|
147
|
-
* Define se
|
140
|
+
* Define se a carga dos dados será feita assim que o componente for carregado.
|
148
141
|
*/
|
149
142
|
autoLoad?: boolean;
|
150
143
|
/**
|
151
|
-
* Define se a
|
144
|
+
* Define se a grid será focada ao ser carregada.
|
152
145
|
*/
|
153
146
|
autoFocus?: boolean;
|
154
147
|
/**
|
155
|
-
*
|
148
|
+
* Ativa inserção de registros no modo grade.
|
156
149
|
*/
|
157
150
|
enableGridInsert?: boolean;
|
158
151
|
/**
|
159
|
-
* Altera
|
160
|
-
*
|
161
|
-
*
|
152
|
+
* Altera visualmente as sombras e bordas do componente
|
153
|
+
* Quando false, aplica o padrão de sombras ao componente (Utilizar quando for o elemento principal do layout)
|
154
|
+
* Quando true, aplica o padrão de outline ao componente (Utilizar quando estiver contido em outro elemento como um painel ou pop-up)
|
162
155
|
*/
|
163
156
|
outlineMode?: boolean;
|
164
157
|
/**
|
165
|
-
* Define se a grade deve suprimir
|
158
|
+
* Define se a grade deve suprimir o scroll horizontal.
|
166
159
|
*/
|
167
160
|
suppressHorizontalScroll: boolean;
|
168
161
|
/**
|
169
|
-
*
|
162
|
+
* Modo de exportação dos dados.
|
170
163
|
*/
|
171
164
|
strategyExporter: IExporterStrategyMode;
|
172
165
|
/**
|
173
|
-
* Define se a grade deve exibir um buscador de
|
166
|
+
* Define se a grade deve exibir um buscador de coluna com uso do Ctrl+F
|
174
167
|
*/
|
175
168
|
useSearchColumn: boolean;
|
176
169
|
/**
|
177
|
-
* Habilita a edição de múltiplos registros
|
170
|
+
* Habilita a edição de múltiplos registros simultâneos.
|
178
171
|
*/
|
179
172
|
multipleEditionEnabled: boolean;
|
180
173
|
/**
|
181
|
-
* Define
|
174
|
+
* Define se a grid será focada ao ser carregada.
|
182
175
|
*/
|
183
176
|
paginationCounterMode?: 'show' | 'hidden' | 'auto';
|
184
177
|
/**
|
185
|
-
* Informa se a coluna de
|
178
|
+
* Informa se a coluna de chechbox deve ser suprimida
|
186
179
|
*/
|
187
180
|
suppressCheckboxColumn: boolean;
|
188
181
|
/**
|
189
|
-
*
|
190
|
-
*/
|
191
|
-
suppressFilterColumn?: boolean;
|
192
|
-
/**
|
193
|
-
* Define se a grade deve ser exibida em modo compacto.
|
182
|
+
* Define se a grade deve ser exibida em modo compacto
|
194
183
|
*/
|
195
184
|
compact: boolean;
|
196
185
|
/**
|
197
|
-
* Emitido
|
198
|
-
* @description Este evento é acionado quando o usuário clica em um botão de ação ou item de menu na grade, permitindo a execução de ações específicas.
|
199
|
-
* @param {string} detail - O identificador da ação clicada, que pode ser usado para determinar qual ação executar.
|
186
|
+
* Emitido sempre que houver click de botão ou ação.
|
200
187
|
*/
|
201
188
|
actionClick: EventEmitter<string>;
|
202
189
|
/**
|
203
|
-
* Emitido
|
204
|
-
* @description Este evento é acionado quando o usuário clica duas vezes em uma linha da grade, permitindo ações como edição rápida ou visualização de detalhes.
|
205
|
-
* @param {any} detail - Detalhes do evento, contendo a linha clicada.
|
190
|
+
* Emitido sempre que houver duplo click na grade.
|
206
191
|
*/
|
207
192
|
gridDoubleClick: EventEmitter<any>;
|
208
193
|
/**
|
209
194
|
* Emitido quando o componente estiver completamente carregado.
|
210
195
|
*/
|
211
196
|
componentReady: EventEmitter<void>;
|
212
|
-
/**
|
213
|
-
* Recarrega a configuração da grade.
|
214
|
-
* @description Este método força o recarregamento da configuração da grade a partir do `ConfigStorage`. A operação é assíncrona, mas o método não aguarda sua conclusão.
|
215
|
-
*/
|
216
197
|
reloadConfig(): void;
|
217
198
|
/**
|
218
199
|
* Exibe a janela de configurações da grade.
|
219
|
-
* @async
|
220
|
-
* @description Este método abre o pop-up de configuração de colunas da grade, permitindo ao usuário ajustar a visibilidade, ordem e largura das colunas.
|
221
|
-
* @returns {Promise<void>} Uma promessa que é resolvida quando a janela de configuração é exibida.
|
222
200
|
*/
|
223
201
|
showConfig(): Promise<void>;
|
224
202
|
/**
|
225
203
|
* Fecha a janela de configurações da grade.
|
226
|
-
* @async
|
227
|
-
* @description Este método fecha o pop-up de configuração de colunas da grade.
|
228
|
-
* @returns {Promise<void>} Uma promessa que é resolvida quando a janela de configuração é fechada.
|
229
204
|
*/
|
230
205
|
hideConfig(): Promise<void>;
|
231
206
|
/**
|
232
|
-
*
|
233
|
-
* @async
|
234
|
-
* @description Aplica uma nova configuração de colunas e ordenação à grade.
|
235
|
-
* @param {IGridConfig} config O objeto de configuração a ser aplicado na grade.
|
236
|
-
* @returns {Promise<void>} Uma promessa que é resolvida quando a configuração é aplicada.
|
207
|
+
* Atribui o valor da configuração da grade.
|
237
208
|
*/
|
238
209
|
setConfig(config: IGridConfig): Promise<void>;
|
239
210
|
/**
|
240
|
-
*
|
241
|
-
* @async
|
242
|
-
* @description Força o recarregamento da barra de filtros, atualizando suas configurações e filtros a partir do servidor.
|
243
|
-
* @returns {Promise<void>} Uma promessa que é resolvida quando a barra de filtros é recarregada.
|
211
|
+
* Faz o recarregamento da filter-bar da grade buscando o state no servidor.
|
244
212
|
*/
|
245
213
|
reloadFilterBar(): Promise<void>;
|
246
214
|
/**
|
247
|
-
* Retorna o elemento da
|
248
|
-
* @async
|
249
|
-
* @description Este método permite acessar o elemento da barra de filtros, que pode ser útil para manipulações adicionais ou para obter o estado atual dos filtros aplicados.
|
250
|
-
* @returns {Promise<HTMLSnkFilterBarElement>} O elemento da barra de filtros.
|
215
|
+
* Retorna o elemento da filter-bar da grade.
|
251
216
|
*/
|
252
217
|
getFilterBar(): Promise<HTMLSnkFilterBarElement>;
|
253
218
|
/**
|
254
|
-
* Registra um editor customizado para
|
255
|
-
* @async
|
256
|
-
* @description Adiciona um componente de edição personalizado para um campo específico. Este editor será usado tanto na edição em linha na grade quanto em formulários de detalhe.
|
257
|
-
* @param {string} fieldName O nome do campo que receberá o editor customizado.
|
258
|
-
* @param {ICustomEditor} customEditor A instância do editor customizado.
|
259
|
-
* @param {string} [detailContext] O contexto de detalhe onde o editor será aplicado (opcional).
|
260
|
-
* @returns {Promise<void>} Uma promessa que é resolvida quando o editor é registrado.
|
219
|
+
* Registra um editor customizado para campos da grade e formulário
|
261
220
|
*/
|
262
221
|
addCustomEditor(fieldName: string, customEditor: ICustomEditor, detailContext?: string): Promise<void>;
|
263
222
|
/**
|
264
|
-
* Registra um
|
265
|
-
* @async
|
266
|
-
* @description Adiciona um componente de renderização personalizado para uma coluna específica, permitindo a exibição de conteúdo customizado nas células.
|
267
|
-
* @param {string} fieldName O nome do campo (coluna) que receberá o renderizador customizado.
|
268
|
-
* @param {ICustomRender} customRender A instância do renderizador customizado.
|
269
|
-
* @param {string} [detailContext] O contexto de detalhe onde o renderizador será aplicado (opcional).
|
270
|
-
* @returns {Promise<void>} Uma promessa que é resolvida quando o renderizador é registrado.
|
223
|
+
* Registra um render customizado para colunas da grid.
|
271
224
|
*/
|
272
225
|
addGridCustomRender(fieldName: string, customRender: ICustomRender, detailContext?: string): Promise<void>;
|
273
226
|
/**
|
274
|
-
* Registra um formatador de
|
275
|
-
* @async
|
276
|
-
* @description Adiciona uma função de formatação personalizada para os valores de uma coluna específica, afetando como os dados são exibidos.
|
277
|
-
* @param {string} columnName O nome da coluna que receberá o formatador.
|
278
|
-
* @param {ICustomFormatter} customFormatter A instância do formatador de valor.
|
279
|
-
* @returns {Promise<void>} Uma promessa que é resolvida quando o formatador é registrado.
|
227
|
+
* Registra um formatador de valores para uma coluna da grid.
|
280
228
|
*/
|
281
229
|
addCustomValueFormatter(columnName: string, customFormatter: ICustomFormatter): Promise<void>;
|
282
230
|
/**
|
283
|
-
* Remove
|
284
|
-
* @async
|
285
|
-
* @description Remove uma função de formatação personalizada previamente registrada para uma coluna.
|
286
|
-
* @param {string} columnName O nome da coluna da qual o formatador será removido.
|
287
|
-
* @returns {Promise<void>} Uma promessa que é resolvida quando o formatador é removido.
|
231
|
+
* Remove o formatador de valores de uma coluna da grid.
|
288
232
|
*/
|
289
233
|
removeCustomValueFormatter(columnName: string): Promise<void>;
|
290
234
|
/**
|
291
235
|
* Atribui o foco para a grade.
|
292
|
-
* @async
|
293
|
-
* @description Move o foco do navegador para o componente da grade, permitindo a navegação por teclado.
|
294
|
-
* @returns {Promise<void>} Uma promessa que é resolvida quando o foco é atribuído.
|
295
236
|
*/
|
296
237
|
setFocus(): Promise<void>;
|
297
238
|
handleClick(event: MouseEvent): Promise<void>;
|
@@ -1,21 +1,3 @@
|
|
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
|
-
*/
|
19
1
|
import { EventEmitter } from '../../stencil-public-runtime';
|
20
2
|
import { IFilterLink, IFilterField, FilterFieldsDataSource } from "../snk-filter-field-search/interfaces";
|
21
3
|
import { SnkMessageBuilder } from '../../lib/message/SnkMessageBuilder';
|
@@ -34,62 +16,32 @@ export declare class SnkPersonalizedFilter {
|
|
34
16
|
private _filterAssistent;
|
35
17
|
/**
|
36
18
|
* Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção.
|
37
|
-
* @property
|
38
19
|
*/
|
39
20
|
messagesBuilder: SnkMessageBuilder;
|
40
21
|
/**
|
41
|
-
*
|
42
|
-
* @property
|
22
|
+
* Responsável por receber a URI da entidade.
|
43
23
|
*/
|
44
24
|
entityUri: string;
|
45
25
|
/**
|
46
|
-
*
|
47
|
-
* @property
|
26
|
+
* Id do filtro que será carregado.
|
48
27
|
*/
|
49
28
|
filterId: string;
|
50
29
|
/**
|
51
|
-
* Nome da configuração
|
52
|
-
* @property
|
30
|
+
* Nome da configuração. Serve para distinguir várias instâncias do componente.
|
53
31
|
*/
|
54
32
|
configName: string;
|
55
33
|
/**
|
56
|
-
*
|
57
|
-
* @property
|
34
|
+
* Nome da configuração. Serve para distinguir várias instâncias do componente.
|
58
35
|
*/
|
59
36
|
resourceID: string;
|
60
37
|
/**
|
61
|
-
*
|
62
|
-
* @property
|
63
|
-
* @default false
|
38
|
+
* Define se o filtro em questão é um filtro padrão.
|
64
39
|
*/
|
65
40
|
isDefaultFilter: boolean;
|
66
|
-
/**
|
67
|
-
* Evento emitido ao cancelar a personalização do filtro.
|
68
|
-
* @event
|
69
|
-
*/
|
70
41
|
ezCancel: EventEmitter<void>;
|
71
|
-
/**
|
72
|
-
* Evento emitido ao salvar as alterações do filtro personalizado.
|
73
|
-
* @event
|
74
|
-
*/
|
75
42
|
ezSave: EventEmitter<string>;
|
76
|
-
/**
|
77
|
-
* Evento emitido após salvar as alterações do filtro personalizado.
|
78
|
-
* @event
|
79
|
-
*/
|
80
43
|
ezAfterSave: EventEmitter<void>;
|
81
|
-
/**
|
82
|
-
* Cria um novo filtro personalizado caso não exista nenhum.
|
83
|
-
* @method
|
84
|
-
* @returns {Promise<void>}
|
85
|
-
*/
|
86
44
|
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
|
-
*/
|
93
45
|
loadFilter(newValue: string, oldValue: string): void;
|
94
46
|
_dataSourceFetcher: FilterFieldsDataSource;
|
95
47
|
componentWillLoad(): void;
|