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 |
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 SyntaxHide 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
See also
Property | Defined By | ||
---|---|---|---|
accessibilityDescription : String
A convenience accessor for the description property
in this UIComponent's accessibilityProperties object. | UIComponent | ||
accessibilityEnabled : Boolean
A convenience accessor for the silent property
in this UIComponent's accessibilityProperties object. | UIComponent | ||
accessibilityName : String
A convenience accessor for the name property
in this UIComponent's accessibilityProperties object. | UIComponent | ||
accessibilityShortcut : String
A convenience accessor for the shortcut property
in this UIComponent's accessibilityProperties object. | UIComponent | ||
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 |
Method | Defined By | ||
---|---|---|---|
Constructor. | ViewNavigator | ||
Adds a visual element to this container. | SkinnableContainer | ||
Adds a visual element to this container. | SkinnableContainer | ||
addStyleClient(styleClient:IAdvancedStyleClient):void
Adds a non-visual style client to this component instance. | UIComponent | ||
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 | ||
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 | ||
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 | ||
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 |
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 | ||
Creates the effect to play when the ActionBar control is hidden. | ViewNavigator | ||
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 | ||
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 |
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 A skin part that defines the action bar of the navigator. | ViewNavigator | ||
Required: false Part Type: Static An optional skin part that defines the Group where the content children get pushed into and laid out. | SkinnableContainer |
To skin the component, implement a skin that defines the following states. Although you must implement all skin states, a skin state can be empty. An empty skin state specifies no changes to the default skin state.
Skin State | Description | Defined By | ||
---|---|---|---|---|
Disabled State | SkinnableContainerBase | |||
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 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 |
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
.
public function get actionContent():Array
public function set actionContent(value:Array):void
See also
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
.
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.
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
.
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
.
public function get defaultPopTransition():ViewTransitionBase
public function set defaultPopTransition(value:ViewTransitionBase):void
See also
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
.
public function get defaultPushTransition():ViewTransitionBase
public function set defaultPushTransition(value:ViewTransitionBase):void
See also
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
.
public function get firstView():Class
public function set firstView(value:Class):void
See also
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
.
public function get firstViewData():Object
public function set firstViewData(value:Object):void
See also
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.
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
.
public function get navigationContent():Array
public function set navigationContent(value:Array):void
See also
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
.
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
.
public function get poppedViewReturnedObject():ViewReturnObject
See also
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.
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
.
public function get titleContent():Array
public function set titleContent(value:Array):void
See also
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
.
public function get titleLayout():LayoutBase
public function set titleLayout(value:LayoutBase):void
ViewNavigator | () | Constructor |
public function ViewNavigator()
Language Version : | ActionScript 3.0 |
Product Version : | Flex 4.5 |
Runtime Versions : | AIR 2.5 |
Constructor.
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 |
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.
|
<?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>
<?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>
<?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>