Class: GridLocateEvent

@nginstack/web-framework/lib/classdef/GridLocateEvent~ GridLocateEvent

new GridLocateEvent()

Evento emitido quando o usuário solicita uma pesquisa em uma grade de dados do Web Framework.

Example
// O exemplo abaixo personaliza a busca para permitir que sejam buscados apenas
 // números e executa o evento padrão através do "inherited".<br>
 // 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.
 grid.replaceListeners('locate', function (evt, replacedEmit) {
   if (typeof evt.value !== 'number') {
     replacedEmit(evt)
     if (replacedEmit.locatedField) {
       grid.process.setNextInteraction('interactionName')
     }
   } else {
     throw new Error('Não é possível localizar valores diferentes de números!')
   }
 });

Extends

Members

cancelable :boolean

Determina se o evento pode ser cancelado por meio da execução do método #preventDefault.

Type:
  • boolean
Inherited From:

currentTarget :Object

Objeto cujos listeners estão sendo processados. Em um borbulhamento de evento, será o elemento atual dentro borbulha.

Type:
  • Object
Inherited From:

data :module:@nginstack/engine/lib/dataset/DataSet~DataSet

DataSet que está sendo alterado. Será uma instância protegida do DataSet contra a alteração do registro corrente, portanto não poderão ser utilizados métodos que mudem a posição corrente, como DataSet#first, DataSet#next, DataSet#prior, DataSet#last, DataSet#find, DataSet#findKey, etc.

Type:
Inherited From:

defaultPrevented :boolean

Indica que o método #preventDefault foi executado durante a emissão de um evento cancelável.

Type:
  • boolean
Inherited From:

found :boolean

Deve ser utilizado pelos listeners para indicar que foi encontrada uma ocorrência do valor pesquisado. O campo onde essa ocorrência foi localizada deve ser informada em #locatedField.

Type:
  • boolean

grid :module:@nginstack/web-framework/lib/grid/Grid~Grid

Grade que sofreu a operação indicada pelo evento.

Type:
Inherited From:

immediateStopped :boolean

Determina se a emissão do evento foi interrompida por meio da execução do método #stopImmediatePropagation.

Type:
  • boolean
Inherited From:

listenerIndex :number

Índice do próximo listener a ser executado pelo module:@nginstack/engine/lib/event/Emitter.

Type:
  • number
Inherited From:

locatedField :module:@nginstack/web-framework/lib/grid/GridField~GridField

Deve ser utilizado pelos listeners para indicar o campo em que foi localizado o valor. Caso nenhum valor seja encontrado, deverá ser informado com null.

Type:

masterData :module:@nginstack/engine/lib/dataset/DataSet~DataSet

DataSet com os dados da grade mestre de uma relação mestre-detalhe quando o evento for emitido por uma grade detalhe. Será nulo caso a grade não seja uma detalhe.

Type:
Inherited From:
Example
// O exemplo abaixo insere um registro padrão no dataSet da detalhe, quando for inserido
 // um registro na mestre
 detail.on('masterInsert', function (evt) {
   const ds = evt.data.newSharedDataSet();
   ds.append([evt.masterData.num('CHAVE'), '123456']);
   ds.post();
 });

masterGrid :module:@nginstack/web-framework/lib/grid/Grid~Grid

Grade mestre de uma relação mestre-detalhe quando o evento for emitido por uma grade detalhe. Será nulo caso a grade não seja uma detalhe.

Type:
Inherited From:
Example
// O exemplo abaixo insere um registro padrão no dataSet da detalhe, quando for inserido
 // um registro na mestre
 detail.on('masterInsert', function (evt) {
   var ds = evt.data.newSharedDataSet();
   ds.append([evt.masterGrid.ds.num('CHAVE'), '123456']);
   ds.post();
 });

options :Array.<number>

Opções da pesquisa solicitada pelo usuário. É um array contendo uma ou mais constantes numéricas que indicam as opções selecionadas pelo usuário na interface. Valores possíveis: Grid.LOCATE_ALL_FIELDS, Grid.LOCATE_EXACT e Grid.LOCATE_NEXT.

Type:
  • Array.<number>

process :module:@nginstack/web-framework/lib/process/Process~Process

Processo onde foi definida a grade que está realizando a operação indicada pelo evento.

Type:
Inherited From:

target :Object

Objeto que emitiu originalmente este evento. Em um borbulhamento de evento, será o primeiro elemento da borbulha.

Type:
  • Object
Inherited From:

timeStamp :number

Instante em que este evento foi criado. Será a quantidade de milissegundos a partir de 01/01/1970.

Type:
  • number
Inherited From:

type :string

Tipo do evento desta instância.

Type:
  • string
Inherited From:

value :string

Valor pesquisado pelo usuário.

Type:
  • string

Methods

preventDefault()

Indica que a ação padrão associada ao evento não deve ser realizada pelo componente que disparou o evento. Apenas alguns eventos utilizam o conceito de ação padrão. Para ver se o evento possui uma ação padrão associada, veja a documentação das classes especializadas de eventos.

Inherited From:

stopImmediatePropagation()

Interrompe a emissão do evento imediatamente, não executando os listeners adicionados no mesmo emissor e o borbulhamento do evento para outros elementos.

Inherited From: