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
Class properties
- symbolName : String
- symbolOwner
- version : String
- mergedClipParameters : Boolean
Class properties inherited from SimpleButton
Class properties inherited from UIComponent
Class properties inherited from UIObject
Instance properties
- className : String
- btnOffset : Number
- number used to offset the label and/or icon when button is pressed
- _color
- __label : String
- __labelPlacement : String
- initIcon
- falseUpSkin : String
- falseDownSkin : String
- falseOverSkin : String
- falseDisabledSkin : String
- trueUpSkin : String
- trueDownSkin : String
- trueOverSkin : String
- trueDisabledSkin : String
- falseUpIcon : String
- falseDownIcon : String
- falseOverIcon : String
- falseDisabledIcon : String
- trueUpIcon : String
- trueDownIcon : String
- trueOverIcon : String
- trueDisabledIcon : String
- clipParameters : Object
- labelPath : Object
- hitArea_mc : MovieClip
- _iconLinkageName : String
- centerContent : Boolean
- borderW : Number
- labelPlacement (val:String)
- sets the label placement of left,right,top, or bottom
- label (lbl:String)
- sets the associated label text
- icon : String
- sets the associated icon
- icon (linkage)
- _inherited_selected : Boolean
Instance properties inherited from SimpleButton
__emphasized __emphatic __emphaticStyleName __state __toggle autoRepeat boundingBox_mc btnOffset buttonDownHandler className clickHandler detail dfi dfs disabledIcon disabledSkin downIcon downSkin dti dts emphasized falseDisabledIcon falseDisabledIconEmphasized falseDisabledSkin falseDisabledSkinEmphasized falseDownIcon falseDownIconEmphasized falseDownSkin falseDownSkinEmphasized falseOverIcon falseOverIconEmphasized falseOverSkin falseOverSkinEmphasized falseUpIcon falseUpIconEmphasized falseUpSkin falseUpSkinEmphasized fdi fds fri frs fui fus iconName idNames initializing interval linkLength phase preset refNames rolloverIcon rolloverSkin selected skinName stateNames style3dInset tagMap tdi tds toggle tri trs trueDisabledIcon trueDisabledIconEmphasized trueDisabledSkin trueDisabledSkinEmphasized trueDownIcon trueDownIconEmphasized trueDownSkin trueDownSkinEmphasized trueOverIcon trueOverIconEmphasized trueOverSkin trueOverSkinEmphasized trueUpIcon trueUpIconEmphasized trueUpSkin trueUpSkinEmphasized tui tus upIcon upSkin value
Instance properties inherited from UIComponent
Instance properties inherited from UIObject
__height __onUnload __width _color _endInit _id _maxHeight _maxWidth _minHeight _minWidth _preferredHeight _preferredWidth _tf _topmost addEventListener bottom buildDepthTable changeColorStyleInChildren changeTextStyleInChildren childrenCreated className clipParameters color createAccessibilityImplementation createChildAtDepth createClassChildAtDepth createEvent dispatchEvent embedFonts findNextAvailableDepth fontFamily fontSize fontStyle fontWeight handleEvent height idNames ignoreClassStyleDeclaration initProperties invalidateFlag left lineColor lineWidth marginLeft marginRight methodTable minHeight minWidth notifyStyleChangeInChildren removeEventListener right scaleX scaleY setStyle stylecache styleName tabEnabled textAlign textDecoration textIndent tfList top validateNow visible width x y
Class methods
Class methods inherited from UIObject
Instance methods
- init (Void) : Void
- draw
- createChildren (Void) : Void
- setSkin (tag:Number, linkageName:String, initobj:Object) : MovieClip
- viewSkin (varName:String) : Void
- invalidateStyle (c:String) : Void
- setColor (c:Number) : Void
- setEnabled (enable:Boolean) : Void
- calcSize (tag:Number, ref:Object) : Void
- size (Void) : Void
- getLabelPlacement (Void) : String
- setLabelPlacement (val:String) : Void
- getBtnOffset (Void) : Number
- setView (offset:Number) : Void
- setLabel (label:String) : Void
- getLabel (Void) : String
- _getIcon (Void) : String
- _setIcon (linkage) : Void
- setHitArea (w:Number, h:Number)
Instance methods inherited from SimpleButton
calcSize changeIcon changeSkin createChildren draw getLabel getSelected getState getToggle init keyDown keyUp onDragOut onDragOver onKillFocus onPress onPressDelay onPressRepeat onRelease onReleaseOutside onRollOut onRollOver refresh removeIcons setEnabled setIcon setLabel setSelected setSkin setState setStateVar setToggle setView showEmphasized size viewIcon viewSkin
Instance methods inherited from UIObject
__getTextFormat _createChildren _getTextFormat cancelAllDoLaters constructObject createChildren createClassObject createEmptyObject createLabel createObject createSkin destroyObject doLater doLaterDispatcher draw drawRect getClassStyleDeclaration getMinHeight getMinWidth getSkinIDName getStyle getStyleName init initFromClipParameters invalidate invalidateStyle move redraw setColor setMinHeight setMinWidth setSize setSkin setVisible size
Event handlers
- onRelease (Void) : Void
- This method calls SimpleButton's onRelease()
Event handlers inherited from SimpleButton
Event handlers inherited from UIComponent
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
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
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
draw
function draw (
)
getBtnOffset
function getBtnOffset (
Void) : Number
getLabelPlacement
function getLabelPlacement (
Void) : String
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
Overrides:
setView
function setView (
offset:Number) : Void
viewSkin
function viewSkin (
varName:String) : Void
Event handlers
onRelease
function onRelease (
Void) : Void
This method calls SimpleButton's onRelease()
Overrides: