Árvore de páginas

Versões comparadas

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.

...

Índice
outlinetrue
exclude.*ndice
stylenone

Eventos

Os eventos de formulários são um conjunto de scripts carregados pela API de Formulários, os quais são desenvolvidos utilizando Javascript e são chamados durante a execução de ação em formulários ou em momentos específicos de interação em formulários.

 

afterSaveNew

Esse evento é disparado após a criação de um novo formulário. O evento recebe como parâmetro uma referência ao formulário da definição de formulário. Para obter o valor de um determinado campo do formulário:

Bloco de código
languagejs
form.getValue("nome-do-campo")

Exemplo:

Bloco de código
languagejs
function afterSaveNew(form) {
  log.info("Colaborador de abertura: " + form.getValue("RNC_colab_abertura"));
}

A consulta aos campos do formulário é case insensitve. No exemplo acima, poderíamos obter o valor do campo usando rnc_colab_abertura.

 

displayFields

Esse evento é disparado no momento em que os objetos do formulário são apresentados. O evento recebe como parâmetro uma referência ao formulário da definição de formulário e a referência para saída de apresentação do formulário. Nesse evento é possível alterar os valores a serem apresentados no campo do formulário. Para isto basta usar o seguinte procedimento:

Bloco de código
languagejs
form.setValue(“nome-do-campo”, “valor”);

Exemplo:

Bloco de código
languagejs
function displayFields(form, customHTML) {
   if ( form.getFormMode() == “MOD” ) {
     form.setValue('RNC_colab_abertura', new java.lang.Integer(1));
   }
}

Ainda no evento displayFields é possível utilizar três métodos de forma independente ou conjunta para alterar a forma de como é apresentada a renderização do formulário, eliminar linhas de um formulário filho e ocultar os botões “Imprimir” e “Imprimir em nova Janela”.

Para visualizar o formulário no formato original com os campos desabilitados, deve-se utilizar o método setShowDisabledFields.

Para habilitar ou desabilitar o botão de excluir nas linhas do formulário filho, que por padrão é habilitado, deve-se utilizar o método setHideDeleteButton.

Para ocultar o os botões Imprimir Imprimir em nova Janela, deve-se utilizar o método setHidePrintLink.

 

 

Exemplo de visualização sem a utilização dos métodos:

Image Removed

Exemplo de utilização dos métodos setShowDisabledFields e setHidePrintLink:

Bloco de código
languagejs
function displayFields(form, customHTML) {
   form.setShowDisabledFields(true);
   form.setHidePrintLink(true);
}

Image Removed

Exemplo de visualização sem a utilização do método setHideDeleteButton:

comdelete.pngImage Removed

Exemplo de utilização do método setHideDeleteButton:

Bloco de código
languagejs
function displayFields(form, customHTML) {
   form.setHideDeleteButton(false);
}

Image Removed

Exemplo de utilização dos métodos setVisible e setVisibleById:

Bloco de código
languagejs
function displayFields(form, customHTML) { 
   form.setVisible("campoA", false);
   form.setVisibleById("linha___1", false);
}

Formulário funcional com exemplos de utilização de setVisiblesetVisibleById, setHideDeleteButton e setHidePrintLink:

 

Objetivo

...

O objetivo deste guia é descrever os eventos de formulários avançados no fluig, abordando criar validações e manipulações do seu formulário.


Pré-requisitos

...

Antes de iniciar, é importante que leia a documentação sobre Desenvolvimento de Formulários e, durante a leitura você vai sentir a necessidade de entender um pouco mais sobre o parâmetro form (FormController)


Como criar eventos de formulário

...

Após a criação de uma definição de formulário é possível realizar a criação de scripts para customização. O eventos para formulários são criados conforme passos a seguir:

Deck of Cards
effectDuration0.5
historyfalse
idsamples
effectTypefade
Card
defaulttrue
id1
labelPasso1


  • Para a criação de um script de formulário no fluig, na visão Explorador de pacotes (Package Explorer) deve-se acessar a pasta forms do projeto fluig, clicar com o botão direito e no menu acessar Novo (New) > Outras (Other).

    Image Added

Figura 5 - Criação de script evento da definição de formulário.


Card
id2
labelPasso 2


  • Abra a pasta Fluig e selecione a opção Script Fluig e clique no botão Avançar (Next > ).Image Added

Figura 6 - Criação de script evento da definição de formulário.


Card
id3
labelPasso 3


  • Selecione o tipo e clique em Avançar (Next >).

Image Added


Card
id4
labelPasso 4


  • Nesta tela é necessário informar os campos pertinentes ao evento que se deseja adicionar e clicar no botão Concluir.

Após a criação de uma definição de formulário é possível realizar a criação de scripts para customização. O eventos para formulários são criados conforme passos a seguir:



Para a criação de um script de formulário no fluig, na visão Explorador de pacotes (Package Explorer) deve-se acessar a pasta forms do projeto fluig, clicar com o botão direito e no menu acessar Novo (New) > Outras (Other).

Figura 5 - Criação de script evento da definição de formulário.




Abra a pasta Fluig e selecione a opção Script Fluig e clique no botão Avançar (Next > ).

Figura 6 - Criação de script evento da definição de formulário.




Selecione o tipo e clique em Avançar (Next >).



Image Added

Figura 7 - Criação de script evento da definição de formulário.


