+Show TOC
×Hide TOC

BasicEvent

Kind of class:	class
Inherits from:	none
Implements:	IEvent
Known subclasses:	BasicFaultEvent BasicResultEvent BooleanEvent BubbleEvent DataRequestEvent DynBasicEvent GraphicLibLocatorEvent LibEvent LogEvent NumberEvent PointEvent StringEvent TweenEvent
Version:	1.0
Author:	Francis Bourre
Classpath:	com.bourre.events.BasicEvent
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 BasicEvent} is the basical event structure to work with {@link EventBroadcaster}.
 * 
 * <p>Give basic methods for all event sub classes like : 
 * <ul>
 *   <li>{@link #setType} to define event name</li>
 *   <li>{@link #getType} to retreive event name</li>
 *   <li>{@link #setTarget} to define event source</li>
 *   <li>{@link #getTarget} to retreive event source</li>
 * </ul>
 * 
 * <p>Extends {@code BasicEvent} class to define proper event structure for 
 * our development using Pixlib Event API.
 * For example, take a look at {@link BooleanEvent} which define specific event 
 * structure to retreive {@code Boolean} value or {@link com.bourre.transitions.TweenEvent} 
 * for a more complex {@code BasicEvent} extension case.
 * 
 * <p>Works with {@link EventType} class to properly define event name. 
 * 
 * <p>Example
 * <code>
 *   var e : BasicEvent = new BasicEvent( MyClass.onSomething, this);
 * </code>
 * 
 * @author Francis Bourre
 * @version 1.0
 */
import com.bourre.events.EventType;
import com.bourre.events.IEvent;
import com.bourre.log.PixlibStringifier;

class com.bourre.events.BasicEvent
    implements IEvent
{
    //-------------------------------------------------------------------------
    // Private properties
    //-------------------------------------------------------------------------
    
    private var _e:EventType;
    private var _oT;
    
    
    //-------------------------------------------------------------------------
    // Public API
    //-------------------------------------------------------------------------
    
    /**
     * Constructs a new {@code BasicEvent} instance.
     * 
     * <p>Example
     * <code>
     *   var e : BasicEvent = new BasicEvent( MyClass.onSomething, this);
     * </code>
     * 
     * @param e an {@link EventType} instance (event name).
     * @param oT event target.
     */
    public function BasicEvent(e:EventType, oT) 
    {
        _e = e;
        _oT = oT;
    }
    
    /**
     * Returns event type (name).
     * 
     * <p>Example
     * <code>
     *   var e : BasicEvent = new BasicEvent( MyClass.onSomething, this);
     *   var t : EventType = e.getType();
     * </code>
     * 
     * @return an {@link EventType} instance
     */
    public function getType() : EventType
    { 
        return _e; 
    }
    
    /**
     * Defines event type (name).
     * <p>Example
     * <code>
     *   var e : BasicEvent = new BasicEvent( null, this);
     *   e.setType( MyClass.onSomething );
     * </code>
     * 
     * @param e an {@link EventType} instance.
     */
    public function setType(e:EventType) : Void 
    { 
        _e = e; 
    }
    
    /**
     * Returns event target (usually event source).
     * 
     * <p>Example
     * <code>
     *   var e : BasicEvent = new BasicEvent( myClass.onSomething, this);
     *   var t = e.getTarget();
     * </code>
     * 
     * @return event target
     */
    public function getTarget()
    { 
        return _oT; 
    }
    
    /**
     * Defines event target.
     * 
     * <p>Example
     * <code>
     *   var e : BasicEvent = new BasicEvent( myClass.onSomething, null);
     *   e.setTarget(this);
     * </code>
     * 
     * @param oT event target
     */
    public function setTarget(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 ) + ' : ' + getType();
    }
}

BasicEvent is the basical event structure to work with EventBroadcaster.

Give basic methods for all event sub classes like :

setType to define event name
getType to retreive event name
setTarget to define event source
getTarget to retreive event source

Extends BasicEvent class to define proper event structure for
our development using Pixlib Event API.
For example, take a look at BooleanEvent which define specific event
structure to retreive Boolean value or com.bourre.transitions.TweenEvent
for a more complex BasicEvent extension case.

Works with EventType class to properly define event name.

Example

var e : BasicEvent = new BasicEvent( MyClass.onSomething, this);

Summary

Constructor

BasicEvent

Instance methods

getType
setType
getTarget
setTarget
toString

Constructor

BasicEvent

function BasicEvent (

e:EventType)

Constructs a new BasicEvent instance.

Example

var e : BasicEvent = new BasicEvent( MyClass.onSomething, this);

Parameters:

e :

an EventType instance (event name).

oT:

event target.

Instance methods

getTarget

function getTarget (

)

Returns event target (usually event source).

Example

var e : BasicEvent = new BasicEvent( myClass.onSomething, this);
var t = e.getTarget();

Returns:

event target

Specified by:

IEvent.getTarget

getType

function getType (

) : EventType

Returns event type (name).

Example

var e : BasicEvent = new BasicEvent( MyClass.onSomething, this);
var t : EventType = e.getType();

Returns:

an EventType instance

Specified by:

IEvent.getType

setTarget

function setTarget (

) : Void

Defines event target.

Example

var e : BasicEvent = new BasicEvent( myClass.onSomething, null);
e.setTarget(this);

Parameters:

oT:

event target

Specified by:

IEvent.setTarget

setType

function setType (

e:EventType) : Void

Defines event type (name).

Example

var e : BasicEvent = new BasicEvent( null, this);
e.setType( MyClass.onSomething );

Parameters:

an EventType instance.

Specified by:

IEvent.setType

toString

function toString (

) : String

Returns the string representation of this instance.

Returns:

String representation of this instance