Class: BeforeSelectRecordEvent

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

new BeforeSelectRecordEvent()

Evento emitido quando um registro é marcado ou desmarcado, ou quando o usuário pressiona o botão inverter seleção.

Example
const createSet = require('@nginstack/engine/lib/object/createSet.js');
 grid.on('beforeSelectRecord', function (evt) {
   var selected = createSet(evt.grid.selectedRecords);
   var alreadySelected = evt.bookmarks.some(function (bmk) {
     return bmk in selected;
   });
   if (alreadySelected) {
     evt.process.alert('Não é permitido selecionar o registro mais de uma vez.');
     evt.bookmarks = [];
   }
 });

Extends

Members

bookmarks :Array.<string>

Bookmark dos registros marcados ou desmarcados pelo usuário. Para identificar se o registro está sendo marcado ou desmarcado, verifique a propriedade module:@nginstack/web-framework/lib/grid/Grid~Grid#selectedRecords. Essa propriedade lista os registros marcados atualmente, portanto os bookmarks que estão presentes em selectedRecords e nesta estão sendo desmarcados, enquanto os bookmarks presentes apenas nesta propriedade estão sendo marcados.

Type:
  • Array.<string>

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:

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:

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();
 });

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:

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: