| Package | spark.components |
| Class | public class ViewNavigator |
| Inheritance | ViewNavigator  ViewNavigatorBase SkinnableContainer SkinnableContainerBase SkinnableComponent UIComponent FlexSprite Sprite DisplayObjectContainer InteractiveObject DisplayObject EventDispatcher Object |
| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 4.5 |
| Runtime Versions: | AIR 2.5 |
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 SyntaxThe <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 PropertynavigationStack
More examples
Use pushView() to change views
Set the overlay mode of a Spark ViewNavigator container
Add a ViewNavigator to a Callout
Set the overlay mode of a Spark ViewNavigator container
Add a ViewNavigator to a Callout
Learn more
Use views and sections to lay out
a mobile application
Lay out a simple mobile application
Navigate the views of a mobile application
Define views in a mobile application
The life cycle of the Spark ViewNavigator and View containers
Lay out a simple mobile application
Navigate the views of a mobile application
Define views in a mobile application
The life cycle of the Spark ViewNavigator and View containers
Related API Elements
spark.components.View
spark.components.ActionBar
spark.components.TabbedViewNavigator
spark.transitions.ViewTransitionBase
spark.components.ActionBar
spark.components.TabbedViewNavigator
spark.transitions.ViewTransitionBase
Public Properties
| Property | Defined By | ||
|---|---|---|---|
 | accessibilityDescription : String
