nginstack

Class: Adapter

@nginstack/engine/lib/event/Adapter~ Adapter

new Adapter(emitter, descriptor)

Adaptador da API antiga de eventos (classe Event) com a classe Emitter. O objeto construído poderá ser utilizado por APIs que esperam receber uma instância de Event.

Parameters:
Name Type Description
emitter Emitter

Emissor de eventos que será adaptado. Todos os listeners registrados por esta instância serão adicionados nesse emissor.
descriptor AdapterDescriptor | Record.<*, *>

Descrição do evento a ser adaptado e os parâmetros esperados.
Example
var Adapter = require('@nginstack/engine/lib/event/Adapter');
this.onBeforePost = new Adapter(listener, {
  type: 'beforeChange',
  parameters: ['target', 'newValue'],
  resultParameter: null,
  eventClass: BeforeChangeEvent
});

Extends

  • Event

Members

duplicates :string

Propriedade utilizada para determinar o comportamento do Event quando for adicionada uma função ou instância de Method duplicado. Será considerado duplicado se o código fonte da função for igual à uma outra função adicionada anteriormente.

Os possíveis valores são: "accept","remove","error":

  • "ignore": ignora o registro de eventos duplicados;
  • "accept": permite a ocorrência de eventos duplicados;
  • "remove": remove o evento duplicado existente da pilha de eventos;
  • "error": gera um erro antes impedindo a inserção do evento duplicado.
Type:
  • string
Default Value:
  • "accept"

isEmpty :boolean

Indica que não há listeners registrados.

Type:
  • boolean

methods :Array.<function(*): *>

Array contendo todas as funções de listeners registradas por meio do método #set.

Type:
  • Array.<function(*): *>

Methods

<static> adaptEvent(obj, name, adapterDescriptor)

Cria um adaptador da API de eventos antiga (classe global Event) com a nova API 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:
Name Type Description
obj Object

Objeto onde deverá ser criado o evento adaptado.
name string

Nome do evento.
adapterDescriptor AdapterDescriptor | Record.<*, *>

Regras de como deve ser feita a adaptação do evento.

assign(source [, opt_preserveMethods])

Copia a pilha de eventos do source para este objeto.

Parameters:
Name Type Argument Description
source Event | Adapter

Evento que deve ser copiado.
opt_preserveMethods boolean <optional>

Indica que os eventos existentes neste objeto não devem ser excluídos. Os eventos do source serão adicionados aos já existentes.

clear()

Elimina todos os listeners registrados.

clearMethods()

Elimina todos os listeners registrados.

Deprecated:
  • Utilize #clear.

clone()

Cria uma cópia desta instância.

Returns:
Type
Adapter

dispatch()

Emite o evento executando os listeners registrados previamente pelo método #set.

set(listener)

Adiciona uma nova função de listener para este evento.

Parameters:
Name Type Description
listener Object | function

Função que tratará este evento.