Card
id5
labelPasso 5


  • No exemplo selecionamos o evento validateForm, e o relacionamos a definição de formulário form_exemplo_fluig.

Image Added

Figura 8 - Criação de script evento da definição de formulário.


Card
id6
labelPasso 6


  • Ao concluir a estrutura principal do método estará disponível no editor.

Image Added

Figura 9 - Criação de script evento da definição de formulário.


Card
id7
labelPasso 7


  • Configure seu script. Para entender mais sobre os eventos e algumas dicas continue lendo essa documentação

Image Added

Figura 10 - Criação de script evento da definição de formulário.


LOGs

...

Uma das funções mais importantes para entender o que está acontecendo no código e rastreamento futuro é o log. Tanto em eventos de formulário, eventos de processo, datasets, o fluig permite fazer log em quatro níveis:

log.info

Usado para apresentar alguma mensagem de rastreamento do código ou dos campos

Bloco de código
languagejs
log.info(“Testando o log info”);
Bloco de código
languagejs
log.info(“O campo código contém o valor: ” + form.getValue("codigo"));


log.warn

...

Usado para indicar algum ponto de atenção ou problema eminente no código

Bloco de código
languagejs
if (form.getValue("codigo") == "") {
   log.warn(“O campo código está em branco e pode apresentar problemas com as integrações”);
}


log.debug

...

Os logs, se não usados com moderação, podem mais atrapalhar do que ajudar. Por isso, caso necessário, algumas informações podem ser utilizadas como debug, que são ativas somente quando o usuário realmente ver elas

Bloco de código
languagejs
log.debug("verificando o conteúdo do campo código")
if (form.getValue("codigo") == "") {
   log.debug("o campo código está em branco");
} else {
   log.debug("o campo código está preenchido: " + form.getValue("codigo"));
}


log.error

...

Usado para imprimir um log de erro

Bloco de código
languagejs
if (form.getValue("codigo") == "") {
   log.error("O campo código não foi preenchido");
   throw "Preencha o campo código";
}


log.dir

...

Este log não é um tipo diferente, na verdade é um log.info turbinado. Serve para fazer o log de objetos mais complexos que simples strings

Bloco de código
languagejs
var objeto = {'codigo': form.getValue("codigo"), 'nome': form.getValue("nome")};
log.dir(objeto);

Eventos

...

Os eventos de formulários são um conjunto de scripts carregados pela API de Formulários, os quais são desenvolvidos utilizando Javascript e são chamados durante a execução de ação em formulários ou em momentos específicos de interação em formulários.


beforeProcessing

...

Esse evento é o primeiro a ser disparado. Ocorre antes de qualquer outro evento da definição de formulário. O evento recebe como parâmetro um objeto do tipo FormController.

Neste contexto, o FormControler deve ser usado apenas para consulta de dados, alterações nos dados não serão persistidas.

Bloco de código
languagejs
function beforeProcessing(form){
}

No contexto deste evento a variável form pode ser usada somente para consulta aos campos da definição de formulário, seus valores e estado de apresentação.


displayFields

...

Esse evento é disparado no momento em que os objetos do formulário são apresentados. O evento recebe como parâmetro um objeto do tipo FormController e um parâmetro customHTML que serve para personalizar e inserir dados diretamente do servidor no formulário

Esse evento pode ser utilizado para alterar os valores a serem apresentados no campo do formulário e é o único que permite a alteração antes da renderização. Para isto basta usar o seguinte procedimento:

Bloco de código
languagejs
titleAo modificar um registro, preenche o campo com o valor 1
linenumberstrue
function displayFields(form, customHTML) {
   if ( form.getFormMode() == “MOD” ) {
     form.setValue('RNC_colab_abertura', new java.lang.Integer(1));
   }
}

Você pode também ocultar campos pelo nome ou pelo id:

Bloco de código
languagejs
function displayFields(form, customHTML) { 
   form.setVisible("campoA", false);
   form.setVisibleById("linha___1", false);
}

Outras funções interessantes que podem ser usados neste evento são:

  • Para visualizar o formulário no formato original com os campos desabilitados, deve-se utilizar o método setShowDisabledFields.
  • Para habilitar ou desabilitar o botão de excluir nas linhas do formulário filho, que por padrão é habilitado, deve-se utilizar o método setHideDeleteButton.
  • Para ocultar o os botões Imprimir Imprimir em nova Janela, deve-se utilizar o método setHidePrintLink.


Sem customizaçõesCom customização

Image Added

Image Added

Bloco de código
languagejs
function displayFields(form, customHTML) {
   form.setShowDisabledFields(true);
   form.setHidePrintLink(true);
}

comdelete.pngImage Added

Image Added


Bloco de código
languagejs
function displayFields(form, customHTML) {
   form.setHideDeleteButton(false);
}


Formulário funcional com exemplos de utilização de setVisiblesetVisibleById, setHideDeleteButton e setHidePrintLink:

Bloco de código
languagexml
titleFormulário - Clique para expandir
linenumberstrue
collapsetrue
<html>
<head>
    <script type="text/javascript" src="/portal/resources/js/jquery/jquery.js"></script>
    <link type="text/css" rel="stylesheet" href="/portal/resources/style-guide/css/fluig-style-guide.min.css"/>
    <script type="text/javascript" src="/portal/resources/style-guide/js/fluig-style-guide.min.js" charset="utf-8"></script>
