Packagespark.components
Classpublic class ToggleButton
InheritanceToggleButton Inheritance ToggleButtonBase Inheritance ButtonBase Inheritance SkinnableComponent Inheritance UIComponent Inheritance FlexSprite Inheritance Sprite Inheritance DisplayObjectContainer Inheritance InteractiveObject Inheritance DisplayObject Inheritance EventDispatcher Inheritance Object
Subclasses ButtonBarButton

Language Version: ActionScript 3.0
Product Version: Flex 4
Runtime Versions: Flash Player 10, AIR 1.5

The ToggleButton component defines a toggle button. Clicking the button toggles it between the up and an down states. If you click the button while it is in the up state, it toggles to the down state. You must click the button again to toggle it back to the up state.

You can get or set this state programmatically by using the selected property.

The ToggleButton control has the following default characteristics:

CharacteristicDescription
Default sizeWide enough to display the text label of the control
Minimum size21 pixels wide and 21 pixels high
Maximum size10000 pixels wide and 10000 pixels high
Default skin classspark.skins.spark.ToggleButtonSkin

MXML SyntaxexpandedHide MXML Syntax

The <s:ToggleButton> tag inherits all of the tag attributes of its superclass and adds no tag attributes:

  <s:ToggleButton/>

Default MXML Propertylabel

View the examples

See also

spark.skins.spark.ToggleButtonSkin
Button and ToggleButton control

Public Properties
 PropertyDefined By
 InheritedaccessibilityProperties : AccessibilityProperties
The current accessibility options for this display object.
DisplayObject
 InheritedactiveEffects : Array
[read-only] The list of effects that are currently playing on the component, as an Array of EffectInstance instances.
UIComponent
 Inheritedalpha : Number
Indicates the alpha transparency value of the object specified.
DisplayObject
 InheritedautomationDelegate : Object
The delegate object that handles the automation-related functionality.
UIComponent
 InheritedautomationEnabled : Boolean
[read-only] True if this component is enabled for automation, false otherwise.
UIComponent
 InheritedautomationName : String
Name that can be used as an identifier for this object.
UIComponent
 InheritedautomationOwner : DisplayObjectContainer
[read-only] The owner of this component for automation purposes.
UIComponent
 InheritedautomationParent : DisplayObjectContainer
[read-only] The parent of this component for automation purposes.
UIComponent
 InheritedautomationTabularData : Object
[read-only] An implementation of the IAutomationTabularData interface, which can be used to retrieve the data.
UIComponent
 InheritedautomationValue : 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
 InheritedautomationVisible : Boolean
[read-only] True if this component is visible for automation, false otherwise.
UIComponent
 InheritedautoRepeat : Boolean
Specifies whether to dispatch repeated buttonDown events if the user holds down the mouse button.
ButtonBase
 Inheritedbaseline : Object
The vertical distance in pixels from the anchor target to the control's baseline position.
UIComponent
 InheritedbaselinePosition : Number
[read-only] The y-coordinate of the baseline of the first line of text of the component.
UIComponent
 InheritedblendMode : String
A value from the BlendMode class that specifies which blend mode to use.
DisplayObject
 InheritedblendShader : Shader
[write-only] Sets a shader that is used for blending the foreground and background.
DisplayObject
 Inheritedbottom : Object
The vertical distance in pixels from the bottom edge of the component to the anchor target's bottom edge.
UIComponent
 InheritedbuttonMode : Boolean
Specifies the button mode of this sprite.
Sprite
 InheritedcacheAsBitmap : Boolean
If set to true, Flash Player or Adobe AIR caches an internal bitmap representation of the display object.
DisplayObject
 InheritedcacheHeuristic : Boolean
[write-only] Used by Flex to suggest bitmap caching for the object.
UIComponent
 InheritedcachePolicy : String
Specifies the bitmap caching policy for this object.
UIComponent
 InheritedclassName : String
[read-only] The name of this instance's class, such as "Button".
UIComponent
 Inheritedconstructor : Object
A reference to the class object or constructor function for a given object instance.
Object
 Inheritedcontent : Object
The content property lets you pass an arbitrary object to be used in a custom skin of the button.
ButtonBase
 InheritedcontentMouseX : Number
[read-only] Returns the x position of the mouse, in the content coordinate system.
UIComponent
 InheritedcontentMouseY : Number
[read-only] Returns the y position of the mouse, in the content coordinate system.
UIComponent
 InheritedcontextMenu : NativeMenu
Specifies the context menu associated with this object.
InteractiveObject
 InheritedcurrentState : String
The current view state of the component.
UIComponent
 InheritedcursorManager : ICursorManager
[read-only] Gets the CursorManager that controls the cursor for this component and its peers.
UIComponent
 Inheriteddepth : Number
Determines the order in which items inside of containers are rendered.
UIComponent
 Inheriteddescriptor : UIComponentDescriptor
Reference to the UIComponentDescriptor, if any, that was used by the createComponentFromDescriptor() method to create this UIComponent instance.
UIComponent
 InheriteddesignLayer : DesignLayer
Specifies the optional DesignLayer instance associated with this visual element.
UIComponent
 Inheriteddocument : Object
A reference to the document object associated with this UIComponent.
UIComponent
 InheriteddoubleClickEnabled : Boolean
[override] Specifies whether the UIComponent object receives doubleClick events.
UIComponent
 InheriteddropTarget : DisplayObject
[read-only] Specifies the display object over which the sprite is being dragged, or on which the sprite was dropped.
Sprite
 Inheritedenabled : Boolean
Whether the component can accept user interaction.
UIComponent
 InheritederrorString : 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
 InheritedexplicitHeight : Number
Number that specifies the explicit height of the component, in pixels, in the component's coordinates.
UIComponent
 InheritedexplicitMaxHeight : Number
The maximum recommended height of the component to be considered by the parent during layout.
UIComponent
 InheritedexplicitMaxWidth : Number
The maximum recommended width of the component to be considered by the parent during layout.
UIComponent
 InheritedexplicitMinHeight : Number
The minimum recommended height of the component to be considered by the parent during layout.
UIComponent
 InheritedexplicitMinWidth : Number
The minimum recommended width of the component to be considered by the parent during layout.
UIComponent
 InheritedexplicitWidth : Number
Number that specifies the explicit width of the component, in pixels, in the component's coordinates.
UIComponent
 Inheritedfilters : Array
An indexed array that contains each filter object currently associated with the display object.
DisplayObject
 InheritedflexContextMenu : IFlexContextMenu
The context menu for this UIComponent.
UIComponent
 InheritedfocusEnabled : Boolean
Indicates whether the component can receive focus when tabbed to.
UIComponent
 InheritedfocusManager : IFocusManager
Gets the FocusManager that controls focus for this component and its peers.
UIComponent
 InheritedfocusPane : Sprite
The focus pane associated with this object.
UIComponent
 InheritedfocusRect : Object
Specifies whether this object displays a focus rectangle.
InteractiveObject
 Inheritedgraphics : Graphics
[read-only] Specifies the Graphics object that belongs to this sprite where vector drawing commands can occur.
Sprite
 InheritedhasFocusableChildren : Boolean
