Button

Kind of class:class
Inherits from:SimpleButton < UIComponent < UIObject < MovieClip
Known subclasses:
Classpath:mx.controls.Button
File last modified:Tuesday, 18 December 2007, 15:44:37
Component metadata:
    Event
    "click"

    Summary


    Constructor
    Instance properties
    Class methods
    Class methods inherited from UIObject
    Instance methods
    Event handlers
    • onRelease (Void) : Void
      • This method calls SimpleButton's onRelease()

    Constructor

    Button

    function Button (
    )

    Class properties

    mergedClipParameters

    static mergedClipParameters:Boolean = UIObject.mergeClipParameters(mx.controls.Button.prototype.clipParameters, SimpleButton.prototype.clipParameters)
    (read)

    symbolName

    static symbolName:String = "Button"
    (read)

    symbolOwner

    static symbolOwner = mx.controls.Button
    (read)

    version

    static version:String = "2.0.2.127"
    (read)

    Instance properties

    __label

    __label:String = "default value"
    (read)

    __labelPlacement

    __labelPlacement:String = "right"
    (read)

    _color

    _color = "buttonColor"
    (read)

    _iconLinkageName

    _iconLinkageName:String
    (read)

    _inherited_selected

    _inherited_selected:Boolean
    (read)

    Component metadata:
      Bindable
      ChangeEvent
      "click"

      borderW

      borderW:Number = 1
      (read)

      btnOffset

      btnOffset:Number = 0
      (read)

      number used to offset the label and/or icon when button is pressed

      centerContent

      centerContent:Boolean = true
      (read)

      className

      className:String = "Button"
      (read)

      clipParameters

      clipParameters:Object = { labelPlacement:1, icon:1, toggle:1, selected:1, label:1 }
      (read)

      falseDisabledIcon

      falseDisabledIcon:String = ""
      (read)

      falseDisabledSkin

      falseDisabledSkin:String = "ButtonSkin"
      (read)

      falseDownIcon

      falseDownIcon:String = ""
      (read)

      falseDownSkin

      falseDownSkin:String = "ButtonSkin"
      (read)

      falseOverIcon

      falseOverIcon:String = ""
      (read)

      falseOverSkin

      falseOverSkin:String = "ButtonSkin"
      (read)

      falseUpIcon

      falseUpIcon:String = ""
      (read)

      falseUpSkin

      falseUpSkin:String = "ButtonSkin"
      (read)

      hitArea_mc

      hitArea_mc:MovieClip
      (read)

      icon

      icon:String
      (read)

      sets the associated icon
      use setIcon() to set the icon

      icon

      icon
      (write)

      sets:
      • the icon for all states of the button
      Component metadata:
        Inspectable
        defaultValue:
        ""

        initIcon

        initIcon
        (read)

        //*@private
        store the linkage name of the icon at initalization

        label

        label
        (read,write)

        sets the associated label text gets the associated label text
        Component metadata:
          Inspectable
          defaultValue:
          "Button"

          labelPath

          labelPath:Object
          (read)

          labelPlacement

          labelPlacement
          (read,write)

          sets the label placement of left,right,top, or bottom returns the label placement of left,right,top, or bottom
          Component metadata:
            Inspectable
            "right"
            enumeration:
            "left,right,top,bottom"defaultValue

            trueDisabledIcon

            trueDisabledIcon:String = ""
            (read)

            trueDisabledSkin

            trueDisabledSkin:String = "ButtonSkin"
            (read)

            trueDownIcon

            trueDownIcon:String = ""
            (read)

            trueDownSkin

            trueDownSkin:String = "ButtonSkin"
            (read)

            trueOverIcon

            trueOverIcon:String = ""
            (read)

            trueOverSkin

            trueOverSkin:String = "ButtonSkin"
            (read)

            trueUpIcon

            trueUpIcon:String = ""
            (read)

            trueUpSkin

            trueUpSkin:String = "ButtonSkin"
            (read)

            Instance methods

            _getIcon

            function _getIcon (
            Void) : String

            _setIcon

            function _setIcon (
            linkage) : Void

            calcSize

            function calcSize (
            tag:Number, ref:Object) : Void

            createChildren

            function createChildren (
            Void) : Void

            draw

            function draw (
            )

            getBtnOffset

            function getBtnOffset (
            Void) : Number

            getLabel

            function getLabel (
            Void) : String

            getLabelPlacement

            function getLabelPlacement (
            Void) : String

            init

            function init (
            Void) : Void

            Overrides:

            invalidateStyle

            function invalidateStyle (
            c:String) : Void

            setColor

            function setColor (
            c:Number) : Void

            setEnabled

            function setEnabled (
            enable:Boolean) : Void

            setHitArea

            function setHitArea (
            w:Number, h:Number)

            setLabel

            function setLabel (
            label:String) : Void

            setLabelPlacement

            function setLabelPlacement (
            val:String) : Void

            setSkin

            function setSkin (
            tag:Number, linkageName:String, initobj:Object) : MovieClip

            setView

            function setView (
            offset:Number) : Void

            size

            function size (
            Void) : Void

            Overrides:

            viewSkin

            function viewSkin (
            varName:String) : Void

            Event handlers

            onRelease

            function onRelease (
            Void) : Void

            This method calls SimpleButton's onRelease()