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

De LATROMI Manuais
Desenvolvedor:APIs/JavaScript/latromi.fieldInstance
Ir para: navegação, pesquisa
(Criou página com '{{DISPLAYTITLE:latromi.fieldInstance}}__NOTOC__ Fornece propriedades e métodos para manipulação de campos do Formulário Dinâmico. == Propriedades == {|class="wikitable...')
 
(→‎Sintaxe)
 
(8 revisões intermediárias pelo mesmo usuário não estão sendo mostradas)
Linha 1: Linha 1:
 
{{DISPLAYTITLE:latromi.fieldInstance}}__NOTOC__
 
{{DISPLAYTITLE:latromi.fieldInstance}}__NOTOC__
−
Fornece propriedades e métodos para manipulação de campos do Formulário Dinâmico.  
+
Fornece propriedades e métodos para manipulação de campos do Formulário Dinâmico.
 +
 
 +
== Sintaxe ==
 +
<syntaxhighlight lang="JavaScript">
 +
latromi.fieldInstance = function() {
 +
  return {
 +
      id: undefined,
 +
      sequence: undefined,
 +
      type: undefined,
 +
      name: undefined,
 +
      clientId: undefined,
 +
      wrapperClientId: undefined,
 +
      labelText: undefined,
 +
      enabled: undefined,
 +
      visible: undefined,
 +
      required: undefined,
 +
      height: undefined,
 +
      tooltip: undefined,
 +
      initialValue: undefined,
 +
      events: undefined,
 +
      // Propriedades estendidas
 +
      // ...
 +
      getValue: function() { },
 +
      setValue: function(value) { } 
 +
  }
 +
}
 +
</syntaxhighlight>
  
 
== Propriedades ==
 
== Propriedades ==
 +
Cada tipo de campo possui um conjunto de propriedades específicas. Clique '''[[DEV:APIs/JavaScript/latromi.fieldInstance/Propriedades Extendidas|aqui]]''' para consultá-las.
 +
 +
Segue abaixo o conjunto de propriedades padrão, disponíveis em todos os tipos de campos:
 +
 
{|class="wikitable apidoctable2"
 
{|class="wikitable apidoctable2"
 
! Nome
 
! Nome
Linha 57: Linha 87:
 
| Obtém <span class="codepart code-boolean">true</span> se o preenchimento do campo for obrigatório. Caso contrário <span class="codepart code-boolean">false</span>.
 
| Obtém <span class="codepart code-boolean">true</span> se o preenchimento do campo for obrigatório. Caso contrário <span class="codepart code-boolean">false</span>.
 
: ''OBS: O valor dessa propriedade é baseado no estado inicial do campo, configurado na propriedade '''Preenchimento Obrigatório'''. Se o estado for alterado via programação, essa propriedade não será atualizada.''
 
: ''OBS: O valor dessa propriedade é baseado no estado inicial do campo, configurado na propriedade '''Preenchimento Obrigatório'''. Se o estado for alterado via programação, essa propriedade não será atualizada.''
 +
|-
 
| height
 
| height
 
| Obtém a altura do campo.
 
| Obtém a altura do campo.
Linha 70: Linha 101:
 
|}
 
|}
  
−
 
+
== Métodos ==
−
== Sintaxe ==
+
{|class="wikitable apidoctable2"
−
<syntaxhighlight lang="JavaScript">
+
! Nome
−
latromi.security.sessionInfo = function () {
+
! Descrição
−
      return {
+
|----------------------------------
−
        userid: undefined,
+
| [[DEV:APIs/JavaScript/latromi.fieldInstance/getValue()|getValue()]]
−
        username: undefined,
+
| Obtém o valor atual do campo.
−
        isadmin: undefined
+
|-
−
      }
+
| [[DEV:APIs/JavaScript/latromi.fieldInstance/setValue(any)|setValue(any)]]
−
}
+
| Atribui valor ao campo.
−
</syntaxhighlight>
+
|}

Edição atual tal como às 20h37min de 9 de julho de 2018

Fornece propriedades e métodos para manipulação de campos do Formulário Dinâmico.

Sintaxe

latromi.fieldInstance = function() {
   return {
      id: undefined,
      sequence: undefined,
      type: undefined,
      name: undefined,
      clientId: undefined,
      wrapperClientId: undefined,
      labelText: undefined,
      enabled: undefined,
      visible: undefined,
      required: undefined,
      height: undefined,
      tooltip: undefined,
      initialValue: undefined,
      events: undefined,
      // Propriedades estendidas
      // ...
      getValue: function() { },
      setValue: function(value) { }   
   }
}

Propriedades

Cada tipo de campo possui um conjunto de propriedades específicas. Clique aqui para consultá-las.

Segue abaixo o conjunto de propriedades padrão, disponíveis em todos os tipos de campos:

Nome Descrição
id Obtém o ID do campo.
sequence Obtém a sequencia (posição) do Campo.
type Obtém um número indicando o tipo do campo:
  1. Numeric Text Box
  2. Text Box
  3. Date/Time Picker
  4. Combo Box
  5. Lookup
  6. Check Box
  7. Radio Button
  8. Color Picker
  9. Label
  10. Upload
  11. HTML Editor
  12. Consulta
  13. Button
  14. Link
  15. TreeView
  16. ImageView
  17. HtmlElement
  18. Gauge
name Obtém o nome do campo.
clientId Obtém o ID do elemento HTML correspondente ao campo.
wrapperClientId Obtém o ID do elemento HTML que envolve o campo.
labelText Obtém o texto da label do campo (descrição)
enabled Obtém true se o campo estiver habilitado. Caso contrário false.
OBS: O valor dessa propriedade é baseado no estado inicial do campo, configurado na propriedade Habilitado. Se o estado for alterado via programação, essa propriedade não será atualizada.
visible Obtém true se o campo estiver visível. Caso contrário false.
OBS: O valor dessa propriedade é baseado no estado inicial do campo, configurado na propriedade Visível. Se o estado for alterado via programação, essa propriedade não será atualizada.
required Obtém true se o preenchimento do campo for obrigatório. Caso contrário false.
OBS: O valor dessa propriedade é baseado no estado inicial do campo, configurado na propriedade Preenchimento Obrigatório. Se o estado for alterado via programação, essa propriedade não será atualizada.
height Obtém a altura do campo.
tooltip Obtém o texto de ToolTip (balão de ajuda) do campo.
initialValue Obtém o valor inicial do campo.
events Lista de eventos disponíveis

Métodos

Nome Descrição
getValue() Obtém o valor atual do campo.
setValue(any) Atribui valor ao campo.
Disponível em "http://docs.latromi.com.br/index.php?title=Desenvolvedor:APIs/JavaScript/latromi.fieldInstance&oldid=1844"