nginstack

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

  • GridEvent

Members

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

locatedField :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:
  • GridField

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>

value :string

Valor pesquisado pelo usuário.

Type:
  • string