Specifies a display object that is used as the visual object for the button "Down" state —the state that the button is in when the user selects the hitTestState object.

Related API Elements

A Boolean value that specifies whether a button is enabled. When a button is disabled (the enabled property is set to false), the button is visible but cannot be clicked. The default value is true. This property is useful if you want to disable part of your navigation; for example, you might want to disable a button in the currently displayed page so that it can't be clicked and the page cannot be reloaded.

Note: To prevent mouseClicks on a button, set both the enabled and mouseEnabled properties to false.

Specifies a display object that is used as the hit testing object for the button. For a basic button, set the hitTestState property to the same display object as the overState property. If you do not set the hitTestState property, the SimpleButton is inactive — it does not respond to user input events.

Related API Elements

Specifies a display object that is used as the visual object for the button over state — the state that the button is in when the pointer is positioned over the button.

Related API Elements

The SoundTransform object assigned to this button. A SoundTransform object includes properties for setting volume, panning, left speaker assignment, and right speaker assignment. This SoundTransform object applies to all states of the button. This SoundTransform object affects only embedded sounds.

Related API Elements

Indicates whether other display objects that are SimpleButton or MovieClip objects can receive user input release events. The trackAsMenu property lets you create menus. You can set the trackAsMenu property on any SimpleButton or MovieClip object. If the trackAsMenu property does not exist, the default behavior is false.

You can change the trackAsMenu property at any time; the modified button immediately takes on the new behavior.

Specifies a display object that is used as the visual object for the button up state — the state that the button is in when the pointer is not positioned over the button.

Related API Elements

A Boolean value that, when set to true, indicates whether the hand cursor is shown when the pointer rolls over a button. If this property is set to false, the arrow pointer cursor is displayed instead. The default is true.

You can change the useHandCursor property at any time; the modified button immediately uses the new cursor behavior.

Creates a new SimpleButton instance. Any or all of the display objects that represent the various button states can be set as parameters in the constructor.

1. In the SimpleButtonExample() constructor, a new CustomSimpleButton object of type SimpleButton, called button, is created, which calls the CustomSimpleButton constructor method. The button object is the added to the display list. The button's color and size are determined in the steps that follow.
2. In the CustomSimpleButton class, instance properties are declared that are later used to control the size and background color of button, based on the state it is in (orange in the normal state, dark yellow in the mouse over state, an light blue in the mouse down state). In all of the button's states, the size of the square is set to 80 pixels by using the size property.
3. The constructor function for the CustomSimpleButton class sets the downState, overState, upState, hitTestState, and useHandCursor properties with four instances of the ButtonDisplayState class.
4. In the ButtonDisplayState class, the constructor sets the value of the square's size and background color and calls the draw() method.
5. The draw() method redraws the square with the size and background color set in the constructor based on the button's state.

package {
    import flash.display.Sprite;

    public class SimpleButtonExample extends Sprite {
        public function SimpleButtonExample() {
            var button:CustomSimpleButton = new CustomSimpleButton();
            addChild(button);
        }
    }
}

import flash.display.DisplayObject;
import flash.display.Shape;
import flash.display.SimpleButton;

class CustomSimpleButton extends SimpleButton {
    private var upColor:uint   = 0xFFCC00;
    private var overColor:uint = 0xCCFF00;
    private var downColor:uint = 0x00CCFF;
    private var size:uint      = 80;

    public function CustomSimpleButton() {
        downState      = new ButtonDisplayState(downColor, size);
        overState      = new ButtonDisplayState(overColor, size);
        upState        = new ButtonDisplayState(upColor, size);
        hitTestState   = new ButtonDisplayState(upColor, size * 2);
        hitTestState.x = -(size / 4);
        hitTestState.y = hitTestState.x;
        useHandCursor  = true;
    }
}

class ButtonDisplayState extends Shape {
    private var bgColor:uint;
    private var size:uint;

    public function ButtonDisplayState(bgColor:uint, size:uint) {
        this.bgColor = bgColor;
        this.size    = size;
        draw();
    }

    private function draw():void {
        graphics.beginFill(bgColor);
        graphics.drawRect(0, 0, size, size);
        graphics.endFill();
    }
}