</head>
<body>
<div class="fluig-style-guide">
<form name="form" role="form">
    <h1>Ao Salvar <small> escolha o que ocultar ao salvar o formulário</small></h1>
    <p>
    <div class="checkbox">
        <label>
        <input type="checkbox" name="ocultarTabela" value="on" 
Bloco de código
languagexml
titleFormulário - Clique para expandir
linenumberstrue
collapsetrue
<html>
<head>
    <script type="text/javascript" src="/portal/resources/js/jquery/jquery.js"></script>
    <link type="text/css" rel="stylesheet" href="/portal/resources/style-guide/css/fluig-style-guide.min.css"/>
    <script type="text/javascript" src="/portal/resources/style-guide/js/fluig-style-guide.min.js" charset="utf-8"></script>
</head>
<body>
<div class="fluig-style-guide">
<form name="form" role="form">
    <h1>Ao Salvar <small> escolha o que ocultar ao salvar o formulário</small></h1>
    <p>
    <div class="checkbox">
        <label>
        <input type="checkbox" name="ocultarTabela" value="on" >
        Ocultar toda tabela
        </label>
    </div>
    <div class="checkbox">
        <label>
        <input type="checkbox" name="ocultarCampoA">
        Ocultar campo A
        </label>
    </div>
    <div class="checkbox">
        <label>
        <input type="checkbox" name="ocultarCampoN1">
        Ocultar campo N da primeira linha
        </label>
    </div>
    <div class="checkbox">
        <label>
        <input type="checkbox" name="ocultarCampoM2">
        Ocultar campo M da segunda linha
        </label>
    </div>
    <div class="checkbox">
        <label>
        <input type="checkbox" name="ocultarLinha1">
        Ocultar linha 1
        </label>
    </div>
    <div class="checkbox">
        <label>
        <input type="checkbox" name="ocultarExclusao">
        Ocultar botão de excluir
        </label>
    </div>
    <div class="checkbox">
        <label>
        <input type="checkbox" name="ocultarImpressao">
        Ocultar botão de imprimir
        </label>
    </div>
    <div class="checkbox">
        <label>
        <input type="checkbox" name="ocultarLoremIpsum">
        Ocultar Loremtoda Ipsumtabela
        </label>
    </div>
     <p><br><p><div class="checkbox">
    <input  type="text" name="campoA" placeholder="Campo A" class="form-control" ></input><br> <label>
    <p>
    <h2>Tabela de registros</h2>
    <table class="table table-bordered" tablename="tabelaTeste" addbuttonlabel="Novo Registro" cellspacing="0" width="100%" id="minhaTabela"<input type="checkbox" name="ocultarCampoA">
        <thead>
Ocultar campo A
        </label>
   <tr </div>
    <div class="tableHeadRowcheckbox">
        <label>
        <td class<input type="checkbox" name="tableColumnocultarCampoN1">N</td>>
        Ocultar campo N da     <td class="tableColumn">M</td>primeira linha
        </label>
    </tr>div>
        </thead><div class="checkbox">
        <tbody><label>
        <input type="checkbox"   <tr class="tableBodyRow" id="linha">name="ocultarCampoM2">
        Ocultar campo M da segunda linha
        </label>
    </div>
    <td><input<div class="form-control" name="campoN" type="text"></td>checkbox">
        <label>
        <td><input<input classtype="form-controlcheckbox" name="campoMocultarLinha1" type="text"></td>>
        Ocultar linha 1
        </label>
    </tr>div>
    <div class="checkbox">
    </tbody>
    </table><label>
    <p>
    <div id<input type="checkbox" name="loremIpsumocultarExclusao">
        LoremOcultar Ipsum:botão Proinde egetexcluir
 purus non mauris vehicula aliquam vitae sed est</label>
    </div>
</form>
</div>
</body>
</html>

 

