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

Package | spark.components
Class | public class ViewNavigator
Inheritance | ViewNavigator ViewNavigatorBase SkinnableContainer SkinnableContainerBase SkinnableComponent UIComponent FlexSprite flash.display.Sprite

Language Version : | ActionScript 3.0

Product Version : | Flex 4.5

Runtime Versions : | AIR 2.5

The ViewNavigator component is a container that consists of a collection of View objects, where only the top most view is visible and active. Use the ViewNavigator container to control the navigation among the views of a mobile application. The ViewNavigatorApplication container automatically creates a single ViewNavigator container for the entire application.

Navigation in a mobile application is controlled by a stack of View objects. The top View object on the stack defines the currently visible view. The ViewNavigator container maintains the stack. To change views, push a new View object onto the stack, or pop the current View object off of the stack. Popping the currently visible View object from the stack destroys the View object, and returns the user to the previous view on the stack.

When a view is pushed on top of the stack, the old view's `data` property is automatically persisted. It is restored when the view is reactived as a result of the current view being popped off the stack. When a new view becomes active by being pushed onto the stack, the old view's instance is destroyed.

The ViewNavigator displays an optional ActionBar control that displays contextual information defined by the active view. When the active view changes, the action bar is automatically updated.

MXML Syntax Show MXML Syntax
Hide MXML Syntax

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

      <s:ViewNavigator
       Properties
        actionContent="null"
        actionLayout="null"
        defaultPopTransition="SlideViewTransition"
        defaultPushTransition="SlideViewTransition"
        firstView="null"
        firstViewData="null"
        navigationContent="null"
        navigationLayout="null"
        poppedViewReturnedObject="null"
        title=""
        titleContent="null"
        titleLayout="null"

      >

Default MXML Property `navigationStack`

View the examples

See also

spark.components.View
spark.components.ActionBar
spark.components.TabbedViewNavigator
spark.transitions.ViewTransitionBase

Public Properties
Hide Inherited Public Properties
Show Inherited Public Properties

| Property | Defined By
--- | --- | ---
|  | accessibilityDescription : String A convenience accessor for the description property in this UIComponent's accessibilityProperties object. | UIComponent
|  | accessibilityEnabled : Boolean A convenience accessor for the silent property in this UIComponent's accessibilityProperties object. | UIComponent
|  | accessibilityName : String A convenience accessor for the name property in this UIComponent's accessibilityProperties object. | UIComponent
|  | accessibilityShortcut : String A convenience accessor for the shortcut property in this UIComponent's accessibilityProperties object. | UIComponent
|  | actionContent : Array This property overrides the actionContent property in the ActionBar and ViewNavigatorApplication components. The components that define actions the user can take in a view. | ViewNavigator
|  | actionLayout : LayoutBase The components that define actions the user can take in a view. | ViewNavigator
|  | activeEffects : Array [read-only] The list of effects that are currently playing on the component, as an Array of EffectInstance instances. | UIComponent
|  | activeView : View [override] [read-only] During a view transition, this property references the view that the navigator is transitioning to. The currently active view of the navigator. | ViewNavigator
|  | 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
|  | 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
|  | context : Object [read-only] The string that describes the context in which the current view was created. | ViewNavigator
|  | 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
|  | defaultPopTransition : ViewTransitionBase Specifies the default view transition for pop navigation operations. | ViewNavigator
|  | defaultPushTransition : ViewTransitionBase Specifies the default view transition for push navigation operations. | ViewNavigator
|  | 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
|  | firstView : Class Each view in an application corresponds to a View container class defined in an ActionScript or MXML file. | ViewNavigator
|  | firstViewData : Object The Object to pass to the data property of the first view when the navigator is initialized. | ViewNavigator
|  | 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
|  | icon : Object The icon used when this navigator is represented by a visual component. | ViewNavigatorBase
|  | 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
|  | isActive : Boolean [read-only] Set to true when this navigator is active. | ViewNavigatorBase
|  | isDocument : Boolean [read-only] Contains true if this UIComponent instance is a document object. | UIComponent
|  | isPopUp : Boolean Set to true by the PopUpManager to indicate that component has been popped up. | UIComponent
|  | label : String The label used when this navigator is represented by a visual component. | ViewNavigatorBase
|  | 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
|  | length : int [read-only] Returns the number of views being managed by the navigator. | ViewNavigator
|  | 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
|  | maxWidth : Number The maximum recommended width of the component to be considered by the parent during layout. | UIComponent
|  | measuredHeight : Number The default height of the component, in pixels. | UIComponent
|  | measuredMinHeight : Number The default minimum height of the component, in pixels. | UIComponent
|  | measuredMinWidth : Number The default minimum width of the component, in pixels. | UIComponent
|  | measuredWidth : Number The default width of the component, in pixels. | UIComponent
|  | minHeight : Number The minimum recommended height of the component to be considered by the parent during layout. | UIComponent
|  | minWidth : Number The minimum recommended width of the component to be considered by the parent during layout. | UIComponent
|  | moduleFactory : IFlexModuleFactory A module factory is used as context for using embedded fonts and for finding the style manager that controls the styles for this component. | UIComponent
|  | mouseFocusEnabled : Boolean Whether you can receive focus when clicked on. | UIComponent
|  | 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
|  | navigationContent : Array This property overrides the navigationContent property in the ActionBar and ViewNavigatorApplication components. The components that define navigation for the user. | ViewNavigator
|  | navigationLayout : LayoutBase Defines the layout of the components contained in the navigationGroup skin part. | ViewNavigator
|  | 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
|  | parentNavigator : ViewNavigatorBase [read-only] The parent navigator for this navigator. | ViewNavigatorBase
|  | 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
|  | poppedViewReturnedObject : ViewReturnObject [read-only] Holds the object returned by the last view that was popped off the navigation stack or replaced by another view. | ViewNavigator
|  | 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
|  | repeater : IRepeater [read-only] A reference to the Repeater object in the parent document that produced this UIComponent. | UIComponent
|  | repeaterIndex : int [read-only] The index of the item in the data provider of the Repeater that produced this UIComponent. | UIComponent
|  | repeaterIndices : Array An Array containing the indices of the items in the data provider of the Repeaters in the parent document that produced this UIComponent. | UIComponent
|  | repeaters : Array An Array containing references to the Repeater objects in the parent document that produced this UIComponent. | UIComponent
|  | right : Object For components, this layout constraint property is a facade on top of the similarly-named style. | UIComponent
|  | rotation : Number [override] | UIComponent
|  | rotationX : Number [override] Indicates the x-axis rotation of the DisplayObject instance, in degrees, from its original orientation relative to the 3D parent container. | UIComponent
|  | rotationY : Number [override] Indicates the y-axis rotation of the DisplayObject instance, in degrees, from its original orientation relative to the 3D parent container. | UIComponent
|  | rotationZ : Number [override] | UIComponent
|  | scaleX : Number [override] Number that specifies the horizontal scaling factor. | UIComponent
|  | scaleY : Number [override] Number that specifies the vertical scaling factor. | UIComponent
|  | scaleZ : Number [override] Number that specifies the scaling factor along the z axis. | UIComponent
|  | screen : Rectangle [read-only] Returns an object that contains the size and position of the base drawing surface for this object. | UIComponent
|  | showInAutomationHierarchy : Boolean A flag that determines if an automation object shows in the automation hierarchy. | UIComponent
|  | 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
|  | 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
|  | 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 This property overrides the title property in the ActionBar and ViewNavigatorApplication components. Title or caption displayed in the title area. | ViewNavigator
|  | titleContent : Array This property overrides the titleContent property in the ActionBar and ViewNavigatorApplication components. The components that appear in the title area of the control. | ViewNavigator
|  | titleLayout : LayoutBase Defines the layout of the titleGroup and titleDisplay skin parts. | ViewNavigator
|  | 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
|  | transitionsEnabled : Boolean Set to true to enable view transitions when a view changes, or when the ActionBar control or TabBar control visibility changes. | ViewNavigatorBase
|  | tweeningProperties : Array Array of properties that are currently being tweened on this object. | UIComponent
|  | uid : String A unique identifier for the object. | UIComponent
|  | updateCompletePendingFlag : Boolean A flag that determines if an object has been through all three phases of layout validation (provided that any were required). | UIComponent
|  | validationSubField : String Used by a validator to associate a subfield with this component. | UIComponent
|  | verticalCenter : Object For components, this layout constraint property is a facade on top of the similarly-named style. | UIComponent
|  | visible : Boolean [override] Whether or not the display object is visible. | UIComponent
|  | width : Number [override] Number that specifies the width of the component, in pixels, in the parent's coordinates. | UIComponent
|  | x : Number [override] Number that specifies the component's horizontal position, in pixels, within its parent container. | UIComponent
|  | y : Number [override] Number that specifies the component's vertical position, in pixels, within its parent container. | UIComponent
|  | z : Number [override] | UIComponent

