| Package | mx.containers |
| Class | public class Panel |
| Inheritance | Panel  Container UIComponent FlexSprite Sprite DisplayObjectContainer InteractiveObject DisplayObject EventDispatcher Object |
| 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, Adobe 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. |
Show MXML Syntax
Hide MXML SyntaxThe <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>
See also
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 | |
| accessibilityImplementation : AccessibilityImplementation
The current accessibility implementation (AccessibilityImplementation)
for this InteractiveObject instance. | InteractiveObject | |
| accessibilityName : String
A convenience accessor for the name property
in this UIComponent's accessibilityProperties object. | UIComponent | |
| accessibilityProperties : AccessibilityProperties
The current accessibility options for this display object. | DisplayObject | |
| 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 | |
| alpha : Number
Indicates the alpha transparency value of the object specified. | DisplayObject | |
| 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
The vertical distance in pixels from the anchor target to
the control's baseline position. | UIComponent | |
| baselinePosition : Number [read-only]
The y-coordinate of the baseline
of the first line of text of the component. | UIComponent | |
| blendMode : String
A value from the BlendMode class that specifies which blend mode to use. | DisplayObject | |
| blendShader : Shader [write-only]
Sets a shader that is used for blending the foreground and background. | DisplayObject | |
| borderMetrics : EdgeMetrics [read-only]
Returns an EdgeMetrics object that has four properties:
left, top, right,
and bottom. | Container | |
| bottom : Object
The vertical distance in pixels from the bottom edge of the component to the
anchor target's bottom edge. | UIComponent | |
| buttonMode : Boolean
Specifies the button mode of this sprite. | Sprite | |
| cacheAsBitmap : Boolean
If set to true, Flash Player or Adobe AIR caches an internal bitmap representation of the
display object. | DisplayObject | |
| cacheHeuristic : Boolean [write-only]
Used by Flex to suggest bitmap caching for the object. | UIComponent | |
| cachePolicy : String
Specifies the bitmap caching policy for this object. | UIComponent | |
| 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 | ||
| constructor : Object
A reference to the class object or constructor function for a given object instance. | Object | |
| 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 | |
| contextMenu : NativeMenu
Specifies the context menu associated with this object. | InteractiveObject | |
| 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 | |
| dropTarget : DisplayObject [read-only]
Specifies the display object over which the sprite is being dragged, or on
which the sprite was dropped. | Sprite | |
| 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 | |
| filters : Array
An indexed array that contains each filter object currently associated with the display object. | DisplayObject | |
| flexContextMenu : IFlexContextMenu
The context menu for this UIComponent. | UIComponent | |
| focusEnabled : Boolean
Indicates whether the component can receive focus when tabbed to. | UIComponent | |
| focusManager : IFocusManager
Gets the FocusManager that controls focus for this component
and its peers. | UIComponent | |
| focusPane : Sprite
The focus pane associated with this object. | UIComponent | |
| focusRect : Object
Specifies whether this object displays a focus rectangle. | InteractiveObject | |
| fontContext : IFlexModuleFactory
The module factory that provides the font context for this component. | Panel | ||
| graphics : Graphics [read-only]
Specifies the Graphics object that belongs to this sprite where vector
drawing commands can occur. | Sprite | |
| hasFocusableChildren : Boolean
A flag that indicates whether child objects can receive focus. | UIComponent | |
| hasLayoutMatrix3D : Boolean [read-only]
Contians 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 | |
| hitArea : Sprite
Designates another sprite to serve as the hit area for a sprite. | Sprite | |
| horizontalCenter : Object
The horizontal distance in pixels from the center of the component to the
center of the anchor target's content area. | 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
The horizontal distance in pixels from the left edge of the component to the
anchor target's left edge. | UIComponent | |
| loaderInfo : LoaderInfo [read-only]
Returns a LoaderInfo object containing information about loading the file
to which this display object belongs. | DisplayObject | |
| maintainProjectionCenter : Boolean
When true, the component keeps its projection matrix centered on the
middle of its bounding box. | UIComponent | |
| mask : DisplayObject
The calling display object is masked by the specified mask object. | DisplayObject | |
| maxHeight : Number
The maximum recommended height of the component to be considered
by the parent during layout. | UIComponent | |
| 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 | |
| mouseChildren : Boolean
Determines whether or not the children of the object are mouse enabled. | DisplayObjectContainer | |
| mouseEnabled : Boolean
Specifies whether this object receives mouse messages. | InteractiveObject | |
| mouseFocusEnabled : Boolean
Whether you can receive focus when clicked on. | UIComponent | |
| mouseX : Number [read-only]
Indicates the x coordinate of the mouse position, in pixels. | DisplayObject | |
| mouseY : Number [read-only]
Indicates the y coordinate of the mouse position, in pixels. | DisplayObject | |
| name : String
Indicates the instance name of the DisplayObject. | DisplayObject | |
| nestLevel : int
Depth of this object in the containment hierarchy. | UIComponent | |
| nonInheritingStyles : Object
The beginning of this component's chain of non-inheriting styles. | UIComponent | |
| numAutomationChildren : int [read-only]
The number of automation children this container has. | UIComponent | |
| numChildren : int [override] [read-only]
Number of child components in this container. | Container | |
| numElements : int [read-only]
The number of visual elements in this container. | Container | |
| opaqueBackground : Object
Specifies whether the display object is opaque with a certain background color. | DisplayObject | |
| 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
Number that specifies the height of a component as a percentage
of its parent's size. | UIComponent | |
| percentWidth : Number
Number that specifies the width of a component as a percentage
of its parent's size. | UIComponent | |
| postLayoutTransformOffsets : mx.geom: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 | |
| prototype : Object [static]
A reference to the prototype object of a class or function object. | Object | |
| 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
The horizontal distance in pixels from the right edge of the component to the
anchor target's right edge. | UIComponent | |
| root : DisplayObject [read-only]
For a display object in a loaded SWF file, the root property is the
top-most display object in the portion of the display list's tree structure represented by that SWF file. | DisplayObject | |
| rotation : Number [override]
Indicates the rotation of the DisplayObject instance, in degrees, from its original orientation. | 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]
Indicates the z-axis rotation of the DisplayObject instance, in degrees, from its original orientation relative to the 3D parent container. | UIComponent | |
| scale9Grid : Rectangle
The current scaling grid that is in effect. | DisplayObject | |
| scaleX : Number [override]
Number that specifies the horizontal scaling factor. | UIComponent | |
| scaleY : Number [override]
Number that specifies the vertical scaling factor. | UIComponent | |
| scaleZ : Number [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 | |
| scrollRect : Rectangle
The scroll rectangle bounds of the display object. | DisplayObject | |
| showInAutomationHierarchy : Boolean
A flag that determines if an automation object
shows in the automation hierarchy. | UIComponent | |
| soundTransform : flash.media:SoundTransform
Controls sound within this sprite. | Sprite | |
| stage : Stage [read-only]
The Stage of the display object. | DisplayObject | |
| states : Array
The view states that are defined for this component. | UIComponent | |
| 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 [read-only]
A component's parent is used to evaluate descendant selectors. | UIComponent | |
| systemManager : ISystemManager
Returns the SystemManager object used by this component. | UIComponent | |
| tabChildren : Boolean
Determines whether the children of the object are tab enabled. | DisplayObjectContainer | |
| tabEnabled : Boolean
Specifies whether this object is in the tab order. | InteractiveObject | |
| 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 | |
| tabIndex : int
Specifies the tab ordering of objects in a SWF file. | InteractiveObject | |
| textSnapshot : flash.text:TextSnapshot [read-only]
Returns a TextSnapshot object for this DisplayObjectContainer instance. | DisplayObjectContainer | |
| 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
The vertical distance in pixels from the top edge of the component to the
anchor target's top edge. | UIComponent | |
| transform : flash.geom:Transform
An object with properties pertaining to a display object's matrix, color transform, and pixel bounds. | DisplayObject | |
| 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 | |
| useHandCursor : Boolean
A Boolean value that indicates whether the pointing hand (hand cursor) appears when the mouse rolls
over a sprite in which the buttonMode property is set to true. | Sprite | |
| validationSubField : String
Used by a validator to associate a subfield with this component. | UIComponent | |
| verticalCenter : Object
The vertical distance in pixels from the center of the component to the
center of the anchor target's content area. | 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]
Indicates the z coordinate position along the z-axis of the DisplayObject
instance relative to the 3D parent container. | UIComponent | |
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 : mx.core: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 : mx.core: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
| Method | Defined By | ||
|---|---|---|---|
Panel()
Constructor. | Panel | ||
| [override]
Adds a child DisplayObject to this Container. | Container | |
| [override]
Adds a child DisplayObject to this Container. | Container | |
|
Adds a visual element to this container. | Container | |
|
Adds a visual element to this container. | Container | |
| addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void
Registers an event listener object with an EventDispatcher object so that the listener
receives notification of an event. | EventDispatcher | |
|
Indicates whether the security restrictions
would cause any display objects to be omitted from the list returned by calling
the DisplayObjectContainer.getObjectsUnderPoint() method
with the specified point point. | DisplayObjectContainer | |
|
Queues a function to be called later. | UIComponent | |
|
Deletes a style property from this component instance. | UIComponent | |
|
Determines whether the specified display object is a child of the DisplayObjectContainer instance or
the instance itself. | DisplayObjectContainer | |
| [override]
Converts a Point object from content coordinates to global coordinates. | Container | |
| [override]
Converts a Point object from content to local coordinates. | Container | |
|
Returns a set of properties that identify the child within
this container. | UIComponent | |
|
Returns a set of properties that identify the child within
this container. | UIComponent | |
|
Given a single UIComponentDescriptor, create the corresponding
component and add the component as a child of this Container. | Container | |
|
Iterate through the Array of childDescriptors,
and call the createComponentFromDescriptor() method for each one. | Container | |
|
Performs the equivalent action of calling
the createComponentsFromDescriptors(true) method for containers
that implement the IDeferredContentOwner interface to support deferred instantiation. | Container | |
|
Creates an id reference to this IUIComponent object
on its parent document object. | UIComponent | |
|
Deletes the id reference to this IUIComponent object
on its parent document object. | UIComponent | |
|
Returns a UITextFormat object corresponding to the text styles
for this UIComponent. | UIComponent | |
| [override]
Dispatches an event into the event flow. | UIComponent | |
|
Shows or hides the focus indicator around this component. | UIComponent | |
| drawRoundRect(x:Number, y:Number, w:Number, h:Number, r:Object = null, c:Object = null, alpha:Object = null, rot:Object = null, gradient:String = null, ratios:Array = null, hole:Object = null):void
Programmatically draws a rectangle into this skin's Graphics object. | UIComponent | |
|
Called by the effect instance when it stops playing on the component. | UIComponent | |
|
Called by the effect instance when it starts playing on the component. | UIComponent | |
|
Ends all currently playing effects on the component. | UIComponent | |
| [override]
Executes all the data bindings on this Container. | Container | |
|
Executes the bindings into this Container's child UIComponent objects. | Container | |
|
Called after printing is complete. | UIComponent | |
|
Provides the automation object at the specified index. | UIComponent | |
|
Provides the automation object list . | UIComponent | |
|
Returns a rectangle that defines the area of the display object relative to the coordinate system
of the targetCoordinateSpace object. | DisplayObject | |
|
Returns the x coordinate of the element's bounds at the specified element size. | UIComponent | |
|
Returns the y coordinate of the element's bounds at the specified element size. | UIComponent | |
| [override]
Gets the nth child component object. | Container | |
| [override]
Returns the child whose name property is the specified String. | Container | |
| [override]
Gets the zero-based index of a specific child. | Container | |
|
Returns an Array of DisplayObject objects consisting of the content children
of the container. | Container | |
|
Finds the type selectors for this UIComponent instance. | UIComponent | |
|
Returns a layout constraint value, which is the same as
getting the constraint style for this component. | UIComponent | |
|
Returns the visual element at the specified index. | Container | |
|
Returns the index position of a visual element. | Container | |
|
A convenience method for determining whether to use the
explicit or measured height
| UIComponent | |
|
A convenience method for determining whether to use the
explicit or measured width
| UIComponent | |
|
Gets the object that currently has focus. | UIComponent | |
|
Returns the element's layout height. | UIComponent | |
|
Returns the element's layout width. | UIComponent | |
|
Returns the x coordinate that the element uses to draw on screen. | UIComponent | |
|
Returns the y coordinate that the element uses to draw on screen. | UIComponent | |
|
Returns the transform matrix that is used to calculate the component's
layout relative to its siblings. | UIComponent | |
|
Returns the layout transform Matrix3D for this element. | UIComponent | |
|
Returns the element's maximum height. | UIComponent | |
|
Returns the element's maximum width. | UIComponent | |
|
Returns the element's minimum height. | UIComponent | |
|
Returns the element's minimum width. | UIComponent | |
|
Returns an array of objects that lie under the specified point and are children
(or grandchildren, and so on) of this DisplayObjectContainer instance. | DisplayObjectContainer | |
|
Returns the element's preferred height. | UIComponent | |
|
Returns the element's preferred width. | UIComponent | |
|
Returns a rectangle that defines the boundary of the display object,
based on the coordinate system defined by the targetCoordinateSpace
parameter, excluding any strokes on shapes. | DisplayObject | |
|
Returns the item in the dataProvider that was used
by the specified Repeater to produce this Repeater, or
null if this Repeater isn't repeated. | UIComponent | |
|
Gets a style property that has been set anywhere in this
component's style lookup chain. | UIComponent | |
| [override]
Converts a Point object from global to content coordinates. | Container | |
|
Converts the point object from the Stage (global) coordinates
to the display object's (local) coordinates. | DisplayObject | |
|
Converts a two-dimensional point from the Stage (global) coordinates to a
three-dimensional display object's (local) coordinates. | DisplayObject | |
|
Checks whether the EventDispatcher object has any listeners registered for a specific type
of event. | EventDispatcher | |
|
Indicates whether an object has a specified property defined. | Object | |
|
Determines whether the specified state has been defined on this
UIComponent. | UIComponent | |
|
Evaluates the bounding box of the display object to see if it overlaps or intersects with the
bounding box of the obj display object. | DisplayObject | |
|
Evaluates the display object to see if it overlaps or intersects with the
point specified by the x and y parameters. | DisplayObject | |
|
Returns a box Matrix which can be passed to the
drawRoundRect() method
as the rot parameter when drawing a horizontal gradient. | UIComponent | |
|
Initializes the internal structure of this component. | UIComponent | |
|
Initializes various properties which keep track of repeated instances
of this component. | UIComponent | |
|
Marks a component so that its updateDisplayList()
method gets called during a later screen update. | UIComponent | |
|
Called by a component's items to indicate that their depth
property has changed. | UIComponent | |
|
Marks a component so that its commitProperties()
method gets called during a later screen update. | UIComponent | |
|
Marks a component so that its measure()
method gets called during a later screen update. | UIComponent | |
|
Indicates whether an instance of the Object class is in the prototype chain of the object specified
as the parameter. | Object | |
|
Converts a three-dimensional point of the three-dimensional display
object's (local) coordinates to a two-dimensional point in the Stage (global) coordinates. | DisplayObject | |
| [override]
Converts a Point object from local to content coordinates. | Container | |
|
Converts the point object from the display object's (local) coordinates to the
Stage (global) coordinates. | DisplayObject | |
|
Returns true if cssState matches currentCSSState. | UIComponent | |
|
Determines whether this instance is the same as, or is a subclass of,
the given type. | UIComponent | |
|
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 | |
|
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 | |
|
Moves the component to a specified position within its parent. | UIComponent | |
|
Propagates style changes to the children. | UIComponent | |
|
Returns true if the chain of owner properties
points from child to this UIComponent. | UIComponent | |
|
Called by Flex when a UIComponent object is added to or removed from a parent. | UIComponent | |
|
Prepares an IFlexDisplayObject for printing. | UIComponent | |
|
Indicates whether the specified property exists and is enumerable. | Object | |
|
Builds or rebuilds the CSS style cache for this component
and, if the recursive parameter is true,
for all descendants of this component as well. | UIComponent | |
|
For each effect event, registers the EffectManager
as one of the event listeners. | UIComponent | |
|
Removes all children from the child list of this container. | Container | |
|
Removes all visual elements from the container. | Container | |
| [override]
Removes a child DisplayObject from the child list of this Container. | Container | |
| [override]
Removes a child DisplayObject from the child list of this Container
at the specified index. | Container | |
|
Removes the specified visual element from the child list of
this container. | Container | |
|
Removes a visual element from the specified index position
in the container. | Container | |
|
Removes a listener from the EventDispatcher object. | EventDispatcher | |
|
Replays the specified event. | UIComponent | |
|
Resolves a child by using the id provided. | UIComponent | |
| [static]
Resumes the background processing of methods
queued by callLater(), after a call to
suspendBackgroundProcessing(). | UIComponent | |
|
Sizes the object. | UIComponent | |
| [override]
Sets the index of a particular child. | Container | |
|
Sets a layout constraint value, which is the same as
setting the constraint style for this component. | UIComponent | |
|
Set the current state. | UIComponent | |
|
Changes the position of an existing visual element in the visual container. | Container | |
|
Sets the focus to this component. | UIComponent | |
|
Sets the coordinates that the element uses to draw on screen. | UIComponent | |
|
Sets the layout size of the element. | UIComponent | |
|
Sets the transform Matrix that is used to calculate the component's layout
size and position relative to its siblings. | UIComponent | |
|
Sets the transform Matrix3D that is used to calculate the component's layout
size and position relative to its siblings. | UIComponent | |
|
Sets the availability of a dynamic property for loop operations. | Object | |
|
Sets a style property on this component instance. | UIComponent | |
|
Called when the visible property changes. | UIComponent | |
|
Lets the user drag the specified sprite. | Sprite | |
|
Ends the startDrag() method. | Sprite | |
|
Detects changes to style properties. | UIComponent | |
|
Flex calls the stylesInitialized() method when
the styles for a component are first initialized. | UIComponent | |
| [static]
Blocks the background processing of methods
queued by callLater(),
until resumeBackgroundProcessing() is called. | UIComponent | |
|
Swaps the z-order (front-to-back order) of the two specified child objects. | DisplayObjectContainer | |
|
Swaps the z-order (front-to-back order) of the child objects at the two specified index positions in the
child list. | DisplayObjectContainer | |
|
Swaps the index of the two specified visual elements. | Container | |
|
Swaps the visual elements at the two specified index
positions in the container. | Container | |
|
Returns the string representation of this object, formatted according to locale-specific conventions. | Object | |
| [override]
Returns a string indicating the location of this object
within the hierarchy of DisplayObjects in the Application. | FlexSprite | |
| 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 | |
|
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 | |
|
Validates the position and size of children and draws other
visuals. | UIComponent | |
|
Validate and update the properties and layout of this object
and redraw it, if necessary. | UIComponent | |
|
Used by layout logic to validate the properties of a component
by calling the commitProperties() method. | UIComponent | |
|
Validates the measured size of the component
If the LayoutManager.invalidateSize() method is called with
this ILayoutManagerClient, then the validateSize() method
is called when it's time to do measurements. | UIComponent | |
|
Handles both the valid and invalid events from a
validator assigned to this component. | UIComponent | |
|
Returns the primitive value of the specified object. | Object | |
|
Returns a box Matrix which can be passed to drawRoundRect()
as the rot parameter when drawing a vertical gradient. | UIComponent | |
|
Checks whether an event listener is registered with this EventDispatcher object or any of
its ancestors for the specified event type. | EventDispatcher | |
Protected Methods
| Method | Defined By | ||
|---|---|---|---|
|
Adjust the focus rectangle. | UIComponent | |
|
Commits the computed matrix built from the combination of the layout
matrix and the transform offsets to the flash displayObject's transform. | UIComponent | |
| [override]
Used internally by the Dissolve Effect to add the overlay to the chrome of a container. | Container | |
|
Determines if the call to the measure() method can be skipped. | UIComponent | |
|
Performs any final processing after child objects are created. | UIComponent | |
|
Processes the properties set on the component. | UIComponent | |
|
Creates the container's border skin
if it is needed and does not already exist. | Container | |
|
Create child objects of the component. | UIComponent | |
|
Creates a new object using a context
based on the embedded font being used. | UIComponent | |
|
Creates the object using a given moduleFactory. | UIComponent | |
|
Helper method for dispatching a PropertyChangeEvent
when a property is updated. | UIComponent | |
|
The event handler called when a UIComponent object gets focus. | UIComponent | |
|
The event handler called when a UIComponent object loses focus. | UIComponent | |
Returns the height of the header. | Panel | ||
|
Initializes the implementation and storage of some of the less frequently
used advanced layout features of a component. | UIComponent | |
|
Finalizes the initialization of this component. | UIComponent | |
|
Initializes this component's accessibility code. | UIComponent | |
|
Helper method to invalidate parent size and display list if
this object affects its layout (includeInLayout is true). | UIComponent | |
|
Typically overridden by components containing UITextField objects,
where the UITextField object gets focus. | UIComponent | |
|
The event handler called for a keyDown event. | UIComponent | |
|
The event handler called for a keyUp event. | UIComponent | |
|
Respond to size changes by setting the positions and sizes
of this container's borders. | Container | |
[override]
Calculates the default mininum and maximum sizes
of the Panel container. | Panel | ||
|
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 | |
|
Positions the container's content area relative to the viewable area
based on the horizontalScrollPosition and verticalScrollPosition properties. | Container | |
|
Specifies a transform stretch factor in the horizontal and vertical direction. | UIComponent | |
Called when the user starts dragging a Panel
that has been popped up by the PopUpManager. | Panel | ||
|
This method is called when a state changes to check whether
state-specific styles apply to this component. | UIComponent | |
Called when the user stops dragging a Panel
that has been popped up by the PopUpManager. | Panel | ||
| [override]
Respond to size changes by setting the positions and sizes
of this container's children. | Container | |
Styles
Styles are either common or associated with a specific theme. If the style is common, it can be used with any theme. If a style is associated with a specific theme, it can only be used if your application uses that theme.
Common Styles
| Style | Description | Defined By | ||
|---|---|---|---|---|
| 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 | ||
| 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 | ||
| Type: Class CSS Inheritance: no The border skin class of the component. | Container | ||
| Type: String CSS Inheritance: no Bounding box style. | Container | ||
| 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 | ||
| Type: uint Format: Color CSS Inheritance: yes Color of text in the component, including the component label. | 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 | ||
| Type: String CSS Inheritance: yes The directionality of the text displayed by the component. | Container | ||
| Type: uint Format: Color CSS Inheritance: yes Color of text in the component if it is disabled. | Container | ||
| Type: Number CSS Inheritance: no The alpha value for the overlay that is placed on top of the container when it is disabled. | Container | ||
| Type: uint Format: Color CSS Inheritance: yes Color of the component highlight when validation fails. | UIComponent | ||
| Type: String CSS Inheritance: yes Sets the antiAliasType property of internal TextFields. | Container | ||
| Type: String CSS Inheritance: yes Name of the font to use. | Container | ||
| Type: String CSS Inheritance: yes Sets the gridFitType property of internal TextFields that represent text in Flex controls. | Container | ||
| Type: Number CSS Inheritance: yes Sets the sharpness property of internal TextFields that represent text in Flex controls. | Container | ||
| Type: Number Format: Length CSS Inheritance: yes Height of the text, in pixels. | Container | ||
| Type: String CSS Inheritance: yes Determines whether the text is italic font. | Container | ||
| Type: Number CSS Inheritance: yes Sets the thickness property of internal TextFields that represent text in Flex controls. | Container | ||
| Type: String CSS Inheritance: yes Determines whether the text is boldface. | Container | ||
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 | ||
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 | ||
| 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 | ||
| Type: String CSS Inheritance: no The name of the horizontal scrollbar style. | Container | ||
| Type: Boolean CSS Inheritance: yes A Boolean value that indicates whether kerning is enabled ( true) or disabled (false). | Container | ||
| 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 | ||
| Type: Number CSS Inheritance: yes The number of additional pixels to appear between each character. | Container | ||
| 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 | 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 | ||
| 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 | ||
| 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 | ||
| 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 | ||
statusStyleName | Type: String CSS Inheritance: no Style declaration name for the status in the title bar. The default value is "windowStatus". | Panel | ||
| Type: String CSS Inheritance: yes Alignment of text within a container. | Container | ||
| Type: String CSS Inheritance: yes Determines whether the text is underlined. | Container | ||
| Type: Class CSS Inheritance: no The class implementing IUITextField that is used by this component to render text. | Container | ||
| Type: Number Format: Length CSS Inheritance: yes Offset of first line of text from the left side of the container, in pixels. | Container | ||
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 | ||
| 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 | ||
| 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 | ||
| Type: String CSS Inheritance: no The name of the vertical scrollbar style. | Container | ||
Spark Theme Styles
| Style | Description | Defined By | ||
|---|---|---|---|---|
| Type: uint Format: Color CSS Inheritance: yes Theme: spark Accent color used by component skins. | Container | ||
| 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 | ||
| Type: uint Format: Color CSS Inheritance: no Theme: halo, spark Background color of a component. | Container | ||
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 | ||
| Type: uint Format: Color CSS Inheritance: no Theme: halo, spark Color of the border. | Container | ||
| Type: Boolean CSS Inheritance: no Theme: spark Visibility of the border. | Container | ||
| Type: uint Format: Color CSS Inheritance: yes Theme: spark The main color for a component. | UIComponent | ||
| Type: Number CSS Inheritance: yes Theme: spark The alpha of the content background for this component. | Container | ||
| Type: uint Format: Color CSS Inheritance: yes Theme: spark Color of the content area of the component. | Container | ||
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 | ||
| Type: Boolean CSS Inheritance: no Theme: spark Boolean property that specifies whether the component has a visible drop shadow. | Container | ||
| Type: uint Format: Color CSS Inheritance: yes Theme: spark Color of focus ring when the component is in focus | Container | ||
| Type: uint Format: Color CSS Inheritance: yes Theme: spark Color of any symbol of a component. | Container | ||
Halo Theme Styles
| Style | Description | Defined By | ||
|---|---|---|---|---|
| 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 | ||
| Type: uint Format: Color CSS Inheritance: no Theme: halo, spark Background color of a component. | Container | ||
| Type: uint Format: Color CSS Inheritance: yes Theme: halo Background color of the component when it is disabled. | Container | ||
| Type: Object Format: File CSS Inheritance: no Theme: halo Background image of a component. | Container | ||
| Type: String CSS Inheritance: no Theme: halo Scales the image specified by backgroundImage to different percentage sizes. | Container | ||
| Type: uint Format: Color CSS Inheritance: yes Theme: halo Determines the color of a ProgressBar. | Container | ||
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 | ||
| Type: uint Format: Color CSS Inheritance: no Theme: halo, spark Color of the border. | Container | ||
| Type: String CSS Inheritance: no Theme: halo Bounding box sides. | Container | ||
| 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 | ||
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 | ||
| 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 | ||
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 | ||
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 | ||
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 | ||
| Type: uint Format: Color CSS Inheritance: yes Theme: halo Theme color of a component. | UIComponent | ||
Effects
| Effect | Description | Defined By | ||
|---|---|---|---|---|
| Triggering Event: added Played when the component is added as a child to a Container. | UIComponent | ||
| Triggering Event: creationComplete Played when the component is created. | UIComponent | ||
| Triggering Event: hide Played when the component becomes invisible. | UIComponent | ||
| Triggering Event: mouseDown Played when the user presses the mouse button while over the component. | UIComponent | ||
| Triggering Event: mouseUp Played when the user releases the mouse button while over the component. | UIComponent | ||
| Triggering Event: move Played when the component is moved. | UIComponent | ||
| Triggering Event: removed Played when the component is removed from a Container. | UIComponent | ||
| 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 | ||
| Triggering Event: rollOut Played when the user rolls the mouse so it is no longer over the component. | UIComponent | ||
| Triggering Event: rollOver Played when the user rolls the mouse over the component. | UIComponent | ||
| Triggering Event: show Played when the component becomes visible. | UIComponent | ||
Public Constants
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():ObjectSee also
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):voidconstraintRows | 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):voidcontrolBar | 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):voidlayout | 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. When this property is modified, it dispatches the layoutChanged event.
Implementation
public function get layout():String public function set layout(value:String):voidstatus | 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. When this property is modified, it dispatches the statusChanged event.
Implementation
public function get status():String public function set status(value:String):voidstatusTextField | property |
protected var statusTextField:mx.core: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
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. When this property is modified, it dispatches the titleChanged event.
Implementation
public function get title():String public function set title(value:String):voidtitleBar | 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. When this property is modified, it dispatches the titleIconChanged event.
Implementation
public function get titleIcon():Class public function set titleIcon(value:Class):voidtitleTextField | property |
protected var titleTextField:mx.core: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
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.
ReturnsNumber — 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
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 |
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 ( How to use this example )
SimplePanelExample.mxml
<?xml version="1.0"?>
<!-- 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>
Fri Mar 19 2010, 02:45 AM -07:00