+Show TOC
×Hide TOC

NumberEvent

Kind of class:	class
Inherits from:	BasicEvent
Version:	1.0
Author:	Francis Bourre
Classpath:	com.bourre.events.NumberEvent
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 NumberEvent} defines specific event structure to work with
 * {@code Number} value.
 * 
 * <p>Based on {@link BasicEvent} class, {@code NumberEvent} add access 
 * to his specific {@code Number} property with {@link #getNumber} and 
 * {@link #setNumber} methods.
 * 
 * @author Francis Bourre
 * @version 1.0
 */

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

class com.bourre.events.NumberEvent extends BasicEvent
{
    //-------------------------------------------------------------------------
    // Private properties
    //-------------------------------------------------------------------------
    
    private var _n:Number;
    
    
    //-------------------------------------------------------------------------
    // Public API
    //-------------------------------------------------------------------------
    
    /**
     * Constructs a new {@code NumberEvent} instance.
     * 
     * <p>Example
     * <code>
     *   var e : NumberEvent = new NumberEvent(MyClass.onSomething, 10);
     * </code>
     * 
     * @param e an {@link EventType} instance (event name).
     * @param n a {@code Number} value
     */
    public function NumberEvent(e:EventType, n:Number)
    {
        super(e);
        _n = n;
    }
    
    /**
     * Returns instance {@code Number} value.
     * 
     * <p>Example
     * <code>
     *   var e : NumberEvent = new NumberEvent(MyClass.onSomething, 10);
     *   trace( e.getNumber() ); //return 10
     * </code>
     * 
     * @return a {@code Number} value
     */
    public function getNumber() : Number
    {
        return _n;
    }
    
    /**
     * Defines instance {@code Number} value.
     * 
     * <p>Example
     * <code>
     *   var e : NumberEvent = new NumberEvent(MyClass.onSomething);
     *   e.setNumber(10);
     * </code>
     * 
     * @param n {@code Number} value
     */
    public function setNumber(n:Number) : Void
    {
        _n = n;
    }
    
    /**
     * Returns the string representation of this instance.
     * 
     * @return {@code String} representation of this instance
     */
    public function toString() : String
    {
        return PixlibStringifier.stringify( this ) + ' : ' + getType() + ', ' + getNumber();
    }
}

NumberEvent defines specific event structure to work with
Number value.

Based on BasicEvent class, NumberEvent add access
to his specific Number property with getNumber and
setNumber methods.

Summary

Constructor

NumberEvent

Instance properties

Instance properties inherited from BasicEvent

_e _oT

Instance methods

getNumber
setNumber
toString

Instance methods inherited from BasicEvent

getTarget getType setTarget setType toString

Constructor

NumberEvent

function NumberEvent (

e:EventType, n:Number)

Constructs a new NumberEvent instance.

Example

var e : NumberEvent = new NumberEvent(MyClass.onSomething, 10);

Parameters:

an EventType instance (event name).

a Number value

Instance methods

getNumber

function getNumber (

) : Number

Returns instance Number value.

Example

var e : NumberEvent = new NumberEvent(MyClass.onSomething, 10);
trace( e.getNumber() ); //return 10

Returns:

a Number value

setNumber

function setNumber (

n:Number) : Void

Defines instance Number value.

Example

var e : NumberEvent = new NumberEvent(MyClass.onSomething);
e.setNumber(10);

Parameters:

Number value

toString

function toString (

) : String

Returns the string representation of this instance.

Returns:

String representation of this instance

Overrides:

BasicEvent.toString