A flag that indicates whether child objects can receive focus This is similar to the tabChildren property used by Flash Player. This is usually false because most components either receive focus themselves or delegate focus to a single internal sub-component and appear as if the component has received focus.
UIComponent
 InheritedhasLayoutMatrix3D : Boolean
[read-only] True if the element has 3D Matrix.
UIComponent
 Inheritedheight : Number
[override] Number that specifies the height of the component, in pixels, in the parent's coordinates.
UIComponent
 InheritedhitArea : Sprite
Designates another sprite to serve as the hit area for a sprite.
Sprite
 InheritedhorizontalCenter : Object
The horizontal distance in pixels from the center of the component to the center of the anchor target's content area.
UIComponent
 Inheritedid : String
ID of the component.
UIComponent
 InheritedincludeInLayout : Boolean
Specifies whether this component is included in the layout of the parent container.
UIComponent
 InheritedinheritingStyles : Object
The beginning of this component's chain of inheriting styles.
UIComponent
 Inheritedinitialized : 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
 InheritedinstanceIndex : int
[read-only] The index of a repeated component.
UIComponent
 InheritedinstanceIndices : Array
An Array containing the indices required to reference this UIComponent object from its parent document.
UIComponent
 Inheritedis3D : Boolean
[read-only] True, when the element is in 3D.
UIComponent
 InheritedisDocument : 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
 InheritedisPopUp : Boolean
Set to true by the PopUpManager to indicate that component has been popped up.
UIComponent
 Inheritedlabel : String
Text to appear on the ButtonBase control.
ButtonBase
 InheritedlayoutMatrix3D : Matrix3D
[write-only] The transform matrix that is used to calculate a component's layout relative to its siblings.
UIComponent
 Inheritedleft : Object
The horizontal distance in pixels from the left edge of the component to the anchor target's left edge.
UIComponent
 InheritedloaderInfo : LoaderInfo
[read-only] Returns a LoaderInfo object containing information about loading the file to which this display object belongs.
DisplayObject
 InheritedmaintainProjectionCenter : Boolean
When true, the component will keep its projection matrix centered on the middle of its bounding box.
UIComponent
 Inheritedmask : DisplayObject
The calling display object is masked by the specified mask object.
DisplayObject
 InheritedmaxHeight : Number
The maximum recommended height of the component to be considered by the parent during layout.
UIComponent
 InheritedmaxWidth : Number
The maximum recommended width of the component to be considered by the parent during layout.
UIComponent
 InheritedmeasuredHeight : Number
The default height of the component, in pixels.
UIComponent
 InheritedmeasuredMinHeight : Number
The default minimum height of the component, in pixels.
UIComponent
 InheritedmeasuredMinWidth : Number
The default minimum width of the component, in pixels.
UIComponent
 InheritedmeasuredWidth : Number
The default width of the component, in pixels.
UIComponent
 InheritedminHeight : Number
The minimum recommended height of the component to be considered by the parent during layout.
UIComponent
 InheritedminWidth : Number
The minimum recommended width of the component to be considered by the parent during layout.
UIComponent
 InheritedmoduleFactory : IFlexModuleFactory
A module factory is used as context for using embeded fonts and for finding the style manager that controls the styles for this component.
UIComponent
 InheritedmouseChildren : Boolean
Determines whether or not the children of the object are mouse enabled.
DisplayObjectContainer
 InheritedmouseEnabled : Boolean
Specifies whether this object receives mouse messages.
InteractiveObject
 InheritedmouseFocusEnabled : Boolean
Whether you can receive focus when clicked on.
UIComponent
 InheritedmouseX : Number
[read-only] Indicates the x coordinate of the mouse position, in pixels.
DisplayObject
 InheritedmouseY : Number
[read-only] Indicates the y coordinate of the mouse position, in pixels.
DisplayObject
 Inheritedname : String
Indicates the instance name of the DisplayObject.
DisplayObject
 InheritednestLevel : int
Depth of this object in the containment hierarchy.
UIComponent
 InheritednonInheritingStyles : Object
The beginning of this component's chain of non-inheriting styles.
UIComponent
 InheritednumAutomationChildren : int
[read-only] The number of automation children this container has.
UIComponent
 InheritedopaqueBackground : Object
Specifies whether the display object is opaque with a certain background color.
DisplayObject
 Inheritedowner : DisplayObjectContainer
The owner of this IVisualElement object.
UIComponent
 Inheritedparent : DisplayObjectContainer
[override] [read-only]
UIComponent
 InheritedparentApplication : Object
[read-only] A reference to the Application object that contains this UIComponent instance.
UIComponent
 InheritedparentDocument : Object
[read-only] A reference to the parent document object for this UIComponent.
UIComponent
 InheritedpercentHeight : Number
Number that specifies the height of a component as a percentage of its parent's size.
UIComponent
 InheritedpercentWidth : Number
Number that specifies the width of a component as a percentage of its parent's size.
UIComponent
 InheritedpostLayoutTransformOffsets : mx.geom:TransformOffsets
UIComponent
 InheritedprocessedDescriptors : Boolean
Set to true after immediate or deferred child creation, depending on which one happens.
UIComponent
 Inheritedprototype : Object
[static] A reference to the prototype object of a class or function object.
Object
 Inheritedrepeater : IRepeater
[read-only] A reference to the Repeater object in the parent document that produced this UIComponent.
UIComponent
 InheritedrepeaterIndex : int
[read-only] The index of the item in the data provider of the Repeater that produced this UIComponent.
UIComponent
 InheritedrepeaterIndices : 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
 Inheritedrepeaters : Array
An Array containing references to the Repeater objects in the parent document that produced this UIComponent.
UIComponent
 Inheritedright : Object
The horizontal distance in pixels from the right edge of the component to the anchor target's right edge.
UIComponent
 Inheritedroot : 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
 Inheritedrotation : Number
[override]
UIComponent
 InheritedrotationX : Number
[override] Indicates the x-axis rotation of the DisplayObject instance, in degrees, from its original orientation relative to the 3D parent container.
UIComponent
 InheritedrotationY : Number
[override] Indicates the y-axis rotation of the DisplayObject instance, in degrees, from its original orientation relative to the 3D parent container.
UIComponent
 InheritedrotationZ : Number
[override] Indicates the z-axis rotation of the DisplayObject instance, in degrees, from its original orientation relative to the 3D parent container.
UIComponent
 Inheritedscale9Grid : Rectangle
The current scaling grid that is in effect.
DisplayObject
 InheritedscaleX : Number
[override] Number that specifies the horizontal scaling factor.
UIComponent
 InheritedscaleY : Number
[override] Number that specifies the vertical scaling factor.
UIComponent
 InheritedscaleZ : Number
[override] Number that specifies the scaling factor along the z axis.
UIComponent
 Inheritedscreen : Rectangle
[read-only] Returns an object that contains the size and position of the base drawing surface for this object.
UIComponent
 InheritedscrollRect : Rectangle
The scroll rectangle bounds of the display object.
DisplayObject
 Inheritedselected : Boolean
true if the button is in the down state, and false if it is in the up state.
ToggleButtonBase
 InheritedshowInAutomationHierarchy : Boolean
A flag that determines if an automation object shows in the automation hierarchy.
UIComponent
 Inheritedskin : UIComponent
