Class Index | File Index

Classes


Class uwi.grid.Grid


Extends ngin.event.Emitter.

Defined in: grid.js.

Class Summary
Constructor Attributes Constructor Name and Description
 
uwi.grid.Grid(parent, name)
Classe que permite a construção e manipulação de uma grade.
Field Summary
Field Attributes Field Name and Description
 
Este array terá os campos na ordem que serão exibidos.
 
Indica se toda vez que for dado um write() na grade, ou seja, caso a grade seja re-escrita, o array da propriedade selectedRecords é limpo, ou seja se deverão ser deletados os bookmarks (marcadores) dos registros que estão selecionados na grade.
 
Indica se toda vez que for dado um write() na grade, ou seja, caso a grade seja re-escrita, o array da propriedade unselectableRecords é limpo, ou seja se deverão ser deletados os bookmarks (marcadores) dos registros que não podem ser selecionados pelo usuário na grade.
 
Determina se a persistência dos dados ocorrerá automaticamente quando os métodos #del e #post forem chamados.
 
Indica se o próximo objeto a ser escrito depois da grade deverá ir para a linha seguinte do gerenciador de layout.
 
Indica se é permitida a exclusão dos registros.
 
Indica se um registro da grade pode ser duplicado.
 
Indica se é permitida a edição dos registros.
 
Indica se é permitida a exportação dos dados da grid.
 
Indica se é permitida a inserção de novos registros.
 
Indica se é permitida a inversão da seleção dos registros.
 
Propriedade de somente leitura.
 
Indica se a grade deve permitir visualização dos logs de alteração.
 
Instância do x-class da classe informada na propriedade classKey.
 
Instância de classDefManager utilizada para construir os x-class utilizados pela grade e pelos campos lookup.
 
Classe do sistema que define o modelo de dados do DataSet controlado pela grade.
 
Determina se a grade será exibida em modo colapse (apenas a barra de título).
 
Permite dispor grades em colunas ao invés da disposição padrão de registros, ou seja, as grades serão exibidas lado-a-lado ao invés de uma abaixo da outra.
 
Indica se a grade deve pedir confirmação para proceder com o cancelamento das alterações feitas.
 
Indica se a grade deve pedir confirmação para postar alterações.
 
Indica se a grade deve pedir confirmação para proceder com a deleção solicitada.
 
Objeto DataExportGrid que é usado para exportação de dados da grade.
 
Indica a classe a ser usada para definir o defineGrid da grade.
 
Indica o nome do defineGrid a ser usado para definir a grid.
 
Indica se a chamada do onAfterScroll será realizada após a sincronia da grade, devido à troca de página.
 
ds
DataSet ao qual a grade está associada.
 
 
Array com os nomes ou as instâncias dos botões que devem estar habilitados na grade.
 
fDs
 
Lista que contém as definições dos campos da grade.
 
Contém os nomes dos campos que deverão compor o modo formView (modo formulário).
 
Coleção de agrupamentos da grade.
 
Determina se a grade poderá ser vista no modo formulário.
 
Determina se a grade poderá ser vista no modo tabela.
 
Utilizada para especificar a ajuda da grade.
 
Lista que contém os nomes dos campos da grade que devem ter o conteúdo exibido através de um hint para toda célula da grade.
 
Número máximo de registros que serão mostrados no modo tableView (modo tabela).
 
Indica a quantidade máxima de registros que podem ser selecionados na grade.
<static>  
uwi.grid.Grid.MDA_DELETE
Indica que os registros detalhes devem ser excluídos.
<static>  
uwi.grid.Grid.MDA_ERROR
Indica que deve ser gerado um erro caso haja registros detalhes no momento da exclusão do registro mestre.
<static>  
uwi.grid.Grid.MDA_UNLINK
Indica que os campos que vinculam os registros detalhes, ngin.classdef.Field#detailFieldNames, devem ser preenchidos com null.
 
Evento que será executado após cancelar a inserção ou edição de um registro, fazendo com que qualquer alteração realizada até o momento no registro seja desfeita e com que a grade retorne ao estado de navegação.
 
Evento que será executado após um registro ser excluído da grade, ou seja após ser excluído do dataSet da grade.
 
Evento que será executado após um registro ser duplicado.
 
Evento que será executado após um registro entrar em edição.
 
Evento que será executado após um registro ser expandido pelo usuário.
 
Evento que será executado após ser inserido um novo registro na grade, ou seja, após o registro ser incluso no dataSet da grade e antes que ele entre em edição.
 
Evento que será executado após ser realizada a inserção ou edição um registro.
 
Evento executado pós a preparação da grade O evento recebe os seguintes parâmetros:
- grid: grade que está sendo preparada.
 
Evento que será disparado após a navegação de um registro para um outro em uma grade associada a um DataSet.
 
Evento que será disparado após um ou mais registros serem selecionados.
 
Evento que será executado antes de cancelar a inserção ou edição de um registro, fazendo com que qualquer alteração realizada até o momento no registro seja desfeita e com que a grade retorne ao estado de navegação.
 
Evento que será executado antes que um registro seja excluído da grade, ou seja antes que seja excluído do dataSet da grade.
 
Evento que será executado antes que um registro seja duplicado.
 
Evento que será executado antes que um registro entre em edição.
 
Evento executado antes de um registro ser expandido pelo usuário.
 
Evento que será executado antes que um novo registro seja inserido na grade, ou seja, antes que o registro seja incluído no dataSet da grade.
 
Evento que será executado antes de realizar a inserção ou edição um registro, permitindo por exemplo que os novos dados no registro possam ser avaliados antes de serem atualizados ou incluídos.
 
Evento executado antes da preparação da grade O evento recebe os seguintes parâmetros:
- grid: grade que está sendo preparada.
 
Evento que será disparado antes da navegação de um registro para um outro em uma grade associada a um DataSet.
 
Evento que será disparado antes de um registro ser selecionado ou desmarcado.
 
Evento que será emitido quando for alterado o modo de visão da grade.
 
Evento que deve ser utilizado para configurar os campos de uma grade.
 
Evento que será executado quando o botão de exportar da grade for acionado.
 
Evento que será executado quando a grade for localizar algum conteúdo.
 
A grade possui o botão de log que ao ser acionado exibe o histórico de alterações do registro corrente.
 
Objeto que contém visualmente a grade.
 
Referência ao processo onde a grade foi criada.
 
Indica se a grade será somente para leitura, não permitindo assim que o usuário faça alterações nos seus valores.
 
Array com os bookmarks (marcadores) dos registros que estão selecionados na grade.
 
 
Contém os nomes dos campos que irão compor o modo tableView (modo tabela).
 
Título atribuído à grade.
 
Campos visualizáveis.
 
Indica se o botão Toggle Key ("Mostrar/Ocultar chaves") está habilitado na grade.
 
