Histórico da Página
...
Agrupador de atributos e métodos que atendem à necessidades específicas;
formatDateToServer
Descrição: atributo que contém o formato de data esperado pelo servidor;
showLargeModal
Descrição: método que retorna se deve ou não apresentar a modal com a classe "modal-lg" do bootstrap;
formatMillisecondsDateToString
Descrição: formata a data informada de acordo com o padrao informado.
Parâmetro de entrada: data a ser formatada (tipo Long) e formato a ser aplicado (tipo String);
Parâmetro de saída: data formatada (tipo Date);
formatStringDateToServer
Descrição: converte uma data em formato string para um objeto do tipo Date.
Parâmetro de entrada: uma string com conteúdo em formato Data;
Parâmetro de saída: uma string formatada com o formato de data do atributo "formatDateToServer";
showRecordDetail
Descrição: método utilizado quando há uma lista hierárquica (item pai e item filho) para apresentar o detalhamento da linha selecionada;
Parâmetros de entrada:
- ID da DIV pai do elemento selecionado (tipo String)
...
- ;
- a classe CSS que contém a tabela detalhe (tipo String)
...
- ;
- a decisão de mostrar a linha detalhe (tipo booleano);
Parâmetro de saída: booleano indicando se a linha de detalhe está visível ou não (tipo booleano);
validateForm
Descrição: efetua as validações de campos cadastradas para um form HTML;
Parâmetros Parâmetro de entrada: escopo do form a ser validado;
Parâmetro de saída: retorna se o form foi validado com sucesso (tipo booleano);
findIndexByKeyValue
Descrição: efetua a busca de um objeto dentro de uma lista;
Parâmetros de entrada:
- objeto no qual será feita a busca
...
- ;
- chave a ser buscada, valor a ser buscado;
Parâmetro de saída: o índice do objeto procurado dentro da lista passada como parâmetro;
findValueByAttr
Descrição: efetua a busca de um valor a partir do nome do seu atributo;
Parâmetros de entrada:
- nome do atributo
- ;
- objeto no qual será feita a busca;
Parâmetro de saída: o valor corresponde ao atributo pesquisado. Caso não encontre, retornará "undefined";
serviceFilterBy ('html-framework.FilterBy')
filterBy
Descrição: array de objetos que contém os filtros informados em tela, seja por busca avançada ou por busca rápida. Possui os atributos "property", "value", "label" e "labelValue";
addFilter
Descrição: método que adiciona uma clásula de filtro ao objeto "filterBy" que armazena os filtros de um controller;
Parâmetros de entrada:
- nome do atributo a ser pesquisado (correspondente à classe Java da entidade)
...
- ;
- valor do atributo a ser pesquisado
...
- ;
- label do filtro a ser exibido em tela
...
- ;
- valor do filtro a ser exibido em tela;
removeFilter
Descrição: método que remove uma cláusula específica da lista de filtros;
Parâmetros de entrada:
- objeto de filtro a ser retirado (no formato do filterBy)
- ;
- função de callback (tipo função do Javascript)
- ;
- instância do objeto chamador (tipo objeto Javascript);
clearFilter
Descrição: método que remove toda a lista de filtros (objeto "filterBy");
Parâmetros Parâmetro de entrada: instância do objeto chamador (tipo objeto Javascript);
clearSearchModel
Descrição: método que remove a lista de filtros da busca avançada;
Parâmetros de entrada: instância do objeto chamador (tipo objeto Javascript);
clearDefaultData
Descrição: método que redefine todos os objetos padrões do controller para seus valores iniciais;
Parâmetros de entrada:
- indicador de pesquisa rápida (tipo booleano)
- ;
- instância do objeto chamador (tipo objeto Javascript);
addDateRangeFilter
Descrição: método que adiciona um filtro do tipo Data à lista de filtros;
Parâmetros de entrada:
- data inicial em milissegundos
- ;
- data final em milissegundos
- ;
- nome do atributo a ser pesquisado (correspondente à classe Java da entidade)
- ;
- label do filtro a ser exibido em tela;
search
Descrição: método que efetua a busca dos registros da entidade correspondente considerando tanto a busca rápida como a busca avançada. No caso da busca rápida, o método espera que a instância do objeto chamador possua o atributo "quickSearchProperites" que é uma string contendo os atributos sobre os quais deverá ser feita a busca sendo estes atributos separados por vírgula. O controller que chama este método deve herdar os métodos do serviço correspondente (através do comando "angular.extend") ou guardar o mesmo em uma variável de nome "service";Parâmetros de entrada: indicador de pesquisa rápida (tipo booleano), . A busca rápida será chamada através do método "quickSearch" somente se a variável do controller "quickSearchText" possuir valor, caso contrário será chamado o método "findRecords";
Parâmetros de entrada:
- indicador de busca paginada, ou seja, a partir de um registro específico (tipo booleano, valor inicial "false");
- instância do objeto chamador (tipo objeto Javascript, valor inicial é o controller que chamou o método);
processResultSearch
Descrição: método que atualiza a lista de dados retornados e exibidos em tela e também o total de registros da lista;
Parâmetros de entrada:
- dados da lista (tipo objeto Javascript)
- ;
- instância do objeto chamador (tipo objeto Javascript);
showAdvancedSearch
Descrição: método que exibe/esconde a DIV de pesquisa avançada;
Parâmetros de entrada:
- indicador se deve mostrar a pesquisa avançada (tipo booleano)
- ;
- instância do objeto chamador (tipo objeto Javascript);
serviceGeneric ('html-framework.generic.Service')
max
Descrição: atributo que define o número limtei de registros a ser retornado de uma busca (valor inicial 10);
orderBy
Descrição: array de string contendo os atributos pelos quais a consulta deve ser ordenada;
asc
Descrição: array de string dos atributos que devem ser ordenados de forma ascendente;
getRecord
Descrição: método que efetua a busca de um registro único de uma entidade;
Parâmetros de entrada:
- id do registro dentro da entidade
- ;
- indicador booleano para trazer também as entidades marcadas como LAZY no Java
- ;
- instância do objeto chamador (tipo objeto Javascript);
Parâmetros de saída: objeto encontrado da entidade;
findRecords
Descrição: método que efetua a busca de um número determinado de registros de uma entidade;
Parâmetros de entrada:
- índice do registro inicial (tipo inteiro)
- ;
- número de registros a buscar (tipo inteiro)
- ;
- objeto "filterBy" contendo os filtros a serem considerados, função de callback (objeto Javascript);
Parâmetros de saída: lista de objetos encontrada da entidade;
serviceGenericQuickSearch ('html-framework.generic-quick-search.Service')
quickSearch
Descrição: método que efetua a busca rápida com base em um valor informado. Na camada REST, irá executar o serviço "quickSeach";
Parâmetros de entrada:
- índice do registro inicial (tipo inteiro)
- ;
- número de registros a buscar (tipo inteiro)
- ;
- array de string contendo os atributos da busca
- ;
- array de string contendo os valores de cada atributo a serem considerados na busca
- ;
- função de callback (objeto Javascript);
Parâmetros de saída: lista de objetos encontrado da entidade;
serviceGenericTypeahead ('html-framework.generic-typeahead.Service')
typeahed
Descrição: método que verifica se os atributos informados contêm o valor de busca informado. Na camada REST, irá executar o serviço "typeahead";
Parâmetros de entrada:
- índice do registro inicial (tipo inteiro)
- ;
- número de registros a buscar (tipo inteiro)
- ;
- array de objeto "filter" (contendo atributos "property" e "value"
- ;
- função de callback (objeto Javascript);
Parâmetros de saída: lista de objetos encontrado da entidade;
serviceGenericZoom ('html-framework.generic-zoom.Service')
zoom
Descrição: método que efetua a busca de dados oriundas de filtros de zoom. Na camada REST, irá executar o serviço "zoom";
Parâmetros de entrada:
- índice do registro inicial (tipo inteiro)
- ;
- número de registros a buscar (tipo inteiro)
- ;
- array de objeto "filter" (contendo atributos "property" e "value"
- ;
- função de callback (objeto Javascript);
Parâmetros de saída: lista de objetos encontrado da entidade;
serviceGenericCRUD ('html-framework.generic-crud.Service')
saveRecord
Descrição: método que cria um determinado registro na base;
Parâmetros de entrada:
- entidade a ser salva (objeto Javascript)
- ;
- função de callback (objeto Javascript);
Parâmetros de saída: objeto salvo na base;
updateRecord
Descrição: método que atualiza as informações de um registro na base;
Parâmetros de entrada:
- id do objeto a ser atualizado
- ;
- entidade a ser salva (objeto Javascript)
- ;
- função de callback (objeto Javascript);
Parâmetros de saída: objeto salvo na base;
deleteRecord
Descrição: método que remove um determinado registro na base;
Parâmetros de entrada:
- id do objeto a ser removido
- ;
- função de callback (objeto Javascript);
Parâmetros de saída: objeto salvo na base;
serviceModal ('html-framework.generic.Modal')
init
Descrição: método que mostra e gerencia uma tela modal
Parâmetros de entrada:
- objeto de parâmetros a ser passados pra modal (tipo objeto javascript e registrado no framework como 'modalParams')
- ;
- evento a ser disparado após o fechamento da modal (função do Javascript)
- ;
- instância chamadora (objeto Javascript)
- para possível uso no evento de "close";
- caminho do HTML que será chamado como tela modal (tipo string)
- ;
- string do controller registrado que gerenciará a modal (tipo string);
Parâmetros de saída: instância da tela modal;
Framework-factories.js
...
Contém os métodos "findRecords" e "getRecord" que são chamados pelas respectivas funções do serviço 'html-framework.generic.Service' do framework-services.js.
factoryGenericQuickSearch ('html-framework.generic-quick-search.Factory')
Contém o método "quickSearch" que é chamado pela respectiva função do serviço 'html-framework.generic-quick-search.Service' do framework-services.js.
factoryGenericTypeahead ('html-framework.generic-typeahead.Factory')
Contém o método "typeahead" que é chamado pela respectiva função do serviço 'html-framework.generic-typeahead.Service' do framework-services.js.
factoryGenericZoom ('html-framework.generic-zoom.Factory')
Contém o método "zoom" que é chamado pela respectiva função do serviço 'html-framework.generic-typeahead.Service' do framework-services.js.
factoryGenericCRUD ('html-framework.generic-crud.Factory')
Contém o método "zoom" que é chamado pela respectiva função do serviço 'html-framework.generic-typeahead.Service' do framework-services.js.
factoryResourceLoader('html-framework.factoryResourceLoader')
Efetua o carregamento dos serviços REST disponibilizados a serem disponibilizados pela factory. Possui 2 métodos:
loadDefaultResources
Descrição: método que carrega os serviços padrões que o framework oferece para a factory;
Parâmetros de entrada: URL do serviço REST da entidade;
Parâmetros de saída: factory com os serviços carregados;
loadSpecificResources
Descrição: método que carrega serviços específicos para a factory, além dos serviços padrões disponibilizados pelo framework;
Parâmetros de entrada:
- URL do serviço REST da entidade
- ;
- lista de objetos com os serviços adicionais (essa lista deve seguir o modelo do angular no parâmetro "actions" descrito aqui);
Parâmetros de saída: factory com os serviços carregados;
...