ActionScript Standard Library: class mx.controls.Button

Main Page | Packages | Class Tree | Index | Help

Previous \| Next	Frames \| No Frames
Summary: Field \| Property \| Contructor \| Method	Detail: Field \| Property \| Contructor \| Method

mx.controls

class Button

Object
  |
  +--MovieClip
        |
        +--mx.core.UIObject
              |
              +--mx.core.UIComponent
                    |
                    +--mx.controls.SimpleButton
                          |
                          +--mx.controls.Button

All Known Subclasses: AccordionHeader, CheckBox, CustomButton, RadioButton

class Button
extends SimpleButton

Button class - extends SimpleButton - adds label and text with layout - adds ability to resize without distorting the skin

Field Summary

__label: String

__labelPlacement: String

_color

_iconLinkageName: String

_inherited_selected: Boolean

borderW: Number

btnOffset: Number

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

centerContent: Boolean

clipParameters: Object

falseDisabledIcon: String

falseDisabledSkin: String

falseDownIcon: String

falseDownSkin: String

falseOverIcon: String

falseOverSkin: String

falseUpIcon: String

falseUpSkin: String

hitArea_mc: MovieClip

initIcon

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

labelPath: Object

static

mergedClipParameters: Boolean

static

symbolName: String

static

symbolOwner

trueDisabledIcon: String

trueDisabledSkin: String

trueDownIcon: String

trueDownSkin: String

trueOverIcon: String

trueOverSkin: String

trueUpIcon: String

trueUpSkin: String

static

version: String

Fields inherited from class mx.controls.SimpleButton

__emphasized, __emphatic, __emphaticStyleName, __state, __toggle, autoRepeat, boundingBox_mc, btnOffset, buttonDownHandler, clickHandler, detail, dfi, dfs, disabledIcon, disabledSkin, downIcon, downSkin, dti, dts, emphasizedStyleDeclaration, falseDisabled, falseDisabledIcon, falseDisabledIconEmphasized, falseDisabledSkin, falseDisabledSkinEmphasized, falseDown, falseDownIcon, falseDownIconEmphasized, falseDownSkin, falseDownSkinEmphasized, falseOver, falseOverIcon, falseOverIconEmphasized, falseOverSkin, falseOverSkinEmphasized, falseUp, falseUpIcon, falseUpIconEmphasized, falseUpSkin, falseUpSkinEmphasized, fdi, fds, fri, frs, fui, fus, iconName, idNames, initializing, interval, linkLength, phase, preset, refNames, rolloverIcon, rolloverSkin, skinName, stateNames, style3dInset, symbolName, symbolOwner, tagMap, tdi, tds, tri, trs, trueDisabled, trueDisabledIcon, trueDisabledIconEmphasized, trueDisabledSkin, trueDisabledSkinEmphasized, trueDown, trueDownIcon, trueDownIconEmphasized, trueDownSkin, trueDownSkinEmphasized, trueOver, trueOverIcon, trueOverIconEmphasized, trueOverSkin, trueOverSkinEmphasized, trueUp, trueUpIcon, trueUpIconEmphasized, trueUpSkin, trueUpSkinEmphasized, tui, tus, upIcon, upSkin, version

Fields inherited from class mx.core.UIComponent

clipParameters, drawFocus, enabled, focusEnabled, focusManager, focusTextField, groupName, kStretch, mergedClipParameters, origBorderStyles, origBorderValues, popUp, symbolName, symbolOwner, tabEnabled, tabIndex, version

Fields inherited from class mx.core.UIObject

__height, __width, _color, _topmost, addEventListener, buildDepthTable, changeColorStyleInChildren, changeTextStyleInChildren, childrenCreated, className, clipParameters, color, createAccessibilityImplementation, createChildAtDepth, createEvent, ction, dispatchEvent, embedFonts, findNextAvailableDepth, fontFamily, fontSize, fontStyle, fontWeight, handleEvent, idNames, ignoreClassStyleDeclaration, initProperties, marginLeft, marginRight, methodTable, notifyStyleChangeInChildren, removeEventListener, setStyle, stylecache, styleName, symbolName, symbolOwner, textAlign, textColorList, textDecoration, textIndent, validateNow, version

