HilightButton

Kind of class: public class
Package:
Inherits from:
Classpath: org.asaplibrary.ui.buttons.HilightButton
File last modified: Wednesday, 11 May 2011, 18:43:40
Button with highlight behavior. The button timeline is expected to have 4 labels: "up", "over", "on" (maintained over state) and "out". A hitarea clip named "tHitarea" is recommended. Because HilightButton inherits from BaseButton, the hitarea clip is automatically hidden. Frames scenario: 1. No interaction: the button has stopped at the first frame 2. Mouse moves over button: the playhead moves to frame "over", optionally goes through the frames, and ends on frame "on" 3. Mouse moves away from button: the playhead moves to frame "out", optionally goes through the frames, and wraps to the first frame. When moving out, scenario step 2 is always finished first.

Summary

Constructor
Instance properties
Instance properties inherited from BaseButton
tHitArea
Instance methods
  • hilight (inDoAnimate:Boolean = false) : void
    • Go to hilight frame
  • unHilight (inDoAnimate:Boolean = false) : void
    • Go directly to the "up" frame
  • setEnabled (inEnabled:Boolean) : void
  • toString () : String

Constructor

HilightButton

function HilightButton()

Instance properties

isAnimatingOver

isAnimatingOver:Boolean(read)
Returns
  • True if the playhead has moved past the "over" frame but has not ended on the "on" frame.

isLit

isLit:Boolean(read)
Returns
  • True if the current frame is the hilight frame "on"; otherwise false.

Instance methods

hilight

function hilight(inDoAnimate:Boolean = false) : void

Go to hilight frame

Parameters
inDoAnimate:if true, the playhead will be moved from "over" to "on"; otherwise the playhead will be set to "on" immediately

setEnabled

function setEnabled(inEnabled:Boolean) : void

toString

override function toString() : String
Overrides

unHilight

function unHilight(inDoAnimate:Boolean = false) : void

Go directly to the "up" frame

Parameters
inDoAnimate:if true, the playhead will be moved from "on" to "out" to "up"; otherwise the playhead will be set to up" immediately