[read-only] The instance of the skin class for this component instance.
SkinnableComponent
 InheritedsoundTransform : flash.media:SoundTransform
Controls sound within this sprite.
Sprite
 Inheritedstage : Stage
[read-only] The Stage of the display object.
DisplayObject
 Inheritedstates : Array
The view states that are defined for this component.
UIComponent
 InheritedstickyHighlighting : Boolean
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.
ButtonBase
 InheritedstyleDeclaration : CSSStyleDeclaration
Storage for the inline inheriting styles on this object.
UIComponent
 InheritedstyleName : Object
The class style used by this component.
UIComponent
 InheritedstyleParent : IAdvancedStyleClient
[read-only] A component's parent is used to evalate descendant selectors.
UIComponent
 InheritedsystemManager : ISystemManager
Returns the SystemManager object used by this component.
UIComponent
 InheritedtabChildren : Boolean
Determines whether the children of the object are tab enabled.
DisplayObjectContainer
 InheritedtabEnabled : Boolean
Specifies whether this object is in the tab order.
InteractiveObject
 InheritedtabFocusEnabled : Boolean
A flag that indicates whether this object can receive focus via the TAB key This is similar to the tabEnabled property used by the Flash Player. This is usually true for components that handle keyboard input, but some components in controlbars have them set to false because they should not steal focus from another component like an editor.
UIComponent
 InheritedtabIndex : int
Specifies the tab ordering of objects in a SWF file.
InteractiveObject
 InheritedtextSnapshot : flash.text:TextSnapshot
[read-only] Returns a TextSnapshot object for this DisplayObjectContainer instance.
DisplayObjectContainer
 InheritedtoolTip : String
Text to display in the ToolTip.
UIComponent
 Inheritedtop : Object
The vertical distance in pixels from the top edge of the component to the anchor target's top edge.
UIComponent
 Inheritedtransform : flash.geom:Transform
An object with properties pertaining to a display object's matrix, color transform, and pixel bounds.
DisplayObject
 InheritedtransformX : Number
Sets the x coordinate for the transform center of the component.
UIComponent
 InheritedtransformY : Number
Sets the y coordinate for the transform center of the component.
UIComponent
 InheritedtransformZ : Number
Sets the z coordinate for the transform center of the component.
UIComponent
 Inheritedtransitions : Array
An Array of Transition objects, where each Transition object defines a set of effects to play when a view state change occurs.
UIComponent
 InheritedtweeningProperties : Array
Array of properties that are currently being tweened on this object.
UIComponent
 Inheriteduid : String
A unique identifier for the object.
UIComponent
 InheritedupdateCompletePendingFlag : Boolean
A flag that determines if an object has been through all three phases of layout validation (provided that any were required).
UIComponent
 InheriteduseHandCursor : 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
 InheritedvalidationSubField : String
Used by a validator to associate a subfield with this component.
UIComponent
 InheritedverticalCenter : Object
The vertical distance in pixels from the center of the component to the center of the anchor target's content area.
UIComponent
 Inheritedvisible : Boolean
[override]
UIComponent
 Inheritedwidth : Number
[override] Number that specifies the width of the component, in pixels, in the parent's coordinates.
UIComponent
 Inheritedx : Number
[override] Number that specifies the component's horizontal position, in pixels, within its parent container.
UIComponent
 Inheritedy : Number
[override] Number that specifies the component's vertical position, in pixels, within its parent container.
UIComponent
 Inheritedz : Number
[override] Indicates the z coordinate position along the z-axis of the DisplayObject instance relative to the 3D parent container.
UIComponent
Protected Properties
 PropertyDefined By
 InheritedcurrentCSSState : String
[override] [read-only] The state to be used when matching CSS pseudo-selectors.
SkinnableComponent
 InheritedhasComplexLayoutMatrix : Boolean
[read-only] Returns true if the UIComponent has any non-translation (x,y) transform properties
UIComponent
 Inheritedhovered : Boolean
Indicates whether the mouse pointer is over the button.
ButtonBase
 InheritedkeyboardPressed : Boolean
Indicates whether a keyboard key is pressed while the button is in focus.
ButtonBase
 InheritedmouseCaptured : Boolean
Indicates whether the mouse is down and the mouse pointer was over the button when MouseEvent.MOUSE_DOWN was first dispatched.
ButtonBase
 InheritedresourceManager : IResourceManager
[read-only] A reference to the object which manages all of the application's localized resources.
UIComponent
 InheritedunscaledHeight : Number
[read-only] A convenience method for determining the unscaled height of the component.
UIComponent
 InheritedunscaledWidth : 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
Public Methods
 MethodDefined By
  
ToggleButton()
Constructor.
ToggleButton
 Inherited
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
 Inherited
areInaccessibleObjectsUnderPoint(point:Point):Boolean
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
 Inherited
callLater(method:Function, args:Array = null):void
Queues a function to be called later.
UIComponent
 Inherited
clearStyle(styleProp:String):void
Deletes a style property from this component instance.
UIComponent
 Inherited
contains(child:DisplayObject):Boolean
Determines whether the specified display object is a child of the DisplayObjectContainer instance or the instance itself.
DisplayObjectContainer
 Inherited
contentToGlobal(point:Point):Point
Converts a Point object from content coordinates to global coordinates.
UIComponent
 Inherited
contentToLocal(point:Point):Point
Converts a Point object from content to local coordinates.
UIComponent
 Inherited
createAutomationIDPart(child:IAutomationObject):Object
Returns a set of properties that identify the child within this container.
UIComponent
 Inherited
createAutomationIDPartWithRequiredProperties(child:IAutomationObject, properties:Array):Object
Returns a set of properties as automation ID that identify the child within this container.
UIComponent
 Inherited
createReferenceOnParentDocument(parentDocument:IFlexDisplayObject):void
Creates an id reference to this IUIComponent object on its parent document object.
UIComponent
 Inherited
deleteReferenceOnParentDocument(parentDocument:IFlexDisplayObject):void
Deletes the id reference to this IUIComponent object on its parent document object.
UIComponent
 Inherited
determineTextFormatFromStyles():mx.core:UITextFormat
Returns a UITextFormat object corresponding to the text styles for this UIComponent.
UIComponent
 Inherited
dispatchEvent(event:Event):Boolean
[override] Dispatches an event into the event flow.
UIComponent
 Inherited
drawFocus(isFocused:Boolean):void
Shows or hides the focus indicator around this component.
UIComponent
 Inherited
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
 Inherited
effectFinished(effectInst:IEffectInstance):void
Called by the effect instance when it stops playing on the component.
UIComponent
 Inherited
effectStarted(effectInst:IEffectInstance):void
Called by the effect instance when it starts playing on the component.
UIComponent
 Inherited
endEffectsStarted():void
Ends all currently playing effects on the component.
UIComponent
 Inherited
executeBindings(recurse:Boolean = false):void
Executes all the bindings for which the UIComponent object is the destination.
UIComponent
 Inherited
finishPrint(obj:Object, target:IFlexDisplayObject):void
Called after printing is complete.
UIComponent
 Inherited
getAutomationChildAt(index:int):IAutomationObject
Provides the automation object at the specified index.
UIComponent
 Inherited
