Class: GridField

@nginstack/web-framework/lib/grid/GridField~ GridField


new GridField(name, type, size, size)

Campo de uma definição de visão (x-view ou x-class) do Web Framework.

Parameters:
Name Type Argument Description
name string

Nome único que identificará o campo.

type string

Tipo do campo, observe a propriedade #type para mais detalhes .

size number <nullable>

Tamanho do campo, requerido apenas para campos do tipo "string".

size Number

Tamanho do campo em caracteres. Obrigatório apenas para os tipos "string" e "password".

Extends

  • ViewDefField

Members


beforeValue :Object

Valor anterior do campo.

Type:
  • Object

canModify :boolean

Indica se o campo pode ser modificado. Os seguintes aspectos são levados em consideração:

  • o campo é readOnly ou calculado;
  • é do tipo "file" ou "grid";
  • tem grade ou a grade não pode ser modificada;
  • campo correspondente no DataSet está protegido.
    Caso seja constatado algum dos aspectos acima o campo não poderá ser modificado.
Type:
  • boolean

grid :DetailGrid

Grade detalhe associada ao campo quando este for do tipo "grid".

Type:
  • DetailGrid

value :Object

Valor contido no campo. Não utilize esta propriedade para alterar o valor do campo. Para isso, utilize os métodos setValue ou setValueOnly.

Type:
  • Object
Deprecated:
  • Utilize o método #getValue.
See:
  • Field#setValue
  • Field#getValue
  • Field#setValueOnly

Methods


emit()


focus()

Posiciona o cursor de edição da grade neste campo.


getComboValue(value)

Para campos do tipo combo, determina o índice de uma opção caso seja um combo simples. Para combos múltiplos, este método retorna o valor informado sem nenhum tipo de tratamento.

Este método existe apenas para contornar o comportamento do #setValue do tipo combo dar preferência para tratar o valor informado como o índice do combo em vez do valor da opção. Esse comportamento não ocorre em combos com a propriedade #multiple ativa.

Parameters:
Name Type Description
value *

O valor para o qual se deseja saber o índice.

Returns:

O índice do valor procurado nas opções do combo ou o valor informado caso seja um combo múltiplo.

Type
number | *

getSavedValue(context)

Obtém o último valor informado pelo usuário. Este método requer que a propriedade saveInputAsDefault esteja habilitada.
Será retornado undefined se o último valor for desconhecido ou se saveInputAsDefault for falso.

Parameters:
Name Type Description
context Object

Objeto contendo o que deve ser buscado no DataSet de cache.

See:
  • Field#saveInputAsDefault
Returns:

Último valor informado pelo usuário.

Type
Object

getValue()

Obtém o valor do campo. Campos calculados serão avaliados na execução deste método para obter o valor atualizado.

See:
  • Field#setValue
  • Field#setValueOnly
Returns:

Valor do campo.

Type
*

lookup()

Inclusão da pesquisa de derivação no gerador de relatório. Dispara lookup em field relacionado com registros de uma tabela do sistema.


setValue(value)

Atribui um valor ao campo.
Este método irá disparar os eventos associados à edição.

Parameters:
Name Type Description
value *

Novo valor do campo

See:
  • Field#setValueOnly
  • Field#getValue

setValueOnly(value)

Atribui um valor ao campo.
Este método não dispara os eventos associados à edição.

Parameters:
Name Type Description
value Object

Novo valor do campo

See:
  • Field#setValue

validateInput()

Deprecated:
  • Utilize Field#validateValue