Apache Flex 4.16.0 API Reference | All Packages | All Classes | Index | Frames No Frames |
Panel

Package | mx.containers
Class | public class Panel
Inheritance | Panel Container UIComponent FlexSprite flash.display.Sprite
Implements | IConstraintLayout, IFontContextComponent
Subclasses | Alert, RichTextEditor, TitleWindow

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

| Starting with Flex 4.0, Apache recommends that you use the spark.components.Panel class as an alternative to this class.

A Halo Panel container consists of a title bar, a caption, a border, and a content area for its children. Typically, you use Panel containers to wrap top-level application modules. For example, you could include a shopping cart in a Panel container.

Note: Adobe recommends that, when possible, you use the Spark Panel container instead of the Halo Panel container.

The Panel container has the following default sizing characteristics:

Characteristic | Description
--- | ---
Default size | Height is large enough to hold all of its children at the default height of the children, plus any vertical gaps between the children, the top and bottom padding, the top and bottom borders, and the title bar. Width is the larger of the default width of the widest child plus the left and right padding of the container, or the width of the title text, plus the border.
Padding | 4 pixels for the top, bottom, left, and right values.

MXML Syntax Show MXML Syntax
Hide MXML Syntax

The `<mx:Panel>` tag inherits all of the tag attributes of its superclass and adds the following tag attributes:

      <mx:Panel
       Properties
       layout="vertical|horizontal|absolute"
       status=""
       title=""
       titleIcon="null"

       Styles
       borderAlpha="0.4"
       borderThicknessBottom="NaN"
       borderThicknessLeft="10"
       borderThicknessRight="10"
       borderThicknessTop="2"
       controlBarStyleName="null"
       cornerRadius="4"
       dropShadowEnabled="true|false"
       footerColors="null"
       headerColors="null"
       headerHeight="Based on style of title"
       highlightAlphas="[0.3,0]"
       horizontalAlign="left|center|right"
       horizontalGap="8"
       modalTransparency="0.5"
       modalTransparencyBlur="3"
       modalTransparencyColor="#DDDDDD"
       modalTransparencyDuration="100"
       paddingBottom="0"
       paddingTop="0"
       roundedBottomCorners="false|true"
       shadowDirection="center|left|right"
       shadowDistance="2"
       statusStyleName="windowStatus"
       titleBackgroundSkin="TitleBackground"
       titleStyleName="windowStyles"
       verticalAlign="top|middle|bottom"
       verticalGap="6"

       Effects
       resizeEndEffect="Dissolve"
       resizeStartEffect="Dissolve"
       >
          ...
          child tags
          ...
      </mx:Panel>

View the examples

See also

spark.components.Panel
mx.containers.ControlBar
mx.containers.VBox

Public Properties
Hide Inherited Public Properties
Show Inherited Public Properties