getAutomationChildren():Array
Provides the automation object list .
UIComponent
 Inherited
getBounds(targetCoordinateSpace:DisplayObject):Rectangle
Returns a rectangle that defines the area of the display object relative to the coordinate system of the targetCoordinateSpace object.
DisplayObject
 Inherited
getBoundsXAtSize(width:Number, height:Number, postLayoutTransform:Boolean = true):Number
Returns the x coordinate of the element's bounds at the specified element size.
UIComponent
 Inherited
getBoundsYAtSize(width:Number, height:Number, postLayoutTransform:Boolean = true):Number
Returns the y coordinate of the element's bounds at the specified element size.
UIComponent
 Inherited
getChildByName(name:String):DisplayObject
Returns the child display object that exists with the specified name.
DisplayObjectContainer
 Inherited
getClassStyleDeclarations():Array
Finds the type selectors for this UIComponent instance.
UIComponent
 Inherited
getConstraintValue(constraintName:String):*
Returns a layout constraint value, which is the same as getting the constraint style for this component.
UIComponent
 Inherited
getExplicitOrMeasuredHeight():Number
A convenience method for determining whether to use the explicit or measured height
UIComponent
 Inherited
getExplicitOrMeasuredWidth():Number
A convenience method for determining whether to use the explicit or measured width
UIComponent
 Inherited
getFocus():InteractiveObject
Gets the object that currently has focus.
UIComponent
 Inherited
getLayoutBoundsHeight(postLayoutTransform:Boolean = true):Number
Returns the element's layout height.
UIComponent
 Inherited
getLayoutBoundsWidth(postLayoutTransform:Boolean = true):Number
Returns the element's layout width.
UIComponent
 Inherited
getLayoutBoundsX(postLayoutTransform:Boolean = true):Number
Returns the x coordinate that the element uses to draw on screen.
UIComponent
 Inherited
getLayoutBoundsY(postLayoutTransform:Boolean = true):Number
Returns the y coordinate that the element uses to draw on screen.
UIComponent
 Inherited
getLayoutMatrix():Matrix
Returns the transform matrix that is used to calculate the component's layout relative to its siblings.
UIComponent
 Inherited
getLayoutMatrix3D():Matrix3D
Returns the layout transform Matrix3D for this element.
UIComponent
 Inherited
getMaxBoundsHeight(postLayoutTransform:Boolean = true):Number
Returns the element's maximum height.
UIComponent
 Inherited
getMaxBoundsWidth(postLayoutTransform:Boolean = true):Number
Returns the element's maximum width.
UIComponent
 Inherited
getMinBoundsHeight(postLayoutTransform:Boolean = true):Number
Returns the element's minimum height.
UIComponent
 Inherited
getMinBoundsWidth(postLayoutTransform:Boolean = true):Number
Returns the element's minimum width.
UIComponent
 Inherited
getObjectsUnderPoint(point:Point):Array
Returns an array of objects that lie under the specified point and are children (or grandchildren, and so on) of this DisplayObjectContainer instance.
DisplayObjectContainer
 Inherited
getPreferredBoundsHeight(postLayoutTransform:Boolean = true):Number
Returns the element's preferred height.
UIComponent
 Inherited
getPreferredBoundsWidth(postLayoutTransform:Boolean = true):Number
Returns the element's preferred width.
UIComponent
 Inherited
getRect(targetCoordinateSpace:DisplayObject):Rectangle
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
 Inherited
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
 Inherited
getStyle(styleProp:String):*
Gets a style property that has been set anywhere in this component's style lookup chain.
UIComponent
 Inherited
globalToContent(point:Point):Point
Converts a Point object from global to content coordinates.
UIComponent
 Inherited
globalToLocal(point:Point):Point
Converts the point object from the Stage (global) coordinates to the display object's (local) coordinates.
DisplayObject
 Inherited
globalToLocal3D(point:Point):Vector3D
Converts a two-dimensional point from the Stage (global) coordinates to a three-dimensional display object's (local) coordinates.
DisplayObject
 Inherited
hasEventListener(type:String):Boolean
Checks whether the EventDispatcher object has any listeners registered for a specific type of event.
EventDispatcher
 Inherited
hasOwnProperty(name:String):Boolean
Indicates whether an object has a specified property defined.
Object
 Inherited
hasState(stateName:String):Boolean
Determines whether the specified state has been defined on this UIComponent.
UIComponent
 Inherited
hitTestObject(obj:DisplayObject):Boolean
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
 Inherited
hitTestPoint(x:Number, y:Number, shapeFlag:Boolean = false):Boolean
Evaluates the display object to see if it overlaps or intersects with the point specified by the x and y parameters.
DisplayObject
 Inherited
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
 Inherited
initialize():void
Initializes the internal structure of this component.
UIComponent
 Inherited
initializeRepeaterArrays(parent:IRepeaterClient):void
Initializes various properties which keep track of repeated instances of this component.
UIComponent
 Inherited
invalidateDisplayList():void
Marks a component so that its updateDisplayList() method gets called during a later screen update.
UIComponent
 Inherited
invalidateLayering():void
Called by a component's items to indicate that their depth property has changed.
UIComponent
 Inherited
invalidateProperties():void
Marks a component so that its commitProperties() method gets called during a later screen update.
UIComponent
 Inherited
invalidateSize():void
Marks a component so that its measure() method gets called during a later screen update.
UIComponent
 Inherited
invalidateSkinState():void
Marks the component so that the new state of the skin will get set during a later screen update.
SkinnableComponent
 Inherited
isPrototypeOf(theClass:Object):Boolean
Indicates whether an instance of the Object class is in the prototype chain of the object specified as the parameter.
Object
 Inherited
local3DToGlobal(point3d:Vector3D):Point
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
 Inherited
localToContent(point:Point):Point
Converts a Point object from local to content coordinates.
UIComponent
 Inherited
localToGlobal(point:Point):Point
Converts the point object from the display object's (local) coordinates to the Stage (global) coordinates.
DisplayObject
 Inherited
matchesCSSState(cssState:String):Boolean
Determins whether the current state of this component matches a CSS pseudo-selector.
UIComponent
 Inherited
matchesCSSType(cssType:String):Boolean
Determines whether this component is assignable to the given CSS type.
UIComponent
 Inherited
measureHTMLText(htmlText:String):flash.text: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
 Inherited
measureText(text:String):flash.text: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
 Inherited
move(x:Number, y:Number):void
Moves the component to a specified position within its parent.
UIComponent
 Inherited
notifyStyleChangeInChildren(styleProp:String, recursive:Boolean):void
Propagates style changes to the children.
UIComponent
 Inherited
owns(child:DisplayObject):Boolean
Returns true if the chain of owner properties points from child to this UIComponent.
UIComponent
 Inherited
parentChanged(p:DisplayObjectContainer):void
Called by Flex when a UIComponent object is added to or removed from a parent.
UIComponent
 Inherited
prepareToPrint(target:IFlexDisplayObject):Object
Prepares an IFlexDisplayObject for printing.
UIComponent
 Inherited
propertyIsEnumerable(name:String):Boolean
Indicates whether the specified property exists and is enumerable.
Object
 Inherited
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
 Inherited
registerEffects(effects:Array):void
For each effect event, registers the EffectManager as one of the event listeners.
UIComponent
 Inherited
removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void
Removes a listener from the EventDispatcher object.
EventDispatcher
 Inherited
replayAutomatableEvent(event:Event):Boolean
Replays the specified event.
UIComponent
 Inherited
resolveAutomationIDPart(criteria:Object):Array
Resolves a child by using the id provided.
UIComponent
 Inherited
resumeBackgroundProcessing():void
[static] Resumes the background processing of methods queued by callLater(), after a call to suspendBackgroundProcessing().
UIComponent
 Inherited
setActualSize(w:Number, h:Number):void
Sizes the object.
UIComponent
 Inherited
setConstraintValue(constraintName:String, value:*):void
Sets a layout constraint value, which is the same as setting the constraint style for this component.
UIComponent
 Inherited
setCurrentState(stateName:String, playTransition:Boolean = true):void
Set the current state.
UIComponent
 Inherited
setFocus():void
Sets the focus to this component.
UIComponent
 Inherited
setLayoutBoundsPosition(x:Number, y:Number, postLayoutTransform:Boolean = true):void
Sets the coordinates that the element uses to draw on screen.
UIComponent
 Inherited
setLayoutBoundsSize(width:Number, height:Number, postLayoutTransform:Boolean = true):void
Sets the layout size to the specified dimensions.
UIComponent
 Inherited
setLayoutMatrix(value:Matrix, invalidateLayout:Boolean):void
Sets the transform Matrix that is used to calculate the component's layout size and position relative to its siblings.
UIComponent
 Inherited
setLayoutMatrix3D(value:Matrix3D, invalidateLayout:Boolean):void
Similarly to the layoutMatrix3D property, sets the layout Matrix3D, but doesn't trigger a layout pass.
UIComponent
 Inherited
setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void
Sets the availability of a dynamic property for loop operations.
Object
 Inherited
setStyle(styleProp:String, newValue:*):void
Sets a style property on this component instance.
UIComponent
 Inherited
setVisible(value:Boolean, noEvent:Boolean = false):void
Called when the visible property changes.
UIComponent
 Inherited
startDrag(lockCenter:Boolean = false, bounds:Rectangle = null):void
Lets the user drag the specified sprite.
Sprite
 Inherited
stopDrag():void
Ends the startDrag() method.
Sprite
 Inherited
styleChanged(styleProp:String):void
Detects changes to style properties.
UIComponent
 Inherited
stylesInitialized():void
Flex calls the stylesInitialized() method when the styles for a component are first initialized.
UIComponent
 Inherited
suspendBackgroundProcessing():void
[static] Blocks the background processing of methods queued by callLater(), until resumeBackgroundProcessing() is called.
UIComponent
 Inherited
toLocaleString():String
Returns the string representation of this object, formatted according to locale-specific conventions.
Object
 Inherited
toString():String
[override] Returns a string indicating the location of this object within the hierarchy of DisplayObjects in the Application.
FlexSprite
 Inherited
transformAround(transformCenter:Vector3D, scale:Vector3D = null, rotation:Vector3D = null, translation:Vector3D = null, postLayoutScale:Vector3D = null, postLayoutRotation:Vector3D = null, postLayoutTranslation:Vector3D = null):void
UIComponent
 Inherited
transformPointToParent(transformCenter:Vector3D, position:Vector3D, postLayoutPosition:Vector3D):void
FIXME (chaase) : FLEXDOCS-1031
UIComponent
 Inherited
validateDisplayList():void
Validates the position and size of children and draws other visuals.
UIComponent
 Inherited
validateNow():void
Validate and update the properties and layout of this object and redraw it, if necessary.
UIComponent
 Inherited
validateProperties():void
Used by layout logic to validate the properties of a component by calling the commitProperties() method.
UIComponent
 Inherited
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
 Inherited
validationResultHandler(event:ValidationResultEvent):void
Handles both the valid and invalid events from a validator assigned to this component.
UIComponent
 Inherited
valueOf():Object
Returns the primitive value of the specified object.
Object
 Inherited
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
 Inherited
willTrigger(type:String):Boolean
Checks whether an event listener is registered with this EventDispatcher object or any of its ancestors for the specified event type.
EventDispatcher
Protected Methods
 MethodDefined By
 Inherited
adjustFocusRect(obj:DisplayObject = null):void
Adjust the focus rectangle.
UIComponent
 Inherited
applyComputedMatrix():void
Commits the computed matrix built from the combination of the layout matrix and the transform offsets to the flash displayObject's transform.
UIComponent
 Inherited
attachOverlay():void
This is an internal method used by the Flex framework to support the Dissolve effect.
UIComponent
 Inherited
attachSkin():void
Create the skin for the component.
SkinnableComponent
 Inherited
canSkipMeasurement():Boolean
Determines if the call to the measure() method can be skipped.
UIComponent
 Inherited
childrenCreated():void
Performs any final processing after child objects are created.
UIComponent
 Inherited
clearSkinParts():void
Clear out references to skin parts.
SkinnableComponent
 Inherited
clickHandler(event:MouseEvent):void
Override in subclasses to handle the click event rather than adding a separate handler.
ButtonBase
 Inherited
commitProperties():void
Processes the properties set on the component.
UIComponent
 Inherited
createChildren():void
Create child objects of the component.
UIComponent
 Inherited
createDynamicPartInstance(partName:String):Object
Create an instance of a dynamic skin part.
SkinnableComponent
 Inherited
createInFontContext(classObj:Class):Object
Creates a new object using a context based on the embedded font being used.
UIComponent
 Inherited
createInModuleContext(moduleFactory:IFlexModuleFactory, className:String):Object
Creates the object using a given moduleFactory.
UIComponent
 Inherited
detachSkin():void
Destroys and removes the skin for this component.
SkinnableComponent
 Inherited
dispatchPropertyChangeEvent(prop:String, oldValue:*, value:*):void
Helper method for dispatching a PropertyChangeEvent when a property is updated.
UIComponent
 Inherited
findSkinParts():void
Find the skin parts in the skin class and assign them to the properties of the component.
SkinnableComponent
 Inherited
focusInHandler(event:FocusEvent):void
The event handler called when a UIComponent object gets focus.
UIComponent
 Inherited
focusOutHandler(event:FocusEvent):void
The event handler called when a UIComponent object loses focus.
UIComponent
 Inherited
getCurrentSkinState():String
Returns the name of the state to be applied to the skin.
SkinnableComponent
 Inherited
getDynamicPartAt(partName:String, index:int):Object
Returns a specific instance of a dynamic part.
SkinnableComponent
 Inherited
initAdvancedLayoutFeatures():void
Initializes the implementation and storage of some of the less frequently used advanced layout features of a component.
UIComponent
 Inherited
initializationComplete():void
Finalizes the initialization of this component.
UIComponent
 Inherited
initializeAccessibility():void
Initializes this component's accessibility code.
UIComponent
 Inherited
invalidateParentSizeAndDisplayList():void
Helper method to invalidate parent size and display list if this object affects its layout (includeInLayout is true).
UIComponent
 Inherited
isOurFocus(target:DisplayObject):Boolean
Typically overridden by components containing UITextField objects, where the UITextField object gets focus.
UIComponent
 Inherited
