+Show TOC
×Hide TOC

BooleanEvent

Kind of class:	class
Inherits from:	BasicEvent
Version:	1.0
Author:	Francis Bourre
Classpath:	com.bourre.events.BooleanEvent
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 BooleanEvent} defines specific event structure to work with
 * {@code Boolean} value.
 * 
 * <p>Based on {@link BasicEvent} class, {@code BooleanEvent} add access 
 * to his specific {@code Boolean} property with {@link #getBoolean} and 
 * {@link #setBoolean} 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.BooleanEvent extends BasicEvent
{
    //-------------------------------------------------------------------------
    // Private properties
    //-------------------------------------------------------------------------
    
    private var _b:Boolean;
    
    
    //-------------------------------------------------------------------------
    // Public API
    //-------------------------------------------------------------------------
    
    /**
     * Constructs a new {@code BooleanEvent} instance.
     * 
     * <p>Example
     * <code>
     *   var e : BooleanEvent = new BooleanEvent(MyClass.onSomething, true);
     * </code>
     * 
     * @param e an {@link EventType} instance (event name).
     * @param b a {@code Boolean} value
     */
    public function BooleanEvent(e:EventType, b:Boolean)
    {
        super(e);
        _b = b;
    }
    
    /**
     * Returns instance {@code Boolean} value.
     * 
     * <p>Example
     * <code>
     *   var e : BooleanEvent = new BooleanEvent(MyClass.onSomething, true);
     *   trace( e.getBoolean() ); //return true
     * </code>
     * 
     * @return a {@code Boolean} value
     */
    public function getBoolean() : Boolean
    {
        return _b;
    }
    
    /**
     * Defines instance {@code Boolean} value.
     * 
     * <p>Example
     * <code>
     *   var e : BooleanEvent = new BooleanEvent(MyClass.onSomething);
     *   e.setBoolean(false);
     * </code>
     * 
     * @param b {@code Boolean} value
     */
    public function setBoolean(b:Boolean) : Void
    {
        _b = b;
    }
    
    /**
     * Indicates if {@code Boolean} instance property is {@code true} 
     * or {@code false}
     * 
     * <p>Example
     * <code>
     *   var e : BooleanEvent = new BooleanEvent(MyClass.onSomething, true);
     *   trace( e.isTrue() ); //return true;
     * </code>
     * 
     * @return {@code true} if instance {@code Boolean} is true, either {@code false}
     */
    public function get isTrue() : Boolean
    {
        return _b;
    }
    
    /**
     * Returns the string representation of this instance.
     * 
     * @return {@code String} representation of this instance
     */
    public function toString() : String
    {
        return PixlibStringifier.stringify( this ) + ' : ' + getType() + ', ' + getBoolean();
    }
}

BooleanEvent defines specific event structure to work with
Boolean value.

Based on BasicEvent class, BooleanEvent add access
to his specific Boolean property with getBoolean and
setBoolean methods.

Summary

Constructor

BooleanEvent

Instance properties

isTrue

Instance properties inherited from BasicEvent

_e _oT

Instance methods

getBoolean
setBoolean
toString

Instance methods inherited from BasicEvent

getTarget getType setTarget setType toString

Constructor

BooleanEvent

function BooleanEvent (

e:EventType, b:Boolean)

Constructs a new BooleanEvent instance.

Example

var e : BooleanEvent = new BooleanEvent(MyClass.onSomething, true);

Parameters:

an EventType instance (event name).

a Boolean value

Instance properties

isTrue

isTrue:Boolean

(read)

Indicates if Boolean instance property is true
or false

Example

var e : BooleanEvent = new BooleanEvent(MyClass.onSomething, true);
trace( e.isTrue() ); //return true;

Returns:

true if instance Boolean is true, either false

Instance methods

getBoolean

function getBoolean (

) : Boolean

Returns instance Boolean value.

Example

var e : BooleanEvent = new BooleanEvent(MyClass.onSomething, true);
trace( e.getBoolean() ); //return true

Returns:

a Boolean value

setBoolean

function setBoolean (

b:Boolean) : Void

Defines instance Boolean value.

Example

var e : BooleanEvent = new BooleanEvent(MyClass.onSomething);
e.setBoolean(false);

Parameters:

Boolean value

toString

function toString (

) : String

Returns the string representation of this instance.

Returns:

String representation of this instance

Overrides:

BasicEvent.toString