Fields inherited from class MovieClip

_alpha, _currentframe, _droptarget, _focusrect, _framesloaded, _height, _lockroot, _name, _parent, _quality, _rotation, _soundbuftime, _target, _totalframes, _url, _visible, _width, _x, _xmouse, _xscale, _y, _ymouse, _yscale, enabled, focusEnabled, hitArea, tabChildren, tabEnabled, tabIndex, tooltipText, trackAsMenu, useHandCursor

Fields inherited from class Object

__proto__, constructor, prototype

Property Summary

icon: String (read)

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

icon: (write)

label: String (read, write)

gets the associated label textsets the associated label text

labelPlacement: String (read, write)

returns the label placement of left,right,top, or bottomsets the label placement of left,right,top, or bottom

Properties inherited from class mx.controls.SimpleButton

emphasized, selected, toggle, value

Properties inherited from class mx.core.UIComponent

height, width

Properties inherited from class mx.core.UIObject

bottom, height, left, minHeight, minWidth, right, scaleX, scaleY, top, visible, width, x, y

Constructor

Button ( )

Method Summary

_getIcon ( Void ): String

_setIcon ( linkage ): Void

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

createChildren ( Void ): Void

draw ( )

getBtnOffset ( Void ): Number

getLabel ( Void ): String

getLabelPlacement ( Void ): String

init ( Void ): Void

invalidateStyle ( c: String ): Void

called if just styles are changing so subclasses don't have to redraw everything

onRelease ( Void ): Void

This method calls SimpleButton's onRelease()

setColor ( c: Number ): Void

setEnabled ( enable: Boolean ): Void

setHitArea ( w: Number, h: Number )

setLabel ( label: String ): Void

setLabelPlacement ( val: String ): Void

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

setView ( offset: Number ): Void

size ( Void ): Void

viewSkin ( varName: String ): Void

Methods inherited from class mx.controls.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, setSelected, setSkin, setState, setStateVar, setToggle, setView, showEmphasized, size, viewIcon, viewSkin

Methods inherited from class mx.core.UIComponent

dispatchValueChangedEvent, enabledChanged, findFocusFromObject, findFocusInChildren, getFocus, getFocusManager, init, isParent, onKillFocus, onSetFocus, pressFocus, releaseFocus, setEnabled, setFocus, setVisible, size

Methods inherited from class mx.core.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, mergeClipParameters, move, redraw, setColor, setMinHeight, setMinWidth, setSize, setSkin, setVisible, size

Methods inherited from class MovieClip

attachAudio, attachMovie, beginFill, beginGradientFill, clear, createEmptyMovieClip, createTextField, curveTo, duplicateMovieClip, endFill, getBounds, getBytesLoaded, getBytesTotal, getDepth, getInstanceAtDepth, getNextHighestDepth, getSWFVersion, getTextSnapshot, getURL, globalToLocal, gotoAndPlay, gotoAndStop, hitTest, lineStyle, lineTo, loadMovie, loadVariables, localToGlobal, moveTo, nextFrame, onData, onDragOut, onDragOver, onEnterFrame, onKeyDown, onKeyUp, onKillFocus, onLoad, onMouseDown, onMouseMove, onMouseUp, onPress, onRelease, onReleaseOutside, onRollOut, onRollOver, onSetFocus, onUnload, play, prevFrame, removeMovieClip, setMask, startDrag, stop, stopDrag, swapDepths, unloadMovie, valueOf

Methods inherited from class Object

addProperty, hasOwnProperty, isPropertyEnumerable, isPrototypeOf, registerClass, toLocaleString, toString, unwatch, valueOf, watch

