Esta clase base define el on, oncey off
métodos de los objetos que pueden generar eventos.
Métodos
| Nombre | Descripción |
|---|---|
addEventListener(type, listener, context) |
En desuso. |
off(type, handler, context) → {Object} |
Elimina uno o varios controladores de eventos. |
on(type, handler, context) → {EventDispatcher} |
Añade una función de gestión de eventos para uno o varios eventos. |
once(type, handler, context) → {Object} |
Añade una función de gestión de eventos para uno o varios eventos. |
removeEventListener(type, listener, context) |
En desuso. |
addEventListener(tipo, oyente, contexto)
Parámetros:
| Nombre | Tipo | Descripción |
|---|---|---|
type |
Cadena | La cadena que identifica el tipo de evento. |
listener |
función | La función que se invocará cuando el objeto dispache el evento. |
context |
Objeto | (Opcional) Define el valor de this en la función del controlador de eventos. |
En desuso — uso on() o una vez() en su lugar.
Este método registra un método como detector de eventos para un evento concreto.
Si no hay ningún controlador registrado para un evento, dicho evento se ignora a nivel local. Si la función de escucha de eventos no existe, el evento se ignora a nivel local.
Lanza una excepción si el listener El nombre no es válido.
Véase: : - on() - una vez() - Eventos
off(tipo, controlador, contexto) → {Object}
Elimina uno o varios controladores de eventos.
Si se pasa un nombre de evento y un método de gestión, dicho método se elimina para ese evento:
obj.off("eventName", eventHandler);
Si se pasan varios nombres de eventos y un método de gestión, dicho método se elimina para esos eventos:
obj.off("eventName1 eventName2", eventHandler);
Si pasas un nombre de evento (o varios nombres) y no método de controladores: se eliminan todos los controladores para esos eventos:
obj.off("event1Name event2Name");
Si no se pasan argumentos, todos Se eliminan los controladores de eventos para todos los eventos enviados por el objeto:
obj.off();
El método también admite una sintaxis alternativa, en la que el primer parámetro es un objeto que consta de un mapa hash con los nombres de los eventos y las funciones de gestión, y el segundo parámetro (opcional) es el contexto para cada una de estas funciones:
obj.off(
{
eventName1: event1Handler,
eventName2: event2Handler
});
Parámetros:
| Nombre | Tipo | Descripción |
|---|---|---|
type |
Cadena | (Opcional) La cadena que identifica el tipo de evento. Puedes utilizar un espacio para especificar varios eventos, como en «accessAllowed accessDenied accessDialogClosed». Si no pasas ningún type valor (u otros argumentos), se eliminan todos los controladores de eventos del objeto. |
handler |
función | (Opcional) La función de gestión de eventos que se va a eliminar. El gestor debe ser el mismo objeto de función que se pasó a on(). Ten cuidado con los ayudantes como bind() que devuelven una nueva función cuando se invocan. Si no se pasa ningún handler, se eliminan todos los controladores de eventos para el evento especificado type. |
context |
Objeto | (Opcional) Si especificas un context, se elimina el controlador de eventos para todos los eventos especificados y los controladores que utilicen el contexto especificado. (El contexto debe coincidir con el contexto pasado a on().) |
Véase: : - on() - una vez() - Eventos
Devoluciones:
El objeto que ha activado el evento.
on(tipo, controlador, contexto) → {EventDispatcher}
Añade una función de gestión de eventos para uno o varios eventos.
El siguiente código añade un controlador de eventos para un evento:
obj.on("eventName", function (event) {
// This is the event handler.
});
Si se pasan varios nombres de eventos y un método de gestión, dicho método se registra para cada uno de esos eventos:
obj.on("eventName1 eventName2",
function (event) {
// This is the event handler.
});
También puedes pasar un tercer context parámetro (que es opcional) para
definir el valor de this en el método del controlador:
obj.on("eventName",
function (event) {
// This is the event handler.
},
obj);
El método también admite una sintaxis alternativa, en la que el primer parámetro es un objeto que constituye un mapa hash de nombres de eventos y funciones de gestión, y el segundo parámetro (opcional) es el contexto para cada una de estas funciones de gestión:
obj.on(
{
eventName1: function (event) {
// This is the handler for eventName1.
},
eventName2: function (event) {
// This is the handler for eventName2.
}
},
obj);
Si no se añade un controlador para un evento, este se ignora a nivel local.
Parámetros:
| Nombre | Tipo | Descripción |
|---|---|---|
type |
Cadena | La cadena que identifica el tipo de evento. En esta cadena puedes especificar varios nombres de eventos, separándolos con un espacio. El controlador de eventos procesará cada uno de ellos. |
handler |
función | La función de gestión encargada de procesar el evento. Esta función toma el objeto del evento como parámetro. |
context |
Objeto | (Opcional) Define el valor de this en la función del controlador de eventos. |
Véase: : - off() - una vez() - Eventos
Devoluciones:
El objeto EventDispatcher.
once(tipo, controlador, contexto) → {Object}
Añade una función de gestión de eventos para uno o varios eventos. Una vez que se invoca el gestor,
el método de gestión especificado deja de ser el gestor de este evento. (Cuando se utiliza
el on() método para añadir un controlador de eventos; el controlador es no
se elimina cuando se invoca.) El once() El método es equivalente a
llamar a la on()
método y llamada off() la primera vez que se invoca el controlador.
El siguiente código añade un controlador de eventos de uso único para un evento:
obj.once("eventName", function (event) {
// This is the event handler.
});
Si se pasan varios nombres de eventos y un método de gestión, dicho método se registra para cada uno de esos eventos:
obj.once("eventName1 eventName2"
function (event) {
// This is the event handler.
});
También puedes pasar un tercer context parámetro (que es opcional) para definir
el valor de
this en el método del controlador:
obj.once("eventName",
function (event) {
// This is the event handler.
},
obj);
El método también admite una sintaxis alternativa, en la que el primer parámetro es un objeto que consta de un mapa hash con los nombres de los eventos y las funciones de gestión, y el segundo parámetro (opcional) es el contexto para cada una de estas funciones:
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:
| Nombre | Tipo | Descripción |
|---|---|---|
type |
Cadena | La cadena que identifica el tipo de evento. En esta cadena puedes especificar varios nombres de eventos, separándolos con un espacio. El controlador de eventos procesará la primera aparición de dichos eventos. Tras el primer evento, el controlador se elimina (para todos los eventos especificados). |
handler |
función | La función de gestión encargada de procesar el evento. Esta función toma el objeto del evento como parámetro. |
context |
Objeto | (Opcional) Define el valor de this en la función del controlador de eventos. |
Véase: : - on() - off() - Eventos
Devoluciones:
El objeto que ha activado el evento.
removeEventListener(tipo, oyente, contexto)
Parámetros:
| Nombre | Tipo | Descripción |
|---|---|---|
type |
Cadena | La cadena que identifica el tipo de evento. |
listener |
función | La función de escucha de eventos que hay que eliminar. |
context |
Objeto | (Opcional) Si especificas un context, se elimina el controlador de eventos para todos los eventos especificados y los oyentes de eventos que utilicen el contexto especificado. (El contexto debe coincidir con el contexto pasado a addEventListener().) |
En desuso — uso off() en su lugar.
Elimina un detector de eventos para un evento concreto.
Lanza una excepción si el listener El nombre no es válido.