Configurações da barra de ferramentas da grid.
 
Array com os bookmarks (marcadores) dos registros que não poderão ser selecionados pelo usuário.
 
Indica se o usuário pode exportar dados da grade.
 
Chave do usuário que será utilizada para validar o acesso de inserção, alteração e exclusão dos dados da grade.
 
Indica se a grade deve validar se o usuário possui permissão de visão e alteração dos campos.
 
Propriedade que indica o modo de visão da grade.
 
 
Nomes ou as instâncias dos botões que devem estar visíveis na grade.
 
Indica o tamanho que a grade assumirá na tela.
Fields borrowed from class ngin.event.Emitter:
duplicationHandling, listenerCompareFunction
Method Summary
Method Attributes Method Name and Description
 
action(name, target, order, processKey, newTab)
 
adaptEvent_(name, descriptor)
Cria um adaptador da API de eventos antiga (classe global Event) com a nova API ngin.event.Emitter.
 
button(name, opt_target, opt_order, opt_processKey, opt_newTab)
Cria um botão na grade se não existir um com o nome informado.
 
Limpa os botões da grade.
 
colapse(nodeValue)
Minimiza o nó solicitado na árvore.
 
declareGetterAndSetter_(fieldName, gridName)
Constrói um método getter and setter no processo para acessar o valor do campo informado.
 
del(handleDetailGrid)
Exclui da grade e consequentemente do dataSet o(s) registro(s) selecionado(s) na grade.
 
duplicateRecord(opt_bookmark)
Duplica um registro da grade.
 
emit(event)
 
expand(nodeValue)
Expande o nó solicitado na árvore.
 
field(name, opt_type, opt_size)
Método utilizado para criar ou acessar um campo na grade.
 
formatEventId(eventType, opt_field)
Cria uma identificação para o evento para fins de log.
 
Mantém compatibilidade para quem precisa acessar a lista de fields como um objeto lista de Strings.
 
getFieldsByProperty(propertyName)
Retorna uma lista de campos cuja propriedades tenham os valores informados.
 
Devolve a ajuda formatada grade.
 
Retorna o campo que contém a chave dos registros, ou nulo caso não o encontre.
 
Obtém o campo que disparou a exibição da grade, caso ela seja a grade de Lookup.
 
getSelectedRecords(opt_viewMode)
Retorna os registros selecionados da visão da grade informada no parâmetro.
 
Trata uma solicitação de sincronismo da grade cliente.
 
locateField(fieldName)
Retorna o objeto Field associado ao nome
 
lookup(field)
Dispara grade lookup em campos da grade que estejam relacionados com registros de uma tabela.
 
newEvent_(type, opt_options)
Cria um novo evento uwi.grid.Grid
 
Realiza persistência para DataSets da grade e de suas filhas.
<static>  
uwi.grid.Grid.persist(grids)
Realiza persistência para DataSets de um conjunto de grades e das suas filhas.
 
post(opt_doParentPost)
Efetiva as alteração o registo corrente esteja em estado de edição ou inserção.
 
TODO: verificar porque o prepare nunca está sendo chamado para uma grid de variáveis
 
refresh(opt_force)
Reinicia a estrutura da grade tanto no servidor quanto no cliente.
 
Redefine os valores de todos os campos do registro que esteja em foco na grade.
 
scroll(action)
Executa um método de navegação do dataset ('first', 'next', 'prior' ou 'last') ou função passada como parâmetro, disparando os eventos de scroll da grade e atualizando os filtros das grades detalhes.
 
setDs(value)
 
Este método cria ou seta as propriedades informadas com os valores informados em cada campo da definido nos parametros.
 
sync_(formSync, tableSync)
Obtém os comandos que devem ser executados dentro do contexto da grade no cliente.
 
tabSyncBufferUpdate(dsSync, records, i, isCurrentRecord)
 
Alterna a visibilidade de um campo da grade nos dois modos de visão.
 
Alterna a visibilidade do campo CHAVE ou iKey, caso o campo esteja presente.
 
write(opt_showInFormView, opt_noWriteInClient)
Método utilizado para escrever a grade na tela após serem configurados os eventos e os seus campos.
Methods borrowed from class ngin.event.Emitter:
addListenersFromEmitter, assignListeners, filterListeners, hasListeners, listenerHandlers, listeners, off, offAll, on, registerEventType, replaceListeners, unregisterEventType
Class Detail
uwi.grid.Grid(parent, name)
Classe que permite a construção e manipulação de uma grade.
Atenção: este construtor é de uso interno do WebFramework. Uma grade deve ser construída através dos métodos Process.grid() ou definindo um campo de grade do tipo "grid".
Parameters:
{Object} parent
Objeto que irá conter a grade criada. Atualmente, somente são suportados objetos das classes Process ou Field.
{string} name
Nome único dentro de um processo que irá identificar a grade.
See:
Process#grid
uwi.grid.Grid#field
Field Detail
{Array} arFields
Este array terá os campos na ordem que serão exibidos. É a lista de campos obtidas através da definição da classe ou do DataSet associado à grid.
See:
Grid#ds
DataSet

{Boolean} automaticClearSelectedRecords
Indica se toda vez que for dado um write() na grade, ou seja, caso a grade seja re-escrita, o array da propriedade selectedRecords é limpo, ou seja se deverão ser deletados os bookmarks (marcadores) dos registros que estão selecionados na grade.
O valor padrão é: false.

{Boolean} automaticClearUnselectableRecords
Indica se toda vez que for dado um write() na grade, ou seja, caso a grade seja re-escrita, o array da propriedade unselectableRecords é limpo, ou seja se deverão ser deletados os bookmarks (marcadores) dos registros que não podem ser selecionados pelo usuário na grade.
O valor padrão é: false.

autoPersist
Determina se a persistência dos dados ocorrerá automaticamente quando os métodos #del e #post forem chamados.

{Boolean} breakLine
Indica se o próximo objeto a ser escrito depois da grade deverá ir para a linha seguinte do gerenciador de layout.

canDelete
Indica se é permitida a exclusão dos registros. Os possíveis valores são:
- uwi.grid.Grid.USER_PERMISSION - As permissões do usuário serão verificadas para decidir se ele pode ou não excluir.
- uwi.grid.Grid.NEVER - A operação nunca é permitida.
- uwi.grid.Grid.ALWAYS - A operação sempre é permitida.
O valor padrão é uwi.grid.Grid.USER_PERMISSION.

canDuplicate
Indica se um registro da grade pode ser duplicado.
Default Value:
true

canEdit
Indica se é permitida a edição dos registros. Os possíveis valores são:
- uwi.grid.Grid.USER_PERMISSION - As permissões do usuário serão verificadas para decidir se ele pode ou não editar.
- uwi.grid.Grid.NEVER - A operação nunca é permitida.
- uwi.grid.Grid.ALWAYS - A operação sempre é permitida.
O valor padrão é uwi.grid.Grid.USER_PERMISSION.

canExport
Indica se é permitida a exportação dos dados da grid. Os possíveis valores são:
- uwi.grid.Grid.USER_PERMISSION - As permissões do usuário serão verificadas para decidir se ele pode ou não exportar os dados.
- uwi.grid.Grid.NEVER - A operação nunca é permitida.
- uwi.grid.Grid.ALWAYS - A operação sempre é permitida.
O valor padrão é uwi.grid.Grid.USER_PERMISSION.

canInsert
Indica se é permitida a inserção de novos registros. Os possíveis valores são:
- uwi.grid.Grid.USER_PERMISSION - As permissões do usuário serão verificadas para decidir se ele pode ou não inserir.
- uwi.grid.Grid.NEVER - A operação nunca é permitida.
- uwi.grid.Grid.ALWAYS - A operação sempre é permitida.
O valor padrão é uwi.grid.Grid.USER_PERMISSION.

{Boolean} canInvertSelection
Indica se é permitida a inversão da seleção dos registros.
Atenção: Não é possível fazer a inversão da seleção dos registros caso a grade esteja em edição.
O valor padrão é: true.

{Boolean} canModify
Propriedade de somente leitura. Seu valor não pode ser alterado.
Indica se a grade pode ser modificada, levando em conta as seguintes considerações:
- ela é uma grade filha e a grade mãe é somente leitura;
- ela é uma grade filha e o campo que a define é somente leitura;
- usuário não tem permissão de alteração.
Caso seja constatado um dos casos anteriores então a grade não poderá ser modificada.

{Boolean} canShowLog
Indica se a grade deve permitir visualização dos logs de alteração.
Se true, então a visualização dos logs será permitida de acordo com as permissões do usuário. Se false, então a visualização dos logs será desabilitada independentemente das permissões do usuário. O valor padrão é: true.

classDefinition
Instância do x-class da classe informada na propriedade classKey.

classDefManager
Instância de classDefManager utilizada para construir os x-class utilizados pela grade e pelos campos lookup. Por padrão é utilizada a instância global retornada pelo método ngin.classdef.Manager.getInstance();

classKey
Classe do sistema que define o modelo de dados do DataSet controlado pela grade. As definições dos campos e eventos existentes no x-class da classe informada serão copiados para esta grade.
Também serão executados os defineGrid associados ao nome desta grade.
Estas definições com base no x-class serão executadas antes do evento onDefineGrid(), portanto, caso sejam realizadas outras definições neste evento, estas sobrescreverão as definidas no x-class.

{Boolean} colapsed
Determina se a grade será exibida em modo colapse (apenas a barra de título).

column
Permite dispor grades em colunas ao invés da disposição padrão de registros, ou seja, as grades serão exibidas lado-a-lado ao invés de uma abaixo da outra. Pode-se também definir em que ordem elas irão aparecer ao setar o valor da propriedade.
   this.grid1.column = 0
   this.grid2.column = 1

   this.grid1.write()
   this.grid2.write()

   // As grades acima serão exibidas lado-a-lado
   // ----------   ----------
   // |  grid1 |   |  grid2 |
   // ----------   ----------

{Boolean} confirmCancel
Indica se a grade deve pedir confirmação para proceder com o cancelamento das alterações feitas.
Se true, então será exibida uma caixa de diálogo ao usuário para que ele confirme o cancelamento.
O valor padrão é: true.

{Boolean} confirmChange
Indica se a grade deve pedir confirmação para postar alterações.
Se true, então será exibida uma caixa de diálogo ao usuário para que ele confirme a alteração.
O valor padrão é: false.

{Boolean} confirmDelete
Indica se a grade deve pedir confirmação para proceder com a deleção solicitada.
Se true, então será exibida uma caixa de diálogo ao usuário para que ele confirme a deleção.
O valor padrão é: true.

dataExporter
Objeto DataExportGrid que é usado para exportação de dados da grade.

definitionClass
Indica a classe a ser usada para definir o defineGrid da grade.

definitionName
Indica o nome do defineGrid a ser usado para definir a grid.

delayedOnAfterScrollEventCall_
Indica se a chamada do onAfterScroll será realizada após a sincronia da grade, devido à troca de página.

ds
DataSet ao qual a grade está associada.

enabledActions
Deprecated:
Utilize a propriedade enabledButtons.
See:
uwi.grid.Grid#enabledButtons

{Array} enabledButtons
Array com os nomes ou as instâncias dos botões que devem estar habilitados na grade.
See:
uwi.grid.Grid#visibleButtons

fDs

{ngin.classdef.FieldList} fields
Lista que contém as definições dos campos da grade.
Deverá haver uma instância da classe Field para cada campo.

formViewFieldNames
Contém os nomes dos campos que deverão compor o modo formView (modo formulário).
Os nomes devem estar separados por ponto-e-vírgula (";"). Caso esta propriedade não seja definida então todos os campos serão exibidos de acordo com as respectivas propriedades de visão.
grid.formViewFieldNames = "nome; endereço; idade"

{FieldGroups} groups
Coleção de agrupamentos da grade.

{Boolean} hasFormView
Determina se a grade poderá ser vista no modo formulário.
Se o valor for setado para falso, a propriedade viewMode da grade será setada para uwi.grid.Grid.TABLEVIEW.

hasTableView
Determina se a grade poderá ser vista no modo tabela.
Se o valor for setado para falso, a propriedade viewMode da grade será setada para uwi.grid.Grid.FORMVIEW. Independente do valor informado, grades de variáveis nunca tem modelo tabela e sempre retornam false.

help
Utilizada para especificar a ajuda da grade.

hintFieldNames
Lista que contém os nomes dos campos da grade que devem ter o conteúdo exibido através de um hint para toda célula da grade.
O hint é uma janela de ajuda exibida quando o mouse permanece um tempo parado sobre uma célula.

maxRecordCount
Número máximo de registros que serão mostrados no modo tableView (modo tabela).
O valor padrão é: 10.

maxSelectedRecords
Indica a quantidade máxima de registros que podem ser selecionados na grade.
Por padrão não há limite para os registros que podem ser selecionados.

<static> uwi.grid.Grid.MDA_DELETE
Indica que os registros detalhes devem ser excluídos.
Deprecated:
Utilize ngin.classdef.MasterDeleteAction.DELETE.

<static> uwi.grid.Grid.MDA_ERROR
Indica que deve ser gerado um erro caso haja registros detalhes no momento da exclusão do registro mestre.
Deprecated:
Utilize ngin.classdef.MasterDeleteAction.ERROR.

