Esta classe base define o on, once, e off
métodos de objetos capazes de disparar eventos.
Métodos
| Nome | Descrição |
|---|---|
addEventListener(type, listener, context) |
Obsoleto. |
off(type, handler, context) → {Object} |
Remove um ou mais manipuladores de eventos. |
on(type, handler, context) → {EventDispatcher} |
Adiciona uma função de manipulador de eventos para um ou mais eventos. |
once(type, handler, context) → {Object} |
Adiciona uma função de manipulador de eventos para um ou mais eventos. |
removeEventListener(type, listener, context) |
Obsoleto. |
addEventListener(tipo, ouvinte, contexto)
Parâmetros:
| Nome | Tipo | Descrição |
|---|---|---|
type |
String | A sequência de caracteres que identifica o tipo de evento. |
listener |
função | A função a ser chamada quando o objeto disparar o evento. |
context |
Objeto | (Opcional) Define o valor de this na função do manipulador de eventos. |
Obsoleto — uso on() ou uma vez() em vez disso.
Este método registra um método como um ouvinte de evento para um evento específico.
Se um manipulador não estiver registrado para um evento, o evento é ignorado localmente. Se a função de escuta de eventos não existir, o evento é ignorado localmente.
Gera uma exceção se o listener O nome é inválido.
Veja: : - on() - uma vez() - Eventos
off(tipo, manipulador, contexto) → {Object}
Remove um ou mais manipuladores de eventos.
Se você passar o nome de um evento e um método manipulador, o manipulador será removido para esse evento:
obj.off("eventName", eventHandler);
Se você passar vários nomes de eventos e um método manipulador, o manipulador será removido para esses eventos:
obj.off("eventName1 eventName2", eventHandler);
Se você passar um nome de evento (ou nomes) e não método de manipulador, todos os manipuladores são removidos para esses eventos:
obj.off("event1Name event2Name");
Se você não passar nenhum argumento, todos os manipuladores de eventos são removidos para todos os eventos desencadeados pelo objeto:
obj.off();
O método também suporta uma sintaxe alternativa, na qual o primeiro parâmetro é um objeto que é um mapa de nomes de eventos e funções de tratamento, e o segundo parâmetro (opcional) é o contexto para isso em cada função de tratamento:
obj.off(
{
eventName1: event1Handler,
eventName2: event2Handler
});
Parâmetros:
| Nome | Tipo | Descrição |
|---|---|---|
type |
String | (Opcional) A sequência de caracteres que identifica o tipo de evento. É possível usar um espaço para especificar vários eventos, como em “accessAllowed accessDenied accessDialogClosed”. Se você não passar nenhum type valor (ou outros argumentos), todos os manipuladores de eventos são removidos do objeto. |
handler |
função | (Opcional) A função manipuladora de eventos a ser removida. A manipuladora deve ser o mesmo objeto de função que foi passado para on(). Tenha cuidado com auxiliares como bind() que retornam uma nova função quando chamadas. Se você não passar nenhum handler, todos os manipuladores de evento são removidos para o evento especificado type. |
context |
Objeto | (Opcional) Se você especificar um context, o manipulador de eventos é removido para todos os eventos especificados e manipuladores que utilizam o contexto especificado. (O contexto deve corresponder ao contexto passado para on().) |
Veja: : - on() - uma vez() - Eventos
Devoluções:
O objeto que disparou o evento.
on(tipo, manipulador, contexto) → {EventDispatcher}
Adiciona uma função de manipulador de eventos para um ou mais eventos.
O código a seguir adiciona um manipulador de eventos para um evento:
obj.on("eventName", function (event) {
// This is the event handler.
});
Se você passar vários nomes de eventos e um método manipulador, o manipulador será registrado para cada um desses eventos:
obj.on("eventName1 eventName2",
function (event) {
// This is the event handler.
});
Você também pode passar um terceiro context parâmetro (que é opcional) para
definir o valor de this no método do manipulador:
obj.on("eventName",
function (event) {
// This is the event handler.
},
obj);
O método também suporta uma sintaxe alternativa, na qual o primeiro parâmetro é um objeto que representa um mapa de nomes de eventos e funções de tratamento, e o segundo parâmetro (opcional) é o contexto para isso em cada função de tratamento:
obj.on(
{
eventName1: function (event) {
// This is the handler for eventName1.
},
eventName2: function (event) {
// This is the handler for eventName2.
}
},
obj);
Se você não adicionar um manipulador para um evento, o evento será ignorado localmente.
Parâmetros:
| Nome | Tipo | Descrição |
|---|---|---|
type |
String | A string que identifica o tipo de evento. É possível especificar vários nomes de eventos nessa string, separando-os por um espaço. O manipulador de eventos processará cada um desses eventos. |
handler |
função | A função de tratamento responsável por processar o evento. Essa função recebe o objeto do evento como parâmetro. |
context |
Objeto | (Opcional) Define o valor de this na função do manipulador de eventos. |
Veja: : - off() - uma vez() - Eventos
Devoluções:
O objeto EventDispatcher.
once(tipo, manipulador, contexto) → {Object}
Adiciona uma função de manipulador de eventos para um ou mais eventos. Assim que o manipulador for chamado,
o método de manipulador especificado é removido como manipulador desse evento. (Quando você usa
o on() método para adicionar um manipulador de eventos; o manipulador é não
é removido quando é chamado.) O once() O método é equivalente a
chamar o on()
método e chamada off() na primeira vez que o manipulador for chamado.
O código a seguir adiciona um manipulador de evento único para um evento:
obj.once("eventName", function (event) {
// This is the event handler.
});
Se você passar vários nomes de eventos e um método de tratamento, o tratamento será registrado para cada um desses eventos:
obj.once("eventName1 eventName2"
function (event) {
// This is the event handler.
});
Você também pode passar um terceiro context parâmetro (que é opcional) para definir
o valor de
this no método do manipulador:
obj.once("eventName",
function (event) {
// This is the event handler.
},
obj);
O método também suporta uma sintaxe alternativa, na qual o primeiro parâmetro é um objeto que é um mapa de nomes de eventos e funções de tratamento, e o segundo parâmetro (opcional) é o contexto para isso em cada função de tratamento:
obj.once(
{
eventName1: function (event) {
// This is the event handler for eventName1.
},
eventName2: function (event) {
// This is the event handler for eventName1.
}
},
obj);
Parâmetros:
| Nome | Tipo | Descrição |
|---|---|---|
type |
String | A string que identifica o tipo de evento. É possível especificar vários nomes de eventos nessa string, separando-os por um espaço. O manipulador de eventos processará a primeira ocorrência desses eventos. Após o primeiro evento, o manipulador é removido (para todos os eventos especificados). |
handler |
função | A função de tratamento responsável por processar o evento. Essa função recebe o objeto do evento como parâmetro. |
context |
Objeto | (Opcional) Define o valor de this na função do manipulador de eventos. |
Veja: : - on() - off() - Eventos
Devoluções:
O objeto que disparou o evento.
removeEventListener(tipo, ouvinte, contexto)
Parâmetros:
| Nome | Tipo | Descrição |
|---|---|---|
type |
String | A sequência de caracteres que identifica o tipo de evento. |
listener |
função | A função do ouvinte de evento a ser removida. |
context |
Objeto | (Opcional) Se você especificar um context, o manipulador de eventos é removido para todos os eventos especificados e para todos os ouvintes de eventos que utilizam o contexto especificado. (O contexto deve corresponder ao contexto passado para addEventListener().) |
Obsoleto — uso off() em vez disso.
Remove um ouvinte de evento para um evento específico.
Gera uma exceção se o listener O nome é inválido.