Packagespark.components
Classpublic class Callout
InheritanceCallout Inheritance SkinnablePopUpContainer Inheritance SkinnableContainer Inheritance SkinnableContainerBase Inheritance SkinnableComponent Inheritance UIComponent Inheritance FlexSprite Inheritance flash.display.Sprite

Language Version : ActionScript 3.0
Product Version : Flex 4.6
Runtime Versions : Flash Player 11, AIR 3

The Callout container is a SkinnablePopUpContainer that functions as a pop-up with additional owner-relative positioning options similar to PopUpAnchor. Callout also adds an optional arrow skin part that visually displays the direction toward the owner.

You can also use the CalloutButton control to open a callout container. The CalloutButton control encapsulates in a single control the callout container and all of the logic necessary to open and close the callout. The CalloutButton control is then said to the be the owner, or host, of the callout.

Callout uses the horizontalPosition and verticalPosition properties to determine the position of the Callout relative to the owner that is specified by the open() method. Both properties can be set to CalloutPosition.AUTO which selects a position based on the aspect ratio of the screen for the Callout to fit with minimal overlap with the owner and and minimal adjustments at the screen bounds.

Once positioned, the Callout positions the arrow on the side adjacent to the owner, centered as close as possible on the horizontal or vertical center of the owner as appropriate. The arrow is hidden in cases where the Callout position is not adjacent to any edge.

You do not create a Callout container as part of the normal layout of its parent container. Instead, it appears as a pop-up container on top of its parent. Therefore, you do not create it directly in the MXML code of your application.

Instead, you create is as an MXML component, often in a separate MXML file. To show the component create an instance of the MXML component, and then call the open() method. You can also set the size and position of the component when you open it.

To close the component, call the close() method. If the pop-up needs to return data to a handler, you can add an event listener for the PopUp.CLOSE event, and specify the returned data in the close() method.

The Callout is initially in its closed skin state. When it opens, it adds itself as a pop-up to the PopUpManager, and transition to the normal skin state. To define open and close animations, use a custom skin with transitions between the closed and normal skin states.

Callout changes the default inheritance behavior seen in Flex components and instead, inherits styles from the top-level application. This prevents Callout's contents from unintentionally inheriting styles from an owner (i.e. Button or TextInput) where the default appearance was desired and expected.

The Callout container has the following default characteristics:

CharacteristicDescription
Default sizeLarge enough to display its children
Minimum size0 pixels
Maximum size10000 pixels wide and 10000 pixels high
Default skin classspark.skins.mobile.CalloutSkin spark.skins.spark.CalloutSkin on desktops

MXML SyntaxexpandedHide MXML Syntax

The <s:Callout> tag inherits all of the tag attributes of its superclass and adds the following tag attributes:

  <s:Callout
    Properties
    horizontalPosition="auto"
    verticalPosition="auto"
     Styles
    contentBackgroundAppearance="inset"
  />
  

Default MXML PropertymxmlContentFactory

View the examples

See also

spark.components.CalloutButton
spark.skins.mobile.CalloutSkin
spark.components.ContentBackgroundAppearance
spark.components.CalloutPosition


Public Properties
 PropertyDefined By
 InheritedaccessibilityDescription : String
A convenience accessor for the description property in this UIComponent's accessibilityProperties object.
UIComponent
 InheritedaccessibilityEnabled : Boolean
A convenience accessor for the silent property in this UIComponent's accessibilityProperties object.
UIComponent
 InheritedaccessibilityName : String
A convenience accessor for the name property in this UIComponent's accessibilityProperties object.
UIComponent
 InheritedaccessibilityShortcut : String
A convenience accessor for the shortcut property in this UIComponent's accessibilityProperties object.
UIComponent
 InheritedactiveEffects : Array
[read-only] The list of effects that are currently playing on the component, as an Array of EffectInstance instances.
UIComponent
  arrowDirection : String
[read-only] A read-only property that indicates the direction from the callout towards the owner.
Callout
 InheritedautoLayout : Boolean
If true, measurement and layout are done when the position or size of a child is changed.
SkinnableContainer
 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
 Inheritedbaseline : Object
For components, this layout constraint property is a facade on top of the similarly-named style.
UIComponent
 InheritedbaselinePosition : Number
[override] [read-only] The y-coordinate of the baseline of the first line of text of the component.
SkinnableComponent
 Inheritedbottom : Object
For components, this layout constraint property is a facade on top of the similarly-named style.
UIComponent
 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
 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
 InheritedcreationPolicy : String
Content creation policy for this component.
SkinnableContainer
 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
 InheriteddefaultButton : IFlexDisplayObject
The Button control designated as the default button for the container.
SkinnableContainerBase
 InheriteddeferredContentCreated : Boolean
[read-only] Contains true if deferred content has been created.
SkinnableContainer
 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
 Inheritedenabled : Boolean
Whether the component can accept user interaction.
UIComponent
 InheritederrorString : String
