+Show TOC
×Hide TOC

PointEvent

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

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

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

PointEvent defines specific event structure to work with
com.bourre.structures.Point instance.

Based on BasicEvent class, PointEvent add access
to his specific com.bourre.structures.Point property with
getPoint and setPoint methods.

Summary

Constructor

PointEvent

Instance properties

Instance properties inherited from BasicEvent

_e _oT

Instance methods

getPoint
setPoint
toString

Instance methods inherited from BasicEvent

getTarget getType setTarget setType toString

Constructor

PointEvent

function PointEvent (

e:EventType, p:Point)

Constructs a new PointEvent instance.

Example

var e : PointEvent = new PointEvent(MyClass.onSomething, new Point(10,2) );

Parameters:

an EventType instance (event name).

a com.bourre.structures.Point instance

Instance methods

getPoint

function getPoint (

) : Point

Returns instance com.bourre.structures.Point value.

Example

var e : PointEvent = new PointEvent(MyClass.onSomething, new Point(10,2) );
trace( e.getPoint() );

Returns:

a com.bourre.structures.Point instance

setPoint

function setPoint (

p:Point) : Void

Defines instance com.bourre.structures.Point value.

Example

var e : PointEvent = new PointEvent(MyClass.onSomething);
e.setPoint( new Point(10,2) );

Parameters:

com.bourre.structures.Point value

toString

function toString (

) : String

Returns the string representation of this instance.

Returns:

String representation of this instance

Overrides:

BasicEvent.toString