Class: LegacyEvent

@nginstack/engine/lib/event/LegacyEvent~ LegacyEvent


new LegacyEvent()

Classe utilizada para armazenar uma pilha de eventos. Ela implementa uma função global inherited() que permite um evento chamar a definição anterior na pilha.

Deprecated:

Members


duplicates :string

Propriedade utilizada para determinar o comportamento do LegacyEvent 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":

  • "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 se a pilha de eventos está vazia, indicando que não existe método a ser executado pelo dispatch().

Type:
  • boolean

Methods


<static> inherited()

Dispara o evento declarado antes do evento sendo executado no momento, os argumentos desta função será os argumentos do evento executado. Também é publicado como uma função global durante a execução do evento.

Example
// Declaração de uma classe qualquer que possui evento.
   function ClasseA( objQualquer ) {
      this.onBeforeAction = new LegacyEvent()
      this.onBeforeAction.set( function ( sender ) {
         ...
      } )
   }
   function ClasseB() {
      ClasseA.call( this )
      this.onBeforeAction.set( function ( sender ) {
         // neste momento será executado a função declarada na ClasseA
         inherited( sender )
         ...
      } )
   }

assign(source, preserveMethods)

Copia a pilha de eventos do source para este objeto.

Parameters:
Name Type Description
source LegacyEvent

Evento que deve ser copiado

preserveMethods boolean

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


assignAddingMethods(source)

Adiciona os eventos existentes em source neste objeto.

Parameters:
Name Type Description
source LegacyEvent

Instância de LegacyEvent, que terá a pilha copiada

See:

clear()

Esvazia a pilha de eventos já registrados.


clearMethods()

Método deprecated. Utilize LegacyEvent.clear()

Deprecated:
  • Utilize #clear.

clone()

Cria uma cópia deste objeto, incluindo a pilha de eventos.

Returns:

Cópia deste objeto.

Type
LegacyEvent

dispatch()

Dispara o último evento adicionado através do método set. Os argumentos e o retorno deste método serão os argumentos e retorno da função ou método executado.

See:

dispatchWithParameterArray(params)

Dispara o último evento adicionado através do método set. Os itens do array informado serão passados como argumentos para a função ou método que será executado. O retorno deste método será o resultado desta execução.

Parameters:
Name Type Description
params Array

Array com os argumentos do evento que deve ser executado

See:

set(method)

Inclui na pilha de eventos uma função, método ou a chave de um script que os contenha. A última função ou método adicionada será a primeira a ser executada, tendo a possibilidade de chamar as definições anteriores através da função inherited(). Caso seja informada uma chave de script, ela será exibida no stack trace, após a string que indica que a origem do código foi um eval.

Parameters:
Name Type Description
method function | Method

Função ou método (instância da classe Method) que deve ser adicionada na pilha de eventos.

See:
  • Method