The text that 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
 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
 InheritedhasFocusableChildren : Boolean
A flag that indicates whether child objects can receive focus.
UIComponent
 InheritedhasLayoutMatrix3D : Boolean
[read-only] Contains 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
 InheritedhorizontalCenter : Object
For components, this layout constraint property is a facade on top of the similarly-named style.
UIComponent
  horizontalPosition : String
Horizontal position of the callout relative to the owner.
Callout
 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] Contains true when the element is in 3D.
UIComponent
 InheritedisDocument : Boolean
[read-only] Contains true if this UIComponent instance is a document object.
UIComponent
 InheritedisOpen : Boolean
[read-only] Contains true when the container is open and is currently showing as a pop-up.
SkinnablePopUpContainer
 InheritedisPopUp : Boolean
Set to true by the PopUpManager to indicate that component has been popped up.
UIComponent
 Inheritedlayout : LayoutBase
The layout object for this container.
SkinnableContainer
 InheritedlayoutMatrix3D : Matrix3D
[write-only] The transform matrix that is used to calculate a component's layout relative to its siblings.
UIComponent
 Inheritedleft : Object
For components, this layout constraint property is a facade on top of the similarly-named style.
UIComponent
 InheritedmaintainProjectionCenter : Boolean
When true, the component keeps its projection matrix centered on the middle of its bounding box.
UIComponent
 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 embedded fonts and for finding the style manager that controls the styles for this component.
UIComponent
 InheritedmouseFocusEnabled : Boolean
Whether you can receive focus when clicked on.
UIComponent
 InheritedAIR-only moveForSoftKeyboard : Boolean
Enables moving the pop-up when the soft keyboard on a mobile device is active.
SkinnablePopUpContainer
 InheritedmxmlContent : Array
[write-only] The visual content children for this Group.
SkinnableContainer
 InheritedmxmlContentFactory : IDeferredInstance
[write-only] A factory object that creates the initial value for the content property.
SkinnableContainer
 InheritedMXMLDescriptor : Array
[read-only]
UIComponent
 InheritedMXMLProperties : Array
[read-only]
UIComponent
 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
 InheritednumElements : int
[read-only] The number of visual elements in this container.
SkinnableContainer
 Inheritedowner : DisplayObjectContainer
The owner of this IVisualElement object.
UIComponent
 Inheritedparent : DisplayObjectContainer
[override] [read-only] The parent container or component for this component.
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
Specifies the height of a component as a percentage of its parent's size.
UIComponent
 InheritedpercentWidth : Number
Specifies the width of a component as a percentage of its parent's size.
UIComponent
 InheritedpostLayoutTransformOffsets : TransformOffsets
Defines a set of adjustments that can be applied to the object's transform in a way that is invisible to its parent's layout.
UIComponent
 InheritedprocessedDescriptors : Boolean
Set to true after immediate or deferred child creation, depending on which one happens.
UIComponent
 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
 InheritedAIR-only resizeForSoftKeyboard : Boolean
Enables resizing the pop-up when the soft keyboard on a mobile device is active.
SkinnablePopUpContainer
 Inheritedright : Object
For components, this layout constraint property is a facade on top of the similarly-named style.
UIComponent
 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]
UIComponent
 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
 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
 Inheritedstates : Array
The view states that are defined for this component.
UIComponent
 InheritedstyleDeclaration : CSSStyleDeclaration
Storage for the inline inheriting styles on this object.
UIComponent
 InheritedstyleManager : IStyleManager2
[read-only] Returns the StyleManager instance used by this component.
UIComponent
 InheritedstyleName : Object
The class style used by this component.
UIComponent
 InheritedstyleParent : IAdvancedStyleClient
A component's parent is used to evaluate descendant selectors.
UIComponent
 InheritedsuggestedFocusSkinExclusions : Array
[read-only] Lists the skin parts that are excluded from bitmaps captured and used to show focus.
SkinnableComponent
 InheritedsystemManager : ISystemManager
Returns the SystemManager object used by this component.
UIComponent
 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
 InheritedtoolTip : String
Text to display in the ToolTip.
UIComponent
 Inheritedtop : Object
For components, this layout constraint property is a facade on top of the similarly-named style.
UIComponent
 Inheritedtransform : Transform
[override] An object with properties pertaining to a display object's matrix, color transform, and pixel bounds.
UIComponent
 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
 InheritedvalidationSubField : String
Used by a validator to associate a subfield with this component.
UIComponent
 InheritedverticalCenter : Object
For components, this layout constraint property is a facade on top of the similarly-named style.
UIComponent
  verticalPosition : String
Vertical position of the callout relative to the owner.
Callout
 Inheritedvisible : Boolean
[override] Whether or not the display object is visible.
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]
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
 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
  
Constructor.
Callout
 Inherited
Adds a visual element to this container.
SkinnableContainer
 Inherited
Adds a visual element to this container.
SkinnableContainer
 Inherited
Adds a non-visual style client to this component instance.
UIComponent
 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
close(commit:Boolean = false, data:*):void
Changes the current skin state to closed, waits until any state transitions finish playing, dispatches a PopUpEvent.CLOSE event, and then removes the container from the PopUpManager.
SkinnablePopUpContainer
 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
Returns a set of properties that identify the child within this container.
UIComponent
 Inherited
Returns a set of properties as automation IDs that identify the child within this container.
UIComponent
 Inherited
Create the content for this component.
SkinnableContainer
 Inherited
Creates an id reference to this IUIComponent object on its parent document object.
UIComponent
 Inherited
Deletes the id reference to this IUIComponent object on its parent document object.
UIComponent
 Inherited
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
Programmatically draws a rectangle into this skin's Graphics object.
UIComponent
 Inherited
Called by the effect instance when it stops playing on the component.
UIComponent
 Inherited
Called by the effect instance when it starts playing on the component.
UIComponent
 Inherited
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
generateMXMLArray(document:Object, data:Array, recursive:Boolean = true):Array
UIComponent
 Inherited
generateMXMLVector(document:Object, data:Array, recursive:Boolean = true):*
UIComponent
 Inherited
Provides the automation object at the specified index.
UIComponent
 Inherited
Provides the automation object list .
UIComponent
 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
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
Returns the visual element at the specified index.
SkinnableContainer
 Inherited
Returns the index position of a visual element.
SkinnableContainer
 Inherited
A convenience method for determining whether to use the explicit or measured height
UIComponent
 Inherited
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
Returns the transform matrix that is used to calculate the component's layout relative to its siblings.
UIComponent
 Inherited
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
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
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
getVisibleRect(targetParent:DisplayObject = null):Rectangle
Get the bounds of this object that are visible to the user on the screen.
UIComponent
 Inherited
globalToContent(point:Point):Point
Converts a Point object from global to content coordinates.
UIComponent
 Inherited
hasCSSState():Boolean
Returns true if currentCSSState is not null.
UIComponent
 Inherited
hasState(stateName:String):Boolean
Determines whether the specified state has been defined on this UIComponent.
UIComponent
 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
Initializes various properties which keep track of repeated instances of this component.
UIComponent
 Inherited
Marks a component so that its updateDisplayList() method gets called during a later screen update.
UIComponent
 Inherited
Called by a component's items to indicate that their depth property has changed.
UIComponent
 Inherited
An element must call this method when its layoutDirection changes or when its parent's layoutDirection changes.
UIComponent
 Inherited
Marks a component so that its commitProperties() method gets called during a later screen update.
UIComponent
 Inherited
Marks a component so that its measure() method gets called during a later screen update.
UIComponent
 Inherited
Marks the component so that the new state of the skin is set during a later screen update.
SkinnableComponent
 Inherited
localToContent(point:Point):Point
Converts a Point object from local to content coordinates.
UIComponent
 Inherited
matchesCSSState(cssState:String):Boolean
Returns true if cssState matches currentCSSState.
UIComponent
 Inherited
matchesCSSType(cssType:String):Boolean
Determines whether this instance is the same as, or is a subclass of, the given type.
UIComponent
 Inherited
measureHTMLText(htmlText:String):TextLineMetrics
Measures the specified HTML text, which can 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):TextLineMetrics
Measures the specified text, assuming that it is displayed in a single-line UITextField (or UIFTETextField) 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
open(owner:DisplayObjectContainer, modal:Boolean = false):void
Opens the container as a pop-up, and switches the skin state from closed to normal.
SkinnablePopUpContainer
 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
Prepares an IFlexDisplayObject for printing.
UIComponent
 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
Removes all visual elements from the container.
SkinnableContainer
 Inherited
Removes the specified visual element from the child list of this container.
SkinnableContainer
 Inherited
Removes a visual element from the specified index position in the container.
SkinnableContainer
 Inherited
Removes a non-visual style client from this component instance.
UIComponent
 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
[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
setElementIndex(element:IVisualElement, index:int):void
Changes the position of an existing visual element in the visual container.
SkinnableContainer
 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 of the element.
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
Sets the transform Matrix3D that is used to calculate the component's layout size and position relative to its siblings.
UIComponent
 Inherited
setMXMLDescriptor(value:Array):void
UIComponent
 Inherited
setMXMLProperties(value:Array):void
UIComponent
 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
styleChanged(styleProp:String):void
Detects changes to style properties.
UIComponent
 Inherited
Flex calls the stylesInitialized() method when the styles for a component are first initialized.
UIComponent
 Inherited
[static] Blocks the background processing of methods queued by callLater(), until resumeBackgroundProcessing() is called.
UIComponent
 Inherited
swapElements(element1:IVisualElement, element2:IVisualElement):void
Swaps the index of the two specified visual elements.
SkinnableContainer
 Inherited
swapElementsAt(index1:int, index2:int):void
Swaps the visual elements at the two specified index positions in the container.
SkinnableContainer
 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, invalidateLayout:Boolean = true):void
A utility method to update the rotation, scale, and translation of the transform while keeping a particular point, specified in the component's own coordinate space, fixed in the parent's coordinate space.
UIComponent
 Inherited
transformPointToParent(localPosition:Vector3D, position:Vector3D, postLayoutPosition:Vector3D):void
A utility method to transform a point specified in the local coordinates of this object to its location in the object's parent's coordinates.
UIComponent
 Inherited
Positions the pop-up after the pop-up is added to PopUpManager but before any state transitions occur.
SkinnablePopUpContainer
 Inherited
Validates the position and size of children and draws other visuals.
UIComponent
 Inherited
Validate and update the properties and layout of this object and redraw it, if necessary.
UIComponent
 Inherited
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
Handles both the valid and invalid events from a validator assigned to this component.
UIComponent
 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
Protected Methods
 MethodDefined By
 Inherited
addMXMLChildren(comps:Array):void
[override] override setting of children
SkinnableContainer
 Inherited
adjustFocusRect(obj:DisplayObject = null):void
Adjust the focus rectangle.
UIComponent
 Inherited
Commits the computed matrix built from the combination of the layout matrix and the transform offsets to the flash displayObject's transform.
UIComponent
 Inherited
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
Determines if the call to the measure() method can be skipped.
UIComponent
 Inherited
Performs any final processing after child objects are created.
UIComponent
 Inherited
Clear out references to skin parts.
SkinnableComponent
 Inherited
Processes the properties set on the component.
UIComponent
 Inherited
[override] Create content children, if the creationPolicy property is not equal to none.
SkinnableContainer
 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
AIR-only createSoftKeyboardEffect(yTo:Number, heightTo:Number):IEffect
Called by the soft keyboard activate and deactive event handlers, this method is responsible for creating the Spark effect played on the pop-up.
SkinnablePopUpContainer
 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
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
generateMXMLAttributes(data:Array):void
UIComponent
 Inherited
generateMXMLInstances(document:Object, data:Array, recursive:Boolean = true):void
[override]
SkinnableContainer
 Inherited
generateMXMLObject(document:Object, data:Array):Object
UIComponent
 Inherited
[override] Returns the name of the state to be applied to the skin.
SkinnableContainerBase
 Inherited
getDynamicPartAt(partName:String, index:int):Object
Returns a specific instance of a dynamic part.
SkinnableComponent
 Inherited
Initializes the implementation and storage of some of the less frequently used advanced layout features of a component.
UIComponent
 Inherited
Finalizes the initialization of this component.
UIComponent
 Inherited
Initializes this component's accessibility code.
UIComponent
 Inherited
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
numDynamicParts(partName:String):int
Returns the number of instances of a dynamic part.
SkinnableComponent
 Inherited
partAdded(partName:String, instance:Object):void
[override] Called when a skin part is added.
SkinnableContainer
 Inherited
partRemoved(partName:String, instance:Object):void
[override] Called when an instance of a skin part is being removed.
SkinnableContainer
 Inherited
removeDynamicPartInstance(partName:String, instance:Object):void
Remove an instance of a dynamic part.
SkinnableComponent
 Inherited
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
  
Sets the bounds of arrow, whose geometry isn't fully specified by the skin's layout.
Callout
Events
 Event Summary Defined By
 InheritedDispatched when the component is added to a container as a content child by using the addChild(), addChildAt(), addElement(), or addElementAt() method.UIComponent
 InheritedDispatched by the container when it's closed.SkinnablePopUpContainer
 InheritedDispatched after the content for this component has been created.SkinnableContainer
 InheritedDispatched when the component has finished its construction, property processing, measuring, layout, and drawing.UIComponent
 InheritedDispatched after the view state has changed.UIComponent
 InheritedDispatched after the currentState property changes, but before the view state changes.UIComponent
 InheritedDispatched 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
 InheritedDispatched by the drop target when the user releases the mouse over it.UIComponent
 InheritedDispatched by a component when the user moves the mouse over the component during a drag operation.UIComponent
 InheritedDispatched by the component when the user drags outside the component, but does not drop the data onto the target.UIComponent
 InheritedDispatched by a component when the user moves the mouse while over the component during a drag operation.UIComponent
 InheritedDispatched by the drag initiator when starting a drag operation.UIComponent
 InheritedDispatched after an effect ends.UIComponent
 InheritedDispatched just before an effect starts.UIComponent
 InheritedDispatched after an effect is stopped, which happens only by a call to stop() on the effect.UIComponent
 InheritedDispatched when a visual element is added to the content holder.SkinnableContainer
 InheritedDispatched when a visual element is removed from the content holder.SkinnableContainer
 InheritedDispatched after the component has entered a view state.UIComponent
 InheritedDispatched just before the component exits a view state.UIComponent
 InheritedDispatched when an object's state changes from visible to invisible.UIComponent
 InheritedDispatched when the component has finished its construction and has all initialization properties set.UIComponent
 InheritedDispatched when a component is monitored by a Validator and the validation failed.UIComponent
 InheritedDispatched from a component opened using the PopUpManager when the user clicks outside it.UIComponent
 InheritedDispatched from a component opened using the PopUpManager when the user scrolls the mouse wheel outside it.UIComponent
 InheritedDispatched when the object has moved.UIComponent
 InheritedDispatched by the container when it's opened and ready for user interaction.SkinnablePopUpContainer
 InheritedDispatched at the beginning of the component initialization sequence.UIComponent
 InheritedDispatched when the component is removed from a container as a content child by using the removeChild(), removeChildAt(), removeElement(), or removeElementAt() method.UIComponent
 InheritedDispatched when the component is resized.UIComponent
 InheritedDispatched when an object's state changes from invisible to visible.UIComponent
 InheritedDispatched after the component has entered a new state and any state transition animation to that state has finished playing.UIComponent
 InheritedDispatched when a component interrupts a transition to its current state in order to switch to a new state.UIComponent
 InheritedDispatched by the component when it is time to create a ToolTip.UIComponent
 InheritedDispatched by the component when its ToolTip has been hidden and is to be discarded soon.UIComponent
 InheritedDispatched by the component when its ToolTip is about to be hidden.UIComponent
 InheritedDispatched by the component when its ToolTip is about to be shown.UIComponent
 InheritedDispatched by the component when its ToolTip has been shown.UIComponent
 InheritedDispatched by a component whose toolTip property is set, as soon as the user moves the mouse over it.UIComponent
 InheritedA non-cancellable event, dispatched by a component when it is done responding to a touch interaction user gesture.UIComponent
 InheritedA non-cancellable event, dispatched by a component when it starts responding to a touch interaction user gesture.UIComponent
 InheritedA cancellable event, dispatched by a component in an attempt to respond to a touch interaction user gesture.UIComponent
 InheritedDispatched when an object has had its commitProperties(), measure(), and updateDisplayList() methods called (if needed).UIComponent
 InheritedDispatched when a component is monitored by a Validator and the validation succeeded.UIComponent
 InheritedDispatched when values are changed programmatically or by user interaction.UIComponent
Styles
 Style Description Defined By
 InheritedType: uint Format: Color CSS Inheritance: yes Theme: spark, mobile
Accent color used by component skins.
SkinnableContainer
 InheritedType: String CSS Inheritance: yes
Specifies the baseline to which the dominant baseline aligns.

See also

SkinnableContainer
 InheritedType: Array Format: Color CSS Inheritance: yes Theme: spark, mobile
The colors to use for the backgrounds of the items in the list.
SkinnableContainer
 InheritedType: Number CSS Inheritance: no Theme: spark, mobile
Alpha level of the background for this component.
SkinnableContainer
 InheritedType: uint Format: Color CSS Inheritance: no Theme: spark, mobile
Background color of a component.
SkinnableContainer
 InheritedType: String CSS Inheritance: no
The vertical distance in pixels from the top edge of the content area to the control's baseline position.
UIComponent
 InheritedType: Object CSS Inheritance: yes
Amount to shift the baseline.

See also

SkinnableContainer
 InheritedType: String CSS Inheritance: yes
Specifies a vertical or horizontal progression of line placement.

See also

SkinnableContainer
  
borderColor
Type: uint Format: Color CSS Inheritance: no Theme: spark, mobile
Color of the frame border and arrow outline of the Callout control. The default value is 0.
Callout
  
borderThickness
Type: Number Format: Length CSS Inheritance: no Theme: spark,mobile
Thickness of the border stroke around the backgroundColor Callout "frame" and arrow. Set to NaN or 0 to hide the border ; The default value is NaN.
Callout
 InheritedType: String CSS Inheritance: no
The vertical distance, in pixels, from the bottom edge of the component to the bottom edge of its parent container's content area.
UIComponent
 InheritedType: String CSS Inheritance: yes
Controls where lines are allowed to break when breaking wrapping text into multiple lines.

See also

SkinnableContainer
 InheritedType: String CSS Inheritance: yes
The type of CFF hinting used for this text.

See also

SkinnableContainer
 InheritedType: uint Format: Color CSS Inheritance: yes Theme: spark, mobile
The main color for a component.
SkinnableComponent
 InheritedType: String CSS Inheritance: yes
Controls how text wraps around a float.

See also

SkinnableContainer
 InheritedType: uint Format: Color CSS Inheritance: yes
Color of the text.

See also

SkinnableContainer
 InheritedType: String CSS Inheritance: yes
Controls column break after the element.

See also

SkinnableContainer
 InheritedType: String CSS Inheritance: yes
Controls column break before the element.

See also

SkinnableContainer
 InheritedType: String CSS Inheritance: yes
Controls container break after the element.

See also

SkinnableContainer
 InheritedType: String CSS Inheritance: yes
Controls container break before the element.

See also

SkinnableContainer
 InheritedType: Number CSS Inheritance: yes Theme: spark, mobile
The alpha of the content background for this component.
SkinnableContainer
  
contentBackgroundAppearance
Type: String CSS Inheritance: no
Appearance of the contentGroup. Valid MXML values are inset, flat, and none.

In ActionScript, you can use the following constants to set this property: ContentBackgroundAppearance.INSET, ContentBackgroundAppearance.FLAT and ContentBackgroundAppearance.NONE.

The default value is ContentBackgroundAppearance.INSET.
Callout
 InheritedType: uint Format: Color CSS Inheritance: yes Theme: spark, mobile
The color of the content background for this component.
SkinnableContainer
 InheritedType: String CSS Inheritance: yes
The type of digit case used for this text.

See also

SkinnableContainer
 InheritedType: String CSS Inheritance: yes
Type of digit width used for this text.

See also

SkinnableContainer
 InheritedType: String CSS Inheritance: yes
Specifies the default bidirectional embedding level of the text.

See also

SkinnableContainer
 InheritedType: String CSS Inheritance: yes
Specifies which element baseline snaps to the alignmentBaseline to determine the vertical position of the element on the line.

See also

SkinnableContainer
 InheritedType: uint Format: Color CSS Inheritance: yes Theme: mobile
Color of the background of an item renderer when it is being pressed down

If downColor is set to undefined, downColor is not used.

The default value for the Spark theme is undefined.

SkinnableContainer
 InheritedType: uint Format: Color CSS Inheritance: yes
Color of the component highlight when validation fails.
UIComponent
 InheritedType: Class
Name of the skin class to use for this component when a validation error occurs.
SkinnableComponent
 InheritedType: Object CSS Inheritance: yes
Specifies the baseline position of the first line in the container.

See also

SkinnableContainer
 InheritedType: uint Format: Color CSS Inheritance: yes Theme: spark, mobile
Color of focus ring when the component is in focus.
SkinnableContainer
 InheritedType: uint Format: Color CSS Inheritance: yes
The color of text when the component is enabled and has focus.
SkinnableContainer
 InheritedType: Class CSS Inheritance: no
Skin used to draw the focus rectangle.
UIComponent
 InheritedType: String CSS Inheritance: yes
The name of the font to use, or a comma-separated list of font names.

See also

SkinnableContainer
 InheritedType: String CSS Inheritance: yes
Font lookup to use.

See also

SkinnableContainer
 InheritedType: Number Format: Length CSS Inheritance: yes
Height of the text, in pixels.

See also

SkinnableContainer
 InheritedType: String CSS Inheritance: yes
Determines whether the text is italic font.

See also

SkinnableContainer
 InheritedType: String CSS Inheritance: yes
Determines whether the text is boldface.

See also

SkinnableContainer
 InheritedType: 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
 InheritedType: uint Format: Color CSS Inheritance: yes
The color of text when the component is disabled.
SkinnableContainer
 InheritedType: String CSS Inheritance: yes
The primary interaction mode for this component.

See also

UIComponent
 InheritedType: String CSS Inheritance: yes
Rule used to justify text in a paragraph.

See also

SkinnableContainer
 InheritedType: String CSS Inheritance: yes
The style used for justification of the paragraph.

See also

SkinnableContainer
 InheritedType: String CSS Inheritance: yes
The style used for justification of the paragraph.

See also

SkinnableContainer
 InheritedType: String CSS Inheritance: yes
Specifies the desired layout direction of a component.

See also

UIComponent
 InheritedType: Number Format: Length CSS Inheritance: yes Theme: mobile
Additional vertical space between lines of text.

See also

SkinnableContainer
 InheritedType: String CSS Inheritance: yes
Specifies the leading model, which is a combination of leading basis and leading direction.

See also

SkinnableContainer
 InheritedType: String CSS Inheritance: no
The horizontal distance, in pixels, from the left edge of the component to the left edge of its parent container's content area.
UIComponent
 InheritedType: Number CSS Inheritance: yes Theme: mobile
The number of additional pixels to appear between each character.

See also

SkinnableContainer
 InheritedType: String CSS Inheritance: yes
Controls which of the ligatures that are defined in the font may be used in the text.

See also

SkinnableContainer
 InheritedType: Object CSS Inheritance: yes
Leading controls for the text.

See also

SkinnableContainer
 InheritedType: Boolean CSS Inheritance: yes
If true, applies strikethrough, a line drawn through the middle of the text.

See also

SkinnableContainer
 InheritedType: Number Format: length CSS Inheritance: yes
This specifies an auto indent for the start edge of lists when the padding value of the list on that side is auto.

See also

SkinnableContainer
 InheritedType: String CSS Inheritance: yes
This controls the placement of a list item marker relative to the list item.

See also

SkinnableContainer
 InheritedType: String CSS Inheritance: yes
This controls the appearance of items in a list.

See also

SkinnableContainer
 InheritedType: String CSS Inheritance: yes
The locale of the text.

See also

SkinnableContainer
 InheritedType: Number Format: length CSS Inheritance: yes
The amount to indent the paragraph's end edge.

See also

SkinnableContainer
 InheritedType: Number Format: length CSS Inheritance: yes
The amount of space to leave after the paragraph.

See also

SkinnableContainer
 InheritedType: Number Format: length CSS Inheritance: yes
The amount of space to leave before the paragraph.

See also

SkinnableContainer
 InheritedType: Number Format: length CSS Inheritance: yes
The amount to indent the paragraph's start edge.

See also

SkinnableContainer
 InheritedType: String CSS Inheritance: yes
The rendering mode used for this text which applies only to embedded fonts.

See also

SkinnableContainer
 InheritedType: String CSS Inheritance: no
The horizontal distance, in pixels, from the right edge of the component to the right edge of its parent container's content area.
UIComponent
 InheritedType: uint Format: Color CSS Inheritance: yes Theme: spark
Color of the highlights when the mouse is over the component.
SkinnableContainer
 InheritedType: Boolean CSS Inheritance: yes
Show the error border or skin when this component is invalid.
UIComponent
 InheritedType: Boolean CSS Inheritance: yes
Show the error tip when this component is invalid and the user rolls over it.
UIComponent
 InheritedType: Class
Name of the skin class to use for this component.
SkinnableComponent
 InheritedType: Number Format: Time CSS Inheritance: no
Duration of the soft keyboard move and resize effect in milliseconds.
SkinnablePopUpContainer
 InheritedType: uint Format: Color CSS Inheritance: yes Theme: spark, mobile
Color of any symbol of a component.
SkinnableContainer
 InheritedType: String CSS Inheritance: yes
Specifies the tab stops associated with the paragraph.

See also

SkinnableContainer
 InheritedType: String CSS Inheritance: yes
Alignment of text within a container.

See also

SkinnableContainer
 InheritedType: String CSS Inheritance: yes
Alignment of the last line in the paragraph relative to the container in justified text.

See also

SkinnableContainer
 InheritedType: Number CSS Inheritance: yes
Alpha (transparency) value for the text.

See also

SkinnableContainer
 InheritedType: String CSS Inheritance: yes
Determines whether the text is underlined.

See also

SkinnableContainer
 InheritedType: Number Format: Length CSS Inheritance: yes
Offset of first line of text from the left side of the container.

See also

SkinnableContainer
 InheritedType: String CSS Inheritance: yes
Specifies options for justifying text.

See also

SkinnableContainer
 InheritedType: String CSS Inheritance: yes
Determines the number of degrees to rotate this text.

See also

SkinnableContainer
 InheritedType: Number CSS Inheritance: yes Theme: mobile
Alpha of text shadows.
SkinnableContainer
 InheritedType: uint Format: Color CSS Inheritance: yes Theme: mobile
Color of text shadows.
SkinnableContainer
 InheritedType: String CSS Inheritance: no
The vertical distance, in pixels, from the top edge of the component to the top edge of its parent container's content area.
UIComponent
 InheritedType: Number Format: Time CSS Inheritance: yes
When in touch interaction mode, the number of milliseconds to wait after the user interaction has occured before showing the component in a visually down state.
SkinnableContainer
 InheritedType: Object CSS Inheritance: yes
The amount of tracking (manual kerning) to be applied to the left of each character.

See also

SkinnableContainer
 InheritedType: Object CSS Inheritance: yes
The amount of tracking (manual kerning) to be applied to the right of each character.

See also

SkinnableContainer
 InheritedType: String CSS Inheritance: yes
The type of typographic case used for this text.

See also

SkinnableContainer
 InheritedType: uint Format: Color CSS Inheritance: yes
The color of text when the component is enabled but does not have focus.
SkinnableContainer
 InheritedType: 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
 InheritedType: String CSS Inheritance: yes
Collapses or preserves whitespace when importing text into a TextFlow.

See also

SkinnableContainer
 InheritedType: Object CSS Inheritance: yes
Specifies the spacing between words to use during justification.

See also

SkinnableContainer
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.


 Skin Part Description Defined By
  Required: false Part Type: Static
An optional skin part that visually connects the owner to the contentGroup.
Callout
 InheritedRequired: false Part Type: Static
An optional skin part that defines the Group where the content children get pushed into and laid out.
SkinnableContainer
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.


 Skin State Description Defined By
 Inherited The closed state. SkinnablePopUpContainer
 Inherited Disabled State SkinnableContainerBase
 Inherited Normal State SkinnableContainerBase
Effects
 Effect Description Defined By
 Inherited Triggering Event: added
Played when the component is added as a child to a Container.
UIComponent
 Inherited Triggering Event: creationComplete
Played when the component is created.
UIComponent
 Inherited Triggering Event: focusIn
Played when the component gains keyboard focus.
UIComponent
 Inherited Triggering Event: focusOut
Played when the component loses keyboard focus.
UIComponent
 Inherited Triggering Event: hide
Played when the component becomes invisible.
UIComponent
 Inherited Triggering Event: mouseDown
Played when the user presses the mouse button while over the component.
UIComponent
 Inherited Triggering Event: mouseUp
Played when the user releases the mouse button while over the component.
UIComponent
 Inherited Triggering Event: move
Played when the component is moved.
UIComponent
 Inherited Triggering Event: removed
Played when the component is removed from a Container.
UIComponent
 Inherited Triggering Event: resize
Played when the component is resized.
UIComponent
 Inherited Triggering Event: rollOut
Played when the user rolls the mouse so it is no longer over the component.
UIComponent
 Inherited Triggering Event: rollOver
Played when the user rolls the mouse over the component.
UIComponent
 Inherited 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
Property Detail
arrowDirectionproperty
arrowDirection:String  [read-only]

Language Version : ActionScript 3.0
Product Version : Flex 4.6
Runtime Versions : Flash Player 11, AIR 3

A read-only property that indicates the direction from the callout towards the owner.

This value is computed based on the callout position given by horizontalPosition and verticalPosition. Exterior and interior positions will point from the callout towards the edge of the owner. Corner and absolute center positions are not supported and will return a value of "none".

The default value is none.


Implementation
    public function get arrowDirection():String

See also

horizontalPositionproperty 
horizontalPosition:String

Language Version : ActionScript 3.0
Product Version : Flex 4.6
Runtime Versions : Flash Player 11, AIR 3

Horizontal position of the callout relative to the owner.

Possible values are "before", "start", "middle", "end", "after", and "auto" (default).

The default value is CalloutPosition.AUTO.


Implementation
    public function get horizontalPosition():String
    public function set horizontalPosition(value:String):void

See also

verticalPositionproperty 
verticalPosition:String

Language Version : ActionScript 3.0
Product Version : Flex 4.6
Runtime Versions : Flash Player 11, AIR 3

Vertical position of the callout relative to the owner.

Possible values are "before", "start", "middle", "end", "after", and "auto" (default).

The default value is CalloutPosition.AUTO.


Implementation
    public function get verticalPosition():String
    public function set verticalPosition(value:String):void

See also

Constructor Detail
Callout()Constructor
public function Callout()

Language Version : ActionScript 3.0
Product Version : Flex 4.6
Runtime Versions : Flash Player 11, AIR 3

Constructor.

Method Detail
updateSkinDisplayList()method
protected function updateSkinDisplayList():void

Language Version : ActionScript 3.0
Product Version : Flex 4.6
Runtime Versions : Flash Player 11, AIR 3

Sets the bounds of arrow, whose geometry isn't fully specified by the skin's layout.

Subclasses can override this method to update the arrow's size, position, and visibility, based on the computed arrowDirection.

By default, this method aligns the arrow on the shorter of either the arrow bounds or the owner bounds. This implementation assumes that the arrow and the Callout skin share the same coordinate space.

Examples
CalloutExample.mxml
<?xml version="1.0" encoding="utf-8"?>
<!--

  Licensed to the Apache Software Foundation (ASF) under one or more
  contributor license agreements.  See the NOTICE file distributed with
  this work for additional information regarding copyright ownership.
  The ASF licenses this file to You under the Apache License, Version 2.0
  (the "License"); you may not use this file except in compliance with
  the License.  You may obtain a copy of the License at

      http://www.apache.org/licenses/LICENSE-2.0

  Unless required by applicable law or agreed to in writing, software
  distributed under the License is distributed on an "AS IS" BASIS,
  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  See the License for the specific language governing permissions and
  limitations under the License.

-->
<s:Application xmlns:fx="http://ns.adobe.com/mxml/2009" 
               xmlns:s="library://ns.adobe.com/flex/spark">
    <fx:Style>
        <!-- Styling Callout with backgroundColor and 
        contentBackgroundAppearance style as flat which gives no shadow -->
        @namespace s "library://ns.adobe.com/flex/spark";
        s|Callout{
            backgroundColor:"red"; 
            contentBackgroundAppearance:"flat";
        }
    </fx:Style>
    <fx:Declarations>
        <!-- Declaring a Callout which closes when it loses focus. 
        Setting a custom skin to skinClass -->
        <s:Callout id="callout"
          width="200" height="200"
          focusOut="callout.close()"
          skinClass="skins.CalloutCustomSkin"/>
    </fx:Declarations>
    <s:HGroup>
        <!-- Focusing in the textInput opens a callout -->
       <s:TextInput id="myTextInput" focusIn="callout.open(myTextInput)" />
    </s:HGroup>
</s:Application>