+Show TOC
×Hide TOC

Top
Summary
Constructors
Instance properties
Instance methods
Event handlers

×Hide private members
+Show private members

EventButton

Kind of class:	class
Inherits from:	EventMovieClip < MovieClip
Known subclasses:	CheckBox DelayButton HilightButton RadioButton RepeaterButton RetroHilightButton
Author:	Stephan Bezoen
Classpath:	org.asapframework.ui.buttons.EventButton
File last modified:	Monday, 09 October 2006, 00:41:07

► View source

▼ Hide source

/*
Copyright 2005-2006 by the authors of asapframework, http://asapframework.org

Licensed under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0

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.
*/

// ASAP classes
import org.asapframework.management.movie.MovieManager;
import org.asapframework.management.movie.LocalController;
import org.asapframework.ui.buttons.EventButtonEvent;

/**
Default button, will automatically make the nearest {@link org.asapframework.management.movie.LocalController LocalController} listen to its events. Unregisters with LocalController on unload.
@author Stephan Bezoen
*/
class org.asapframework.ui.buttons.EventButton extends org.asapframework.ui.EventMovieClip {
    
    private var hitArea_mc:MovieClip;
    private var mController:LocalController = null;
    private var mSendEventOnRoll:Boolean = false;
    private var mSendEventOnPress:Boolean = false;

    /**
    
    */
    public function EventButton () {
        super();
    }

    /**
    
    */
    public function setSendEventOnRoll (inSend:Boolean) : Void {
        mSendEventOnRoll = inSend;
    }

    /**
    
    */
    public function setSendEventOnPress (inSend:Boolean) : Void {
        mSendEventOnPress = inSend;
    }

    /**
    
    */
    public function toString () : String {
        return ";EventButton: name = " + _name;
    }
    
    // EVENTS
    
        /**
    @sends EventButtonEvent#ON_ROLLOVER
    */
    public function onRollOver () : Void {
        
        if (mSendEventOnRoll && enabled) {
            dispatchEvent(new EventButtonEvent(EventButtonEvent.ON_ROLLOVER, this, _name));
        }
    }

    public function onDragOver () : Void {
        onRollOver();
    }

    /**
    @sends EventButtonEvent#ON_ROLLOUT
    */
    public function onRollOut () : Void {
        if (mSendEventOnRoll && enabled) {
            dispatchEvent(new EventButtonEvent(EventButtonEvent.ON_ROLLOUT, this, _name));
        }
    }

    public function onDragOut () : Void {
        onRollOut();
    }

    /**
    @sends EventButtonEvent#ON_PRESS
    */
    public function onPress () : Void {
        if (mSendEventOnPress) {
            dispatchEvent(new EventButtonEvent(EventButtonEvent.ON_PRESS, this, _name));
        }
    }

    /**
    @sends EventButtonEvent#ON_RELEASE
    */
    public function onRelease () : Void {
        dispatchEvent(new EventButtonEvent(EventButtonEvent.ON_RELEASE, this, _name));
    }

    public function onReleaseOutside () : Void {
        //
    }

    // PRIVATE METHODS
    
    /**
    
    */
    private function onLoad () : Void {
        mController = MovieManager.getInstance().getNearestLocalController(this);

        if (mController != null) {
            addEventListener(EventButtonEvent.ON_ROLLOVER, mController);
            addEventListener(EventButtonEvent.ON_ROLLOUT, mController);
            addEventListener(EventButtonEvent.ON_PRESS, mController);
            addEventListener(EventButtonEvent.ON_RELEASE, mController);
        }

        hitArea = hitArea_mc;
        hitArea_mc._visible = false;
    }

    /**
    
    */
    private function onUnload () : Void {
        if (mController != null) {
            removeEventListener(EventButtonEvent.ON_ROLLOVER, mController);
            removeEventListener(EventButtonEvent.ON_ROLLOUT, mController);
            removeEventListener(EventButtonEvent.ON_PRESS, mController);
            removeEventListener(EventButtonEvent.ON_RELEASE, mController);
        }
    }
}

Default button, will automatically make the nearest LocalController listen to its events. Unregisters with LocalController on unload.

Events broadcasted to listeners:

EventButtonEvent with type: ON_ROLLOVER
- (null)
EventButtonEvent with type: ON_ROLLOUT
- (null)
EventButtonEvent with type: ON_PRESS
- (null)
EventButtonEvent with type: ON_RELEASE
- (null)

Summary

Constructor

EventButton

Instance properties

hitArea_mc : MovieClip
mController : LocalController
mSendEventOnRoll : Boolean
mSendEventOnPress : Boolean

Instance properties inherited from EventMovieClip

addEventListener dispatchEvent mMc removeEventListener

Instance methods

setSendEventOnRoll (inSend:Boolean) : Void
setSendEventOnPress (inSend:Boolean) : Void
toString : String

Event handlers

onRollOver : Void
onDragOver : Void
onRollOut : Void
onDragOut : Void
onPress : Void
onRelease : Void
onReleaseOutside : Void
onLoad : Void
onUnload : Void

Constructor

EventButton

function EventButton (

)

Instance properties

hitArea_mc

private hitArea_mc:MovieClip

(read)

mController

private mController:LocalController = null

(read)

mSendEventOnPress

private mSendEventOnPress:Boolean = false

(read)

mSendEventOnRoll

private mSendEventOnRoll:Boolean = false

(read)

Instance methods

setSendEventOnPress

function setSendEventOnPress (

inSend:Boolean) : Void

setSendEventOnRoll

function setSendEventOnRoll (

inSend:Boolean) : Void

toString

function toString (

) : String

Event handlers

onDragOut

function onDragOut (

) : Void

onDragOver

function onDragOver (

) : Void

onLoad

private function onLoad (

) : Void

onPress

function onPress (

) : Void

Events broadcasted to listeners:

EventButtonEvent with type: ON_PRESS
- (null)

onRelease

function onRelease (

) : Void

Events broadcasted to listeners:

EventButtonEvent with type: ON_RELEASE
- (null)

onReleaseOutside

function onReleaseOutside (

) : Void

onRollOut

function onRollOut (

) : Void

Events broadcasted to listeners:

EventButtonEvent with type: ON_ROLLOUT
- (null)

onRollOver

function onRollOver (

) : Void

Events broadcasted to listeners:

EventButtonEvent with type: ON_ROLLOVER
- (null)

onUnload

private function onUnload (

) : Void