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 37: Linha 37:
 
|[[DEV:APIs/JavaScript/latromi.formManager/setOnFieldValueChangedCallback(function)|setOnFieldValueChangedCallback(function)]]
 
|[[DEV:APIs/JavaScript/latromi.formManager/setOnFieldValueChangedCallback(function)|setOnFieldValueChangedCallback(function)]]
 
|Callback disparado quando o valor de um campo for alterado.
 
|Callback disparado quando o valor de um campo for alterado.
|}
 
 
== <span id="getFormInstance"></span>getFormInstance() ==
 
Função que retorna uma instância de [[Dev:APIs/JavaScript/latromi.formInstance|formInstance]].
 
 
{|class="wikitable apidoctable"
 
!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:
 
 
<syntaxhighlight lang="JavaScript">
 
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!');
 
  }
 
}
 
</syntaxhighlight>
 
 
== <span id="setOnFormCreatedCallback"></span>setOnFormCreatedCallback() ==
 
Especifica uma [https://www.google.com.br/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.
 
 
{|class="wikitable apidoctable"
 
!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:
 
 
{|class="wikitable apidoctable"
 
|+ CallbackArguments
 
!Membro
 
!Tipo
 
!Descrição
 
|-
 
|form
 
|[[Dev:APIs/JavaScript/latromi.formInstance|latromi.formInstance]]
 
|Instância do Formulários que foi criado.
 
|}
 
 
== <span id="setOnEventFiringCallback"></span>setOnEventFiringCallback() ==
 
 
{|class="wikitable apidoctable"
 
!Parâmetro
 
!Tipo
 
!Descrição
 
|-
 
|callback
 
|function (arguments)
 
|Função de callback, esperando um parâmetro do tipo ''Object''.
 
|}
 
 
== <span id="setOnFieldValueChangedCallback"></span>setOnFieldValueChangedCallback() ==
 
 
{|class="wikitable apidoctable"
 
!Parâmetro
 
!Tipo
 
!Descrição
 
|-
 
|callback
 
|function (arguments)
 
|Função de callback, esperando um parâmetro do tipo ''Object''.
 
 
|}
 
|}

Edição das 12h50min 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(function) Callback disparado quando o Formulário for criado na página.
setOnEventFiringCallback(function) Callback disparado quando um evento for disparado.
setOnFieldValueChangedCallback(function) Callback disparado quando o valor de um campo for alterado.