| Package | mx.controls |
| Class | public class Button |
| Inheritance | Button  UIComponent FlexSprite Sprite DisplayObjectContainer InteractiveObject DisplayObject EventDispatcher Object |
| Implements | IDataRenderer, IDropInListItemRenderer, IFocusManagerComponent, IListItemRenderer, IFontContextComponent, IButton |
| Subclasses | AccordionHeader, CheckBox, LinkButton, PopUpButton, RadioButton, 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 SyntaxThe <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 | ||
|---|---|---|---|
 | accessibilityProperties : AccessibilityProperties
The current accessibility options for this display object. | DisplayObject | |
| activeEffects : Array [read-only]
The list of effects that are currently playing on the component,
as an Array of EffectInstance instances. | UIComponent | |
| alpha : Number
Indicates the alpha transparency value of the object specified. | DisplayObject | |
| 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 [read-only]
An implementation of the IAutomationTabularData interface, which
can be used to retrieve the data. | UIComponent | |
| automationValue : Array [read-only]
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 [read-only]
The y-coordinate of the baseline
of the first line of text of the component. | UIComponent | |
| blendMode : String
A value from the BlendMode class that specifies which blend mode to use. | DisplayObject | |
| blendShader : Shader [write-only]
Sets a shader that is used for blending the foreground and background. | DisplayObject | |
| buttonMode : Boolean
Specifies the button mode of this sprite. | Sprite | |
| cacheAsBitmap : Boolean
If set to true, Flash Player or Adobe AIR caches an internal bitmap representation of the
display object. | DisplayObject | |
| cacheHeuristic : Boolean [write-only]
Used by Flex to suggest bitmap caching for the object. | UIComponent | |
| cachePolicy : String
Specifies the bitmap caching policy for this object. | UIComponent | |
| className : String [read-only]
The name of this instance's class, such as "Button". | UIComponent | |
| constructor : Object
A reference to the class object or constructor function for a given object instance. | Object | |
| contentMouseX : Number [read-only]
Returns the x position of the mouse, in the content coordinate system. | UIComponent | |
| contentMouseY : Number [read-only]
Returns the y position of the mouse, in the content coordinate system. | UIComponent | |
| contextMenu : NativeMenu
Specifies the context menu associated with this object. | InteractiveObject | |
| currentState : String
The current view state of the component. | UIComponent | |
| cursorManager : ICursorManager [read-only]
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 [override]
Specifies whether the UIComponent object receives doubleClick events. | UIComponent | |
| dropTarget : DisplayObject [read-only]
Specifies the display object over which the sprite is being dragged, or on
which the sprite was dropped. | Sprite | |
| 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
The maximum recommended height of the component to be considered
by the parent during layout. | UIComponent | |
| explicitMaxWidth : Number
The maximum recommended width of the component to be considered
by the parent during layout. | UIComponent | |
| explicitMinHeight : Number
The minimum recommended height of the component to be considered
by the parent during layout. | UIComponent | |
| explicitMinWidth : Number
The minimum recommended width of the component to be considered
by the parent during layout. | UIComponent | |
| explicitWidth : Number
Number that specifies the explicit width of the component,
in pixels, in the component's coordinates. | UIComponent | |
| filters : Array
An indexed array that contains each filter object currently associated with the display object. | DisplayObject | |
| 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 | |
| focusRect : Object
Specifies whether this object displays a focus rectangle. | InteractiveObject | |
| fontContext : IFlexModuleFactory
The module factory that provides the font context for this component. | Button | ||
| graphics : Graphics [read-only]
Specifies the Graphics object that belongs to this sprite where vector
drawing commands can occur. | Sprite | |
| height : Number [override]
Number that specifies the height of the component, in pixels,
in the parent's coordinates. | UIComponent | |
| hitArea : Sprite
Designates another sprite to serve as the hit area for a sprite. | Sprite | |
| 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 [read-only]
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 [read-only]
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 | ||
| loaderInfo : LoaderInfo [read-only]
Returns a LoaderInfo object containing information about loading the file
to which this display object belongs. | DisplayObject | |
| mask : DisplayObject
The calling display object is masked by the specified mask object. | DisplayObject | |
| maxHeight : Number
The maximum recommended height of the component to be considered
by the parent during layout. | UIComponent | |
| maxWidth : Number
The maximum recommended width of the component to be considered
by the parent during layout. | 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
The minimum recommended height of the component to be considered
by the parent during layout. | UIComponent | |
| minWidth : Number
The minimum recommended width of the component to be considered
by the parent during layout. | UIComponent | |
| moduleFactory : IFlexModuleFactory
The moduleFactory that is used to create TextFields in the correct SWF context. | UIComponent | |
| mouseChildren : Boolean
Determines whether or not the children of the object are mouse enabled. | DisplayObjectContainer | |
| mouseEnabled : Boolean
Specifies whether this object receives mouse messages. | InteractiveObject | |
| mouseFocusEnabled : Boolean
Whether you can receive focus when clicked on. | UIComponent | |
| mouseX : Number [read-only]
Indicates the x coordinate of the mouse position, in pixels. | DisplayObject | |
| mouseY : Number [read-only]
Indicates the y coordinate of the mouse position, in pixels. | DisplayObject | |
| name : String
Indicates the instance name of the DisplayObject. | DisplayObject | |
| 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 [read-only]
The number of automation children this container has. | UIComponent | |
| numChildren : int [read-only]
Returns the number of children of this object. | DisplayObjectContainer | |
| opaqueBackground : Object
Specifies whether the display object is opaque with a certain background color. | DisplayObject | |
| owner : DisplayObjectContainer
The owner of this UIComponent. | UIComponent | |
| parent : DisplayObjectContainer [override] [read-only]
The parent container or component for this component. | UIComponent | |
| parentApplication : Object [read-only]
A reference to the Application object that contains this UIComponent
instance. | UIComponent | |
| parentDocument : Object [read-only]
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 | |
| prototype : Object [static]
A reference to the prototype object of a class or function object. | Object | |
| repeater : IRepeater [read-only]
A reference to the Repeater object
in the parent document that produced this UIComponent. | UIComponent | |
| repeaterIndex : int [read-only]
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 | |
| root : DisplayObject [read-only]
For a display object in a loaded SWF file, the root property is the
top-most display object in the portion of the display list's tree structure represented by that SWF file. | DisplayObject | |
| rotation : Number
Indicates the rotation of the DisplayObject instance, in degrees, from its original orientation. | DisplayObject | |
| rotationX : Number
Indicates the x-axis rotation of the DisplayObject instance, in degrees, from its original orientation relative to the 3D parent container. | DisplayObject | |
| rotationY : Number
Indicates the y-axis rotation of the DisplayObject instance, in degrees, from its original orientation relative to the 3D parent container. | DisplayObject | |
| rotationZ : Number
Indicates the z-axis rotation of the DisplayObject instance, in degrees, from its original orientation relative to the 3D parent container. | DisplayObject | |
| scale9Grid : Rectangle
The current scaling grid that is in effect. | DisplayObject | |
| scaleX : Number [override]
Number that specifies the horizontal scaling factor. | UIComponent | |
| scaleY : Number [override]
Number that specifies the vertical scaling factor. | UIComponent | |
| scaleZ : Number
Indicates the depth scale (percentage) of an object as applied from the registration point of the object. | DisplayObject | |
| screen : Rectangle [read-only]
Returns an object that contains the size and position of the base
drawing surface for this object. | UIComponent | |
| scrollRect : Rectangle
The scroll rectangle bounds of the display object. | DisplayObject | |
| 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 | ||
| showInAutomationHierarchy : Boolean
A flag that determines if an automation object
shows in the automation hierarchy. | UIComponent | |
| soundTransform : flash.media:SoundTransform
Controls sound within this sprite. | Sprite | |
| stage : Stage [read-only]
The Stage of the display object. | DisplayObject | |
| 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 | ||
| 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 | |
| tabChildren : Boolean
Determines whether the children of the object are tab enabled. | DisplayObjectContainer | |
| tabEnabled : Boolean
Specifies whether this object is in the tab order. | InteractiveObject | |
| tabIndex : int
Specifies the tab ordering of objects in a SWF file. | InteractiveObject | |
| textSnapshot : flash.text:TextSnapshot [read-only]
Returns a TextSnapshot object for this DisplayObjectContainer instance. | DisplayObjectContainer | |
| toggle : Boolean
Controls whether a Button is in a toggle state or not. | Button | ||
| toolTip : String
Text to display in the ToolTip. | UIComponent | |
| transform : flash.geom:Transform
An object with properties pertaining to a display object's matrix, color transform, and pixel bounds. | DisplayObject | |
| 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 | |
| useHandCursor : Boolean
A Boolean value that indicates whether the pointing hand (hand cursor) appears when the mouse rolls
over a sprite in which the buttonMode property is set to true. | Sprite | |
| validationSubField : String
Used by a validator to associate a subfield with this component. | UIComponent | |
| visible : Boolean [override]
Controls the visibility of this UIComponent. | UIComponent | |
| width : Number [override]
Number that specifies the width of the component, in pixels,
in the parent's coordinates. | UIComponent | |
| x : Number [override]
Number that specifies the component's horizontal position,
in pixels, within its parent container. | UIComponent | |
| y : Number [override]
Number that specifies the component's vertical position,
in pixels, within its parent container. | UIComponent | |
| z : Number
Indicates the z coordinate position along the z-axis of the DisplayObject
instance relative to the 3D parent container. | DisplayObject | |
| Property | Defined By | ||
|---|---|---|---|
| resourceManager : IResourceManager [read-only]
A reference to the object which manages
all of the application's localized resources. | UIComponent | |
| textField : mx.core:IUITextField
The internal UITextField object that renders the label of this Button. | Button | ||
| unscaledHeight : Number [read-only]
A convenience method for determining the unscaled height
of the component. | UIComponent | |
| unscaledWidth : Number [read-only]
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 | ||
|
Adds a child DisplayObject instance to this DisplayObjectContainer instance. | DisplayObjectContainer | |
|
Adds a child DisplayObject instance to this DisplayObjectContainer
instance. | DisplayObjectContainer | |
| addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void
Registers an event listener object with an EventDispatcher object so that the listener
receives notification of an event. | EventDispatcher | |
|
Indicates whether the security restrictions
would cause any display objects to be omitted from the list returned by calling
the DisplayObjectContainer.getObjectsUnderPoint() method
with the specified point point. | DisplayObjectContainer | |
|
Queues a function to be called later. | UIComponent | |
|
Deletes a style property from this component instance. | UIComponent | |
|
Determines whether the specified display object is a child of the DisplayObjectContainer instance or
the instance itself. | DisplayObjectContainer | |
|
Converts a Point object from content coordinates to global coordinates. | UIComponent | |
|
Converts a Point object from content to local coordinates. | UIComponent | |
|
Returns a set of properties that identify the child within
this container. | UIComponent | |
|
Creates an id reference to this IUIComponent object
on its parent document object. | UIComponent | |
|
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 | |
| [override]
Dispatches an event into the event flow. | UIComponent | |
|
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 | |
|
Called by the effect instance when it stops playing on the component. | UIComponent | |
|
Called by the effect instance when it starts playing on the component. | UIComponent | |
|
Ends all currently playing effects on the component. | UIComponent | |
|
Executes the data bindings into this UIComponent object. | UIComponent | |
|
Called after printing is complete. | UIComponent | |
|
Provides the automation object at the specified index. | UIComponent | |
|
Returns a rectangle that defines the area of the display object relative to the coordinate system
of the targetCoordinateSpace object. | DisplayObject | |
|
Returns the child display object instance that exists at the specified index. | DisplayObjectContainer | |
|
Returns the child display object that exists with the specified name. | DisplayObjectContainer | |
|
Returns the index position of a child DisplayObject instance. | DisplayObjectContainer | |
|
Finds the type selectors for this UIComponent instance. | UIComponent | |
|
Returns a layout constraint value, which is the same as
getting the constraint style for this component. | UIComponent | |
|
A convenience method for determining whether to use the
explicit or measured height
| UIComponent | |
|
A convenience method for determining whether to use the
explicit or measured width
| UIComponent | |
|
Gets the object that currently has focus. | UIComponent | |
|
Returns an array of objects that lie under the specified point and are children
(or grandchildren, and so on) of this DisplayObjectContainer instance. | DisplayObjectContainer | |
|
Returns a rectangle that defines the boundary of the display object,
based on the coordinate system defined by the targetCoordinateSpace
parameter, excluding any strokes on shapes. | DisplayObject | |
|
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 | |
|
Gets a style property that has been set anywhere in this
component's style lookup chain. | UIComponent | |
|
Converts a Point object from global to content coordinates. | UIComponent | |
|
Converts the point object from the Stage (global) coordinates
to the display object's (local) coordinates. | DisplayObject | |
|
Converts a two-dimensional point from the Stage (global) coordinates to a
three-dimensional display object's (local) coordinates. | DisplayObject | |
|
Checks whether the EventDispatcher object has any listeners registered for a specific type
of event. | EventDispatcher | |
|
Indicates whether an object has a specified property defined. | Object | |
|
Evaluates the bounding box of the display object to see if it overlaps or intersects with the
bounding box of the obj display object. | DisplayObject | |
|
Evaluates the display object to see if it overlaps or intersects with the
point specified by the x and y parameters. | DisplayObject | |
|
Returns a box Matrix which can be passed to the
drawRoundRect() method
as the rot parameter when drawing a horizontal gradient. | UIComponent | |
|
Initializes the internal structure of this component. | UIComponent | |
|
Initializes various properties which keep track of repeated instances
of this component. | UIComponent | |
|
Marks a component so that its updateDisplayList()
method gets called during a later screen update. | UIComponent | |
|
Marks a component so that its commitProperties()
method gets called during a later screen update. | UIComponent | |
|
Marks a component so that its measure()
method gets called during a later screen update. | UIComponent | |
|
Indicates whether an instance of the Object class is in the prototype chain of the object specified
as the parameter. | Object | |
|
Converts a three-dimensional point of the three-dimensional display
object's (local) coordinates to a two-dimensional point in the Stage (global) coordinates. | DisplayObject | |
|
Converts a Point object from local to content coordinates. | UIComponent | |
|
Converts the point object from the display object's (local) coordinates to the
Stage (global) coordinates. | DisplayObject | |
|
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 | |
|
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 | |
|
Moves the component to a specified position within its parent. | UIComponent | |
|
Propagates style changes to the children. | UIComponent | |
|
Returns true if the chain of owner properties
points from child to this UIComponent. | UIComponent | |
|
Called by Flex when a UIComponent object is added to or removed from a parent. | UIComponent | |
|
Prepares an IFlexDisplayObject for printing. | UIComponent | |
|
Indicates whether the specified property exists and is enumerable. | Object | |
|
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 | |
|
For each effect event, registers the EffectManager
as one of the event listeners. | UIComponent | |
|
Removes the specified child DisplayObject instance from the child list of the DisplayObjectContainer instance. | DisplayObjectContainer | |
|
Removes a child DisplayObject from the specified index position in the child list of
the DisplayObjectContainer. | DisplayObjectContainer | |
|
Removes a listener from the EventDispatcher object. | EventDispatcher | |
|
Replays the specified event. | UIComponent | |
|
Resolves a child by using the id provided. | UIComponent | |
| [static]
Resumes the background processing of methods
queued by callLater(), after a call to
suspendBackgroundProcessing(). | UIComponent | |
|
Sizes the object. | UIComponent | |
|
Changes the position of an existing child in the display object container. | DisplayObjectContainer | |
|
Sets a layout constraint value, which is the same as
setting the constraint style for this component. | UIComponent | |
|
Set the current state. | UIComponent | |
|
Sets the focus to this component. | UIComponent | |
|
Sets the availability of a dynamic property for loop operations. | Object | |
|
Sets a style property on this component instance. | UIComponent | |
|
Called when the visible property changes. | UIComponent | |
|
Lets the user drag the specified sprite. | Sprite | |
|
Ends the startDrag() method. | Sprite | |
|
Detects changes to style properties. | UIComponent | |
|
Flex calls the stylesInitialized() method when
the styles for a component are first initialized. | UIComponent | |
| [static]
Blocks the background processing of methods
queued by callLater(),
until resumeBackgroundProcessing() is called. | UIComponent | |
|
Swaps the z-order (front-to-back order) of the two specified child objects. | DisplayObjectContainer | |
|
Swaps the z-order (front-to-back order) of the child objects at the two specified index positions in the
child list. | DisplayObjectContainer | |
|
Returns the string representation of this object, formatted according to locale-specific conventions. | Object | |
| [override]
Returns a string indicating the location of this object
within the hierarchy of DisplayObjects in the Application. | FlexSprite | |
|
Validates the position and size of children and draws other
visuals. | UIComponent | |
|
Validate and update the properties and layout of this object
and redraw it, if necessary. | UIComponent | |
|
Used by layout logic to validate the properties of a component
by calling the commitProperties() method. | UIComponent | |
|
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 | |
|
Handles both the valid and invalid events from a
validator assigned to this component. | UIComponent | |
|
Returns the primitive value of the specified object. | Object | |
|
Returns a box Matrix which can be passed to drawRoundRect()
as the rot parameter when drawing a vertical gradient. | UIComponent | |
|
Checks whether an event listener is registered with this EventDispatcher object or any of
its ancestors for the specified event type. | EventDispatcher | |
| Method | Defined By | ||
|---|---|---|---|
|
Adjust the focus rectangle. | UIComponent | |
|
This is an internal method used by the Flex framework
to support the Dissolve effect. | UIComponent | |
|
Performs any final processing after child objects are created. | UIComponent | |
The default handler for the MouseEvent.CLICK event. | Button | ||
|
Processes the properties set on the component. | UIComponent | |
|
Create child objects of the component. | UIComponent | |
|
Creates a new object using a context
based on the embedded font being used. | UIComponent | |
|
Creates the object using a given moduleFactory. | UIComponent | |
|
The event handler called when a UIComponent object gets focus. | UIComponent | |
|
The event handler called when a UIComponent object loses focus. | UIComponent | |
|
Finalizes the initialization of this component. | UIComponent | |
|
Initializes this component's accessibility code. | UIComponent | |
|
Typically overridden by components containing UITextField objects,
where the UITextField object gets focus. | UIComponent | |
|
The event handler called for a keyDown event. | UIComponent | |
|
The event handler called for a keyUp event. | UIComponent | |
|
Calculates the default size, and optionally the default minimum size,
of the component. | UIComponent | |
The default handler for the MouseEvent.MOUSE_DOWN event. | Button | ||
The default handler for the MouseEvent.MOUSE_UP event. | Button | ||
|
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 | |
The default handler for the MouseEvent.ROLL_OUT event. | Button | ||
The default handler for the MouseEvent.ROLL_OVER event. | Button | ||
|
Draws the object and/or sizes and positions its children. | UIComponent | |
| Event | Summary | Defined By | ||
|---|---|---|---|---|
| [broadcast event] Dispatched when the Flash Player or AIR application gains operating system focus and becomes active. | EventDispatcher | ||
| Dispatched when the component is added to a container as a content child by using the addChild() or addChildAt() method. | UIComponent | ||
| Dispatched when a display object is added to the display list. | DisplayObject | ||
| Dispatched when a display object is added to the on stage display list, either directly or through the addition of a sub tree in which the display object is contained. | DisplayObject | ||
| Dispatched when the user presses the Button control. | Button | |||
| Dispatched when the selected property changes for a toggle Button control. | Button | |||
| Dispatched when the user selects 'Clear' (or 'Delete') from the text context menu. | InteractiveObject | ||
| Dispatched when a user presses and releases the main button of the user's pointing device over the same InteractiveObject. | InteractiveObject | ||
| Dispatched when a user gesture triggers the context menu associated with this interactive object in an AIR application. | InteractiveObject | ||
| Dispatched when the user activates the platform specific accelerator key combination for a copy operation or selects 'Copy' from the text context menu. | InteractiveObject | ||
| 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 user activates the platform specific accelerator key combination for a cut operation or selects 'Cut' from the text context menu. | InteractiveObject | ||
| Dispatched when the data property changes. | Button | |||
| [broadcast event] Dispatched when the Flash Player or AIR application operating loses system focus and is becoming inactive. | EventDispatcher | ||
| Dispatched when a user presses and releases the main button of a pointing device twice in rapid succession over the same InteractiveObject when that object's doubleClickEnabled flag is set to true. | InteractiveObject | ||
| 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 | ||
| [broadcast event] Dispatched when the playhead is entering a new frame. | DisplayObject | ||
| Dispatched after the component has returned to the root view state. | UIComponent | ||
| [broadcast event] Dispatched when the playhead is exiting the current frame. | DisplayObject | ||
| Dispatched before the component exits from the root view state. | UIComponent | ||
| Dispatched after a display object gains focus. | InteractiveObject | ||
| Dispatched after a display object loses focus. | InteractiveObject | ||
| [broadcast event] Dispatched after the constructors of frame display objects have run but before frame scripts have run. | DisplayObject | ||
| 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 when the user presses a key. | InteractiveObject | ||
| Dispatched when the user attempts to change focus by using keyboard navigation. | InteractiveObject | ||
| Dispatched when the user releases a key. | InteractiveObject | ||
| Dispatched when a user presses and releases the middle button of the user's pointing device over the same InteractiveObject. | InteractiveObject | ||
| Dispatched when a user presses the middle pointing device button over an InteractiveObject instance. | InteractiveObject | ||
| Dispatched when a user releases the pointing device button over an InteractiveObject instance. | InteractiveObject | ||
| Dispatched when a user presses the pointing device button over an InteractiveObject instance. | InteractiveObject | ||
| Dispatched from a component opened using the PopUpManager when the user clicks outside it. | UIComponent | ||
| Dispatched when the user attempts to change focus by using a pointer device. | InteractiveObject | ||
| Dispatched when a user moves the pointing device while it is over an InteractiveObject. | InteractiveObject | ||
| Dispatched when the user moves a pointing device away from an InteractiveObject instance. | InteractiveObject | ||
| Dispatched when the user moves a pointing device over an InteractiveObject instance. | InteractiveObject | ||
| Dispatched when a user releases the pointing device button over an InteractiveObject instance. | InteractiveObject | ||
| Dispatched when a mouse wheel is spun over an InteractiveObject instance. | InteractiveObject | ||
| 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 by the drag initiator InteractiveObject when the user releases the drag gesture. | InteractiveObject | ||
| Dispatched by the target InteractiveObject when a dragged object is dropped on it and the drop has been accepted with a call to DragManager.acceptDragDrop(). | InteractiveObject | ||
| Dispatched by an InteractiveObject when a drag gesture enters its boundary. | InteractiveObject | ||
| Dispatched by an InteractiveObject when a drag gesture leaves its boundary. | InteractiveObject | ||
| Dispatched by an InteractiveObject continually while a drag gesture remains within its boundary. | InteractiveObject | ||
| Dispatched at the beginning of a drag operation by the InteractiveObject that is specified as the drag initiator in the DragManager.doDrag() call. | InteractiveObject | ||
| Dispatched during a drag operation by the InteractiveObject that is specified as the drag initiator in the DragManager.doDrag() call. | InteractiveObject | ||
| Dispatched when the user activates the platform specific accelerator key combination for a paste operation or selects 'Paste' from the text context menu. | InteractiveObject | ||
| Dispatched at the beginning of the component initialization sequence. | UIComponent | ||
| Dispatched when the component is removed from a container as a content child by using the removeChild() or removeChildAt() method. | UIComponent | ||
| Dispatched when a display object is about to be removed from the display list. | DisplayObject | ||
| Dispatched when a display object is about to be removed from the display list, either directly or through the removal of a sub tree in which the display object is contained. | DisplayObject | ||
| [broadcast event] Dispatched when the display list is about to be updated and rendered. | DisplayObject | ||
| Dispatched when the component is resized. | UIComponent | ||
| Dispatched when a user presses and releases the right button of the user's pointing device over the same InteractiveObject. | InteractiveObject | ||
| Dispatched when a user presses the pointing device button over an InteractiveObject instance. | InteractiveObject | ||
| Dispatched when a user releases the pointing device button over an InteractiveObject instance. | InteractiveObject | ||
| Dispatched when the user moves a pointing device away from an InteractiveObject instance. | InteractiveObject | ||
| Dispatched when the user moves a pointing device over an InteractiveObject instance. | InteractiveObject | ||
| Dispatched when the user activates the platform specific accelerator key combination for a select all operation or selects 'Select All' from the text context menu. | InteractiveObject | ||
| Dispatched when an object's state changes from invisible to visible. | UIComponent | ||
| Dispatched when the value of the object's tabChildren flag changes. | InteractiveObject | ||
| Dispatched when the object's tabEnabled flag changes. | InteractiveObject | ||
| Dispatched when the value of the object's tabIndex property changes. | InteractiveObject | ||
| Dispatched when a user enters one or more characters of text. | InteractiveObject | ||
| 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 | ||
color | Type: uint Format: Color CSS Inheritance: yes Color of text in the component, including the component label. The default value is 0x0B333C. | Button | ||
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".See also | 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".See also | 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 is 0.See also | 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 is 0.See also | 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 | ||
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 | ||
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 | ||
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
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
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. When this property is modified, it dispatches the propertyChange event.
public function get data():Object public function set data(value:Object):voidSee also
| emphasized | property |
emphasized:Boolean
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:IFlexModuleFactoryThe module factory that provides the font context for this component.
public function get fontContext():IFlexModuleFactory public function set fontContext(value:IFlexModuleFactory):void| label | property |
label:StringText 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. When this property is modified, it dispatches the propertyChange event.
public function get label():String public function set label(value:String):void| labelPlacement | property |
labelPlacement:String
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. When this property is modified, it dispatches the propertyChange event.
public function get labelPlacement():String public function set labelPlacement(value:String):void| listData | property |
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.
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. When this property is modified, it dispatches the propertyChange event.
public function get listData():BaseListData public function set listData(value:BaseListData):voidSee also
| selected | property |
selected:Boolean
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. When this property is modified, it dispatches the propertyChange event.
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:mx.core:IUITextFieldThe internal UITextField object that renders the label of this Button.
The default value is null.
| toggle | property |
toggle:Boolean
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. When this property is modified, it dispatches the propertyChange event.
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.
Parameters
event:MouseEvent — event object.
|
| mouseDownHandler | () | method |
protected function mouseDownHandler(event:MouseEvent):void
The default handler for the MouseEvent.MOUSE_DOWN event.
Parameters
event:MouseEvent — event object.
|
| mouseUpHandler | () | method |
protected function mouseUpHandler(event:MouseEvent):void
The default handler for the MouseEvent.MOUSE_UP event.
Parameters
event:MouseEvent — event object.
|
| rollOutHandler | () | method |
protected function rollOutHandler(event:MouseEvent):void
The default handler for the MouseEvent.ROLL_OUT event.
Parameters
event:MouseEvent — event object.
|
| rollOverHandler | () | method |
protected function rollOverHandler(event:MouseEvent):void
The default handler for the MouseEvent.ROLL_OVER event.
Parameters
event:MouseEvent — event object.
|
| buttonDown | Event |
mx.events.FlexEventmx.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.
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.Eventflash.events.Event.CHANGE
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.
Event.CHANGE constant defines the value of the type property of a change event object.
This event has the following properties:
| Property | Value |
|---|---|
bubbles | true |
cancelable | false; there is no default behavior to cancel. |
currentTarget | The object that is actively processing the Event object with an event listener. |
target | The object that has had its value modified.
The target is not always the object in the display list
that registered the event listener. Use the currentTarget
property to access the object in the display list that is currently processing the event. |
| dataChange | Event |
mx.events.FlexEventmx.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.
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. |
