import { BaseModel, BaseSearchStore, OptionalType } from '@itix/core'; import { TableColumnModel } from '../table-column.model'; import { TableCustomActionModel } from '../table-custom-action.model'; import { SelectionModeEnum } from '../enums/selection-mode.enum'; import { TitleSizeEnum } from '../../../../common/title/models/enums/title-size.enum'; import { TableContentDisplayModeEnum } from '../enums/table-content-display-mode.enum'; import { ToolbarItemModel } from '../../../../toolbar/models/toolbar-item.model'; import { ColumnContextMenuModel } from '../../../../data-list-controls/column/models/column-context-menu.model'; import { ButtonConfig } from '../../../../common/button/models/button.config'; import { TableActionConfig } from '../table-action.config'; import { TableFilterFormConfig } from '../table-filter-form.config'; /** * Classe base para configuração de tabelas. */ export declare abstract class BaseTableConfig { /** * ID da tabela. */ get id(): string; /** * Título de descrição da tabela. */ get title(): string; /** * Sub-título de descrição da tabela. */ get subtitle(): string; /** * Tamanho do título de descrição da tabela (Veja: #ixsee[p:common/title/models/enums, i:TitleSizeEnum]). */ get titleSize(): TitleSizeEnum; /** * Modo de exibição das linhas da tabela (Veja: #ixsee[p:data-list/table/models/enums, i:TableContentDisplayModeEnum]). */ get contentDisplayMode(): TableContentDisplayModeEnum; /** * Indica se o usuário poderá alterar o modo como os dados da tabela são exibidos. */ get allowUserChangeDisplayMode(): boolean; /** * Obtém o store (Veja: #ixsee[p:abstractions, i:BaseSearchStore, l:core]). */ get store(): BaseSearchStore; /** * Obtém as colunas que estão visiveis (Veja: #ixsee[p:data-list/table/models, i:TableColumnModel]). */ get visibleColumns(): TableColumnModel[]; /** * Obtém as colunas que estão ocultas (Veja: #ixsee[p:data-list/table/models, i:TableColumnModel]). */ get hiddenColumns(): TableColumnModel[]; /** * Obtém todas colunas da tabela (Veja: #ixsee[p:data-list/table/models, i:TableColumnModel]). */ get columns(): TableColumnModel[]; /** * Filtros adicionais do tabela com agrupamentos de linhas. * Veja: #ixsee[p:data-list/table/models, i:TableFilterFormConfig]. */ get customFormFilters(): OptionalType; /** * Obtém o tamanho de cada página. */ get pageSize(): number; /** * Obtém a quantidade máxima de páginas a serem exibidas no paginador. */ get maxPagesDisplayed(): number; /** * Indica se tem adição. */ get hasCreate(): boolean; /** * Indica se o tabela permite ordenação dos dados por mais de uma coluna. */ get allowMultiSort(): boolean; /** * Indica se deve iniciar o componente consultando os dados. */ get autoSearch(): boolean; /** * Indica se tem edição. */ get hasEdit(): boolean; /** * Indica se tem remoção. */ get hasDelete(): boolean; /** * Indica se tem botão de visualização. */ get hasView(): boolean; /** * Indica se tem consulta. */ get hasSearch(): boolean; /** * Indica se deve salvar o último estado da tabela. * Caso verdadeiro, irá salvar o último estado na sessionStorage toda vez que o usuário sair da página. * Sempre que ele retornar, sem atualizar a página, esse registro será recarregado. */ get shouldSaveLastState(): boolean; /** * Indica se o toolbar ficará fixo no topo da tela quando o usuário fazer o scroll da mesma. */ get stickToolbar(): boolean; /** * Obtém as ações personalizadas (Veja: #ixsee[p:data-list/table/models, i:TableCustomActionModel]). */ get customActions(): TableCustomActionModel[]; /** * Ação personalizada aplicada no header do tabela. * Veja: #ixsee[p:common/button/models, i:ButtonConfig]. */ get customHeaderAction(): OptionalType; /** * Obtem as ações do menu de contexto (Veja: #ixsee[p:data-list-controls/column/models, i:ColumnContextMenuModel]). */ get contextualMenuActions(): OptionalType; /** * Ação de clique no conteúdo da linha da tabela. */ get actionRowLinkTemplate(): any; /** * Função responsável por validar se a linha da tabela vai possuir action. */ get actionRowIsDisabled(): any; /** * Mensagem exibida pro usuário ao passar o mouse sobre a coluna da tabela. * quando a action da coluna está desabilitada. */ get tooltipForDisabledAction(): string; /** * Indica se deve usar a paginação local. */ get useLocalPagination(): boolean; /** * Nome da propriedade que identifica a linha/registro. * **Obs:** utiliza id por padrão. */ get idName(): string; /** * Modo de seleção da tabela. * **Obs:** Seleção múltipla por padrão. * Veja: #ixsee[p:data-list/table/models/enums, i:SelectionModeEnum]. */ get selectionMode(): SelectionModeEnum; /** * Essa propriedade por padrão é false, onde ela exibe a paginação da tabela de forma vertical sem lista. * caso seja true, ela exibirá a paginação via dropdown. */ get showPageSizeAsDropdown(): boolean; /** * Nome identificador da tabela. Por padrão seu valor é 'table'. */ get name(): string; /** * Indica se o nome da tabela foi informado. */ get hasSetName(): boolean; /** * Itens personalizados a serem adicionados na toolbar da tabela. * Veja: #ixsee[p:toolbar/models, i:ToolbarItemModel]. */ get toolbarItems(): ToolbarItemModel[]; /** * Define os comportamentos de cada ação padrão da tabela. * Ex: botões de Criar, editar, visualizar e excluir. * Veja: #ixsee[p:data-list/table/models, i:TableActionConfig]. */ get actions(): TableActionConfig[]; /** * URL path que será utilizado para redirecionar o usuário para a página de criação de um registro da tabela atual. * Recebe um vetor de strings. Cada item é um path da URL. * Padrão: ['add'] */ get createPath(): string[]; /** * URL path que será utilizado para redirecionar o usuário para a página de edição do registro selecionado na tabela atual. * Recebe um vetor de strings. Cada item é um path da URL. * Obs: Para se informar o ID do registro na URL, deve-se informar um dos parâmetros como ":id". * Padrão: [':id'] */ get viewPath(): string[]; /** * URL path que será utilizado para redirecionar o usuário para a página de visualização do registro selecionado na tabela atual. * Recebe um vetor de strings. Cada item é um path da URL. * Obs: Para se informar o ID do registro na URL, deve-se informar um dos parâmetros como ":id". * Padrão: [':id', 'edit'] */ get editPath(): string[]; /** * Mensagem de confirmação enviada ao usuário antes de excluir um registro. */ get removeConfirmationMessage(): string; /** * Mensagem de confirmação enviada ao usuário antes de excluir vários registros. */ get removeConfirmationMessagePlural(): string; /** * ID único da tabela. */ protected readonly _id: string; /** * Título de descrição da tabela. */ protected _title?: string; /** * sub-título de descrição da tabela. */ protected _subtitle?: string; /** * Tamanho do título de descrição da tabela (Veja: #ixsee[p:common/title/models/enums, i:TitleSizeEnum]). */ protected _titleSize: TitleSizeEnum; /** * Modo de exibição das linhas da tabela (Veja: #ixsee[p:data-list/table/models/enums, i:TableContentDisplayModeEnum]). */ protected _contentDisplayMode: TableContentDisplayModeEnum; /** * Indica se o usuário poderá alterar o modo como os dados da tabela são exibidos. */ protected _allowUserChangeDisplayMode: boolean; /** * Store utilizado para interação com dados (Veja: #ixsee[p:abstractions, i:BaseSearchStore, l:core]). */ protected _store: BaseSearchStore; /** * Colunas da tabela (Veja: #ixsee[p:data-list/table/models, i:TableColumnModel]). */ protected _columns: TableColumnModel[]; /** * Filtros adicionais do tabela com agrupamentos de linhas (#ixsee[p:data-list/table/models, i:TableFilterFormConfig]). */ protected _customFormFilters?: TableFilterFormConfig; /** * Quantidade de itens por página */ protected _pageSize: number; /** * Quantidade máxima de páginas exibidas por vez */ protected _maxPagesDisplayed: number; /** * Indica se o tabela permite ordenação dos dados por mais de uma coluna */ protected _allowMultiSort: boolean; /** * Indica se deve iniciar o componente consultando os dados. */ protected _autoSearch: boolean; /** * Indica se pode criar novo registro. * Caso verdadeiro, exibe o botão de criação. */ protected _canCreate: boolean; /** * Indica se pode remover um registro. * Caso verdadeiro, exibe o botão de remoção. */ protected _canDelete?: boolean | undefined; /** * Indica se pode visualizar um registro. * Caso verdadeiro, exibe o botão de visualização. */ protected _canView?: boolean | undefined; /** * Indica se pode editar um registro. * Caso verdadeiro, exibe o botão de edição. */ protected _canEdit?: boolean | undefined; /** * Indica se pode pesquisar em todas as colunas (pesquisa global). * Caso verdadeiro, exibe o formulário de pesquisa. * Obs: Não afeta a pesquisa individual por coluna. */ protected _canSearch: boolean; /** * Indica se deve salvar o último estado da tabela. * Caso verdadeiro, irá salvar o último estado na sessionStorage toda vez que o usuário sair da página. * Sempre que ele retornar, sem atualizar a página, esse registro será recarregado. */ protected _shouldSaveLastState: boolean; /** * Indica se o toolbar ficará fixo no topo da tela quando o usuário fazer o scroll da mesma. */ protected _stickToolbar: boolean; /** * Ações personalizadas para cada registro. * Para cada ação adicionada aqui uma coluna com botão é adicionada na tabela. * Veja: #ixsee[p:data-list/table/models, i:TableCustomActionModel]. */ protected _customActions: TableCustomActionModel[]; /** * Ação personalizada aplicada no header do tabela (#ixsee[p:common/button/models, i:ButtonConfig]). */ protected _customHeaderAction?: ButtonConfig; /** * O menu de contexto, conhecido por menu "sanduiche" é um dropdown que possui * uma lista de botões com ações diferentes. * Nesse parâmetro serão informadas as ações de cada item do menu e qual campo ele será exibido. * Veja: #ixsee[p:data-list-controls/column/models, i:ColumnContextMenuModel]. */ protected _contextualMenuActions?: ColumnContextMenuModel; /** * Itens personalizados a serem adicionados na toolbar da tabela. * Veja: #ixsee[p:toolbar/models, i:ToolbarItemModel]. */ protected _toolbarItems: ToolbarItemModel[]; /** * Ação de clique no conteúdo da linha da tabela. */ protected _actionRowLinkTemplate: any; /** * Função responsável por validar se a coluna da tabela vai possuir action. */ protected _actionRowIsDisabled?: (record: any, columnName: string) => boolean; /** * Mensagem exibida pro usuário ao passar o mouse sobre a coluna da tabela * quando a action da coluna está desabilitada. */ protected _tooltipForDisabledAction?: string; /** * Indica se a paginação dos registros da tabela ocorre no servidor ou no próprio componente. * Por padrão essa opção é false. */ protected _useLocalPagination: boolean; /** * Nome da propriedade que identifica a linha/registro. * **Obs:** utiliza id por padrão. */ protected _idName: string; /** * Modo de seleção da tabela. * **Obs:** Seleção múltipla por padrão. * Veja: #ixsee[p:data-list/table/models/enums, i:SelectionModeEnum]. */ protected _selectionMode: SelectionModeEnum; /** * Essa propriedade por padrão é false, onde ela exibe a paginação da tabela de forma vertical sem lista. * caso seja true, ela exibirá a paginação via dropdown. */ protected _showPageSizeAsDropdown: boolean; /** * Nome identificador da tabela. Por padrão seu valor é 'table'. */ protected _name: string; /** * Define os comportamentos de cada ação padrão da tabela. * Ex: botões de Criar, editar, visualizar e excluir. * Veja: #ixsee[p:data-list/table/models, i:TableActionConfig]. */ protected _actions: TableActionConfig[]; /** * URL path que será utilizado para redirecionar o usuário para a página de criação de um registro da tabela atual. * Recebe um vetor de strings. Cada item é um path da URL. * Padrão: ['add'] */ protected _createPath: string[]; /** * URL path que será utilizado para redirecionar o usuário para a página de edição do registro selecionado na tabela atual. * Recebe um vetor de strings. Cada item é um path da URL. * Obs: Para se informar o ID do registro na URL, deve-se informar um dos parâmetros como ":id". * Padrão: [':id'] */ protected _viewPath: string[]; /** * URL path que será utilizado para redirecionar o usuário para a página de visualização do registro selecionado na tabela atual. * Recebe um vetor de strings. Cada item é um path da URL. * Obs: Para se informar o ID do registro na URL, deve-se informar um dos parâmetros como ":id". * Padrão: [':id', 'edit'] */ protected _editPath: string[]; /** * Mensagem de confirmação enviada ao usuário antes de excluir um registro. */ protected _removeConfirmationMessage: string; /** * Mensagem de confirmação enviada ao usuário antes de excluir vários registros. */ protected _removeConfirmationMessagePlural: string; /** * Obriga a existência do nome para a tabela. */ requireName(): void; }