| Package | mx.core |
| Class | public class WindowedApplication |
| Inheritance | WindowedApplication  Application LayoutContainer Container UIComponent FlexSprite Sprite DisplayObjectContainer InteractiveObject DisplayObject EventDispatcher Object |
| Implements | IWindow |
The WindowedApplication serves two roles. It is a replacement for the <mx:Application> tag, functioning as the entry point to a Flex-based AIR application. In addition, as a container the WindowedApplication defines the layout of the initial window of a Flex AIR application -- any visual controls defined in the WindowedApplication become the content of the initial window loaded by the AIR application.
Note that because the WindowedApplication only represents the visual content of a single window, and not all the windows in a multi-window application, a WindowedApplication instance only dispatches display-related events (events that the WindowedApplication class inherits from display object base classes such as InteractiveObject or UIComponent) for its own stage and window, and not for events that occur on other windows in the application. This differs from a browser-based application, where an Application container dispatches events for all the windows in the application (because technically those windows are all display objects rendered on the single Application stage).
MXML Syntax
Hide MXML SyntaxThe <mx:WindowedApplication> tag inherits all of the tag
attributes of its superclass and adds the following tag attributes:
Show MXML Syntax
<mx:WindowedApplication
Properties
alwaysInFront="false"
autoExit="true"
dockIconMenu="null"
maxHeight="10000"
maxWidth="10000"
menu="null"
minHeight="100"
minWidth="100"
showGripper="true"
showStatusBar="true"
showTitleBar="true"
status=""
statusBarFactory="mx.core.ClassFactory"
systemTrayIconMenu="null"
title=""
titleBarFactory="mx.core.ClassFactory"
titleIcon="null"
Styles
buttonAlignment="auto"
buttonPadding="2"
closeButtonSkin="mx.skins.halo.windowCloseButtonSkin"
gripperPadding="3"
gripperStyleName="gripperStyle"
headerHeight="undefined"
maximizeButtonSkin="mx.skins.halo.WindowMaximizeButtonSkin"
minimizeButtonSkin="mx.skins.halo.WindowMinimizeButtonSkin"
restoreButtonSkin="mx.skins.halo.WindowRestoreButtonSkin"
showFlexChrome="true"
statusBarBackgroundColor="0xC0C0C0"
statusBarBackgroundSkin="mx.skins.halo.StatusBarBackgroundSkin"
statusTextStyleName="undefined"
titleAlignment="auto"
titleBarBackgroundSkin="mx.skins.halo.ApplicationTitleBarBackgroundSkin"
titleBarButtonPadding="5"
titleBarColors="[ 0x000000, 0x000000 ]"
titleTextStyleName="undefined"
Effects
closeEffect="No default"
minimizeEffect="No default"
unminimizeEffect="No default"
Events
applicationActivate="No default"
applicationDeactivate="No default"
closing="No default"
displayStateChange="No default"
displayStateChanging="No default"
invoke="No default"
moving="No default"
networkChange="No default"
resizing="No default"
windowComplete="No default"
windowMove="No default"
windowResize="No default"
/>
| Property | Defined By | ||
|---|---|---|---|
 | accessibilityProperties : AccessibilityProperties
The current accessibility options for this display object. | DisplayObject | |
| activeEffects : Array [read-only]
The list of effects that are currently playing on the component,
as an Array of EffectInstance instances. | UIComponent | |
| alpha : Number
Indicates the alpha transparency value of the object specified. | DisplayObject | |
| alwaysInFront : Boolean
Determines whether the underlying NativeWindow is always in front of other windows. | WindowedApplication | ||
| application : Object [static] [read-only]
A reference to the top-level application. | Application | |
| applicationID : String [read-only]
The identifier that AIR uses to identify the application. | WindowedApplication | ||
| autoExit : Boolean
Specifies whether the AIR application will quit when the last
window closes or will continue running in the background. | WindowedApplication | ||
| 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 | |
| automationName : String
Name that can be used as an identifier for this object. | UIComponent | |
| automationTabularData : Object [read-only]
An implementation of the IAutomationTabularData interface, which
can be used to retrieve the data. | UIComponent | |
| automationValue : Array [read-only]
This value generally corresponds to the rendered appearance of the
object and should be usable for correlating the identifier with
the object as it appears visually within the application. | UIComponent | |
| 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 | |
| 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 | |
| closed : Boolean [read-only]
Returns true when the underlying window has been closed. | WindowedApplication | ||
| constraintColumns : Array
An Array of ConstraintColumn instances that partition this container. | LayoutContainer | |
| constraintRows : Array
An Array of ConstraintRow instances that partition this container. | LayoutContainer | |
| 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 | |
| controlBar : IUIComponent
The ApplicationControlBar for this Application. | Application | |
| creatingContentPane : Boolean
Containers use an internal content pane to control scrolling. | Container | |
| creationIndex : int
Specifies the order to instantiate and draw the children
of the container. | Container | |
| creationPolicy : String
The child creation policy for this 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 | |
| descriptor : UIComponentDescriptor
Reference to the UIComponentDescriptor, if any, that was used
by the createComponentFromDescriptor() method to create this
UIComponent instance. | UIComponent | |
| dockIconMenu : FlexNativeMenu
The dock icon menu. | WindowedApplication | ||
| 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 will be displayed by a component's error tip when a
component is monitored by a Validator and validation fails. | UIComponent | |
| explicitHeight : Number
Number that specifies the explicit height of the component,
in pixels, in the component's coordinates. | UIComponent | |
| explicitMaxHeight : Number
The maximum recommended height of the component to be considered
by the parent during layout. | UIComponent | |
| explicitMaxWidth : Number
The maximum recommended width of the component to be considered
by the parent during layout. | UIComponent | |
| explicitMinHeight : Number
The minimum recommended height of the component to be considered
by the parent during layout. | UIComponent | |
| explicitMinWidth : Number
The minimum recommended width of the component to be considered
by the parent during layout. | UIComponent | |
| explicitWidth : Number
Number that specifies the explicit width of the component,
in pixels, in the component's coordinates. | UIComponent | |
| filters : Array
An indexed array that contains each filter object currently associated with the display object. | DisplayObject | |
| flexContextMenu : IFlexContextMenu
The context menu for this UIComponent. | UIComponent | |
| focusEnabled : Boolean
Indicates whether the component can receive focus when tabbed to. | UIComponent | |
| focusManager : IFocusManager
Gets the FocusManager that controls focus for this component
and its peers. | UIComponent | |
| focusPane : Sprite
The focus pane associated with this object. | UIComponent | |
| focusRect : Object
Specifies whether this object displays a focus rectangle. | InteractiveObject | |
| frameRate : Number
Specifies the frame rate of the application. | Application | |
| graphics : Graphics [read-only]
Specifies the Graphics object that belongs to this sprite where vector
drawing commands can occur. | Sprite | |
| height : Number [override]
Number that specifies the height of the component, in pixels,
in the parent's coordinates. | UIComponent | |
| historyManagementEnabled : Boolean = true
If false, the history manager will be disabled. | Application | |
| hitArea : Sprite
Designates another sprite to serve as the hit area for a sprite. | Sprite | |
| 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 | |
| id : String
ID of the component. | UIComponent | |
| includeInLayout : Boolean
Specifies whether this component is included in the layout of the
parent container. | UIComponent | |
| inheritingStyles : Object
The beginning of this component's chain of inheriting styles. | UIComponent | |
| initialized : Boolean
A flag that determines if an object has been through all three phases
of layout: commitment, measurement, and layout (provided that any were required). | UIComponent | |
| instanceIndex : int [read-only]
The index of a repeated component. | UIComponent | |
| instanceIndices : Array
An Array containing the indices required to reference
this UIComponent object from its parent document. | UIComponent | |
| isDocument : Boolean [read-only]
Determines whether this UIComponent instance is a document object,
that is, whether it is at the top of the hierarchy of a Flex
application, MXML component, or ActionScript component. | UIComponent | |
| isPopUp : Boolean
Set to true by the PopUpManager to indicate
that component has been popped up. | UIComponent | |
| layout : String
Specifies the layout mechanism used for this application. | LayoutContainer | |
| loaderInfo : LoaderInfo [read-only]
Returns a LoaderInfo object containing information about loading the file
to which this display object belongs. | DisplayObject | |
| mask : DisplayObject
The calling display object is masked by the specified mask object. | DisplayObject | |
| maxHeight : Number [override]
Specifies the maximum height of the application's window. | WindowedApplication | ||
| maxHorizontalScrollPosition : Number [read-only]
The largest possible value for the
horizontalScrollPosition property. | Container | |
| maximizable : Boolean [read-only]
Specifies whether the window can be maximized. | WindowedApplication | ||
| maxVerticalScrollPosition : Number [read-only]
The largest possible value for the
verticalScrollPosition property. | Container | |
| maxWidth : Number [override]
Specifies the maximum width of the application's window. | WindowedApplication | ||
| 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 | |
| menu : FlexNativeMenu
The application menu for operating systems that support an application menu,
or the window menu of the application's initial window for operating
systems that support window menus. | WindowedApplication | ||
| minHeight : Number [override]
Specifies the minimum height of the application's window. | WindowedApplication | ||
| minimizable : Boolean [read-only]
Specifies whether the window can be minimized. | WindowedApplication | ||
| minWidth : Number [override]
Specifies the minimum width of the application's window. | WindowedApplication | ||
| moduleFactory : IFlexModuleFactory
The moduleFactory that is used to create TextFields in the correct SWF context. | UIComponent | |
| mouseChildren : Boolean
Determines whether or not the children of the object are mouse enabled. | DisplayObjectContainer | |
| mouseEnabled : Boolean
Specifies whether this object receives mouse messages. | InteractiveObject | |
| mouseFocusEnabled : Boolean
Whether you can receive focus when clicked on. | UIComponent | |
| mouseX : Number [read-only]
Indicates the x coordinate of the mouse position, in pixels. | DisplayObject | |
| mouseY : Number [read-only]
Indicates the y coordinate of the mouse position, in pixels. | DisplayObject | |
| name : String
Indicates the instance name of the DisplayObject. | DisplayObject | |
| nativeApplication : NativeApplication [read-only]
The NativeApplication object representing the AIR application. | WindowedApplication | ||
| nativeWindow : NativeWindow [read-only]
The NativeWindow used by this WindowedApplication component (the initial
native window of the application). | WindowedApplication | ||
| 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 | |
| opaqueBackground : Object
Specifies whether the display object is opaque with a certain background color. | DisplayObject | |
| owner : DisplayObjectContainer
The owner of this UIComponent. | UIComponent | |
| pageTitle : String
Specifies a string that appears in the title bar of the browser. | Application | |
| parameters : Object [read-only]
The parameters property returns an Object containing name-value
pairs representing the parameters provided to this Application. | Application | |
| 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 | |
| preloader : Object
Specifies the path of a SWC component class or ActionScript
component class that defines a custom progress bar. | Application | |
| 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 | |
| resetHistory : Boolean = true
If true, the application's history state is reset
to its initial state whenever the application is reloaded. | Application | |
| resizable : Boolean [read-only]
Specifies whether the window can be resized. | WindowedApplication | ||
| root : DisplayObject [read-only]
For a display object in a loaded SWF file, the root property is the
top-most display object in the portion of the display list's tree structure represented by that SWF file. | DisplayObject | |
| rotation : Number
Indicates the rotation of the DisplayObject instance, in degrees, from its original orientation. | DisplayObject | |
| rotationX : Number
Indicates the x-axis rotation of the DisplayObject instance, in degrees, from its original orientation relative to the 3D parent container. | DisplayObject | |
| rotationY : Number
Indicates the y-axis rotation of the DisplayObject instance, in degrees, from its original orientation relative to the 3D parent container. | DisplayObject | |
| rotationZ : Number
Indicates the z-axis rotation of the DisplayObject instance, in degrees, from its original orientation relative to the 3D parent container. | DisplayObject | |
| scale9Grid : Rectangle
The current scaling grid that is in effect. | DisplayObject | |
| scaleX : Number [override]
Number that specifies the horizontal scaling factor. | UIComponent | |
| scaleY : Number [override]
Number that specifies the vertical scaling factor. | UIComponent | |
| scaleZ : Number
Indicates the depth scale (percentage) of an object as applied from the registration point of the object. | DisplayObject | |
| screen : Rectangle [read-only]
Returns an object that contains the size and position of the base
drawing surface for this object. | UIComponent | |
| scriptRecursionLimit : int
Specifies the maximum depth of Flash Player or AIR
call stack before the player stops. | Application | |
| scriptTimeLimit : Number
Specifies the maximum duration, in seconds, that an ActionScript
event handler can execute before Flash Player or AIR assumes
that it is hung, and aborts it. | Application | |
| scrollRect : Rectangle
The scroll rectangle bounds of the display object. | DisplayObject | |
| showGripper : Boolean
If true, the gripper is visible. | WindowedApplication | ||
| showInAutomationHierarchy : Boolean
A flag that determines if an automation object
shows in the automation hierarchy. | UIComponent | |
| showStatusBar : Boolean
If true, the status bar is visible. | WindowedApplication | ||
| showTitleBar : Boolean
If true, the window's title bar is visible. | WindowedApplication | ||
| 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
The string that appears in the status bar, if it is visible. | WindowedApplication | ||
| statusBar : UIComponent [read-only]
The UIComponent that displays the status bar. | WindowedApplication | ||
| statusBarFactory : IFactory
The IFactory that creates an instance to use
as the status bar. | WindowedApplication | ||
| styleDeclaration : CSSStyleDeclaration
Storage for the inline inheriting styles on this object. | UIComponent | |
| styleName : Object
The class style used by this component. | UIComponent | |
| systemChrome : String [read-only]
Specifies the type of system chrome (if any) the window has. | WindowedApplication | ||
| systemManager : ISystemManager
Returns the SystemManager object used by this component. | UIComponent | |
| systemTrayIconMenu : FlexNativeMenu
The system tray icon menu. | WindowedApplication | ||
| 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 | |
| textSnapshot : flash.text:TextSnapshot [read-only]
Returns a TextSnapshot object for this DisplayObjectContainer instance. | DisplayObjectContainer | |
| title : String
The title that appears in the window title bar and
the taskbar. | WindowedApplication | ||
| titleBar : UIComponent [read-only]
The UIComponent that displays the title bar. | WindowedApplication | ||
| titleBarFactory : IFactory
The IFactory that creates an instance to use
as the title bar. | WindowedApplication | ||
| titleIcon : Class
The Class (usually an image) used to draw the title bar icon. | WindowedApplication | ||
| transform : flash.geom:Transform
An object with properties pertaining to a display object's matrix, color transform, and pixel bounds. | DisplayObject | |
| transitions : Array
An Array of Transition objects, where each Transition object defines a
set of effects to play when a view state change occurs. | UIComponent | |
| transparent : Boolean [read-only]
Specifies whether the window is transparent. | WindowedApplication | ||
| tweeningProperties : Array
Array of properties that are currently being tweened on this object. | UIComponent | |
| type : String [read-only]
Specifies the type of NativeWindow that this component
represents. | WindowedApplication | ||
| 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 | |
| url : String [read-only]
The URL from which this Application's SWF file was loaded. | Application | |
| 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 | |
| usePreloader : Boolean
If true, specifies to display the application preloader. | Application | |
| validationSubField : String
Used by a validator to associate a subfield with this component. | 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 | |
| viewSourceURL : String
URL where the application's source can be viewed. | Application | |
| visible : Boolean [override]
Controls the visibility of this UIComponent. | UIComponent | |
| width : Number [override]
Number that specifies the width of the component, in pixels,
in the parent's coordinates. | UIComponent | |
| z : Number
Indicates the z coordinate position along the z-axis of the DisplayObject
instance relative to the 3D parent container. | DisplayObject | |
| Property | Defined By | ||
|---|---|---|---|
| actualCreationPolicy : String
The creation policy of this container. | Container | |
| boxLayoutClass : Class
The mx.containers.utilityClasses.Layout subclass that is doing the layout
| LayoutContainer | |
| canvasLayoutClass : Class
The mx.containers.utilityClasses.Layout subclass that is doing the layout
| LayoutContainer | |
| resourceManager : IResourceManager [read-only]
A reference to the object which manages
all of the application's localized resources. | UIComponent | |
| statusBarStyleFilters : Object [read-only]
Set of styles to pass from the WindowedApplication to the status bar. | WindowedApplication | ||
| titleBarStyleFilters : Object [read-only]
Set of styles to pass from the WindowedApplication to the titleBar. | WindowedApplication | ||
| unscaledHeight : Number [read-only]
A convenience method for determining the unscaled height
of the component. | UIComponent | |
| unscaledWidth : Number [read-only]
A convenience method for determining the unscaled width
of the component
All of a component's drawing and child layout should be done
within a bounding rectangle of this width, which is also passed
as an argument to updateDisplayList(). | UIComponent | |
| Method | Defined By | ||
|---|---|---|---|
Constructor. | WindowedApplication | ||
Activates the underlying NativeWindow (even if this application is not the active one). | WindowedApplication | ||
| [override]
Adds a child DisplayObject to this Container. | Container | |
| [override]
Adds a child DisplayObject 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 | |
| addToCreationQueue(id:Object, preferredIndex:int = -1, callbackFunc:Function = null, parent:IFlexDisplayObject = null):void
Add a container to the Application's creation queue. | Application | |
|
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 | |
Closes the application's NativeWindow (the initial native window opened by the application). | WindowedApplication | ||
|
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 | |
|
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 | |
|
Creates an id reference to this IUIComponent object
on its parent document object. | UIComponent | |
|
Deletes the id reference to this IUIComponent object
on its parent document object. | UIComponent | |
|
Returns a UITextFormat object corresponding to the text styles
for this UIComponent. | UIComponent | |
| [override]
Dispatches an event into the event flow. | UIComponent | |
|
Shows or hides the focus indicator around this component. | UIComponent | |
| drawRoundRect(x:Number, y:Number, w:Number, h:Number, r:Object = null, c:Object = null, alpha:Object = null, rot:Object = null, gradient:String = null, ratios:Array = null, hole:Object = null):void
Programatically draws a rectangle into this skin's Graphics object. | UIComponent | |
|
Called by the effect instance when it stops playing on the component. | UIComponent | |
|
Called by the effect instance when it starts playing on the component. | UIComponent | |
|
Ends all currently playing effects on the component. | UIComponent | |
| [override]
Executes all the data bindings on this Container. | Container | |
|
Executes the bindings into this Container's child UIComponent objects. | Container | |
Closes the window and exits the application. | WindowedApplication | ||
|
Called after printing is complete. | UIComponent | |
|
Provides the automation object at the specified index. | UIComponent | |
|
Returns a rectangle that defines the area of the display object relative to the coordinate system
of the targetCoordinateSpace object. | DisplayObject | |
| [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 | |
|
A convenience method for determining whether to use the
explicit or measured height
| UIComponent | |
|
A convenience method for determining whether to use the
explicit or measured width
| UIComponent | |
|
Gets the object that currently has focus. | UIComponent | |
|
Returns an array of objects that lie under the specified point and are children
(or grandchildren, and so on) of this DisplayObjectContainer instance. | DisplayObjectContainer | |
|
Returns a rectangle that defines the boundary of the display object,
based on the coordinate system defined by the targetCoordinateSpace
parameter, excluding any strokes on shapes. | DisplayObject | |
|
Returns the item in the dataProvider that was used
by the specified Repeater to produce this Repeater, or
null if this Repeater isn't repeated. | UIComponent | |
|
Gets a style property that has been set anywhere in this
component's style lookup chain. | UIComponent | |
| [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 | |
|
Evaluates the bounding box of the display object to see if it overlaps or intersects with the
bounding box of the obj display object. | DisplayObject | |
|
Evaluates the display object to see if it overlaps or intersects with the
point specified by the x and y parameters. | DisplayObject | |
|
Returns a box Matrix which can be passed to the
drawRoundRect() method
as the rot parameter when drawing a horizontal gradient. | UIComponent | |
|
Initializes the internal structure of this component. | UIComponent | |
|
Initializes various properties which keep track of repeated instances
of this component. | UIComponent | |
|
Marks a component so that its updateDisplayList()
method gets called during a later screen update. | UIComponent | |
|
Marks a component so that its commitProperties()
method gets called during a later screen update. | UIComponent | |
|
Marks a component so that its measure()
method gets called during a later screen update. | UIComponent | |
|
Indicates whether an instance of the Object class is in the prototype chain of the object specified
as the parameter. | Object | |
|
Converts a three-dimensional point of the three-dimensional display
object's (local) coordinates to a two-dimensional point in the Stage (global) coordinates. | DisplayObject | |
| [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 | |
Maximizes the window, or does nothing if it's already maximized. | WindowedApplication | ||
|
Measures the specified HTML text, which may contain HTML tags such
as <font> and <b>,
assuming that it is displayed
in a single-line UITextField using a UITextFormat
determined by the styles of this UIComponent. | UIComponent | |
|
Measures the specified text, assuming that it is displayed
in a single-line UITextField using a UITextFormat
determined by the styles of this UIComponent. | UIComponent | |
Minimizes the window. | WindowedApplication | ||
|
Moves the component to a specified position within its parent. | UIComponent | |
|
Propagates style changes to the children. | UIComponent | |
Orders the window just behind another. | WindowedApplication | ||
Orders the window just in front of another. | WindowedApplication | ||
Orders the window behind all others in the same application. | WindowedApplication | ||
Orders the window in front of all others in the same application. | WindowedApplication | ||
|
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 | |
| [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 a listener from the EventDispatcher object. | EventDispatcher | |
|
Replays the specified event. | UIComponent | |
|
Resolves a child by using the id provided. | UIComponent | |
Restores the window (unmaximizes it if it's maximized, or
unminimizes it if it's minimized). | WindowedApplication | ||
| [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 | |
|
Sets the focus to this component. | UIComponent | |
|
Sets the availability of a dynamic property for loop operations. | Object | |
|
Sets a style property on this component instance. | UIComponent | |
|
Called when the visible property changes. | UIComponent | |
|
Lets the user drag the specified sprite. | Sprite | |
|
Ends the startDrag() method. | Sprite | |
|
Detects changes to style properties. | UIComponent | |
|
Flex calls the stylesInitialized() method when
the styles for a component are first initialized. | UIComponent | |
| [static]
Blocks the background processing of methods
queued by callLater(),
until resumeBackgroundProcessing() is called. | UIComponent | |
|
Swaps the z-order (front-to-back order) of the two specified child objects. | DisplayObjectContainer | |
|
Swaps the z-order (front-to-back order) of the child objects at the two specified index positions in the
child list. | DisplayObjectContainer | |
|
Returns the string representation of this object, formatted according to locale-specific conventions. | Object | |
| [override]
Returns a string indicating the location of this object
within the hierarchy of DisplayObjects in the Application. | FlexSprite | |
|
Validates the position and size of children and draws other
visuals. | UIComponent | |
|
Validate and update the properties and layout of this object
and redraw it, if necessary. | UIComponent | |
|
Used by layout logic to validate the properties of a component
by calling the commitProperties() method. | UIComponent | |
|
Validates the measured size of the component
If the LayoutManager.invalidateSize() method is called with
this ILayoutManagerClient, then the validateSize() method
is called when it's time to do measurements. | UIComponent | |
|
Handles both the valid and invalid events from a
validator assigned to this component. | UIComponent | |
|
Returns the primitive value of the specified object. | Object | |
|
Returns a box Matrix which can be passed to drawRoundRect()
as the rot parameter when drawing a vertical gradient. | UIComponent | |
|
Checks whether an event listener is registered with this EventDispatcher object or any of
its ancestors for the specified event type. | EventDispatcher | |
| Method | Defined By | ||
|---|---|---|---|
|
Adjust the focus rectangle. | UIComponent | |
| [override]
Used internally by the Dissolve Effect to add the overlay to the chrome of a container. | Container | |
|
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 | |
|
The event handler called when a UIComponent object gets focus. | UIComponent | |
|
The event handler called when a UIComponent object loses focus. | UIComponent | |
|
Finalizes the initialization of this component. | UIComponent | |
|
Initializes this component's accessibility code. | UIComponent | |
|
Typically overridden by components containing UITextField objects,
where the UITextField object gets focus. | UIComponent | |
|
The event handler called for a keyDown event. | UIComponent | |
|
The event handler called for a keyUp event. | UIComponent | |
|
Respond to size changes by setting the positions and sizes
of this container's borders. | Container | |
|
Calculates the default size, and optionally the default minimum size,
of the component. | UIComponent | |
Manages mouse down events on the window border. | WindowedApplication | ||
|
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 | |
| [override]
Respond to size changes by setting the positions and sizes
of this container's children. | Container | |
| Event | Summary | Defined By | ||
|---|---|---|---|---|
| [broadcast event] Dispatched when the Flash Player or AIR application gains operating system focus and becomes active. | EventDispatcher | ||
| Dispatched when the component is added to a container as a content child by using the addChild() or addChildAt() method. | UIComponent | ||
| Dispatched when a display object is added to the display list. | DisplayObject | ||
| Dispatched when a display object is added to the on stage display list, either directly or through the addition of a sub tree in which the display object is contained. | DisplayObject | ||
| Dispatched when this application is activated. | WindowedApplication | |||
| Dispatched after the Application has been initialized, processed by the LayoutManager, and attached to the display list. | Application | ||
| Dispatched when this application is deactivated. | WindowedApplication | |||
| Dispatched after a child has been added to a container. | Container | ||
| Dispatched after the index (among the container children) of a container child changes. | Container | ||
| Dispatched before a child of a container is removed. | Container | ||
| Dispatched when the user selects 'Clear' (or 'Delete') from the text context menu. | InteractiveObject | ||
| Dispatched when a user presses and releases the main button of the user's pointing device over the same InteractiveObject. | InteractiveObject | ||
| Dispatched after this application window has been closed. | WindowedApplication | |||
| Dispatched before the WindowedApplication window closes. | WindowedApplication | |||
| Dispatched when a user gesture triggers the context menu associated with this interactive object in an AIR application. | InteractiveObject | ||
| Dispatched when the user activates the platform specific accelerator key combination for a copy operation or selects 'Copy' from the text context menu. | InteractiveObject | ||
| Dispatched when the component has finished its construction, property processing, measuring, layout, and drawing. | UIComponent | ||
| Dispatched after the view state has changed. | UIComponent | ||
| Dispatched after the currentState property changes, but before the view state changes. | UIComponent | ||
| Dispatched when the user activates the platform specific accelerator key combination for a cut operation or selects 'Cut' from the text context menu. | InteractiveObject | ||
| Dispatched when the data property changes. | Container | ||
| [broadcast event] Dispatched when the Flash Player or AIR application operating loses system focus and is becoming inactive. | EventDispatcher | ||
| Dispatched after the display state changes to minimize, maximize or restore. | WindowedApplication | |||
| Dispatched before the display state changes to minimize, maximize or restore. | WindowedApplication | |||
| Dispatched when a user presses and releases the main button of a pointing device twice in rapid succession over the same InteractiveObject when that object's doubleClickEnabled flag is set to true. | InteractiveObject | ||
| Dispatched by the drag initiator (the component that is the source of the data being dragged) when the drag operation completes, either when you drop the dragged data onto a drop target or when you end the drag-and-drop operation without performing a drop. | UIComponent | ||
| Dispatched by the drop target when the user releases the mouse over it. | UIComponent | ||
| Dispatched by a component when the user moves the mouse over the component during a drag operation. | UIComponent | ||
| Dispatched by the component when the user drags outside the component, but does not drop the data onto the target. | UIComponent | ||
| Dispatched by a component when the user moves the mouse while over the component during a drag operation. | UIComponent | ||
| Dispatched by the drag initiator when starting a drag operation. | UIComponent | ||
| Dispatched after an effect ends. | UIComponent | ||
| Dispatched just before an effect starts. | UIComponent | ||
| [broadcast event] Dispatched when the playhead is entering a new frame. | DisplayObject | ||
| Dispatched after the component has returned to the root view state. | UIComponent | ||
| Dispatched when an error occurs anywhere in the application, such as an HTTPService, WebService, or RemoteObject fails. | Application | ||
| [broadcast event] Dispatched when the playhead is exiting the current frame. | DisplayObject | ||
| Dispatched before the component exits from the root view state. | UIComponent | ||
| Dispatched after a display object gains focus. | InteractiveObject | ||
| Dispatched after a display object loses focus. | InteractiveObject | ||
| [broadcast event] Dispatched after the constructors of frame display objects have run but before frame scripts have run. | DisplayObject | ||
| Dispatched when an object's state changes from visible to invisible. | UIComponent | ||
| Dispatched when the component has finished its construction and has all initialization properties set. | UIComponent | ||
| Dispatched when a component is monitored by a Validator and the validation failed. | UIComponent | ||
| Dispatched when an application is invoked. | WindowedApplication | |||
| Dispatched when the user presses a key. | InteractiveObject | ||
| Dispatched when the user attempts to change focus by using keyboard navigation. | InteractiveObject | ||
| Dispatched when the user releases a key. | InteractiveObject | ||
| Dispatched when a user presses and releases the middle button of the user's pointing device over the same InteractiveObject. | InteractiveObject | ||
| Dispatched when a user presses the middle pointing device button over an InteractiveObject instance. | InteractiveObject | ||
| Dispatched when a user releases the pointing device button over an InteractiveObject instance. | InteractiveObject | ||
| Dispatched when a user presses the pointing device button over an InteractiveObject instance. | InteractiveObject | ||
| Dispatched from a component opened using the PopUpManager when the user clicks outside it. | UIComponent | ||
| Dispatched when the user attempts to change focus by using a pointer device. | InteractiveObject | ||
| Dispatched when a user moves the pointing device while it is over an InteractiveObject. | InteractiveObject | ||
| Dispatched when the user moves a pointing device away from an InteractiveObject instance. | InteractiveObject | ||
| Dispatched when the user moves a pointing device over an InteractiveObject instance. | InteractiveObject | ||
| Dispatched when a user releases the pointing device button over an InteractiveObject instance. | InteractiveObject | ||
| Dispatched when a mouse wheel is spun over an InteractiveObject instance. | InteractiveObject | ||
| Dispatched from a component opened using the PopUpManager when the user scrolls the mouse wheel outside it. | UIComponent | ||
| Dispatched when the object has moved. | UIComponent | ||
| Dispatched before the WindowedApplication object moves, or while the WindowedApplication object is being dragged. | WindowedApplication | |||
| Dispatched by the drag initiator InteractiveObject when the user releases the drag gesture. | InteractiveObject | ||
| Dispatched by the target InteractiveObject when a dragged object is dropped on it and the drop has been accepted with a call to DragManager.acceptDragDrop(). | InteractiveObject | ||
| Dispatched by an InteractiveObject when a drag gesture enters its boundary. | InteractiveObject | ||
| Dispatched by an InteractiveObject when a drag gesture leaves its boundary. | InteractiveObject | ||
| Dispatched by an InteractiveObject continually while a drag gesture remains within its boundary. | InteractiveObject | ||
| Dispatched at the beginning of a drag operation by the InteractiveObject that is specified as the drag initiator in the DragManager.doDrag() call. | InteractiveObject | ||
| Dispatched during a drag operation by the InteractiveObject that is specified as the drag initiator in the DragManager.doDrag() call. | InteractiveObject | ||
| Dispatched when the computer connects to or disconnects from the network. | WindowedApplication | |||
| Dispatched when the user activates the platform specific accelerator key combination for a paste operation or selects 'Paste' from the text context menu. | InteractiveObject | ||
| Dispatched at the beginning of the component initialization sequence. | UIComponent | ||
| Dispatched when the component is removed from a container as a content child by using the removeChild() or removeChildAt() method. | UIComponent | ||
| Dispatched when a display object is about to be removed from the display list. | DisplayObject | ||
| Dispatched when a display object is about to be removed from the display list, either directly or through the removal of a sub tree in which the display object is contained. | DisplayObject | ||
| [broadcast event] Dispatched when the display list is about to be updated and rendered. | DisplayObject | ||
| Dispatched when the component is resized. | UIComponent | ||
| Dispatched before the WindowedApplication object is resized, or while the WindowedApplication object boundaries are being dragged. | WindowedApplication | |||
| Dispatched when a user presses and releases the right button of the user's pointing device over the same InteractiveObject. | InteractiveObject | ||
| Dispatched when a user presses the pointing device button over an InteractiveObject instance. | InteractiveObject | ||
| Dispatched when a user releases the pointing device button over an InteractiveObject instance. | InteractiveObject | ||
| Dispatched when the user moves a pointing device away from an InteractiveObject instance. | InteractiveObject | ||
| Dispatched when the user moves a pointing device over an InteractiveObject instance. | InteractiveObject | ||
| Dispatched when the user manually scrolls the container. | Container | ||
| Dispatched when the user activates the platform specific accelerator key combination for a select all operation or selects 'Select All' from the text context menu. | InteractiveObject | ||
| Dispatched when an object's state changes from invisible to visible. | UIComponent | ||
| Dispatched when the value of the object's tabChildren flag changes. | InteractiveObject | ||
| Dispatched when the object's tabEnabled flag changes. | InteractiveObject | ||
| Dispatched when the value of the object's tabIndex property changes. | InteractiveObject | ||
| Dispatched when a user enters one or more characters of text. | InteractiveObject | ||
| Dispatched by the component when it is time to create a ToolTip. | UIComponent | ||
| Dispatched by the component when its ToolTip has been hidden and will be discarded soon. | UIComponent | ||
| Dispatched by the component when its ToolTip is about to be hidden. | UIComponent | ||
| Dispatched by the component when its ToolTip is about to be shown. | UIComponent | ||
| Dispatched by the component when its ToolTip has been shown. | UIComponent | ||
| Dispatched by a component whose toolTip property is set, as soon as the user moves the mouse over it. | UIComponent | ||
| Dispatched when an object has had its commitProperties(), measure(), and updateDisplayList() methods called (if needed). | UIComponent | ||
| Dispatched when a component is monitored by a Validator and the validation succeeded. | UIComponent | ||
| Dispatched when values are changed programmatically or by user interaction. | UIComponent | ||
| Dispatched after this application window has been activated. | WindowedApplication | |||
| Dispatched when the WindowedApplication completes its initial layout. | WindowedApplication | |||
| Dispatched after this application window has been deactivated. | WindowedApplication | |||
| Dispatched after the WindowedApplication object moves. | WindowedApplication | |||
| Dispatched after the underlying NativeWindow object is resized. | WindowedApplication | |||
| Style | Description | Defined By | ||
|---|---|---|---|---|
| Type: Number CSS Inheritance: no Alpha level of the color defined by the backgroundColor property, of the image or SWF file defined by the backgroundImage style. | Container | ||
| 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: uint Format: Color CSS Inheritance: no Background color of a component. | Container | ||
| Type: uint Format: Color CSS Inheritance: yes Background color of the component when it is disabled. | Container | ||
| Type: Array CSS Inheritance: no Specifies the alpha transparency values used for the background gradient fill of the application. | Application | ||
| Type: Array Format: Color CSS Inheritance: no Specifies the colors used to tint the background gradient fill of the application. | Application | ||
| Type: Object Format: File CSS Inheritance: no Background image of a component. | Container | ||
| Type: String CSS Inheritance: no Scales the image specified by backgroundImage to different percentage sizes. | Container | ||
| Type: uint Format: Color CSS Inheritance: yes Determines the color of a ProgressBar. | 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: uint Format: Color CSS Inheritance: no Color of the border. | Container | ||
| Type: String CSS Inheritance: no Bounding box sides. | Container | ||
| Type: Class CSS Inheritance: no The border skin class of the component. | Container | ||
| Type: String CSS Inheritance: no Bounding box style. | Container | ||
| Type: Number Format: Length CSS Inheritance: no Bounding box thickness. | Container | ||
| Type: String CSS Inheritance: no The vertical distance in pixels from the lower edge of the component to the lower edge of its content area. | UIComponent | ||
buttonAlignment | Type: String CSS Inheritance: yes Position of buttons in title bar. Possible values: "left",
"right", "auto".
A value of "auto". | WindowedApplication | ||
buttonPadding | Type: Number CSS Inheritance: yes Defines the distance between the titleBar buttons. The default value is 2. | WindowedApplication | ||
closeButtonSkin | Type: Class CSS Inheritance: no Skin for close button when using Flex chrome. The default value is mx.skins.halo.WindowCloseButtonSkin. | WindowedApplication | ||
| Type: uint Format: Color CSS Inheritance: yes Color of text in the component, including the component label. | Container | ||
| Type: Number Format: Length CSS Inheritance: no Radius of component corners. | 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 drop shadow. | Container | ||
| Type: Boolean CSS Inheritance: no Boolean property that specifies whether the component has a visible drop shadow. | Container | ||
| Type: uint Format: Color CSS Inheritance: yes Color of the component highlight when validation fails. | UIComponent | ||
| Type: String CSS Inheritance: no Blend mode used by the focus rectangle. | UIComponent | ||
| Type: Class CSS Inheritance: no Skin used to draw the focus rectangle. | UIComponent | ||
| Type: Number Format: Length CSS Inheritance: no Thickness, in pixels, of the focus rectangle outline. | UIComponent | ||
| 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 | ||
gripperPadding | Type: Number Format: Length CSS Inheritance: no The extra space around the gripper. The total area of the gripper plus the padding around the edges is the hit area for the gripper resizing. The default value is 3. | WindowedApplication | ||
gripperStyleName | Type: String CSS Inheritance: no Style declaration for the skin of the gripper. The default value is "gripperStyle". | WindowedApplication | ||
headerHeight | Type: Number Format: Length CSS Inheritance: no The explicit height of the header. If this style is not set, the header height is calculated from the largest of the text height, the button heights, and the icon height. The default value is undefined. | WindowedApplication | ||
| Type: String CSS Inheritance: no Horizontal alignment of children in the container. | LayoutContainer | ||
| 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 | ||
| Type: Number Format: Length CSS Inheritance: no Number of pixels between children in the horizontal direction. | LayoutContainer | ||
| 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's content area to the left edge of the component. | UIComponent | ||
| Type: Number CSS Inheritance: yes The number of additional pixels to appear between each character. | Container | ||
maximizeButtonSkin | Type: Class CSS Inheritance: no Skin for maximize button when using Flex chrome. The default value is mx.skins.halo.WindowMaximizeButtonSkin. | WindowedApplication | ||
minimizeButtonSkin | Type: Class CSS Inheritance: no Skin for minimize button when using Flex chrome. The default value is mx.skins.halo.WindowMinimizeButtonSkin. | WindowedApplication | ||
| Type: Number CSS Inheritance: yes Modality of components launched by the PopUp Manager is simulated by creating a large translucent overlay underneath the component. | Application | ||
| Type: Number CSS Inheritance: yes The blur applied to the application while a modal window is open. | Application | ||
| Type: uint Format: Color CSS Inheritance: yes Color of the modal overlay layer. | Application | ||
| Type: Number Format: Time CSS Inheritance: yes Duration, in milliseconds, of the modal transparency effect that plays when a modal window opens or closes. | Application | ||
| Type: Number Format: Length CSS Inheritance: no Number of pixels between the application's bottom border and its content area. | Application | ||
| 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 | ||
| Type: Number Format: Length CSS Inheritance: no Number of pixels between the application's top border and its content area. | Application | ||
restoreButtonSkin | Type: Class CSS Inheritance: no Skin for restore button when using Flex chrome. This style is ignored for Mac OS X. The default value is mx.skins.halo.WindowRestoreButtonSkin. | WindowedApplication | ||
| Type: String CSS Inheritance: no The horizontal distance in pixels from the right edge of the component to the right edge of its content area. | UIComponent | ||
| Type: String CSS Inheritance: no Direction of the drop shadow. | Container | ||
| Type: Number Format: Length CSS Inheritance: no Distance of the drop shadow. | Container | ||
showFlexChrome | Type: Boolean CSS Inheritance: no Determines whether the window draws its own Flex Chrome or depends on the developer to draw chrome. Changing this style once the window is open has no effect. The default value is true. | WindowedApplication | ||
statusBarBackgroundColor | Type: uint Format: Color CSS Inheritance: yes The colors used to draw the status bar. The default value is 0xC0C0C0. | WindowedApplication | ||
statusBarBackgroundSkin | Type: Class CSS Inheritance: yes The status bar background skin. The default value is mx.skins.halo.StatusBarBackgroundSkin. | WindowedApplication | ||
statusTextStyleName | Type: String CSS Inheritance: yes Style declaration for the status text. The default value is undefined. | WindowedApplication | ||
| 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: Number Format: Length CSS Inheritance: yes Offset of first line of text from the left side of the container, in pixels. | Container | ||
| Type: uint Format: Color CSS Inheritance: yes Theme color of a component. | UIComponent | ||
titleAlignment | Type: String CSS Inheritance: yes Position of the title in title bar. The possible values are "left",
"center", "auto"
A value of "auto". | WindowedApplication | ||
titleBarBackgroundSkin | Type: Class CSS Inheritance: yes The title background skin. The default value is mx.skins.halo.ApplicationTitleBarBackgroundSkin. | WindowedApplication | ||
titleBarButtonPadding | Type: Number CSS Inheritance: true The distance between the furthest out title bar button and the edge of the title bar. The default value is 5. | WindowedApplication | ||
titleBarColors | Type: Array Format: Color CSS Inheritance: yes An 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 undefined, which
makes the header background the same as the
panel background.
The default value is [ 0x000000, 0x000000 ]. | WindowedApplication | ||
titleTextStyleName | Type: String CSS Inheritance: yes The style name for the title text. The default value is undefined. | WindowedApplication | ||
| Type: String CSS Inheritance: no The vertical distance in pixels from the top edge of the control's content area to the top edge of the component. | UIComponent | ||
| Type: String CSS Inheritance: no Vertical alignment of children in the container. | LayoutContainer | ||
| 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 | ||
| Type: Number Format: Length CSS Inheritance: no Number of pixels between children in the vertical direction. | LayoutContainer | ||
| Type: String CSS Inheritance: no The name of the vertical scrollbar style. | Container | ||
| Effect | Description | Defined By | ||
|---|---|---|---|---|
| Triggering Event: added Played when the component is added as a child to a Container. | UIComponent | ||
closeEffect | Triggering Event: windowClose Played when the window is closed. | WindowedApplication | ||
| Triggering Event: creationComplete Played when the component is created. | UIComponent | ||
| Triggering Event: focusIn Played when the component gains keyboard focus. | UIComponent | ||
| Triggering Event: focusOut Played when the component loses keyboard focus. | UIComponent | ||
| Triggering Event: hide Played when the component becomes invisible. | UIComponent | ||
minimizeEffect | Triggering Event: windowMinimize Played when the component is minimized. | WindowedApplication | ||
| 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: removed Played when the component is removed from a Container. | UIComponent | ||
| Triggering Event: resize Played when the component is resized. | UIComponent | ||
| 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 | ||
unminimizeEffect | Triggering Event: windowUnminimize Played when the component is unminimized. | WindowedApplication | ||
| alwaysInFront | property |
alwaysInFront:BooleanDetermines whether the underlying NativeWindow is always in front of other windows.
The default value is false.
public function get alwaysInFront():Boolean public function set alwaysInFront(value:Boolean):void| applicationID | property |
applicationID:String [read-only] The identifier that AIR uses to identify the application.
public function get applicationID():String| autoExit | property |
autoExit:BooleanSpecifies whether the AIR application will quit when the last window closes or will continue running in the background.
The default value is true.
public function get autoExit():Boolean public function set autoExit(value:Boolean):void| closed | property |
closed:Boolean [read-only] Returns true when the underlying window has been closed.
public function get closed():Boolean| dockIconMenu | property |
dockIconMenu:FlexNativeMenuThe dock icon menu. Some operating systems do not support dock icon menus.
public function get dockIconMenu():FlexNativeMenu public function set dockIconMenu(value:FlexNativeMenu):void| maxHeight | property |
maxHeight:Number[override] Specifies the maximum height of the application's window.
override public function get maxHeight():Number override public function set maxHeight(value:Number):void| maximizable | property |
maximizable:Boolean [read-only] Specifies whether the window can be maximized.
public function get maximizable():Boolean| maxWidth | property |
maxWidth:Number[override] Specifies the maximum width of the application's window.
override public function get maxWidth():Number override public function set maxWidth(value:Number):void| menu | property |
menu:FlexNativeMenuThe application menu for operating systems that support an application menu, or the window menu of the application's initial window for operating systems that support window menus.
public function get menu():FlexNativeMenu public function set menu(value:FlexNativeMenu):void| minHeight | property |
minHeight:Number[override] Specifies the minimum height of the application's window.
This property can be used as the source for data binding. When this property is modified, it dispatches the windowComplete event.
override public function get minHeight():Number override public function set minHeight(value:Number):void| minimizable | property |
minimizable:Boolean [read-only] Specifies whether the window can be minimized.
public function get minimizable():Boolean| minWidth | property |
minWidth:Number[override] Specifies the minimum width of the application's window.
This property can be used as the source for data binding. When this property is modified, it dispatches the windowComplete event.
override public function get minWidth():Number override public function set minWidth(value:Number):void| nativeApplication | property |
nativeApplication:NativeApplication [read-only] The NativeApplication object representing the AIR application.
public function get nativeApplication():NativeApplication| nativeWindow | property |
nativeWindow:NativeWindow [read-only] The NativeWindow used by this WindowedApplication component (the initial native window of the application).
public function get nativeWindow():NativeWindow| resizable | property |
resizable:Boolean [read-only] Specifies whether the window can be resized.
public function get resizable():Boolean| showGripper | property |
showGripper:Boolean
If true, the gripper is visible.
On Mac OS X a window with systemChrome
set to "standard"
always has an operating system gripper, so this property is ignored
in that case.
The default value is true.
public function get showGripper():Boolean public function set showGripper(value:Boolean):void| showStatusBar | property |
showStatusBar:Boolean
If true, the status bar is visible.
The default value is true.
public function get showStatusBar():Boolean public function set showStatusBar(value:Boolean):void| showTitleBar | property |
showTitleBar:Boolean
If true, the window's title bar is visible.
The default value is true.
public function get showTitleBar():Boolean public function set showTitleBar(value:Boolean):void| status | property |
status:StringThe string that appears in the status bar, if it is visible.
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.
public function get status():String public function set status(value:String):void| statusBar | property |
statusBar:UIComponent [read-only] The UIComponent that displays the status bar.
public function get statusBar():UIComponent| statusBarFactory | property |
statusBarFactory:IFactoryThe IFactory that creates an instance to use as the status bar. The default value is an IFactory for StatusBar.
If you write a custom status bar class, it should expose
a public property named status.
This property can be used as the source for data binding. When this property is modified, it dispatches the statusBarFactoryChanged event.
public function get statusBarFactory():IFactory public function set statusBarFactory(value:IFactory):void| statusBarStyleFilters | property |
statusBarStyleFilters:Object [read-only] Set of styles to pass from the WindowedApplication to the status bar.
protected function get statusBarStyleFilters():ObjectSee also
| systemChrome | property |
systemChrome:String [read-only] Specifies the type of system chrome (if any) the window has. The set of possible values is defined by the constants in the NativeWindowSystemChrome class.
public function get systemChrome():StringSee also
| systemTrayIconMenu | property |
systemTrayIconMenu:FlexNativeMenuThe system tray icon menu. Some operating systems do not support system tray icon menus.
public function get systemTrayIconMenu():FlexNativeMenu public function set systemTrayIconMenu(value:FlexNativeMenu):void| title | property |
title:StringThe title that appears in the window title bar and the taskbar. If you are using system chrome and you set this property to something different than the <title> tag in your application.xml, you may see the title from the XML file appear briefly first.
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.
public function get title():String public function set title(value:String):void| titleBar | property |
titleBar:UIComponent [read-only] The UIComponent that displays the title bar.
public function get titleBar():UIComponent| titleBarFactory | property |
titleBarFactory:IFactoryThe IFactory that creates an instance to use as the title bar. The default value is an IFactory for TitleBar.
If you write a custom title bar class, it should expose
public properties named titleIcon
and title.
This property can be used as the source for data binding. When this property is modified, it dispatches the titleBarFactoryChanged event.
public function get titleBarFactory():IFactory public function set titleBarFactory(value:IFactory):void| titleBarStyleFilters | property |
titleBarStyleFilters:Object [read-only] Set of styles to pass from the WindowedApplication to the titleBar.
protected function get titleBarStyleFilters():ObjectSee also
| titleIcon | property |
titleIcon:ClassThe Class (usually an image) used to draw the title bar icon.
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.
public function get titleIcon():Class public function set titleIcon(value:Class):void| transparent | property |
transparent:Boolean [read-only] Specifies whether the window is transparent.
public function get transparent():Boolean| type | property |
type:String [read-only] Specifies the type of NativeWindow that this component represents. The set of possible values is defined by the constants in the NativeWindowType class.
public function get type():StringSee also
| WindowedApplication | () | Constructor |
public function WindowedApplication()Constructor.
| activate | () | method |
public function activate():voidActivates the underlying NativeWindow (even if this application is not the active one).
| close | () | method |
public function close():voidCloses the application's NativeWindow (the initial native window opened by the application). This action is cancelable.
| exit | () | method |
public function exit():voidCloses the window and exits the application.
| maximize | () | method |
public function maximize():voidMaximizes the window, or does nothing if it's already maximized.
| minimize | () | method |
public function minimize():voidMinimizes the window.
| mouseDownHandler | () | method |
protected function mouseDownHandler(event:MouseEvent):voidManages mouse down events on the window border.
Parameters
event:MouseEvent |
| orderInBackOf | () | method |
public function orderInBackOf(window:IWindow):Boolean
Orders the window just behind another. To order the window behind
a NativeWindow that does not implement IWindow, use this window's
NativeWindow's orderInBackOf() method.
Parameters
window:IWindow — The IWindow (Window or WindowedAplication)
to order this window behind.
|
Boolean — true if the window was succesfully sent behind;
false if the window is invisible or minimized.
|
| orderInFrontOf | () | method |
public function orderInFrontOf(window:IWindow):Boolean
Orders the window just in front of another. To order the window
in front of a NativeWindow that does not implement IWindow, use this
window's NativeWindow's orderInFrontOf() method.
Parameters
window:IWindow — The IWindow (Window or WindowedAplication)
to order this window in front of.
|
Boolean — true if the window was succesfully sent in front;
false if the window is invisible or minimized.
|
| orderToBack | () | method |
public function orderToBack():BooleanOrders the window behind all others in the same application.
ReturnsBoolean — true if the window was succesfully sent to the back;
false if the window is invisible or minimized.
|
| orderToFront | () | method |
public function orderToFront():BooleanOrders the window in front of all others in the same application.
ReturnsBoolean — true if the window was succesfully sent to the front;
false if the window is invisible or minimized.
|
| restore | () | method |
public function restore():voidRestores the window (unmaximizes it if it's maximized, or unminimizes it if it's minimized).
| applicationActivate | Event |
mx.events.AIREventmx.events.AIREvent.APPLICATION_ACTIVATEDispatched when this application is activated.
The AIREvent.APPLICATION_ACTIVATE constant defines the value of thetype property of the event object for an
applicationActivate event.
The properties of the event object have the following values:
| Property | Value |
|---|---|
bubbles | false |
cancelable | false |
currentTarget | The Object that defines the
event listener that handles the event. For example, if you use
myButton.addEventListener() to register an event listener,
myButton is the value of the currentTarget. |
file | The File object associated with this event. |
target | The Object that dispatched the event;
it is not always the Object listening for the event.
Use the currentTarget property to always access the
Object listening for the event. |
type | AIREvent.APPLICATION_ACTIVATE |
| applicationDeactivate | Event |
mx.events.AIREventmx.events.AIREvent.APPLICATION_DEACTIVATEDispatched when this application is deactivated.
The AIREvent.APPLICATION_DEACTIVATE constant defines the value of thetype property of the event object for an
applicationDeactivate event.
The properties of the event object have the following values:
| Property | Value |
|---|---|
bubbles | false |
cancelable | false |
currentTarget | The Object that defines the
event listener that handles the event. For example, if you use
myButton.addEventListener() to register an event listener,
myButton is the value of the currentTarget. |
file | The File object associated with this event. |
target | The Object that dispatched the event;
it is not always the Object listening for the event.
Use the currentTarget property to always access the
Object listening for the event. |
type | AIREvent.APPLICATION_DEACTIVATE |
| close | Event |
flash.events.Eventflash.events.Event.CLOSEDispatched after this application window has been closed.
TheEvent.CLOSE constant defines the value of the type property of a close event object.
This event has the following properties:
| Property | Value |
|---|---|
bubbles | false |
cancelable | false; there is no default behavior to cancel. |
currentTarget | The object that is actively processing the Event object with an event listener. |
target | The object whose connection has been closed. |
See also
| closing | Event |
flash.events.Eventflash.events.Event.CLOSINGDispatched before the WindowedApplication window closes. Cancelable.
TheEvent.CLOSING constant defines the value of the
type property of a closing event object.
This event has the following properties:
| Property | Value |
|---|---|
bubbles | false |
cancelable | true; canceling this event object stops the close operation. |
currentTarget | The object that is actively processing the Event object with an event listener. |
target | The object whose connection is to be closed. |
See also
| displayStateChange | Event |
flash.events.NativeWindowDisplayStateEventflash.events.NativeWindowDisplayStateEvent.DISPLAY_STATE_CHANGEDispatched after the display state changes to minimize, maximize or restore.
Defines the value of thetype property of a displayStateChange event object.
This event has the following properties:
| Properties | Values |
|---|---|
afterDisplayState | The old display state of the window. |
beforeDisplayState | The new display state of the window. |
target | The NativeWindow instance that has just changed state. |
bubbles | No. |
currentTarget | Indicates the object that is actively processing the Event object with an event listener. |
cancelable | false; There is no default behavior to cancel. |
| displayStateChanging | Event |
flash.events.NativeWindowDisplayStateEventflash.events.NativeWindowDisplayStateEvent.DISPLAY_STATE_CHANGINGDispatched before the display state changes to minimize, maximize or restore.
Defines the value of thetype property of a displayStateChanging event object.
This event has the following properties:
| Properties | Values |
|---|---|
afterDisplayState | The display state of the window before the pending change. |
beforeDisplayState | The display state of the window after the pending change. |
target | The NativeWindow instance that has just changed state. |
bubbles | No. |
currentTarget | Indicates the object that is actively processing the Event object with an event listener. |
cancelable | true; canceling the event will prevent the change. |
| invoke | Event |
flash.events.InvokeEventeventTypeDispatched when an application is invoked.
| moving | Event |
flash.events.NativeWindowBoundsEventflash.events.NativeWindowBoundsEvent.MOVINGDispatched before the WindowedApplication object moves, or while the WindowedApplication object is being dragged.
Defines the value of thetype property of a moving event object.
This event has the following properties:
| Properties | Values |
|---|---|
afterBounds | The bounds of the window after the pending change. |
beforeBounds | The bounds of the window before the pending change. |
bubbles | No. |
cancelable | true; cancelling the event will prevent the window move. |
currentTarget | Indicates the object that is actively processing the Event object with an event listener. |
target | The NativeWindow object that has just changed state. |
| networkChange | Event |
flash.events.Eventflash.events.Event.NETWORK_CHANGEDispatched when the computer connects to or disconnects from the network.
TheEvent.NETWORK_CHANGE constant defines the value of the type property of a networkChange event object.
This event has the following properties:
| Property | Value |
|---|---|
bubbles | false |
cancelable | false; there is no default behavior to cancel. |
currentTarget | The object that is actively processing the Event object with an event listener. |
target | The NativeApplication object. |
| resizing | Event |
flash.events.NativeWindowBoundsEventflash.events.NativeWindowBoundsEvent.RESIZINGDispatched before the WindowedApplication object is resized, or while the WindowedApplication object boundaries are being dragged.
Defines the value of thetype property of a resizing event object.
This event has the following properties:
| Properties | Values |
|---|---|
afterBounds | The bounds of the window after the pending change. |
beforeBounds | The bounds of the window before the pending change. |
target | The NativeWindow object that has just changed state. |
bubbles | No. |
currentTarget | Indicates the object that is actively processing the Event object with an event listener. |
cancelable | true; cancelling the event will prevent the window move. |
| windowActivate | Event |
mx.events.AIREventmx.events.AIREvent.WINDOW_ACTIVATEDispatched after this application window has been activated.
The AIREvent.WINDOW_ACTIVATE constant defines the value of thetype property of the event object for a
windowActivate event.
The properties of the event object have the following values:
| Property | Value |
|---|---|
bubbles | false |
cancelable | false |
currentTarget | The Object that defines the
event listener that handles the event. For example, if you use
myButton.addEventListener() to register an event listener,
myButton is the value of the currentTarget. |
file | The File object associated with this event. |
target | The Object that dispatched the event;
it is not always the Object listening for the event.
Use the currentTarget property to always access the
Object listening for the event. |
type | AIREvent.WINDOW_ACTIVATE |
| windowComplete | Event |
mx.events.AIREventmx.events.AIREvent.WINDOW_COMPLETEDispatched when the WindowedApplication completes its initial layout. By default, the WindowedApplication will be visbile at this time.
The AIREvent.WINDOW_COMPLETE constant defines the value of thetype property of the event object for an
windowComplete event.
The properties of the event object have the following values:
| Property | Value |
|---|---|
bubbles | false |
cancelable | false |
currentTarget | The Object that defines the
event listener that handles the event. For example, if you use
myButton.addEventListener() to register an event listener,
myButton is the value of the currentTarget. |
file | The File object associated with this event. |
target | The Object that dispatched the event;
it is not always the Object listening for the event.
Use the currentTarget property to always access the
Object listening for the event. |
type | AIREvent.WINDOW_COMPLETE |
| windowDeactivate | Event |
mx.events.AIREventmx.events.AIREvent.WINDOW_DEACTIVATEDispatched after this application window has been deactivated.
The AIREvent.WINDOW_DEACTIVATE constant defines the value of thetype property of the event object for a
windowDeactivate event.
The properties of the event object have the following values:
| Property | Value |
|---|---|
bubbles | false |
cancelable | false |
currentTarget | The Object that defines the
event listener that handles the event. For example, if you use
myButton.addEventListener() to register an event listener,
myButton is the value of the currentTarget. |
file | The File object associated with this event. |
target | The Object that dispatched the event;
it is not always the Object listening for the event.
Use the currentTarget property to always access the
Object listening for the event. |
type | AIREvent.WINDOW_DEACTIVATE |
| windowMove | Event |
mx.events.FlexNativeWindowBoundsEventmx.events.FlexNativeWindowBoundsEvent.WINDOW_MOVEDispatched after the WindowedApplication object moves.
The FlexNativeWindowBoundsEvent.WINDOW_MOVE constant defines the value of thetype property of the event object for a
windowMove event.
The properties of the event object have the following values:
| Property | Value |
|---|---|
afterBounds | The bounds of the window after the bounds changed. |
beforeBounds | The bounds of the window before the bounds changed. |
bubbles | false |
cancelable | false |
currentTarget | The Object that defines the
event listener that handles the event. For example, if you use
myButton.addEventListener() to register an event listener,
myButton is the value of the currentTarget. |
file | The File object associated with this event. |
target | The Object that dispatched the event;
it is not always the Object listening for the event.
Use the currentTarget property to always access the
Object listening for the event. |
type | FlexNativeWindowBoundsEvent.WINDOW_MOVE |
| windowResize | Event |
mx.events.FlexNativeWindowBoundsEventmx.events.FlexNativeWindowBoundsEvent.WINDOW_RESIZEDispatched after the underlying NativeWindow object is resized.
The FlexNativeWindowBoundsEvent.WINDOW_RESIZE constant defines the value of thetype property of the event object for a
windowResize event.
The properties of the event object have the following values:
| Property | Value |
|---|---|
afterBounds | The bounds of the window after the bounds changed. |
beforeBounds | The bounds of the window before the bounds changed. |
bubbles | false |
cancelable | false |
currentTarget | The Object that defines the
event listener that handles the event. For example, if you use
myButton.addEventListener() to register an event listener,
myButton is the value of the currentTarget. |
file | The File object associated with this event. |
target | The Object that dispatched the event;
it is not always the Object listening for the event.
Use the currentTarget property to always access the
Object listening for the event. |
type | FlexNativeWindowBoundsEvent.WINDOW_RESIZE |