Protected Properties
Hide Inherited Protected Properties
Show Inherited Protected Properties

| Property | Defined By
--- | --- | ---
|  | currentCSSState : String [override] [read-only] The state to be used when matching CSS pseudo-selectors. | SkinnableComponent
|  | hasComplexLayoutMatrix : Boolean [read-only] Returns true if the UIComponent has any non-translation (x,y) transform properties. | UIComponent
|  | resourceManager : IResourceManager [read-only] A reference to the object which manages all of the application's localized resources. | UIComponent
|  | unscaledHeight : Number [read-only] A convenience method for determining the unscaled height of the component. | UIComponent
|  | unscaledWidth : Number [read-only] A convenience method for determining the unscaled width of the component All of a component's drawing and child layout should be done within a bounding rectangle of this width, which is also passed as an argument to updateDisplayList(). | UIComponent

Public Methods
Hide Inherited Public Methods
Show Inherited Public Methods

| Method | Defined By
--- | --- | ---
|  | ViewNavigator() Constructor. | ViewNavigator
|  | addElement(element:IVisualElement):IVisualElement Adds a visual element to this container. | SkinnableContainer
|  | addElementAt(element:IVisualElement, index:int):IVisualElement Adds a visual element to this container. | SkinnableContainer
|  | addStyleClient(styleClient:IAdvancedStyleClient):void Adds a non-visual style client to this component instance. | UIComponent
|  | backKeyUpHandler():void [override] Pops to the previous view of the navigator in response to the back key. | ViewNavigator
|  | callLater(method:Function, args:Array = null):void Queues a function to be called later. | UIComponent
|  | clearStyle(styleProp:String):void Deletes a style property from this component instance. | UIComponent
|  | contentToGlobal(point:Point):Point 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
|  | determineTextFormatFromStyles():UITextFormat Returns a UITextFormat object corresponding to the text styles for this UIComponent. | UIComponent
|  | dispatchEvent(event:Event):Boolean [override] Dispatches an event into the event flow. | UIComponent
|  | drawFocus(isFocused:Boolean):void Shows or hides the focus indicator around this component. | UIComponent
|  | drawRoundRect(x:Number, y:Number, w:Number, h:Number, r:Object = null, c:Object = null, alpha:Object = null, rot:Object = null, gradient:String = null, ratios:Array = null, hole:Object = null):void Programmatically draws a rectangle into this skin's Graphics object. | UIComponent
|  | effectFinished(effectInst:IEffectInstance):void Called by the effect instance when it stops playing on the component. | UIComponent
|  | effectStarted(effectInst:IEffectInstance):void Called by the effect instance when it starts playing on the component. | UIComponent
|  | endEffectsStarted():void Ends all currently playing effects on the component. | UIComponent
|  | executeBindings(recurse:Boolean = false):void 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
|  | 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
|  | hideActionBar(animate:Boolean = true):void Hides the action bar. | ViewNavigator
|  | 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
|  | loadViewData(value:Object):void Restores the state of a navigator's view from the value argument. | ViewNavigatorBase
|  | 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
|  | measureHTMLText(htmlText:String):TextLineMetrics Measures the specified HTML text, which can contain HTML tags such as <font> and <b>, assuming that it is displayed in a single-line UITextField using a UITextFormat determined by the styles of this UIComponent. | UIComponent
|  | measureText(text:String):TextLineMetrics Measures the specified text, assuming that it is displayed in a single-line UITextField (or UIFTETextField) using a UITextFormat determined by the styles of this UIComponent. | UIComponent
|  | move(x:Number, y:Number):void Moves the component to a specified position within its parent. | UIComponent
|  | notifyStyleChangeInChildren(styleProp:String, recursive:Boolean):void Propagates style changes to the children. | UIComponent
|  | owns(child:DisplayObject):Boolean Returns true if the chain of owner properties points from child to this UIComponent. | UIComponent
|  | parentChanged(p:DisplayObjectContainer):void Called by Flex when a UIComponent object is added to or removed from a parent. | UIComponent
|  | popAll(transition:ViewTransitionBase = null):void Removes all of the views from the navigator stack. | ViewNavigator
|  | popToFirstView(transition:ViewTransitionBase = null):void Removes all views except the bottom view from the navigation stack. | ViewNavigator
|  | popView(transition:ViewTransitionBase = null):void Pops the current view off the navigation stack. | ViewNavigator
|  | prepareToPrint(target:IFlexDisplayObject):Object Prepares an IFlexDisplayObject for printing. | UIComponent
|  | pushView(viewClass:Class, data:Object = null, context:Object = null, transition:ViewTransitionBase = null):void Pushes a new view onto the top of the navigation stack. | ViewNavigator
|  | 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
|  | removeElement(element:IVisualElement):IVisualElement 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
|  | replaceView(viewClass:Class, data:Object = null, context:Object = null, transition:ViewTransitionBase = null):void Replaces the top view of the navigation stack with a new view. | ViewNavigator
|  | replayAutomatableEvent(event:Event):Boolean Replays the specified event. | UIComponent
|  | resolveAutomationIDPart(criteria:Object):Array Resolves a child by using the id provided. | UIComponent
|  | resumeBackgroundProcessing():void [static] Resumes the background processing of methods queued by callLater(), after a call to suspendBackgroundProcessing(). | UIComponent
|  | saveViewData():Object Serializes all data related to the navigator's children into an object that can be saved by the persistence manager. | ViewNavigatorBase
|  | 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
|  | showActionBar(animate:Boolean = true):void Shows the action bar. | ViewNavigator
|  | styleChanged(styleProp:String):void Detects changes to style properties. | UIComponent
|  | stylesInitialized():void Flex calls the stylesInitialized() method when the styles for a component are first initialized. | UIComponent
|  | suspendBackgroundProcessing():void [static] Blocks the background processing of methods queued by callLater(), until resumeBackgroundProcessing() is called. | UIComponent
|  | swapElements(element1:IVisualElement, element2:IVisualElement):void Swaps the index of the two specified visual elements. | 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
|  | updateControlsForView(view:View):void Updates various properties of the navigator when a new view is added and activated. | ViewNavigatorBase
|  | validateDisplayList():void Validates the position and size of children and draws other visuals. | UIComponent
|  | validateNow():void Validate and update the properties and layout of this object and redraw it, if necessary. | UIComponent
|  | validateProperties():void Used by layout logic to validate the properties of a component by calling the commitProperties() method. | UIComponent
|  | validateSize(recursive:Boolean = false):void Validates the measured size of the component If the LayoutManager.invalidateSize() method is called with this ILayoutManagerClient, then the validateSize() method is called when it's time to do measurements. | UIComponent
|  | validationResultHandler(event:ValidationResultEvent):void Handles both the valid and invalid events from a validator assigned to this component. | UIComponent
|  | verticalGradientMatrix(x:Number, y:Number, width:Number, height:Number):Matrix Returns a box Matrix which can be passed to drawRoundRect() as the rot parameter when drawing a vertical gradient. | UIComponent