<static> uwi.grid.Grid.MDA_UNLINK
Indica que os campos que vinculam os registros detalhes, ngin.classdef.Field#detailFieldNames, devem ser preenchidos com null.
Deprecated:
Utilize ngin.classdef.MasterDeleteAction.UNLINK.

onAfterCancel
Evento que será executado após cancelar a inserção ou edição de um registro, fazendo com que qualquer alteração realizada até o momento no registro seja desfeita e com que a grade retorne ao estado de navegação.
No exemplo abaixo modifica-se o modo de visão da grade para o modo tabela, caso a grade não esteja neste modo, e também é exibido um alerta de que a edição/inserção do registro foi cancelada.
O evento recebe os seguintes parâmetros:
- grid: grade a qual pertence o registro cuja edição/inserção foi cancelada;
grid.onAfterCancel.set( function ( grid ){
   if (grid.viewMode == uwi.grid.Grid.FORMVIEW ){
    grid.viewMode = uwi.grid.Grid.TABLEVIEW
   }
   grid.process.alert( "Edição/Inserção cancelada!" )
})
Deprecated:
Utilize on('afterCancel', listener).

onAfterDelete
Evento que será executado após um registro ser excluído da grade, ou seja após ser excluído do dataSet da grade.
No exemplo abaixo após o registro ser excluído é informada uma mensagem confirmando a exclusão e é realizado um refresh na estrutura da grade. O evento recebe os seguintes parâmetros:
- grid: grade em que o registro foi excluído;
onAfterDelete.set( function ( grid ) {
   grid.process.alert( 'Exclusões Efetuadas com Sucesso!' )
})
Deprecated:
Utilize on('afterDelete', listener).

onAfterDuplicate
Evento que será executado após um registro ser duplicado. O evento recebe os seguintes parâmetros:
- grid: grade que possui o registro que foi duplicado;
grid.onAfterDuplicate.set( function (grid) {
   this.alert('Registro duplicado.');
})
Deprecated:
Utilize on('afterDuplicate', listener).

onAfterEdit
Evento que será executado após um registro entrar em edição. O registro entra em edição ao ser chamado o método grid.edit, que pode ser chamado diretamente pelo programador ou automaticamente quando se altera o valor de um campo;
O exemplo abaixo pega o último horário em que o registro entrou em edição e salva este valor em um campo somente leitura da grade, ficando assim registrado o horário da última edição no registro.
O evento recebe os seguintes parâmetros:
- grid: grade que entrou em edição;
grid.onAfterEdit.set( function ( grid ){
   var hoje = new Date
   grid.dataedicao.setValueOnly( hoje.toString( "DD/MM/YYYY" ) + " "
   + hoje.getHours() + ":" + hoje.getMinutes() + ":" + hoje.getSeconds() )
})
Deprecated:
Utilize on('afterEdit', listener).

onAfterExpand
Evento que será executado após um registro ser expandido pelo usuário.
Utilizado apenas pela TreeGrid.
O evento receberá os seguintes parâmetros:
- grid: grade que possui o registro que foi expandido;
- childValue: valor do campo, exibido na árvore, que foi expandido;
- tree: instância da classe Tree que contém a estrutura de nós da árvore de navegação.
Deprecated:
Utilize on('afterExpand', listener).

onAfterInsert
Evento que será executado após ser inserido um novo registro na grade, ou seja, após o registro ser incluso no dataSet da grade e antes que ele entre em edição.
O exemplo abaixo modifica o modo de visão da grade para o modo de formulário caso a grade não esteja neste modo e exibe uma mensagem alertando que o registro foi incluído no dataSet.
O evento recebe os seguintes parâmetros:
- grid: grade em que o registro foi inserido;
grid.onAfterInsert.set( function ( grid ){
   if (grid.viewMode == uwi.grid.Grid.TABLEVIEW ){
    grid.viewMode = uwi.grid.Grid.FORMVIEW
   }
   grid.parent.alert("Registro inserido com sucesso!")
})
Deprecated:
Utilize on('afterInsert', listener).

