| Package | spark.components |
| Class | public class WindowedApplication |
| Inheritance | WindowedApplication  Application SkinnableContainer SkinnableContainerBase SkinnableComponent UIComponent FlexSprite Sprite DisplayObjectContainer InteractiveObject DisplayObject EventDispatcher Object |
| Implements | IWindow |
| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 4 |
| Runtime Versions: | AIR 1.5 |
The WindowedApplication serves two roles. It is a replacement for the <mx:WindowedApplication> 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.
A WindowedApplication is the top-level application of a Flex-based AIR application. It is not designed to be loaded by other Flex applications. If a WindowedApplication needs to load other applications, use the Application class as container for those applications. If other windows are required, use the Window class as a container for those windows.
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
Show MXML Syntax
Hide MXML SyntaxThe <mx:WindowedApplication> tag inherits all of the tag
attributes of its superclass and adds the following tag attributes:
<s:WindowedApplication
Properties
alwaysInFront="false"
autoExit="true"
backgroundFrameRate="-1"
dockIconMenu="null"
menu="null"
showStatusBar="true"
status=""
systemTrayIconMenu="null"
title=""
titleIcon="null"
useNativeDragManager="true"
Styles
backgroundAlpha="1.0"
backgroundColor="0xFFFFFF"
resizeAffordanceWidth="6"
Effects
closeEffect="No default"
minimizeEffect="No default"
unminimizeEffect="No default"
Events
applicationActivate="No default"
applicationDeactivate="No default"
close="No default"
closing="No default"
displayStateChange="No default"
displayStateChanging="No default"
invoke="No default"
moving="No default"
networkChange="No default"
resizing="No default"
windowActivate="No default"
windowComplete="No default"
windowDeactivate="No default"
windowMove="No default"
windowResize="No default"
/>
Default MXML PropertymxmlContentFactory
More examples
Displaying a directory structure
with Flex AIR
Creating and using a Window container
Controlling window chrome
Defining custom skin classes
Creating and using a Window container
Controlling window chrome
Defining custom skin classes
Learn more
Related API Elements
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 | |
| alwaysInFront : Boolean
Determines whether the underlying NativeWindow is always in front of other windows. | WindowedApplication | ||
| applicationDPI : Number
The DPI of the application. | Application | |
| applicationID : String [read-only]
The identifier that AIR uses to identify the application. | WindowedApplication | ||
| aspectRatio : String [read-only]
Returns the aspect ratio of the top level stage based on its width
and height. | Application | |
| 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. | SkinnableContainer | |
| 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 | |
| backgroundFrameRate : Number
Specifies the frame rate to use when the application is inactive. | WindowedApplication | ||
| baseline : Object
For components, this layout constraint property is a
facade on top of the similarly-named style. | UIComponent | |
| baselinePosition : Number [override] [read-only]
The y-coordinate of the baseline
of the first line of text of the component. | SkinnableComponent | |
| 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 | |
| bottom : Object
For components, this layout constraint property is a
facade on top of the similarly-named style. | UIComponent | |
| buttonMode : Boolean
Specifies the button mode of this sprite. | Sprite | |
| cacheAsBitmap : Boolean
If set to true, Flash runtimes cache an internal bitmap representation of the
display object. | DisplayObject | |
| cacheAsBitmapMatrix : Matrix
If non-null, this Matrix object defines how a display object is rendered when
cacheAsBitmap is set to true. | 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 | |
| className : String [read-only]
The name of this instance's class, such as "Button". | UIComponent | |
| closed : Boolean [read-only]
Returns true when the underlying window has been closed. | WindowedApplication | ||
| colorCorrection : String
The value of the stage's colorCorrection property. | Application | |
| constructor : Object
A reference to the class object or constructor function for a given object instance. | Object | |
| contentMouseX : Number [read-only]
Returns the x position of the mouse, in the content coordinate system. | UIComponent | |
| contentMouseY : Number [read-only]
Returns the y position of the mouse, in the content coordinate system. | UIComponent | |
| contextMenu : NativeMenu
Specifies the context menu associated with this object. | InteractiveObject | |
| creationPolicy : String
Content creation policy for this component. | SkinnableContainer | |
| 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 | |
| defaultButton : IFlexDisplayObject
The Button control designated as the default button for the container. | SkinnableContainerBase | |
| deferredContentCreated : Boolean [read-only]
Contains true if deferred content has been created. | SkinnableContainer | |
| 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 | |
| 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 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 | |
| hasFocusableChildren : Boolean
A flag that indicates whether child objects can receive focus. | UIComponent | |
| hasLayoutMatrix3D : Boolean [read-only]
Contains true if the element has 3D Matrix. | UIComponent | |
| height : Number [override]
Number that specifies the height of the component, in pixels,
in the parent's coordinates. | UIComponent | |
| hitArea : Sprite
Designates another sprite to serve as the hit area for a sprite. | Sprite | |
| horizontalCenter : Object
For components, this layout constraint property is a
facade on top of the similarly-named style. | UIComponent | |
| 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 | |
| layout : LayoutBase
The layout object for this container. | SkinnableContainer | |
| layoutMatrix3D : Matrix3D [write-only]
The transform matrix that is used to calculate a component's layout
relative to its siblings. | UIComponent | |
| left : Object
For components, this layout constraint property is a
facade on top of the similarly-named style. | UIComponent | |
| 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 | |
| maximizable : Boolean [read-only]
Specifies whether the window can be maximized. | WindowedApplication | ||
| 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 | |
| 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 | ||
| metaData : Object
Obtains the meta data object of the DisplayObject instance if meta data was stored alongside the
the instance of this DisplayObject in the SWF file through a PlaceObject4 tag. | DisplayObject | |
| minHeight : Number
The minimum recommended height of the component to be considered
by the parent during layout. | UIComponent | |
| minimizable : Boolean [read-only]
Specifies whether the window can be minimized. | WindowedApplication | ||
| 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, or user input device, enabled. | DisplayObjectContainer | |
| mouseEnabled : Boolean
Specifies whether this object receives mouse, or other user input, messages. | InteractiveObject | |
| mouseFocusEnabled : Boolean
Whether you can receive focus when clicked on. | UIComponent | |
| mouseX : Number [read-only]
Indicates the x coordinate of the mouse or user input device position, in pixels. | DisplayObject | |
| mouseY : Number [read-only]
Indicates the y coordinate of the mouse or user input device position, in pixels. | DisplayObject | |
| mxmlContent : Array [write-only]
The visual content children for this Group. | SkinnableContainer | |
| mxmlContentFactory : IDeferredInstance [write-only]
A factory object that creates the initial value for the
content property. | SkinnableContainer | |
| 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 | ||
| needsSoftKeyboard : Boolean
Specifies whether a virtual keyboard (an on-screen, software keyboard) should display
when this InteractiveObject instance receives focus. | InteractiveObject | |
| 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 | |
| numElements : int [read-only]
The number of visual elements in this container. | SkinnableContainer | |
| opaqueBackground : Object
Specifies whether the display object is opaque with a certain background color. | DisplayObject | |
| owner : DisplayObjectContainer
The owner of this IVisualElement object. | UIComponent | |
| pageTitle : String
Specifies a string that appears in the title bar of the browser. | Application | |
| parameters : Object [read-only]
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
Specifies the height of a component as a percentage
of its parent's size. | UIComponent | |
| percentWidth : Number
Specifies the width of a component as a percentage
of its parent's size. | UIComponent | |
| postLayoutTransformOffsets : 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 | |
| preloader : Object
The application container supports an application preloader that
uses a download progress bar to show the download and initialization progress
of an application SWF file. | Application | |
| preloaderChromeColor : uint
Specifies the chrome color used by the default preloader component. | Application | |
| processedDescriptors : Boolean
Set to true after immediate or deferred child creation,
depending on which one happens. | UIComponent | |
| 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 | |
| resizable : Boolean [read-only]
Specifies whether the window can be resized. | WindowedApplication | ||
| resizeForSoftKeyboard : Boolean
Some devices do not support a hardware keyboard. | Application | |
| right : Object
For components, this layout constraint property is a
facade on top of the similarly-named style. | 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 | |
| runtimeDPI : Number [read-only]
The DPI of the device the application is currently running on. | Application | |
| runtimeDPIProvider : Class
A class that extends RuntimeDPIProvider and overrides the default Flex
calculations for runtimeDPI. | Application | |
| 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 | |
| scriptRecursionLimit : int
Specifies the maximum depth of Flash Player or AIR
call stack before the player stops. | Application | |
| 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 | |
| showStatusBar : Boolean
If true, the status bar is visible. | WindowedApplication | ||
| skin : UIComponent [read-only]
The instance of the skin class for this component instance. | SkinnableComponent | |
| softKeyboard : String
Controls the appearance of the soft keyboard. | InteractiveObject | |
| softKeyboardInputAreaOfInterest : Rectangle
Defines the area that should remain on-screen when a soft keyboard is displayed (not available on iOS). | InteractiveObject | |
| soundTransform : flash.media:SoundTransform
Controls sound within this sprite. | Sprite | |
| splashScreenImage : Class
The image class for the SplashScreen preloader. | Application | |
| splashScreenMinimumDisplayTime : Number
Minimum amount of time, in milliseconds, to show the splash screen image. | Application | |
| splashScreenScaleMode : String
The splash screen image scale mode:
A value of none implies that the image size is set
to match its intrinsic size.
A value of stretch sets the width and the height of the image to the
stage width and height, possibly changing the content aspect ratio.
A value of letterbox sets the width and height of the image
as close to the stage width and height as possible while maintaining aspect ratio. | Application | |
| 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 | ||
| styleDeclaration : CSSStyleDeclaration
Storage for the inline inheriting styles on this object. | UIComponent | |
| styleManager : IStyleManager2 [read-only]
Returns the StyleManager instance used by this component. | UIComponent | |
| styleName : Object
The class style used by this component. | UIComponent | |
| styleParent : IAdvancedStyleClient
A component's parent is used to evaluate descendant selectors. | UIComponent | |
| suggestedFocusSkinExclusions : Array [read-only]
Lists the skin parts that are
excluded from bitmaps captured and used to
show focus. | SkinnableComponent | |
| 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 | |
| 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 | |
| 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 | ||
| titleIcon : Class
The Class (usually an image) used to draw the title bar icon. | WindowedApplication | ||
| top : Object
For components, this layout constraint property is a
facade on top of the similarly-named style. | UIComponent | |
| transform : flash.geom:Transform [override]
An object with properties pertaining to a display object's matrix, color transform,
and pixel bounds. | UIComponent | |
| transformX : Number
Sets the x coordinate for the transform center of the component. | UIComponent | |
| transformY : Number
Sets the y coordinate for the transform center of the component. | UIComponent | |
| transformZ : Number
Sets the z coordinate for the transform center of the component. | UIComponent | |
| transitions : Array
An Array of Transition objects, where each Transition object defines a
set of effects to play when a view state change occurs. | UIComponent | |
| 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 pointer rolls
over a sprite in which the buttonMode property is set to true. | Sprite | |
| useNativeDragManager : Boolean = true
If true, the DragManager should use the NativeDragManagerImpl implementation class. | WindowedApplication | ||
| 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 | |
| verticalCenter : Object
For components, this layout constraint property is a
facade on top of the similarly-named style. | UIComponent | |
| viewSourceURL : String
URL where the application's source can be viewed. | Application | |
| 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 | |
| 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
Public Methods
| Method | Defined By | ||
|---|---|---|---|
Constructor. | WindowedApplication | ||
Activates the underlying NativeWindow (even if this application is not the active one). | WindowedApplication | ||
|
Adds a visual element to this container. | SkinnableContainer | |
|
Adds a visual element to this container. | SkinnableContainer | |
| 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 | |
|
Adds a non-visual style client to this component instance. | UIComponent | |
|
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 | |
|
Converts a Point object from content coordinates to global coordinates. | UIComponent | |
|
Converts a Point object from content to local coordinates. | UIComponent | |
|
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 | |
|
Create the content for this component. | SkinnableContainer | |
|
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 | |
|
Executes all the bindings for which the UIComponent object is the destination. | UIComponent | |
Closes the window and exits the application. | WindowedApplication | ||
|
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 | |
|
Returns the child display object that exists with the specified name. | DisplayObjectContainer | |
|
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. | SkinnableContainer | |
|
Returns the index position of a visual element. | SkinnableContainer | |
|
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 | |
|
Converts a Point object from global to content coordinates. | UIComponent | |
|
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 | |
|
Returns true if currentCSSState is not null. | UIComponent | |
|
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 | |
|
An element must call this method when its layoutDirection changes or
when its parent's layoutDirection changes. | 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 | |
|
Marks the component so that the new state of the skin is set
during a later screen update. | SkinnableComponent | |
|
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 | |
|
Converts a Point object from local to content coordinates. | UIComponent | |
|
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 | |
Maximizes the window, or does nothing if it's already maximized. | WindowedApplication | ||
|
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 | |
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 visual elements from the container. | SkinnableContainer | |
|
Removes all child DisplayObject instances from the child list of the DisplayObjectContainer instance. | DisplayObjectContainer | |
|
Removes the specified visual element from the child list of
this container. | SkinnableContainer | |
|
Removes a visual element from the specified index position
in the container. | SkinnableContainer | |
|
Removes a listener from the EventDispatcher object. | EventDispatcher | |
|
Removes a non-visual style client from this component instance. | UIComponent | |
|
Replays the specified event. | UIComponent | |
|
Raises a virtual keyboard. | InteractiveObject | |
|
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 | |
|
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. | SkinnableContainer | |
|
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 | |
|
Lets the user drag the specified sprite on a touch-enabled device. | Sprite | |
|
Recursively stops the timeline execution of all MovieClips rooted at this object. | DisplayObjectContainer | |
|
Ends the startDrag() method. | Sprite | |
|
Ends the startTouchDrag() method, for use with touch-enabled devices. | 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 index of the two specified visual elements. | SkinnableContainer | |
|
Swaps the visual elements at the two specified index
positions in the container. | SkinnableContainer | |
|
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
Events
| 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(), addChildAt(), addElement(), or addElementAt() 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 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 after the content for this component has been created. | SkinnableContainer | ||
| 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 | ||
| [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 | ||
| Dispatched after an effect is stopped, which happens only by a call to stop() on the effect. | UIComponent | ||
| Dispatched when a visual element is added to the content holder. | SkinnableContainer | ||
| Dispatched when a visual element is removed from the content holder. | SkinnableContainer | ||
| [broadcast event] Dispatched when the playhead is entering a new frame. | DisplayObject | ||
| Dispatched after the component has entered a view state. | UIComponent | ||
| Dispatched when an HTTPService call fails. | Application | ||
| [broadcast event] Dispatched when the playhead is exiting the current frame. | DisplayObject | ||
| Dispatched just before the component exits a 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 the user creates a point of contact along the edge of the touch surface with an InteractiveObject instance, (such as tapping along the edge of the touch surface on Siri Remote for Apple TV) Some devices might also interpret this contact as a combination of several touch events, as well. | InteractiveObject | ||
| Dispatched when the user presses two points of contact over the same InteractiveObject instance on a touch-enabled device (such as presses and releases two fingers over a display object on a mobile phone or tablet with a touch screen). | InteractiveObject | ||
| Dispatched when the user moves a point of contact over the InteractiveObject instance on a touch-enabled device (such as moving a finger from left to right over a display object on a mobile phone or tablet with a touch screen). | InteractiveObject | ||
| Dispatched when the user performs a rotation gesture at a point of contact with an InteractiveObject instance (such as touching two fingers and rotating them over a display object on a mobile phone or tablet with a touch screen). | InteractiveObject | ||
| Dispatched when the user performs a swipe gesture at a point of contact with an InteractiveObject instance (such as touching three fingers to a screen and then moving them in parallel over a display object on a mobile phone or tablet with a touch screen). | InteractiveObject | ||
| Dispatched when the user creates a point of contact with an InteractiveObject instance, then taps on a touch-enabled device (such as placing several fingers over a display object to open a menu and then taps one finger to select a menu item on a mobile phone or tablet with a touch screen). | InteractiveObject | ||
| Dispatched when the user performs a zoom gesture at a point of contact with an InteractiveObject instance (such as touching two fingers to a screen and then quickly spreading the fingers apart over a display object on a mobile phone or tablet with a touch screen). | InteractiveObject | ||
| Dispatched when an object's state changes from visible to invisible. | UIComponent | ||
| This event is dispatched to any client app that supports inline input with an IME | InteractiveObject | ||
| 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 user lowers an active stylus past the proximity detection threshold of the screen. | InteractiveObject | ||
| Dispatched when the user lifts an active stylus above the proximity detection threshold of the screen. | InteractiveObject | ||
| Dispatched when the user moves an active stylus over the screen while remaining within the proximity detection threshold. | InteractiveObject | ||
| Dispatched when the user moves an active stylus away from this InteractiveObject while remaining within the proximity detection threshold of the screen. | InteractiveObject | ||
| Dispatched when the user moves an active stylus directly above this InteractiveObject while remaining within the proximity detection threshold of the screen. | InteractiveObject | ||
| Dispatched when the user moves an active stylus away from this InteractiveObject and any of its children while remaining within the proximity detection threshold of the screen. | InteractiveObject | ||
| Dispatched when the user moves an active stylus over this InteractiveObject from outside the object's tree of descendents in the display list (while remaining within the proximity detection threshold of the screen). | InteractiveObject | ||
| Dispatched when a user releases the button on the pointing device after the user first pressed the button over an InteractiveObject instance and then moved the pointing device off of the InteractiveObject instance. | InteractiveObject | ||
| Dispatched when the component is removed from a container as a content child by using the removeChild(), removeChildAt(), removeElement(), or removeElementAt() 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 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 immediately after the soft keyboard is raised. | InteractiveObject | ||
| Dispatched immediately before the soft keyboard is raised. | InteractiveObject | ||
| Dispatched immediately after the soft keyboard is lowered. | InteractiveObject | ||
| Dispatched after the component has entered a new state and any state transition animation to that state has finished playing. | UIComponent | ||
| Dispatched when a component interrupts a transition to its current state in order to switch to a new state. | 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 is to 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 the user first contacts a touch-enabled device (such as touches a finger to a mobile phone or tablet with a touch screen). | InteractiveObject | ||
| Dispatched when the user removes contact with a touch-enabled device (such as lifts a finger off a mobile phone or tablet with a touch screen). | InteractiveObject | ||
| A non-cancellable event, dispatched by a component when it is done responding to a touch interaction user gesture. | UIComponent | ||
| A non-cancellable event, dispatched by a component when it starts responding to a touch interaction user gesture. | UIComponent | ||
| A cancellable event, dispatched by a component in an attempt to respond to a touch interaction user gesture. | UIComponent | ||
| Dispatched when the user touches the device, and is continuously dispatched until the point of contact is removed. | InteractiveObject | ||
| Dispatched when the user moves the point of contact away from InteractiveObject instance on a touch-enabled device (such as drags a finger from one display object to another on a mobile phone or tablet with a touch screen). | InteractiveObject | ||
| Dispatched when the user moves the point of contact over an InteractiveObject instance on a touch-enabled device (such as drags a finger from a point outside a display object to a point over a display object on a mobile phone or tablet with a touch screen). | InteractiveObject | ||
| Dispatched when the user moves the point of contact away from an InteractiveObject instance on a touch-enabled device (such as drags a finger from over a display object to a point outside the display object on a mobile phone or tablet with a touch screen). | InteractiveObject | ||
| Dispatched when the user moves the point of contact over an InteractiveObject instance on a touch-enabled device (such as drags a finger from a point outside a display object to a point over a display object on a mobile phone or tablet with a touch screen). | InteractiveObject | ||
| Dispatched when the user lifts the point of contact over the same InteractiveObject instance on which the contact was initiated on a touch-enabled device (such as presses and releases a finger from a single point over a display object on a mobile phone or tablet with a touch screen). | InteractiveObject | ||
| Dispatched when an uncaught error is caught by the Global Exception Handler | Application | ||
| 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 | |||
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: Yes Language Version: ActionScript 3.0 Product Version: Flex 4 Runtime Versions: Flash10, AIR 1.5 Specifies the baseline to which the dominant baseline aligns. | SkinnableContainer | ||
backgroundAlpha | Type: Number CSS Inheritance: No Language Version: ActionScript 3.0 Product Version: Flex 4 Runtime Versions: Flash10, AIR 1.5 Alpha level of the color defined by the backgroundColor
property.
The default value is 1.0. | WindowedApplication | ||
backgroundColor | Type: uint Format: Color CSS Inheritance: No Language Version: ActionScript 3.0 Product Version: Flex 4 Runtime Versions: Flash10, AIR 1.5 The background color of the application. This color is used as the stage color for the application and the background color for the HTML embed tag. | WindowedApplication | ||
| Type: String CSS Inheritance: No Language Version: ActionScript 3.0 Product Version: Flex 3 Runtime Versions: Flash9, AIR 1.1 The vertical distance in pixels from the top edge of the content area to the control's baseline position. | UIComponent | ||
| Type: Object CSS Inheritance: Yes Language Version: ActionScript 3.0 Product Version: Flex 4 Runtime Versions: Flash10, AIR 1.5 Amount to shift the baseline. | SkinnableContainer | ||
| Type: String CSS Inheritance: Yes Language Version: ActionScript 3.0 Product Version: Flex 4 Runtime Versions: Flash10, AIR 1.5 Specifies a vertical or horizontal progression of line placement. | SkinnableContainer | ||
| Type: String CSS Inheritance: No Language Version: ActionScript 3.0 Product Version: Flex 3 Runtime Versions: Flash9, AIR 1.1 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: String CSS Inheritance: Yes Language Version: ActionScript 3.0 Product Version: Flex 4 Runtime Versions: Flash10, AIR 1.5 Controls where lines are allowed to break when breaking wrapping text into multiple lines. | SkinnableContainer | ||
| Type: String CSS Inheritance: Yes Language Version: ActionScript 3.0 Product Version: Flex 4 Runtime Versions: Flash10, AIR 1.5 The type of CFF hinting used for this text. | SkinnableContainer | ||
| Type: String CSS Inheritance: Yes Language Version: ActionScript 3.0 Product Version: Flex 4 Runtime Versions: Flash10, AIR 1.5 Controls how text wraps around a float. | SkinnableContainer | ||
| Type: uint Format: Color CSS Inheritance: Yes Language Version: ActionScript 3.0 Product Version: Flex 4 Runtime Versions: Flash10, AIR 1.5 Color of the text. | SkinnableContainer | ||
| Type: String CSS Inheritance: Yes Language Version: ActionScript 3.0 Product Version: Flex 4 Runtime Versions: Flash10, AIR 1.5 The type of digit case used for this text. | SkinnableContainer | ||
| Type: String CSS Inheritance: Yes Language Version: ActionScript 3.0 Product Version: Flex 4 Runtime Versions: Flash10, AIR 1.5 Type of digit width used for this text. | SkinnableContainer | ||
| Type: String CSS Inheritance: Yes Language Version: ActionScript 3.0 Product Version: Flex 4 Runtime Versions: Flash10, AIR 1.5 Specifies the default bidirectional embedding level of the text. | SkinnableContainer | ||
| Type: String CSS Inheritance: Yes Language Version: ActionScript 3.0 Product Version: Flex 4 Runtime Versions: Flash10, AIR 1.5 Specifies which element baseline snaps to the alignmentBaseline to determine the vertical position of the element on the line. | SkinnableContainer | ||
| Type: uint Format: Color CSS Inheritance: Yes Language Version: ActionScript 3.0 Product Version: Flex 3 Runtime Versions: Flash9, AIR 1.1 Color of the component highlight when validation fails. | UIComponent | ||
| Type: Class Language Version: ActionScript 3.0 Product Version: Flex 4 Runtime Versions: Flash10, AIR 1.5 Name of the skin class to use for this component when a validation error occurs. | SkinnableComponent | ||
| Type: Object CSS Inheritance: Yes Language Version: ActionScript 3.0 Product Version: Flex 4 Runtime Versions: Flash10, AIR 1.5 Specifies the baseline position of the first line in the container. | SkinnableContainer | ||
| Type: uint Format: Color CSS Inheritance: Yes Language Version: ActionScript 3.0 Product Version: Flex 4 Runtime Versions: Flash10, AIR 1.5 The color of text when the component is enabled and has focus. | SkinnableContainer | ||
| Type: Class CSS Inheritance: No Language Version: ActionScript 3.0 Product Version: Flex 3 Runtime Versions: Flash9, AIR 1.1 Skin used to draw the focus rectangle. | UIComponent | ||
| Type: String CSS Inheritance: Yes Language Version: ActionScript 3.0 Product Version: Flex 4 Runtime Versions: Flash10, AIR 1.5 The name of the font to use, or a comma-separated list of font names. | SkinnableContainer | ||
| Type: String CSS Inheritance: Yes Language Version: ActionScript 3.0 Product Version: Flex 4 Runtime Versions: Flash10, AIR 1.5 Font lookup to use. | SkinnableContainer | ||
| Type: Number Format: Length CSS Inheritance: Yes Language Version: ActionScript 3.0 Product Version: Flex 4 Runtime Versions: Flash10, AIR 1.5 Height of the text, in pixels. | SkinnableContainer | ||
| Type: String CSS Inheritance: Yes Language Version: ActionScript 3.0 Product Version: Flex 4 Runtime Versions: Flash10, AIR 1.5 Determines whether the text is italic font. | SkinnableContainer | ||
| Type: String CSS Inheritance: Yes Language Version: ActionScript 3.0 Product Version: Flex 4 Runtime Versions: Flash10, AIR 1.5 Determines whether the text is boldface. | SkinnableContainer | ||
| Type: String CSS Inheritance: No Language Version: ActionScript 3.0 Product Version: Flex 3 Runtime Versions: Flash9, AIR 1.1 The horizontal distance in pixels from the center of the component's content area to the center of the component. | UIComponent | ||
| Type: uint Format: Color CSS Inheritance: Yes Language Version: ActionScript 3.0 Product Version: Flex 4 Runtime Versions: Flash10, AIR 1.5 The color of text when the component is disabled. | SkinnableContainer | ||
| Type: String CSS Inheritance: Yes Language Version: ActionScript 3.0 Product Version: Flex 4.5 Runtime Versions: Flash10, AIR 2.5 The primary interaction mode for this component. | UIComponent | ||
| Type: String CSS Inheritance: Yes Language Version: ActionScript 3.0 Product Version: Flex 4 Runtime Versions: Flash10, AIR 1.5 Rule used to justify text in a paragraph. | SkinnableContainer | ||
| Type: String CSS Inheritance: Yes Language Version: ActionScript 3.0 Product Version: Flex 4 Runtime Versions: Flash10, AIR 1.5 The style used for justification of the paragraph. | SkinnableContainer | ||
| Type: String CSS Inheritance: Yes Language Version: ActionScript 3.0 Product Version: Flex 4 Runtime Versions: Flash10, AIR 1.5 The style used for justification of the paragraph. | SkinnableContainer | ||
| Type: String CSS Inheritance: Yes Language Version: ActionScript 3.0 Product Version: Flex 4.1 Runtime Versions: Flash10, AIR 1.5 Specifies the desired layout direction of a component. | UIComponent | ||
| Type: String CSS Inheritance: Yes Language Version: ActionScript 3.0 Product Version: Flex 4 Runtime Versions: Flash10, AIR 1.5 Specifies the leading model, which is a combination of leading basis and leading direction. | SkinnableContainer | ||
| Type: String CSS Inheritance: No Language Version: ActionScript 3.0 Product Version: Flex 3 Runtime Versions: Flash9, AIR 1.1 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: String CSS Inheritance: Yes Language Version: ActionScript 3.0 Product Version: Flex 4 Runtime Versions: Flash10, AIR 1.5 Controls which of the ligatures that are defined in the font may be used in the text. | SkinnableContainer | ||
| Type: Object CSS Inheritance: Yes Language Version: ActionScript 3.0 Product Version: Flex 4 Runtime Versions: Flash10, AIR 1.5 Leading controls for the text. | SkinnableContainer | ||
| Type: Boolean CSS Inheritance: Yes Language Version: ActionScript 3.0 Product Version: Flex 4 Runtime Versions: Flash10, AIR 1.5 If true, applies strikethrough, a line drawn through the middle of the text. | SkinnableContainer | ||
| Type: Number Format: length CSS Inheritance: Yes Language Version: ActionScript 3.0 Product Version: Flex 4 Runtime Versions: Flash10, AIR 1.5 This specifies an auto indent for the start edge of lists when the padding value of the list on that side is auto. | SkinnableContainer | ||
| Type: String CSS Inheritance: Yes Language Version: ActionScript 3.0 Product Version: Flex 4.5 Runtime Versions: Flash10, AIR 2.5 This controls the placement of a list item marker relative to the list item. | SkinnableContainer | ||
| Type: String CSS Inheritance: Yes Language Version: ActionScript 3.0 Product Version: Flex 4.5 Runtime Versions: Flash10, AIR 2.5 This controls the appearance of items in a list. | SkinnableContainer | ||
| Type: String CSS Inheritance: Yes Language Version: ActionScript 3.0 Product Version: Flex 4 Runtime Versions: Flash10, AIR 1.5 The locale of the text. | SkinnableContainer | ||
| Type: Number Format: length CSS Inheritance: Yes Language Version: ActionScript 3.0 Product Version: Flex 4 Runtime Versions: Flash10, AIR 1.5 The amount to indent the paragraph's end edge. | SkinnableContainer | ||
| Type: Number Format: length CSS Inheritance: Yes Language Version: ActionScript 3.0 Product Version: Flex 4 Runtime Versions: Flash10, AIR 1.5 The amount of space to leave after the paragraph. | SkinnableContainer | ||
| Type: Number Format: length CSS Inheritance: Yes Language Version: ActionScript 3.0 Product Version: Flex 4 Runtime Versions: Flash10, AIR 1.5 The amount of space to leave before the paragraph. | SkinnableContainer | ||
| Type: Number Format: length CSS Inheritance: Yes Language Version: ActionScript 3.0 Product Version: Flex 4 Runtime Versions: Flash10, AIR 1.5 The amount to indent the paragraph's start edge. | SkinnableContainer | ||
| Type: String CSS Inheritance: Yes Language Version: ActionScript 3.0 Product Version: Flex 4 Runtime Versions: Flash10, AIR 1.5 The rendering mode used for this text which applies only to embedded fonts. | SkinnableContainer | ||
resizeAffordanceWidth | Type: Number Format: length CSS Inheritance: No Language Version: ActionScript 3.0 Product Version: Flex 4 Runtime Versions: Flash10, AIR 1.5 Provides a margin of error around a window's border so a resize can be more easily started. A click on a window is considered a click on the window's border if the click occurs with the resizeAffordance number of pixels from the outside edge of the window. The default value is 6. | WindowedApplication | ||
| Type: String CSS Inheritance: No Language Version: ActionScript 3.0 Product Version: Flex 3 Runtime Versions: Flash9, AIR 1.1 The horizontal distance, in pixels, from the right edge of the component to the right edge of its parent container's content area. | UIComponent | ||
| Type: Boolean CSS Inheritance: Yes Language Version: ActionScript 3.0 Product Version: Flex 4.5 Runtime Versions: Flash10, AIR 1.5 Show the error border or skin when this component is invalid | UIComponent | ||
| Type: Boolean CSS Inheritance: Yes Language Version: ActionScript 3.0 Product Version: Flex 4.5 Runtime Versions: Flash10, AIR 1.5 Show the error tip when this component is invalid and the user rolls over it | UIComponent | ||
| Type: Class Language Version: ActionScript 3.0 Product Version: Flex 4 Runtime Versions: Flash10, AIR 1.5 Name of the skin class to use for this component. | SkinnableComponent | ||
| Type: String CSS Inheritance: Yes Language Version: ActionScript 3.0 Product Version: Flex 4 Runtime Versions: Flash10, AIR 1.5 Specifies the tab stops associated with the paragraph. | SkinnableContainer | ||
| Type: String CSS Inheritance: Yes Language Version: ActionScript 3.0 Product Version: Flex 4 Runtime Versions: Flash10, AIR 1.5 Alignment of text within a container. | SkinnableContainer | ||
| Type: String CSS Inheritance: Yes Language Version: ActionScript 3.0 Product Version: Flex 4 Runtime Versions: Flash10, AIR 1.5 Alignment of the last line in the paragraph relative to the container in justified text. | SkinnableContainer | ||
| Type: Number CSS Inheritance: Yes Language Version: ActionScript 3.0 Product Version: Flex 4 Runtime Versions: Flash10, AIR 1.5 Alpha (transparency) value for the text. | SkinnableContainer | ||
| Type: String CSS Inheritance: Yes Language Version: ActionScript 3.0 Product Version: Flex 4 Runtime Versions: Flash10, AIR 1.5 Determines whether the text is underlined. | SkinnableContainer | ||
| Type: Number Format: Length CSS Inheritance: Yes Language Version: ActionScript 3.0 Product Version: Flex 4 Runtime Versions: Flash10, AIR 1.5 Offset of first line of text from the left side of the container. | SkinnableContainer | ||
| Type: String CSS Inheritance: Yes Language Version: ActionScript 3.0 Product Version: Flex 4 Runtime Versions: Flash10, AIR 1.5 Specifies options for justifying text. | SkinnableContainer | ||
| Type: String CSS Inheritance: Yes Language Version: ActionScript 3.0 Product Version: Flex 4 Runtime Versions: Flash10, AIR 1.5 Determines the number of degrees to rotate this text. | SkinnableContainer | ||
| Type: String CSS Inheritance: No Language Version: ActionScript 3.0 Product Version: Flex 3 Runtime Versions: Flash9, AIR 1.1 The vertical distance, in pixels, from the top edge of the component to the top edge of its parent container's content area. | UIComponent | ||
| Type: Number Format: Time CSS Inheritance: Yes Language Version: ActionScript 3.0 Product Version: Flex 4.5 Runtime Versions: Flash10.1, AIR 2.5 When in touch interaction mode, the number of milliseconds to wait after the user interaction has occured before showing the component in a visually down state. | SkinnableContainer | ||
| Type: Object CSS Inheritance: Yes Language Version: ActionScript 3.0 Product Version: Flex 4 Runtime Versions: Flash10, AIR 1.5 The amount of tracking (manual kerning) to be applied to the left of each character. | SkinnableContainer | ||
| Type: Object CSS Inheritance: Yes Language Version: ActionScript 3.0 Product Version: Flex 4 Runtime Versions: Flash10, AIR 1.5 The amount of tracking (manual kerning) to be applied to the right of each character. | SkinnableContainer | ||
| Type: String CSS Inheritance: Yes Language Version: ActionScript 3.0 Product Version: Flex 4 Runtime Versions: Flash10, AIR 1.5 The type of typographic case used for this text. | SkinnableContainer | ||
| Type: uint Format: Color CSS Inheritance: Yes Language Version: ActionScript 3.0 Product Version: Flex 4 Runtime Versions: Flash10, AIR 1.5 The color of text when the component is enabled but does not have focus. | SkinnableContainer | ||
| Type: String CSS Inheritance: No Language Version: ActionScript 3.0 Product Version: Flex 3 Runtime Versions: Flash9, AIR 1.1 The vertical distance in pixels from the center of the component's content area to the center of the component. | UIComponent | ||
| Type: String CSS Inheritance: Yes Language Version: ActionScript 3.0 Product Version: Flex 4 Runtime Versions: Flash10, AIR 1.5 Collapses or preserves whitespace when importing text into a TextFlow. | SkinnableContainer | ||
| Type: Object CSS Inheritance: Yes Language Version: ActionScript 3.0 Product Version: Flex 4.5 Runtime Versions: Flash10.5, AIR 2.0 Specifies the spacing between words to use during justification. | SkinnableContainer | ||
Spark Theme Styles
Mobile Theme Styles
Skin Parts
This component uses skins made up of skin parts. Do not set the skin parts directly. The component's skin sets the skin parts.
| Skin Part | Description | Defined By | ||
|---|---|---|---|---|
| Required: false Part Type: Static Language Version: ActionScript 3.0 Product Version: Flex 4 Runtime Versions: Flash10, AIR 1.5 An optional skin part that defines the Group where the content children get pushed into and laid out. | SkinnableContainer | ||
| Required: false Part Type: Static Language Version: ActionScript 3.0 Product Version: Flex 4 Runtime Versions: Flash10, AIR 1.5 The skin part that defines the appearance of the control bar area of the container. By default, the ApplicationSkin class defines the control bar area to appear at the top of the content area of the Application container with a grey background. | Application | ||
gripper:Button | Required: false Part Type: Static Language Version: ActionScript 3.0 Product Version: Flex 4 Runtime Versions: Flash10, AIR 1.5 The skin part that defines the gripper button used to resize the window. | WindowedApplication | ||
statusBar:IVisualElement | Required: false Part Type: Static Language Version: ActionScript 3.0 Product Version: Flex 4 Runtime Versions: AIR1.5, The skin part that defines the display of the status bar. | WindowedApplication | ||
statusText:TextBase | Required: false Part Type: Static Language Version: ActionScript 3.0 Product Version: Flex 4 Runtime Versions: AIR1.5, The skin part that defines the display of the status bar's text. | WindowedApplication | ||
titleBar:TitleBar | Required: false Part Type: Static Language Version: ActionScript 3.0 Product Version: Flex 4 Runtime Versions: AIR1.5, The skin part that defines the display of the title bar. | WindowedApplication | ||
Skin States
To skin the component, implement a skin that defines the following states. Although you must implement all skin states, a skin state can be empty. An empty skin state specifies no changes to the default skin state.
| Skin State | Description | Defined By | ||
|---|---|---|---|---|
|
Disabled State
Language Version: ActionScript 3.0 Product Version: Flex 4 Runtime Versions: Flash10, AIR 1.5 | SkinnableContainerBase | ||
disabledAndInactive |
The application is disabled and inactive.
Language Version: ActionScript 3.0 Product Version: Flex 4 Runtime Versions: Flash10, AIR 1.5 | WindowedApplication | ||
|
Normal State
Language Version: ActionScript 3.0 Product Version: Flex 4 Runtime Versions: Flash10, AIR 1.5 | SkinnableContainerBase | ||
normalAndInactive |
The application is enabled and inactive.
Language Version: ActionScript 3.0 Product Version: Flex 4 Runtime Versions: Flash10, AIR 1.5 | WindowedApplication | ||
Effects
| 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 | ||
Public Constants
Property Detail
alwaysInFront | property |
alwaysInFront:Boolean| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 4 |
| Runtime Versions: | AIR 1.5 |
Determines whether the underlying NativeWindow is always in front of other windows.
The default value is false.
Implementation
public function get alwaysInFront():Boolean public function set alwaysInFront(value:Boolean):void applicationID | property |
autoExit | property |
autoExit:Boolean| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 4 |
| Runtime Versions: | AIR 1.5 |
Specifies whether the AIR application will quit when the last window closes or will continue running in the background.
The default value is true.
Implementation
public function get autoExit():Boolean public function set autoExit(value:Boolean):void backgroundFrameRate | property |
backgroundFrameRate:Number| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 4 |
| Runtime Versions: | AIR 1.5 |
Specifies the frame rate to use when the application is inactive. When set to -1, no background frame rate throttling occurs.
The default value is -1.
Implementation
public function get backgroundFrameRate():Number public function set backgroundFrameRate(value:Number):void closed | property |
dockIconMenu | property |
dockIconMenu:FlexNativeMenu| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 4 |
| Runtime Versions: | AIR 1.5 |
The dock icon menu. Some operating systems do not support dock icon menus.
Implementation
public function get dockIconMenu():FlexNativeMenu public function set dockIconMenu(value:FlexNativeMenu):void maximizable | property |
menu | property |
menu:FlexNativeMenu| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 4 |
| Runtime Versions: | AIR 1.5 |
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.
Implementation
public function get menu():FlexNativeMenu public function set menu(value:FlexNativeMenu):void minimizable | property |
nativeApplication | property |
nativeApplication:NativeApplication [read-only] | Language Version: | ActionScript 3.0 |
| Product Version: | Flex 4 |
| Runtime Versions: | AIR 1.5 |
The NativeApplication object representing the AIR application.
Implementation
public function get nativeApplication():NativeApplication nativeWindow | property |
nativeWindow:NativeWindow [read-only] | Language Version: | ActionScript 3.0 |
| Product Version: | Flex 4 |
| Runtime Versions: | AIR 1.5 |
The NativeWindow used by this WindowedApplication component (the initial native window of the application).
Implementation
public function get nativeWindow():NativeWindow resizable | property |
showStatusBar | property |
showStatusBar:Boolean| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 4 |
| Runtime Versions: | AIR 1.5 |
If true, the status bar is visible.
The status bar only appears when you use the WindowedApplicationSkin class or the SparkChromeWindowedApplicationSkin class as the skin for your application or any of your application's windows.
The default value is true.
Implementation
public function get showStatusBar():Boolean public function set showStatusBar(value:Boolean):void status | property |
status:String| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 4 |
| Runtime Versions: | AIR 1.5 |
The 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.
Implementation
public function get status():String public function set status(value:String):void systemChrome | property |
systemChrome:String [read-only] | Language Version: | ActionScript 3.0 |
| Product Version: | Flex 4 |
| Runtime Versions: | AIR 1.5 |
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.
Implementation
public function get systemChrome():StringRelated API Elements
systemTrayIconMenu | property |
systemTrayIconMenu:FlexNativeMenu| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 4 |
| Runtime Versions: | AIR 1.5 |
The system tray icon menu. Some operating systems do not support system tray icon menus.
Implementation
public function get systemTrayIconMenu():FlexNativeMenu public function set systemTrayIconMenu(value:FlexNativeMenu):void title | property |
title:String| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 4 |
| Runtime Versions: | AIR 1.5 |
The 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.
Implementation
public function get title():String public function set title(value:String):void titleIcon | property |
titleIcon:Class| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 4 |
| Runtime Versions: | AIR 1.5 |
The 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.
Implementation
public function get titleIcon():Class public function set titleIcon(value:Class):void transparent | property |
type | property |
type:String [read-only] | Language Version: | ActionScript 3.0 |
| Product Version: | Flex 4 |
| Runtime Versions: | AIR 1.5 |
Specifies the type of NativeWindow that this component represents. The set of possible values is defined by the constants in the NativeWindowType class.
Implementation
public function get type():StringRelated API Elements
useNativeDragManager | property |
public var useNativeDragManager:Boolean = true| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 4 |
| Runtime Versions: | Flash Player 10, AIR 1.5 |
If true, the DragManager should use the NativeDragManagerImpl implementation class.
If false, then the DragManagerImpl class will be used.
Note: This property cannot be set by ActionScript code; it must be set in MXML code. That means you cannot change its value at run time.
By default, the DragManager for AIR applications built in Flex uses the NativeDragManagerImpl class as the implementation class. Flash Player applications build in Flex use the DragManagerImpl class.
The NativeDragManagerImpl class is a bridge between the AIR NativeDragManager API and the Flex DragManager API. The AIR NativeDragManager class uses the operating system's drag and drop APIs. It supports dragging between AIR windows and between the operating system and AIR. Because the operating system controls the drag-and-drop operation, it is not possible to customize the cursors during a drag. Also, you have no control over the drop animation. The behavior is dependent upon the operating system and has some inconsistencies across different platforms.
The DragManagerImpl class does not use the operating system for drag-and-drop. Instead, it controls the entire drag-and-drop process. It supports customizing the cursors and provides a drop animation. However, it does not allow dragging between AIR windows and between the operating system or AIR window.
The default value is true.
Constructor Detail
WindowedApplication | () | Constructor |
public function WindowedApplication()| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 4 |
| Runtime Versions: | AIR 1.5 |
Constructor.
Method Detail
activate | () | method |
public function activate():void| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 4 |
| Runtime Versions: | AIR 1.5 |
Activates the underlying NativeWindow (even if this application is not the active one).
close | () | method |
public function close():void| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 4 |
| Runtime Versions: | AIR 1.5 |
Closes the application's NativeWindow (the initial native window opened by the application). This action is cancelable.
exit | () | method |
public function exit():void| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 4 |
| Runtime Versions: | AIR 1.5 |
Closes the window and exits the application.
maximize | () | method |
public function maximize():void| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 4 |
| Runtime Versions: | AIR 1.5 |
Maximizes the window, or does nothing if it's already maximized.
minimize | () | method |
public function minimize():void| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 4 |
| Runtime Versions: | AIR 1.5 |
Minimizes the window.
orderInBackOf | () | method |
public function orderInBackOf(window:IWindow):Boolean| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 4 |
| Runtime Versions: | AIR 1.5 |
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 successfully sent behind;
false if the window is invisible or minimized.
|
orderInFrontOf | () | method |
public function orderInFrontOf(window:IWindow):Boolean| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 4 |
| Runtime Versions: | AIR 1.5 |
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 successfully sent in front;
false if the window is invisible or minimized.
|
orderToBack | () | method |
orderToFront | () | method |
public function orderToFront():Boolean| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 4 |
| Runtime Versions: | AIR 1.5 |
Orders the window in front of all others in the same application.
ReturnsBoolean — true if the window was successfully sent to the front;
false if the window is invisible or minimized.
|
restore | () | method |
public function restore():void| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 4 |
| Runtime Versions: | AIR 1.5 |
Restores the window (unmaximizes it if it's maximized, or unminimizes it if it's minimized).
Event Detail
applicationActivate | Event |
Event Object Type:
property AIREvent.type =
mx.events.AIREventproperty AIREvent.type =
mx.events.AIREvent.APPLICATION_ACTIVATE| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 4 |
| Runtime Versions: | AIR 1.5 |
Dispatched 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 |
Event Object Type:
property AIREvent.type =
mx.events.AIREventproperty AIREvent.type =
mx.events.AIREvent.APPLICATION_DEACTIVATE| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 4 |
| Runtime Versions: | AIR 1.5 |
Dispatched 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 |
Event Object Type:
property Event.type =
flash.events.Eventproperty Event.type =
flash.events.Event.CLOSE| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 4 |
| Runtime Versions: | AIR 1.5 |
Dispatched 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. |
Related API Elements
closing | Event |
Event Object Type:
property Event.type =
flash.events.Eventproperty Event.type =
flash.events.Event.CLOSING| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 4 |
| Runtime Versions: | AIR 1.5 |
Dispatched 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. |
Related API Elements
displayStateChange | Event |
Event Object Type:
property NativeWindowDisplayStateEvent.type =
flash.events.NativeWindowDisplayStateEventproperty NativeWindowDisplayStateEvent.type =
flash.events.NativeWindowDisplayStateEvent.DISPLAY_STATE_CHANGE| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 4 |
| Runtime Versions: | AIR 1.5 |
Dispatched 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 |
Event Object Type:
property NativeWindowDisplayStateEvent.type =
flash.events.NativeWindowDisplayStateEventproperty NativeWindowDisplayStateEvent.type =
flash.events.NativeWindowDisplayStateEvent.DISPLAY_STATE_CHANGING| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 4 |
| Runtime Versions: | AIR 1.5 |
Dispatched 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 |
Event Object Type:
flash.events.InvokeEvent| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 4 |
| Runtime Versions: | AIR 1.5 |
Dispatched when an application is invoked.
moving | Event |
Event Object Type:
property NativeWindowBoundsEvent.type =
flash.events.NativeWindowBoundsEventproperty NativeWindowBoundsEvent.type =
flash.events.NativeWindowBoundsEvent.MOVING| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 4 |
| Runtime Versions: | AIR 1.5 |
Dispatched 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. |
Note: On Linux, the preventDefault() method is not supported for this event.
networkChange | Event |
Event Object Type:
property Event.type =
flash.events.Eventproperty Event.type =
flash.events.Event.NETWORK_CHANGE| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 4 |
| Runtime Versions: | AIR 1.5 |
Dispatched 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 |
Event Object Type:
property NativeWindowBoundsEvent.type =
flash.events.NativeWindowBoundsEventproperty NativeWindowBoundsEvent.type =
flash.events.NativeWindowBoundsEvent.RESIZING| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 4 |
| Runtime Versions: | AIR 1.5 |
Dispatched 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. |
Note: On Linux, the preventDefault() method is not supported for this event.
windowActivate | Event |
Event Object Type:
property AIREvent.type =
mx.events.AIREventproperty AIREvent.type =
mx.events.AIREvent.WINDOW_ACTIVATE| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 4 |
| Runtime Versions: | AIR 1.5 |
Dispatched 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 |
Event Object Type:
property AIREvent.type =
mx.events.AIREventproperty AIREvent.type =
mx.events.AIREvent.WINDOW_COMPLETE| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 4 |
| Runtime Versions: | AIR 1.5 |
Dispatched when the WindowedApplication completes its initial layout. By default, the WindowedApplication will be visible 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 |
Event Object Type:
property AIREvent.type =
mx.events.AIREventproperty AIREvent.type =
mx.events.AIREvent.WINDOW_DEACTIVATE| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 4 |
| Runtime Versions: | AIR 1.5 |
Dispatched 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 |
Event Object Type:
property FlexNativeWindowBoundsEvent.type =
mx.events.FlexNativeWindowBoundsEventproperty FlexNativeWindowBoundsEvent.type =
mx.events.FlexNativeWindowBoundsEvent.WINDOW_MOVE| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 4 |
| Runtime Versions: | AIR 1.5 |
Dispatched 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 |
Event Object Type:
property FlexNativeWindowBoundsEvent.type =
mx.events.FlexNativeWindowBoundsEventproperty FlexNativeWindowBoundsEvent.type =
mx.events.FlexNativeWindowBoundsEvent.WINDOW_RESIZE| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 4 |
| Runtime Versions: | AIR 1.5 |
Dispatched 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 |
Examples How to use this example
WindowedApplicationSample.mxml
<?xml version="1.0" encoding="utf-8"?>
<s:WindowedApplication
xmlns:fx="http://ns.adobe.com/mxml/2009"
xmlns:mx="library://ns.adobe.com/flex/mx"
xmlns:s="library://ns.adobe.com/flex/spark"
creationComplete="doCreationComplete();">
<fx:Script>
<![CDATA[
import mx.controls.FlexNativeMenu;
import mx.events.FlexNativeMenuEvent;
[Embed(source="TestImage.jpg")]
[Bindable]
public var TestImage:Class;
private var menu1:FlexNativeMenu;
private var menu2:FlexNativeMenu;
/**
* Set up the icon and menus.
**/
private function doCreationComplete():void {
setUpIcon();
menu1 = new FlexNativeMenu();
menu1.addEventListener(mx.events.FlexNativeMenuEvent.ITEM_CLICK, handleMenuItemClick);
menu1.dataProvider = menuData1;
menu1.labelField = "@label";
menu1.showRoot = false;
menu2 = new FlexNativeMenu();
menu2.addEventListener(mx.events.FlexNativeMenuEvent.ITEM_CLICK, handleMenuItemClick);
menu2.dataProvider = menuData2;
menu2.labelField = "@label";
menu2.showRoot = false;
// Mac dock
dockIconMenu = menu1;
// Windows system tray
systemTrayIconMenu = menu1;
// Mac and Windows
menu = menu2;
}
/**
* Set up the icon which appears in the sytem tray (Win)
* or the dock (Mac).
**/
private function setUpIcon():void {
nativeApplication.icon.bitmaps = new Array(new TestImage().bitmapData);
}
/**
* If someone chooses Exit from either menu, then exit.
**/
private function handleMenuItemClick(e:mx.events.FlexNativeMenuEvent):void {
if(e.label == "Exit"){
exit();
}
}
]]>
</fx:Script>
<fx:Declarations>
<!-- We use this one for the system tray or dock. -->
<fx:XML format="e4x" id="menuData1">
<root>
<menuitem label="Exit" />
</root>
</fx:XML>
<!-- We use this one for the menu on top. -->
<fx:XML format="e4x" id="menuData2">
<root>
<menuitem label="File" >
<menuitem label="Exit" />
</menuitem>
</root>
</fx:XML>
</fx:Declarations>
</s:WindowedApplication>
Mon Apr 10 2017, 12:28 PM -07:00