| Package | spark.components |
| Class | public class Window |
| Inheritance | Window  SkinnableContainer SkinnableContainerBase SkinnableComponent UIComponent FlexSprite flash.display.Sprite |
| Implements | IWindow |
| Language Version : | ActionScript 3.0 |
| Product Version : | Flex 4 |
| Runtime Versions : | AIR 1.5 |
The Window container is a special kind of container in the sense that it cannot be used within other layout containers. An spark.components.Window component must be the top-level component in its MXML document.
The easiest way to use a Window component to define a native window is to
create an MXML document with an <s:Window> tag
as the top-level tag in the document. You use the Window component
just as you do any other container, including specifying the layout
type, defining child controls, and so forth. Like any other custom
MXML component, when your application is compiled your MXML document
is compiled into a custom class that is a subclass of the Window
component.
In your application code, to make an instance of
your Window subclass appear on the screen you first create an instance
of the class in code (by defining a variable and calling the new
MyWindowClass() constructor. Next you set any properties you wish
to specify for the new window. Finally you call your Window component's
open() method to open the window on the screen.
Note that several of the Window class's properties can only be set
before calling the open() method to open
the window. Once the underlying NativeWindow is created, these initialization
properties can be read but cannot be changed. This restriction applies to
the following properties:
maximizable
minimizable
resizable
systemChrome
transparent
type
Hide MXML SyntaxThe <s:Window> tag inherits all of the tag
attributes of its superclass and adds the following tag attributes:
Show MXML Syntax
<s:Window
Properties
alwaysInFront="false"
colorCorrection="default"
maximizable="true"
menu="null"
minimizable="true"
resizable="true"
showStatusBar="true"
status=""
systemChrome="standard"
title=""
titleIcon="null"
transparent="false"
type="normal"
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"
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
See also
| Property | Defined By | ||
|---|---|---|---|
 | accessibilityDescription : String
A convenience accessor for the description property
in this UIComponent's accessibilityProperties object. | UIComponent | |
| accessibilityEnabled : Boolean
A convenience accessor for the silent property
in this UIComponent's accessibilityProperties object. | UIComponent | |
| accessibilityName : String
A convenience accessor for the name property
in this UIComponent's accessibilityProperties object. | UIComponent | |
| accessibilityShortcut : String
A convenience accessor for the shortcut property
in this UIComponent's accessibilityProperties object. | UIComponent | |
| activeEffects : Array [read-only]
The list of effects that are currently playing on the component,
as an Array of EffectInstance instances. | UIComponent | |
 alwaysInFront : Boolean
Determines whether the underlying NativeWindow is always in front
of other windows (including those of other applications). | Window | ||
| 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 | |
| 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 | |
| bottom : Object
For components, this layout constraint property is a
facade on top of the similarly-named style. | UIComponent | |
| cacheHeuristic : Boolean [write-only]
Used by Flex to suggest bitmap caching for the object. | UIComponent | |
| cachePolicy : String
Specifies the bitmap caching policy for this object. | UIComponent | |
| className : String [read-only]
The name of this instance's class, such as "Button". | UIComponent | |
| closed : Boolean [read-only]
A flag indicating whether the window has been closed. | Window | ||
| colorCorrection : String
The value of the stage's colorCorrection property. | Window | ||
| 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 | |
| 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 | |
| document : Object
A reference to the document object associated with this UIComponent. | UIComponent | |
| doubleClickEnabled : Boolean [override]
Specifies whether the UIComponent object receives doubleClick events. | UIComponent | |
| enabled : Boolean
Whether the component can accept user interaction. | UIComponent | |
| errorString : String
The text that displayed by a component's error tip when a
component is monitored by a Validator and validation fails. | UIComponent | |
| explicitHeight : Number
Number that specifies the explicit height of the component,
in pixels, in the component's coordinates. | UIComponent | |
| explicitMaxHeight : Number
The maximum recommended height of the component to be considered
by the parent during layout. | UIComponent | |
| explicitMaxWidth : Number
The maximum recommended width of the component to be considered
by the parent during layout. | UIComponent | |
| explicitMinHeight : Number
The minimum recommended height of the component to be considered
by the parent during layout. | UIComponent | |
| explicitMinWidth : Number
The minimum recommended width of the component to be considered
by the parent during layout. | UIComponent | |
| explicitWidth : Number
Number that specifies the explicit width of the component,
in pixels, in the component's coordinates. | UIComponent | |
| flexContextMenu : IFlexContextMenu
The context menu for this UIComponent. | UIComponent | |
| focusEnabled : Boolean
Indicates whether the component can receive focus when tabbed to. | UIComponent | |
| focusManager : IFocusManager
Gets the FocusManager that controls focus for this component
and its peers. | UIComponent | |
| focusPane : Sprite
The focus pane associated with this object. | UIComponent | |
| hasFocusableChildren : Boolean
A flag that indicates whether child objects can receive focus. | UIComponent | |
| hasLayoutMatrix3D : Boolean [read-only]
Contains true if the element has 3D Matrix. | UIComponent | |
| height : Number [override]
Number that specifies the height of the component, in pixels,
in the parent's coordinates. | UIComponent | |
| horizontalCenter : Object
For components, this layout constraint property is a
facade on top of the similarly-named style. | UIComponent | |
| 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 | |
| maintainProjectionCenter : Boolean
When true, the component keeps its projection matrix centered on the
middle of its bounding box. | UIComponent | |
| maxHeight : Number
The maximum recommended height of the component to be considered
by the parent during layout. | UIComponent | |
| maximizable : Boolean
Specifies whether the window can be maximized. | Window | ||
| 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 window menu for this window. | Window | ||
| minHeight : Number
The minimum recommended height of the component to be considered
by the parent during layout. | UIComponent | |
| minimizable : Boolean
Specifies whether the window can be minimized. | Window | ||
| minWidth : Number
The minimum recommended width of the component to be considered
by the parent during layout. | UIComponent | |
| moduleFactory : IFlexModuleFactory
A module factory is used as context for using embedded fonts and for
finding the style manager that controls the styles for this
component. | UIComponent | |
| mouseFocusEnabled : Boolean
Whether you can receive focus when clicked on. | UIComponent | |
| 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 | |
| MXMLDescriptor : Array [read-only] | UIComponent | |
| MXMLProperties : Array [read-only] | UIComponent | |
| nativeWindow : NativeWindow [read-only]
The underlying NativeWindow that this Window component uses. | Window | ||
| 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 | |
| owner : DisplayObjectContainer
The owner of this IVisualElement object. | UIComponent | |
| parent : DisplayObjectContainer [override] [read-only]
The parent container or component for this component. | UIComponent | |
| parentApplication : Object [read-only]
A reference to the Application object that contains this UIComponent
instance. | UIComponent | |
| parentDocument : Object [read-only]
A reference to the parent document object for this UIComponent. | UIComponent | |
| percentHeight : Number
Specifies the height of a component as a percentage
of its parent's size. | UIComponent | |
| percentWidth : Number
Specifies the width of a component as a percentage
of its parent's size. | UIComponent | |
| postLayoutTransformOffsets : TransformOffsets
Defines a set of adjustments that can be applied to the object's
transform in a way that is invisible to its parent's layout. | UIComponent | |
| processedDescriptors : Boolean
Set to true after immediate or deferred child creation,
depending on which one happens. | UIComponent | |
| renderMode : String
Specifies the render mode of the NativeWindow object. | Window | ||
| 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
Specifies whether the window can be resized. | Window | ||
| right : Object
For components, this layout constraint property is a
facade on top of the similarly-named style. | UIComponent | |
| rotation : Number [override] | UIComponent | |
| rotationX : Number [override]
Indicates the x-axis rotation of the DisplayObject instance, in degrees, from its original orientation
relative to the 3D parent container. | UIComponent | |
| rotationY : Number [override]
Indicates the y-axis rotation of the DisplayObject instance, in degrees, from its original orientation
relative to the 3D parent container. | UIComponent | |
| rotationZ : Number [override]
| UIComponent | |
| scaleX : Number [override]
Number that specifies the horizontal scaling factor. | UIComponent | |
| scaleY : Number [override]
Number that specifies the vertical scaling factor. | UIComponent | |
| scaleZ : Number [override]
Number that specifies the scaling factor along the z axis. | UIComponent | |
| screen : Rectangle [read-only]
Returns an object that contains the size and position of the base
drawing surface for this object. | UIComponent | |
| showInAutomationHierarchy : Boolean
A flag that determines if an automation object
shows in the automation hierarchy. | UIComponent | |
| showStatusBar : Boolean
If true, the status bar is visible. | Window | ||
| skin : UIComponent [read-only]
The instance of the skin class for this component instance. | SkinnableComponent | |
| 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. | Window | ||
| 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
Specifies the type of system chrome (if any) the window has. | Window | ||
| systemManager : ISystemManager
Returns the SystemManager object used by this component. | UIComponent | |
| tabFocusEnabled : Boolean
A flag that indicates whether this object can receive focus
via the TAB key
This is similar to the tabEnabled property
used by the Flash Player.
This is usually true for components that
handle keyboard input, but some components in controlbars
have them set to false because they should not steal
focus from another component like an editor. | UIComponent | |
| title : String
The title text that appears in the window title bar and
the taskbar. | Window | ||
| titleIcon : Class
The Class (usually an image) used to draw the title bar icon. | Window | ||
| toolTip : String
Text to display in the ToolTip. | UIComponent | |
| top : Object
For components, this layout constraint property is a
facade on top of the similarly-named style. | UIComponent | |
| transform : Transform [override]
An object with properties pertaining to a display object's matrix, color transform,
and pixel bounds. | UIComponent | |
| transformX : Number
Sets the x coordinate for the transform center of the component. | UIComponent | |
| transformY : Number
Sets the y coordinate for the transform center of the component. | UIComponent | |
| transformZ : Number
Sets the z coordinate for the transform center of the component. | UIComponent | |
| transitions : Array
An Array of Transition objects, where each Transition object defines a
set of effects to play when a view state change occurs. | UIComponent | |
| transparent : Boolean
Specifies whether the window is transparent. | Window | ||
| tweeningProperties : Array
Array of properties that are currently being tweened on this object. | UIComponent | |
| type : String
Specifies the type of NativeWindow that this component
represents. | Window | ||
| uid : String
A unique identifier for the object. | UIComponent | |
| updateCompletePendingFlag : Boolean
A flag that determines if an object has been through all three phases
of layout validation (provided that any were required). | UIComponent | |
| validationSubField : String
Used by a validator to associate a subfield with this component. | UIComponent | |
| verticalCenter : Object
For components, this layout constraint property is a
facade on top of the similarly-named style. | UIComponent | |
| visible : Boolean [override]
Whether or not the display object is visible. | UIComponent | |
| width : Number [override]
Number that specifies the width of the component, in pixels,
in the parent's coordinates. | UIComponent | |
| x : Number [override]
Number that specifies the component's horizontal position,
in pixels, within its parent container. | UIComponent | |
| y : Number [override]
Number that specifies the component's vertical position,
in pixels, within its parent container. | UIComponent | |
| z : Number [override]
| UIComponent | |
| Method | Defined By | ||
|---|---|---|---|
| Window()
Constructor. | Window | ||
| activate():void
Activates the underlying NativeWindow (even if this Window's application
is not currently active). | Window | ||
|
Adds a visual element to this container. | SkinnableContainer | |
|
Adds a visual element to this container. | SkinnableContainer | |
| addStyleClient(styleClient:IAdvancedStyleClient):void
Adds a non-visual style client to this component instance. | UIComponent | |
| callLater(method:Function, args:Array = null):void
Queues a function to be called later. | UIComponent | |
| clearStyle(styleProp:String):void
Deletes a style property from this component instance. | UIComponent | |
| close():void
Closes the window. | Window | ||
| contentToGlobal(point:Point):Point
Converts a Point object from content coordinates to global coordinates. | UIComponent | |
| contentToLocal(point:Point):Point
Converts a Point object from content to local coordinates. | UIComponent | |
| createAutomationIDPart(child:IAutomationObject):Object
Returns a set of properties that identify the child within
this container. | UIComponent | |
| createAutomationIDPartWithRequiredProperties(child:IAutomationObject, properties:Array):Object
Returns a set of properties as automation IDs that identify the child within
this container. | UIComponent | |
| createDeferredContent():void
Create the content for this component. | SkinnableContainer | |
| createReferenceOnParentDocument(parentDocument:IFlexDisplayObject):void
Creates an id reference to this IUIComponent object
on its parent document object. | UIComponent | |
| deleteReferenceOnParentDocument(parentDocument:IFlexDisplayObject):void
Deletes the id reference to this IUIComponent object
on its parent document object. | UIComponent | |
|
Returns a UITextFormat object corresponding to the text styles
for this UIComponent. | UIComponent | |
| dispatchEvent(event:Event):Boolean [override]
Dispatches an event into the event flow. | UIComponent | |
| drawFocus(isFocused:Boolean):void
Shows or hides the focus indicator around this component. | UIComponent | |
| drawRoundRect(x:Number, y:Number, w:Number, h:Number, r:Object = null, c:Object = null, alpha:Object = null, rot:Object = null, gradient:String = null, ratios:Array = null, hole:Object = null):void
Programmatically draws a rectangle into this skin's Graphics object. | UIComponent | |
| effectFinished(effectInst:IEffectInstance):void
Called by the effect instance when it stops playing on the component. | UIComponent | |
| effectStarted(effectInst:IEffectInstance):void
Called by the effect instance when it starts playing on the component. | UIComponent | |
| endEffectsStarted():void
Ends all currently playing effects on the component. | UIComponent | |
| executeBindings(recurse:Boolean = false):void
Executes all the bindings for which the UIComponent object is the destination. | UIComponent | |
| finishPrint(obj:Object, target:IFlexDisplayObject):void
Called after printing is complete. | UIComponent | |
| generateMXMLArray(document:Object, data:Array, recursive:Boolean = true):Array | UIComponent | |
| generateMXMLVector(document:Object, data:Array, recursive:Boolean = true):* | UIComponent | |
| getAutomationChildAt(index:int):IAutomationObject
Provides the automation object at the specified index. | UIComponent | |
| getAutomationChildren():Array
Provides the automation object list . | UIComponent | |
| getBoundsXAtSize(width:Number, height:Number, postLayoutTransform:Boolean = true):Number
Returns the x coordinate of the element's bounds at the specified element size. | UIComponent | |
| getBoundsYAtSize(width:Number, height:Number, postLayoutTransform:Boolean = true):Number
Returns the y coordinate of the element's bounds at the specified element size. | UIComponent | |
| getClassStyleDeclarations():Array
Finds the type selectors for this UIComponent instance. | UIComponent | |
| getConstraintValue(constraintName:String):*
Returns a layout constraint value, which is the same as
getting the constraint style for this component. | UIComponent | |
| getElementAt(index:int):IVisualElement
Returns the visual element at the specified index. | SkinnableContainer | |
| getElementIndex(element:IVisualElement):int
Returns the index position of a visual element. | SkinnableContainer | |
| getExplicitOrMeasuredHeight():Number
A convenience method for determining whether to use the
explicit or measured height
| UIComponent | |
| getExplicitOrMeasuredWidth():Number
A convenience method for determining whether to use the
explicit or measured width
| UIComponent | |
| getFocus():InteractiveObject
Gets the object that currently has focus. | UIComponent | |
| getLayoutBoundsHeight(postLayoutTransform:Boolean = true):Number
Returns the element's layout height. | UIComponent | |
| getLayoutBoundsWidth(postLayoutTransform:Boolean = true):Number
Returns the element's layout width. | UIComponent | |
| getLayoutBoundsX(postLayoutTransform:Boolean = true):Number
Returns the x coordinate that the element uses to draw on screen. | UIComponent | |
| getLayoutBoundsY(postLayoutTransform:Boolean = true):Number
Returns the y coordinate that the element uses to draw on screen. | UIComponent | |
| getLayoutMatrix():Matrix
Returns the transform matrix that is used to calculate the component's
layout relative to its siblings. | UIComponent | |
| getLayoutMatrix3D():Matrix3D
Returns the layout transform Matrix3D for this element. | UIComponent | |
| getMaxBoundsHeight(postLayoutTransform:Boolean = true):Number
Returns the element's maximum height. | UIComponent | |
| getMaxBoundsWidth(postLayoutTransform:Boolean = true):Number
Returns the element's maximum width. | UIComponent | |
| getMinBoundsHeight(postLayoutTransform:Boolean = true):Number
Returns the element's minimum height. | UIComponent | |
| getMinBoundsWidth(postLayoutTransform:Boolean = true):Number
Returns the element's minimum width. | UIComponent | |
| getPreferredBoundsHeight(postLayoutTransform:Boolean = true):Number
Returns the element's preferred height. | UIComponent | |
| getPreferredBoundsWidth(postLayoutTransform:Boolean = true):Number
Returns the element's preferred width. | UIComponent | |
| getRepeaterItem(whichRepeater:int = -1):Object
Returns the item in the dataProvider that was used
by the specified Repeater to produce this Repeater, or
null if this Repeater isn't repeated. | UIComponent | |
| getStyle(styleProp:String):*
Gets a style property that has been set anywhere in this
component's style lookup chain. | UIComponent | |
| getVisibleRect(targetParent:DisplayObject = null):Rectangle
Get the bounds of this object that are visible to the user
on the screen. | UIComponent | |
[static]
Returns the Window to which a component is parented. | Window | ||
| globalToContent(point:Point):Point
Converts a Point object from global to content coordinates. | UIComponent | |
| hasCSSState():Boolean
Returns true if currentCSSState is not null. | UIComponent | |
| hasState(stateName:String):Boolean
Determines whether the specified state has been defined on this
UIComponent. | UIComponent | |
| horizontalGradientMatrix(x:Number, y:Number, width:Number, height:Number):Matrix
Returns a box Matrix which can be passed to the
drawRoundRect() method
as the rot parameter when drawing a horizontal gradient. | UIComponent | |
| initialize():void
Initializes the internal structure of this component. | UIComponent | |
| initializeRepeaterArrays(parent:IRepeaterClient):void
Initializes various properties which keep track of repeated instances
of this component. | UIComponent | |
| invalidateDisplayList():void
Marks a component so that its updateDisplayList()
method gets called during a later screen update. | UIComponent | |
| invalidateLayering():void
Called by a component's items to indicate that their depth
property has changed. | UIComponent | |
| invalidateLayoutDirection():void
An element must call this method when its layoutDirection changes or
when its parent's layoutDirection changes. | UIComponent | |
| invalidateProperties():void
Marks a component so that its commitProperties()
method gets called during a later screen update. | UIComponent | |
| invalidateSize():void
Marks a component so that its measure()
method gets called during a later screen update. | UIComponent | |
| invalidateSkinState():void
Marks the component so that the new state of the skin is set
during a later screen update. | SkinnableComponent | |
| localToContent(point:Point):Point
Converts a Point object from local to content coordinates. | UIComponent | |
| matchesCSSState(cssState:String):Boolean
Returns true if cssState matches currentCSSState. | UIComponent | |
| matchesCSSType(cssType:String):Boolean
Determines whether this instance is the same as, or is a subclass of,
the given type. | UIComponent | |
| maximize():void
Maximizes the window, or does nothing if it's already maximized. | Window | ||
| measureHTMLText(htmlText:String):TextLineMetrics
Measures the specified HTML text, which can contain HTML tags such
as <font> and <b>,
assuming that it is displayed
in a single-line UITextField using a UITextFormat
determined by the styles of this UIComponent. | UIComponent | |
| measureText(text:String):TextLineMetrics
Measures the specified text, assuming that it is displayed
in a single-line UITextField (or UIFTETextField) using a UITextFormat
determined by the styles of this UIComponent. | UIComponent | |
| minimize():void
Minimizes the window. | Window | ||
| move(x:Number, y:Number):void
Moves the component to a specified position within its parent. | UIComponent | |
| notifyStyleChangeInChildren(styleProp:String, recursive:Boolean):void
Propagates style changes to the children. | UIComponent | |
| open(openWindowActive:Boolean = true):void
Creates the underlying NativeWindow and opens it. | Window | ||
Orders the window just behind another. | Window | ||
Orders the window just in front of another. | Window | ||
| orderToBack():Boolean
Orders the window behind all others in the same application. | Window | ||
| orderToFront():Boolean
Orders the window in front of all others in the same application. | Window | ||
| owns(child:DisplayObject):Boolean
Returns true if the chain of owner properties
points from child to this UIComponent. | UIComponent | |
| parentChanged(p:DisplayObjectContainer):void
Called by Flex when a UIComponent object is added to or removed from a parent. | UIComponent | |
| prepareToPrint(target:IFlexDisplayObject):Object
Prepares an IFlexDisplayObject for printing. | UIComponent | |
| regenerateStyleCache(recursive:Boolean):void
Builds or rebuilds the CSS style cache for this component
and, if the recursive parameter is true,
for all descendants of this component as well. | UIComponent | |
| registerEffects(effects:Array):void
For each effect event, registers the EffectManager
as one of the event listeners. | UIComponent | |
| removeAllElements():void
Removes all visual elements from the container. | SkinnableContainer | |
|
Removes the specified visual element from the child list of
this container. | SkinnableContainer | |
| removeElementAt(index:int):IVisualElement
Removes a visual element from the specified index position
in the container. | SkinnableContainer | |
| removeStyleClient(styleClient:IAdvancedStyleClient):void
Removes a non-visual style client from this component instance. | UIComponent | |
| replayAutomatableEvent(event:Event):Boolean
Replays the specified event. | UIComponent | |
| resolveAutomationIDPart(criteria:Object):Array
Resolves a child by using the id provided. | UIComponent | |
| restore():void
Restores the window (unmaximizes it if it's maximized, or
unminimizes it if it's minimized). | Window | ||
| resumeBackgroundProcessing():void [static]
Resumes the background processing of methods
queued by callLater(), after a call to
suspendBackgroundProcessing(). | UIComponent | |
| setActualSize(w:Number, h:Number):void
Sizes the object. | UIComponent | |
| setConstraintValue(constraintName:String, value:*):void
Sets a layout constraint value, which is the same as
setting the constraint style for this component. | UIComponent | |
| setCurrentState(stateName:String, playTransition:Boolean = true):void
Set the current state. | UIComponent | |
| setElementIndex(element:IVisualElement, index:int):void
Changes the position of an existing visual element in the visual container. | SkinnableContainer | |
| setFocus():void
Sets the focus to this component. | UIComponent | |
| setLayoutBoundsPosition(x:Number, y:Number, postLayoutTransform:Boolean = true):void
Sets the coordinates that the element uses to draw on screen. | UIComponent | |
| setLayoutBoundsSize(width:Number, height:Number, postLayoutTransform:Boolean = true):void
Sets the layout size of the element. | UIComponent | |
| setLayoutMatrix(value:Matrix, invalidateLayout:Boolean):void
Sets the transform Matrix that is used to calculate the component's layout
size and position relative to its siblings. | UIComponent | |
| setLayoutMatrix3D(value:Matrix3D, invalidateLayout:Boolean):void
Sets the transform Matrix3D that is used to calculate the component's layout
size and position relative to its siblings. | UIComponent | |
| setMXMLDescriptor(value:Array):void | UIComponent | |
| setMXMLProperties(value:Array):void | UIComponent | |
| setStyle(styleProp:String, newValue:*):void
Sets a style property on this component instance. | UIComponent | |
| setVisible(value:Boolean, noEvent:Boolean = false):void
Called when the visible property changes. | UIComponent | |
| styleChanged(styleProp:String):void
Detects changes to style properties. | UIComponent | |
| stylesInitialized():void
Flex calls the stylesInitialized() method when
the styles for a component are first initialized. | UIComponent | |
| suspendBackgroundProcessing():void [static]
Blocks the background processing of methods
queued by callLater(),
until resumeBackgroundProcessing() is called. | UIComponent | |
|
Swaps the index of the two specified visual elements. | SkinnableContainer | |
| swapElementsAt(index1:int, index2:int):void
Swaps the visual elements at the two specified index
positions in the container. | SkinnableContainer | |
| toString():String [override]
Returns a string indicating the location of this object
within the hierarchy of DisplayObjects in the Application. | FlexSprite | |
| transformAround(transformCenter:Vector3D, scale:Vector3D = null, rotation:Vector3D = null, translation:Vector3D = null, postLayoutScale:Vector3D = null, postLayoutRotation:Vector3D = null, postLayoutTranslation:Vector3D = null, invalidateLayout:Boolean = true):void
A utility method to update the rotation, scale, and translation of the
transform while keeping a particular point, specified in the component's
own coordinate space, fixed in the parent's coordinate space. | UIComponent | |
| transformPointToParent(localPosition:Vector3D, position:Vector3D, postLayoutPosition:Vector3D):void
A utility method to transform a point specified in the local
coordinates of this object to its location in the object's parent's
coordinates. | UIComponent | |
| validateDisplayList():void
Validates the position and size of children and draws other
visuals. | UIComponent | |
| validateNow():void
Validate and update the properties and layout of this object
and redraw it, if necessary. | UIComponent | |
| validateProperties():void
Used by layout logic to validate the properties of a component
by calling the commitProperties() method. | UIComponent | |
| validateSize(recursive:Boolean = false):void
Validates the measured size of the component
If the LayoutManager.invalidateSize() method is called with
this ILayoutManagerClient, then the validateSize() method
is called when it's time to do measurements. | UIComponent | |
| validationResultHandler(event:ValidationResultEvent):void
Handles both the valid and invalid events from a
validator assigned to this component. | UIComponent | |
| verticalGradientMatrix(x:Number, y:Number, width:Number, height:Number):Matrix
Returns a box Matrix which can be passed to drawRoundRect()
as the rot parameter when drawing a vertical gradient. | UIComponent | |
| Method | Defined By | ||
|---|---|---|---|
| addMXMLChildren(comps:Array):void [override]
override setting of children
| SkinnableContainer | |
| adjustFocusRect(obj:DisplayObject = null):void
Adjust the focus rectangle. | UIComponent | |
| applyComputedMatrix():void
Commits the computed matrix built from the combination of the layout
matrix and the transform offsets to the flash displayObject's transform. | UIComponent | |
| attachOverlay():void
This is an internal method used by the Flex framework
to support the Dissolve effect. | UIComponent | |
| attachSkin():void
Create the skin for the component. | SkinnableComponent | |
| canSkipMeasurement():Boolean
Determines if the call to the measure() method can be skipped. | UIComponent | |
| childrenCreated():void
Performs any final processing after child objects are created. | UIComponent | |
| clearSkinParts():void
Clear out references to skin parts. | SkinnableComponent | |
| commitProperties():void
Processes the properties set on the component. | UIComponent | |
| createChildren():void [override]
Create content children, if the creationPolicy property
is not equal to none. | SkinnableContainer | |
| createDynamicPartInstance(partName:String):Object
Create an instance of a dynamic skin part. | SkinnableComponent | |
| createInFontContext(classObj:Class):Object
Creates a new object using a context
based on the embedded font being used. | UIComponent | |
| createInModuleContext(moduleFactory:IFlexModuleFactory, className:String):Object
Creates the object using a given moduleFactory. | UIComponent | |
| detachSkin():void
Destroys and removes the skin for this component. | SkinnableComponent | |
| dispatchPropertyChangeEvent(prop:String, oldValue:*, value:*):void
Helper method for dispatching a PropertyChangeEvent
when a property is updated. | UIComponent | |
| findSkinParts():void
Find the skin parts in the skin class and assign them to the properties of the component. | SkinnableComponent | |
| focusInHandler(event:FocusEvent):void
The event handler called when a UIComponent object gets focus. | UIComponent | |
| focusOutHandler(event:FocusEvent):void
The event handler called when a UIComponent object loses focus. | UIComponent | |
| generateMXMLAttributes(data:Array):void | UIComponent | |
| generateMXMLInstances(document:Object, data:Array, recursive:Boolean = true):void [override] | SkinnableContainer | |
| generateMXMLObject(document:Object, data:Array):Object | UIComponent | |
| getCurrentSkinState():String [override]
Returns the name of the state to be applied to the skin. | SkinnableContainerBase | |
| getDynamicPartAt(partName:String, index:int):Object
Returns a specific instance of a dynamic part. | SkinnableComponent | |
| initAdvancedLayoutFeatures():void
Initializes the implementation and storage of some of the less frequently
used advanced layout features of a component. | UIComponent | |
| initializationComplete():void
Finalizes the initialization of this component. | UIComponent | |
| initializeAccessibility():void
Initializes this component's accessibility code. | UIComponent | |
|
Helper method to invalidate parent size and display list if
this object affects its layout (includeInLayout is true). | UIComponent | |
| isOurFocus(target:DisplayObject):Boolean
Typically overridden by components containing UITextField objects,
where the UITextField object gets focus. | UIComponent | |
| keyDownHandler(event:KeyboardEvent):void
The event handler called for a keyDown event. | UIComponent | |
| keyUpHandler(event:KeyboardEvent):void
The event handler called for a keyUp event. | UIComponent | |
| measure():void
Calculates the default size, and optionally the default minimum size,
of the component. | UIComponent | |
| numDynamicParts(partName:String):int
Returns the number of instances of a dynamic part. | SkinnableComponent | |
| partAdded(partName:String, instance:Object):void [override]
Called when a skin part is added. | SkinnableContainer | |
| partRemoved(partName:String, instance:Object):void [override]
Called when an instance of a skin part is being removed. | SkinnableContainer | |
| removeDynamicPartInstance(partName:String, instance:Object):void
Remove an instance of a dynamic part. | SkinnableComponent | |
| resourcesChanged():void
This method is called when a UIComponent is constructed,
and again whenever the ResourceManager dispatches
a "change" Event to indicate
that the localized resources have changed in some way. | UIComponent | |
| setStretchXY(stretchX:Number, stretchY:Number):void
Specifies a transform stretch factor in the horizontal and vertical direction. | UIComponent | |
| setupWindowInitOptions():NativeWindowInitOptions
Creates and fills up the NativeWindowInitOptios used to create
the internal nativeWindow. | Window | ||
| stateChanged(oldState:String, newState:String, recursive:Boolean):void
This method is called when a state changes to check whether
state-specific styles apply to this component. | UIComponent | |
| updateDisplayList(unscaledWidth:Number, unscaledHeight:Number):void
Draws the object and/or sizes and positions its children. | UIComponent | |
| Event | Summary | Defined By | ||
|---|---|---|---|---|
| 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 this application gets activated. | Window | |||
| Dispatched when this application gets deactivated. | Window | |||
| Dispatched after the window has been closed. | Window | |||
| Dispatched before the window closes. | Window | |||
| Dispatched after the content for this component has been created. | SkinnableContainer | ||
| 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 after the display state changes to minimize, maximize or restore. | Window | |||
| Dispatched before the display state changes to minimize, maximize or restore. | Window | |||
| 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 | ||
| Dispatched after the component has entered a view state. | UIComponent | ||
| Dispatched just before the component exits a view state. | UIComponent | ||
| Dispatched when an object's state changes from visible to invisible. | UIComponent | ||
| Dispatched when the component has finished its construction and has all initialization properties set. | UIComponent | ||
| Dispatched when a component is monitored by a Validator and the validation failed. | UIComponent | ||
| Dispatched from a component opened using the PopUpManager when the user clicks outside it. | UIComponent | ||
| 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 window moves, and while the window is being dragged. | Window | |||
| Dispatched when the computer connects to or disconnects from the network. | Window | |||
| Dispatched at the beginning of the component initialization sequence. | UIComponent | ||
| Dispatched when the component is removed from a container as a content child by using the removeChild(), removeChildAt(), removeElement(), or removeElementAt() method. | UIComponent | ||
| Dispatched when the component is resized. | UIComponent | ||
| Dispatched before the underlying NativeWindow is resized, or while the Window object boundaries are being dragged. | Window | |||
| Dispatched when an object's state changes from invisible to visible. | UIComponent | ||
| 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 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 | ||
| 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 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 the window has been activated. | Window | |||
| Dispatched when the Window completes its initial layout and opens the underlying NativeWindow. | Window | |||
| Dispatched after the window has been deactivated. | Window | |||
| Dispatched after the window moves. | Window | |||
| Dispatched after the underlying NativeWindow is resized. | Window | |||
| Style | Description | Defined By | ||
|---|---|---|---|---|
| Type: uint Format: Color CSS Inheritance: yes Theme: spark, mobile Accent color used by component skins. | SkinnableContainer | ||
| Type: String CSS Inheritance: yes Specifies the baseline to which the dominant baseline aligns. See also | SkinnableContainer | ||
| Type: Array Format: Color CSS Inheritance: yes Theme: spark, mobile The colors to use for the backgrounds of the items in the list. | SkinnableContainer | ||
backgroundAlpha | Type: Number CSS Inheritance: no Alpha level of the color defined by the backgroundColor
property.
The default value is 1.0. | Window | ||
backgroundColor | Type: uint Format: Color CSS Inheritance: no 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. The default value is 0xFFFFFF. | Window | ||
| Type: String CSS Inheritance: no The vertical distance in pixels from the top edge of the content area to the control's baseline position. | UIComponent | ||
| Type: Object CSS Inheritance: yes Amount to shift the baseline. See also | SkinnableContainer | ||
| Type: String CSS Inheritance: yes Specifies a vertical or horizontal progression of line placement. See also | SkinnableContainer | ||
| Type: String CSS Inheritance: no The vertical distance, in pixels, from the bottom edge of the component to the bottom edge of its parent container's content area. | UIComponent | ||
| Type: String CSS Inheritance: yes Controls where lines are allowed to break when breaking wrapping text into multiple lines. See also | SkinnableContainer | ||
| Type: String CSS Inheritance: yes The type of CFF hinting used for this text. See also | SkinnableContainer | ||
| Type: uint Format: Color CSS Inheritance: yes Theme: spark, mobile The main color for a component. | SkinnableComponent | ||
| Type: String CSS Inheritance: yes Controls how text wraps around a float. See also | SkinnableContainer | ||
| Type: uint Format: Color CSS Inheritance: yes Color of the text. See also | SkinnableContainer | ||
| Type: String CSS Inheritance: yes Controls column break after the element. See also | SkinnableContainer | ||
| Type: String CSS Inheritance: yes Controls column break before the element. See also | SkinnableContainer | ||
| Type: String CSS Inheritance: yes Controls container break after the element. See also | SkinnableContainer | ||
| Type: String CSS Inheritance: yes Controls container break before the element. See also | SkinnableContainer | ||
| Type: Number CSS Inheritance: yes Theme: spark, mobile The alpha of the content background for this component. | SkinnableContainer | ||
| Type: uint Format: Color CSS Inheritance: yes Theme: spark, mobile The color of the content background for this component. | SkinnableContainer | ||
| Type: String CSS Inheritance: yes The type of digit case used for this text. See also | SkinnableContainer | ||
| Type: String CSS Inheritance: yes Type of digit width used for this text. See also | SkinnableContainer | ||
| Type: String CSS Inheritance: yes Specifies the default bidirectional embedding level of the text. See also | SkinnableContainer | ||
| Type: String CSS Inheritance: yes Specifies which element baseline snaps to the alignmentBaseline to determine the vertical position of the element on the line.See also | SkinnableContainer | ||
| Type: uint Format: Color CSS Inheritance: yes Theme: mobile Color of the background of an item renderer when it is being pressed down If The default value for the Spark theme is | SkinnableContainer | ||
| Type: uint Format: Color CSS Inheritance: yes Color of the component highlight when validation fails. | UIComponent | ||
| Type: Class Name of the skin class to use for this component when a validation error occurs. | SkinnableComponent | ||
| Type: Object CSS Inheritance: yes Specifies the baseline position of the first line in the container. See also | SkinnableContainer | ||
| Type: uint Format: Color CSS Inheritance: yes Theme: spark, mobile Color of focus ring when the component is in focus. | SkinnableContainer | ||
| Type: uint Format: Color CSS Inheritance: yes The color of text when the component is enabled and has focus. | SkinnableContainer | ||
| Type: Class CSS Inheritance: no Skin used to draw the focus rectangle. | UIComponent | ||
| Type: String CSS Inheritance: yes The name of the font to use, or a comma-separated list of font names. See also | SkinnableContainer | ||
| Type: String CSS Inheritance: yes Font lookup to use. See also | SkinnableContainer | ||
| Type: Number Format: Length CSS Inheritance: yes Height of the text, in pixels. See also | SkinnableContainer | ||
| Type: String CSS Inheritance: yes Determines whether the text is italic font. See also | SkinnableContainer | ||
| Type: String CSS Inheritance: yes Determines whether the text is boldface. See also | SkinnableContainer | ||
| Type: String CSS Inheritance: no The horizontal distance in pixels from the center of the component's content area to the center of the component. | UIComponent | ||
| Type: uint Format: Color CSS Inheritance: yes The color of text when the component is disabled. | SkinnableContainer | ||
| Type: String CSS Inheritance: yes The primary interaction mode for this component. See also | UIComponent | ||
| Type: String CSS Inheritance: yes Rule used to justify text in a paragraph. See also | SkinnableContainer | ||
| Type: String CSS Inheritance: yes The style used for justification of the paragraph. See also | SkinnableContainer | ||
| Type: String CSS Inheritance: yes The style used for justification of the paragraph. See also | SkinnableContainer | ||
| Type: String CSS Inheritance: yes Specifies the desired layout direction of a component. See also | UIComponent | ||
| Type: Number Format: Length CSS Inheritance: yes Theme: mobile Additional vertical space between lines of text. See also | SkinnableContainer | ||
| Type: String CSS Inheritance: yes Specifies the leading model, which is a combination of leading basis and leading direction. See also | SkinnableContainer | ||
| Type: String CSS Inheritance: no The horizontal distance, in pixels, from the left edge of the component to the left edge of its parent container's content area. | UIComponent | ||
| Type: Number CSS Inheritance: yes Theme: mobile The number of additional pixels to appear between each character. See also | SkinnableContainer | ||
| Type: String CSS Inheritance: yes Controls which of the ligatures that are defined in the font may be used in the text. See also | SkinnableContainer | ||
| Type: Object CSS Inheritance: yes Leading controls for the text. See also | SkinnableContainer | ||
| Type: Boolean CSS Inheritance: yes If true, applies strikethrough, a line drawn through the middle of the text. See also | SkinnableContainer | ||
| Type: Number Format: length CSS Inheritance: yes This specifies an auto indent for the start edge of lists when the padding value of the list on that side is auto.See also | SkinnableContainer | ||
| Type: String CSS Inheritance: yes This controls the placement of a list item marker relative to the list item. See also | SkinnableContainer | ||
| Type: String CSS Inheritance: yes This controls the appearance of items in a list. See also | SkinnableContainer | ||
| Type: String CSS Inheritance: yes The locale of the text. See also | SkinnableContainer | ||
| Type: Number Format: length CSS Inheritance: yes The amount to indent the paragraph's end edge. See also | SkinnableContainer | ||
| Type: Number Format: length CSS Inheritance: yes The amount of space to leave after the paragraph. See also | SkinnableContainer | ||
| Type: Number Format: length CSS Inheritance: yes The amount of space to leave before the paragraph. See also | SkinnableContainer | ||
| Type: Number Format: length CSS Inheritance: yes The amount to indent the paragraph's start edge. See also | SkinnableContainer | ||
| Type: String CSS Inheritance: yes The rendering mode used for this text which applies only to embedded fonts. See also | SkinnableContainer | ||
resizeAffordanceWidth | Type: Number Format: length CSS Inheritance: no 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. | Window | ||
| Type: String CSS Inheritance: no The horizontal distance, in pixels, from the right edge of the component to the right edge of its parent container's content area. | UIComponent | ||
| Type: uint Format: Color CSS Inheritance: yes Theme: spark Color of the highlights when the mouse is over the component. | SkinnableContainer | ||
| Type: Boolean CSS Inheritance: yes Show the error border or skin when this component is invalid. | UIComponent | ||
| Type: Boolean CSS Inheritance: yes Show the error tip when this component is invalid and the user rolls over it. | UIComponent | ||
| Type: Class Name of the skin class to use for this component. | SkinnableComponent | ||
| Type: uint Format: Color CSS Inheritance: yes Theme: spark, mobile Color of any symbol of a component. | SkinnableContainer | ||
| Type: String CSS Inheritance: yes Specifies the tab stops associated with the paragraph. See also | SkinnableContainer | ||
| Type: String CSS Inheritance: yes Alignment of text within a container. See also | SkinnableContainer | ||
| Type: String CSS Inheritance: yes Alignment of the last line in the paragraph relative to the container in justified text. See also | SkinnableContainer | ||
| Type: Number CSS Inheritance: yes Alpha (transparency) value for the text. See also | SkinnableContainer | ||
| Type: String CSS Inheritance: yes Determines whether the text is underlined. See also | SkinnableContainer | ||
| Type: Number Format: Length CSS Inheritance: yes Offset of first line of text from the left side of the container. See also | SkinnableContainer | ||
| Type: String CSS Inheritance: yes Specifies options for justifying text. See also | SkinnableContainer | ||
| Type: String CSS Inheritance: yes Determines the number of degrees to rotate this text. See also | SkinnableContainer | ||
| Type: Number CSS Inheritance: yes Theme: mobile Alpha of text shadows. | SkinnableContainer | ||
| Type: uint Format: Color CSS Inheritance: yes Theme: mobile Color of text shadows. | SkinnableContainer | ||
| Type: String CSS Inheritance: no The vertical distance, in pixels, from the top edge of the component to the top edge of its parent container's content area. | UIComponent | ||
| Type: Number Format: Time CSS Inheritance: yes When in touch interaction mode, the number of milliseconds to wait after the user interaction has occured before showing the component in a visually down state. | SkinnableContainer | ||
| Type: Object CSS Inheritance: yes The amount of tracking (manual kerning) to be applied to the left of each character. See also | SkinnableContainer | ||
| Type: Object CSS Inheritance: yes The amount of tracking (manual kerning) to be applied to the right of each character. See also | SkinnableContainer | ||
| Type: String CSS Inheritance: yes The type of typographic case used for this text. See also | SkinnableContainer | ||
| Type: uint Format: Color CSS Inheritance: yes The color of text when the component is enabled but does not have focus. | SkinnableContainer | ||
| Type: String CSS Inheritance: no The vertical distance in pixels from the center of the component's content area to the center of the component. | UIComponent | ||
| Type: String CSS Inheritance: yes Collapses or preserves whitespace when importing text into a TextFlow. See also | SkinnableContainer | ||
| Type: Object CSS Inheritance: yes Specifies the spacing between words to use during justification. See also | SkinnableContainer | ||
This component uses skins made up of skin parts. Do not set the skin parts directly. The component's skin sets the skin parts.
| Skin Part | Description | Defined By | ||
|---|---|---|---|---|
| Required: false Part Type: Static An optional skin part that defines the Group where the content children get pushed into and laid out. | SkinnableContainer | ||
gripper:Button | Required: false Part Type: Static The skin part that defines the gripper button used to resize the window. | Window | ||
statusBar:IVisualElement | Required: false Part Type: Static The skin part that defines the display of the status bar. | Window | ||
statusText:TextBase | Required: false Part Type: Static The skin part that defines the display of the status bar's text. | Window | ||
titleBar:TitleBar | Required: false Part Type: Static The skin part that defines the title bar. | Window | ||
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 | SkinnableContainerBase | ||
disabledAndInactive | The application is disabled and inactive. | Window | ||
| Normal State | SkinnableContainerBase | ||
normalAndInactive | The application is enabled and inactive. | Window | ||
| 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. | Window | ||
| 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. | Window | ||
| 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. | Window | ||
| 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 (including those of other applications). Setting
this property sets the alwaysInFront property of the
underlying NativeWindow. See the NativeWindow.alwaysInFront
property description for details of how this affects window stacking
order.
public function get alwaysInFront():Boolean public function set alwaysInFront(value:Boolean):voidSee also
| closed | property |
closed:Boolean [read-only] | Language Version : | ActionScript 3.0 |
| Product Version : | Flex 4 |
| Runtime Versions : | AIR 1.5 |
A flag indicating whether the window has been closed.
public function get closed():Boolean| colorCorrection | property |
colorCorrection:String| Language Version : | ActionScript 3.0 |
| Product Version : | Flex 4 |
| Runtime Versions : | AIR 1.5 |
The value of the stage's colorCorrection property. If this application
does not have access to the stage's colorCorrection property,
the value of the colorCorrection property will be reported as
null. Only the main application is allowed to set the colorCorrection
property. If a sub-application's needs to set the color correction property it will
need to set it via the main application's instance, either directly using an object
instance or via an event (there is no framework event for this purpose).
The default value is ColorCorrection.DEFAULT.
public function get colorCorrection():String public function set colorCorrection(value:String):void| maximizable | property |
maximizable:Boolean| Language Version : | ActionScript 3.0 |
| Product Version : | Flex 4 |
| Runtime Versions : | AIR 1.5 |
Specifies whether the window can be maximized. This property's value is read-only after the window has been opened.
public function get maximizable():Boolean public function set maximizable(value:Boolean):void| menu | property |
menu:FlexNativeMenu| Language Version : | ActionScript 3.0 |
| Product Version : | Flex 4 |
| Runtime Versions : | AIR 1.5 |
The window menu for this window. Some operating systems do not support window menus, in which case this property is ignored.
public function get menu():FlexNativeMenu public function set menu(value:FlexNativeMenu):void| minimizable | property |
minimizable:Boolean| Language Version : | ActionScript 3.0 |
| Product Version : | Flex 4 |
| Runtime Versions : | AIR 1.5 |
Specifies whether the window can be minimized. This property is read-only after the window has been opened.
public function get minimizable():Boolean public function set minimizable(value:Boolean):void| nativeWindow | property |
nativeWindow:NativeWindow [read-only] | Language Version : | ActionScript 3.0 |
| Product Version : | Flex 4 |
| Runtime Versions : | AIR 1.5 |
The underlying NativeWindow that this Window component uses.
public function get nativeWindow():NativeWindow| renderMode | property |
renderMode:String| Language Version : | ActionScript 3.0 |
| Product Version : | Flex 4 |
| Runtime Versions : | AIR 1.5 |
Specifies the render mode of the NativeWindow object.
Constants for the valid values of this property are defined in the NativeWindowRenderMode class
If not specified, the default value for renderMode is NativeWindowRenderMode.AUTO.
This property is read-only after the window has been opened.
public function get renderMode():String public function set renderMode(value:String):void| resizable | property |
resizable:Boolean| Language Version : | ActionScript 3.0 |
| Product Version : | Flex 4 |
| Runtime Versions : | AIR 1.5 |
Specifies whether the window can be resized. This property is read-only after the window has been opened.
public function get resizable():Boolean public function set resizable(value:Boolean):void| 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.
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.
public function get status():String public function set status(value:String):void| systemChrome | property |
systemChrome:String| 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.
This property is read-only once the window has been opened.
The default value is NativeWindowSystemChrome.STANDARD.
public function get systemChrome():String public function set systemChrome(value:String):voidSee also
| title | property |
title:String| Language Version : | ActionScript 3.0 |
| Product Version : | Flex 4 |
| Runtime Versions : | AIR 1.5 |
The title text that appears in the window title bar and the taskbar.
The default value is "".
This property can be used as the source for data binding.
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.
public function get titleIcon():Class public function set titleIcon(value:Class):void| transparent | property |
transparent:Boolean| Language Version : | ActionScript 3.0 |
| Product Version : | Flex 4 |
| Runtime Versions : | AIR 1.5 |
Specifies whether the window is transparent. Setting this
property to true for a window that uses
system chrome is not supported.
This property is read-only after the window has been opened.
public function get transparent():Boolean public function set transparent(value:Boolean):void| type | property |
type:String| 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.
This property is read-only once the window has been opened.
The default value is NativeWindowType.NORMAL.
public function get type():String public function set type(value:String):voidSee also
| Window | () | Constructor |
public function Window()| Language Version : | ActionScript 3.0 |
| Product Version : | Flex 4 |
| Runtime Versions : | AIR 1.5 |
Constructor.
| 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 Window's application is not currently active).
| close | () | method |
public function close():void| Language Version : | ActionScript 3.0 |
| Product Version : | Flex 4 |
| Runtime Versions : | AIR 1.5 |
Closes the window. This action is cancelable.
| getWindow | () | method |
public static function getWindow(component:UIComponent):IWindow| Language Version : | ActionScript 3.0 |
| Product Version : | Flex 4 |
| Runtime Versions : | AIR 1.5 |
Returns the Window to which a component is parented.
Parameters
component:UIComponent — The component whose Window you wish to find.
|
IWindow — An IWindow object.
|
| 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.
| open | () | method |
public function open(openWindowActive:Boolean = true):void| Language Version : | ActionScript 3.0 |
| Product Version : | Flex 4 |
| Runtime Versions : | AIR 1.5 |
Creates the underlying NativeWindow and opens it. After being closed, the Window object is still a valid reference, but accessing most properties and methods will not work. Closed windows cannot be reopened.
Parameters
openWindowActive:Boolean (default = true)true.
|
| 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 |
public function orderToBack():Boolean| Language Version : | ActionScript 3.0 |
| Product Version : | Flex 4 |
| Runtime Versions : | AIR 1.5 |
Orders the window behind all others in the same application.
ReturnsBoolean — true if the window was successfully sent to the back;
false if the window is invisible or minimized.
|
| 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).
| setupWindowInitOptions | () | method |
protected function setupWindowInitOptions():NativeWindowInitOptions| Language Version : | ActionScript 3.0 |
| Product Version : | Flex 4.6 |
| Runtime Versions : | AIR 3.0 |
Creates and fills up the NativeWindowInitOptios used to create the internal nativeWindow.
ReturnsNativeWindowInitOptions |
| applicationActivate | Event |
mx.events.AIREventmx.events.AIREvent.APPLICATION_ACTIVATE| Language Version : | ActionScript 3.0 |
| Product Version : | Flex 4 |
| Runtime Versions : | AIR 1.5 |
Dispatched when this application gets activated.
The AIREvent.APPLICATION_ACTIVATE constant defines the value of thetype property of the event object for an
applicationActivate event.
The properties of the event object have the following values:
| Property | Value |
|---|---|
bubbles | false |
cancelable | false |
currentTarget | The Object that defines the
event listener that handles the event. For example, if you use
myButton.addEventListener() to register an event listener,
myButton is the value of the currentTarget. |
file | The File object associated with this event. |
target | The Object that dispatched the event;
it is not always the Object listening for the event.
Use the currentTarget property to always access the
Object listening for the event. |
type | AIREvent.APPLICATION_ACTIVATE |
| applicationDeactivate | Event |
mx.events.AIREventmx.events.AIREvent.APPLICATION_DEACTIVATE| Language Version : | ActionScript 3.0 |
| Product Version : | Flex 4 |
| Runtime Versions : | AIR 1.5 |
Dispatched when this application gets deactivated.
The AIREvent.APPLICATION_DEACTIVATE constant defines the value of thetype property of the event object for an
applicationDeactivate event.
The properties of the event object have the following values:
| Property | Value |
|---|---|
bubbles | false |
cancelable | false |
currentTarget | The Object that defines the
event listener that handles the event. For example, if you use
myButton.addEventListener() to register an event listener,
myButton is the value of the currentTarget. |
file | The File object associated with this event. |
target | The Object that dispatched the event;
it is not always the Object listening for the event.
Use the currentTarget property to always access the
Object listening for the event. |
type | AIREvent.APPLICATION_DEACTIVATE |
| close | Event |
flash.events.Eventflash.events.Event.CLOSE| Language Version : | ActionScript 3.0 |
| Product Version : | Flex 4 |
| Runtime Versions : | AIR 1.5 |
Dispatched after the window has been closed.
See also
| closing | Event |
flash.events.Eventflash.events.Event.CLOSING| Language Version : | ActionScript 3.0 |
| Product Version : | Flex 4 |
| Runtime Versions : | AIR 1.5 |
Dispatched before the window closes. This event is cancelable.
See also
| displayStateChange | Event |
flash.events.NativeWindowDisplayStateEventflash.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.
| displayStateChanging | Event |
flash.events.NativeWindowDisplayStateEventflash.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.
| moving | Event |
flash.events.NativeWindowBoundsEventflash.events.NativeWindowBoundsEvent.MOVING| Language Version : | ActionScript 3.0 |
| Product Version : | Flex 4 |
| Runtime Versions : | AIR 1.5 |
Dispatched before the window moves, and while the window is being dragged.
| networkChange | Event |
flash.events.Eventflash.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.
| resizing | Event |
flash.events.NativeWindowBoundsEventflash.events.NativeWindowBoundsEvent.RESIZING| Language Version : | ActionScript 3.0 |
| Product Version : | Flex 4 |
| Runtime Versions : | AIR 1.5 |
Dispatched before the underlying NativeWindow is resized, or while the Window object boundaries are being dragged.
| windowActivate | Event |
mx.events.AIREventmx.events.AIREvent.WINDOW_ACTIVATE| Language Version : | ActionScript 3.0 |
| Product Version : | Flex 4 |
| Runtime Versions : | AIR 1.5 |
Dispatched after the window has been activated.
The AIREvent.WINDOW_ACTIVATE constant defines the value of thetype property of the event object for a
windowActivate event.
The properties of the event object have the following values:
| Property | Value |
|---|---|
bubbles | false |
cancelable | false |
currentTarget | The Object that defines the
event listener that handles the event. For example, if you use
myButton.addEventListener() to register an event listener,
myButton is the value of the currentTarget. |
file | The File object associated with this event. |
target | The Object that dispatched the event;
it is not always the Object listening for the event.
Use the currentTarget property to always access the
Object listening for the event. |
type | AIREvent.WINDOW_ACTIVATE |
| windowComplete | Event |
mx.events.AIREventmx.events.AIREvent.WINDOW_COMPLETE| Language Version : | ActionScript 3.0 |
| Product Version : | Flex 4 |
| Runtime Versions : | AIR 1.5 |
Dispatched when the Window completes its initial layout and opens the underlying NativeWindow.
The AIREvent.WINDOW_COMPLETE constant defines the value of thetype property of the event object for an
windowComplete event.
The properties of the event object have the following values:
| Property | Value |
|---|---|
bubbles | false |
cancelable | false |
currentTarget | The Object that defines the
event listener that handles the event. For example, if you use
myButton.addEventListener() to register an event listener,
myButton is the value of the currentTarget. |
file | The File object associated with this event. |
target | The Object that dispatched the event;
it is not always the Object listening for the event.
Use the currentTarget property to always access the
Object listening for the event. |
type | AIREvent.WINDOW_COMPLETE |
| windowDeactivate | Event |
mx.events.AIREventmx.events.AIREvent.WINDOW_DEACTIVATE| Language Version : | ActionScript 3.0 |
| Product Version : | Flex 4 |
| Runtime Versions : | AIR 1.5 |
Dispatched after the window has been deactivated.
The AIREvent.WINDOW_DEACTIVATE constant defines the value of thetype property of the event object for a
windowDeactivate event.
The properties of the event object have the following values:
| Property | Value |
|---|---|
bubbles | false |
cancelable | false |
currentTarget | The Object that defines the
event listener that handles the event. For example, if you use
myButton.addEventListener() to register an event listener,
myButton is the value of the currentTarget. |
file | The File object associated with this event. |
target | The Object that dispatched the event;
it is not always the Object listening for the event.
Use the currentTarget property to always access the
Object listening for the event. |
type | AIREvent.WINDOW_DEACTIVATE |
| windowMove | Event |
mx.events.FlexNativeWindowBoundsEventmx.events.FlexNativeWindowBoundsEvent.WINDOW_MOVE| Language Version : | ActionScript 3.0 |
| Product Version : | Flex 4 |
| Runtime Versions : | AIR 1.5 |
Dispatched after the window moves.
The FlexNativeWindowBoundsEvent.WINDOW_MOVE constant defines the value of thetype property of the event object for a
windowMove event.
The properties of the event object have the following values:
| Property | Value |
|---|---|
afterBounds | The bounds of the window after the bounds changed. |
beforeBounds | The bounds of the window before the bounds changed. |
bubbles | false |
cancelable | false |
currentTarget | The Object that defines the
event listener that handles the event. For example, if you use
myButton.addEventListener() to register an event listener,
myButton is the value of the currentTarget. |
file | The File object associated with this event. |
target | The Object that dispatched the event;
it is not always the Object listening for the event.
Use the currentTarget property to always access the
Object listening for the event. |
type | FlexNativeWindowBoundsEvent.WINDOW_MOVE |
| windowResize | Event |
mx.events.FlexNativeWindowBoundsEventmx.events.FlexNativeWindowBoundsEvent.WINDOW_RESIZE| Language Version : | ActionScript 3.0 |
| Product Version : | Flex 4 |
| Runtime Versions : | AIR 1.5 |
Dispatched after the underlying NativeWindow 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 |