Field Documentation

__label

var __label: String

__labelPlacement

var __labelPlacement: String

_color

var _color

_iconLinkageName

var _iconLinkageName: String

_inherited_selected

var _inherited_selected: Boolean

borderW

var borderW: Number

btnOffset

var btnOffset: Number

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

centerContent

var centerContent: Boolean

clipParameters

var clipParameters: Object

falseDisabledIcon

var falseDisabledIcon: String

falseDisabledSkin

var falseDisabledSkin: String

falseDownIcon

var falseDownIcon: String

falseDownSkin

var falseDownSkin: String

falseOverIcon

var falseOverIcon: String

falseOverSkin

var falseOverSkin: String

falseUpIcon

var falseUpIcon: String

falseUpSkin

var falseUpSkin: String

hitArea_mc

var hitArea_mc: MovieClip

initIcon

var initIcon

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

labelPath

var labelPath: Object

mergedClipParameters

static var mergedClipParameters: Boolean

symbolName

static var symbolName: String

symbolOwner

static var symbolOwner

trueDisabledIcon

var trueDisabledIcon: String

trueDisabledSkin

var trueDisabledSkin: String

trueDownIcon

var trueDownIcon: String

trueDownSkin

var trueDownSkin: String

trueOverIcon

var trueOverIcon: String

trueOverSkin

var trueOverSkin: String

trueUpIcon

var trueUpIcon: String

trueUpSkin

var trueUpSkin: String

version

static var version: String

Property Documentation

icon

icon	: String (read)

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

icon

: (write)

label

: String (read, write)

gets the associated label textsets the associated label text

labelPlacement

: String (read, write)

returns the label placement of left,right,top, or bottomsets the label placement of left,right,top, or bottom

Constructor Documentation

Button

function Button

()

Method Documentation

_getIcon

function _getIcon

(Void): String

_setIcon

function _setIcon

(linkage): Void

calcSize

function calcSize

(tag: Number,
ref: Object): Void

Overrides:: SimpleButton.calcSize in class SimpleButton

createChildren

function createChildren

(Void): Void

Overrides:: SimpleButton.createChildren in class SimpleButton

draw

function draw

()

Overrides:: SimpleButton.draw in class SimpleButton

getBtnOffset

function getBtnOffset

(Void): Number

getLabel

function getLabel

(Void): String

Overrides:: SimpleButton.getLabel in class SimpleButton

getLabelPlacement

function getLabelPlacement

(Void): String

init

function init

(Void): Void

Overrides:: SimpleButton.init in class SimpleButton

invalidateStyle

function invalidateStyle

(c: String): Void

called if just styles are changing so subclasses don't have to redraw everything

Overrides:: mx.core.UIObject.invalidateStyle in class mx.core.UIObject

onRelease

function onRelease

(Void): Void

This method calls SimpleButton's onRelease()

Overrides:: SimpleButton.onRelease in class SimpleButton

setColor

function setColor

(c: Number): Void

Overrides:: mx.core.UIObject.setColor in class mx.core.UIObject

setEnabled

function setEnabled

(enable: Boolean): Void

Overrides:: SimpleButton.setEnabled in class SimpleButton

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:: SimpleButton.setSkin in class SimpleButton

Parameters:

tag		id number of skin
linkageName		name symbol name of object
initobj		initObj object containing initialization properties

Returns:: reference to object

setView

function setView

(offset: Number): Void

Overrides:: SimpleButton.setView in class SimpleButton

size

function size

(Void): Void

Overrides:: SimpleButton.size in class SimpleButton

viewSkin

function viewSkin

(varName: String): Void

Overrides:: SimpleButton.viewSkin in class SimpleButton

The documentation was generated from the following file:

Button.as, Last Modified: 22.03.2004 18:27:28

Previous \| Next	Frames \| No Frames
Summary: Field \| Property \| Contructor \| Method	Detail: Field \| Property \| Contructor \| Method