Protected Methods
Show Inherited Protected Methods
Show Inherited Protected Methods

| Method | Defined By
--- | --- | ---
|  | addMXMLChildren(comps:Array):void [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
|  | createActionBarHideEffect():IEffect Creates the effect to play when the ActionBar control is hidden. | ViewNavigator
|  | createActionBarShowEffect():IEffect Creates the effect to play when the ActionBar control appears. | ViewNavigator
|  | 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
|  | invalidateParentSizeAndDisplayList():void Helper method to invalidate parent size and display list if this object affects its layout (includeInLayout is true). | UIComponent
|  | isOurFocus(target:DisplayObject):Boolean Typically overridden by components containing UITextField objects, where the UITextField object gets focus. | UIComponent
|  | keyDownHandler(event:KeyboardEvent):void The event handler called for a keyDown event. | UIComponent
|  | keyUpHandler(event:KeyboardEvent):void The event handler called for a keyUp event. | UIComponent
|  | 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
|  | 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

Events
Hide Inherited Events
Show Inherited Events

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

Styles
Hide Inherited Styles
Show Inherited Styles

| Style | Description | Defined By
--- | --- | --- | ---
|  | accentColor | Type: uint Format: Color CSS Inheritance: yes Theme: spark, mobile Accent color used by component skins. | SkinnableContainer
|  | alignmentBaseline | Type: String CSS Inheritance: yes Specifies the baseline to which the dominant baseline aligns. See also flashx.textLayout.formats.ITextLayoutFormat.alignmentBaseline | SkinnableContainer
|  | alternatingItemColors | 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 Theme: spark, mobile Alpha level of the background for this component. | SkinnableContainer
|  | backgroundColor | Type: uint Format: Color CSS Inheritance: no Theme: spark, mobile Background color of a component. | SkinnableContainer
|  | baseline | Type: String CSS Inheritance: no The vertical distance in pixels from the top edge of the content area to the control's baseline position. | UIComponent
|  | baselineShift | Type: Object CSS Inheritance: yes Amount to shift the baseline. See also flashx.textLayout.formats.ITextLayoutFormat.baselineShift | SkinnableContainer
|  | blockProgression | Type: String CSS Inheritance: yes Specifies a vertical or horizontal progression of line placement. See also flashx.textLayout.formats.ITextLayoutFormat.blockProgression | SkinnableContainer
|  | bottom | Type: String CSS Inheritance: no The vertical distance, in pixels, from the bottom edge of the component to the bottom edge of its parent container's content area. | UIComponent
|  | breakOpportunity | Type: String CSS Inheritance: yes Controls where lines are allowed to break when breaking wrapping text into multiple lines. See also flashx.textLayout.formats.ITextLayoutFormat.breakOpportunity | SkinnableContainer
|  | cffHinting | Type: String CSS Inheritance: yes The type of CFF hinting used for this text. See also flashx.textLayout.formats.ITextLayoutFormat.cffHinting | SkinnableContainer
|  | chromeColor | Type: uint Format: Color CSS Inheritance: yes Theme: spark, mobile The main color for a component. | SkinnableComponent
|  | clearFloats | Type: String CSS Inheritance: yes Controls how text wraps around a float. See also flashx.textLayout.formats.ITextLayoutFormat.clearFloats | SkinnableContainer
|  | color | Type: uint Format: Color CSS Inheritance: yes Color of the text. See also flashx.textLayout.formats.ITextLayoutFormat.color spark.components.supportClasses.StyleableTextField.color spark.components.supportClasses.StyleableStageText.color | SkinnableContainer
|  | columnBreakAfter | Type: String CSS Inheritance: yes Controls column break after the element. See also flashx.textLayout.formats.ITextLayoutFormat.columnBreakAfter | SkinnableContainer
|  | columnBreakBefore | Type: String CSS Inheritance: yes Controls column break before the element. See also flashx.textLayout.formats.ITextLayoutFormat.columnBreakBefore | SkinnableContainer
|  | containerBreakAfter | Type: String CSS Inheritance: yes Controls container break after the element. See also flashx.textLayout.formats.ITextLayoutFormat.containerBreakAfter | SkinnableContainer
|  | containerBreakBefore | Type: String CSS Inheritance: yes Controls container break before the element. See also flashx.textLayout.formats.ITextLayoutFormat.containerBreakBefore | SkinnableContainer
|  | contentBackgroundAlpha | Type: Number CSS Inheritance: yes Theme: spark, mobile The alpha of the content background for this component. | SkinnableContainer
|  | contentBackgroundColor | Type: uint Format: Color CSS Inheritance: yes Theme: spark, mobile The color of the content background for this component. | SkinnableContainer
|  | digitCase | Type: String CSS Inheritance: yes The type of digit case used for this text. See also flashx.textLayout.formats.ITextLayoutFormat.digitCase | SkinnableContainer
|  | digitWidth | Type: String CSS Inheritance: yes Type of digit width used for this text. See also flashx.textLayout.formats.ITextLayoutFormat.digitWidth | SkinnableContainer
|  | direction | Type: String CSS Inheritance: yes Specifies the default bidirectional embedding level of the text. See also flashx.textLayout.formats.ITextLayoutFormat.direction | SkinnableContainer
|  | dominantBaseline | 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 flashx.textLayout.formats.ITextLayoutFormat.dominantBaseline | SkinnableContainer
|  | downColor | Type: uint Format: Color CSS Inheritance: yes Theme: mobile Color of the background of an item renderer when it is being pressed down If `downColor` is set to `undefined`, `downColor` is not used. The default value for the Spark theme is `undefined`. | SkinnableContainer
|  | errorColor | Type: uint Format: Color CSS Inheritance: yes Color of the component highlight when validation fails. | UIComponent
|  | errorSkin | Type: Class Name of the skin class to use for this component when a validation error occurs. | SkinnableComponent
|  | firstBaselineOffset | Type: Object CSS Inheritance: yes Specifies the baseline position of the first line in the container. See also flashx.textLayout.formats.ITextLayoutFormat.firstBaselineOffset | SkinnableContainer
|  | focusColor | Type: uint Format: Color CSS Inheritance: yes Theme: spark, mobile Color of focus ring when the component is in focus. | SkinnableContainer
|  | focusedTextSelectionColor | Type: uint Format: Color CSS Inheritance: yes The color of text when the component is enabled and has focus. | SkinnableContainer
|  | focusSkin | Type: Class CSS Inheritance: no Skin used to draw the focus rectangle. | UIComponent
|  | fontFamily | Type: String CSS Inheritance: yes The name of the font to use, or a comma-separated list of font names. See also flashx.textLayout.formats.ITextLayoutFormat.fontFamily spark.components.supportClasses.StyleableStageText.fontFamily spark.components.supportClasses.StyleableTextField.fontFamily | SkinnableContainer
|  | fontLookup | Type: String CSS Inheritance: yes Font lookup to use. See also flashx.textLayout.formats.ITextLayoutFormat.fontLookup | SkinnableContainer
|  | fontSize | Type: Number Format: Length CSS Inheritance: yes Height of the text, in pixels. See also flashx.textLayout.formats.ITextLayoutFormat.fontSize spark.components.supportClasses.StyleableStageText.fontSize spark.components.supportClasses.StyleableTextField.fontSize | SkinnableContainer
|  | fontStyle | Type: String CSS Inheritance: yes Determines whether the text is italic font. See also flashx.textLayout.formats.ITextLayoutFormat.fontStyle spark.components.supportClasses.StyleableStageText.fontStyle spark.components.supportClasses.StyleableTextField.fontStyle | SkinnableContainer
|  | fontWeight | Type: String CSS Inheritance: yes Determines whether the text is boldface. See also flashx.textLayout.formats.ITextLayoutFormat.fontWeight spark.components.supportClasses.StyleableStageText.fontWeight spark.components.supportClasses.StyleableTextField.fontWeight | SkinnableContainer
|  | horizontalCenter | Type: String CSS Inheritance: no The horizontal distance in pixels from the center of the component's content area to the center of the component. | UIComponent
|  | inactiveTextSelectionColor | Type: uint Format: Color CSS Inheritance: yes The color of text when the component is disabled. | SkinnableContainer
|  | interactionMode | Type: String CSS Inheritance: yes The primary interaction mode for this component. See also mx.core.InteractionMode.MOUSE mx.core.InteractionMode.TOUCH | UIComponent
|  | justificationRule | Type: String CSS Inheritance: yes Rule used to justify text in a paragraph. See also flashx.textLayout.formats.ITextLayoutFormat.justificationRule | SkinnableContainer
|  | justificationStyle | Type: String CSS Inheritance: yes The style used for justification of the paragraph. See also flashx.textLayout.formats.ITextLayoutFormat.justificationStyle | SkinnableContainer
|  | kerning | Type: String CSS Inheritance: yes The style used for justification of the paragraph. See also flashx.textLayout.formats.ITextLayoutFormat.kerning | SkinnableContainer
|  | layoutDirection | Type: String CSS Inheritance: yes Specifies the desired layout direction of a component. See also MXFTEText.css mx.core.ILayoutDirectionElement mx.core.LayoutDirection | UIComponent
|  | leading | Type: Number Format: Length CSS Inheritance: yes Theme: mobile Additional vertical space between lines of text. See also spark.components.supportClasses.StyleableTextField.leading lineHeight | SkinnableContainer
|  | leadingModel | Type: String CSS Inheritance: yes Specifies the leading model, which is a combination of leading basis and leading direction. See also flashx.textLayout.formats.ITextLayoutFormat.leadingModel | SkinnableContainer
|  | left | Type: String CSS Inheritance: no The horizontal distance, in pixels, from the left edge of the component to the left edge of its parent container's content area. | UIComponent
|  | letterSpacing | Type: Number CSS Inheritance: yes Theme: mobile The number of additional pixels to appear between each character. See also spark.components.supportClasses.StyleableTextField.letterSpacing trackingLeft trackingRight | SkinnableContainer
|  | ligatureLevel | Type: String CSS Inheritance: yes Controls which of the ligatures that are defined in the font may be used in the text. See also flashx.textLayout.formats.ITextLayoutFormat.ligatureLevel | SkinnableContainer
|  | lineHeight | Type: Object CSS Inheritance: yes Leading controls for the text. See also flashx.textLayout.formats.ITextLayoutFormat.lineHeight leading | SkinnableContainer
|  | lineThrough | Type: Boolean CSS Inheritance: yes If true, applies strikethrough, a line drawn through the middle of the text. See also flashx.textLayout.formats.ITextLayoutFormat.lineThrough | SkinnableContainer
|  | listAutoPadding | 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 flashx.textLayout.formats.ITextLayoutFormat.listAutoPadding | SkinnableContainer
|  | listStylePosition | Type: String CSS Inheritance: yes This controls the placement of a list item marker relative to the list item. See also flashx.textLayout.formats.ITextLayoutFormat.listStylePosition | SkinnableContainer
|  | listStyleType | Type: String CSS Inheritance: yes This controls the appearance of items in a list. See also flashx.textLayout.formats.ITextLayoutFormat.listStyleType | SkinnableContainer
|  | locale | Type: String CSS Inheritance: yes The locale of the text. See also http://www.unicode.org/reports/tr35/ | SkinnableContainer
|  | paragraphEndIndent | Type: Number Format: length CSS Inheritance: yes The amount to indent the paragraph's end edge. See also flashx.textLayout.formats.ITextLayoutFormat.paragraphEndIndent | SkinnableContainer
|  | paragraphSpaceAfter | Type: Number Format: length CSS Inheritance: yes The amount of space to leave after the paragraph. See also flashx.textLayout.formats.ITextLayoutFormat.paragraphSpaceAfter | SkinnableContainer
|  | paragraphSpaceBefore | Type: Number Format: length CSS Inheritance: yes The amount of space to leave before the paragraph. See also flashx.textLayout.formats.ITextLayoutFormat.paragraphSpaceBefore | SkinnableContainer
|  | paragraphStartIndent | Type: Number Format: length CSS Inheritance: yes The amount to indent the paragraph's start edge. See also flashx.textLayout.formats.ITextLayoutFormat.paragraphStartIndent | SkinnableContainer
|  | renderingMode | Type: String CSS Inheritance: yes The rendering mode used for this text which applies only to embedded fonts. See also flashx.textLayout.formats.ITextLayoutFormat.renderingMode | SkinnableContainer
|  | right | Type: String CSS Inheritance: no The horizontal distance, in pixels, from the right edge of the component to the right edge of its parent container's content area. | UIComponent
|  | rollOverColor | Type: uint Format: Color CSS Inheritance: yes Theme: spark Color of the highlights when the mouse is over the component. | SkinnableContainer
|  | showErrorSkin | Type: Boolean CSS Inheritance: yes Show the error border or skin when this component is invalid. | UIComponent
|  | showErrorTip | Type: Boolean CSS Inheritance: yes Show the error tip when this component is invalid and the user rolls over it. | UIComponent
|  | skinClass | Type: Class Name of the skin class to use for this component. | SkinnableComponent
|  | symbolColor | Type: uint Format: Color CSS Inheritance: yes Theme: spark, mobile Color of any symbol of a component. | SkinnableContainer
|  | tabStops | Type: String CSS Inheritance: yes Specifies the tab stops associated with the paragraph. See also flashx.textLayout.formats.ITextLayoutFormat.tabStops | SkinnableContainer
|  | textAlign | Type: String CSS Inheritance: yes Alignment of text within a container. See also flashx.textLayout.formats.ITextLayoutFormat.textAlign spark.components.supportClasses.StyleableStageText.textAlign spark.components.supportClasses.StyleableTextField.textAlign | SkinnableContainer
|  | textAlignLast | Type: String CSS Inheritance: yes Alignment of the last line in the paragraph relative to the container in justified text. See also flashx.textLayout.formats.ITextLayoutFormat.textAlignLast | SkinnableContainer
|  | textAlpha | Type: Number CSS Inheritance: yes Alpha (transparency) value for the text. See also flashx.textLayout.formats.ITextLayoutFormat.textAlpha | SkinnableContainer
|  | textDecoration | Type: String CSS Inheritance: yes Determines whether the text is underlined. See also flashx.textLayout.formats.ITextLayoutFormat.textDecoration spark.components.supportClasses.StyleableTextField.textDecoration | SkinnableContainer
|  | textIndent | Type: Number Format: Length CSS Inheritance: yes Offset of first line of text from the left side of the container. See also flashx.textLayout.formats.ITextLayoutFormat.textIndent spark.components.supportClasses.StyleableTextField.textIndent | SkinnableContainer
|  | textJustify | Type: String CSS Inheritance: yes Specifies options for justifying text. See also flashx.textLayout.formats.ITextLayoutFormat.textJustify | SkinnableContainer
|  | textRotation | Type: String CSS Inheritance: yes Determines the number of degrees to rotate this text. See also flashx.textLayout.formats.ITextLayoutFormat.textRotation | SkinnableContainer
|  | textShadowAlpha | Type: Number CSS Inheritance: yes Theme: mobile Alpha of text shadows. | SkinnableContainer
|  | textShadowColor | Type: uint Format: Color CSS Inheritance: yes Theme: mobile Color of text shadows. | SkinnableContainer
|  | top | Type: String CSS Inheritance: no The vertical distance, in pixels, from the top edge of the component to the top edge of its parent container's content area. | UIComponent
|  | touchDelay | 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
|  | trackingLeft | Type: Object CSS Inheritance: yes The amount of tracking (manual kerning) to be applied to the left of each character. See also flashx.textLayout.formats.ITextLayoutFormat.trackingLeft | SkinnableContainer
|  | trackingRight | Type: Object CSS Inheritance: yes The amount of tracking (manual kerning) to be applied to the right of each character. See also flashx.textLayout.formats.ITextLayoutFormat.trackingRight | SkinnableContainer
|  | typographicCase | Type: String CSS Inheritance: yes The type of typographic case used for this text. See also flashx.textLayout.formats.ITextLayoutFormat.typographicCase | SkinnableContainer
|  | unfocusedTextSelectionColor | Type: uint Format: Color CSS Inheritance: yes The color of text when the component is enabled but does not have focus. | SkinnableContainer
|  | verticalCenter | Type: String CSS Inheritance: no The vertical distance in pixels from the center of the component's content area to the center of the component. | UIComponent
|  | whiteSpaceCollapse | Type: String CSS Inheritance: yes Collapses or preserves whitespace when importing text into a TextFlow. See also flashx.textLayout.formats.ITextLayoutFormat.whiteSpaceCollapse | SkinnableContainer
|  | wordSpacing | Type: Object CSS Inheritance: yes Specifies the spacing between words to use during justification. See also flashx.textLayout.formats.ITextLayoutFormat.wordSpacing | SkinnableContainer

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.

Hide Inherited Skin Parts
Show Inherited Skin Parts

| Skin Part | Description | Defined By
--- | --- | --- | ---
|  | actionBar:ActionBar | Required: false Part Type: Static A skin part that defines the action bar of the navigator. | ViewNavigator
|  | contentGroup:Group | Required: false Part Type: Static An optional skin part that defines the Group where the content children get pushed into and laid out. | SkinnableContainer

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.

Hide Inherited Skin States
Show Inherited Skin States

| Skin State | Description | Defined By
--- | --- | --- | ---
|  | disabled | Disabled State | SkinnableContainerBase
|  | landscape | The state used when the navigator is in landscape orientation. | ViewNavigator
|  | landscapeAndOverlay | The state used when the navigator is in landscape orientation and the navigator controls are overlaid on top. | ViewNavigator
|  | normal | Normal State | SkinnableContainerBase
|  | portrait | The state used when the navigator is in portrait orientation. | ViewNavigator
|  | portraitAndOverlay | The state used when the navigator is in portrait orientation and the navigator controls are overlaid on top. | ViewNavigator

Effects
Hide Inherited Effects
Show Inherited Effects

| Effect | Description | Defined By
--- | --- | --- | ---
|  | addedEffect | Triggering Event: added Played when the component is added as a child to a Container. | UIComponent
|  | creationCompleteEffect | Triggering Event: creationComplete Played when the component is created. | UIComponent
|  | focusInEffect | Triggering Event: focusIn Played when the component gains keyboard focus. | UIComponent
|  | focusOutEffect | Triggering Event: focusOut Played when the component loses keyboard focus. | UIComponent
|  | hideEffect | Triggering Event: hide Played when the component becomes invisible. | UIComponent
|  | mouseDownEffect | Triggering Event: mouseDown Played when the user presses the mouse button while over the component. | UIComponent
|  | mouseUpEffect | Triggering Event: mouseUp Played when the user releases the mouse button while over the component. | UIComponent
|  | moveEffect | Triggering Event: move Played when the component is moved. | UIComponent
|  | removedEffect | Triggering Event: removed Played when the component is removed from a Container. | UIComponent
|  | resizeEffect | Triggering Event: resize Played when the component is resized. | UIComponent
|  | rollOutEffect | Triggering Event: rollOut Played when the user rolls the mouse so it is no longer over the component. | UIComponent
|  | rollOverEffect | Triggering Event: rollOver Played when the user rolls the mouse over the component. | UIComponent
|  | showEffect | Triggering Event: show Played when the component becomes visible. | UIComponent

Public Constants
Hide Inherited Public Constants
Show Inherited Public Constants

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

Property Detail

actionContent | property

`actionContent:Array`

Language Version : | ActionScript 3.0

Product Version : | Flex 4.5

Runtime Versions : | AIR 2.5

This property overrides the `actionContent` property in the ActionBar and ViewNavigatorApplication components.

The components that define actions the user can take in a view. These components appear in the action area of the control, using the `actionGroup` skin part.

The location and appearance of the `actionGroup` skin part is determined by the ActionBarSkin class. The default ActionBarSkin class defines the `actionGroup` to appear to the right of the title display area of the ActionBar.

Create a custom ActionBarSkin skin class to change the default location and appearance of the `actionGroup` skin part.

The default value is `null`.

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

See also

ActionBar.actionContent
spark.skins.mobile.ActionBarSkin

actionLayout | property |

`actionLayout:LayoutBase`

Language Version : | ActionScript 3.0

Product Version : | Flex 4.5

Runtime Versions : | AIR 2.5

The components that define actions the user can take in a view. These components appear in the action area of the control, using the `actionGroup` skin part.

The location and appearance of the `actionGroup` skin part is determined by the ActionBarSkin class. The default ActionBarSkin class defines the `actionGroup` to appear to the right of the title display area of the ActionBar.

Create a custom ActionBarSkin skin class to change the default location and appearance of the `actionGroup` skin part.

The default value is `null`.

Implementation
`public function get actionLayout():LayoutBase`
`public function set actionLayout(value:LayoutBase):void`

activeView | property |

`activeView:View` [read-only] [override]

Language Version : | ActionScript 3.0

Product Version : | Flex 4.5

Runtime Versions : | AIR 2.5

During a view transition, this property references the view that the navigator is transitioning to.

The currently active view of the navigator. Only one view can be active at a time.

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

Implementation
`public function get activeView():View`

context | property |

`context:Object` [read-only]

Language Version : | ActionScript 3.0

Product Version : | Flex 4.5

Runtime Versions : | AIR 2.5

The string that describes the context in which the current view was created. This property is assigned to the value of the `context` parameter passed to the `ViewNavigator.pushView()` method.

The default value is `null`.

Implementation
`public function get context():Object`

defaultPopTransition | property |

`defaultPopTransition:ViewTransitionBase`

Language Version : | ActionScript 3.0

Product Version : | Flex 4.5

Runtime Versions : | AIR 2.5

Specifies the default view transition for pop navigation operations.

The default value is `SlideViewTransition`.

Implementation
`public function get defaultPopTransition():ViewTransitionBase`
`public function set defaultPopTransition(value:ViewTransitionBase):void`

See also

spark.transitions.SlideViewTransition

defaultPushTransition | property |

`defaultPushTransition:ViewTransitionBase`

Language Version : | ActionScript 3.0

Product Version : | Flex 4.5

Runtime Versions : | AIR 2.5

Specifies the default view transition for push navigation operations.

The default value is `SlideViewTransition`.

Implementation
`public function get defaultPushTransition():ViewTransitionBase`
`public function set defaultPushTransition(value:ViewTransitionBase):void`

See also

spark.transitions.SlideViewTransition

firstView | property |

`firstView:Class`

Language Version : | ActionScript 3.0

Product Version : | Flex 4.5

Runtime Versions : | AIR 2.5

Each view in an application corresponds to a View container class defined in an ActionScript or MXML file. This property specifies the view to use to initialize the first view of the stack. This property must reference a class that extends View container.

Specify any data passed to the first view by using the `firstViewData` property.

The default value is `null`.

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

See also

firstViewData
View

firstViewData | property |

`firstViewData:Object`

Language Version : | ActionScript 3.0

Product Version : | Flex 4.5

Runtime Versions : | AIR 2.5

The Object to pass to the `data` property of the first view when the navigator is initialized. Specify the first view by using the `firstView` property.

The default value is `null`.

Implementation
`public function get firstViewData():Object`
`public function set firstViewData(value:Object):void`

See also

firstView
View

length | property |

`length:int` [read-only]

Language Version : | ActionScript 3.0

Product Version : | Flex 4.5

Runtime Versions : | AIR 2.5

Returns the number of views being managed by the navigator.

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

Implementation
`public function get length():int`

navigationContent | property |

`navigationContent:Array`

Language Version : | ActionScript 3.0

Product Version : | Flex 4.5

Runtime Versions : | AIR 2.5

This property overrides the `navigationContent` property in the ActionBar and ViewNavigatorApplication components.

The components that define navigation for the user. These components appear in the navigation area of the control, in the `navigationGroup` skin part.

The location and appearance of the `navigationGroup` skin part is determined by the ActionBarSkin class. The default ActionBarSkin class defines the `navigationGroup` to appear to the left of the `titleGroup` area of the ActionBar.

Create a custom ActionBarSkin skin class to change the default location and appearance of the `navigationGroup` skin part.

The default value is `null`.

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

See also

ActionBar.navigationContent
spark.skins.mobile.ActionBarSkin

navigationLayout | property |

`navigationLayout:LayoutBase`

Language Version : | ActionScript 3.0

Product Version : | Flex 4.5

Runtime Versions : | AIR 2.5

Defines the layout of the components contained in the `navigationGroup` skin part.

The default value is `null`.

Implementation
`public function get navigationLayout():LayoutBase`
`public function set navigationLayout(value:LayoutBase):void`

poppedViewReturnedObject | property |

`poppedViewReturnedObject:ViewReturnObject` [read-only]

Language Version : | ActionScript 3.0

Product Version : | Flex 4.5

Runtime Versions : | AIR 2.5

Holds the object returned by the last view that was popped off the navigation stack or replaced by another view. To return a value, the view being popped off the stack overrides its `createReturnObject()` method.

This object is only available when the navigator is in the process of switching views in response to a pop or replace navigation operation. This object is guaranteed to be valid when the new view receives the `add` event, and is destroyed after the view receives a `viewActivate` event.

The default value is `null`.

Implementation
`public function get poppedViewReturnedObject():ViewReturnObject`

See also

View.createReturnObject()

title | property |

`title:String`

Language Version : | ActionScript 3.0

Product Version : | Flex 4.5

Runtime Versions : | AIR 2.5

This property overrides the `title` property in the ActionBar and ViewNavigatorApplication components.

Title or caption displayed in the title area.

Use the `titleContent` property to define the components that appear in the title area. If you specify a value for the `titleContent` property, the ActionBar skin ignores the `title` property.

The default value is `""`.

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

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

titleContent | property |

`titleContent:Array`

Language Version : | ActionScript 3.0

Product Version : | Flex 4.5

Runtime Versions : | AIR 2.5

This property overrides the `titleContent` property in the ActionBar and ViewNavigatorApplication components.

The components that appear in the title area of the control. These components appear in the `titleGroup` skin part of the ActionBar control.

The location and appearance of the `titleGroup` skin part is determined by the ActionBarSkin class. The default ActionBarSkin class defines the `titleGroup` to appear in the center of the ActionBar, using the space remaining between `navigationGroup` and `actionGroup` skin parts.

If `titleContent` is null, the `titleDisplay` skin part, if present, is displayed in place of the `titleGroup` skin part.

Create a custom ActionBarSkin skin class to change the default location and appearance of the `titleGroup` skin part.

The default value is `null`.

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

See also

ActionBar.titleContent
spark.skins.mobile.ActionBarSkin

titleLayout | property |

`titleLayout:LayoutBase`

Language Version : | ActionScript 3.0

Product Version : | Flex 4.5

Runtime Versions : | AIR 2.5

Defines the layout of the `titleGroup` and `titleDisplay` skin parts.

If the `titleContent` property is null, the `titleDisplay` skin part is displayed in place of the `titleGroup` skin part. The `titleDisplay` skin part is positioned in the center of the ActionBar control by using the `paddingLeft` and `paddingRight` properties of the layout class specified by the `titleLayout` property.

The default value is `null`.

Implementation
`public function get titleLayout():LayoutBase`
`public function set titleLayout(value:LayoutBase):void`
Constructor Detail

ViewNavigator | () | Constructor

`public function ViewNavigator()`

Language Version : | ActionScript 3.0

Product Version : | Flex 4.5

Runtime Versions : | AIR 2.5

Constructor.

Method Detail

backKeyUpHandler | () | method

`override public function backKeyUpHandler():void`

Language Version : | ActionScript 3.0

Product Version : | Flex 4.6

Runtime Versions : | AIR 3.1

Pops to the previous view of the navigator in response to the back key. ViewNavigator only allows this method to be called once during a navigation event. All subsequent calls to this method will be ignored until the current view transition is complete.

ViewNavigatorApplication automatically calls this method when the back key is pressed.

createActionBarHideEffect | () | method |

`protected function createActionBarHideEffect():IEffect`

Language Version : | ActionScript 3.0

Product Version : | Flex 4.5

Runtime Versions : | AIR 2.5

Creates the effect to play when the ActionBar control is hidden. The produced effect is responsible for animating both the ActionBar and the view currently displayed in the content area of the navigator.

Returns

| `IEffect` — An effect to play when the ActionBar control is hidden.

createActionBarShowEffect | () | method |

`protected function createActionBarShowEffect():IEffect`

Language Version : | ActionScript 3.0

Product Version : | Flex 4.5

Runtime Versions : | AIR 2.5

Creates the effect to play when the ActionBar control appears. The produced effect is responsible for animating both the ActionBar and the view currently displayed in the content area of the navigator.

Returns

| `IEffect` — An effect to play when the ActionBar control is appears.

hideActionBar | () | method |

`public function hideActionBar(animate:Boolean = true):void`

Language Version : | ActionScript 3.0

Product Version : | Flex 4.5

Runtime Versions : | AIR 2.5

Hides the action bar.

Parameters

| `animate:Boolean` (default = `true`)`` — Indicates whether a hide effect should be played when the action bar is hidden.

popAll | () | method |

`public function popAll(transition:ViewTransitionBase = null):void`

Language Version : | ActionScript 3.0

Product Version : | Flex 4.5

Runtime Versions : | AIR 2.5

Removes all of the views from the navigator stack. This method changes the display to a blank screen.

Parameters

| `transition:ViewTransitionBase` (default = `null`)`` — The view transition to play while switching views.

popToFirstView | () | method |

`public function popToFirstView(transition:ViewTransitionBase = null):void`

Language Version : | ActionScript 3.0

Product Version : | Flex 4.5

Runtime Versions : | AIR 2.5

Removes all views except the bottom view from the navigation stack. The bottom view is the one that was first pushed onto the stack.

Parameters

| `transition:ViewTransitionBase` (default = `null`)`` — The view transition to play while switching views.

popView | () | method |

`public function popView(transition:ViewTransitionBase = null):void`

Language Version : | ActionScript 3.0

Product Version : | Flex 4.5

Runtime Versions : | AIR 2.5

Pops the current view off the navigation stack. The current view is represented by the top view on the stack. The previous view on the stack becomes the current view.

Parameters

| `transition:ViewTransitionBase` (default = `null`)`` — The view transition to play while switching views.

pushView | () | method |

`public function pushView(viewClass:Class, data:Object = null, context:Object = null, transition:ViewTransitionBase = null):void`

Language Version : | ActionScript 3.0

Product Version : | Flex 4.5

Runtime Versions : | AIR 2.5

Pushes a new view onto the top of the navigation stack. The view pushed onto the stack becomes the current view.

Parameters

| `viewClass:Class` — The class used to create the view. This argument must reference a class that extends View container.
| `data:Object` (default = `null`)`` — The data object to pass to the view. This argument is written to the `data` property of the new view.
| `context:Object` (default = `null`)`` — An arbitrary object written to the `ViewNavigator.context` property. When the new view is created, it can reference this property and perform an action based on its value. For example, the view could display data in different ways based on the value of `context`.
| `transition:ViewTransitionBase` (default = `null`)`` — The view transition to play while switching views.

replaceView | () | method |

`public function replaceView(viewClass:Class, data:Object = null, context:Object = null, transition:ViewTransitionBase = null):void`

Language Version : | ActionScript 3.0

Product Version : | Flex 4.5

Runtime Versions : | AIR 2.5

Replaces the top view of the navigation stack with a new view. The view replacing the current view on the stack becomes the current view.

Parameters

| `viewClass:Class` — The class used to create the replacement view. This argument must reference a class that extends View container.
| `data:Object` (default = `null`)`` — The data object to pass to the view. This argument is written to the `data` property of the new view.
| `context:Object` (default = `null`)`` — An arbitrary object used to describe the context of the push. When the new view is created, it can reference this property.
| `transition:ViewTransitionBase` (default = `null`)`` — The view transition to play while switching views.

showActionBar | () | method |

`public function showActionBar(animate:Boolean = true):void`

Language Version : | ActionScript 3.0

Product Version : | Flex 4.5

Runtime Versions : | AIR 2.5

Shows the action bar.

Parameters

| `animate:Boolean` (default = `true`)`` — Indicates whether a show effect should be played when the action bar appears.

Examples
ViewNavigatorExample.mxml

    <?xml version="1.0" encoding="utf-8"?>
    <!--

      Licensed to the Apache Software Foundation (ASF) under one or more
      contributor license agreements.  See the NOTICE file distributed with
      this work for additional information regarding copyright ownership.
      The ASF licenses this file to You under the Apache License, Version 2.0
      (the "License"); you may not use this file except in compliance with
      the License.  You may obtain a copy of the License at

          http://www.apache.org/licenses/LICENSE-2.0

      Unless required by applicable law or agreed to in writing, software
      distributed under the License is distributed on an "AS IS" BASIS,
      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
      See the License for the specific language governing permissions and
      limitations under the License.

    -->
    <s:ViewNavigatorApplication xmlns:fx="http://ns.adobe.com/mxml/2009"
        xmlns:s="library://ns.adobe.com/flex/spark"
        firstView="views.ViewNavigatorExampleHomeView">

        <fx:Script>
            <![CDATA[
                // Call ViewNavigator.popToFirstView() when the user clicks the Home button.
                protected function button1_clickHandler(event:MouseEvent):void {
                    navigator.popToFirstView();
                }
            ]]>
        </fx:Script>

        <s:navigationContent>
            <s:Button icon="@Embed(source='assets/Home.png')"
                click="button1_clickHandler(event);"/>
        </s:navigationContent>

    </s:ViewNavigatorApplication>

ViewNavigatorExampleHomeView.mxml

    <?xml version="1.0" encoding="utf-8"?>
    <!--

      Licensed to the Apache Software Foundation (ASF) under one or more
      contributor license agreements.  See the NOTICE file distributed with
      this work for additional information regarding copyright ownership.
      The ASF licenses this file to You under the Apache License, Version 2.0
      (the "License"); you may not use this file except in compliance with
      the License.  You may obtain a copy of the License at

          http://www.apache.org/licenses/LICENSE-2.0

      Unless required by applicable law or agreed to in writing, software
      distributed under the License is distributed on an "AS IS" BASIS,
      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
      See the License for the specific language governing permissions and
      limitations under the License.

    -->
    <s:View xmlns:fx="http://ns.adobe.com/mxml/2009"
        xmlns:s="library://ns.adobe.com/flex/spark"
        title="Home View">
        <s:layout>
            <s:VerticalLayout paddingTop="10"/>
        </s:layout>

        <fx:Script>
            <![CDATA[

                // Call ViewNavigator.pushView() to navigate to the Search view.
                protected function button1_clickHandler(event:MouseEvent):void {
                    navigator.pushView(ViewNavigatorExampleSearch);
                }
            ]]>
        </fx:Script>

        <s:Label text="Home View"/>
        <s:Button label="Search"
            click="button1_clickHandler(event);"/>
    </s:View>

ViewNavigatorExampleSearch.mxml

    <?xml version="1.0" encoding="utf-8"?>
    <!--

      Licensed to the Apache Software Foundation (ASF) under one or more
      contributor license agreements.  See the NOTICE file distributed with
      this work for additional information regarding copyright ownership.
      The ASF licenses this file to You under the Apache License, Version 2.0
      (the "License"); you may not use this file except in compliance with
      the License.  You may obtain a copy of the License at

          http://www.apache.org/licenses/LICENSE-2.0

      Unless required by applicable law or agreed to in writing, software
      distributed under the License is distributed on an "AS IS" BASIS,
      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
      See the License for the specific language governing permissions and
      limitations under the License.

    -->
    <s:View xmlns:fx="http://ns.adobe.com/mxml/2009"
            xmlns:s="library://ns.adobe.com/flex/spark">
        <s:layout>
            <s:VerticalLayout paddingTop="10"
                paddingLeft="10" paddingRight="10"/>
        </s:layout>

        <fx:Script>
            <![CDATA[

                // Handle the search.
                protected function button1_clickHandler(event:MouseEvent):void {
                    // Perform a search.
                }
            ]]>
        </fx:Script>

        <!-- Override the title to insert a TextInput control. -->
        <s:titleContent>
            <s:TextInput text="Enter search text ..."
                textAlpha="0.5"
                width="250"/>
        </s:titleContent>

        <!-- Override the action area to insert a Search button. -->
        <s:actionContent>
            <s:Button label="Search" click="button1_clickHandler(event);"/>
        </s:actionContent>

        <s:Label text="Search View"/>
        <s:TextArea text="Search results appear here ..."
            height="75%"/>
    </s:View>

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