+Show TOC
×Hide TOC

DynBasicEvent

Kind of class:	dynamic class
Inherits from:	BasicEvent
Known subclasses:	ChannelDynBasicEvent
Version:	1.0
Author:	Francis Bourre
Classpath:	com.bourre.events.DynBasicEvent
File last modified:	Wednesday, 31 October 2007, 07:35:29

► 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.
 */
 
/**
 * {@code DynBasicEvent} defines basic event structure for working with event as a classical 
 * {@code Object} structure.
 * 
 * <p>{@code DynBasicEvent} defines 2 main properties : 
 * <ul>
 *   <li>{@link #type} to get event name</li>
 *   <li>{@link #target} to get event target</li>
 * </ul>
 * 
 * <p>Using {@code DynBasicEvent} gives compatibility to send event throw Macromedia event API using
 * {@code EventDispatcher} broadcaster.
 * 
 * <p>{@link EventBroadcaster#dispatchEvent} use this structure to send Macromedia compatible event.
 * 
 * @author Francis Bourre
 * @version 1.0
 */

import com.bourre.events.BasicEvent;
import com.bourre.events.EventType;
import com.bourre.log.PixlibStringifier;

dynamic class com.bourre.events.DynBasicEvent extends BasicEvent
{
    //-------------------------------------------------------------------------
    // Public API
    //-------------------------------------------------------------------------
    
    /**
     * Constructs a new {@code DynBasicEvent} instance.
     * 
     * @param s Event name
     * @param oT Event target
     */
    public function DynBasicEvent(s:String, oT)
    {
        super( new EventType(s), oT);
    }
    
    /**
     * Returns event type (event name).
     * 
     * <p>Example
     * <code>
     *   var o : EventType = e.type;
     * </code>
     * 
     * @return {@code String} event name
     */
    public function get type() : String 
    { 
        return _e.toString(); 
    }
    
    /**
     * Defines event type (event name).
     * 
     * <p>Example
     * <code>
     *   e.type = MyClass.onSomething;
     * </code>
     * 
     * @param e  {@code String} event name.
     */
    public function set type(s:String) : Void
    { 
        _e = new EventType(s); 
    }
    
    /**
     * Returns event target.
     * 
     * <p>Example
     * <code>
     *   var o = e.target;
     * </code>
     * 
     * @return event target
     */
    public function get target() : Object 
    { 
        return _oT; 
    }
    
    /**
     * Defines event target.
     * 
     * <p>Example
     * <code>
     *   e.target = this;
     * </code>
     * 
     * @param event target
     */
    public function set target(oT) : Void 
    { 
        _oT = oT; 
    }
    
    /**
     * Returns the string representation of this instance.
     * 
     * @return {@code String} representation of this instance
     */
    public function toString() : String
    {
        return PixlibStringifier.stringify( this ) + ' : ' + this.type;
    }
}

DynBasicEvent defines basic event structure for working with event as a classical
Object structure.

DynBasicEvent defines 2 main properties :

type to get event name
target to get event target

Using DynBasicEvent gives compatibility to send event throw Macromedia event API using
EventDispatcher broadcaster.

EventBroadcaster.dispatchEvent use this structure to send Macromedia compatible event.

Summary

Constructor

DynBasicEvent

Instance properties

type
target
target

Instance properties inherited from BasicEvent

_e _oT

Instance methods

toString

Instance methods inherited from BasicEvent

getTarget getType setTarget setType toString

Constructor

DynBasicEvent

function DynBasicEvent (

s:String)

Constructs a new DynBasicEvent instance.

Parameters:

s :

Event name

oT:

Event target

Instance properties

target

target:Object

(read)

Returns event target.

Example

var o = e.target;

Returns:

event target

target

target:Void

(write)

Defines event target.

Example

e.target = this;

Parameters:

event:

target

type

type:String

(read,write)

Returns event type (event name).

Example

var o : EventType = e.type;

Defines event type (event name).

Example

e.type = MyClass.onSomething;

Parameters:

String event name.

Returns:

String event name

Instance methods

toString

function toString (

) : String

Returns the string representation of this instance.

Returns:

String representation of this instance

Overrides:

BasicEvent.toString