Mudanças entre as edições de "Desenvolvedor:APIs/JavaScript/latromi.formManager/setOnEventFiringCallback(function)"

De LATROMI Manuais
Desenvolvedor:APIs/JavaScript/latromi.formManager/setOnEventFiringCallback(function)
Ir para: navegação, pesquisa
(Exemplos)
(Cancelando um evento)
 
(8 revisões intermediárias pelo mesmo usuário não estão sendo mostradas)
Linha 1: Linha 1:
{{DISPLAYTITLE:Método setOnEventFiringCallback()}}__NOTOC__
+
{{DISPLAYTITLE:Método setOnEventFiringCallback(function)}}__NOTOC__
Especifica uma [https://www.google.com/search?q=Função+de+Callback função de callback], que será chamada quando o processo de criação do Formulário Dinâmico na página for concluído. Este evento ocorre apenas uma vez para cada página carregada.
+
Especifica uma [https://www.google.com/search?q=Função+de+Callback função de callback], que será chamada antes do processamento de eventos do Formulário Dinâmico no servidor.
  
 
'''Membro de:''' [[DEV:APIs/JavaScript/latromi.formManager|latromi.formManager]]
 
'''Membro de:''' [[DEV:APIs/JavaScript/latromi.formManager|latromi.formManager]]
Linha 7: Linha 7:
 
<syntaxhighlight lang="JavaScript">
 
<syntaxhighlight lang="JavaScript">
 
function setOnEventFiringCallback(callback) {  
 
function setOnEventFiringCallback(callback) {  
   var arguments = new latromi.formEventFiringContext();
+
   var context = new latromi.formEventFiringContext();
   callback(arguments);  
+
   callback(context);  
 
}
 
}
 
</syntaxhighlight>
 
</syntaxhighlight>
Linha 18: Linha 18:
  
 
=== Valor de Retorno ===
 
=== Valor de Retorno ===
Sem retorno.
+
: Sem retorno.
  
 
== Exemplos ==
 
== Exemplos ==
  
 +
=== Utilizando o contexto ===
 +
O exemplo a seguir, mostra como interceptar o disparo de um evento do Formulário Dinâmico. O código executa as seguintes ações:
 +
* Verifica se é um evento de campo.
 +
* Se for um evento de campo, mostra no console do navegador o nome do campo e nome do evento disparado.
 +
* Se for outro tipo de evento, mostra apenas o nome do evento.
  
Exemplo:
+
<syntaxhighlight lang="JavaScript">
 +
latromi.formManager.setOnEventFiringCallback( function(context) {
 +
  if (context.eventKind === 'Field')
 +
      console.log('Evento ' + context.eventName + ' do campo ' + context.field.name + ' disparado.');
 +
  else
 +
      console.log('Evento ' + context.eventName + ' disparado.')
 +
});
 +
</syntaxhighlight>
  
 +
=== Cancelando um evento ===
 +
O exemplo a seguir, mostra como cancelar o processamento de um evento no servidor. O código executa as seguintes ações:
 +
* Verifica se o evento disparado foi o ''Click'' do botão ''btnFakeButton''. Se for, executa as ações:
 +
** Cancela o processamento do evento no servidor.
 +
** Mostra no console do navegador uma mensagem notificando o cancelamento do evento.
 
<syntaxhighlight lang="JavaScript">
 
<syntaxhighlight lang="JavaScript">
function test() {
+
latromi.formManager.setOnEventFiringCallback( function(context) {
 
+
  if (context.eventKind  === 'Field'
}
+
      && context.field.name === 'btnFakeButton'
 +
      && context.eventName === 'Click')  
 +
  {
 +
      context.cancel = true;
 +
      console.log('O Evento Click do botão btnFakeButton foi cancelado.');
 +
  }
 +
});
 
</syntaxhighlight>
 
</syntaxhighlight>

Edição atual tal como às 14h10min de 22 de novembro de 2018

Especifica uma função de callback, que será chamada antes do processamento de eventos do Formulário Dinâmico no servidor.

Membro de: latromi.formManager

Sintaxe

function setOnEventFiringCallback(callback) { 
   var context = new latromi.formEventFiringContext();
   callback(context); 
}

Parâmetros

callback
Tipo: function (formEventFiringContext)
Função de callback, esperando um parâmetro do tipo formEventFiringContext. Neste parâmetro estarão disponíveis as informações de contexto do evento.

Valor de Retorno

Sem retorno.

Exemplos

Utilizando o contexto

O exemplo a seguir, mostra como interceptar o disparo de um evento do Formulário Dinâmico. O código executa as seguintes ações:

  • Verifica se é um evento de campo.
  • Se for um evento de campo, mostra no console do navegador o nome do campo e nome do evento disparado.
  • Se for outro tipo de evento, mostra apenas o nome do evento.
latromi.formManager.setOnEventFiringCallback( function(context) {
   if (context.eventKind === 'Field')
      console.log('Evento ' + context.eventName + ' do campo ' + context.field.name + ' disparado.');
   else
      console.log('Evento ' + context.eventName + ' disparado.')
});

Cancelando um evento

O exemplo a seguir, mostra como cancelar o processamento de um evento no servidor. O código executa as seguintes ações:

  • Verifica se o evento disparado foi o Click do botão btnFakeButton. Se for, executa as ações:
    • Cancela o processamento do evento no servidor.
    • Mostra no console do navegador uma mensagem notificando o cancelamento do evento.
latromi.formManager.setOnEventFiringCallback( function(context) {
   if (context.eventKind   === 'Field' 
      && context.field.name === 'btnFakeButton' 
      && context.eventName === 'Click') 
   {
      context.cancel = true;
      console.log('O Evento Click do botão btnFakeButton foi cancelado.');
   }
});