IRemovableEventDispatcher
Kind of class: | public interface |
---|---|
Package: | |
Inherits from: |
|
Implemented by: | |
Version: | 02/11/10 |
Author: | Aaron Clinger |
Classpath: | org.casalib.events.IRemovableEventDispatcher |
File last modified: | Friday, 20 May 2011, 00:59:43 |
► View source▼ Hide source
/*
CASA Lib for ActionScript 3.0
Copyright (c) 2011, Aaron Clinger & Contributors of CASA Lib
All rights reserved.
Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:
- Redistributions of source code must retain the above copyright notice,
this list of conditions and the following disclaimer.
- Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
- Neither the name of the CASA Lib nor the names of its contributors
may be used to endorse or promote products derived from this software
without specific prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
POSSIBILITY OF SUCH DAMAGE.
*/
package org.casalib.events {
import flash.events.IEventDispatcher;
/**
@author Aaron Clinger
@version 02/11/10
*/
public interface IRemovableEventDispatcher extends IEventDispatcher {
/**
Removes all events of a specific type.
@param type: The type of event.
*/
function removeEventsForType(type:String):void;
/**
Removes all events that report to the specified listener.
@param listener: The listener function that processes the event.
*/
function removeEventsForListener(listener:Function):void;
/**
Removes all event listeners.
*/
function removeEventListeners():void;
/**
Reports the number of listeners for a specific event or the total listeners for all events.
@param type: The name of event or null
for all events.
@return The number of listeners.
*/
function getTotalEventListeners(type:String = null):uint;
}
}
Summary
Instance methods
-
removeEventsForType
(type:String) : void
- Removes all events of a specific type.
-
removeEventsForListener
(listener:Function) : void
- Removes all events that report to the specified listener.
-
removeEventListeners
() : void
- Removes all event listeners.
-
getTotalEventListeners
(type:String = null) : uint
- Reports the number of listeners for a specific event or the total listeners for all events.
Instance methods
getTotalEventListeners
function getTotalEventListeners(type:String = null) : uint
Reports the number of listeners for a specific event or the total listeners for all events.
Parameters
type:The name of event or
null
for all events.
Returns
- The number of listeners.
removeEventListeners
function removeEventListeners() : void
Removes all event listeners.
removeEventsForListener
function removeEventsForListener(listener:Function) : void
Removes all events that report to the specified listener.
Parameters
listener:The listener function that processes the event.
removeEventsForType
function removeEventsForType(type:String) : void
Removes all events of a specific type.
Parameters
type:The type of event.