keyDownHandler(event:KeyboardEvent):void
The event handler called for a keyDown event.
UIComponent
 Inherited
keyUpHandler(event:KeyboardEvent):void
The event handler called for a keyUp event.
UIComponent
 Inherited
measure():void
Calculates the default size, and optionally the default minimum size, of the component.
UIComponent
 Inherited
mouseEventHandler(event:Event):void
This method handles the mouse events, calls the clickHandler method where appropriate and updates the hovered and mouseCaptured properties.
ButtonBase
 Inherited
nonDeltaLayoutMatrix():Matrix
UIComponent
 Inherited
numDynamicParts(partName:String):int
Returns the number of instances of a dynamic part.
SkinnableComponent
 Inherited
partAdded(partName:String, instance:Object):void
Called when a skin part is added.
SkinnableComponent
 Inherited
partRemoved(partName:String, instance:Object):void
Called when an instance of a skin part is being removed.
SkinnableComponent
 Inherited
removeDynamicPartInstance(partName:String, instance:Object):void
Remove an instance of a dynamic part.
SkinnableComponent
 Inherited
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
 Inherited
setStretchXY(stretchX:Number, stretchY:Number):void
Specifies a transform stretch factor in the horizontal and vertical direction.
UIComponent
 Inherited
stateChanged(oldState:String, newState:String, recursive:Boolean):void
This method is called when a state changes to check whether state-specific styles apply to this component.
UIComponent
 Inherited
updateDisplayList(unscaledWidth:Number, unscaledHeight:Number):void
Draws the object and/or sizes and positions its children.
UIComponent
Events
Click for more information on events
 Event Summary Defined By
 Inherited
activate
[broadcast event] Dispatched when the Flash Player or AIR application gains operating system focus and becomes active.EventDispatcher
 Inherited
add
Dispatched when the component is added to a container as a content child by using the addChild(), addChildAt(), addElement(), or addElementAt() method.UIComponent
 Inherited
added
Dispatched when a display object is added to the display list.DisplayObject
 Inherited
addedToStage
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
 Inherited
buttonDown
Dispatched when the user presses the ButtonBase control.ButtonBase
 Inherited
change
Dispatched when the selected property changes for the ToggleButtonBase control.ToggleButtonBase
 Inherited
clear
Dispatched when the user selects 'Clear' (or 'Delete') from the text context menu.InteractiveObject
 Inherited
click
Dispatched when a user presses and releases the main button of the user's pointing device over the same InteractiveObject.InteractiveObject
 Inherited
AIR-only contextMenu
Dispatched when a user gesture triggers the context menu associated with this interactive object in an AIR application.InteractiveObject
 Inherited
copy
Dispatched when the user activates the platform specific accelerator key combination for a copy operation or selects 'Copy' from the text context menu.InteractiveObject
 Inherited
creationComplete
Dispatched when the component has finished its construction, property processing, measuring, layout, and drawing.UIComponent
 Inherited
currentStateChange
Dispatched after the view state has changed.UIComponent
 Inherited
currentStateChanging
Dispatched after the currentState property changes, but before the view state changes.UIComponent
 Inherited
cut
Dispatched when the user activates the platform specific accelerator key combination for a cut operation or selects 'Cut' from the text context menu.InteractiveObject
 Inherited
deactivate
[broadcast event] Dispatched when the Flash Player or AIR application operating loses system focus and is becoming inactive.EventDispatcher
 Inherited
doubleClick
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
 Inherited
dragComplete
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
 Inherited
dragDrop
Dispatched by the drop target when the user releases the mouse over it.UIComponent
 Inherited
dragEnter
Dispatched by a component when the user moves the mouse over the component during a drag operation.UIComponent
 Inherited
dragExit
Dispatched by the component when the user drags outside the component, but does not drop the data onto the target.UIComponent
 Inherited
dragOver
Dispatched by a component when the user moves the mouse while over the component during a drag operation.UIComponent
 Inherited
dragStart
Dispatched by the drag initiator when starting a drag operation.UIComponent
 Inherited
effectEnd
Dispatched after an effect ends.UIComponent
 Inherited
effectStart
Dispatched just before an effect starts.UIComponent
 Inherited
effectStop
Dispatched after an effect is stopped, which happens only by a call to stop() on the effect.UIComponent
 Inherited
enterFrame
[broadcast event] Dispatched when the playhead is entering a new frame.DisplayObject
 Inherited
enterState
Dispatched after the component has entered a view state.UIComponent
 Inherited
exitFrame
[broadcast event] Dispatched when the playhead is exiting the current frame.DisplayObject
 Inherited
exitState
Dispatched just before the component exits a view state.UIComponent
 Inherited
focusIn
Dispatched after a display object gains focus.InteractiveObject
 Inherited
focusOut
Dispatched after a display object loses focus.InteractiveObject
 Inherited
frameConstructed
[broadcast event] Dispatched after the constructors of frame display objects have run but before frame scripts have run.DisplayObject
 Inherited
hide
Dispatched when an object's state changes from visible to invisible.UIComponent
 Inherited
initialize
Dispatched when the component has finished its construction and has all initialization properties set.UIComponent
 Inherited
invalid
Dispatched when a component is monitored by a Validator and the validation failed.UIComponent
 Inherited
keyDown
Dispatched when the user presses a key.InteractiveObject
 Inherited
keyFocusChange
Dispatched when the user attempts to change focus by using keyboard navigation.InteractiveObject
 Inherited
keyUp
Dispatched when the user releases a key.InteractiveObject
 Inherited
AIR-only middleClick
Dispatched when a user presses and releases the middle button of the user's pointing device over the same InteractiveObject.InteractiveObject
 Inherited
AIR-only middleMouseDown
Dispatched when a user presses the middle pointing device button over an InteractiveObject instance.InteractiveObject
 Inherited
AIR-only middleMouseUp
Dispatched when a user releases the pointing device button over an InteractiveObject instance.InteractiveObject
 Inherited
mouseDown
Dispatched when a user presses the pointing device button over an InteractiveObject instance.InteractiveObject
 Inherited
mouseDownOutside
Dispatched from a component opened using the PopUpManager when the user clicks outside it.UIComponent
 Inherited
mouseFocusChange
Dispatched when the user attempts to change focus by using a pointer device.InteractiveObject
 Inherited
mouseMove
Dispatched when a user moves the pointing device while it is over an InteractiveObject.InteractiveObject
 Inherited
mouseOut
Dispatched when the user moves a pointing device away from an InteractiveObject instance.InteractiveObject
 Inherited
mouseOver
Dispatched when the user moves a pointing device over an InteractiveObject instance.InteractiveObject
 Inherited
mouseUp
Dispatched when a user releases the pointing device button over an InteractiveObject instance.InteractiveObject
 Inherited
mouseWheel
Dispatched when a mouse wheel is spun over an InteractiveObject instance.InteractiveObject
 Inherited
mouseWheelOutside
Dispatched from a component opened using the PopUpManager when the user scrolls the mouse wheel outside it.UIComponent
 Inherited
move
Dispatched when the object has moved.UIComponent
 Inherited
AIR-only nativeDragComplete
Dispatched by the drag initiator InteractiveObject when the user releases the drag gesture.InteractiveObject
 Inherited
