+Show TOC
×Hide TOC

ValueObjectEvent

Kind of class:	public class
Package:	com.bourre.events
Inherits from:	BasicEvent < Event
Known subclasses:	PluginEvent
Author:	Francis Bourre
Classpath:	com.bourre.events.ValueObjectEvent
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 flash.events.Event;        

    /**
     * An event object which carry a value object.
     * 
     * @author    Francis Bourre
     * @see        BasicEvent
     * @see        ValueObject
     */
    public class ValueObjectEvent extends BasicEvent
    {
        protected var _o : ValueObject;
        
        /**
         * Creates a new <code>ValueObjectEvent</code> object.
         * 
         * @param    type    name of the event type
         * @param    target    target of this event
         * @param    obj        value object carried by this event
         */
        public function ValueObjectEvent( type : String, target : Object = null, obj : ValueObject = null )
        {
            super( type, target );
            _o = obj;
        }
        
        /**
         * Returns the value object carried by this event.
         * 
         * @return    the value object carried by this event.
         */
        public function getValueObject() : ValueObject
        {
            return _o;
        }
        
        /**
         * Clone the event
         * 
         * @return    a clone of the event
         */
        override public function clone() : Event
        {
            return new ValueObjectEvent(type, target, _o);
        }
    }
}

An event object which carry a value object.

Summary

Constructor

ValueObjectEvent (type:String, target:Object = null, obj:ValueObject = null)
- Creates a new ValueObjectEvent object.

Instance properties

Instance properties inherited from BasicEvent

_oTarget _sType target type

Instance methods

getValueObject : ValueObject
- Returns the value object carried by this event.
clone : Event
- Clone the event

Instance methods inherited from BasicEvent

clone getTarget getType setTarget setType toString

Constructor

ValueObjectEvent

public function ValueObjectEvent (

type:String, target:Object = null, obj:ValueObject = null)

Creates a new ValueObjectEvent object.

Parameters:

type :

name of the event type

target:

target of this event

obj :

value object carried by this event

Instance methods

clone

override public function clone (

) : Event

Clone the event

Returns:

a clone of the event

Overrides:

BasicEvent.clone

getValueObject

public function getValueObject (

) : ValueObject

Returns the value object carried by this event.

Returns:

the value object carried by this event.