| Package | mx.controls |
| Class | public class Button |
| Inheritance | Button  UIComponent FlexSprite flash.display.Sprite |
| Implements | IButton, IDataRenderer, IDropInListItemRenderer, IFocusManagerComponent, IFontContextComponent, IListItemRenderer |
| Subclasses | AccordionHeader, CheckBox, DWU_Button, GalleryPagingNextButton, GalleryPagingPreviousButton, GalleryPasswordButton, LinkButton, ScrollThumb, SliderThumb |
Buttons typically use event listeners to perform an action
when the user selects the control. When a user clicks the mouse
on a Button control, and the Button control is enabled,
it dispatches a click event and a buttonDown event.
A button always dispatches events such as the mouseMove,
mouseOver, mouseOut, rollOver,
rollOut, mouseDown, and
mouseUp events whether enabled or disabled.
You can customize the look of a Button control and change its functionality from a push button to a toggle button. You can change the button appearance by using a skin for each of the button's states.
The label of a Button control uses a bold typeface. If you embed a font that you want to use for the label of the Button control, you must embed the bold typeface; for example:
<mx:style>
@font-face {
src:url("../MyFont-Bold.ttf");
fontFamily: myFont;
fontWeight: bold;
}
.myBoldStyle {
fontFamily: myFont;
fontWeight: bold;
}
</mx:style>
...
<mx:Button ... styleName="myBoldStyle"/>
The Button control has the following default characteristics:
| Characteristic | Description |
|---|---|
| Default size | A size large enough to hold the label text, and any icon |
| Minimum size | 0 pixels |
| Maximum size | No limit |
Hide MXML Syntax
The <mx:Button> tag inherits all the tag attributes
of its superclass, and adds the following tag attributes:
Show MXML Syntax
<mx:Button
Properties
autoRepeat="false|true"
emphasized="false|true"
fontContext="IFontModuleFactory"
label=""
labelPlacement="right|left|bottom|top"
selected="false|true"
selectedField="null"
stickyHighlighting="false|true"
toggle="false|true"
Styles
borderColor="0xAAB3B3"
color="0x0B333C"
cornerRadius="4"
disabledColor="0xAAB3B3"
disabledIcon="null"
disabledSkin="mx.skins.halo.ButtonSkin"
downIcon="null"
downSkin="mx.skins.halo.ButtonSkin"
fillAlphas="[0.6, 0.4]"
fillColors="[0xE6EEEE, 0xFFFFFF]"
focusAlpha="0.5"
focusRoundedCorners"tl tr bl br"
fontAntiAliasType="advanced"
fontFamily="Verdana"
fontGridFitType="pixel"
fontSharpness="0"
fontSize="10"
fontStyle="normal|italic"
fontThickness="0"
fontWeight="bold|normal"
highlightAlphas="[0.3, 0.0]"
horizontalGap="2"
icon="null"
kerning="false|true"
leading="2"
letterSpacing="0"
overIcon="null"
overSkin="mx.skins.halo.ButtonSkin"
paddingBottom="0"
paddingLeft="0"
paddingRight="0"
paddingTop="0"
repeatDelay="500"
repeatInterval="35"
selectedDisabledIcon="null"
selectedDisabledSkin="mx.skins.halo.ButtonSkin"
selectedDownIcon="null"
selectedDownSkin="mx.skins.halo.ButtonSkin"
selectedOverIcon="null"
selectedOverSkin="mx.skins.halo.ButtonSkin"
selectedUpIcon="null"
selectedUpSkin="mx.skins.halo.ButtonSkin"
skin="mx.skins.halo.ButtonSkin"
textAlign="center|left|right"
textDecoration="none|underline"
textIndent="0"
textRollOverColor="0x2B333C"
textSelectedColor="0x000000"
upIcon="null"
upSkin="mx.skins.halo.ButtonSkin"
verticalGap="2"
Events
buttonDown="No default"
change="No default"
dataChange="No default"
/>
| Property | Defined by | ||
|---|---|---|---|
 | activeEffects : Array