AIR-only nativeDragDrop
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
 Inherited
AIR-only nativeDragEnter
Dispatched by an InteractiveObject when a drag gesture enters its boundary.InteractiveObject
 Inherited
AIR-only nativeDragExit
Dispatched by an InteractiveObject when a drag gesture leaves its boundary.InteractiveObject
 Inherited
AIR-only nativeDragOver
Dispatched by an InteractiveObject continually while a drag gesture remains within its boundary.InteractiveObject
 Inherited
AIR-only nativeDragStart
Dispatched at the beginning of a drag operation by the InteractiveObject that is specified as the drag initiator in the DragManager.doDrag() call.InteractiveObject
 Inherited
AIR-only nativeDragUpdate
Dispatched during a drag operation by the InteractiveObject that is specified as the drag initiator in the DragManager.doDrag() call.InteractiveObject
 Inherited
paste
Dispatched when the user activates the platform specific accelerator key combination for a paste operation or selects 'Paste' from the text context menu.InteractiveObject
 Inherited
preinitialize
Dispatched at the beginning of the component initialization sequence.UIComponent
 Inherited
remove
Dispatched when the component is removed from a container as a content child by using the removeChild(), removeChildAt(), removeElement(), or removeElementAt() method.UIComponent
 Inherited
removed
Dispatched when a display object is about to be removed from the display list.DisplayObject
 Inherited
removedFromStage
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
 Inherited
render
[broadcast event] Dispatched when the display list is about to be updated and rendered.DisplayObject
 Inherited
resize
Dispatched when the component is resized.UIComponent
 Inherited
AIR-only rightClick
Dispatched when a user presses and releases the right button of the user's pointing device over the same InteractiveObject.InteractiveObject
 Inherited
AIR-only rightMouseDown
Dispatched when a user presses the pointing device button over an InteractiveObject instance.InteractiveObject
 Inherited
AIR-only rightMouseUp
Dispatched when a user releases the pointing device button over an InteractiveObject instance.InteractiveObject
 Inherited
rollOut
Dispatched when the user moves a pointing device away from an InteractiveObject instance.InteractiveObject
 Inherited
rollOver
Dispatched when the user moves a pointing device over an InteractiveObject instance.InteractiveObject
 Inherited
selectAll
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
 Inherited
show
Dispatched when an object's state changes from invisible to visible.UIComponent
 Inherited
tabChildrenChange
Dispatched when the value of the object's tabChildren flag changes.InteractiveObject
 Inherited
tabEnabledChange
Dispatched when the object's tabEnabled flag changes.InteractiveObject
 Inherited
tabIndexChange
Dispatched when the value of the object's tabIndex property changes.InteractiveObject
 Inherited
textInput
Dispatched when a user enters one or more characters of text.InteractiveObject
 Inherited
toolTipCreate
Dispatched by the component when it is time to create a ToolTip.UIComponent
 Inherited
toolTipEnd
Dispatched by the component when its ToolTip has been hidden and will be discarded soon.UIComponent
 Inherited
toolTipHide
Dispatched by the component when its ToolTip is about to be hidden.UIComponent
 Inherited
toolTipShow
Dispatched by the component when its ToolTip is about to be shown.UIComponent
 Inherited
toolTipShown
Dispatched by the component when its ToolTip has been shown.UIComponent
 Inherited
toolTipStart
Dispatched by a component whose toolTip property is set, as soon as the user moves the mouse over it.UIComponent
 Inherited
updateComplete
Dispatched when an object has had its commitProperties(), measure(), and updateDisplayList() methods called (if needed).UIComponent
 Inherited
valid
Dispatched when a component is monitored by a Validator and the validation succeeded.UIComponent
 Inherited
valueCommit
Dispatched when values are changed programmatically or by user interaction.UIComponent
Styles
Click for more information on styles
 Style Description Defined By
 Inherited
alignmentBaseline
Type: String CSS Inheritance: yes
Specifies the baseline to which the dominant baseline aligns.		ButtonBase
 Inherited
baseColor
Type: uint Format: Color CSS Inheritance: yes Theme: spark
SkinnableComponent
 Inherited
baseline
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
 Inherited
baselineShift
Type: Object CSS Inheritance: yes
Amount to shift the baseline from the dominantBaseline value.		ButtonBase
 Inherited
bottom
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
 Inherited
cffHinting
Type: String CSS Inheritance: yes
The type of CFF hinting used for this text.		ButtonBase
 Inherited
color
Type: uint Format: Color CSS Inheritance: yes
Color of the text.		ButtonBase
 Inherited
cornerRadius
Type: Number Format: Length CSS Inheritance: no Theme: spark
The radius of the corners of this component.		ButtonBase
 Inherited
digitCase
Type: String CSS Inheritance: yes
The type of digit case used for this text.		ButtonBase
 Inherited
digitWidth
Type: String CSS Inheritance: yes
Type of digit width used for this text.		ButtonBase
 Inherited
direction
Type: String CSS Inheritance: yes
Specifies the default bidirectional embedding level of the text in the text block.		ButtonBase
 Inherited
dominantBaseline
Type: String CSS Inheritance: yes
Specifies which element baseline snaps to the alignmentBaseline to determine the vertical position of the element on the line.		ButtonBase
 Inherited
errorSkin
Type: Class
Name of the skin class to use for this component when a validation error occurs.		SkinnableComponent
 Inherited
focusAlpha
Type: Number CSS Inheritance: no Theme: spark
The alpha of the focus ring for this component.		ButtonBase
 Inherited
focusColor
Type: uint Format: Color CSS Inheritance: yes Theme: spark
ButtonBase
 Inherited
focusSkin
Type: Class CSS Inheritance: no
Skin used to draw the focus rectangle.		UIComponent
 Inherited
focusThickness
Type: Number Format: Length CSS Inheritance: no
Thickness, in pixels, of the focus rectangle outline.		UIComponent
 Inherited
fontFamily
Type: String CSS Inheritance: yes
The name of the font to use, or a comma-separated list of font names.		ButtonBase
 Inherited
fontLookup
Type: String CSS Inheritance: yes
Font lookup to use.		ButtonBase
 Inherited
fontSize
Type: Number Format: Length CSS Inheritance: yes
The size of the text in pixels.		ButtonBase
 Inherited
fontStyle
Type: String CSS Inheritance: yes
Style of text.		ButtonBase
 Inherited
fontWeight
Type: String CSS Inheritance: yes
Weight of text.		ButtonBase
 Inherited
horizontalCenter
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
 Inherited
justificationRule
Type: String CSS Inheritance: yes
Rule used to justify text in a paragraph.		ButtonBase
 Inherited
justificationStyle
Type: String CSS Inheritance: yes
The style used for justification of the paragraph.		ButtonBase
 Inherited
kerning
Type: String CSS Inheritance: yes
Kerning adjusts the pixels between certain character pairs to improve readability.		ButtonBase
 Inherited
left
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
 Inherited
ligatureLevel
Type: String CSS Inheritance: yes
Controls which of the ligatures that are defined in the font may be used in the text.		ButtonBase
 Inherited
lineHeight
Type: Object CSS Inheritance: yes
Leading controls for the text.		ButtonBase
 Inherited
