import { ElementRef, EventEmitter, QueryList, TemplateRef } from '@angular/core'; import { BaseModel, ColumnFilter, ColumnSort, ContextualStyleEnum, KeyValueModel, OptionalType, SizeEnum } from '@itix/core'; import { Subject, Subscription } from 'rxjs'; import { ButtonGroupModel } from '../../../../common/button/models/button-group.model'; import { ButtonConfig } from '../../../../common/button/models/button.config'; import { CustomColumnDirective } from '../../../../data-list-controls/column/directives/custom-column.directive'; import { ColumnWidthModel } from '../../../../data-list-controls/column/models/column-width.model'; import { ToolbarItemModel } from '../../../../toolbar/models/toolbar-item.model'; import { ColumnVisibilityManagerComponent } from '../../components/column-visibility-manager/column-visibility-manager.component'; import { SavedViewsComponent } from '../../components/saved-views/saved-views.component'; import { SelectionModeEnum } from '../enums/selection-mode.enum'; import { TableContentDisplayModeEnum } from '../enums/table-content-display-mode.enum'; import { TableColumnExtendedModel } from '../table-column-extended.model'; import { TableColumnModel } from '../table-column.model'; import { TableCustomActionModel } from '../table-custom-action.model'; import { TableLoaderConfig } from '../table.loader-config'; import { BaseTableConfig } from './base-table.config'; import { BaseFilterForm } from './base.filter-form'; import { ColumnTypeEnum } from '../enums/column-type.enum'; /** * Define o comportamento da tabela. * Obs: Interface criada para resolver o problema de referência circular entre table e table-header. */ export interface BaseTable { SelectionModeEnum: typeof SelectionModeEnum; SizeEnum: typeof SizeEnum; TableContentDisplayModeEnum: typeof TableContentDisplayModeEnum; ContextualStyleEnum: typeof ContextualStyleEnum; /** * Templates de colunas (Veja: #ixsee[p:data-list-controls/column/directives, i:CustomColumnDirective]). */ columnTemplates: QueryList; /** * Referência HTML do componente tabela. */ table: ElementRef; /** * Referência ao cabeçalho da table (Veja: #ixsee[p:data-list/table/components/filter-form, i:FilterFormComponent]). */ filterForm: BaseFilterForm; /** * Termo de pesquisa. * Caso informado, pesquisa esse termo ao iniciar a tabela. */ searchTerm: string; /** * Indica se a tabela exibirá seu cabeçalho com o título e toolbar. */ showDefaultHeader: boolean; /** * Define os itens selecionados na tabela. */ selected: T[]; /** * Tamanhos de página disponíveis */ availablePageSizes: number[]; /** * Dispara quando itens são selecionados na tabela. */ selectedChange: EventEmitter; /** * Indica se o resultado está vazio. */ isEmptyResult: boolean; /** * Indica se a pesquisa foi realizada ao menos uma vez. */ wasSearched: boolean; /** * Estilo do botao de pesquisa rápida da tabela. * Veja: #ixsee[p:models/enums, i:ContextualStyleEnum, l:core]. */ searchButtonStyle: ContextualStyleEnum; /** * Indica se está realizando uma consulta em todas as colunas. */ isSearching: boolean; /** * Itens originais (iniciais). */ originalItems: T[]; /** * Itens locais. */ localItems: T[]; /** * Itens paginados. */ pagedItems: T[]; /** * Quantidade total de registros. */ totalItems: number; /** * Página atual. */ currentPage: number; /** * Início da exibição dos itens. */ startIndex: number; /** * Fim da exibição dos itens. */ endIndex: number; /** * Quantidade de itens por página. */ pageSize: number; /** * Larguras das colunas (Veja: #ixsee[p:data-list-controls/column/models, i:ColumnWidthModel]). */ columnWidths: ColumnWidthModel[]; /** * Tamanho que a tabela deve possuir, com base no tamanho dos campos, podendo ser em % ou em Px. */ totalWidthTable?: string; /** * Modo de exibição das linhas da tabela (Veja: #ixsee[p:data-list/table/models/enums, i:TableContentDisplayModeEnum]). */ contentDisplayMode: TableContentDisplayModeEnum; /** * Indica se todos os registros estão selecionados parcialmente, total ou vazio. */ selection: string; /** * Mapeamento com os itens selecionados. */ selectedItemsMap: Map; /** * Subject que verifica quando os dados foram carregados. */ isLoadingSubject: Subject; /** * Filtros do tabela que são criados pelo desenvolvedor e adicionados na pesquisa. * O usuário não tem ação sobre os filtros inseridos aqui. * Veja: #ixsee[p:models/search, i:ColumnFilter, l:core]. */ defaultFilters: ColumnFilter[]; /** * Menu de contexto ou menu "Sanduíche" da tabela (Veja: #ixsee[p:common/button/models, i:ButtonConfig]). */ contextualMenu?: ButtonConfig; /** * Toolbar de ações definidas pelo usuário (Veja: #ixsee[p:toolbar/models, i:ToolbarItemModel]). */ userTitleToolbarItems: ToolbarItemModel[]; /** * Toolbar de ações do título da tabela (Veja: #ixsee[p:common/button/models, i:ButtonGroupModel]). */ defaultHeaderActions: ButtonGroupModel; /** * Nome dado ao conjunto de filtros da tabela. */ filterName?: string; /** * Subject utilizado para limpeza do filtros aplicados. */ clearFiltersSubject: Subject; /** * Referência ao componente que lista as pesquisas salvas pelo usuário. * Veja: #ixsee[p:data-list/table/components/saved-views, i:SavedViewsComponent]. */ savedViewsComponent?: SavedViewsComponent; /** * Referência ao componente que lista as colunas ocultas da tabela. * Veja: #ixsee[p:data-list/table/components/column-visibility-manager, i:ColumnVisibilityManagerComponent]. */ columnVisibilityMgrComponent?: ColumnVisibilityManagerComponent; /** * Subcribe que muda o texto do dropdown de colunas escondidas. */ subTextButtonHiddenColumns: Subject; /** * Subject que muda a visibilidade do botão de remover filtros. */ subVisibleButtonClearFilter: Subject; /** * Subject que muda a visibilidade do botão de remover visão. */ subVisibleButtonClearView: Subject; /** * Definição do skeleton de loader quando o tabela carrega os dados (Veja: #ixsee[p:data-list/table/models, i:TableLoaderConfig]). */ tableLoaderWrapperConfig: TableLoaderConfig; /** * Nome do filtro selecionado na tabela. */ selectedFilterTitle: string; /** * Indica o tipo de seleção atual (Veja: #ixsee[p:data-list/table/models/enums, i:SelectionModeEnum]). */ selectionStatus: SelectionModeEnum; /** * Indica se os registros da table estão parcialmente selecionados. */ isPartiallyChecked: boolean; /** * Indica se os registros da table estão totalmente selecionados. */ isCompletlyChecked: boolean; /** * Obtém a etiqueta que exibe o filtro aplicado. */ appliedFilterLabel: string; /** * Verifica se alguma coluna tem filtro. */ hasFilter: boolean; /** * Filtros da tabela (Veja: #ixsee[p:models/search, i:ColumnFilter, l:core]). */ filters: ColumnFilter[]; /** * Configuração da tabela (Veja: #ixsee[p:data-list/table/models/abstractions, i:BaseTableConfig]). */ config: BaseTableConfig; /** * Lista com as colunas da tabela (Veja: #ixsee[p:data-list/table/models, i:TableColumnExtendedModel]). */ columns: TableColumnExtendedModel[]; /** * Lista com as colunas visíveis customizadas da tabela pelo usuário. * Veja: #ixsee[p:data-list/table/models, i:TableColumnExtendedModel]. */ visibleColumns: TableColumnExtendedModel[]; /** * Lista com as colunas ocultas customizadas da tabela pelo usuário. * Veja: #ixsee[p:data-list/table/models, i:TableColumnExtendedModel]. */ hiddenColumns: TableColumnExtendedModel[]; /** * Ordenações da tabela (Veja: #ixsee[p:models/search, i:ColumnSort, l:core]). */ sortings: ColumnSort[]; /** * Pesquisa em todas as colunas dos registros. * @param newPage Página a ser exibida. */ search(newPage?: number): void; /** * Muda a visibilidade dos filtros da tabela. */ toggleFilter(): void; /** * Atualiza a altura da tabela. */ updateHeight(): void; /** * Exposição pública do addSubscriptions. * @param subscriptions Subscriptions. */ addSubscriptions(...subscriptions: Subscription[]): void; /** * Faz o download dos registros da table em forma de arquivo CSV. * @param params parametros que serão enviados ao backend para gerar o csv (Veja: #ixsee[p:models, i:KeyValueModel, l:core]). * @param fileName nome do arquivo a ser gerado. Não é necessário passar a extensão do arquivo. Caso não informado * será utilizado o title da table como nome padrão, e se o mesmo nao estiver preenchido será usado o termo "table". */ downloadCsv(params?: KeyValueModel[], fileName?: string): void; /** * Seleciona/Remove a seleção de todos os registros da table. * @param isSelected Indica se deve selecionar ou desmarcar. */ toggleAll(isSelected: boolean): void; /** * Alterna a seleção do item. * @param item Item. */ toggleItem(item: T): void; /** * Indica se a linha da tabela está selecionada. * @param item item da tabela. */ isSelected(item: T): boolean; /** * Remove todos os registros selecionados. * @param redoSearch Indica se deve refazer a consulta após a exclusão. */ removeSelected(redoSearch?: boolean): void; /** * Remove a visão aplicada atualmente. */ removeAppliedView(): void; /** * Remove os filtros atuais. * @param onlyTableFilters Indica se serão limpos, apenas os filtros da tabela, e não os da service também. */ clearFilters(onlyTableFilters?: boolean): void; /** * Executa a ação customizada. * @param item Item local. * @param action Ação (Veja: #ixsee[p:data-list/table/models, i:TableCustomActionModel]). */ handleCustomAction(item: T, action: TableCustomActionModel): void; /** * Obtém o template personalizado da coluna. * @param columnName Nome da coluna. */ getTemplate(columnName: string): OptionalType>; /** * Obtém as classes da coluna. * @param column Coluna (Veja: #ixsee[p:data-list/table/models, i:TableColumnModel]). */ getColumnClasses(column: TableColumnModel): string; /** * Obtém o tamanho da coluna ou em pixel ou em porcentagem. * @param type Tipo. * @param column Coluna (Veja: #ixsee[p:data-list/table/models, i:TableColumnModel]). */ getColumnWidth(type: ColumnTypeEnum, column?: TableColumnModel): string; /** * Retorna o menu de contexto da linha da table. * @param row linha da table que irá receber o menu de contexto. * @returns #ixsee[p:common/button/models, i:ButtonConfig]. */ getContextualMenu(row: T): OptionalType; /** * Retorna o texto de ajuda para informar o usuário o motivo da action da linha da tabela estar desabilitada. * @param row linha a ser verificada. */ getActionDesabledHint(row: T): string; /** * Indica se a action da linha está desabilitada. * @param row linha a ser analisada. */ isActionDisabled(row: T): boolean; /** * Indica se a tabela possui checkbox de seleção, menu de contexto, ou filtros. */ shouldDisplayFirstColumn(): boolean; /** * Indica se a coluna pode receber o menu de contexto. * @param columnName coluna a ser analisada. */ canAddContextualMenu(columnName: string): boolean; /** * Retorna o tamanho disponível em tela para a tabela. */ getScreenWidth(): number; /** * Função responsável por salvar as customizações feitas na tabela. */ saveFilter(): void; /** * Configura as colunas. * @param columnsConfig Configuração (Veja: #ixsee[p:data-list/table/models, i:TableColumnModel]). */ setupColumns(columnsConfig: TableColumnModel[]): void; }