+Show TOC
×Hide TOC

DynBasicEvent

Kind of class:	public dynamic class
Package:	com.bourre.events
Inherits from:	BasicEvent < Event
Author:	Francis Bourre
Classpath:	com.bourre.events.DynBasicEvent
File last modified:	Monday, 24 November 2008, 11:36:53

► View source

▼ Hide source

/*
 * Copyright the original author or authors.
 * 
 * Licensed under the MOZILLA PUBLIC LICENSE, Version 1.1 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 * 
 *      http://www.mozilla.org/MPL/MPL-1.1.html
 * 
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package com.bourre.events
{
    import com.bourre.log.PixlibStringifier;        

    /**
     * The <code>DynBasicEvent</code> class extends the 
     * <code>BasicEvent</code> class and make it dynamic.
     * <p>
     * The <code>DynBasicEvent</code> class is used by 
     * the <code>EventBroadcaster.dispatchEvent</code>
     * function, which dispatch event using anonymous object,
     * the event object is then decorated with the object
     * properties and finally broadcasted as any other event
     * object. 
     * </p>
     * @author     Francis Bourre
     * @see        BasicEvent
     * @see        EventBroadcaster#dispatchEvent()
     */
    public dynamic class DynBasicEvent extends BasicEvent
    {
        /**
         * Creates a new <code>DynBasicEvent</code> event for the
         * passed-in event type. The <code>target</code> is optional, 
         * if the target is omitted and the event used in combination
         * with the <code>EventBroadcaster</code> class, the event
         * target will be set on the event broadcaster source.
         * 
         * @param    type    <code>String</code> name of the event
         * @param    target    an object considered as source for this event
         * @see        EventBroadcaster#dispatchEvent() The EventBroadcaster.dispatchEvent() method
         */
        public function DynBasicEvent( type : String, target : Object = null )
        {
            super( type, target );
        }
        
        /**
         * Returns the string representation of this instance.
         * 
         * @return the string representation of this instance
         */
        public override function toString() : String 
        {
            return PixlibStringifier.stringify( this );
        }
    }
}

The DynBasicEvent class extends the

BasicEvent class and make it dynamic.

The DynBasicEvent class is used by
the EventBroadcaster.dispatchEventfunction, which dispatch event using anonymous object,
the event object is then decorated with the object
properties and finally broadcasted as any other event
object.

Summary

Constructor

DynBasicEvent (type:String, target:Object = null)
- Creates a new DynBasicEvent event for the

Instance properties

Instance properties inherited from BasicEvent

_oTarget _sType target type

Instance methods

toString : String
- Returns the string representation of this instance.

Instance methods inherited from BasicEvent

clone getTarget getType setTarget setType toString

Constructor

DynBasicEvent

public function DynBasicEvent (

type:String, target:Object = null)

Creates a new DynBasicEvent event for the
passed-in event type. The target is optional,
if the target is omitted and the event used in combination
with the EventBroadcaster class, the event
target will be set on the event broadcaster source.

Parameters:

type :

String name of the event

target:

an object considered as source for this event

Instance methods

toString

override public function toString (

) : String

Returns the string representation of this instance.

Returns:

the string representation of this instance

Overrides:

BasicEvent.toString