onAfterPost
Evento que será executado após ser realizada a inserção ou edição um registro. Pode-se definir através deste método uma função a ser executada após o registro ser incluído ou atualizado no dataSet da grade. Pode-se utilizar este evento para criar um log do horário que o registro foi criado ou modificado, ou ainda notificar ao usuário a quantidade de registros que ainda podem ser inseridos no dataSet da grade, como demonstrado no exemplo a seguir.
O evento recebe os seguintes parâmetros:
- grid: grade em que foi inserir o registro;
grid.onAfterPost.set( function ( grid ){
   if (grid.ds.recordCount < 5 ){
    grid.parent.alert( "Atenção: Ainda poderão ser adicionados " +
             ( maxRecordNumber - grid.ds.recordCount ) +
              " registros" )
   } else {
    grid.parent.alert( "Atenção! Não poderão mais adicionar registros:
             Número máximo de registros atingido!" )
   }
})
Deprecated:
Utilize on('afterPost', listener).

onAfterPrepare
Evento executado pós a preparação da grade O evento recebe os seguintes parâmetros:
- grid: grade que está sendo preparada.
grid.onAfterPrepare.set(function (grid) {
})

onAfterScroll
Evento que será disparado após a navegação de um registro para um outro em uma grade associada a um DataSet. Também será disparado logo após a grade ser escrita quando se posicionar no primeiro registro da grade.
O evento recebe os seguintes parâmetros:
- grid: grade em que se deve aplicar o evento.
grid.onAfterScroll.set( function ( grid ){
 })
Deprecated:
Utilize on('afterScroll', listener).

onAfterSelectRecord
Evento que será disparado após um ou mais registros serem selecionados.
Neste evento, é possível manipular a seleção retornando um bookmark ou array de bookmarks. O evento deverá retornar ou um bookmark ou um array de bookmarks que representarão os registros selecionados.

onBeforeCancel
Evento que será executado antes de cancelar a inserção ou edição de um registro, fazendo com que qualquer alteração realizada até o momento no registro seja desfeita e com que a grade retorne ao estado de navegação.
No exemplo abaixo é exibido um alerta de que o a inserção/edição do registro está sendo cancelada e que a grade irá retornar para o modo de tabela.
O evento recebe os seguintes parâmetros:
- grid: grade em que foi cancelada a inserção/edição do registro;
grid.onBeforeCancel.set( function ( grid ){
   grid.process.alert( "Atenção! Cancelando a edição,
             todas as informações serão perdidas!" )
   grid.process.alert( "Grade retornando para o modo
             de visão em tabela..." )
   if (grid.viewMode == uwi.grid.Grid.FORMVIEW ){
    grid.viewMode = uwi.grid.Grid.TABLEVIEW
   }
})
Deprecated:
Utilize on('beforeCancel', listener).

onBeforeDelete
Evento que será executado antes que um registro seja excluído da grade, ou seja antes que seja excluído do dataSet da grade.
A grade possui o método Grid.canDelete que determina se é possível ou não deletar registros na grade ou se será de acordo com as permissões do usuário logado.
Podemos utilizar o evento onBeforeDelete para solicitar um login e senha de algum usuário cadastrado no sistema para que possa ser validada a deleção do registro, conforme exemplo abaixo, que além de fazer a verificação, bloqueia a grid para deleção de registros caso esta verificação falhe.
O evento recebe os seguintes parâmetros:
- grid: grade em que está o registro a ser excluído;
grid.onBeforeDelete.set( function ( grid ){
   if (grid.parent.authenticateUser( "Insira as informações de login" ) == -1 ){
    grid.canDelete = uwi.grid.Grid.NEVER
    throw new Error( "Nome de Usuário ou senha incorretos!
             Não pode deletar! Registro bloqueado para deleção!" )
   }
})
Deprecated:
Utilize on('beforeDelete', listener).

onBeforeDuplicate
Evento que será executado antes que um registro seja duplicado. O evento recebe os seguintes parâmetros:
- grid: grade que possui o registro que será duplicado;
grid.onBeforeDuplicate.set( function (grid) {
   this.alert('Duplicando registro em ' + grid.name + '.');
})
Deprecated:
Utilize on('beforeDuplicate', listener).

onBeforeEdit
Evento que será executado antes que um registro entre em edição. O registro entra em edição ao ser chamado o método grid.edit, que pode ser chamado diretamente pelo programador ou automaticamente quando é alterado o valor de um campo;
O exemplo abaixo solicita as informações de login (nome de usuário e senha) para validar se o registro pode ou não ser alterado. Caso não possa validar será exibida uma mensagem de erro e a grade não entra em edição.
O evento recebe os seguintes parâmetros:
- grid: grade que irá entrar em edição;
grid.onBeforeEdit.set( function ( grid ){
   var result = grid.parent.authenticateUser( "Insira as informações de login" )
   if (result == -1 || result == null){
    throw new Error( "Nome de Usuário ou senha incorretos! Não pode editar!" )
   }
})
Deprecated:
Utilize on('beforeEdit', listener).

onBeforeExpand
Evento executado antes de um registro ser expandido pelo usuário.
Utilizado apenas pela TreeGrid.
O evento receberá os seguintes parâmetros:
- grid: grade que possui o registro que foi expandido;
- childValue: valor do campo, exibido na árvore, que foi expandido;
- tree: instância da classe Tree que contém a estrutura de nós da árvore de navegação.
Deprecated:
Utilize on('beforeExpand', listener).

onBeforeInsert
Evento que será executado antes que um novo registro seja inserido na grade, ou seja, antes que o registro seja incluído no dataSet da grade.
Pode ser usado para controlar a quantidade de registros que serão inseridos no dataSet da grade conforme o exemplo abaixo que limita a quantidade de registros inseridos no dataSet à 5 e exibe um erro caso se tente inserir mais que a quantidade máxima de registros permitida.
O evento recebe os seguintes parâmetros:
- grid: grade em que irá inserir o registro;
grid.onBeforeInsert.set( function ( grid ){
   if (grid.ds.recordCount >= 5 ){
    throw new Error ( "Número máximo de registros atingido!" )
   }
})
Deprecated:
Utilize on('beforeInsert', listener).

onBeforePost
Evento que será executado antes de realizar a inserção ou edição um registro, permitindo por exemplo que os novos dados no registro possam ser avaliados antes de serem atualizados ou incluídos.
O exemplo abaixo verifica se os valores nos campos "password" e "confirmPassword" são iguais, ou seja, se o usuário digitou uma senha e a confirmou corretamente, em caso negativo exibe um erro, impedindo que o registro seja inserido.
O evento recebe os seguintes parâmetros:
- grid: grade em que irá inserir o registro;
grid.onBeforePost.set( function ( grid ) {
   if (grid.ds.password != grid.ds.confirmPassword ){
    throw new Error( "A nova senha e a confirmação são diferentes.
             Digite novamente a senha." )
   }
})
Deprecated:
Utilize on('beforePost', listener).

onBeforePrepare
Evento executado antes da preparação da grade O evento recebe os seguintes parâmetros:
- grid: grade que está sendo preparada.
grid.onBeforePrepare.set(function (grid) {
})

onBeforeScroll
Evento que será disparado antes da navegação de um registro para um outro em uma grade associada a um DataSet. Também será disparado assim que a grade for escrita quando se posicionar no primeiro registro da grade.
No exemplo abaixo é dado um alerta informando o número do registro em que se estava posicionado, caso a grade não esteja vazia.
O evento recebe os seguintes parâmetros:
- grid: grade em que se deve aplicar o evento.
grid.onBeforeScroll.set( function ( grid ){
   if (grid.ds.recNo > 0 ){
    grid.process.alert( "Você estava no registro: " + grid.ds.recNo )
   }
})
Deprecated:
Utilize on('beforeScroll', listener).

onBeforeSelectRecord
Evento que será disparado antes de um registro ser selecionado ou desmarcado.

onChangeView
Evento que será emitido quando for alterado o modo de visão da grade.
A grade poderá ter seu modo de visão alterado a partir da propriedade viewMode que irá emitir este evento, ao chamar esse evento a propriedade viewMode estará com seu valor anterior à mudança de visão.
A grade também pode ter seu modo de visão alterado quando for chamado o grid.write() que possui um parâmetro que determina em que modo será escrita a grade.
No exemplo abaixo quando o modo de visão da grade é alterado são alterados também os botões visíveis pois algumas delas não fazem sentido em um ou outro modo de visão. Como a modificação deve ser do modo formulário para tabela e vice-versa, é utilizado uma expressão condicional para analisar o valor do viewMode.
O evento recebe os seguintes parâmetros:
- grid: grade a qual está sendo modificado o modo de visão;
grid.onChangeView.set( function ( grid ){
   if (grid.viewMode === uwi.grid.Grid.TABLEVIEW ){
   grid.parent.visibleButtons = ['Recarregar grades'];
  } else {
   grid.parent.visibleButtons = ['Editar', 'Recarregar grades'];
  }
})
Deprecated:
Utilize on('changeView', listener).

onDefineFields
Evento que deve ser utilizado para configurar os campos de uma grade. Todas as definições de campo devem ser declaradas através deste evento.
Customizações fora deste evento serão perdidas caso sejam alteradas as propriedades "classKey" ou "ds" da grade, ou seja, após ser executado o método Grid.refresh().
O evento recebe os seguintes parâmetros:
- grid: grade em que serão definidos os campos.
grid2.onDefineFields.set( function ( grid2 ){
   var fld = grid2.field( "matricula", "integer" )
   fld.size = 6
   fld.readOnly = true
   fld.label = "Número de matrícula"
   fld.help = "Número da matrícula do aluno"

   var fld = grid2.field( "disciplina", "String", 10 )
   fld.size = 6
   fld.readOnly = true
   fld.label = "Disciplina"
   fld.help = "Código das disciplinas cadastradas para esse aluno"
})

onExport
Evento que será executado quando o botão de exportar da grade for acionado. Ele substitui o comportamento padrão da grade.
O exemplo abaixo seleciona o campo "teste" do dataExporter e modifica seu label para "Testing". O evento recebe os seguintes parâmetros:
- dataExport: Objeto DataExportGrid que é usado para exportação de dados da grade;
 grid.onExport.set(function ( dataExport ) {
   dataExport.getField("teste").label = "Testing"
 });
Deprecated:
Utilize on('export', listener).

onLocate
Evento que será executado quando a grade for localizar algum conteúdo. A grade automaticamente adiciona um evento de pesquisa padrão que pode ser estendido.
O exemplo abaixo personaliza a busca para permitir que sejam buscados apenas números e executa o evento padrão através do "inherited".
O evento deverá retornar um valor booleano, sendo true para indicar que localizou o registro. O dataSet da grid deve ser posicionado no registro localizado. O evento recebe os seguintes parâmetros:
- grid: Grade que está sendo pesquisada;
- value: Valor a ser localizado;
- options: Array que contém as opções a serem aplicadas na localização, podem ser: (opcional)
Grid.LOCATE_ALL_FIELDS: Opção que indica se deverá localizar em todos os campos;
Grid.LOCATE_EXACT: Opção que indica se deverá localizar um valor idêntico;
Grid.LOCATE_NEXT: Opção que indica se deverá localizar da próxima ocorrência;
grid.onLocate.set( function ( grid, value ) {
    if (typeof value == 'number') {
    var found = inherited( grid, value )
     if (found ) {
        grid.process.setNextInteraction('interactionName')
     }
    return found
   } else {
    throw new Error('Não é possível localizar valores diferentes de números!')
   }
})
Deprecated:
Utilize on('locate', listener).

onShowLog
A grade possui o botão de log que ao ser acionado exibe o histórico de alterações do registro corrente. Este evento será executado quando o botão de log da grade for acionado. Ele substitui o comportamento padrão da grade.
O exemplo abaixo chama a Intereção "run" e passa como parâmetros ['chave', key].
O evento recebe os seguintes parâmetros:
- grid: grade em que foi acionado o botão de log;
grid.onShowLog = function ( grid ) {
   var key = grid.ds.ikey
    grid.process.setNextInteraction('run', ['chave', key], -1898143458)
   }
})
Deprecated:
Utilize on('showLog', listener).

parent
Objeto que contém visualmente a grade. Atualmente a grade pode ser criada apenas pelo Process.grid ou definindo um campo do tipo "grid", logo este objeto poderá ser apenas Process ou Field.

process
Referência ao processo onde a grade foi criada. Atualmente a grade pode ser criada apenas pelo Process.grid ou definindo um campo do tipo "grid".

{Boolean} readOnly
Indica se a grade será somente para leitura, não permitindo assim que o usuário faça alterações nos seus valores.

{Array} selectedRecords
Array com os bookmarks (marcadores) dos registros que estão selecionados na grade.

tableViewBuffer

tableViewFieldNames
Contém os nomes dos campos que irão compor o modo tableView (modo tabela).
Os nomes devem estar separado por ponto-e-vírgula (";"). Caso esta propriedade não seja definida então todos os campos serão exibidos de acordo com as respectivas propriedades de visão.
 grid.tableViewFieldNames = "nome; idade; cpf"

title
Título atribuído à grade. Caso não seja definido, então será utilizado o valor contido no parâmetro "name" definido durante a criação da grade.
See:
Process#grid

toggledViewFieldsVisibility_
Campos visualizáveis.

toggleKeyButtonEnabled
Indica se o botão Toggle Key ("Mostrar/Ocultar chaves") está habilitado na grade.
Default Value:
true

toolbar
Configurações da barra de ferramentas da grid.
A barra de ferramentas possui controles de navegação, busca, exportação, duplicação e outros botões criados pelo usuário.
Propriedades disponíveis:
- visible: indica se a barra de ferramentas será exibida.
this.grid('test').toolbar.visible = false; // torna a barra invisível

{Array} unselectableRecords
Array com os bookmarks (marcadores) dos registros que não poderão ser selecionados pelo usuário.

userCanExport
Indica se o usuário pode exportar dados da grade.

userKeyToValidatePermissions
Chave do usuário que será utilizada para validar o acesso de inserção, alteração e exclusão dos dados da grade. Caso não seja informado, será considerado session.userKey, que seria a chave do usuário que estiver logado no sistema.

validateFieldPermissions
Indica se a grade deve validar se o usuário possui permissão de visão e alteração dos campos. Estas permissões são obtidas da tabela iPermission, a partir dos campos iVisibleFieldNames e iChangeableFieldNames.

viewMode
Propriedade que indica o modo de visão da grade. A alteração desta propriedade implica na alteração do modo de visão da grade no navegador.
Por padrão a grade é escrita no modo TABLEVIEW (modo tabela) exceto quando no grid.write() for especificado que deverá ser escrita em modo FORMVIEW (modo formulário).
O exemplo a seguir modifica o modo de visão da grade do modo tabela para o modo formulário.
Pode assumir os seguintes valores:
- uwi.grid.Grid.FORMVIEW: modo formulário.
- uwi.grid.Grid.TABLEVIEW: modo tabela.
if (grid.viewMode === uwi.grid.Grid.TABLEVIEW ){
    grid.viewMode = uwi.grid.Grid.FORMVIEW
 }

visibleActions
Deprecated:
Utilize a propriedade visibleButtons.
See:
uwi.grid.Grid#visibleButtons

{Array} visibleButtons
Nomes ou as instâncias dos botões que devem estar visíveis na grade. A ordem dos botões será alterada para refletir a ordem informada nesta propriedade.
See:
uwi.grid.Grid#enabledButtons

width
Indica o tamanho que a grade assumirá na tela. Por padrão, a grade se auto redimensionará conforme o seu conteúdo, mas é possível indicar um valor fixo que esta deverá assumir.
Atenção:
- O valor não poderá ser menor que o tamanho mínimo de todos os campos da grade, caso contrário esta irá ter um comportamento estranho.
- O valor informado estará em pixels.
grid.width = "100" // grade terá 100 pixels
grid.width = 1000 // grade terá 1000 pixels
Method Detail
action(name, target, order, processKey, newTab)
Parameters:
name
target
order
processKey
newTab
Deprecated:
Utilize o método button.
See:
uwi.grid.Grid#button

adaptEvent_(name, descriptor)
Cria um adaptador da API de eventos antiga (classe global Event) com a nova API ngin.event.Emitter. Esse adaptador terá os mesmos métodos de Event, mas os eventos registrados por eles serão adicionados como listeners dos eventos da grade por meio método on.
Parameters:
{string} name
Nome do evento.
{ngin.event.AdapterDescriptor|Object} descriptor
Regras de como deve ser feita a adaptação do evento.

{uwi.button.Button} button(name, opt_target, opt_order, opt_processKey, opt_newTab)
Cria um botão na grade se não existir um com o nome informado. Caso exista, será retornada a instância criada anteriormente.
 grid.button("Tornar maiúsculas", function (bt){
   var grid = bt.parent
   var ds = grid.ds
   var selectedRecords = grid.selectedRecords
   for (var i = 0; i < selectedRecords.length; ++i){
     ds.bookmark = selectedRecords[i]
     ds.nome = ds.nome.toUpperCase()
   }
 })
Parameters:
{string} name
Nome do botão. O valor informado também será utilizado como o texto do botão, caso a propriedade label do botão não seja informada.
{(string|Function)=} opt_target
Poderá ser informado:
- nome de uma interação;
- nome de uma atividade;
- função que será atribuída ao evento onClick do botão.
Se "target" for uma string vazia e o parâmetro "processKey" for informado, será considerado como destino a primeira interação do processo destino.
Este parâmetro será opcional apenas quando deseja-se obter a instância de um botão existente.
{number=} opt_order
Ordem do botão na barra de botões. Prefira utilizar a propriedade Grid.visibleButtons.
{number=} opt_processKey
Indica a chave do processo que contém a atividade ou interação informada no parâmetro "target". Será considerado o processo corrente quando não for informado.
{boolean=} opt_newTab
Indica se deve ser criada uma nova aba para exibir a interação ou atividade informada em "target". Considerado "false" quando não for informado.
Returns:
{uwi.button.Button} Botão existente com o nome informado ou uma nova instância caso não exista um com o nome informado.
See:
uwi.grid.Grid#Button

clearButtons()
Limpa os botões da grade.

colapse(nodeValue)
Minimiza o nó solicitado na árvore. Ao se chamar o colapse, a grade garante que a hierarquia de nós será minimizada.
Parameters:
{string} nodeValue
Nó que deve ser minimizado.

declareGetterAndSetter_(fieldName, gridName)
Constrói um método getter and setter no processo para acessar o valor do campo informado.
Parameters:
{string} fieldName
Nome do campo.
{string} gridName
Nome da grade.

del(handleDetailGrid)
Exclui da grade e consequentemente do dataSet o(s) registro(s) selecionado(s) na grade. É executado quando for acionado o botão representado por um "-" na grade.
Parameters:
{boolean} handleDetailGrid
Indica se a deleção está sendo chamada por causa de um tratamento de deleção de uma grade master.

duplicateRecord(opt_bookmark)
Duplica um registro da grade.
Parameters:
{string?} opt_bookmark
Identificação do registro que será duplicado. Caso não seja informado, será duplicado o registro corrente.

emit(event)
Parameters:
event

expand(nodeValue)
Expande o nó solicitado na árvore. Ao se chamar o expand, a grade garante que a hierarquia de nós será expandida.
Parameters:
{string} nodeValue
Nó que deve ser expandido.

{ngin.classdef.Field} field(name, opt_type, opt_size)
Método utilizado para criar ou acessar um campo na grade.
Os campos devem ser criados dentro do evento onDefineFields() da grade, caso queira acessar um campo previamento criado, basta informar o primeiro parâmetro "name".
var grid = this.grid("gradeExemplo");
grid.onDefineFields.set(function (grid) {
    // Cria um campo do tipo string com identificador "nome" e tamanho 20.
    var fld = grid.field("nome", "string", 20);
    // Cria um campo do tipo integer com idetificador "matricula".
    fld = grid.field("matricula", "integer");
    // cria um campo do tipo date com identificador "dataEdicao".
    fld = grid.field("dataEdicao", "date");
});
Parameters:
{string} name
Nome que servirá como identificador do campo.
Atenção: Não podem ser definidos nomes que conflitem com propriedades/métodos da grade.
{string=} opt_type
Tipo do campo.
Tipos existentes:
- "string";
- "integer";
- "date";
- "number";
- "boolean";
- "combo";
- "memo";
{number=} opt_size
Tamanho do campo. Indica o número de caracteres que o campo suportará.
Este valor também servirá de base para obtenção da largura do campo.
É necessário apenas em campos do tipo "string" ou "memo";
Returns:
{ngin.classdef.Field} Campo recém criado ou existente que possua o nome informado.

formatEventId(eventType, opt_field)
Cria uma identificação para o evento para fins de log. A identificação conterá, sempre que for possível, o processo, a grade e o evento, permitindo que o desenvolvedor localize o código que declarou o evento a partir da mensagem de log.
Parameters:
{string} eventType
Evento a ser identificado.
{uwi.field.Field=} opt_field
Caso seja um evento de campo, deve ser informada a instância do campo.

{StringList} getFieldsAsStringList()
Mantém compatibilidade para quem precisa acessar a lista de fields como um objeto lista de Strings. Esse método seleciona os campos da grade e os coloca em um objeto StringList, retornando-o.
Returns:
{StringList} Campos da grade.

{Array} getFieldsByProperty(propertyName)
Retorna uma lista de campos cuja propriedades tenham os valores informados.
 //Propriedade e valor:
 //Nessa forma serão obtidos os campos que possuem as propriedades fornecidos
 //com os respectivos valores.
 getFieldsByProperty('prop', valor, 'prop2', valor2);

 //Array de propriedades e de valores:
 //Nessa forma serão fornecidos dois arrays, o primeiro array é o de propriedades
 //que se relaciona com o segundo array, que é o de valores, pelo índice.
 getFieldsByProperty(['prop', 'prop2'], [valor, valor2]);

 //Através de um callback
 //Nesta forma são obtidos os campos de acordo com a regra definida no callback.
 getFieldsByProperty(function (field) {
   return field.required === true;
 });
Parameters:
{...*} propertyName
Há multiplas formas de definição dos parametros, veja o exemplo abaixo.
Returns:
{Array} Lista de campos.

{string} getFormattedHelp()
Devolve a ajuda formatada grade.
Returns:
{string} Ajuda formatada.

{ngin.classdef.Field} getKeyField()
Retorna o campo que contém a chave dos registros, ou nulo caso não o encontre.
Returns:
{ngin.classdef.Field} O campo chave da grade.

{ngin.classdef.Field} getLookupCallerField()
Obtém o campo que disparou a exibição da grade, caso ela seja a grade de Lookup.
Returns:
{ngin.classdef.Field}

{!Array} getSelectedRecords(opt_viewMode)
Retorna os registros selecionados da visão da grade informada no parâmetro. Caso a visão não seja informada, será utilizada a visão atual. Para a visão formulário, será retornado um array com o bookmark do registro posicionado no momento. Quando o dataset estiver no estado de inserção, o getSelectedRecords() retornará um array vazio.
Parameters:
{number=} opt_viewMode
Modo de visão a partir da qual se deseja saber quais os registros selecionados. Os valores possíveis são: uwi.grid.Grid.FORMVIEW e uwi.grid.Grid.TABLEVIEW.
Returns:
{!Array} Array com os bookmarks dos registros selecionados.

{string} handleSync()
Trata uma solicitação de sincronismo da grade cliente.
Returns:
{string} Retorna os comandos de sincronismo do protocolo IFP.

{ngin.classdef.Field} locateField(fieldName)
Retorna o objeto Field associado ao nome
Parameters:
{string} fieldName
Nome do campo
Returns:
{ngin.classdef.Field} object

lookup(field)
Dispara grade lookup em campos da grade que estejam relacionados com registros de uma tabela.
Parameters:
{uwi.field.Field} field
Campo que possui a propriedade lookup definida.

{uwi.classdef.GridEvent} newEvent_(type, opt_options)
Cria um novo evento uwi.grid.Grid
Parameters:
{string} type
Tipo do evento registrado anteriormente no emissor
{{cancelable: boolean}=} opt_options
Opções do evento a ser criado. Atualmente, é permitido apenas informar a opção cancelable para indicar se o evento pode ser cancelado pelo método #preventDefault.
Returns:
{uwi.classdef.GridEvent} Evento criado.

{number} persist()
Realiza persistência para DataSets da grade e de suas filhas. Essa deve ser a forma recomendada de realizar a persistência de uma grade. A exceção é para quando são utilizados objetos de gestão responsáveis por gravar as alterações realizadas no DataSet informado à grade.
Returns:
{number} Versão das alterações.

<static> {number} uwi.grid.Grid.persist(grids)
Realiza persistência para DataSets de um conjunto de grades e das suas filhas.
Parameters:
{uwi.grid.Grid|Array} grids
Grades cujos DataSets serão persistidos.
Returns:
{number} Versão das alterações.

{boolean} post(opt_doParentPost)
Efetiva as alteração o registo corrente esteja em estado de edição ou inserção.
Parameters:
{boolean=} opt_doParentPost
Indica que deve ser realizada a efetivação do registro mestre caso esta seja uma grade detalhe. Caso não seja informado, será considerado true.
Returns:
{boolean} True se a edição ou inserção foi efetivada, false caso o registro não estivesse em edição ou inserção, ou se um listener do evento post previniu a ação padrão.

prepare()
TODO: verificar porque o prepare nunca está sendo chamado para uma grid de variáveis

refresh(opt_force)
Reinicia a estrutura da grade tanto no servidor quanto no cliente. Possibilitando assim que as alterações feitas após o grid.write() entrem em vigor.
Sempre que uma alteração é realizada na estrutura da grade (criação de um campo por exemplo) esta entrará em vigor somente após ser feito o grid.refresh() da grade.
Parameters:
{boolean=} opt_force
Indica se o refresh deverá ser realizado mesmo para uma grade que acabou de ser escrita, ou seja logo após ser realizado o grid.write(), ou se pode ser realizado refresh múltiplas vezes.

resetFields()
Redefine os valores de todos os campos do registro que esteja em foco na grade.
Caso seja um campo não-calculável, para o seu valor padrão, onde o valor padrão seria o Field.defaultValue, ou seja, a sugestão de preenchimento do campo.

scroll(action)
Executa um método de navegação do dataset ('first', 'next', 'prior' ou 'last') ou função passada como parâmetro, disparando os eventos de scroll da grade e atualizando os filtros das grades detalhes.
Parameters:
{string|function(DataSet)} action
Método que deve ser invocado no dataset ou uma função que será executada recebendo o dataset com argumento.

setDs(value)
Parameters:
{DataSet} value

setFieldsProperties()
Este método cria ou seta as propriedades informadas com os valores informados em cada campo da definido nos parametros. Para utilizar esse método existem diversas formas de o invocar, veja os exemplo abaixo.
 // Array de campos com callback para setar as propriedades:
 fl.setFieldsProperties([field1, field2], function (field) {
   field.prop = valor;
field.prop2 = valor2
}); // Array com os nomes dos campos com callback para setar as propriedades: fl.setFieldsProperties(['campo1','campos2'], function (field) { field.prop = valor; field.prop2 = valor2 }); // String com o nomes dos campos separados por virgula ou ponto e virgula como primeiro // parâmetro. // Array com nomes das propriedades a serem definidas como segundo parâmetro. // Array com os valores a serem definidos nas propriedades de mesmo índice como terceiro // parâmetro. fl.setFieldsProperties('campo1,campos2', ['prop', 'prop2'], [valor, valor2]); // Ainda na forma anterior pode ser utilizado o caractere '*' para obter todos os campos. fl.setFieldsProperties('*', ['prop', 'prop2'], [valor, valor2]); // Lista de strings separados por vírgula ou ponto e virgula com os nomes dos campos a // serem alterados como primeiro parâmetro. // Os parâmetros seguintes são os nomes das propriedades com os valores que devem ser // atribuídos. fl.setFieldsProperties('campo1,campos2', 'prop', valor, 'prop2', valor2);

sync_(formSync, tableSync)
Obtém os comandos que devem ser executados dentro do contexto da grade no cliente.
Parameters:
formSync
tableSync

tabSyncBufferUpdate(dsSync, records, i, isCurrentRecord)
Parameters:
dsSync
records
i
isCurrentRecord

toggleFieldVisibility(field)
Alterna a visibilidade de um campo da grade nos dois modos de visão.
Parameters:
{string|Field} field
O campo ou nome do campo a ter a visibilidade chaveada.

toggleKeyVisibility()
Alterna a visibilidade do campo CHAVE ou iKey, caso o campo esteja presente.

write(opt_showInFormView, opt_noWriteInClient)
Método utilizado para escrever a grade na tela após serem configurados os eventos e os seus campos.
Qualquer alteração na estrutura da grade após ser realizado o grid.write() só entrará em vigor após ser realizado um grid.refresh(), que atualiza a estrutura de uma grade que já foi escrita.
Por padrão a grade é escrita em modo tabela.
Parameters:
{boolean=} opt_showInFormView
Indica se deverá escrever a grade no modo formulário.
{boolean=} opt_noWriteInClient
Indica que o write não deve ser efetivado para o browser. É de uso interno da grade e não deve ser utilizado. Este parâmetro será removido no futuro.

Documentation generated by JsDoc Toolkit 2.4.0 on Tue Aug 23 2016 16:18:20 GMT-0300 (GFT)