Packagecom.devnet.osmf.controls
Classpublic class SimpleButton
InheritanceSimpleButton Inheritance flash.display.MovieClip
Subclasses PlayScreen

Language Version : ActionScript 3.0
Runtime Versions : AIR 1.0, Flash Player 10.0.0

The SimpleButton class creates a custom timeline-based button component. The component works by navigating to named labels on the timeline which hold button graphic states.


Public Properties
 PropertyDefined By
  selected : Boolean
Set to true to trigger the selected (dn) state in a toggle button.
SimpleButton
  toggle : Boolean
Set to true to allow the button to behave as a toggle button.
SimpleButton
  useDownState : Boolean
Signals whether or not the down (dn) state should be used for a button set to toggle.
SimpleButton
Public Methods
 MethodDefined By
  
SimpleButton()
SimpleButton
  
setSelected(value:Boolean):void
Sets the selected state to true or false.
SimpleButton
Protected Methods
 MethodDefined By
  
onMouseDownHandler(event:MouseEvent):void
SimpleButton
  
onMouseOutHandler(event:MouseEvent):void
SimpleButton
  
onMouseOverHandler(event:MouseEvent):void
SimpleButton
  
onMouseUpHandler(event:MouseEvent):void
SimpleButton
Events
 Event Summary Defined By
  
click
SimpleButton
  
mouseDown
SimpleButton
  
mouseOut
SimpleButton
  
mouseOver
SimpleButton
  
mouseUp
SimpleButton
Public Constants
 ConstantDefined By
  DOWN : String = dn
[static]
SimpleButton
  DOWN_OVER : String = dnov
[static]
SimpleButton
  OVER : String = ov
[static]
SimpleButton
  UP : String = up
[static]
SimpleButton
Property Detail
selectedproperty
selected:Boolean

Set to true to trigger the selected (dn) state in a toggle button.


Implementation
    public function get selected():Boolean
    public function set selected(value:Boolean):void
toggleproperty 
toggle:Boolean

Set to true to allow the button to behave as a toggle button.


Implementation
    public function get toggle():Boolean
    public function set toggle(value:Boolean):void
useDownStateproperty 
useDownState:Boolean

Signals whether or not the down (dn) state should be used for a button set to toggle.


Implementation
    public function get useDownState():Boolean
    public function set useDownState(value:Boolean):void
Constructor Detail
SimpleButton()Constructor
public function SimpleButton()



Method Detail
onMouseDownHandler()method
protected function onMouseDownHandler(event:MouseEvent):void

Parameters

event:MouseEvent

onMouseOutHandler()method 
protected function onMouseOutHandler(event:MouseEvent):void

Parameters

event:MouseEvent

onMouseOverHandler()method 
protected function onMouseOverHandler(event:MouseEvent):void

Parameters

event:MouseEvent

onMouseUpHandler()method 
protected function onMouseUpHandler(event:MouseEvent):void

Parameters

event:MouseEvent

setSelected()method 
public function setSelected(value:Boolean):void

Sets the selected state to true or false.

Parameters

value:Boolean — Set to true to show the selected state.

Event Detail
click Event
Event Object Type: flash.events.MouseEvent

mouseDown Event  
Event Object Type: flash.events.MouseEvent

mouseOut Event  
Event Object Type: flash.events.MouseEvent

mouseOver Event  
Event Object Type: flash.events.MouseEvent

mouseUp Event  
Event Object Type: flash.events.MouseEvent

Constant Detail
DOWNConstant
public static const DOWN:String = dn

DOWN_OVERConstant 
public static const DOWN_OVER:String = dnov

OVERConstant 
public static const OVER:String = ov

UPConstant 
public static const UP:String = up