lineThrough
Type: Boolean CSS Inheritance: yes
If true, applies strikethrough, a line drawn through the middle of the text.		ButtonBase
 Inherited
locale
Type: String CSS Inheritance: yes
The locale of the text.		ButtonBase
 Inherited
renderingMode
Type: String CSS Inheritance: yes
The rendering mode used for this text.		ButtonBase
 Inherited
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.		ButtonBase
 Inherited
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.		ButtonBase
 Inherited
right
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
 Inherited
skinClass
Type: Class
Name of the skin class to use for this component.		SkinnableComponent
 Inherited
textAlign
Type: String CSS Inheritance: yes
Alignment of lines in the paragraph relative to the container.		ButtonBase
 Inherited
textAlignLast
Type: String CSS Inheritance: yes
Alignment of the last (or only) line in the paragraph relative to the container in justified text.		ButtonBase
 Inherited
textAlpha
Type: Number CSS Inheritance: yes
Alpha (transparency) value for the text.		ButtonBase
 Inherited
textDecoration
Type: String CSS Inheritance: yes
Decoration on text.		ButtonBase
 Inherited
textJustify
Type: String CSS Inheritance: yes
Specifies options for justifying text.		ButtonBase
 Inherited
top
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
 Inherited
trackingLeft
Type: Object CSS Inheritance: yes
Number in pixels (or percent of fontSize, like 120%) indicating the amount of tracking (manual kerning) to be applied to the left of each character.		ButtonBase
 Inherited
trackingRight
Type: Object CSS Inheritance: yes
Number in pixels (or percent of fontSize, like 120%) indicating the amount of tracking (manual kerning) to be applied to the right of each character.		ButtonBase
 Inherited
typographicCase
Type: String CSS Inheritance: yes
The type of typographic case used for this text.		ButtonBase
 Inherited
verticalCenter
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
Skin Parts

This component uses skins made up of skin parts. Do not set the skin parts directly. The component's skin sets the skin parts.


Click for more information on skins
 Skin Part Description Defined By
 Inherited
labelDisplay:TextBase
Required: false Part Type: Static
A skin part that defines the label of the button.
ButtonBase
Skin States

To skin the component, implement a skin that defines the following states. Although you must implement all skin states, a skin state can be empty. An empty skin state specifies no changes to the default skin state.


Click for more information on skins
 Skin State Description Defined By
 Inherited
disabled
 Disabled State of the Button ButtonBase
 Inherited
disabledAndSelected
 Disabled State of the Button when it's selected ToggleButtonBase
 Inherited
down
 Down State of the Button ButtonBase
 Inherited
downAndSelected
 Down State of the Button when it's selected ToggleButtonBase
 Inherited
over
 Over State of the Button ButtonBase
 Inherited
overAndSelected
 Over State of the Button when it's selected ToggleButtonBase
 Inherited
up
 Up State of the Button ButtonBase
 Inherited
upAndSelected
 Up State of the Button when it's selected ToggleButtonBase
Effects
Click for more information on effects
 Effect Description Defined By
 Inherited
addedEffect
 Triggering Event: added
Played when the component is added as a child to a Container. 		UIComponent
 Inherited
creationCompleteEffect
 Triggering Event: creationComplete
Played when the component is created. 		UIComponent
 Inherited
focusInEffect
 Triggering Event: focusIn
Played when the component gains keyboard focus. 		UIComponent
 Inherited
focusOutEffect
 Triggering Event: focusOut
Played when the component loses keyboard focus. 		UIComponent
 Inherited
hideEffect
 Triggering Event: hide
Played when the component becomes invisible. 		UIComponent
 Inherited
mouseDownEffect
 Triggering Event: mouseDown
Played when the user presses the mouse button while over the component. 		UIComponent
 Inherited
mouseUpEffect
 Triggering Event: mouseUp
Played when the user releases the mouse button while over the component. 		UIComponent
 Inherited
moveEffect
 Triggering Event: move
Played when the component is moved. 		UIComponent
 Inherited
removedEffect
 Triggering Event: removed
Played when the component is removed from a Container. 		UIComponent
 Inherited
resizeEffect
 Triggering Event: resize
Played when the component is resized. 		UIComponent
 Inherited
rollOutEffect
 Triggering Event: rollOut
Played when the user rolls the mouse so it is no longer over the component. 		UIComponent
 Inherited
rollOverEffect
 Triggering Event: rollOver
Played when the user rolls the mouse over the component. 		UIComponent
 Inherited
showEffect
 Triggering Event: show
Played when the component becomes visible. 		UIComponent
Public Constants
 ConstantDefined By
 InheritedDEFAULT_MAX_HEIGHT : Number = 10000
[static] The default value for the maxHeight property.
UIComponent
 InheritedDEFAULT_MAX_WIDTH : Number = 10000
[static] The default value for the maxWidth property.
UIComponent
 InheritedDEFAULT_MEASURED_HEIGHT : Number = 22
[static] The default value for the measuredHeight property.
UIComponent
 InheritedDEFAULT_MEASURED_MIN_HEIGHT : Number = 22
[static] The default value for the measuredMinHeight property.
UIComponent
 InheritedDEFAULT_MEASURED_MIN_WIDTH : Number = 40
[static] The default value for the measuredMinWidth property.
UIComponent
 InheritedDEFAULT_MEASURED_WIDTH : Number = 160
[static] The default value for the measuredWidth property.
UIComponent
Constructor Detail
ToggleButton()Constructor
public function ToggleButton()

Language Version: ActionScript 3.0
Product Version: Flex 4
Runtime Versions: Flash Player 10, AIR 1.5

Constructor.

Examples (  How to use this example  )
ToggleButtonExample.mxml
<?xml version="1.0"?>
<!-- Simple example to demonstrate the Spark ToggleButton control -->
<s:Application xmlns:fx="http://ns.adobe.com/mxml/2009" xmlns:s="library://ns.adobe.com/flex/spark" xmlns:mx="library://ns.adobe.com/flex/halo">

    <fx:Script>
        <![CDATA[
            // Event handler function to print a message
            // describing the Spark ToggleButton selected state.
            // Toggle the fontWeight of the Label between bold and normal
            private function printMessage(evt:Event):void  {
                if (evt.target.selected){
                    message.text += "fontWeight: bold" + "\n";
                    lbl.setStyle("fontWeight", "bold");
                    togBtn.label = "Bold";
                } else{
                    message.text += "fontWeight: normal" + "\n";
                    lbl.setStyle("fontWeight", "normal");
                    togBtn.label = "Normal";
                }
            }
        ]]>
    </fx:Script>

    <s:Panel title="Spark ToggleButton Control Example"
            width="75%" height="75%" 
            horizontalCenter="0" verticalCenter="0">
        <s:VGroup left="10" right="10" top="10" bottom="10">
            <s:ToggleButton id="togBtn" label="Normal" click="printMessage(event);" />
            <s:Label id="lbl" text="Label" />
            <s:TextArea id="message" height="100%" width="100%" color="#0000FF" />
        </s:VGroup>
    </s:Panel>

</s:Application>



© 2009 Adobe Systems Incorporated. All rights reserved.
Sat Oct 3 2009, 04:15 AM -07:00