A convenience accessor for the description property
in this UIComponent's accessibilityProperties object. | UIComponent | |
| accessibilityEnabled : Boolean
A convenience accessor for the silent property
in this UIComponent's accessibilityProperties object. | UIComponent | |
| accessibilityImplementation : AccessibilityImplementation
The current accessibility implementation (AccessibilityImplementation)
for this InteractiveObject instance. | InteractiveObject | |
| accessibilityName : String
A convenience accessor for the name property
in this UIComponent's accessibilityProperties object. | UIComponent | |
| accessibilityProperties : AccessibilityProperties
The current accessibility options for this display object. | DisplayObject | |
| accessibilityShortcut : String
A convenience accessor for the shortcut property
in this UIComponent's accessibilityProperties object. | UIComponent | |
| 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 | ||
| alpha : Number
Indicates the alpha transparency value of the object specified. | DisplayObject | |
| autoLayout : Boolean
If true, measurement and layout are done
when the position or size of a child is changed. | 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 | |
| blendMode : String
A value from the BlendMode class that specifies which blend mode to use. | DisplayObject | |
| blendShader : Shader [write-only]
Sets a shader that is used for blending the foreground and background. | DisplayObject | |
| bottom : Object
For components, this layout constraint property is a
facade on top of the similarly-named style. | UIComponent | |
| buttonMode : Boolean
Specifies the button mode of this sprite. | Sprite | |
| cacheAsBitmap : Boolean
If set to true, Flash runtimes cache an internal bitmap representation of the
display object. | DisplayObject | |
| cacheAsBitmapMatrix : Matrix
If non-null, this Matrix object defines how a display object is rendered when
cacheAsBitmap is set to true. | DisplayObject | |
| cacheHeuristic : Boolean [write-only]
Used by Flex to suggest bitmap caching for the object. | UIComponent | |
| cachePolicy : String
Specifies the bitmap caching policy for this object. | UIComponent | |
| className : String [read-only]
The name of this instance's class, such as "Button". | UIComponent | |
| constructor : Object
A reference to the class object or constructor function for a given object instance. | Object | |
| contentMouseX : Number [read-only]
Returns the x position of the mouse, in the content coordinate system. | UIComponent | |
| contentMouseY : Number [read-only]
Returns the y position of the mouse, in the content coordinate system. | UIComponent | |
| context : Object [read-only]
The string that describes the context in which the current view was
created. | ViewNavigator | ||
| contextMenu : NativeMenu
Specifies the context menu associated with this object. | InteractiveObject | |
| creationPolicy : String
Content creation policy for this component. | SkinnableContainer | |
| currentState : String
The current view state of the component. | UIComponent | |
| cursorManager : ICursorManager [read-only]
Gets the CursorManager that controls the cursor for this component
and its peers. | UIComponent | |
| defaultButton : IFlexDisplayObject
The Button control designated as the default button for the container. | SkinnableContainerBase | |
| defaultPopTransition : spark.transitions:ViewTransitionBase
Specifies the default view transition for pop navigation operations. | ViewNavigator | ||
| defaultPushTransition : spark.transitions: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 | |
| dropTarget : DisplayObject [read-only]
Specifies the display object over which the sprite is being dragged, or on
which the sprite was dropped. | Sprite | |
| enabled : Boolean
Whether the component can accept user interaction. | UIComponent | |
| errorString : String
The text that displayed by a component's error tip when a
component is monitored by a Validator and validation fails. | UIComponent | |
| explicitHeight : Number
Number that specifies the explicit height of the component,
in pixels, in the component's coordinates. | UIComponent | |
| explicitMaxHeight : Number
The maximum recommended height of the component to be considered
by the parent during layout. | UIComponent | |
| explicitMaxWidth : Number
The maximum recommended width of the component to be considered
by the parent during layout. | UIComponent | |
| explicitMinHeight : Number
The minimum recommended height of the component to be considered
by the parent during layout. | UIComponent | |
| explicitMinWidth : Number
The minimum recommended width of the component to be considered
by the parent during layout. | UIComponent | |
| explicitWidth : Number
Number that specifies the explicit width of the component,
in pixels, in the component's coordinates. | UIComponent | |
| filters : Array
An indexed array that contains each filter object currently associated with the display object. | DisplayObject | |
| 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 | |
| focusRect : Object
Specifies whether this object displays a focus rectangle. | InteractiveObject | |
| graphics : Graphics [read-only]
Specifies the Graphics object that belongs to this sprite where vector
drawing commands can occur. | Sprite | |
| hasFocusableChildren : Boolean
A flag that indicates whether child objects can receive focus. | UIComponent | |
| hasLayoutMatrix3D : Boolean [read-only]
Contains true if the element has 3D Matrix. | UIComponent | |
| height : Number [override]
Number that specifies the height of the component, in pixels,
in the parent's coordinates. | UIComponent | |
| hitArea : Sprite
Designates another sprite to serve as the hit area for a sprite. | Sprite | |
| horizontalCenter : Object
For components, this layout constraint property is a
facade on top of the similarly-named style. | UIComponent | |
| 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 | ||
| loaderInfo : LoaderInfo [read-only]
Returns a LoaderInfo object containing information about loading the file
to which this display object belongs. | DisplayObject | |
| maintainProjectionCenter : Boolean
When true, the component keeps its projection matrix centered on the
middle of its bounding box. | UIComponent | |
| mask : DisplayObject
The calling display object is masked by the specified mask object. | DisplayObject | |
| maxHeight : Number
The maximum recommended height of the component to be considered
by the parent during layout. | UIComponent | |
| 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 | |
| metaData : Object
Obtains the meta data object of the DisplayObject instance if meta data was stored alongside the
the instance of this DisplayObject in the SWF file through a PlaceObject4 tag. | DisplayObject | |
| minHeight : Number
The minimum recommended height of the component to be considered
by the parent during layout. | UIComponent | |
| minWidth : Number
The minimum recommended width of the component to be considered
by the parent during layout. | UIComponent | |
| moduleFactory : IFlexModuleFactory
A module factory is used as context for using embedded fonts and for
finding the style manager that controls the styles for this
component. | UIComponent | |
| mouseChildren : Boolean
Determines whether or not the children of the object are mouse, or user input device, enabled. | DisplayObjectContainer | |
| mouseEnabled : Boolean
Specifies whether this object receives mouse, or other user input, messages. | InteractiveObject | |
| mouseFocusEnabled : Boolean
Whether you can receive focus when clicked on. | UIComponent | |
| mouseX : Number [read-only]
Indicates the x coordinate of the mouse or user input device position, in pixels. | DisplayObject | |
| mouseY : Number [read-only]
Indicates the y coordinate of the mouse or user input device position, in pixels. | DisplayObject | |
| mxmlContent : Array [write-only]
The visual content children for this Group. | SkinnableContainer | |
| mxmlContentFactory : IDeferredInstance [write-only]
A factory object that creates the initial value for the
content property. | SkinnableContainer | |
| name : String
Indicates the instance name of the DisplayObject. | DisplayObject | |
| 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 | ||
| needsSoftKeyboard : Boolean
Specifies whether a virtual keyboard (an on-screen, software keyboard) should display
when this InteractiveObject instance receives focus. | InteractiveObject | |
| nestLevel : int
Depth of this object in the containment hierarchy. | UIComponent | |
| nonInheritingStyles : Object
The beginning of this component's chain of non-inheriting styles. | UIComponent | |
| numAutomationChildren : int [read-only]
The number of automation children this container has. | UIComponent | |
| numElements : int [read-only]
The number of visual elements in this container. | SkinnableContainer | |
| opaqueBackground : Object
Specifies whether the display object is opaque with a certain background color. | DisplayObject | |
| owner : DisplayObjectContainer
The owner of this IVisualElement object. | UIComponent | |
| 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 : mx.geom:TransformOffsets
Defines a set of adjustments that can be applied to the object's
transform in a way that is invisible to its parent's layout. | UIComponent | |
| processedDescriptors : Boolean
Set to true after immediate or deferred child creation,
depending on which one happens. | UIComponent | |
| 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 | |
| root : DisplayObject [read-only]
For a display object in a loaded SWF file, the root property is the
top-most display object in the portion of the display list's tree structure represented by that SWF file. | DisplayObject | |
| rotation : Number [override]
Indicates the rotation of the DisplayObject instance, in degrees, from its original orientation. | UIComponent | |
| rotationX : Number [override]
Indicates the x-axis rotation of the DisplayObject instance, in degrees, from its original orientation
relative to the 3D parent container. | UIComponent | |
| rotationY : Number [override]
Indicates the y-axis rotation of the DisplayObject instance, in degrees, from its original orientation
relative to the 3D parent container. | UIComponent | |
| rotationZ : Number [override]
Indicates the z-axis rotation of the DisplayObject instance, in degrees, from its original orientation relative to the 3D parent container. | UIComponent | |
| scale9Grid : Rectangle
The current scaling grid that is in effect. | DisplayObject | |
| scaleX : Number [override]
Number that specifies the horizontal scaling factor. | UIComponent | |
| scaleY : Number [override]
Number that specifies the vertical scaling factor. | UIComponent | |
| scaleZ : Number [override]
Number that specifies the scaling factor along the z axis. | UIComponent | |
| screen : Rectangle [read-only]
Returns an object that contains the size and position of the base
drawing surface for this object. | UIComponent | |
| scrollRect : Rectangle
The scroll rectangle bounds of the display object. | DisplayObject | |
| showInAutomationHierarchy : Boolean
A flag that determines if an automation object
shows in the automation hierarchy. | UIComponent | |
| skin : UIComponent [read-only]
The instance of the skin class for this component instance. | SkinnableComponent | |
| softKeyboard : String
Controls the appearance of the soft keyboard. | InteractiveObject | |
| softKeyboardInputAreaOfInterest : Rectangle
Defines the area that should remain on-screen when a soft keyboard is displayed (not available on iOS). | InteractiveObject | |
| soundTransform : flash.media:SoundTransform
Controls sound within this sprite. | Sprite | |
| stage : Stage [read-only]
The Stage of the display object. | DisplayObject | |
| 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 | |
| tabChildren : Boolean
Determines whether the children of the object are tab enabled. | DisplayObjectContainer | |
| tabEnabled : Boolean
Specifies whether this object is in the tab order. | InteractiveObject | |
| tabFocusEnabled : Boolean
A flag that indicates whether this object can receive focus
via the TAB key
This is similar to the tabEnabled property
used by the Flash Player.
This is usually true for components that
handle keyboard input, but some components in controlbars
have them set to false because they should not steal
focus from another component like an editor. | UIComponent | |
| tabIndex : int
Specifies the tab ordering of objects in a SWF file. | InteractiveObject | |
| textSnapshot : flash.text:TextSnapshot [read-only]
Returns a TextSnapshot object for this DisplayObjectContainer instance. | DisplayObjectContainer | |
| title : String
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 : flash.geom:Transform [override]
An object with properties pertaining to a display object's matrix, color transform,
and pixel bounds. | UIComponent | |
| transformX : Number
Sets the x coordinate for the transform center of the component. | UIComponent | |
| transformY : Number
Sets the y coordinate for the transform center of the component. | UIComponent | |
| transformZ : Number
Sets the z coordinate for the transform center of the component. | UIComponent | |
| transitions : Array
An Array of Transition objects, where each Transition object defines a
set of effects to play when a view state change occurs. | UIComponent | |
| 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 | |
| useHandCursor : Boolean
A Boolean value that indicates whether the pointing hand (hand cursor) appears when the pointer rolls
over a sprite in which the buttonMode property is set to true. | Sprite | |
| 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]
Indicates the z coordinate position along the z-axis of the DisplayObject
instance relative to the 3D parent container. | UIComponent | |
Protected Properties
Public Methods
| Method | Defined By | ||
|---|---|---|---|
Constructor. | ViewNavigator | ||
|
Adds a visual element to this container. | SkinnableContainer | |
|
Adds a visual element to this container. | SkinnableContainer | |
| addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void
Registers an event listener object with an EventDispatcher object so that the listener
receives notification of an event. | EventDispatcher | |
|
Adds a non-visual style client to this component instance. | UIComponent | |
|
Indicates whether the security restrictions
would cause any display objects to be omitted from the list returned by calling
the DisplayObjectContainer.getObjectsUnderPoint() method
with the specified point point. | DisplayObjectContainer | |
[override]
Pops to the previous view of the navigator in response to the back
key. | ViewNavigator | ||
|
Queues a function to be called later. | UIComponent | |
|
Deletes a style property from this component instance. | UIComponent | |
|
Determines whether the specified display object is a child of the DisplayObjectContainer instance or
the instance itself. | DisplayObjectContainer | |
|
Converts a Point object from content coordinates to global coordinates. | UIComponent | |
|
Converts a Point object from content to local coordinates. | UIComponent | |
|
Returns a set of properties that identify the child within
this container. | UIComponent | |
|
Returns a set of properties that identify the child within
this container. | UIComponent | |
|
Create the content for this component. | SkinnableContainer | |
|
Creates an id reference to this IUIComponent object
on its parent document object. | UIComponent | |
|
Deletes the id reference to this IUIComponent object
on its parent document object. | UIComponent | |
|
Returns a UITextFormat object corresponding to the text styles
for this UIComponent. | UIComponent | |
| [override]
Dispatches an event into the event flow. | UIComponent | |
|
Shows or hides the focus indicator around this component. | UIComponent | |
| drawRoundRect(x:Number, y:Number, w:Number, h:Number, r:Object = null, c:Object = null, alpha:Object = null, rot:Object = null, gradient:String = null, ratios:Array = null, hole:Object = null):void
Programmatically draws a rectangle into this skin's Graphics object. | UIComponent | |
|
Called by the effect instance when it stops playing on the component. | UIComponent | |
|
Called by the effect instance when it starts playing on the component. | UIComponent | |
|
Ends all currently playing effects on the component. | UIComponent | |
|
Executes all the bindings for which the UIComponent object is the destination. | UIComponent | |
|
Called after printing is complete. | UIComponent | |
|
Provides the automation object at the specified index. | UIComponent | |
|
Provides the automation object list . | UIComponent | |
|
Returns a rectangle that defines the area of the display object relative to the coordinate system
of the targetCoordinateSpace object. | DisplayObject | |
|
Returns the x coordinate of the element's bounds at the specified element size. | UIComponent | |
|
Returns the y coordinate of the element's bounds at the specified element size. | UIComponent | |
|
Returns the child display object that exists with the specified name. | DisplayObjectContainer | |
|
Finds the type selectors for this UIComponent instance. | UIComponent | |
|
Returns a layout constraint value, which is the same as
getting the constraint style for this component. | UIComponent | |
|
Returns the visual element at the specified index. | SkinnableContainer | |
|
Returns the index position of a visual element. | SkinnableContainer | |
|
A convenience method for determining whether to use the
explicit or measured height
| UIComponent | |
|
A convenience method for determining whether to use the
explicit or measured width
| UIComponent | |
|
Gets the object that currently has focus. | UIComponent | |
|
Returns the element's layout height. | UIComponent | |
|
Returns the element's layout width. | UIComponent | |
|
Returns the x coordinate that the element uses to draw on screen. | UIComponent | |
|
Returns the y coordinate that the element uses to draw on screen. | UIComponent | |
|
Returns the transform matrix that is used to calculate the component's
layout relative to its siblings. | UIComponent | |
|
Returns the layout transform Matrix3D for this element. | UIComponent | |
|
Returns the element's maximum height. | UIComponent | |
|
Returns the element's maximum width. | UIComponent | |
|
Returns the element's minimum height. | UIComponent | |
|
Returns the element's minimum width. | UIComponent | |
|
Returns an array of objects that lie under the specified point and are children
(or grandchildren, and so on) of this DisplayObjectContainer instance. | DisplayObjectContainer | |
|
Returns the element's preferred height. | UIComponent | |
|
Returns the element's preferred width. | UIComponent | |
|
Returns a rectangle that defines the boundary of the display object,
based on the coordinate system defined by the targetCoordinateSpace
parameter, excluding any strokes on shapes. | DisplayObject | |
|
Returns the item in the dataProvider that was used
by the specified Repeater to produce this Repeater, or
null if this Repeater isn't repeated. | UIComponent | |
|
Gets a style property that has been set anywhere in this
component's style lookup chain. | UIComponent | |
|
Converts a Point object from global to content coordinates. | UIComponent | |
|
Converts the point object from the Stage (global) coordinates
to the display object's (local) coordinates. | DisplayObject | |
|
Converts a two-dimensional point from the Stage (global) coordinates to a
three-dimensional display object's (local) coordinates. | DisplayObject | |
|
Returns true if currentCSSState is not null. | UIComponent | |
|
Checks whether the EventDispatcher object has any listeners registered for a specific type
of event. | EventDispatcher | |
|
Indicates whether an object has a specified property defined. | Object | |
|
Determines whether the specified state has been defined on this
UIComponent. | UIComponent | |
Hides the action bar. | ViewNavigator | ||
|
Evaluates the bounding box of the display object to see if it overlaps or intersects with the
bounding box of the obj display object. | DisplayObject | |
|
Evaluates the display object to see if it overlaps or intersects with the
point specified by the x and y parameters. | DisplayObject | |
|
Returns a box Matrix which can be passed to the
drawRoundRect() method
as the rot parameter when drawing a horizontal gradient. | UIComponent | |
|
Initializes the internal structure of this component. | UIComponent | |
|
Initializes various properties which keep track of repeated instances
of this component. | UIComponent | |
|
Marks a component so that its updateDisplayList()
method gets called during a later screen update. | UIComponent | |
|
Called by a component's items to indicate that their depth
property has changed. | UIComponent | |
|
An element must call this method when its layoutDirection changes or
when its parent's layoutDirection changes. | UIComponent | |
|
Marks a component so that its commitProperties()
method gets called during a later screen update. | UIComponent | |
|
Marks a component so that its measure()
method gets called during a later screen update. | UIComponent | |
|
Marks the component so that the new state of the skin is set
during a later screen update. | SkinnableComponent | |
|
Indicates whether an instance of the Object class is in the prototype chain of the object specified
as the parameter. | Object | |
|
Restores the state of a navigator's view
from the value argument. | ViewNavigatorBase | |
|
Converts a three-dimensional point of the three-dimensional display
object's (local) coordinates to a two-dimensional point in the Stage (global) coordinates. | DisplayObject | |
|
Converts a Point object from local to content coordinates. | UIComponent | |
|
Converts the point object from the display object's (local) coordinates to the
Stage (global) coordinates. | DisplayObject | |
|
Returns true if cssState matches currentCSSState. | UIComponent | |
|
Determines whether this instance is the same as, or is a subclass of,
the given type. | UIComponent | |
|
Measures the specified HTML text, which can contain HTML tags such
as <font> and <b>,
assuming that it is displayed
in a single-line UITextField using a UITextFormat
determined by the styles of this UIComponent. | UIComponent | |
|
Measures the specified text, assuming that it is displayed
in a single-line UITextField (or UIFTETextField) using a UITextFormat
determined by the styles of this UIComponent. | UIComponent | |
|
Moves the component to a specified position within its parent. | UIComponent | |
|
Propagates style changes to the children. | UIComponent | |
|
Returns true if the chain of owner properties
points from child to this UIComponent. | UIComponent | |
|
Called by Flex when a UIComponent object is added to or removed from a parent. | UIComponent | |
Removes all of the views from the navigator stack. | ViewNavigator | ||
Removes all views except the bottom view from the navigation stack. | ViewNavigator | ||
Pops the current view off the navigation stack. | ViewNavigator | ||
|
Prepares an IFlexDisplayObject for printing. | UIComponent | |
|
Indicates whether the specified property exists and is enumerable. | Object | |
pushView(viewClass:Class, data:Object = null, context:Object = null, transition:spark.transitions:ViewTransitionBase = null):void
Pushes a new view onto the top of the navigation stack. | ViewNavigator | ||
|
Builds or rebuilds the CSS style cache for this component
and, if the recursive parameter is true,
for all descendants of this component as well. | UIComponent | |
|
For each effect event, registers the EffectManager
as one of the event listeners. | UIComponent | |
|
Removes all visual elements from the container. | SkinnableContainer | |
|
Removes all child DisplayObject instances from the child list of the DisplayObjectContainer instance. | DisplayObjectContainer | |
|
Removes the specified visual element from the child list of
this container. | SkinnableContainer | |
|
Removes a visual element from the specified index position
in the container. | SkinnableContainer | |
|
Removes a listener from the EventDispatcher object. | EventDispatcher | |
|
Removes a non-visual style client from this component instance. | UIComponent | |
replaceView(viewClass:Class, data:Object = null, context:Object = null, transition:spark.transitions:ViewTransitionBase = null):void
Replaces the top view of the navigation stack with a new view. | ViewNavigator | ||
|
Replays the specified event. | UIComponent | |
|
Raises a virtual keyboard. | InteractiveObject | |
|
Resolves a child by using the id provided. | UIComponent | |
| [static]
Resumes the background processing of methods
queued by callLater(), after a call to
suspendBackgroundProcessing(). | UIComponent | |
|
Serializes all data related to
the navigator's children into an object that can be saved
by the persistence manager. | ViewNavigatorBase | |
|
Sizes the object. | UIComponent | |
|
Sets a layout constraint value, which is the same as
setting the constraint style for this component. | UIComponent | |
|
Set the current state. | UIComponent | |
|
Changes the position of an existing visual element in the visual container. | SkinnableContainer | |
|
Sets the focus to this component. | UIComponent | |
|
Sets the coordinates that the element uses to draw on screen. | UIComponent | |
|
Sets the layout size of the element. | UIComponent | |
|
Sets the transform Matrix that is used to calculate the component's layout
size and position relative to its siblings. | UIComponent | |
|
Sets the transform Matrix3D that is used to calculate the component's layout
size and position relative to its siblings. | UIComponent | |
|
Sets the availability of a dynamic property for loop operations. | Object | |
|
Sets a style property on this component instance. | UIComponent | |
|
Called when the visible property changes. | UIComponent | |
Shows the action bar. | ViewNavigator | ||
|
Lets the user drag the specified sprite. | Sprite | |
|
Lets the user drag the specified sprite on a touch-enabled device. | Sprite | |
|
Recursively stops the timeline execution of all MovieClips rooted at this object. | DisplayObjectContainer | |
|
Ends the startDrag() method. | Sprite | |
|
Ends the startTouchDrag() method, for use with touch-enabled devices. | Sprite | |
|
Detects changes to style properties. | UIComponent | |
|
Flex calls the stylesInitialized() method when
the styles for a component are first initialized. | UIComponent | |
| [static]
Blocks the background processing of methods
queued by callLater(),
until resumeBackgroundProcessing() is called. | UIComponent | |
|
Swaps the index of the two specified visual elements. | SkinnableContainer | |
|
Swaps the visual elements at the two specified index
positions in the container. | SkinnableContainer | |
|
Returns the string representation of this object, formatted according to locale-specific conventions. | Object | |
| [override]
Returns a string indicating the location of this object
within the hierarchy of DisplayObjects in the Application. | FlexSprite | |
| transformAround(transformCenter:Vector3D, scale:Vector3D = null, rotation:Vector3D = null, translation:Vector3D = null, postLayoutScale:Vector3D = null, postLayoutRotation:Vector3D = null, postLayoutTranslation:Vector3D = null, invalidateLayout:Boolean = true):void
A utility method to update the rotation, scale, and translation of the
transform while keeping a particular point, specified in the component's
own coordinate space, fixed in the parent's coordinate space. | UIComponent | |
|
A utility method to transform a point specified in the local
coordinates of this object to its location in the object's parent's
coordinates. | UIComponent | |
|
Updates various properties of the navigator when a
new view is added and activated. | ViewNavigatorBase | |
|
Validates the position and size of children and draws other
visuals. | UIComponent | |
|
Validate and update the properties and layout of this object
and redraw it, if necessary. | UIComponent | |
|
Used by layout logic to validate the properties of a component
by calling the commitProperties() method. | UIComponent | |
|
Validates the measured size of the component
If the LayoutManager.invalidateSize() method is called with
this ILayoutManagerClient, then the validateSize() method
is called when it's time to do measurements. | UIComponent | |
|
Handles both the valid and invalid events from a
validator assigned to this component. | UIComponent | |
|
Returns the primitive value of the specified object. | Object | |
|
Returns a box Matrix which can be passed to drawRoundRect()
as the rot parameter when drawing a vertical gradient. | UIComponent | |
|
Checks whether an event listener is registered with this EventDispatcher object or any of
its ancestors for the specified event type. | EventDispatcher | |
Protected Methods
| Method | Defined By | ||
|---|---|---|---|
|
Adjust the focus rectangle. | UIComponent | |
|
Commits the computed matrix built from the combination of the layout
matrix and the transform offsets to the flash displayObject's transform. | UIComponent | |
|
This is an internal method used by the Flex framework
to support the Dissolve effect. | UIComponent | |
|
Create the skin for the component. | SkinnableComponent | |
|
Determines if the call to the measure() method can be skipped. | UIComponent | |
|
Performs any final processing after child objects are created. | UIComponent | |
|
Clear out references to skin parts. | SkinnableComponent | |
|
Processes the properties set on the component. | UIComponent | |
Creates the effect to play when the ActionBar control is hidden. | ViewNavigator | ||
Creates the effect to play when the ActionBar control appears. | ViewNavigator | ||
| [override]
Create content children, if the creationPolicy property
is not equal to none. | SkinnableContainer | |
|
Create an instance of a dynamic skin part. | SkinnableComponent | |
|
Creates a new object using a context
based on the embedded font being used. | UIComponent | |
|
Creates the object using a given moduleFactory. | UIComponent | |
|
Destroys and removes the skin for this component. | SkinnableComponent | |
|
Helper method for dispatching a PropertyChangeEvent
when a property is updated. | UIComponent | |
|
Find the skin parts in the skin class and assign them to the properties of the component. | SkinnableComponent | |
|
The event handler called when a UIComponent object gets focus. | UIComponent | |
|
The event handler called when a UIComponent object loses focus. | UIComponent | |
| [override]
Returns the name of the state to be applied to the skin. | SkinnableContainerBase | |
|
Returns a specific instance of a dynamic part. | SkinnableComponent | |
|
Initializes the implementation and storage of some of the less frequently
used advanced layout features of a component. | UIComponent | |
|
Finalizes the initialization of this component. | UIComponent | |
|
Initializes this component's accessibility code. | UIComponent | |
|
Helper method to invalidate parent size and display list if
this object affects its layout (includeInLayout is true). | UIComponent | |
|
Typically overridden by components containing UITextField objects,
where the UITextField object gets focus. | UIComponent | |
|
The event handler called for a keyDown event. | UIComponent | |
|
The event handler called for a keyUp event. | UIComponent | |
|
Calculates the default size, and optionally the default minimum size,
of the component. | UIComponent | |
|
Returns the number of instances of a dynamic part. | SkinnableComponent | |
| [override]
Called when a skin part is added. | SkinnableContainer | |
| [override]
Called when an instance of a skin part is being removed. | SkinnableContainer | |
|
Remove an instance of a dynamic part. | SkinnableComponent | |
|
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 | |
|
Specifies a transform stretch factor in the horizontal and vertical direction. | UIComponent | |
|
This method is called when a state changes to check whether
state-specific styles apply to this component. | UIComponent | |
|
Draws the object and/or sizes and positions its children. | UIComponent | |
Styles
Styles are either common or associated with a specific theme. If the style is common, it can be used with any theme. If a style is associated with a specific theme, it can only be used if your application uses that theme.
Common Styles
Spark Theme Styles
Mobile Theme Styles
Skin Parts
This component uses skins made up of skin parts. Do not set the skin parts directly. The component's skin sets the skin parts.
| Skin Part | Description | Defined By | ||
|---|---|---|---|---|
actionBar:ActionBar | Required: false Part Type: Static Language Version: ActionScript 3.0 Product Version: Flex 4.5 Runtime Versions: AIR2.5, A skin part that defines the action bar of the navigator. | ViewNavigator | ||
| Required: false Part Type: Static Language Version: ActionScript 3.0 Product Version: Flex 4 Runtime Versions: Flash10, AIR 1.5 An optional skin part that defines the Group where the content children get pushed into and laid out. | SkinnableContainer | ||
Skin States
To skin the component, implement a skin that defines the following states. Although you must implement all skin states, a skin state can be empty. An empty skin state specifies no changes to the default skin state.
| Skin State | Description | Defined By | ||
|---|---|---|---|---|
|
Disabled State
Language Version: ActionScript 3.0 Product Version: Flex 4 Runtime Versions: Flash10, AIR 1.5 | SkinnableContainerBase | ||
landscape |
The state used when the navigator is in landscape orientation.
Language Version: ActionScript 3.0 Product Version: Flex 4.5 Runtime Versions: AIR2.5, | ViewNavigator | ||
landscapeAndOverlay |
The state used when the navigator is in landscape orientation
and the navigator controls are overlaid on top.
Language Version: ActionScript 3.0 Product Version: Flex 4.5 Runtime Versions: AIR2.5, | ViewNavigator | ||
|
Normal State
Language Version: ActionScript 3.0 Product Version: Flex 4 Runtime Versions: Flash10, AIR 1.5 | SkinnableContainerBase | ||
portrait |
The state used when the navigator is in portrait orientation.
Language Version: ActionScript 3.0 Product Version: Flex 4.5 Runtime Versions: AIR2.5, | ViewNavigator | ||
portraitAndOverlay |
The state used when the navigator is in portrait orientation
and the navigator controls are overlaid on top.
Language Version: ActionScript 3.0 Product Version: Flex 4.5 Runtime Versions: AIR2.5, | ViewNavigator | ||
Public Constants
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.
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):voidRelated API Elements
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. When this property is modified, it dispatches the viewChangeComplete event.
Implementation
override 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:spark.transitions: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():spark.transitions:ViewTransitionBase public function set defaultPopTransition(value:spark.transitions:ViewTransitionBase):voidRelated API Elements
defaultPushTransition | property |
defaultPushTransition:spark.transitions: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():spark.transitions:ViewTransitionBase public function set defaultPushTransition(value:spark.transitions:ViewTransitionBase):voidRelated API Elements
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):voidRelated API Elements
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):voidRelated API Elements
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. When this property is modified, it dispatches the lengthChanged event.
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.
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):voidRelated API Elements
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():ViewReturnObjectRelated API Elements
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.
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. When this property is modified, it dispatches the propertyChange event.
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.
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):voidRelated API Elements
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):voidConstructor 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.
ReturnsIEffect — 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.
ReturnsIEffect — An effect to play when the ActionBar control is appears.
|
hideActionBar | () | method |
popAll | () | method |
public function popAll(transition:spark.transitions: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:spark.transitions:ViewTransitionBase (default = null) |
popToFirstView | () | method |
public function popToFirstView(transition:spark.transitions: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:spark.transitions:ViewTransitionBase (default = null) |
popView | () | method |
public function popView(transition:spark.transitions: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:spark.transitions:ViewTransitionBase (default = null) |
pushView | () | method |
public function pushView(viewClass:Class, data:Object = null, context:Object = null, transition:spark.transitions: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)data property of the new view.
| |
context:Object (default = null)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:spark.transitions:ViewTransitionBase (default = null) |
replaceView | () | method |
public function replaceView(viewClass:Class, data:Object = null, context:Object = null, transition:spark.transitions: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)data property of the new view.
| |
context:Object (default = null) | |
transition:spark.transitions:ViewTransitionBase (default = null) |
showActionBar | () | method |
Examples How to use this example
ViewNavigatorExample.mxml
<?xml version="1.0" encoding="utf-8"?>
<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"?>
<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"?>
<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>
Mon Apr 10 2017, 12:28 PM -07:00