The list of effects that are currently playing on the component,
as an Array of EffectInstance instances.
| UIComponent | |
| automationDelegate : Object
The delegate object that handles the automation-related functionality.
| UIComponent | |
| automationName : String
Name that can be used as an identifier for this object.
| UIComponent | |
| automationTabularData : Object
An implementation of the
IAutomationTabularData interface, which
can be used to retrieve the data. | UIComponent | |
| automationValue : Array
This value generally corresponds to the rendered appearance of the
object and should be usable for correlating the identifier with
the object as it appears visually within the application.
| UIComponent | |
| autoRepeat : Boolean
Specifies whether to dispatch repeated
buttonDown
events if the user holds down the mouse button. | Button | ||
| baselinePosition : Number
The y-coordinate of the baseline
of the first line of text of the component.
| UIComponent | |
| cacheHeuristic : Boolean
Used by Flex to suggest bitmap caching for the object.
| UIComponent | |
| cachePolicy : String
Specifies the bitmap caching policy for this object.
| UIComponent | |
| className : String
The name of this instance's class, such as
"Button". | UIComponent | |
| contentMouseX : Number
Returns the x position of the mouse, in the content coordinate system.
| UIComponent | |
| contentMouseY : Number
Returns the y position of the mouse, in the content coordinate system.
| UIComponent | |
| currentLooperData : Object
When using this component as the child of a DataLooper element, this holds the current element's corresponding looping data.
| UIComponent | |
| currentState : String
The current view state of the component.
| UIComponent | |
| cursorManager : ICursorManager
Gets the CursorManager that controls the cursor for this component
and its peers.
| UIComponent | |
| data : Object
The
data property lets you pass a value
to the component when you use it as an item renderer or item editor. | Button | ||
| descriptor : UIComponentDescriptor
Reference to the UIComponentDescriptor, if any, that was used
by the
createComponentFromDescriptor() method to create this
UIComponent instance. | UIComponent | |
| document : Object
A reference to the document object associated with this UIComponent.
| UIComponent | |
| doubleClickEnabled : Boolean
Specifies whether the UIComponent object receives
doubleClick events. | UIComponent | |
| emphasized : Boolean
Draws a thick border around the Button control
when the control is in its up state if
emphasized
is set to true. | Button | ||
| enabled : Boolean
Whether the component can accept user interaction.
| UIComponent | |
| errorString : String
The text that will be displayed by a component's error tip when a
component is monitored by a Validator and validation fails.
| UIComponent | |
| explicitHeight : Number
Number that specifies the explicit height of the component,
in pixels, in the component's coordinates.
| UIComponent | |
| explicitMaxHeight : Number
Number that specifies the maximum height of the component,
in pixels, in the component's coordinates.
| UIComponent | |
| explicitMaxWidth : Number
Number that specifies the maximum width of the component,
in pixels, in the component's coordinates.
| UIComponent | |
| explicitMinHeight : Number
Number that specifies the minimum height of the component,
in pixels, in the component's coordinates.
| UIComponent | |
| explicitMinWidth : Number
Number that specifies the minimum width of the component,
in pixels, in the component's coordinates.
| UIComponent | |
| explicitWidth : Number
Number that specifies the explicit width of the component,
in pixels, in the component's coordinates.
| UIComponent | |
| flexContextMenu : IFlexContextMenu
The context menu for this UIComponent.
| UIComponent | |
| focusEnabled : Boolean
Indicates whether the component can receive focus when tabbed to.
| UIComponent | |
| focusManager : IFocusManager
Gets the FocusManager that controls focus for this component
and its peers.
| UIComponent | |
| focusPane : Sprite
The focus pane associated with this object.
| UIComponent | |
| fontContext : IFlexModuleFactory
The module factory that provides the font context for this component.
| Button | ||
| globalX : Number | UIComponent | |
| globalY : Number | UIComponent | |
| height : Number
Number that specifies the height of the component, in pixels,
in the parent's coordinates.
| UIComponent | |
| id : String
ID of the component.
| UIComponent | |
| includeInLayout : Boolean
Specifies whether this component is included in the layout of the
parent container.
| UIComponent | |
| inheritingStyles : Object
The beginning of this component's chain of inheriting styles.
| UIComponent | |
| initialized : Boolean
A flag that determines if an object has been through all three phases
of layout: commitment, measurement, and layout (provided that any were required).
| UIComponent | |
| instanceIndex : int
The index of a repeated component.
| UIComponent | |
| instanceIndices : Array
An Array containing the indices required to reference
this UIComponent object from its parent document.
| UIComponent | |
| isDocument : Boolean
Determines whether this UIComponent instance is a document object,
that is, whether it is at the top of the hierarchy of a Flex
application, MXML component, or ActionScript component.
| UIComponent | |
| isPopUp : Boolean
Set to
true by the PopUpManager to indicate
that component has been popped up. | UIComponent | |
| label : String
Text to appear on the Button control.
| Button | ||
| labelPlacement : String
Orientation of the label in relation to a specified icon.
| Button | ||
| listData : BaseListData
When a component is used as a drop-in item renderer or drop-in
item editor, Flex initializes the
listData property
of the component with the appropriate data from the list control. | Button | ||
| maxHeight : Number
Number that specifies the maximum height of the component,
in pixels, in the component's coordinates.
| UIComponent | |
| maxWidth : Number
Number that specifies the maximum width of the component,
in pixels, in the component's coordinates.
| UIComponent | |
| measuredHeight : Number
The default height of the component, in pixels.
| UIComponent | |
| measuredMinHeight : Number
The default minimum height of the component, in pixels.
| UIComponent | |
| measuredMinWidth : Number
The default minimum width of the component, in pixels.
| UIComponent | |
| measuredWidth : Number
The default width of the component, in pixels.
| UIComponent | |
| minHeight : Number
Number that specifies the minimum height of the component,
in pixels, in the component's coordinates.
| UIComponent | |
| minWidth : Number
Number that specifies the minimum width of the component,
in pixels, in the component's coordinates.
| UIComponent | |
| miscHolder : Object
A utility holder for any various properties
| UIComponent | |
| moduleFactory : IFlexModuleFactory
The moduleFactory that is used to create TextFields in the correct SWF context.
| UIComponent | |
| mouseFocusEnabled : Boolean
Whether you can receive focus when clicked on.
| UIComponent | |
| move_enableProtection : Boolean = false | UIComponent | |
| nestLevel : int
Depth of this object in the containment hierarchy.
| UIComponent | |
| nonInheritingStyles : Object
The beginning of this component's chain of non-inheriting styles.
| UIComponent | |
| numAutomationChildren : int
The number of automation children this container has.
| UIComponent | |
| owner : DisplayObjectContainer
The owner of this UIComponent.
| UIComponent | |
| parent : DisplayObjectContainer
The parent container or component for this component.
| UIComponent | |
| parentApplication : Object
A reference to the Application object that contains this UIComponent
instance.
| UIComponent | |
| parentDocument : Object
A reference to the parent document object for this UIComponent.
| UIComponent | |
| percentHeight : Number
Number that specifies the height of a component as a percentage
of its parent's size.
| UIComponent | |
| percentWidth : Number
Number that specifies the width of a component as a percentage
of its parent's size.
| UIComponent | |
| processedDescriptors : Boolean
Set to
true after immediate or deferred child creation,
depending on which one happens. | UIComponent | |
| repeater : IRepeater
A reference to the Repeater object
in the parent document that produced this UIComponent.
| UIComponent | |
| repeaterIndex : int
The index of the item in the data provider
of the Repeater that produced this UIComponent.
| UIComponent | |
| repeaterIndices : Array
An Array containing the indices of the items in the data provider
of the Repeaters in the parent document that produced this UIComponent.
| UIComponent | |
| repeaters : Array
An Array containing references to the Repeater objects
in the parent document that produced this UIComponent.
| UIComponent | |
| scaleX : Number
Number that specifies the horizontal scaling factor.
| UIComponent | |
| scaleY : Number
Number that specifies the vertical scaling factor.
| UIComponent | |
| screen : Rectangle
Returns an object that contains the size and position of the base
drawing surface for this object.
| UIComponent | |
| selected : Boolean
Indicates whether a toggle button is toggled
on (
true) or off (false). | Button | ||
| selectedField : String = "null"
The name of the field in the
data property which specifies
the value of the Button control's selected property. | Button | ||
| setActualSize_enableProtection : Boolean = false | UIComponent | |
| setVisible_enableProtection : Boolean = true | UIComponent | |
| showInAutomationHierarchy : Boolean
A flag that determines if an automation object
shows in the automation hierarchy.
| UIComponent | |
| states : Array
The view states that are defined for this component.
| UIComponent | |
| stickyHighlighting : Boolean = false
If
false, the Button displays its down skin
when the user presses it but changes to its over skin when
the user drags the mouse off of it. | Button | ||
| styleClassOverridesInline : Boolean = true
Specifies if class-specific styles (as defined by the
styleName property) override inline styles. | UIComponent | |
| styleDeclaration : CSSStyleDeclaration
Storage for the inline inheriting styles on this object.
| UIComponent | |
| styleName : Object
The class style used by this component.
| UIComponent | |
| systemManager : ISystemManager
Returns the SystemManager object used by this component.
| UIComponent | |
| toggle : Boolean
Controls whether a Button is in a toggle state or not.
| Button | ||
| toolTip : String
Text to display in the ToolTip.
| UIComponent | |
| transitions : Array
An Array of Transition objects, where each Transition object defines a
set of effects to play when a view state change occurs.
| UIComponent | |
| tweeningProperties : Array
Array of properties that are currently being tweened on this object.
| UIComponent | |
| uid : String
A unique identifier for the object.
| UIComponent | |
| updateCompletePendingFlag : Boolean
A flag that determines if an object has been through all three phases
of layout validation (provided that any were required).
| UIComponent | |
| validationSubField : String
Used by a validator to associate a subfield with this component.
| UIComponent | |
| visible : Boolean
Controls the visibility of this UIComponent.
| UIComponent | |
| visible_unprotected : Boolean
If setVisible_enableProtection is enabled, this allows access to determine what the pseudo-state is -- that is, what's been requested, regardless of any prevention of default behavior.
| UIComponent | |
| width : Number
Number that specifies the width of the component, in pixels,
in the parent's coordinates.
| UIComponent | |
| x : Number
Number that specifies the component's horizontal position,
in pixels, within its parent container.
| UIComponent | |
| xmlDescriptor : XML
For certain dynamically created elements, this represents the XML node used to create that element.
| UIComponent | |
| y : Number
Number that specifies the component's vertical position,
in pixels, within its parent container.
| UIComponent | |
| Property | Defined by | ||
|---|---|---|---|
| textField : IUITextField
The internal UITextField object that renders the label of this Button.
| Button | ||
| unscaledHeight : Number
A convenience method for determining the unscaled height
of the component.
| UIComponent | |
| unscaledWidth : Number
A convenience method for determining the unscaled width
of the component
All of a component's drawing and child layout should be done
within a bounding rectangle of this width, which is also passed
as an argument to
updateDisplayList(). | UIComponent | |
| Method | Defined by | ||
|---|---|---|---|
|
Button()
Constructor.
| Button | ||
|
callLater(method:Function, args:Array = null):void
Queues a function to be called later.
| UIComponent | |
|
clearStyle(styleProp:String):void
Deletes a style property from this component instance.
| UIComponent | |
|
contentToGlobal(point:Point):Point
Converts a
Point object from content coordinates to global coordinates. | UIComponent | |
|
contentToLocal(point:Point):Point
Converts a
Point object from content to local coordinates. | UIComponent | |
|
createAutomationIDPart(child:IAutomationObject):Object
Returns a set of properties that identify the child within
this container.
| UIComponent | |
|
createReferenceOnParentDocument(parentDocument:IFlexDisplayObject):void
Creates an
id reference to this IUIComponent object
on its parent document object. | UIComponent | |
|
deleteReferenceOnParentDocument(parentDocument:IFlexDisplayObject):void
Deletes the
id reference to this IUIComponent object
on its parent document object. | UIComponent | |
|
Returns a UITextFormat object corresponding to the text styles
for this UIComponent.
| UIComponent | |
|
dispatchEvent(event:Event):Boolean
Dispatches an event into the event flow.
| UIComponent | |
|
drawFocus(isFocused:Boolean):void
Shows or hides the focus indicator around this component.
| UIComponent | |
|
drawRoundRect(x:Number, y:Number, w:Number, h:Number, r:Object = null, c:Object = null, alpha:Object = null, rot:Object = null, gradient:String = null, ratios:Array = null, hole:Object = null):void
Programatically draws a rectangle into this skin's Graphics object.
| UIComponent | |
|
effectFinished(effectInst:IEffectInstance):void
Called by the effect instance when it stops playing on the component.
| UIComponent | |
|
effectStarted(effectInst:IEffectInstance):void
Called by the effect instance when it starts playing on the component.
| UIComponent | |
|
endEffectsStarted():void
Ends all currently playing effects on the component.
| UIComponent | |
|
executeBindings(recurse:Boolean = false):void
Executes the data bindings into this UIComponent object.
| UIComponent | |
|
finishPrint(obj:Object, target:IFlexDisplayObject):void
Called after printing is complete.
| UIComponent | |
|
getAutomationChildAt(index:int):IAutomationObject
Provides the automation object at the specified index.
| UIComponent | |
|
getClassStyleDeclarations():Array
Finds the type selectors for this UIComponent instance.
| UIComponent | |
|
getConstraintValue(constraintName:String):*
Returns a layout constraint value, which is the same as
getting the constraint style for this component.
| UIComponent | |
|
getDescendantByName(name:String):DisplayObject
Searches all children for the first child named with the passed value; returns that child, or null if not found.
| UIComponent | |
|
getDescendantsByName(name:String):Array
Searches all children for all children named with the passed value; returns an array with those children, or an empty array if none found.
| UIComponent | |
|
getExplicitOrMeasuredHeight():Number
A convenience method for determining whether to use the
explicit or measured height
| UIComponent | |
|
getExplicitOrMeasuredWidth():Number
A convenience method for determining whether to use the
explicit or measured width
| UIComponent | |
|
getFocus():InteractiveObject
Gets the object that currently has focus.
| UIComponent | |
|
getRepeaterItem(whichRepeater:int = -1):Object
Returns the item in the
dataProvider that was used
by the specified Repeater to produce this Repeater, or
null if this Repeater isn't repeated. | UIComponent | |
|
getStyle(styleProp:String):*
Gets a style property that has been set anywhere in this
component's style lookup chain.
| UIComponent | |
|
getVisibleRect(targetParent:DisplayObject = null):Rectangle
MOVED OVER FROM SDK 3.2 UIComponent - Allows for popped-up alerts to be displayed correctly - NGR MOVED 11-20-08
| UIComponent | |
|
globalToContent(point:Point):Point
Converts a
Point object from global to content coordinates. | UIComponent | |
|
horizontalGradientMatrix(x:Number, y:Number, width:Number, height:Number):Matrix
Returns a box Matrix which can be passed to the
drawRoundRect() method
as the rot parameter when drawing a horizontal gradient. | UIComponent | |
|
initialize():void
Initializes the internal structure of this component.
| UIComponent | |
|
initializeRepeaterArrays(parent:IRepeaterClient):void
Initializes various properties which keep track of repeated instances
of this component.
| UIComponent | |
|
invalidateDisplayList():void
Marks a component so that its
updateDisplayList()
method gets called during a later screen update. | UIComponent | |
|
invalidateProperties():void
Marks a component so that its
commitProperties()
method gets called during a later screen update. | UIComponent | |
|
invalidateSize():void
Marks a component so that its
measure()
method gets called during a later screen update. | UIComponent | |
|
localToContent(point:Point):Point
Converts a
Point object from local to content coordinates. | UIComponent | |
|
measureHTMLText(htmlText:String):TextLineMetrics
Measures the specified HTML text, which may contain HTML tags such
as
<font> and <b>,
assuming that it is displayed
in a single-line UITextField using a UITextFormat
determined by the styles of this UIComponent. | UIComponent | |
|
measureText(text:String):TextLineMetrics
Measures the specified text, assuming that it is displayed
in a single-line UITextField using a UITextFormat
determined by the styles of this UIComponent.
| UIComponent | |
|
move(x:Number, y:Number):void
Moves the component to a specified position within its parent.
| UIComponent | |
|
move_unprotected(x:Number, y:Number):void
Same as move, but cannot be prevented via the protection_move event.
| UIComponent | |
|
notifyStyleChangeInChildren(styleProp:String, recursive:Boolean):void
Propagates style changes to the children.
| UIComponent | |
|
owns(child:DisplayObject):Boolean
Returns
true if the chain of owner properties
points from child to this UIComponent. | UIComponent | |
|
parentChanged(p:DisplayObjectContainer):void
Called by Flex when a UIComponent object is added to or removed from a parent.
| UIComponent | |
|
prepareToPrint(target:IFlexDisplayObject):Object
Prepares an IFlexDisplayObject for printing.
| UIComponent | |
|
regenerateStyleCache(recursive:Boolean):void
Builds or rebuilds the CSS style cache for this component
and, if the
recursive parameter is true,
for all descendants of this component as well. | UIComponent | |
|
registerEffects(effects:Array):void
For each effect event, registers the EffectManager
as one of the event listeners.
| UIComponent | |
|
replayAutomatableEvent(event:Event):Boolean
Replays the specified event.
| UIComponent | |
|
resolveAutomationIDPart(criteria:Object):Array
Resolves a child by using the id provided.
| UIComponent | |
|
resumeBackgroundProcessing():void
[static]
Resumes the background processing of methods
queued by
callLater(), after a call to
suspendBackgroundProcessing(). | UIComponent | |
|
setActualSize(w:Number, h:Number):void
Sizes the object.
| UIComponent | |
|
setActualSize_unprotected(w:Number, h:Number):void
Same as setActualSize, but is not cancelable via the protection_size event.
| UIComponent | |
|
setConstraintValue(constraintName:String, value:*):void
Sets a layout constraint value, which is the same as
setting the constraint style for this component.
| UIComponent | |
|
setCurrentState(stateName:String, playTransition:Boolean = true):void
Set the current state.
| UIComponent | |
|
setFocus():void
Sets the focus to this component.
| UIComponent | |
|
setStyle(styleProp:String, newValue:*):void
Sets a style property on this component instance.
| UIComponent | |
|
setVisible(value:Boolean, noEvent:Boolean = false):void
Called when the
visible property changes. | UIComponent | |
|
setVisible_unprotected(value:Boolean, noEvent:Boolean = false):void
Same as setVisible, but cannot be prevented.
| UIComponent | |
|
styleChanged(styleProp:String):void
Detects changes to style properties.
| UIComponent | |
|
stylesInitialized():void
Flex calls the
stylesInitialized() method when
the styles for a component are first initialized. | UIComponent | |
|
suspendBackgroundProcessing():void
[static]
Blocks the background processing of methods
queued by
callLater(),
until resumeBackgroundProcessing() is called. | UIComponent | |
|
toString():String
Returns a string indicating the location of this object
within the hierarchy of DisplayObjects in the Application.
| FlexSprite | |
|
validateDisplayList():void
Validates the position and size of children and draws other
visuals.
| UIComponent | |
|
validateNow():void
Validate and update the properties and layout of this object
and redraw it, if necessary.
| UIComponent | |
|
validateProperties():void
Used by layout logic to validate the properties of a component
by calling the
commitProperties() method. | UIComponent | |
|
validateSize(recursive:Boolean = false):void
Validates the measured size of the component
If the
LayoutManager.invalidateSize() method is called with
this ILayoutManagerClient, then the validateSize() method
is called when it's time to do measurements. | UIComponent | |
|
validationResultHandler(event:ValidationResultEvent):void
Handles both the
valid and invalid events from a
validator assigned to this component. | UIComponent | |
|
verticalGradientMatrix(x:Number, y:Number, width:Number, height:Number):Matrix
Returns a box Matrix which can be passed to
drawRoundRect()
as the rot parameter when drawing a vertical gradient. | UIComponent | |
| Method | Defined by | ||
|---|---|---|---|
|
adjustFocusRect(obj:DisplayObject = null):void
Adjust the focus rectangle.
| UIComponent | |
|
attachOverlay():void
This is an internal method used by the Flex framework
to support the Dissolve effect.
| UIComponent | |
|
childrenCreated():void
Performs any final processing after child objects are created.
| UIComponent | |
|
clickHandler(event:MouseEvent):void
The default handler for the
MouseEvent.CLICK event. | Button | ||
|
commitProperties():void
Processes the properties set on the component.
| UIComponent | |
|
createChildren():void
Create child objects of the component.
| UIComponent | |
|
createInFontContext(classObj:Class):Object
Creates a new object using a context
based on the embedded font being used.
| UIComponent | |
|
createInModuleContext(moduleFactory:IFlexModuleFactory, className:String):Object
Creates the object using a given moduleFactory.
| UIComponent | |
|
focusInHandler(event:FocusEvent):void
The event handler called when a UIComponent object gets focus.
| UIComponent | |
|
focusOutHandler(event:FocusEvent):void
The event handler called when a UIComponent object loses focus.
| UIComponent | |
|
initializationComplete():void
Finalizes the initialization of this component.
| UIComponent | |
|
initializeAccessibility():void
Initializes this component's accessibility code.
| UIComponent | |
|
isOurFocus(target:DisplayObject):Boolean
Typically overridden by components containing UITextField objects,
where the UITextField object gets focus.
| UIComponent | |
|
keyDownHandler(event:KeyboardEvent):void
The event handler called for a
keyDown event. | UIComponent | |
|
keyUpHandler(event:KeyboardEvent):void
The event handler called for a
keyUp event. | UIComponent | |
|
measure():void
Calculates the default size, and optionally the default minimum size,
of the component.
| UIComponent | |
|
mouseDownHandler(event:MouseEvent):void
The default handler for the
MouseEvent.MOUSE_DOWN event. | Button | ||
|
mouseUpHandler(event:MouseEvent):void
The default handler for the
MouseEvent.MOUSE_UP event. | Button | ||
|
resourcesChanged():void
This method is called when a UIComponent is constructed,
and again whenever the ResourceManager dispatches
a
"change" Event to indicate
that the localized resources have changed in some way. | UIComponent | |
|
rollOutHandler(event:MouseEvent):void
The default handler for the
MouseEvent.ROLL_OUT event. | Button | ||
|
rollOverHandler(event:MouseEvent):void
The default handler for the
MouseEvent.ROLL_OVER event. | Button | ||
|
updateDisplayList(unscaledWidth:Number, unscaledHeight:Number):void
Draws the object and/or sizes and positions its children.
| UIComponent | |
| Event | Summary | Defined by | ||
|---|---|---|---|---|
|
Dispatched when the component is added to a container as a content child
by using the addChild() or addChildAt() method. | UIComponent | ||
| Dispatched when the user presses the Button control. | Button | |||
Dispatched when the selected property
changes for a toggle Button control. | Button | |||
| Dispatched when the component has finished its construction, property processing, measuring, layout, and drawing. | UIComponent | ||
| Dispatched after the view state has changed. | UIComponent | ||
|
Dispatched after the currentState property changes,
but before the view state changes. | UIComponent | ||
Dispatched when the data property changes. | Button | |||
| Dispatched by the drag initiator (the component that is the source of the data being dragged) when the drag operation completes, either when you drop the dragged data onto a drop target or when you end the drag-and-drop operation without performing a drop. | UIComponent | ||
| Dispatched by the drop target when the user releases the mouse over it. | UIComponent | ||
| Dispatched by a component when the user moves the mouse over the component during a drag operation. | UIComponent | ||
| Dispatched by the component when the user drags outside the component, but does not drop the data onto the target. | UIComponent | ||
| Dispatched by a component when the user moves the mouse while over the component during a drag operation. | UIComponent | ||
| Dispatched by the drag initiator when starting a drag operation. | UIComponent | ||
| Dispatched after an effect ends. | UIComponent | ||
| Dispatched just before an effect starts. | UIComponent | ||
| Dispatched after the component has returned to the root view state. | UIComponent | ||
| Dispatched before the component exits from the root view state. | UIComponent | ||
| Dispatched when an object's state changes from visible to invisible. | UIComponent | ||
| Dispatched when the component has finished its construction and has all initialization properties set. | UIComponent | ||
| Dispatched when a component is monitored by a Validator and the validation failed. | UIComponent | ||
| Dispatched from a component opened using the PopUpManager when the user clicks outside it. | UIComponent | ||
| Dispatched from a component opened using the PopUpManager when the user scrolls the mouse wheel outside it. | UIComponent | ||
| Dispatched when the object has moved. | UIComponent | ||
| Dispatched at the beginning of the component initialization sequence. | UIComponent | ||
| Dispatched when the component is about to be hidden (visible = false); calling event.preventDefault() will stop the action from occuring. | UIComponent | ||
| Dispatched when the component is about to be moved via move(); calling event.preventDefault() will stop the action from occuring. | UIComponent | ||
| Dispatched when the component is about to be shown (visible = true); calling event.preventDefault() will stop the action from occuring. | UIComponent | ||
| Dispatched when the component is about to be sized via setActualSize(); calling event.preventDefault() will stop the action from occuring. | UIComponent | ||
|
Dispatched when the component is removed from a container as a content child
by using the removeChild() or removeChildAt() method. | UIComponent | ||
| Dispatched when the component is resized. | UIComponent | ||
| Dispatched when an object's state changes from invisible to visible. | UIComponent | ||
| Dispatched by the component when it is time to create a ToolTip. | UIComponent | ||
| Dispatched by the component when its ToolTip has been hidden and will be discarded soon. | UIComponent | ||
| Dispatched by the component when its ToolTip is about to be hidden. | UIComponent | ||
| Dispatched by the component when its ToolTip is about to be shown. | UIComponent | ||
| Dispatched by the component when its ToolTip has been shown. | UIComponent | ||
|
Dispatched by a component whose toolTip property is set,
as soon as the user moves the mouse over it. | UIComponent | ||
|
Dispatched when an object has had its commitProperties(),
measure(), and
updateDisplayList() methods called (if needed). | UIComponent | ||
| Dispatched when a component is monitored by a Validator and the validation succeeded. | UIComponent | ||
| Dispatched when values are changed programmatically or by user interaction. | UIComponent | ||
| Style | Description | Defined by | ||
|---|---|---|---|---|
| Type: String CSS Inheritance: no The vertical distance in pixels from the top edge of the content area to the control's baseline position. | UIComponent | ||
|
borderColor
| Type: uint Format: Color CSS Inheritance: no Color of the border. The following controls support this style: Button, CheckBox, ComboBox, MenuBar, NumericStepper, ProgressBar, RadioButton, ScrollBar, Slider, and any components that support the borderStyle style.
The default value depends on the component class;
if not overriden for the class, the default value is 0xB7BABC.
| Button | ||
| Type: String CSS Inheritance: no The vertical distance in pixels from the lower edge of the component to the lower edge of its content area. | UIComponent | ||
| Type: Number CSS Inheritance: no The color brightness of the component. | UIComponent | ||
|
color
| Type: uint Format: Color CSS Inheritance: yes Color of text in the component, including the component label. The default value is 0x0B333C. | Button | ||
| Type: Number CSS Inheritance: no The color contrast of the component. | UIComponent | ||
|
cornerRadius
| Type: Number Format: Length CSS Inheritance: no Radius of component corners. The following components support this style: Alert, Button, ComboBox, LinkButton, MenuBar, NumericStepper, Panel, ScrollBar, Tab, TitleWindow, and any component that supports a borderStyle property set to "solid".
The default value depends on the component class;
if not overriden for the class, the default value is 0.
| Button | ||
|
disabledColor
| Type: uint Format: Color CSS Inheritance: yes Color of text in the component if it is disabled. The default value is 0xAAB3B3. | Button | ||
|
disabledIcon
| Type: Class CSS Inheritance: no Name of the class to use as the icon when the button is disabled and not selected. The default value is null. | Button | ||
|
disabledSkin
| Type: Class CSS Inheritance: no Name of the class to use as the skin for the background and border when the button is not selected and is disabled. The default value is "mx.skins.halo.ButtonSkin". | Button | ||
|
downIcon
| Type: Class CSS Inheritance: no Name of the class to use as the icon when the button is not selected and the mouse button is down. The default value is null. | Button | ||
|
downSkin
| Type: Class CSS Inheritance: no Name of the class to use as the skin for the background and border when the button is not selected and the mouse button is down. The default value is "mx.skins.halo.ButtonSkin". | Button | ||
| Type: uint Format: Color CSS Inheritance: yes Color of the component highlight when validation fails. | UIComponent | ||
|
fillAlphas
| Type: Array CSS Inheritance: no Alphas used for the background fill of controls. Use [1, 1] to make the control background opaque. The default value is [ 0.6, 0.4 ]. | Button | ||
|
fillColors
| Type: Array Format: Color CSS Inheritance: no Colors used to tint the background of the control. Pass the same color for both values for a flat-looking control. The default value is [ 0xFFFFFF, 0xCCCCCC ]. | Button | ||
|
focusAlpha
| Type: Number CSS Inheritance: no Specifies the alpha transparency value of the focus skin. The default value is 0.4. | Button | ||
| Type: String CSS Inheritance: no Blend mode used by the focus rectangle. | UIComponent | ||
|
focusRoundedCorners
| Type: String CSS Inheritance: no Specifies which corners of the focus rectangle should be rounded. This value is a space-separated String that can contain any combination of "tl", "tr", "bl"
and "br".
For example, to specify that the right side corners should be rounded,
but the left side corners should be square, use "tr br".
The cornerRadius style property specifies
the radius of the rounded corners.
The default value depends on the component class; if not overridden for
the class, default value is "tl tr bl br".
| Button | ||
| Type: Class CSS Inheritance: no Skin used to draw the focus rectangle. | UIComponent | ||
| Type: Number Format: Length CSS Inheritance: no Thickness, in pixels, of the focus rectangle outline. | UIComponent | ||
|
fontAntiAliasType
| Type: String CSS Inheritance: yes Sets the antiAliasType property of internal TextFields. The possible values are
"normal" (flash.text.AntiAliasType.NORMAL)
and "advanced" (flash.text.AntiAliasType.ADVANCED).
The default value is This style has no effect for system fonts. This style applies to all the text in a TextField subcontrol; you cannot apply it to some characters and not others. The default value is"advanced". | Button | ||
|
fontFamily
| Type: String CSS Inheritance: yes Name of the font to use. Unlike in a full CSS implementation, comma-separated lists are not supported. You can use any font family name. If you specify a generic font name, it is converted to an appropriate device font. The default value is "Verdana". | Button | ||
|
fontGridFitType
| Type: String CSS Inheritance: yes Sets the gridFitType property of internal TextFields that represent text in Flex controls.
The possible values are "none" (flash.text.GridFitType.NONE),
"pixel" (flash.text.GridFitType.PIXEL),
and "subpixel" (flash.text.GridFitType.SUBPIXEL).
This property only applies when you are using an embedded font
and the This style has no effect for system fonts. This style applies to all the text in a TextField subcontrol; you can't apply it to some characters and not others. The default value is"pixel". | Button | ||
|
fontSharpness
| Type: Number CSS Inheritance: yes Sets the sharpness property of internal TextFields that represent text in Flex controls.
This property specifies the sharpness of the glyph edges. The possible values are Numbers
from -400 through 400.
This property only applies when you are using an embedded font
and the This style has no effect for system fonts. This style applies to all the text in a TextField subcontrol; you can't apply it to some characters and not others. The default value is0. | Button | ||
|
fontSize
| Type: Number Format: Length CSS Inheritance: yes Height of the text, in pixels. The default value is 10 for all controls except the ColorPicker control. For the ColorPicker control, the default value is 11. | Button | ||
|
fontStyle
| Type: String CSS Inheritance: yes Determines whether the text is italic font. Recognized values are "normal" and "italic".
The default value is "normal". | Button | ||
|
fontThickness
| Type: Number CSS Inheritance: yes Sets the thickness property of internal TextFields that represent text in Flex controls.
This property specifies the thickness of the glyph edges.
The possible values are Numbers from -200 to 200.
This property only applies when you are using an embedded font
and the This style has no effect on system fonts. This style applies to all the text in a TextField subcontrol; you can't apply it to some characters and not others. The default value is0. | Button | ||
|
fontWeight
| Type: String CSS Inheritance: yes Determines whether the text is boldface. Recognized values are normal and bold.
The default value for Button controls is bold.
The default value for all other controls is normal.
| Button | ||
|
highlightAlphas
| Type: Array CSS Inheritance: no Alpha transparencies used for the highlight fill of controls. The first value specifies the transparency of the top of the highlight and the second value specifies the transparency of the bottom of the highlight. The highlight covers the top half of the skin. The default value is [ 0.3, 0.0 ]. | Button | ||
| Type: String CSS Inheritance: no The horizontal distance in pixels from the center of the component's content area to the center of the component. | UIComponent | ||
|
horizontalGap
| Type: Number Format: Length CSS Inheritance: no Gap between the label and icon, when the labelPlacement property
is set to left or right.
The default value is 2. | Button | ||
| Type: Number CSS Inheritance: no The color hue of the component. | UIComponent | ||
|
icon
| Type: Class CSS Inheritance: no Name of the class to use as the default icon. Setting any other icon style overrides this setting. The default value is null. | Button | ||
|
kerning
| Type: Boolean CSS Inheritance: yes A Boolean value that indicates whether kerning is enabled ( true) or disabled (false).
Kerning adjusts the gap between certain character pairs
to improve readability, and should be used only when necessary,
such as with headings in large fonts.
Kerning is supported for embedded fonts only.
Certain fonts, such as Verdana, and monospaced fonts,
such as Courier New, do not support kerning.
The default value is false. | Button | ||
|
leading
| Type: Number Format: Length CSS Inheritance: yes Additional vertical space between lines of text. The default value is 2. The default value for the ComboBox control is 0. | Button | ||
| Type: String CSS Inheritance: no The horizontal distance in pixels from the left edge of the component's content area to the left edge of the component. | UIComponent | ||
|
letterSpacing
| Type: Number CSS Inheritance: yes The number of additional pixels to appear between each character. A positive value increases the character spacing beyond the normal spacing, while a negative value decreases it. The default value is 0. | Button | ||
| Type: Number CSS Inheritance: no The opacity of the component. | UIComponent | ||
|
overIcon
| Type: Class CSS Inheritance: no Name of the class to use as the icon when the button is not selected and the mouse is over the control. The default value is null. | Button | ||
|
overSkin
| Type: Class CSS Inheritance: no Name of the class to use as the skin for the background and border when the button is not selected and the mouse is over the control. The default value is "mx.skins.halo.ButtonSkin". | Button | ||
|
paddingBottom
| Type: Number Format: Length CSS Inheritance: no Number of pixels between the component's bottom border and the bottom of its content area. The default value is 0. | Button | ||
|
paddingLeft
| Type: Number Format: Length CSS Inheritance: no Number of pixels between the component's left border and the left edge of its content area. The default value is 0. The default value for a Button control is 10. The default value for the ComboBox control is 5. The default value for the Form container is 16. The default value for the Tree control is 2. | Button | ||
|
paddingRight
| Type: Number Format: Length CSS Inheritance: no Number of pixels between the component's right border and the right edge of its content area. The default value is 0. The default value for a Button control is 10. The default value for the ComboBox control is 5. The default value for the Form container is 16. | Button | ||
|
paddingTop
| Type: Number Format: Length CSS Inheritance: no Number of pixels between the component's top border and the top of its content area. The default value is 0. | Button | ||
|
repeatDelay
| Type: Number Format: Time CSS Inheritance: no Number of milliseconds to wait after the first buttonDown
event before repeating buttonDown events at each
repeatInterval.
The default value is 500. | Button | ||
|
repeatInterval
| Type: Number Format: Time CSS Inheritance: no Number of milliseconds between buttonDown events
if the user presses and holds the mouse on a button.
The default value is 35. | Button | ||
| Type: String CSS Inheritance: no The horizontal distance in pixels from the right edge of the component to the right edge of its content area. | UIComponent | ||
| Type: Number CSS Inheritance: no The color saturation of the component. | UIComponent | ||
|
selectedDisabledIcon
| Type: Class CSS Inheritance: no Name of the class to use as the icon when the button is selected and disabled. The default value is null. | Button | ||
|
selectedDisabledSkin
| Type: Class CSS Inheritance: no Name of the class to use as the skin for the background and border when a toggle button is selected and disabled. The default value is "mx.skins.halo.ButtonSkin". | Button | ||
|
selectedDownIcon
| Type: Class CSS Inheritance: no Name of the class to use as the icon when the button is selected and the mouse button is down. The default value is null. | Button | ||
|
selectedDownSkin
| Type: Class CSS Inheritance: no Name of the class to use as the skin for the background and border when a toggle button is selected and the mouse button is down. The default value is "mx.skins.halo.ButtonSkin". | Button | ||
|
selectedOverIcon
| Type: Class CSS Inheritance: no Name of the class to use as the icon when the button is selected and the mouse is over the control. The default value is null. | Button | ||
|
selectedOverSkin
| Type: Class CSS Inheritance: no Name of the class to use as the skin for the background and border when a toggle button is selected and the mouse is over the control. The default value is "mx.skins.halo.ButtonSkin". | Button | ||
|
selectedUpIcon
| Type: Class CSS Inheritance: no Name of the class to use as the icon when the button is selected and the mouse button is up. The default value is null. | Button | ||
|
selectedUpSkin
| Type: Class CSS Inheritance: no Name of the class to use as the skin for the background and border when a toggle button is selected and the mouse is not over the control. The default value is "mx.skins.halo.ButtonSkin". | Button | ||
|
skin
| Type: Class CSS Inheritance: no Name of the class to use as the default skin for the background and border. The default value is "mx.skins.halo.ButtonSkin". | Button | ||
|
textAlign
| Type: String CSS Inheritance: yes Alignment of text within a container. Possible values are "left", "right",
or "center".
The default value for most components is | Button | ||
|
textDecoration
| Type: String CSS Inheritance: yes Determines whether the text is underlined. Possible values are "none" and "underline".
The default value is "none". | Button | ||
|
textIndent
| Type: Number Format: Length CSS Inheritance: yes Offset of first line of text from the left side of the container, in pixels. The default value is 0. | Button | ||
|
textRollOverColor
| Type: uint Format: Color CSS Inheritance: yes Text color of the label as the user moves the mouse pointer over the button. The default value is 0x2B333C. | Button | ||
|
textSelectedColor
| Type: uint Format: Color CSS Inheritance: yes Text color of the label as the user presses it. The default value is 0x000000. | Button | ||
| Type: uint Format: Color CSS Inheritance: yes Theme color of a component. | UIComponent | ||
| Type: String CSS Inheritance: no The vertical distance in pixels from the top edge of the control's content area to the top edge of the component. | UIComponent | ||
|
upIcon
| Type: Class CSS Inheritance: no Name of the class to use as the icon when a toggle button is not selected and the mouse is not over the button. The default value is null. | Button | ||
|
upSkin
| Type: Class CSS Inheritance: no Name of the class to use as the skin for the background and border when the button is not selected and the mouse is not over the control. The default value is "mx.skins.halo.ButtonSkin". | Button | ||
| Type: String CSS Inheritance: no The vertical distance in pixels from the center of the component's content area to the center of the component. | UIComponent | ||
|
verticalGap
| Type: Number Format: Length CSS Inheritance: no Gap between the button's label and icon when the labelPlacement
property is set to "top" or "bottom".
The default value is 2. | Button | ||
| autoRepeat | property |
autoRepeat:Boolean [read-write]
Specifies whether to dispatch repeated buttonDown
events if the user holds down the mouse button.
The default value is false.
public function get autoRepeat():Boolean
public function set autoRepeat(value:Boolean):void
| data | property |
data:Object [read-write]
The data property lets you pass a value
to the component when you use it as an item renderer or item editor.
You typically use data binding to bind a field of the data
property to a property of this component.
When you use the control as a drop-in item renderer or drop-in
item editor, Flex automatically writes the current value of the item
to the selected property of this control.
You do not set this property in MXML.
The default value is null.
This property can be used as the source for data binding.
Implementation public function get data():Object
public function set data(value:Object):void
See also
| emphasized | property |
emphasized:Boolean [read-write]
Draws a thick border around the Button control
when the control is in its up state if emphasized
is set to true.
The default value is false.
public function get emphasized():Boolean
public function set emphasized(value:Boolean):void
| fontContext | property |
fontContext:IFlexModuleFactory [read-write]The module factory that provides the font context for this component.
Implementation public function get fontContext():IFlexModuleFactory
public function set fontContext(value:IFlexModuleFactory):void
| label | property |
label:String [read-write]Text to appear on the Button control.
If the label is wider than the Button control,
the label is truncated and terminated by an ellipsis (...).
The full label displays as a tooltip
when the user moves the mouse over the Button control.
If you have also set a tooltip by using the tooltip
property, the tooltip is displayed rather than the label text.
The default value is "".
This property can be used as the source for data binding.
Implementation public function get label():String
public function set label(value:String):void
| labelPlacement | property |
labelPlacement:String [read-write]
Orientation of the label in relation to a specified icon.
Valid MXML values are right, left,
bottom, and top.
In ActionScript, you can use the following constants
to set this property:
ButtonLabelPlacement.RIGHT,
ButtonLabelPlacement.LEFT,
ButtonLabelPlacement.BOTTOM, and
ButtonLabelPlacement.TOP.
The default value is ButtonLabelPlacement.RIGHT.
This property can be used as the source for data binding.
Implementation public function get labelPlacement():String
public function set labelPlacement(value:String):void
| listData | property |
listData:BaseListData [read-write]
When a component is used as a drop-in item renderer or drop-in
item editor, Flex initializes the listData property
of the component with the appropriate data from the list control.
The component can then use the listData property
to initialize the data property
of the drop-in item renderer or drop-in item editor.
You do not set this property in MXML or ActionScript; Flex sets it when the component is used as a drop-in item renderer or drop-in item editor.
The default value is null.
This property can be used as the source for data binding.
Implementation public function get listData():BaseListData
public function set listData(value:BaseListData):void
See also
| selected | property |
selected:Boolean [read-write]
Indicates whether a toggle button is toggled
on (true) or off (false).
This property can be set only if the toggle property
is set to true.
For a CheckBox control, indicates whether the box is displaying a check mark. For a RadioButton control, indicates whether the control is selected.
The user can change this property by clicking the control, but you can also set the property programmatically.
In previous versions, If the toggle property
was set to true, changing this property also dispatched
a change event. Starting in version 3.0, setting this
property programmatically only dispatches a
valueCommit event.
The default value is false.
This property can be used as the source for data binding.
Implementation public function get selected():Boolean
public function set selected(value:Boolean):void
| selectedField | property |
public var selectedField:String = "null"
The name of the field in the data property which specifies
the value of the Button control's selected property.
You can set this property when you use the Button control in an item renderer.
The default value is null, which means that the Button control does
not set its selected state based on a property in the data property.
The default value is null.
| stickyHighlighting | property |
public var stickyHighlighting:Boolean = false
If false, the Button displays its down skin
when the user presses it but changes to its over skin when
the user drags the mouse off of it.
If true, the Button displays its down skin
when the user presses it, and continues to display this skin
when the user drags the mouse off of it.
Button subclasses, such as the SliderThumb and ScrollThumb classes
or the up and down arrows of a ScrollBar, set
this property to true.
The default value is false.
| textField | property |
protected var textField:IUITextFieldThe internal UITextField object that renders the label of this Button.
The default value is null.
| toggle | property |
toggle:Boolean [read-write]
Controls whether a Button is in a toggle state or not.
If true, clicking the button toggles it
between a selected and an unselected state.
You can get or set this state programmatically
by using the selected property.
If false, the button does not stay pressed
after the user releases it.
In this case, its selected property
is always false.
Buttons like this are used for performing actions.
When toggle is set to false,
selected is forced to false
because only toggle buttons can be selected.
The default value is false.
This property can be used as the source for data binding.
Implementation public function get toggle():Boolean
public function set toggle(value:Boolean):void
| Button | () | constructor |
public function Button()Constructor.
| clickHandler | () | method |
protected function clickHandler(event:MouseEvent):void
The default handler for the MouseEvent.CLICK event.
event:MouseEvent — event object.
|
| mouseDownHandler | () | method |
protected function mouseDownHandler(event:MouseEvent):void
The default handler for the MouseEvent.MOUSE_DOWN event.
event:MouseEvent — event object.
|
| mouseUpHandler | () | method |
protected function mouseUpHandler(event:MouseEvent):void
The default handler for the MouseEvent.MOUSE_UP event.
event:MouseEvent — event object.
|
| rollOutHandler | () | method |
protected function rollOutHandler(event:MouseEvent):void
The default handler for the MouseEvent.ROLL_OUT event.
event:MouseEvent — event object.
|
| rollOverHandler | () | method |
protected function rollOverHandler(event:MouseEvent):void
The default handler for the MouseEvent.ROLL_OVER event.
event:MouseEvent — event object.
|
| buttonDown | event |
mx.events.FlexEvent
mx.events.FlexEvent.BUTTON_DOWN
Dispatched when the user presses the Button control.
If the autoRepeat property is true,
this event is dispatched repeatedly as long as the button stays down.
The FlexEvent.BUTTON_DOWN constant defines the value of the
type property of the event object for a buttonDown event.
The properties of the event object have the following values:
| Property | Value |
|---|---|
bubbles | false |
cancelable | false |
currentTarget | The Object that defines the
event listener that handles the event. For example, if you use
myButton.addEventListener() to register an event listener,
myButton is the value of the currentTarget. |
target | The Object that dispatched the event;
it is not always the Object listening for the event.
Use the currentTarget property to always access the
Object listening for the event. |
| change | event |
flash.events.Event
Dispatched when the selected property
changes for a toggle Button control. A toggle Button control means that the
toggle property is set to true.
For the RadioButton controls, this event is dispatched when the selected
property changes.
For the CheckBox controls, this event is dispatched only when the
user interacts with the control by using the mouse.
| dataChange | event |
mx.events.FlexEvent
mx.events.FlexEvent.DATA_CHANGE
Dispatched when the data property changes.
When you use a component as an item renderer,
the data property contains the data to display.
You can listen for this event and update the component
when the data property changes.
The FlexEvent.DATA_CHANGE constant defines the value of the
type property of the event object for a dataChange event.
The properties of the event object have the following values:
| Property | Value |
|---|---|
bubbles | false |
cancelable | false |
currentTarget | The Object that defines the
event listener that handles the event. For example, if you use
myButton.addEventListener() to register an event listener,
myButton is the value of the currentTarget. |
target | The Object that dispatched the event;
it is not always the Object listening for the event.
Use the currentTarget property to always access the
Object listening for the event. |