Bloco de código
languagejs
titledisplayFields.js - Clique para expandir
linenumberstrue
collapsetrue
 function displayFields(form,customHTML){    <div class="checkbox">
    var ocultarTodaTabela = form.getValue("ocultarTabela") == "on"; // Ocultar toda tabela
 <label>
        <input var ocultarCampoA = form.getValue("ocultarCampoA") == "on"; // Ocultar campo A
type="checkbox" name="ocultarImpressao">
        varOcultar ocultarCampoN1botão = form.getValue("ocultarCampoN1") == "on"; // Ocultar campo N da primeira linhade imprimir
        </label>
    </div>
 var ocultarCampoM2 = form.getValue("ocultarCampoM2") == "on"; // Ocultar campo M da segunda linha
 <div class="checkbox">
        <label>
       var ocultarLinha1<input type= form.getValue("ocultarLinha1checkbox") name== "onocultarLoremIpsum";>
 // Ocultar linha 1
    varOcultar ocultarExclusaoLorem = form.getValue("ocultarExclusao") == "on"; // Ocultar botão de excluirIpsum
        </label>
    </div>
 var ocultarImpressao = form.getValue("ocultarImpressao") == "on"; // Ocultar botão de imprimir <p><br><p>
    var ocultarLoremIpsum = form.getValue("ocultarLoremIpsum") == "on"; // Ocultar a div Lorem Ipsum<input type="text" name="campoA" placeholder="Campo A" class="form-control" ></input><br>
    <p>
    if<h2>Tabela ( ocultarTodaTabela ) {de registros</h2>
    <table class="table table-bordered"  form.setVisibleById("minhaTabela", false); // bloqueia o campo, tabela ou div cujo id seja "minhaTabela"
    }
    if ( ocultarCampoA ) {tablename="tabelaTeste" addbuttonlabel="Novo Registro" cellspacing="0" width="100%" id="minhaTabela">
        <thead>
            <tr class="tableHeadRow">
        form.setVisible("campoA", false); // bloqueia o campo com name "campoA"
    }
    if ( ocultarCampoN1 ) {
        <td class="tableColumn">N</td>
                 form.setVisible("campoN___1", false); // bloqueia o campo com name "campoN___1"
<td class="tableColumn">M</td>
            }</tr>
    if ( ocultarCampoM2 ) {</thead>
        form.setVisible("campoM___2", false); // bloqueia o campo com name "campoM___2"
    }
<tbody>
            <tr class="tableBodyRow" id="linha">
     if ( ocultarLinha1 ) {
       <td><input form.setVisibleById("linha___1", false); // bloqueia o campo, tabela ou div cujo id seja "linha___1"
    }
    if ( ocultarLoremIpsum ) {
class="form-control" name="campoN" type="text"></td>
                <td><input class="form-control" name="campoM" type="text"></td>
          form.setVisibleById("loremIpsum", false); <//tr>
 bloqueia o campo, tabela ou div cujo id seja "loremIpsum" </tbody>
    }</table>
    <p>
 if ( ocultarExclusao ) {<div id="loremIpsum">
        form.setHideDeleteButton(true); // bloqueia o botão de exclusão de linha
    }Lorem Ipsum: Proin eget purus non mauris vehicula aliquam vitae sed est
    </div>
</form>
</div>
</body>
</html>
Bloco de código
languagejs
titledisplayFields.js - Clique para expandir
linenumberstrue
collapsetrue
 function displayFields(form,customHTML){
    var ocultarTodaTabela = form.getValue("ocultarTabela") == "on"if ( ocultarImpressao ) {
        form.setHidePrintLink(true); // bloqueiaOcultar botãotoda detabela
 imprimir
    }
}

 

É importante destacar que este evento é o único que permite a alteração dos valores a serem apresentados nos campos formulário antes da renderização deste.

Abaixo um exemplo para usar a saída de apresentação do formulário:

Bloco de código
languagejs
if(form.getFormMode() != "VIEW")  {
    customHTML.append("<script>");
    customHTML.append("function MostraEscondeBtn_zoom()");
    customHTML.append("{");
    customHTML.append("document.getElementById(\'zoomUsuario\').className = \'show\';");
    customHTML.append("document.getElementById(\'zoomModulo\').className = \'show\';");
    customHTML.append("}");
    customHTML.append("</script>");
}

 

Carregar dados em tela com evento displayFields

Para que os dados sejam carregados e apresentados em tela, principalmente em dispositivos mobile, é necessário chamar as funções que irão carregá-los dentro de uma estrutura de read.

A invocação dos métodos que irão popular o formulário deve estar contida dentro de uma chamada $(function(), garantindo assim o carregamento dos arquivos exigidos pelo formulário antes das funções.

Por exemplo, deseja-se carregar dados de produtos em um formulário. Para que isto ocorra, foi criada uma função loadProdutos() que irá preencher um grid inserido no formulário HTML. Neste caso a chamada desta função dentro do displayFields ficaria:

Bloco de código
languageactionscript3
customHTML.append('<script>');
customHTML.append('$(function(){');
customHTML.append("loadProdutos();");
customHTML.append('});');
customHTML.append('</script>');

...

Esse evento é disparado no momento em que os objetos do formulário são habilitados, permitindo desabilitar alguns campos, caso haja a necessidade. O evento recebe como parâmetro uma referência ao formulário da definição de formulário. Para habilitar ou desabilitar um campo do formulário o seguinte procedimento deve ser executado:

Bloco de código
languagejs
form.setEnabled("nome-do-campo",true/false)

Onde “true” habilita o campo e “false” desabilita o campo.

Exemplo:

Bloco de código
languagejs
 function enableFields(form) {
    if ( form.getFormMode() != 'ADD' ){   
        form.setEnabled("rnc_area",false);var ocultarCampoA = form.getValue("ocultarCampoA") == "on"; // Ocultar campo A
    var ocultarCampoN1 = form.getValue("ocultarCampoN1") == "on"; // Ocultar campo N da primeira linha
    var ocultarCampoM2 = form.getValue("ocultarCampoM2") == "on"; // Ocultar campo M da segunda linha
    var ocultarLinha1 = form.getValue("ocultarLinha1") == "on"; // Ocultar linha 1
    var ocultarExclusao = form.getValue("ocultarExclusao") == "on"; // Ocultar botão de excluir
    var ocultarImpressao = form.getValue("ocultarImpressao") == "on"; // Ocultar botão de imprimir
    var ocultarLoremIpsum = form.getValue("ocultarLoremIpsum") == "on"; // Ocultar a div Lorem Ipsum
    if ( ocultarTodaTabela ) {
        form.setVisibleById("minhaTabela", false); // bloqueia o campo, tabela ou div cujo id seja "minhaTabela"
    }
    if ( ocultarCampoA ) {
        form.setVisible("campoA", false); // bloqueia o campo com name "campoA"
    }
    if ( ocultarCampoN1 ) {
        form.setVisible("campoN___1", false); // bloqueia o campo com name "campoN___1"
    }
    if ( ocultarCampoM2 ) {
        form.setVisible("campoM___2", false); // bloqueia o campo com name "campoM___2"
    }
    if ( ocultarLinha1 ) {
        form.setVisibleById("linha___1", false); // bloqueia o campo, tabela ou div cujo id seja "linha___1"
    }
    if ( ocultarLoremIpsum ) {
        form.setVisibleById("loremIpsum", false); // bloqueia o campo, tabela ou div cujo id seja "loremIpsum"
    }
    if ( ocultarExclusao ) {
        form.setEnabled("rnc_tipo_ocorrencia",false);setHideDeleteButton(true); // bloqueia o botão de exclusão de linha
    }
    if ( ocultarImpressao ) {
        form.setHidePrintLink(true); // bloqueia botão de imprimir
    }
}

É importante destacar que o evento ocorre no momento da renderização do formulário e é o único que permite alterar o estado de apresentação dos campos do formulário.


Outra forma de desabilitar os campos é utilizando comandos JavaScript implementados diretamente em funções do formulário. Porém, neste caso, não é permitido utilizar a propriedade disabled, pois os campos não serão gravados ao salvar o registro de formulário. Para esta situação, deve-se utilizar a propriedade readonly conforme exemplo abaixoConforme explicado, o customHTML permite personalizar o formulário diretamente pelo método displayFields. Este exemplo, adaptado dos nos Exemplos Avançados, mostra como usar o displayFields para, no formulário, ter acesso ao modo de visualização, código do solicitante e número da atividade. Além de preencher alguns campos da solicitação com a data atual e o nome do solicitante:

Bloco de código
languagejs
document.forms['nomeForm'].nomeCampo.setAttribute('readonly',true);
Nota
titleFique atento!

Mesmo utilizando a função setEnable, ainda existe a possibilidade de algum usuário conseguir visualizar informações do campo formulário oculto, utilizando de recursos como a ferramenta de inspeção de código dos navegadores.

Protegendo campos desabilitados 

Ao proteger um campo desabilitado, ele não terá o seu valor alterado no registro de formulário. Para isso, informe o valor true para o parâmetro protect do método setEnabled conforme o exemplo abaixo:

Bloco de código
languagejs
 function enableFields(form) { 
    if ( form.getFormMode() != 'ADD' ){    
        form.setEnabled("rnc_cod_ocorrencia",false, true);
    }
}

 

Também é possível utilizar o método setEnhancedSecurityHiddenInputs, que faz com que todos os campos desabilitados pelo método setEnabled fiquem protegidos:

Bloco de código
languagejs
function enableFields(form) { 
    if ( form.getFormMode() != 'ADD' ){   
		form.setEnhancedSecurityHiddenInputs(true); 
        form.setEnabled("rnc_cod_ocorrencia",false);
    }
}
Nota
titleAtenção!

O método setEnhancedSecurityHiddenInputs só protegerá campos desabilitados após a sua executação no evento.

inputFields

Esse evento é disparado no momento em que os dados do formulário são passados para a BO responsável por formulário do fluig. O evento recebe como parâmetro uma referência ao formulário da definição de formulário. Exemplo:

Bloco de código
languagejs
function inputFields(form){
}
Nota
titleAtenção!

 Este evento pode ser usado para que as datas persistidas por formulários customizados sejam salvas corretamente. Hoje no sistema as datas salvas através de formulários pelo navegador Chrome são salvas com padrão americano (yyyy-mm-dd), enquanto as datas nos demais navegadores são salvas com padrão brasileiro (dd/mm/yyyy). Para empresas que utilizam múltiplos navegadores e querem que os dados de data estejam padronizados, recomendamos a utilização do evento inputFields com o seguinte trecho de código.

Bloco de código
languagejs
titleCódigo para Datas
function inputFields(form) { 

var regEx = /^\d{4}-\d{2}-\d{2}$/; 

if (form.getValue("dt_solicitacao").match(regEx)) { 
var split = form.getValue("dt_solicitacao").split('-'); 
form.setValue("dt_solicitacao", split[2] + '-' + split[1] + '-' + split[0]); 
} 

}

setEnable

Esse evento pode ser executado em diferentes eventos das definições de formulário. Este evento não é implementado automaticamente na customização da definição de formulário. Exemplo:

Bloco de código
languagejs
function setEnable() {
  log.info(“Teste de chamada de função”);
}
 
function displayFields(form, customHTML) {
  setEnable();
}

validateForm

Esse evento é executado antes da gravação dos dados do formulário no banco de dados. O evento recebe como parâmetro uma referência ao formulário da definição de formulário. Em caso de erros de validação dos dados do formulário, esse evento retornará uma mensagem de erro para o usuário, através de uma modal do fluig, com a mensagem definida no evento.

Informações

A partir da atualização fluig 1.5.10, para quebrar a linha na mensagem de validação deve ser utilizado o padrão \n.

Exemplo:

Bloco de código
languagejavascript
function validateForm(form) {
   if (form.getValue('RNC_colab_abertura') == null){
     throw "O colaborador de abertura não foi informado";
   }   
}  

afterProcessing

É o último evento a ser disparado para o formulário. O evento recebe como parâmetro uma referência ao formulário da definição de formulário.

Exemplo:

Bloco de código
languagejs
function afterProcessing(form){
}

...

function displayFields(form,customHTML){
  // getValue("WKNumState"); -> Número da atividade atual de acordo com o diagrama
  var numeroAtividadeAtual = getValue("WKNumState");

  /*
  * form.getFormMode();
  * ADD - Momento inicial do formulário antes de iniciar e/ou salvar o processo
  * MOD - Momento a qual os campos estão editavéis para o usuário modificar após iniciar e/ou salvar o processo
  * VIEW - Modo de visualização do formulário
  */
  var modoDeVisualizacaoDoFormulario = form.getFormMode();

  // getValue("WKUser"); ->  Retorno o código do usuário logado
  var codigoSolicitante = getValue("WKUser");

  if (modoDeVisualizacaoDoFormulario != "VIEW") {
    if (numeroAtividadeAtual == Atividades.ZERO || numeroAtividadeAtual == Atividades.INICIO) { //Antes do processo ser iniciado ou salvo o número da primera ativade é 0
      form.setValue("codigoSolicitante", codigoSolicitante);
      form.setValue("nomeSolicitante", buscaNomeDeUsuarioPeloIdentificador(codigoSolicitante));
      form.setValue("dataSolicitacao", retornaDataAtual());
    }
  }

  // Exemplo de injeção de javascript pelo evento de formulário displayFields
  customHTML.append("<script type='text/javascript'>");
  customHTML.append("var modoDeVisualizacaoDoFormulario = '" + modoDeVisualizacaoDoFormulario + "';");
  customHTML.append("var numeroAtividadeAtual = " + numeroAtividadeAtual + ";");
  customHTML.append("var codigoSolicitante = '" + codigoSolicitante + "';");
  customHTML.append("</script>");
}

/**
* Função para retornar a data atual
* @returns data atual
*/
function retornaDataAtual() {
  return (new java.text.SimpleDateFormat('dd/MM/yyyy')).format(new Date());
}

/**
*
* @param {*} codigoSolicitante
* @returns retorno o nome do usuário
*/
function buscaNomeDeUsuarioPeloIdentificador(codigoSolicitante) {
  var constraint = DatasetFactory.createConstraint("colleaguePK.colleagueId", codigoSolicitante , codigoSolicitante, ConstraintType.MUST);
  var dataset = DatasetFactory.getDataset("colleague", null, [constraint], null);

  return dataset.getValue(0, "colleagueName");
}


Para que os dados sejam carregados e apresentados em tela, principalmente em dispositivos mobile, é necessário chamar as funções que irão carregá-los dentro de uma estrutura de read.

A invocação dos métodos que irão popular o formulário deve estar contida dentro de uma chamada $(function(), garantindo assim o carregamento dos arquivos exigidos pelo formulário antes das funções.

Por exemplo, deseja-se carregar dados de produtos em um formulário. Para que isto ocorra, foi criada uma função loadProdutos() que irá preencher um grid inserido no formulário HTML. Neste caso a chamada desta função dentro do displayFields ficaria:

Bloco de código
languageactionscript3
customHTML.append('<script>');
customHTML.append('$(function(){');
customHTML.append("loadProdutos();");
customHTML.append('});');
customHTML.append('</script>');

Mas, exceto em situações onde há mais coisas no customHTML que justifiquem isso, o mais recomendado é que você faça isso dentro dos próprios scripts javascript do formulário


enableFields

...

Esse evento é disparado no momento em que os objetos do formulário são habilitados. O evento recebe como parâmetro um objeto do tipo FormController

Bloco de código
languagejs
titleExemplo de como tornar campo desativado conforme o modo do formulário
linenumberstrue
 function enableFields(form) {
    if ( form.getFormMode() != 'ADD' ){   
        form.setEnabled("rnc_area",false);
        form.setEnabled("rnc_tipo_ocorrencia",false);
    }
}

Outra forma de desabilitar os campos é utilizando comandos JavaScript implementados diretamente em funções do formulário. Porém, neste caso, não é permitido utilizar a propriedade disabled, pois os campos não serão gravados ao salvar o registro de formulário. Para esta situação, deve-se utilizar a propriedade readonly conforme exemplo abaixo:

Bloco de código
languagejs
document.forms['nomeForm'].nomeCampo.setAttribute('readonly',true);
Nota
titleFique atento!

Mesmo utilizando a função setEnable, ainda existe a possibilidade de algum usuário conseguir visualizar informações do campo formulário oculto, utilizando de recursos como a ferramenta de inspeção de código dos navegadores.

Aviso
titleAtenção

Ao utilizar o evento enableFields para proteger os campos, é adicionado o caractere underline (_) nas propriedade name e id. Com isso as manipulações via JavaScript puro ou pela biblioteca jQuery não terão efeitos, devido a alteração destas propriedades:

Exemplo enableFields.js:

Bloco de código
function enableFields(form) {
 var atividade = parseInt(getValue('WKNumState'));
    
    if(atividade == 0 || atividade == 4){
     form.setEnabled('loginsolicitante', false);
    }
    
    if(atividade == 5){
     form.setEnabled('nomesolicitante', false);
    }
}

HTML:

Bloco de código
<div class="panel-body">
    <div class="row inicial" id="inicialRow0">
        <div class="col-xs-12 col-md-2 col-sm-12 col-lg-2">
            <div class="form-group">
                <label class="control-label" for="loginsolicitante">Login</label>
                <input type="text" class="form-control" name="loginsolicitante" id="loginsolicitante" value="adm"/>
            </div>
        </div>
        <div class="col-xs-12 col-md-4 col-sm-12 col-lg-4">
            <div class="form-group">
                <label class="control-label" for="nomesolicitante">Solicitante</label>
                <input type="text" class="form-control" name="nomesolicitante" id="nomesolicitante" value="Administrador"/>
            </div>
        </div>
    </div>
</div>

Resultado no navegador/console, onde o campo loginsolicitante agora é _loginsolicitante e o campo nomesolicitante permanece igual, pois a lógica implementada indica que será bloqueado na próxima movimentação:

Image Added



Protegendo campos desabilitados

Ao proteger um campo desabilitado, ele não terá o seu valor alterado no registro de formulário. Para isso, informe o valor true para o parâmetro protect do método setEnabled conforme o exemplo abaixo:

Bloco de código
languagejs
 function enableFields(form) { 
    if ( form.getFormMode() != 'ADD' ){    
        form.setEnabled("rnc_cod_ocorrencia",false, true);
    }
}


Também é possível utilizar o método setEnhancedSecurityHiddenInputs, que faz com que todos os campos desabilitados pelo método setEnabled fiquem protegidos:

Bloco de código
languagejs
function enableFields(form) { 
    if ( form.getFormMode() != 'ADD' ){   
		form.setEnhancedSecurityHiddenInputs(true); 
        form.setEnabled("rnc_cod_ocorrencia",false);
    }
}
Nota
titleAtenção!

O método setEnhancedSecurityHiddenInputs só protegerá campos desabilitados após a sua execução no evento e quando o formulário estiver no contexto de uma execução de processo.


inputFields

...

Esse evento é disparado no momento em que os dados do formulário são passados para a BO responsável por formulário do fluig. O evento recebe como parâmetro uma referência ao formulário da definição de formulário. 

Exemplo:

Bloco de código
languagejs
function inputFields(form){
}
Nota
titleAtenção!

O evento inputFields não foi criado para ser utilizado na "Movimentação em Bloco", seu foco é o tratamento de campos que vem do navegador.

Esse evento é disparado no momento em que os dados do formulário são passados para a BO responsável por formulário do fluig. O evento recebe como parâmetro um objeto do tipo FormController

Este evento pode ser usado para que as datas persistidas por formulários customizados sejam salvas corretamente. Hoje no sistema as datas salvas através de formulários pelo navegador Chrome tem o padrão americano (yyyy-mm-dd), enquanto as datas nos demais navegadores tem o padrão brasileiro (dd/mm/yyyy). Para empresas que utilizam múltiplos navegadores e querem que os dados de data estejam padronizados, recomendamos a utilização do evento inputFields com o seguinte trecho de código.

Bloco de código
languagejs
titleCódigo para Datas
function inputFields(form) { 
    var regEx = /^\d{4}-\d{2}-\d{2}$/; 

    if (form.getValue("dt_solicitacao").match(regEx)) { 
        var split = form.getValue("dt_solicitacao").split('-'); 
        form.setValue("dt_solicitacao", split[2] + '-' + split[1] + '-' + split[0]); 
    } 
}


validateForm

...

Esse evento é disparado antes da gravação dos dados do formulário. O evento recebe como parâmetro um objeto do tipo FormController

Ele é utilizado para fazer validações nos campos.

Bloco de código
languagejs
titleExemplo da validação do campo de formulário
linenumberstrue
function validateForm(form) {
   if (form.getValue('RNC_colab_abertura') == null){
     throw "O colaborador de abertura não foi informado";
   }   
}
Bloco de código
languagejs
titleExemplo da validação do campo de formulário com mensagem com quebra de linha
linenumberstrue
function validateForm(form) {
   if (form.getValue('RNC_colab_abertura') == null){
     throw "O colaborador de abertura não foi informado\nFavor preencher o campo e tentar novamente";
   }   
}


afterSaveNew

...

Esse evento é disparado após a criação de um formulário. O evento recebe como parâmetro um objeto do tipo FormController

Este evento pode ser feito para criar algum tipo de log ou disparar algum evento:

Bloco de código
languagejs
titleExemplo de uso para imprimir log
linenumberstrue
function afterSaveNew(form) {
  log.info("Colaborador de abertura: " + form.getValue("RNC_colab_abertura"));
}


afterProcessing

...

Este é último evento disparado no formulário. O evento recebe como parâmetro um objeto do tipo FormController

Neste contexto, o FormControler deve ser usado apenas para consulta de dados, alterações nos dados não serão persistidas. Assim como o afterSaveNew pode ser usado para log ou disparo de algum tipo de evento.

Bloco de código
languagejs
function afterProcessing(form){
}


beforeMovementOptions

...

Diferentemente dos outros eventos que precisam de um script próprio e são executados no servidor, este evento acontece ao clicar em "enviar" no navegador antes de abrir a tela de movimentação. Por isso, esse código deve ser implementado em um arquivo javascript vinculado ao formulário html. Ele recebe o parâmetro da atividade atual e é muito útil para algumas validações de campos antes mesmo de ser enviado para o servidor.

Bloco de código
languagejs
titleExemplo de implementação em um arquivo.js
linenumberstrue
  var beforeMovementOptions = function(numState) {
    if (document.form.codigo.value == '') {
      throw ("Erro: O código não foi preenchido");
    }
    return true;
  }
Nota
titleFique atento!

Este método só é executado caso haja a abertura da tela de movimentação, o que leva em consideração se há mais de uma atividade destino ou o mecanismo de atribuição da próxima tarefa. E também não é considerada em movimentações via api, ou diretamente no formulário pela navegação de documento. Utilize o validateForm em conjunto com esse método para garantir a integridade das validações


beforeSendValidate

...

Assim como beforeMovementOptions, este evento acontece ao clicar em "enviar" no navegador para executar a movimentação em si. Ou seja, depois do beforeMovementOptions e independente da tela de seleção de atividade/usuário destino.

Esse código deve ser implementado em um arquivo javascript vinculado ao formulário html. Ele recebe o parâmetro da atividade atual e da atividade destino (ou seja, pra qual atividade está sendo enviado essa solicitação) e é muito útil para algumas validações de campos antes mesmo de ser enviado para o servidor.

Ocorre antes da solicitação ser movimentada, após já ter sido selecionada a atividade destino o usuário e demais informações necessárias à solicitação.

Bloco de código
languagejs
titleExemplo de implementação em um arquivo.js
linenumberstrue
  var beforeSendValidate = function(numState, nextState) {
    if (numState == 1 && nextState == 2 && document.form.codigo.value == '') {
      throw ("Erro: Para movimentar para a atividade 2, o código deve ser preenchido");
    }
    return true;
  }

setEnable

...

Este evento está depreciado e não é mais utilizado.

beforeProcessing

Esse evento é o primeiro a ser disparado. Ocorre antes de qualquer outro evento da definição de formulário. O evento recebe como parâmetro uma referência ao formulário da definição de formulário. Exemplo:

Bloco de código
languagejs
function beforeProcessing(form){
}

No contexto deste evento a variável form pode ser usada somente para consulta aos campos da definição de formulário, seus valores e estado de apresentação.

beforeMovementOptions

É executado quando o usuário pressiona o botão Movimentar antes de serem exibidas as opções de movimentação do processo.

Parâmetros da função

numStatenúmero da atividade atualint
Propriedade
Descrição
Tipo

Exemplo de implementação

 

1
2
3
4
5
6
7
8
9
10
11
var beforeMovementOptions = function(numState){
    console.log("-beforeMovementOptions-");
    console.log("numState: " + numState);
    console.log("valor campo Email: " +document.formulario.email.value);
    if(document.cad01.nome.value === 'false'){
        return false;
    }
    if(document.cad01.nome.value !== ''){
        throw("Erro " + document.formulario.nome.value);
    }
}

 

beforeSendValidate

Ocorre antes da solicitação ser movimentada, após já ter sido selecionada a atividade destino, o usuário e demais informações necessárias à solicitação.

Parâmetros da função

numStatenúmero da atividade atualint
nextStatenúmero da atividade destinoint
Propriedade
Descrição
Tipo

Exemplos de implementação

 

1
2
3
4
5
6
var beforeSendValidate = function(numState,nextState){
    console.log("-beforeSendValidate-");
    console.log("numState: " + numState);
    console.log("nextState: " + nextState); 
    throw("Erro Xyz");
}

 

 

1
2
3
4
5
6
7
var beforeSendValidate = function(numState,nextState){
    console.log("-beforeSendValidate-");
    console.log("numState: " + numState);
    console.log("nextState: " + nextState); 
    var isOk = confirm("Deseja realmente enviar o processo ?");
    return isOk;
 }

 

Eventos de Formulário Pai Filho

Para facilitar a manipulação dos dados em uma customização de formulário que faz uso da técnica Pai Filho, foram disponibilizados os métodos listados a seguir. Ambos são chamados a partir do objeto form que é passado como parâmetro nas funções de customização de formulários.

 

getChildrenFromTable

Esse evento retorna um mapa com todos os campos filhos de um Pai Filho a partir do seu tablename.

 

getChildrenIndexes

Esse evento retorna os índices dos registros (linhas) contidos em um Pai Filho a partir do seu tablename.

 

 

Bloco de código
languagejava
themeEclipse
function validateForm(form){
    var indexes = form.getChildrenIndexes("tabledetailname");
    var total = 0;
    for (var i = 0; i < indexes.length; i++) {
        var fieldValue = parseInt(form.getValue("valor___" + indexes[i]));
        if (isNaN(fieldValue)){
            fieldValue = 0;
        } 
        total = total + fieldValue;
        log.info(total);
    }
    log.info(total);
    if (total < 100) {
        throw "Valor Total da requisição não pode ser inferior a 100";
    }
}
enableFields

Para utilizar o evento enableFields em um formulário Pai x Filho, é necessário ter o índice da linha a qual o campo a ser desabilitado pertence.

Uma forma de obter essa informação é através do método getChildrenIndexes conforme exemplo a seguir:

...

languagejava
themeEclipse

...