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 |
module:@nginstack/engine/lib/event/Emitter~Emitter |
Emissor de eventos que será adaptado. Todos os listeners registrados por esta instância serão adicionados nesse emissor. |
descriptor |
module:@nginstack/engine/lib/event/AdapterDescriptor~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
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:
-
defaultPrevented :boolean
-
Indica que o método #preventDefault foi executado durante a emissão de um evento cancelável.
Type:
- boolean
- Inherited From:
-
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"
-
immediateStopped :boolean
-
Determina se a emissão do evento foi interrompida por meio da execução do método #stopImmediatePropagation.
Type:
- boolean
- Inherited From:
-
isEmpty :boolean
-
Indica que não há listeners registrados.
Type:
- boolean
-
listenerIndex :number
-
Índice do próximo listener a ser executado pelo module:@nginstack/engine/lib/event/Emitter.
Type:
- number
- Inherited From:
-
methods :Array.<function(*): *>
-
Array contendo todas as funções de listeners registradas por meio do método #set.
Type:
- Array.<function(*): *>
-
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
-
assign(source [, opt_preserveMethods])
-
Copia a pilha de eventos do source para este objeto.
Parameters:
Name Type Argument Description sourcemodule:@nginstack/engine/lib/event/Event~Event| module:@nginstack/engine/lib/event/Adapter~Adapter Evento que deve ser copiado.
opt_preserveMethodsboolean <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:
-
dispatch()
-
Emite o evento executando os listeners registrados previamente pelo método #set.
-
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:
-
set(listener)
-
Adiciona uma nova função de listener para este evento.
Parameters:
Name Type Description listenerObject| function Função que tratará este evento.
-
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.
-
<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 objObject Objeto onde deverá ser criado o evento adaptado.
namestring Nome do evento.
adapterDescriptormodule:@nginstack/engine/lib/event/AdapterDescriptor~AdapterDescriptor| Record.<*, *> Regras de como deve ser feita a adaptação do evento.