| Property | Defined By
--- | --- | ---
|  | accessibilityDescription : String A convenience accessor for the description property in this UIComponent's accessibilityProperties object. | UIComponent
|  | accessibilityEnabled : Boolean A convenience accessor for the silent property in this UIComponent's accessibilityProperties object. | UIComponent
|  | accessibilityName : String A convenience accessor for the name property in this UIComponent's accessibilityProperties object. | UIComponent
|  | accessibilityShortcut : String A convenience accessor for the shortcut property in this UIComponent's accessibilityProperties object. | UIComponent
|  | activeEffects : Array [read-only] The list of effects that are currently playing on the component, as an Array of EffectInstance instances. | UIComponent
|  | autoLayout : Boolean If true, measurement and layout are done when the position or size of a child is changed. | Container
|  | automationDelegate : Object The delegate object that handles the automation-related functionality. | UIComponent
|  | automationEnabled : Boolean [read-only] True if this component is enabled for automation, false otherwise. | UIComponent
|  | automationName : String Name that can be used as an identifier for this object. | UIComponent
|  | automationOwner : DisplayObjectContainer [read-only] The owner of this component for automation purposes. | UIComponent
|  | automationParent : DisplayObjectContainer [read-only] The parent of this component for automation purposes. | UIComponent
|  | automationTabularData : Object [read-only] An implementation of the IAutomationTabularData interface, which can be used to retrieve the data. | UIComponent
|  | automationValue : Array [read-only] This value generally corresponds to the rendered appearance of the object and should be usable for correlating the identifier with the object as it appears visually within the application. | UIComponent
|  | automationVisible : Boolean [read-only] True if this component is visible for automation, false otherwise. | UIComponent
|  | baseline : Object For components, this layout constraint property is a facade on top of the similarly-named style. | UIComponent
|  | baselinePosition : Number [read-only] The y-coordinate of the baseline of the first line of text of the component. | UIComponent
|  | borderMetrics : EdgeMetrics [read-only] Returns an EdgeMetrics object that has four properties: left, top, right, and bottom. | Container
|  | bottom : Object For components, this layout constraint property is a facade on top of the similarly-named style. | UIComponent
|  | cacheHeuristic : Boolean [write-only] Used by Flex to suggest bitmap caching for the object. | UIComponent
|  | cachePolicy : String Specifies the bitmap caching policy for this object. | UIComponent
|  | childDescriptors : Array [read-only] Array of UIComponentDescriptor objects produced by the MXML compiler. | Container
|  | className : String [read-only] The name of this instance's class, such as "Button". | UIComponent
|  | clipContent : Boolean Whether to apply a clip mask if the positions and/or sizes of this container's children extend outside the borders of this container. | Container
|  | constraintColumns : Array An Array of ConstraintColumn instances that partition this container. | Panel
|  | constraintRows : Array An Array of ConstraintRow instances that partition this container. | Panel
|  | contentMouseX : Number [override] [read-only] Returns the x position of the mouse, in the content coordinate system. | Container
|  | contentMouseY : Number [override] [read-only] Returns the y position of the mouse, in the content coordinate system. | Container
|  | creatingContentPane : Boolean Containers use an internal content pane to control scrolling. | Container
|  | creationIndex : int Deprecated: Deprecated Specifies the order to instantiate and draw the children of the container. | Container
|  | creationPolicy : String The child creation policy for this MX Container. | Container
|  | currentState : String The current view state of the component. | UIComponent
|  | cursorManager : ICursorManager [read-only] Gets the CursorManager that controls the cursor for this component and its peers. | UIComponent
|  | data : Object The data property lets you pass a value to the component when you use it in an item renderer or item editor. | Container
|  | defaultButton : IFlexDisplayObject The Button control designated as the default button for the container. | Container
|  | deferredContentCreated : Boolean [read-only] IDeferredContentOwner equivalent of processedDescriptors | Container
|  | depth : Number Determines the order in which items inside of containers are rendered. | UIComponent
|  | descriptor : UIComponentDescriptor Reference to the UIComponentDescriptor, if any, that was used by the createComponentFromDescriptor() method to create this UIComponent instance. | UIComponent
|  | designLayer : DesignLayer Specifies the optional DesignLayer instance associated with this visual element. | UIComponent
|  | document : Object A reference to the document object associated with this UIComponent. | UIComponent
|  | doubleClickEnabled : Boolean [override] Specifies whether the UIComponent object receives doubleClick events. | UIComponent
|  | enabled : Boolean Whether the component can accept user interaction. | UIComponent
|  | errorString : String The text that displayed by a component's error tip when a component is monitored by a Validator and validation fails. | UIComponent
|  | explicitHeight : Number Number that specifies the explicit height of the component, in pixels, in the component's coordinates. | UIComponent
|  | explicitMaxHeight : Number The maximum recommended height of the component to be considered by the parent during layout. | UIComponent
|  | explicitMaxWidth : Number The maximum recommended width of the component to be considered by the parent during layout. | UIComponent
|  | explicitMinHeight : Number The minimum recommended height of the component to be considered by the parent during layout. | UIComponent
|  | explicitMinWidth : Number The minimum recommended width of the component to be considered by the parent during layout. | UIComponent
|  | explicitWidth : Number Number that specifies the explicit width of the component, in pixels, in the component's coordinates. | UIComponent
|  | flexContextMenu : IFlexContextMenu The context menu for this UIComponent. | UIComponent
|  | focusEnabled : Boolean Indicates whether the component can receive focus when tabbed to. | UIComponent
|  | focusManager : IFocusManager Gets the FocusManager that controls focus for this component and its peers. | UIComponent
|  | focusPane : Sprite The focus pane associated with this object. | UIComponent
|  | fontContext : IFlexModuleFactory The module factory that provides the font context for this component. | Panel
|  | hasFocusableChildren : Boolean A flag that indicates whether child objects can receive focus. | UIComponent
|  | hasLayoutMatrix3D : Boolean [read-only] Contains true if the element has 3D Matrix. | UIComponent
|  | height : Number [override] Number that specifies the height of the component, in pixels, in the parent's coordinates. | UIComponent
|  | horizontalCenter : Object For components, this layout constraint property is a facade on top of the similarly-named style. | UIComponent
|  | horizontalLineScrollSize : Number Number of pixels to move when the left- or right-arrow button in the horizontal scroll bar is pressed. | Container
|  | horizontalPageScrollSize : Number Number of pixels to move when the track in the horizontal scroll bar is pressed. | Container
|  | horizontalScrollBar : ScrollBar The horizontal scrollbar used in this container. | Container
|  | horizontalScrollPolicy : String Specifies whether the horizontal scroll bar is always present, always absent, or automatically added when needed. | Container
|  | horizontalScrollPosition : Number The current position of the horizontal scroll bar. | Container
|  | icon : Class The Class of the icon displayed by some navigator containers to represent this Container. | Container
|  | id : String ID of the component. | UIComponent
|  | includeInLayout : Boolean Specifies whether this component is included in the layout of the parent container. | UIComponent
|  | inheritingStyles : Object The beginning of this component's chain of inheriting styles. | UIComponent
|  | initialized : Boolean A flag that determines if an object has been through all three phases of layout: commitment, measurement, and layout (provided that any were required). | UIComponent
|  | instanceIndex : int [read-only] The index of a repeated component. | UIComponent
|  | instanceIndices : Array An Array containing the indices required to reference this UIComponent object from its parent document. | UIComponent
|  | is3D : Boolean [read-only] Contains true when the element is in 3D. | UIComponent
|  | isDocument : Boolean [read-only] Contains true if this UIComponent instance is a document object. | UIComponent
|  | isPopUp : Boolean Set to true by the PopUpManager to indicate that component has been popped up. | UIComponent
|  | label : String The text displayed by some navigator containers to represent this Container. | Container
|  | layout : String Specifies the layout mechanism used for this container. | Panel
|  | layoutMatrix3D : Matrix3D [write-only] The transform matrix that is used to calculate a component's layout relative to its siblings. | UIComponent
|  | left : Object For components, this layout constraint property is a facade on top of the similarly-named style. | UIComponent
|  | maintainProjectionCenter : Boolean When true, the component keeps its projection matrix centered on the middle of its bounding box. | UIComponent
|  | maxHeight : Number The maximum recommended height of the component to be considered by the parent during layout. | UIComponent
|  | maxHorizontalScrollPosition : Number [read-only] The largest possible value for the horizontalScrollPosition property. | Container
|  | maxVerticalScrollPosition : Number [read-only] The largest possible value for the verticalScrollPosition property. | Container
|  | maxWidth : Number The maximum recommended width of the component to be considered by the parent during layout. | UIComponent
|  | measuredHeight : Number The default height of the component, in pixels. | UIComponent
|  | measuredMinHeight : Number The default minimum height of the component, in pixels. | UIComponent
|  | measuredMinWidth : Number The default minimum width of the component, in pixels. | UIComponent
|  | measuredWidth : Number The default width of the component, in pixels. | UIComponent
|  | minHeight : Number The minimum recommended height of the component to be considered by the parent during layout. | UIComponent
|  | minWidth : Number The minimum recommended width of the component to be considered by the parent during layout. | UIComponent
|  | moduleFactory : IFlexModuleFactory 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
|  | mouseFocusEnabled : Boolean Whether you can receive focus when clicked on. | UIComponent
|  | MXMLDescriptor : Array [read-only] | UIComponent
|  | MXMLProperties : Array [read-only] | UIComponent
|  | nestLevel : int Depth of this object in the containment hierarchy. | UIComponent
|  | nonInheritingStyles : Object The beginning of this component's chain of non-inheriting styles. | UIComponent
|  | numAutomationChildren : int [read-only] The number of automation children this container has. | UIComponent
|  | numChildren : int [override] [read-only] Number of child components in this container. | Container
|  | numElements : int [read-only] The number of visual elements in this container. | Container
|  | owner : DisplayObjectContainer The owner of this IVisualElement object. | UIComponent
|  | parent : DisplayObjectContainer [override] [read-only] The parent container or component for this component. | UIComponent
|  | parentApplication : Object [read-only] A reference to the Application object that contains this UIComponent instance. | UIComponent
|  | parentDocument : Object [read-only] A reference to the parent document object for this UIComponent. | UIComponent
|  | percentHeight : Number Specifies the height of a component as a percentage of its parent's size. | UIComponent
|  | percentWidth : Number Specifies the width of a component as a percentage of its parent's size. | UIComponent
|  | postLayoutTransformOffsets : 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
|  | processedDescriptors : Boolean Set to true after immediate or deferred child creation, depending on which one happens. | UIComponent
|  | rawChildren : IChildList [read-only] A container typically contains child components, which can be enumerated using the Container.getChildAt() method and Container.numChildren property. | Container
|  | repeater : IRepeater [read-only] A reference to the Repeater object in the parent document that produced this UIComponent. | UIComponent
|  | repeaterIndex : int [read-only] The index of the item in the data provider of the Repeater that produced this UIComponent. | UIComponent
|  | repeaterIndices : Array An Array containing the indices of the items in the data provider of the Repeaters in the parent document that produced this UIComponent. | UIComponent
|  | repeaters : Array An Array containing references to the Repeater objects in the parent document that produced this UIComponent. | UIComponent
|  | right : Object For components, this layout constraint property is a facade on top of the similarly-named style. | UIComponent
|  | rotation : Number [override] | UIComponent
|  | rotationX : Number [override] Indicates the x-axis rotation of the DisplayObject instance, in degrees, from its original orientation relative to the 3D parent container. | UIComponent
|  | rotationY : Number [override] Indicates the y-axis rotation of the DisplayObject instance, in degrees, from its original orientation relative to the 3D parent container. | UIComponent
|  | rotationZ : Number [override] | UIComponent
|  | scaleX : Number [override] Number that specifies the horizontal scaling factor. | UIComponent
|  | scaleY : Number [override] Number that specifies the vertical scaling factor. | UIComponent
|  | scaleZ : Number [override] Number that specifies the scaling factor along the z axis. | UIComponent
|  | screen : Rectangle [read-only] Returns an object that contains the size and position of the base drawing surface for this object. | UIComponent
|  | showInAutomationHierarchy : Boolean A flag that determines if an automation object shows in the automation hierarchy. | UIComponent
|  | states : Array The view states that are defined for this component. | UIComponent
|  | status : String Text in the status area of the title bar. | Panel
|  | styleDeclaration : CSSStyleDeclaration Storage for the inline inheriting styles on this object. | UIComponent
|  | styleManager : IStyleManager2 [read-only] Returns the StyleManager instance used by this component. | UIComponent
|  | styleName : Object The class style used by this component. | UIComponent
|  | styleParent : IAdvancedStyleClient A component's parent is used to evaluate descendant selectors. | UIComponent
|  | systemManager : ISystemManager Returns the SystemManager object used by this component. | UIComponent
|  | tabFocusEnabled : 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
|  | title : String Title or caption displayed in the title bar. | Panel
|  | titleIcon : Class The icon displayed in the title bar. | Panel
|  | toolTip : String Text to display in the ToolTip. | UIComponent
|  | top : Object For components, this layout constraint property is a facade on top of the similarly-named style. | UIComponent
|  | transform : Transform [override] An object with properties pertaining to a display object's matrix, color transform, and pixel bounds. | UIComponent
|  | transformX : Number Sets the x coordinate for the transform center of the component. | UIComponent
|  | transformY : Number Sets the y coordinate for the transform center of the component. | UIComponent
|  | transformZ : Number Sets the z coordinate for the transform center of the component. | UIComponent
|  | transitions : Array An Array of Transition objects, where each Transition object defines a set of effects to play when a view state change occurs. | UIComponent
|  | tweeningProperties : Array Array of properties that are currently being tweened on this object. | UIComponent
|  | uid : String A unique identifier for the object. | UIComponent
|  | updateCompletePendingFlag : Boolean A flag that determines if an object has been through all three phases of layout validation (provided that any were required). | UIComponent
|  | validationSubField : String Used by a validator to associate a subfield with this component. | UIComponent
|  | verticalCenter : Object For components, this layout constraint property is a facade on top of the similarly-named style. | UIComponent
|  | verticalLineScrollSize : Number Number of pixels to scroll when the up- or down-arrow button in the vertical scroll bar is pressed, or when you scroll by using the mouse wheel. | Container
|  | verticalPageScrollSize : Number Number of pixels to scroll when the track in the vertical scroll bar is pressed. | Container
|  | verticalScrollBar : ScrollBar The vertical scrollbar used in this container. | Container
|  | verticalScrollPolicy : String Specifies whether the vertical scroll bar is always present, always absent, or automatically added when needed. | Container
|  | verticalScrollPosition : Number The current position of the vertical scroll bar. | Container
|  | viewMetrics : EdgeMetrics [read-only] Returns an object that has four properties: left, top, right, and bottom. | Container
|  | viewMetricsAndPadding : EdgeMetrics [read-only] Returns an object that has four properties: left, top, right, and bottom. | Container
|  | visible : Boolean [override] Whether or not the display object is visible. | UIComponent
|  | width : Number [override] Number that specifies the width of the component, in pixels, in the parent's coordinates. | UIComponent
|  | x : Number [override] Number that specifies the component's horizontal position, in pixels, within its parent container. | UIComponent
|  | y : Number [override] Number that specifies the component's vertical position, in pixels, within its parent container. | UIComponent
|  | z : Number [override] | UIComponent

Protected Properties
Hide Inherited Protected Properties
Show Inherited Protected Properties

| Property | Defined By
--- | --- | ---
|  | actualCreationPolicy : String The creation policy of this container. | Container
|  | closeButtonStyleFilters : Object [read-only] The set of styles to pass from the Panel to the close button. | Panel
|  | controlBar : IUIComponent A reference to this Panel container's control bar, if any. | Panel
|  | currentCSSState : String [read-only] The state to be used when matching CSS pseudo-selectors. | UIComponent
|  | hasComplexLayoutMatrix : Boolean [read-only] Returns true if the UIComponent has any non-translation (x,y) transform properties. | UIComponent
|  | resourceManager : IResourceManager [read-only] A reference to the object which manages all of the application's localized resources. | UIComponent
|  | statusTextField : IUITextField The UITextField sub-control that displays the status. | Panel
|  | titleBar : UIComponent The TitleBar sub-control that displays the Panel container's title bar. | Panel
|  | titleTextField : IUITextField The UITextField sub-control that displays the title. | Panel
|  | unscaledHeight : Number [read-only] A convenience method for determining the unscaled height of the component. | UIComponent
|  | unscaledWidth : Number [read-only] A convenience method for determining the unscaled width of the component All of a component's drawing and child layout should be done within a bounding rectangle of this width, which is also passed as an argument to updateDisplayList(). | UIComponent

Public Methods
Hide Inherited Public Methods
Show Inherited Public Methods

| Method | Defined By
--- | --- | ---
|  | Panel() Constructor. | Panel
|  | addChild(child:DisplayObject):DisplayObject [override] Adds a child DisplayObject to this Container. | Container
|  | addChildAt(child:DisplayObject, index:int):DisplayObject [override] Adds a child DisplayObject to this Container. | Container
|  | addElement(element:IVisualElement):IVisualElement Adds a visual element to this container. | Container
|  | addElementAt(element:IVisualElement, index:int):IVisualElement Adds a visual element to this container. | Container
|  | addStyleClient(styleClient:IAdvancedStyleClient):void Adds a non-visual style client to this component instance. | UIComponent
|  | callLater(method:Function, args:Array = null):void Queues a function to be called later. | UIComponent
|  | clearStyle(styleProp:String):void Deletes a style property from this component instance. | UIComponent
|  | contentToGlobal(point:Point):Point [override] Converts a Point object from content coordinates to global coordinates. | Container
|  | contentToLocal(point:Point):Point [override] Converts a Point object from content to local coordinates. | Container
|  | createAutomationIDPart(child:IAutomationObject):Object Returns a set of properties that identify the child within this container. | UIComponent
|  | createAutomationIDPartWithRequiredProperties(child:IAutomationObject, properties:Array):Object Returns a set of properties as automation IDs that identify the child within this container. | UIComponent
|  | createComponentFromDescriptor(descriptor:ComponentDescriptor, recurse:Boolean):IFlexDisplayObject Given a single UIComponentDescriptor, create the corresponding component and add the component as a child of this Container. | Container
|  | createComponentsFromDescriptors(recurse:Boolean = true):void Iterate through the Array of childDescriptors, and call the createComponentFromDescriptor() method for each one. | Container
|  | createDeferredContent():void Performs the equivalent action of calling the createComponentsFromDescriptors(true) method for containers that implement the IDeferredContentOwner interface to support deferred instantiation. | Container
|  | createReferenceOnParentDocument(parentDocument:IFlexDisplayObject):void Creates an id reference to this IUIComponent object on its parent document object. | UIComponent
|  | deleteReferenceOnParentDocument(parentDocument:IFlexDisplayObject):void Deletes the id reference to this IUIComponent object on its parent document object. | UIComponent
|  | determineTextFormatFromStyles():UITextFormat Returns a UITextFormat object corresponding to the text styles for this UIComponent. | UIComponent
|  | dispatchEvent(event:Event):Boolean [override] Dispatches an event into the event flow. | UIComponent
|  | drawFocus(isFocused:Boolean):void Shows or hides the focus indicator around this component. | UIComponent
|  | drawRoundRect(x:Number, y:Number, w:Number, h:Number, r:Object = null, c:Object = null, alpha:Object = null, rot:Object = null, gradient:String = null, ratios:Array = null, hole:Object = null):void Programmatically draws a rectangle into this skin's Graphics object. | UIComponent
|  | effectFinished(effectInst:IEffectInstance):void Called by the effect instance when it stops playing on the component. | UIComponent
|  | effectStarted(effectInst:IEffectInstance):void Called by the effect instance when it starts playing on the component. | UIComponent
|  | endEffectsStarted():void Ends all currently playing effects on the component. | UIComponent
|  | executeBindings(recurse:Boolean = false):void [override] Executes all the data bindings on this Container. | Container
|  | executeChildBindings(recurse:Boolean):void Executes the bindings into this Container's child UIComponent objects. | Container
|  | finishPrint(obj:Object, target:IFlexDisplayObject):void Called after printing is complete. | UIComponent
|  | generateMXMLArray(document:Object, data:Array, recursive:Boolean = true):Array | UIComponent
|  | generateMXMLVector(document:Object, data:Array, recursive:Boolean = true):* | UIComponent
|  | getAutomationChildAt(index:int):IAutomationObject Provides the automation object at the specified index. | UIComponent
|  | getAutomationChildren():Array Provides the automation object list . | UIComponent
|  | getBoundsXAtSize(width:Number, height:Number, postLayoutTransform:Boolean = true):Number Returns the x coordinate of the element's bounds at the specified element size. | UIComponent
|  | getBoundsYAtSize(width:Number, height:Number, postLayoutTransform:Boolean = true):Number Returns the y coordinate of the element's bounds at the specified element size. | UIComponent
|  | getChildAt(index:int):DisplayObject [override] Gets the nth child component object. | Container
|  | getChildByName(name:String):DisplayObject [override] Returns the child whose name property is the specified String. | Container
|  | getChildIndex(child:DisplayObject):int [override] Gets the zero-based index of a specific child. | Container
|  | getChildren():Array Returns an Array of DisplayObject objects consisting of the content children of the container. | Container
|  | getClassStyleDeclarations():Array Finds the type selectors for this UIComponent instance. | UIComponent
|  | getConstraintValue(constraintName:String):* Returns a layout constraint value, which is the same as getting the constraint style for this component. | UIComponent
|  | getElementAt(index:int):IVisualElement Returns the visual element at the specified index. | Container
|  | getElementIndex(element:IVisualElement):int Returns the index position of a visual element. | Container
|  | getExplicitOrMeasuredHeight():Number A convenience method for determining whether to use the explicit or measured height | UIComponent
|  | getExplicitOrMeasuredWidth():Number A convenience method for determining whether to use the explicit or measured width | UIComponent
|  | getFocus():InteractiveObject Gets the object that currently has focus. | UIComponent
|  | getLayoutBoundsHeight(postLayoutTransform:Boolean = true):Number Returns the element's layout height. | UIComponent
|  | getLayoutBoundsWidth(postLayoutTransform:Boolean = true):Number Returns the element's layout width. | UIComponent
|  | getLayoutBoundsX(postLayoutTransform:Boolean = true):Number Returns the x coordinate that the element uses to draw on screen. | UIComponent
|  | getLayoutBoundsY(postLayoutTransform:Boolean = true):Number Returns the y coordinate that the element uses to draw on screen. | UIComponent
|  | getLayoutMatrix():Matrix Returns the transform matrix that is used to calculate the component's layout relative to its siblings. | UIComponent
|  | getLayoutMatrix3D():Matrix3D Returns the layout transform Matrix3D for this element. | UIComponent
|  | getMaxBoundsHeight(postLayoutTransform:Boolean = true):Number Returns the element's maximum height. | UIComponent
|  | getMaxBoundsWidth(postLayoutTransform:Boolean = true):Number Returns the element's maximum width. | UIComponent
|  | getMinBoundsHeight(postLayoutTransform:Boolean = true):Number Returns the element's minimum height. | UIComponent
|  | getMinBoundsWidth(postLayoutTransform:Boolean = true):Number Returns the element's minimum width. | UIComponent
|  | getPreferredBoundsHeight(postLayoutTransform:Boolean = true):Number Returns the element's preferred height. | UIComponent
|  | getPreferredBoundsWidth(postLayoutTransform:Boolean = true):Number Returns the element's preferred width. | UIComponent
|  | getRepeaterItem(whichRepeater:int = -1):Object Returns the item in the dataProvider that was used by the specified Repeater to produce this Repeater, or null if this Repeater isn't repeated. | UIComponent
|  | getStyle(styleProp:String):* Gets a style property that has been set anywhere in this component's style lookup chain. | UIComponent
|  | getVisibleRect(targetParent:DisplayObject = null):Rectangle Get the bounds of this object that are visible to the user on the screen. | UIComponent
|  | globalToContent(point:Point):Point [override] Converts a Point object from global to content coordinates. | Container
|  | hasCSSState():Boolean Returns true if currentCSSState is not null. | UIComponent
|  | hasState(stateName:String):Boolean Determines whether the specified state has been defined on this UIComponent. | UIComponent
|  | horizontalGradientMatrix(x:Number, y:Number, width:Number, height:Number):Matrix Returns a box Matrix which can be passed to the drawRoundRect() method as the rot parameter when drawing a horizontal gradient. | UIComponent
|  | initialize():void Initializes the internal structure of this component. | UIComponent
|  | initializeRepeaterArrays(parent:IRepeaterClient):void Initializes various properties which keep track of repeated instances of this component. | UIComponent
|  | invalidateDisplayList():void Marks a component so that its updateDisplayList() method gets called during a later screen update. | UIComponent
|  | invalidateLayering():void Called by a component's items to indicate that their depth property has changed. | UIComponent
|  | invalidateLayoutDirection():void An element must call this method when its layoutDirection changes or when its parent's layoutDirection changes. | UIComponent
|  | invalidateProperties():void Marks a component so that its commitProperties() method gets called during a later screen update. | UIComponent
|  | invalidateSize():void Marks a component so that its measure() method gets called during a later screen update. | UIComponent
|  | localToContent(point:Point):Point [override] Converts a Point object from local to content coordinates. | Container
|  | matchesCSSState(cssState:String):Boolean Returns true if cssState matches currentCSSState. | UIComponent
|  | matchesCSSType(cssType:String):Boolean Determines whether this instance is the same as, or is a subclass of, the given type. | UIComponent
|  | 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
|  | 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
|  | move(x:Number, y:Number):void Moves the component to a specified position within its parent. | UIComponent
|  | notifyStyleChangeInChildren(styleProp:String, recursive:Boolean):void Propagates style changes to the children. | UIComponent
|  | owns(child:DisplayObject):Boolean Returns true if the chain of owner properties points from child to this UIComponent. | UIComponent
|  | parentChanged(p:DisplayObjectContainer):void Called by Flex when a UIComponent object is added to or removed from a parent. | UIComponent
|  | prepareToPrint(target:IFlexDisplayObject):Object Prepares an IFlexDisplayObject for printing. | UIComponent
|  | regenerateStyleCache(recursive:Boolean):void Builds or rebuilds the CSS style cache for this component and, if the recursive parameter is true, for all descendants of this component as well. | UIComponent
|  | registerEffects(effects:Array):void For each effect event, registers the EffectManager as one of the event listeners. | UIComponent
|  | removeAllChildren():void Removes all children from the child list of this container. | Container
|  | removeAllElements():void Removes all visual elements from the container. | Container
|  | removeChild(child:DisplayObject):DisplayObject [override] Removes a child DisplayObject from the child list of this Container. | Container
|  | removeChildAt(index:int):DisplayObject [override] Removes a child DisplayObject from the child list of this Container at the specified index. | Container
|  | removeElement(element:IVisualElement):IVisualElement Removes the specified visual element from the child list of this container. | Container
|  | removeElementAt(index:int):IVisualElement Removes a visual element from the specified index position in the container. | Container
|  | removeStyleClient(styleClient:IAdvancedStyleClient):void Removes a non-visual style client from this component instance. | UIComponent
|  | replayAutomatableEvent(event:Event):Boolean Replays the specified event. | UIComponent
|  | resolveAutomationIDPart(criteria:Object):Array Resolves a child by using the id provided. | UIComponent
|  | resumeBackgroundProcessing():void [static] Resumes the background processing of methods queued by callLater(), after a call to suspendBackgroundProcessing(). | UIComponent
|  | setActualSize(w:Number, h:Number):void Sizes the object. | UIComponent
|  | setChildIndex(child:DisplayObject, newIndex:int):void [override] Sets the index of a particular child. | Container
|  | setConstraintValue(constraintName:String, value:*):void Sets a layout constraint value, which is the same as setting the constraint style for this component. | UIComponent
|  | setCurrentState(stateName:String, playTransition:Boolean = true):void Set the current state. | UIComponent
|  | setElementIndex(element:IVisualElement, index:int):void Changes the position of an existing visual element in the visual container. | Container
|  | setFocus():void Sets the focus to this component. | UIComponent
|  | setLayoutBoundsPosition(x:Number, y:Number, postLayoutTransform:Boolean = true):void Sets the coordinates that the element uses to draw on screen. | UIComponent
|  | setLayoutBoundsSize(width:Number, height:Number, postLayoutTransform:Boolean = true):void Sets the layout size of the element. | UIComponent
|  | 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
|  | 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
|  | setMXMLDescriptor(value:Array):void | UIComponent
|  | setMXMLProperties(value:Array):void | UIComponent
|  | setStyle(styleProp:String, newValue:*):void Sets a style property on this component instance. | UIComponent
|  | setVisible(value:Boolean, noEvent:Boolean = false):void Called when the visible property changes. | UIComponent
|  | styleChanged(styleProp:String):void Detects changes to style properties. | UIComponent
|  | stylesInitialized():void Flex calls the stylesInitialized() method when the styles for a component are first initialized. | UIComponent
|  | suspendBackgroundProcessing():void [static] Blocks the background processing of methods queued by callLater(), until resumeBackgroundProcessing() is called. | UIComponent
|  | swapElements(element1:IVisualElement, element2:IVisualElement):void Swaps the index of the two specified visual elements. | Container
|  | swapElementsAt(index1:int, index2:int):void Swaps the visual elements at the two specified index positions in the container. | Container
|  | toString():String [override] Returns a string indicating the location of this object within the hierarchy of DisplayObjects in the Application. | FlexSprite
|  | 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
|  | 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
|  | validateDisplayList():void Validates the position and size of children and draws other visuals. | UIComponent
|  | validateNow():void Validate and update the properties and layout of this object and redraw it, if necessary. | UIComponent
|  | validateProperties():void Used by layout logic to validate the properties of a component by calling the commitProperties() method. | UIComponent
|  | validateSize(recursive:Boolean = false):void Validates the measured size of the component If the LayoutManager.invalidateSize() method is called with this ILayoutManagerClient, then the validateSize() method is called when it's time to do measurements. | UIComponent
|  | validationResultHandler(event:ValidationResultEvent):void Handles both the valid and invalid events from a validator assigned to this component. | UIComponent
|  | verticalGradientMatrix(x:Number, y:Number, width:Number, height:Number):Matrix Returns a box Matrix which can be passed to drawRoundRect() as the rot parameter when drawing a vertical gradient. | UIComponent

Protected Methods
Show Inherited Protected Methods
Show Inherited Protected Methods

| Method | Defined By
--- | --- | ---
|  | addMXMLChildren(comps:Array):void | UIComponent
|  | adjustFocusRect(obj:DisplayObject = null):void Adjust the focus rectangle. | UIComponent
|  | 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
|  | attachOverlay():void [override] Used internally by the Dissolve Effect to add the overlay to the chrome of a container. | Container
|  | canSkipMeasurement():Boolean Determines if the call to the measure() method can be skipped. | UIComponent
|  | childrenCreated():void Performs any final processing after child objects are created. | UIComponent
|  | commitProperties():void Processes the properties set on the component. | UIComponent
|  | createBorder():void Creates the container's border skin if it is needed and does not already exist. | Container
|  | createChildren():void Create child objects of the component. | UIComponent
|  | createInFontContext(classObj:Class):Object Creates a new object using a context based on the embedded font being used. | UIComponent
|  | createInModuleContext(moduleFactory:IFlexModuleFactory, className:String):Object Creates the object using a given moduleFactory. | UIComponent
|  | dispatchPropertyChangeEvent(prop:String, oldValue:*, value:*):void Helper method for dispatching a PropertyChangeEvent when a property is updated. | UIComponent
|  | focusInHandler(event:FocusEvent):void The event handler called when a UIComponent object gets focus. | UIComponent
|  | focusOutHandler(event:FocusEvent):void The event handler called when a UIComponent object loses focus. | UIComponent
|  | generateMXMLAttributes(data:Array):void | UIComponent
|  | generateMXMLInstances(document:Object, data:Array, recursive:Boolean = true):void | UIComponent
|  | generateMXMLObject(document:Object, data:Array):Object | UIComponent
|  | getHeaderHeight():Number Returns the height of the header. | Panel
|  | initAdvancedLayoutFeatures():void Initializes the implementation and storage of some of the less frequently used advanced layout features of a component. | UIComponent
|  | initializationComplete():void Finalizes the initialization of this component. | UIComponent
|  | initializeAccessibility():void Initializes this component's accessibility code. | UIComponent
|  | invalidateParentSizeAndDisplayList():void Helper method to invalidate parent size and display list if this object affects its layout (includeInLayout is true). | UIComponent
|  | isOurFocus(target:DisplayObject):Boolean Typically overridden by components containing UITextField objects, where the UITextField object gets focus. | UIComponent
|  | keyDownHandler(event:KeyboardEvent):void The event handler called for a keyDown event. | UIComponent
|  | keyUpHandler(event:KeyboardEvent):void The event handler called for a keyUp event. | UIComponent
|  | layoutChrome(unscaledWidth:Number, unscaledHeight:Number):void Respond to size changes by setting the positions and sizes of this container's borders. | Container
|  | measure():void [override] Calculates the default mininum and maximum sizes of the Panel container. | Panel
|  | 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
|  | scrollChildren():void Positions the container's content area relative to the viewable area based on the horizontalScrollPosition and verticalScrollPosition properties. | Container
|  | setStretchXY(stretchX:Number, stretchY:Number):void Specifies a transform stretch factor in the horizontal and vertical direction. | UIComponent
|  | startDragging(event:MouseEvent):void Called when the user starts dragging a Panel that has been popped up by the PopUpManager. | Panel
|  | 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
|  | stopDragging():void Called when the user stops dragging a Panel that has been popped up by the PopUpManager. | Panel
|  | updateDisplayList(unscaledWidth:Number, unscaledHeight:Number):void [override] Respond to size changes by setting the positions and sizes of this container's children. | Container

Events
Hide Inherited Events
Show Inherited Events

| Event | Summary | Defined By
--- | --- | --- | ---
|  | add | Dispatched when the component is added to a container as a content child by using the addChild(), addChildAt(), addElement(), or addElementAt() method. | UIComponent
|  | childAdd | Dispatched after a child has been added to a container. | Container
|  | childIndexChange | Dispatched after the index (among the container children) of a container child changes. | Container
|  | childRemove | Dispatched before a child of a container is removed. | Container
|  | creationComplete | Dispatched when the component has finished its construction, property processing, measuring, layout, and drawing. | UIComponent
|  | currentStateChange | Dispatched after the view state has changed. | UIComponent
|  | currentStateChanging | Dispatched after the currentState property changes, but before the view state changes. | UIComponent
|  | dataChange | Dispatched when the data property changes. | Container
|  | 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
|  | dragDrop | Dispatched by the drop target when the user releases the mouse over it. | UIComponent
|  | dragEnter | Dispatched by a component when the user moves the mouse over the component during a drag operation. | UIComponent
|  | dragExit | Dispatched by the component when the user drags outside the component, but does not drop the data onto the target. | UIComponent
|  | dragOver | Dispatched by a component when the user moves the mouse while over the component during a drag operation. | UIComponent
|  | dragStart | Dispatched by the drag initiator when starting a drag operation. | UIComponent
|  | effectEnd | Dispatched after an effect ends. | UIComponent
|  | effectStart | Dispatched just before an effect starts. | UIComponent
|  | effectStop | Dispatched after an effect is stopped, which happens only by a call to stop() on the effect. | UIComponent
|  | enterState | Dispatched after the component has entered a view state. | UIComponent
|  | exitState | Dispatched just before the component exits a view state. | UIComponent
|  | hide | Dispatched when an object's state changes from visible to invisible. | UIComponent
|  | initialize | Dispatched when the component has finished its construction and has all initialization properties set. | UIComponent
|  | invalid | Dispatched when a component is monitored by a Validator and the validation failed. | UIComponent
|  | mouseDownOutside | Dispatched from a component opened using the PopUpManager when the user clicks outside it. | UIComponent
|  | mouseWheelOutside | Dispatched from a component opened using the PopUpManager when the user scrolls the mouse wheel outside it. | UIComponent
|  | move | Dispatched when the object has moved. | UIComponent
|  | preinitialize | Dispatched at the beginning of the component initialization sequence. | UIComponent
|  | remove | Dispatched when the component is removed from a container as a content child by using the removeChild(), removeChildAt(), removeElement(), or removeElementAt() method. | UIComponent
|  | resize | Dispatched when the component is resized. | UIComponent
|  | scroll | Dispatched when the user manually scrolls the container. | Container
|  | show | Dispatched when an object's state changes from invisible to visible. | UIComponent
|  | stateChangeComplete | Dispatched after the component has entered a new state and any state transition animation to that state has finished playing. | UIComponent
|  | stateChangeInterrupted | Dispatched when a component interrupts a transition to its current state in order to switch to a new state. | UIComponent
|  | toolTipCreate | Dispatched by the component when it is time to create a ToolTip. | UIComponent
|  | toolTipEnd | Dispatched by the component when its ToolTip has been hidden and is to be discarded soon. | UIComponent
|  | toolTipHide | Dispatched by the component when its ToolTip is about to be hidden. | UIComponent
|  | toolTipShow | Dispatched by the component when its ToolTip is about to be shown. | UIComponent
|  | toolTipShown | Dispatched by the component when its ToolTip has been shown. | UIComponent
|  | toolTipStart | Dispatched by a component whose toolTip property is set, as soon as the user moves the mouse over it. | UIComponent
|  | touchInteractionEnd | A non-cancellable event, dispatched by a component when it is done responding to a touch interaction user gesture. | UIComponent
|  | touchInteractionStart | A non-cancellable event, dispatched by a component when it starts responding to a touch interaction user gesture. | UIComponent
|  | touchInteractionStarting | A cancellable event, dispatched by a component in an attempt to respond to a touch interaction user gesture. | UIComponent
|  | updateComplete | Dispatched when an object has had its commitProperties(), measure(), and updateDisplayList() methods called (if needed). | UIComponent
|  | valid | Dispatched when a component is monitored by a Validator and the validation succeeded. | UIComponent
|  | valueCommit | Dispatched when values are changed programmatically or by user interaction. | UIComponent

Styles
Hide Inherited Styles
Show Inherited Styles

| Style | Description | Defined By
--- | --- | --- | ---
|  | accentColor | Type: uint Format: Color CSS Inheritance: yes Theme: spark Accent color used by component skins. | Container
|  | backgroundAlpha | Type: Number CSS Inheritance: no Theme: halo, spark Alpha level of the color defined by the `backgroundColor` property, of the image or SWF file defined by the `backgroundImage` style. | Container
|  | backgroundAttachment | Type: String CSS Inheritance: no If a background image is specified, this style specifies whether it is fixed with regard to the viewport (`"fixed"`) or scrolls along with the content (`"scroll"`). | Container
|  | backgroundColor | Type: uint Format: Color CSS Inheritance: no Theme: halo, spark Background color of a component. | Container
|  | backgroundDisabledColor | Type: uint Format: Color CSS Inheritance: yes Theme: halo Background color of the component when it is disabled. | Container
|  | backgroundImage | Type: Object Format: File CSS Inheritance: no Theme: halo Background image of a component. | Container
|  | backgroundSize | Type: String CSS Inheritance: no Theme: halo Scales the image specified by `backgroundImage` to different percentage sizes. | Container
|  | barColor | Type: uint Format: Color CSS Inheritance: yes Theme: halo Determines the color of a ProgressBar. | Container
|  | 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
|  | borderAlpha | Type: Number CSS Inheritance: no Theme: halo, spark Alpha of the title bar, control bar and sides of the Panel. The default value for the Halo theme is `0.4`. The default value for the Spark theme is `0.5`. | Panel
|  | borderColor | Type: uint Format: Color CSS Inheritance: no Theme: halo, spark Color of the border. | Container
|  | borderSides | Type: String CSS Inheritance: no Theme: halo Bounding box sides. | Container
|  | borderSkin | Type: Class CSS Inheritance: no The border skin class of the component. | Container
|  | borderStyle | Type: String CSS Inheritance: no Bounding box style. | Container
|  | borderThickness | Type: Number Format: Length CSS Inheritance: no Theme: halo Bounding box thickness. | Container
|  | borderThicknessBottom | Type: Number Format: Length CSS Inheritance: no Theme: halo Thickness of the bottom border of the Panel control. If this style is not set and the Panel control contains a ControlBar control, the bottom border thickness equals the thickness of the top border of the panel; otherwise the bottom border thickness equals the thickness of the left border. The default value is`NaN`. | Panel
|  | borderThicknessLeft | Type: Number Format: Length CSS Inheritance: no Theme: halo Thickness of the left border of the Panel. The default value is`10`. | Panel
|  | borderThicknessRight | Type: Number Format: Length CSS Inheritance: no Theme: halo Thickness of the right border of the Panel. The default value is`10`. | Panel
|  | borderThicknessTop | Type: Number Format: Length CSS Inheritance: no Theme: halo Thickness of the top border of the Panel. The default value is`2`. | Panel
|  | borderVisible | Type: Boolean CSS Inheritance: no Theme: spark Visibility of the border. | Container
|  | bottom | Type: 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
|  | chromeColor | Type: uint Format: Color CSS Inheritance: yes Theme: spark The main color for a component. | UIComponent
|  | color | Type: uint Format: Color CSS Inheritance: yes Color of text in the component, including the component label. | Container
|  | contentBackgroundAlpha | Type: Number CSS Inheritance: yes Theme: spark The alpha of the content background for this component. | Container
|  | contentBackgroundColor | Type: uint Format: Color CSS Inheritance: yes Theme: spark Color of the content area of the component. | Container
|  | controlBarStyleName | Type: String CSS Inheritance: no Name of the CSS style declaration that specifies styles to apply to any control bar child subcontrol. The default value is`null`. | Panel
|  | cornerRadius | Type: Number Format: Length CSS Inheritance: no Theme: halo, spark Radius of corners of the window frame. The default value for the Halo theme is `4`. The default value for the Spark theme is `0`. | Panel
|  | direction | Type: String CSS Inheritance: yes The directionality of the text displayed by the component. | Container
|  | disabledColor | Type: uint Format: Color CSS Inheritance: yes Color of text in the component if it is disabled. | Container
|  | disabledOverlayAlpha | Type: Number CSS Inheritance: no The alpha value for the overlay that is placed on top of the container when it is disabled. | Container
|  | dropShadowColor | Type: uint Format: Color CSS Inheritance: yes Theme: halo Color of the drop shadow. | Container
|  | dropShadowEnabled | Type: Boolean CSS Inheritance: no Theme: halo Boolean property that controls the visibility of the Panel container's drop shadow. The default value is`true`. | Panel
|  | dropShadowVisible | Type: Boolean CSS Inheritance: no Theme: spark Boolean property that specifies whether the component has a visible drop shadow. | Container
|  | errorColor | Type: uint Format: Color CSS Inheritance: yes Color of the component highlight when validation fails. | UIComponent
|  | focusColor | Type: uint Format: Color CSS Inheritance: yes Theme: spark Color of focus ring when the component is in focus. | Container
|  | fontAntiAliasType | Type: String CSS Inheritance: yes Sets the `antiAliasType` property of internal TextFields. See also flash.text.TextField flash.text.AntiAliasType | Container
|  | fontFamily | Type: String CSS Inheritance: yes Name of the font to use. | Container
|  | fontGridFitType | Type: String CSS Inheritance: yes Sets the `gridFitType` property of internal TextFields that represent text in Flex controls. See also flash.text.TextField flash.text.GridFitType | Container
|  | fontSharpness | Type: Number CSS Inheritance: yes Sets the `sharpness` property of internal TextFields that represent text in Flex controls. See also flash.text.TextField | Container
|  | fontSize | Type: Number Format: Length CSS Inheritance: yes Height of the text, in pixels. | Container
|  | fontStyle | Type: String CSS Inheritance: yes Determines whether the text is italic font. | Container
|  | fontThickness | Type: Number CSS Inheritance: yes Sets the `thickness` property of internal TextFields that represent text in Flex controls. See also flash.text.TextField | Container
|  | fontWeight | Type: String CSS Inheritance: yes Determines whether the text is boldface. | Container
|  | footerColors | Type: Array Format: Color CSS Inheritance: yes Theme: halo Array of two colors used to draw the footer (area for the ControlBar container) background. The first color is the top color. The second color is the bottom color. The default values are `null`, which makes the control bar background the same as the panel background. The default value is`null`. | Panel
|  | headerColors | Type: Array Format: Color CSS Inheritance: yes Theme: halo Array of two colors used to draw the header. The first color is the top color. The second color is the bottom color. The default values are `null`, which makes the header background the same as the panel background. The default value is`null`. | Panel
|  | headerHeight | Type: Number Format: Length CSS Inheritance: no Height of the header. The default value is based on the style of the title text. | Panel
|  | highlightAlphas | Type: Array CSS Inheritance: no Theme: halo Alphas used for the highlight fill of the header. The default value is`[0.3,0]`. | Panel
|  | horizontalAlign | Type: String CSS Inheritance: no Horizontal alignment of children in the container. Possible values are `"left"`, `"center"`, and `"right"`. The default value is `"left"`, but some containers, such as ButtonBar and ToggleButtonBar, have different default values. | Panel
|  | 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
|  | horizontalGap | Type: Number Format: Length CSS Inheritance: no Number of pixels between children in the horizontal direction. The default value depends on the component class; if not overridden for the class, the default value is 8. | Panel
|  | horizontalScrollBarStyleName | Type: String CSS Inheritance: no The name of the horizontal scrollbar style. | Container
|  | interactionMode | Type: String CSS Inheritance: yes The primary interaction mode for this component. See also mx.core.InteractionMode.MOUSE mx.core.InteractionMode.TOUCH | UIComponent
|  | kerning | Type: Boolean CSS Inheritance: yes A Boolean value that indicates whether kerning is enabled (`true`) or disabled (`false`). | Container
|  | layoutDirection | Type: String CSS Inheritance: yes Specifies the desired layout direction of a component. See also MXFTEText.css mx.core.ILayoutDirectionElement mx.core.LayoutDirection | UIComponent
|  | left | Type: 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
|  | letterSpacing | Type: Number CSS Inheritance: yes The number of additional pixels to appear between each character. | Container
|  | locale | Type: String CSS Inheritance: yes The locale of the text displayed by this component. | Container
|  | modalTransparency | Type: Number CSS Inheritance: yes Modality of components launched by the PopUp Manager is simulated by creating a large translucent overlay underneath the component. Because of the way translucent objects are rendered, you may notice a slight dimming of the objects under the overlay. The effective transparency can be set by changing the `modalTransparency` value from 0.0 (fully transparent) to 1.0 (fully opaque). You can also set the color of the overlay by changing the `modalTransparencyColor` style. The default value is`0.5`. | Panel
|  | modalTransparencyBlur | Type: Number CSS Inheritance: yes The blur applied to the application while a modal window is open. A Blur effect softens the details of an image. The default value is`3`. See also flash.filters.BlurFilter | Panel
|  | modalTransparencyColor | Type: uint Format: Color CSS Inheritance: yes Color of the modal overlay layer. This style is used in conjunction with the `modalTransparency` style to determine the colorization applied to the application when a modal window is open. The default value is`#DDDDDD`. | Panel
|  | modalTransparencyDuration | Type: Number Format: Time CSS Inheritance: yes Duration, in milliseconds, of the modal transparency effect that plays when a modal window opens or closes. The default value is`100`. | Panel
|  | paddingBottom | Type: Number Format: Length CSS Inheritance: no Number of pixels between the container's lower border and its content area. The default value is`0`. | Panel
|  | paddingLeft | Type: Number Format: Length CSS Inheritance: no Number of pixels between the component's left border and the left edge of its content area. | Container
|  | paddingRight | Type: Number Format: Length CSS Inheritance: no Number of pixels between the component's right border and the right edge of its content area. | Container
|  | paddingTop | Type: Number Format: Length CSS Inheritance: no Number of pixels between the container's top border and its content area. The default value is`0`. | Panel
|  | right | Type: 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
|  | roundedBottomCorners | Type: Boolean CSS Inheritance: no Theme: halo Flag to enable rounding for the bottom two corners of the container. Does not affect the upper two corners, which are normally round. To configure the upper corners to be square, set `cornerRadius` to 0. The default value is`false`. | Panel
|  | shadowDirection | Type: String CSS Inheritance: no Theme: halo Direction of drop shadow. Possible values are `"left"`, `"center"`, and `"right"`. The default value is`"center"`. | Panel
|  | shadowDistance | Type: Number Format: Length CSS Inheritance: no Theme: halo Distance of drop shadow. Negative values move the shadow above the panel. The default value is`2`. | Panel
|  | showErrorSkin | Type: Boolean CSS Inheritance: yes Show the error border or skin when this component is invalid. | UIComponent
|  | showErrorTip | Type: Boolean CSS Inheritance: yes Show the error tip when this component is invalid and the user rolls over it. | UIComponent
|  | statusStyleName | Type: String CSS Inheritance: no Style declaration name for the status in the title bar. The default value is`"windowStatus"`. | Panel
|  | symbolColor | Type: uint Format: Color CSS Inheritance: yes Theme: spark Color of any symbol of a component. | Container
|  | textAlign | Type: String CSS Inheritance: yes Alignment of text within a container. | Container
|  | textDecoration | Type: String CSS Inheritance: yes Determines whether the text is underlined. | Container
|  | textFieldClass | Type: Class CSS Inheritance: no The class implementing IUITextField that is used by this component to render text. | Container
|  | textIndent | Type: Number Format: Length CSS Inheritance: yes Offset of first line of text from the left side of the container, in pixels. | Container
|  | themeColor | Type: uint Format: Color CSS Inheritance: yes Theme: halo Theme color of a component. | UIComponent
|  | titleBackgroundSkin | Type: Class CSS Inheritance: no The title background skin. The default value for the Halo theme is `mx.skins.halo.TitleBackground`. The default value for the Spark theme is `mx.core.UIComponent`. | Panel
|  | titleStyleName | Type: String CSS Inheritance: no Style declaration name for the text in the title bar. The default value is `"windowStyles"`, which causes the title to have boldface text. The default value is`"windowStyles"`. | Panel
|  | top | Type: 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
|  | verticalAlign | Type: String CSS Inheritance: no Vertical alignment of children in the container. Possible values are `"top"`, `"middle"`, and `"bottom"`. The default value is `"top"`, but some containers, such as ButtonBar, ControlBar, LinkBar, and ToggleButtonBar, have different default values. | Panel
|  | 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
|  | verticalGap | Type: Number Format: Length CSS Inheritance: no Number of pixels between children in the vertical direction. The default value depends on the component class; if not overridden for the class, the default value is 6. | Panel
|  | verticalScrollBarStyleName | Type: String CSS Inheritance: no The name of the vertical scrollbar style. | Container

Effects
Hide Inherited Effects
Show Inherited Effects

| Effect | Description | Defined By
--- | --- | --- | ---
|  | addedEffect | Triggering Event: added Played when the component is added as a child to a Container. | UIComponent
|  | creationCompleteEffect | Triggering Event: creationComplete Played when the component is created. | UIComponent
|  | hideEffect | Triggering Event: hide Played when the component becomes invisible. | UIComponent
|  | mouseDownEffect | Triggering Event: mouseDown Played when the user presses the mouse button while over the component. | UIComponent
|  | mouseUpEffect | Triggering Event: mouseUp Played when the user releases the mouse button while over the component. | UIComponent
|  | moveEffect | Triggering Event: move Played when the component is moved. | UIComponent
|  | removedEffect | Triggering Event: removed Played when the component is removed from a Container. | UIComponent
|  | resizeEffect | Triggering Event: resize Played when the component is resized. | UIComponent
|  | resizeEndEffect | Triggering Event: resizeEnd Specifies the effect to play after a Resize effect finishes playing. To disable the default Dissolve effect, so that the children are hidden instantaneously, set the value of the resizeEndEffect property to "none". | Panel
|  | resizeStartEffect | Triggering Event: resizeStart Specifies the effect to play before a Resize effect begins playing. To disable the default Dissolve effect, so that the children are hidden instantaneously, set the value of the resizeStartEffect property to "none". | Panel
|  | rollOutEffect | Triggering Event: rollOut Played when the user rolls the mouse so it is no longer over the component. | UIComponent
|  | rollOverEffect | Triggering Event: rollOver Played when the user rolls the mouse over the component. | UIComponent
|  | showEffect | Triggering Event: show Played when the component becomes visible. | UIComponent

Public Constants
Hide Inherited Public Constants
Show Inherited Public Constants

| Constant | Defined By
--- | --- | ---
|  | DEFAULT_MAX_HEIGHT : Number = 10000 [static] The default value for the maxHeight property. | UIComponent
|  | DEFAULT_MAX_WIDTH : Number = 10000 [static] The default value for the maxWidth property. | UIComponent
|  | DEFAULT_MEASURED_HEIGHT : Number = 22 [static] The default value for the measuredHeight property. | UIComponent
|  | DEFAULT_MEASURED_MIN_HEIGHT : Number = 22 [static] The default value for the measuredMinHeight property. | UIComponent
|  | DEFAULT_MEASURED_MIN_WIDTH : Number = 40 [static] The default value for the measuredMinWidth property. | UIComponent
|  | DEFAULT_MEASURED_WIDTH : Number = 160 [static] The default value for the measuredWidth property. | UIComponent

Property Detail

closeButtonStyleFilters | property

`closeButtonStyleFilters:Object` [read-only]

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

The set of styles to pass from the Panel to the close button.

Implementation
`protected function get closeButtonStyleFilters():Object`

See also

mx.styles.StyleProxy

constraintColumns | property |

`constraintColumns:Array`

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

An Array of ConstraintColumn instances that partition this container. The ConstraintColumn instance at index 0 is the left-most column; indices increase from left to right.

Implementation
`public function get constraintColumns():Array`
`public function set constraintColumns(value:Array):void`

constraintRows | property |

`constraintRows:Array`

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

An Array of ConstraintRow instances that partition this container. The ConstraintRow instance at index 0 is the top-most row; indices increase from top to bottom.

Implementation
`public function get constraintRows():Array`
`public function set constraintRows(value:Array):void`

controlBar | property |

`protected var controlBar:IUIComponent`

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

A reference to this Panel container's control bar, if any.

fontContext | property |

`fontContext:IFlexModuleFactory`

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

The module factory that provides the font context for this component.

Implementation
`public function get fontContext():IFlexModuleFactory`
`public function set fontContext(value:IFlexModuleFactory):void`

layout | property |

`layout:String`

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

Specifies the layout mechanism used for this container. Panel containers can use `"vertical"`, `"horizontal"`, or `"absolute"` positioning. Vertical positioning lays out the child components vertically from the top of the container to the bottom in the specified order. Horizontal positioning lays out the child components horizontally from the left of the container to the right in the specified order. Absolute positioning does no automatic layout and requires you to explicitly define the location of each child component.

The default value is `"vertical"`.

This property can be used as the source for data binding.

Implementation
`public function get layout():String`
`public function set layout(value:String):void`

status | property |

`status:String`

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

Text in the status area of the title bar.

The default value is `""`.

This property can be used as the source for data binding.

Implementation
`public function get status():String`
`public function set status(value:String):void`

statusTextField | property |

`protected var statusTextField:IUITextField`

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

The UITextField sub-control that displays the status. The status field is a child of the `titleBar` sub-control.

See also

titleBar

title | property |

`title:String`

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

Title or caption displayed in the title bar.

The default value is `""`.

This property can be used as the source for data binding.

Implementation
`public function get title():String`
`public function set title(value:String):void`

titleBar | property |

`protected var titleBar:UIComponent`

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

The TitleBar sub-control that displays the Panel container's title bar.

titleIcon | property |

`titleIcon:Class`

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

The icon displayed in the title bar.

The default value is `null`.

This property can be used as the source for data binding.

Implementation
`public function get titleIcon():Class`
`public function set titleIcon(value:Class):void`

titleTextField | property |

`protected var titleTextField:IUITextField`

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

The UITextField sub-control that displays the title. The title field is a child of the `titleBar` sub-control.

See also

titleBar
Constructor Detail

Panel | () | Constructor

`public function Panel()`

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

Constructor.

Method Detail

getHeaderHeight | () | method

`protected function getHeaderHeight():Number`

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

Returns the height of the header.

Returns

| `Number` — The height of the header, in pixels.

measure | () | method |

`override protected function measure():void`

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

Calculates the default mininum and maximum sizes of the Panel container. For more information about the `measure()` method, see the `UIComponent.measure()` method.

The `measure()` method first calls `VBox.measure()` method, and then ensures that the `measuredWidth` and `measuredMinWidth` properties are wide enough to display the title and the ControlBar.

See also

mx.core.UIComponent.measure()

startDragging | () | method |

`protected function startDragging(event:MouseEvent):void`

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

Called when the user starts dragging a Panel that has been popped up by the PopUpManager.

Parameters

| `event:MouseEvent` — The MouseEvent dispatched when the user clicks on the container.

stopDragging | () | method |

`protected function stopDragging():void`

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

Called when the user stops dragging a Panel that has been popped up by the PopUpManager.

Examples
SimplePanelExample.mxml

    <?xml version="1.0"?>
    <!--

      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.

    -->
    <!-- Simple example to demonstrate Halo Panel layout container. -->
    <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/mx">

        <fx:Script>
            <![CDATA[
                private function showProperties():void  {
                    panelPropertyArea.text= "Status: " + panel.status + '\n' +
                      "Title: " + panel.title + '\n' +
                      "Width: " + panel.width + '\n' +
                      "Height: " + panel.height;
                }
            ]]>
        </fx:Script>

        <mx:Panel id="panel" title="Panel Container Example" status="Active"
                width="75%" height="75%"
                paddingLeft="10" paddingRight="10" paddingTop="10" paddingBottom="10"
                horizontalCenter="0" verticalCenter="0">

            <mx:Label width="100%" color="blue"
                text="Click the Button control to see panel properties."/>

            <s:TextArea id="panelPropertyArea" width="100%" height="100%"/>
            <s:Button label="Click to view Panel properties" click="showProperties();"/>

        </mx:Panel>

    </s:Application>

Sun Mar 5 2017, 03:42 PM +11:00