Package | flash.display |
Class | public class SimpleButton |
Inheritance | SimpleButton InteractiveObject DisplayObject EventDispatcher Object |
Subclasses | FlexSimpleButton |
Language Version: | ActionScript 3.0 |
Runtime Versions: | AIR 1.0, Flash Player 9, Flash Lite 4 |
In Flash Professional, you can give a button an instance name in the Property inspector. SimpleButton instance names are displayed in the Movie Explorer and in the Insert Target Path dialog box in the Actions panel. After you create an instance of a button in Flash Professional, you can use the methods and properties of the SimpleButton class to manipulate buttons with ActionScript.
In ActionScript 3.0, you use the new SimpleButton()
constructor to create a
SimpleButton instance.
The SimpleButton class inherits from the InteractiveObject class.
Starting with Player version 11.2 / AIR version 3.2, the parent
property
of the states of a SimpleButton
object will report null
if queried.
Learn more
Related API Elements
Property | Defined By | ||
---|---|---|---|
accessibilityImplementation : AccessibilityImplementation
The current accessibility implementation (AccessibilityImplementation)
for this InteractiveObject instance. | InteractiveObject | ||
accessibilityProperties : AccessibilityProperties
The current accessibility options for this display object. | DisplayObject | ||
alpha : Number
Indicates the alpha transparency value of the object specified. | DisplayObject | ||
blendMode : String
A value from the BlendMode class that specifies which blend mode to use. | DisplayObject | ||
blendShader : Shader [write-only]
Sets a shader that is used for blending the foreground and background. | DisplayObject | ||
cacheAsBitmap : Boolean
If set to true, Flash runtimes cache an internal bitmap representation of the
display object. | DisplayObject | ||
cacheAsBitmapMatrix : Matrix
If non-null, this Matrix object defines how a display object is rendered when
cacheAsBitmap is set to true. | DisplayObject | ||
constructor : Object
A reference to the class object or constructor function for a given object instance. | Object | ||
contextMenu : NativeMenu
Specifies the context menu associated with this object. | InteractiveObject | ||
doubleClickEnabled : Boolean
Specifies whether the object receives doubleClick events. | InteractiveObject | ||
downState : DisplayObject
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. | SimpleButton | ||
enabled : Boolean
A Boolean value that specifies whether a button is enabled. | SimpleButton | ||
filters : Array
An indexed array that contains each filter object currently associated with the display object. | DisplayObject | ||
focusRect : Object
Specifies whether this object displays a focus rectangle. | InteractiveObject | ||
height : Number
Indicates the height of the display object, in pixels. | DisplayObject | ||
hitTestState : DisplayObject
Specifies a display object that is used as the hit testing object for the button. | SimpleButton | ||
loaderInfo : LoaderInfo [read-only]
Returns a LoaderInfo object containing information about loading the file
to which this display object belongs. | DisplayObject | ||
mask : DisplayObject
The calling display object is masked by the specified mask object. | DisplayObject | ||
metaData : Object
Obtains the meta data object of the DisplayObject instance if meta data was stored alongside the
the instance of this DisplayObject in the SWF file through a PlaceObject4 tag. | DisplayObject | ||
mouseEnabled : Boolean
Specifies whether this object receives mouse, or other user input, messages. | InteractiveObject | ||
mouseX : Number [read-only]
Indicates the x coordinate of the mouse or user input device position, in pixels. | DisplayObject | ||
mouseY : Number [read-only]
Indicates the y coordinate of the mouse or user input device position, in pixels. | DisplayObject | ||
name : String
Indicates the instance name of the DisplayObject. | DisplayObject | ||
needsSoftKeyboard : Boolean
Specifies whether a virtual keyboard (an on-screen, software keyboard) should display
when this InteractiveObject instance receives focus. | InteractiveObject | ||
opaqueBackground : Object
Specifies whether the display object is opaque with a certain background color. | DisplayObject | ||
overState : DisplayObject
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. | SimpleButton | ||
parent : DisplayObjectContainer [read-only]
Indicates the DisplayObjectContainer object that contains this display object. | DisplayObject | ||
root : DisplayObject [read-only]
For a display object in a loaded SWF file, the root property is the
top-most display object in the portion of the display list's tree structure represented by that SWF file. | DisplayObject | ||
rotation : Number
Indicates the rotation of the DisplayObject instance, in degrees, from its original orientation. | DisplayObject | ||
rotationX : Number
Indicates the x-axis rotation of the DisplayObject instance, in degrees, from its original orientation relative to the 3D parent container. | DisplayObject | ||
rotationY : Number
Indicates the y-axis rotation of the DisplayObject instance, in degrees, from its original orientation relative to the 3D parent container. | DisplayObject | ||
rotationZ : Number
Indicates the z-axis rotation of the DisplayObject instance, in degrees, from its original orientation relative to the 3D parent container. | DisplayObject | ||
scale9Grid : Rectangle
The current scaling grid that is in effect. | DisplayObject | ||
scaleX : Number
Indicates the horizontal scale (percentage) of the object as applied from the registration point. | DisplayObject | ||
scaleY : Number
Indicates the vertical scale (percentage) of an object as applied from the registration point of the object. | DisplayObject | ||
scaleZ : Number
Indicates the depth scale (percentage) of an object as applied from the registration point of the object. | DisplayObject | ||
scrollRect : Rectangle
The scroll rectangle bounds of the display object. | DisplayObject | ||
softKeyboard : String
Controls the appearance of the soft keyboard. | InteractiveObject | ||
softKeyboardInputAreaOfInterest : Rectangle
Defines the area that should remain on-screen when a soft keyboard is displayed (not available on iOS). | InteractiveObject | ||
soundTransform : flash.media:SoundTransform
The SoundTransform object assigned to this button. | SimpleButton | ||
stage : Stage [read-only]
The Stage of the display object. | DisplayObject | ||
tabEnabled : Boolean
Specifies whether this object is in the tab order. | InteractiveObject | ||
tabIndex : int
Specifies the tab ordering of objects in a SWF file. | InteractiveObject | ||
trackAsMenu : Boolean
Indicates whether other display objects that are SimpleButton or MovieClip objects can receive
user input release events. | SimpleButton | ||
transform : flash.geom:Transform
An object with properties pertaining to a display object's matrix, color transform, and pixel bounds. | DisplayObject | ||
upState : DisplayObject
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. | SimpleButton | ||
useHandCursor : Boolean
A Boolean value that, when set to true, indicates whether
the hand cursor is shown when the pointer rolls over a button. | SimpleButton | ||
visible : Boolean
Whether or not the display object is visible. | DisplayObject | ||
width : Number
Indicates the width of the display object, in pixels. | DisplayObject | ||
x : Number
Indicates the x coordinate of the DisplayObject instance relative to the local coordinates of
the parent DisplayObjectContainer. | DisplayObject | ||
y : Number
Indicates the y coordinate of the DisplayObject instance relative to the local coordinates of
the parent DisplayObjectContainer. | DisplayObject | ||
z : Number
Indicates the z coordinate position along the z-axis of the DisplayObject
instance relative to the 3D parent container. | DisplayObject |
Method | Defined By | ||
---|---|---|---|
SimpleButton(upState:DisplayObject = null, overState:DisplayObject = null, downState:DisplayObject = null, hitTestState:DisplayObject = null)
Creates a new SimpleButton instance. | SimpleButton | ||
addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void
Registers an event listener object with an EventDispatcher object so that the listener
receives notification of an event. | EventDispatcher | ||
Dispatches an event into the event flow. | EventDispatcher | ||
Returns a rectangle that defines the area of the display object relative to the coordinate system
of the targetCoordinateSpace object. | DisplayObject | ||
Returns a rectangle that defines the boundary of the display object,
based on the coordinate system defined by the targetCoordinateSpace
parameter, excluding any strokes on shapes. | DisplayObject | ||
Converts the point object from the Stage (global) coordinates
to the display object's (local) coordinates. | DisplayObject | ||
Converts a two-dimensional point from the Stage (global) coordinates to a
three-dimensional display object's (local) coordinates. | DisplayObject | ||
Checks whether the EventDispatcher object has any listeners registered for a specific type
of event. | EventDispatcher | ||
Indicates whether an object has a specified property defined. | Object | ||
Evaluates the bounding box of the display object to see if it overlaps or intersects with the
bounding box of the obj display object. | DisplayObject | ||
Evaluates the display object to see if it overlaps or intersects with the
point specified by the x and y parameters. | DisplayObject | ||
Indicates whether an instance of the Object class is in the prototype chain of the object specified
as the parameter. | Object | ||
Converts a three-dimensional point of the three-dimensional display
object's (local) coordinates to a two-dimensional point in the Stage (global) coordinates. | DisplayObject | ||
Converts the point object from the display object's (local) coordinates to the
Stage (global) coordinates. | DisplayObject | ||
Indicates whether the specified property exists and is enumerable. | Object | ||
Removes a listener from the EventDispatcher object. | EventDispatcher | ||
Raises a virtual keyboard. | InteractiveObject | ||
Sets the availability of a dynamic property for loop operations. | Object | ||
Returns the string representation of this object, formatted according to locale-specific conventions. | Object | ||
Returns the string representation of the specified object. | Object | ||
Returns the primitive value of the specified object. | Object | ||
Checks whether an event listener is registered with this EventDispatcher object or any of
its ancestors for the specified event type. | EventDispatcher |
downState | property |
downState:DisplayObject
Language Version: | ActionScript 3.0 |
Runtime Versions: | AIR 1.0, Flash Player 9, Flash Lite 4 |
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.
Implementation
public function get downState():DisplayObject
public function set downState(value:DisplayObject):void
Related API Elements
enabled | property |
enabled:Boolean
Language Version: | ActionScript 3.0 |
Runtime Versions: | AIR 1.0, Flash Player 9, Flash Lite 4 |
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
.
Implementation
public function get enabled():Boolean
public function set enabled(value:Boolean):void
hitTestState | property |
hitTestState:DisplayObject
Language Version: | ActionScript 3.0 |
Runtime Versions: | AIR 1.0, Flash Player 9, Flash Lite 4 |
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.
Implementation
public function get hitTestState():DisplayObject
public function set hitTestState(value:DisplayObject):void
Related API Elements
overState | property |
overState:DisplayObject
Language Version: | ActionScript 3.0 |
Runtime Versions: | AIR 1.0, Flash Player 9, Flash Lite 4 |
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.
Implementation
public function get overState():DisplayObject
public function set overState(value:DisplayObject):void
Related API Elements
soundTransform | property |
soundTransform:flash.media:SoundTransform
Language Version: | ActionScript 3.0 |
Runtime Versions: | AIR 1.0, Flash Player 9 |
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.
Implementation
public function get soundTransform():flash.media:SoundTransform
public function set soundTransform(value:flash.media:SoundTransform):void
Related API Elements
trackAsMenu | property |
trackAsMenu:Boolean
Language Version: | ActionScript 3.0 |
Runtime Versions: | AIR 1.0, Flash Player 9 |
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.
Implementation
public function get trackAsMenu():Boolean
public function set trackAsMenu(value:Boolean):void
upState | property |
upState:DisplayObject
Language Version: | ActionScript 3.0 |
Runtime Versions: | AIR 1.0, Flash Player 9, Flash Lite 4 |
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.
Implementation
public function get upState():DisplayObject
public function set upState(value:DisplayObject):void
Related API Elements
useHandCursor | property |
useHandCursor:Boolean
Language Version: | ActionScript 3.0 |
Runtime Versions: | AIR 1.0, Flash Player 9 |
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.
Implementation
public function get useHandCursor():Boolean
public function set useHandCursor(value:Boolean):void
SimpleButton | () | Constructor |
public function SimpleButton(upState:DisplayObject = null, overState:DisplayObject = null, downState:DisplayObject = null, hitTestState:DisplayObject = null)
Language Version: | ActionScript 3.0 |
Runtime Versions: | AIR 1.0, Flash Player 9, Flash Lite 4 |
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.
ParametersupState:DisplayObject (default = null ) — The initial value for the SimpleButton up state.
| |
overState:DisplayObject (default = null ) — The initial value for the SimpleButton over state.
| |
downState:DisplayObject (default = null ) — The initial value for the SimpleButton down state.
| |
hitTestState:DisplayObject (default = null ) — The initial value for the SimpleButton hitTest state.
|
- In the
SimpleButtonExample()
constructor, a new CustomSimpleButton object of type SimpleButton, calledbutton
, is created, which calls theCustomSimpleButton
constructor method. Thebutton
object is the added to the display list. The button's color and size are determined in the steps that follow. - 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 thebutton
's states, the size of the square is set to 80 pixels by using thesize
property. - The constructor function for the CustomSimpleButton class sets the
downState
,overState
,upState
,hitTestState
, anduseHandCursor
properties with four instances of the ButtonDisplayState class. - In the ButtonDisplayState class, the constructor sets the value of the
square's size and background color and calls the
draw()
method. - 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(); } }
Wed Nov 21 2018, 06:34 AM -08:00