RepeaterButton

Kind of class:	class
Inherits from:	EventButton < EventMovieClip < MovieClip
Author:	Martijn de Visser
Classpath:	org.asapframework.ui.buttons.RepeaterButton
File last modified:	Tuesday, 03 October 2006, 00:52:15

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

import org.asapframework.ui.buttons.EventButtonEvent;
import org.asapframework.ui.buttons.EventButton;

/**
Use this class to create buttons that keep on firing {@link EventButtonEvent#ON_RELEASE} events while the mouse is down (for scrollbar buttons, for example).
@author Martijn de Visser
*/

class org.asapframework.ui.buttons.RepeaterButton extends EventButton {

    private static var DEFAULT_FRAME_NORMAL:String = "normal";
    private static var DEFAULT_FRAME_ROLLOVER:String = "rollover";
    private static var DEFAULT_FRAME_MOUSEDOWN:String = "mousedown";
    private static var DEFAULT_WAIT_TIMEOUT:Number = 200;
    private static var DEFAULT_REPEAT_TIMEOUT:Number = 50;
    
    private var mWaitInterval:Number;
    private var mRepeatInterval:Number;
    
    private var mWaitTimeOut:Number = DEFAULT_WAIT_TIMEOUT;
    private var mRepeatTimeOut:Number = DEFAULT_REPEAT_TIMEOUT;
    
    private var mFrameNormal:String = DEFAULT_FRAME_NORMAL;
    private var mFrameRollOver:String = DEFAULT_FRAME_ROLLOVER;
    private var mFrameMouseDown:String = DEFAULT_FRAME_MOUSEDOWN;

    public function RepeaterButton () {

        super();
        mMc.gotoAndStop(mFrameNormal);
    }

    public function onMouseUp () : Void {

        mMc.gotoAndStop(mFrameNormal);
        stopIntervals();
    }

    public function onRelease () : Void {

        super.onRelease();        
        mMc.gotoAndStop(mFrameRollOver);
        stopIntervals();
    }

    public function onReleaseOutside () : Void {

        super.onReleaseOutside();
        mMc.gotoAndStop(mFrameNormal);
        stopIntervals();
    }

    public function onRollOver () : Void {

        super.onRollOver();
        mMc.gotoAndStop(mFrameRollOver);
    }
    
    public function onRollOut () : Void {

        super.onRollOut();
        mMc.gotoAndStop(mFrameNormal);
    }

    public function onPress () : Void {
        super.onPress();
        mMc.gotoAndStop(mFrameMouseDown);
        mWaitInterval = setInterval(this, "onAutoFire", mWaitTimeOut);
    }

    private function onAutoFire () : Void {

        clearInterval(mWaitInterval);
        mRepeatInterval = setInterval(this, "fireEvent", mRepeatTimeOut);
    }
    
    public function toString () : String {
        return ";RepeaterButton: name = " + _name;
    }
    
    /**
    @sends EventButtonEvent#ON_RELEASE
    */
    private function fireEvent () : Void {
    
        dispatchEvent(new EventButtonEvent(EventButtonEvent.ON_RELEASE, this, _name));
    }


    private function stopIntervals () : Void {

        clearInterval(mWaitInterval);
        clearInterval(mRepeatInterval);
    }
}

Use this class to create buttons that keep on firing EventButtonEvent.ON_RELEASE events while the mouse is down (for scrollbar buttons, for example).

Summary

Constructor

RepeaterButton

Class properties

DEFAULT_FRAME_NORMAL : String
DEFAULT_FRAME_ROLLOVER : String
DEFAULT_FRAME_MOUSEDOWN : String
DEFAULT_WAIT_TIMEOUT : Number
DEFAULT_REPEAT_TIMEOUT : Number

Instance properties

mWaitInterval : Number
mRepeatInterval : Number
mWaitTimeOut : Number
mRepeatTimeOut : Number
mFrameNormal : String
mFrameRollOver : String
mFrameMouseDown : String

Instance properties inherited from EventButton

hitArea_mc mController mSendEventOnPress mSendEventOnRoll

Instance properties inherited from EventMovieClip

addEventListener dispatchEvent mMc removeEventListener

Instance methods

toString : String
fireEvent : Void
stopIntervals : Void

Instance methods inherited from EventButton

onDragOut onDragOver onLoad onPress onRelease onReleaseOutside onRollOut onRollOver onUnload setSendEventOnPress setSendEventOnRoll toString

Event handlers

onMouseUp : Void
onRelease : Void
onReleaseOutside : Void
onRollOver : Void
onRollOut : Void
onPress : Void
onAutoFire : Void

Event handlers inherited from EventButton

onDragOut onDragOver onLoad onPress onRelease onReleaseOutside onRollOut onRollOver onUnload

Constructor

RepeaterButton

function RepeaterButton (

)

Class properties

DEFAULT_FRAME_MOUSEDOWN

static private DEFAULT_FRAME_MOUSEDOWN:String = "mousedown"

(read)

DEFAULT_FRAME_NORMAL

static private DEFAULT_FRAME_NORMAL:String = "normal"

(read)

DEFAULT_FRAME_ROLLOVER

static private DEFAULT_FRAME_ROLLOVER:String = "rollover"

(read)

DEFAULT_REPEAT_TIMEOUT

static private DEFAULT_REPEAT_TIMEOUT:Number = 50

(read)

DEFAULT_WAIT_TIMEOUT

static private DEFAULT_WAIT_TIMEOUT:Number = 200

(read)

Instance properties

mFrameMouseDown

private mFrameMouseDown:String = DEFAULT_FRAME_MOUSEDOWN

(read)

mFrameNormal

private mFrameNormal:String = DEFAULT_FRAME_NORMAL

(read)

mFrameRollOver

private mFrameRollOver:String = DEFAULT_FRAME_ROLLOVER

(read)

mRepeatInterval

private mRepeatInterval:Number

(read)

mRepeatTimeOut

private mRepeatTimeOut:Number = DEFAULT_REPEAT_TIMEOUT

(read)

mWaitInterval

private mWaitInterval:Number

(read)

mWaitTimeOut

private mWaitTimeOut:Number = DEFAULT_WAIT_TIMEOUT

(read)

Instance methods

fireEvent

private function fireEvent (

) : Void

Events broadcasted to listeners:

EventButtonEvent with type: ON_RELEASE
- (null)

stopIntervals

private function stopIntervals (

) : Void

toString

function toString (

) : String

Overrides:

EventButton.toString

Event handlers

onAutoFire

private function onAutoFire (

) : Void

onMouseUp

function onMouseUp (

) : Void

onPress

function onPress (

) : Void

Overrides:

EventButton.onPress

onRelease

function onRelease (

) : Void

Overrides:

EventButton.onRelease

onReleaseOutside

function onReleaseOutside (

) : Void

Overrides:

EventButton.onReleaseOutside

onRollOut

function onRollOut (

) : Void

Overrides:

EventButton.onRollOut

onRollOver

function onRollOver (

) : Void

Overrides:

EventButton.onRollOver