ButtonBehavior

Kind of class: public class
Package:
Inherits from:
  • EventDispatcher
Known subclasses:
Classpath: org.asaplibrary.ui.buttons.ButtonBehavior
File last modified: Wednesday, 11 May 2011, 18:43:17
Delegate class to manage button states (mouse over, selected, enabled, etcetera) to free the button class from state management and let it just do the drawing of its mouse states. This also makes mouse behaviour pluggable - see for instance DelayButtonBehavior for a time-oriented delegate.
Example
  • This example shows how to set up a button class that receives its update changes from its delegate: 
    import flash.display.MovieClip;
import org.asaplibrary.ui.buttons.*;

public class MyButton extends MovieClip {

private var mDelegate:ButtonBehavior;
    
public var tBorder:MovieClip; // a border clip shows the button state
public function MyButton () {
mDelegate = new ButtonBehavior(this);
// listen for changes
// button updates will be redirected to method 'update':
mDelegate.addEventListener(ButtonBehaviorEvent._EVENT, update);
}
    
// pass any button change setter state to the delegate
public function select (inState:Boolean) : void {
mDelegate.select(inState);
}
    
private function update (e:ButtonBehaviorEvent) : void {
switch (e.state) {
case ButtonStates.SELECTED:
case ButtonStates.OVER:
tBorder.visible = true;
break;
case ButtonStates.NORMAL:
case ButtonStates.OUT:
case ButtonStates.DESELECTED:
tBorder.visible = false;
break;
default:
tBorder.visible = false;
}
buttonMode = e.enabled;
}
}
Events broadcasted to listeners

Summary

Constructor
Instance methods
  • select (inState:Boolean) : void
    • /
  • enable (inState:Boolean) : void
    • Pass the enabled state from the button to the delegate.

Constructor

ButtonBehavior

function ButtonBehavior(inButton:MovieClip)

Creates a new delegate object.

Parameters
inButton:the owner button
To do
  • Implement CLICK, DOUBLE_CLICK, MOUSE_WHEEL (if necessary)

Instance methods

enable

function enable(inState:Boolean) : void

Pass the enabled state from the button to the delegate.

Parameters
inState:the enabled button state

select

function select(inState:Boolean) : void

/ override public function toString() : String { return getQualifiedClassName(this); } / Pass the selected state from the button to the delegate.

Parameters
inState:the selected button state