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

De LATROMI Manuais
Desenvolvedor:APIs/JavaScript/latromi.formManager
Ir para: navegação, pesquisa
Linha 1: Linha 1:
 
{{DISPLAYTITLE:latromi.formManager}}__NOTOC__
 
{{DISPLAYTITLE:latromi.formManager}}__NOTOC__
 
Gerenciador de Formulários Dinâmicos. Essa fornece os seguintes objetos no lado do cliente:
 
Gerenciador de Formulários Dinâmicos. Essa fornece os seguintes objetos no lado do cliente:
 +
 +
== Sintaxe ==
 +
<syntaxhighlight lang="JavaScript">
 +
latromi.formInstance = function () {
 +
      return {
 +
        // Callback para quando o form for criado
 +
        setOnFormCreatedCallback: function (callback) { },
 +
       
 +
        // Callback para quando um evento for disparado
 +
        setOnEventFiringCallback: function (callback) { },
 +
       
 +
        // Callback para quando o valor de um campo for alterado
 +
        setOnFieldValueChangedCallback: function (callback) { },
 +
       
 +
        // Obtém uma instância do Formulário
 +
        getFormInstance: function (upgradeCode) { }
 +
      }
 +
}
 +
</syntaxhighlight>
 +
 +
 
{|class="wikitable apidoctable2"
 
{|class="wikitable apidoctable2"
 
|+ Métodos
 
|+ Métodos

Edição das 11h35min de 9 de julho de 2018

Gerenciador de Formulários Dinâmicos. Essa fornece os seguintes objetos no lado do cliente:

Sintaxe

latromi.formInstance = function () {
      return {
         // Callback para quando o form for criado
         setOnFormCreatedCallback: function (callback) { },
         
         // Callback para quando um evento for disparado
         setOnEventFiringCallback: function (callback) { },
         
         // Callback para quando o valor de um campo for alterado
         setOnFieldValueChangedCallback: function (callback) { },
         
         // Obtém uma instância do Formulário
         getFormInstance: function (upgradeCode) { }
      }
}


Métodos
Nome Descrição
getFormInstance(string) Retorna um objeto do tipo latromi.formInstance, referente a um Formulário Dinâmico carregado na tela.
setOnFormCreatedCallback() Callback disparado quando o Formulário for criado na página.
setOnEventFiringCallback() Callback disparado quando um evento for disparado.
setOnFieldValueChangedCallback() Callback disparado quando o valor de um campo for alterado.

getFormInstance()

Função que retorna uma instância de formInstance.

Parâmetro Tipo Descrição
upgradeCode * string Código de atualização do Formulário Dinâmico. Este parâmetro é opcional. Se for especificado, o formManager vai procurar um formulário que contenha esse código. Caso contrário, vai retornar o primeiro Formulário encontrado.

Exemplo:

function getFormInstance() {
   // Obtém a instância do formulário
   var form = latromi.formManager.getFormInstance();
   if (form) {
      console.log('Form com UpgradeCode ' + form.upgradeCode + ' encontrado!');
   }
}

setOnFormCreatedCallback()

Especifica uma 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.

Parâmetro Tipo Descrição
callback function (arguments) Função de callback, esperando um parâmetro do tipo Object.

A função de callback informada deve esperar um parâmetro do tipo Object. Neste parâmetro estarão disponíveis as informações de contexto do evento, conforme especificadas abaixo:

CallbackArguments
Membro Tipo Descrição
form latromi.formInstance Instância do Formulários que foi criado.

setOnEventFiringCallback()

Parâmetro Tipo Descrição
callback function (arguments) Função de callback, esperando um parâmetro do tipo Object.

setOnFieldValueChangedCallback()

Parâmetro Tipo Descrição
callback function (arguments) Função de callback, esperando um parâmetro do tipo Object.