ActionScript® 3.0 Reference for the Adobe® Flash® Platform
Home  |  Hide Packages and Classes List |  Packages  |  Classes  |  What's New  |  Index  |  Appendixes

Language Reference only
Filters: AIR 32.0 and earlier, Flash Player 32.0 and earlier, Flash Lite 4
Flex 4.6 and earlier, Flash Pro CS6 and earlier
Hide Filters
spark.transitions 

ViewTransitionBase  - AS3 Flex

Packagesx

Top Level
adobe.utils
air.desktop
air.net
air.update
air.update.events
coldfusion.air
coldfusion.air.errors
coldfusion.air.events
coldfusion.service
coldfusion.service.events
coldfusion.service.mxml
com.adobe.acm.solutions.authoring.domain.extensions
com.adobe.acm.solutions.ccr.domain.extensions
com.adobe.consulting.pst.vo
com.adobe.dct.component
com.adobe.dct.component.datadictionary
com.adobe.dct.component.datadictionaryElement
com.adobe.dct.component.dataElementsPanel
com.adobe.dct.component.toolbars
com.adobe.dct.event
com.adobe.dct.exp
com.adobe.dct.model
com.adobe.dct.service
com.adobe.dct.service.provider
com.adobe.dct.transfer
com.adobe.dct.util
com.adobe.dct.view
com.adobe.ep.taskmanagement.domain
com.adobe.ep.taskmanagement.event
com.adobe.ep.taskmanagement.filter
com.adobe.ep.taskmanagement.services
com.adobe.ep.taskmanagement.util
com.adobe.ep.ux.attachmentlist.component
com.adobe.ep.ux.attachmentlist.domain
com.adobe.ep.ux.attachmentlist.domain.events
com.adobe.ep.ux.attachmentlist.domain.renderers
com.adobe.ep.ux.attachmentlist.skin
com.adobe.ep.ux.attachmentlist.skin.renderers
com.adobe.ep.ux.content.event
com.adobe.ep.ux.content.factory
com.adobe.ep.ux.content.handlers
com.adobe.ep.ux.content.managers
com.adobe.ep.ux.content.model.asset
com.adobe.ep.ux.content.model.preview
com.adobe.ep.ux.content.model.relation
com.adobe.ep.ux.content.model.search
com.adobe.ep.ux.content.model.toolbar
com.adobe.ep.ux.content.search
com.adobe.ep.ux.content.services
com.adobe.ep.ux.content.services.load
com.adobe.ep.ux.content.services.permissions
com.adobe.ep.ux.content.services.preview
com.adobe.ep.ux.content.services.providers
com.adobe.ep.ux.content.services.query
com.adobe.ep.ux.content.services.relationships
com.adobe.ep.ux.content.services.search.lccontent
com.adobe.ep.ux.content.services.version
com.adobe.ep.ux.content.view
com.adobe.ep.ux.content.view.components.activate
com.adobe.ep.ux.content.view.components.grid
com.adobe.ep.ux.content.view.components.grid.hover
com.adobe.ep.ux.content.view.components.grid.hover.component
com.adobe.ep.ux.content.view.components.grid.renderers
com.adobe.ep.ux.content.view.components.relationships
com.adobe.ep.ux.content.view.components.review
com.adobe.ep.ux.content.view.components.search.renderers
com.adobe.ep.ux.content.view.components.searchpod
com.adobe.ep.ux.content.view.components.toolbar
com.adobe.ep.ux.content.view.components.toolbar.controlRenderers
com.adobe.ep.ux.content.view.components.version
com.adobe.ep.ux.documentsubmit.component
com.adobe.ep.ux.documentsubmit.domain
com.adobe.ep.ux.documentsubmit.skin
com.adobe.ep.ux.taskaction.component
com.adobe.ep.ux.taskaction.domain
com.adobe.ep.ux.taskaction.domain.events
com.adobe.ep.ux.taskaction.skin
com.adobe.ep.ux.taskdetails.component
com.adobe.ep.ux.taskdetails.domain
com.adobe.ep.ux.taskdetails.skin
com.adobe.ep.ux.tasklist.component
com.adobe.ep.ux.tasklist.domain
com.adobe.ep.ux.tasklist.skin
com.adobe.ep.ux.webdocumentviewer.domain
com.adobe.exm.expression
com.adobe.exm.expression.error
com.adobe.exm.expression.event
com.adobe.exm.expression.impl
com.adobe.fiber.runtime.lib
com.adobe.fiber.services
com.adobe.fiber.services.wrapper
com.adobe.fiber.styles
com.adobe.fiber.util
com.adobe.fiber.valueobjects
com.adobe.gravity.binding
com.adobe.gravity.context
com.adobe.gravity.flex.bundleloader
com.adobe.gravity.flex.progress
com.adobe.gravity.flex.serviceloader
com.adobe.gravity.framework
com.adobe.gravity.init
com.adobe.gravity.service.bundleloader
com.adobe.gravity.service.logging
com.adobe.gravity.service.manifest
com.adobe.gravity.service.progress
com.adobe.gravity.tracker
com.adobe.gravity.ui
com.adobe.gravity.utility
com.adobe.gravity.utility.async
com.adobe.gravity.utility.error
com.adobe.gravity.utility.events
com.adobe.gravity.utility.factory
com.adobe.gravity.utility.flex.async
com.adobe.gravity.utility.logging
com.adobe.gravity.utility.message
com.adobe.gravity.utility.sequence
com.adobe.gravity.utility.url
com.adobe.guides.control
com.adobe.guides.domain
com.adobe.guides.i18n
com.adobe.guides.spark.components.skins
com.adobe.guides.spark.components.skins.mx
com.adobe.guides.spark.headers.components
com.adobe.guides.spark.headers.skins
com.adobe.guides.spark.layouts.components
com.adobe.guides.spark.layouts.skins
com.adobe.guides.spark.navigators.components
com.adobe.guides.spark.navigators.renderers
com.adobe.guides.spark.navigators.skins
com.adobe.guides.spark.util
com.adobe.guides.spark.wrappers.components
com.adobe.guides.spark.wrappers.skins
com.adobe.guides.submit
com.adobe.icc.dc.domain
com.adobe.icc.dc.domain.factory
com.adobe.icc.editors.events
com.adobe.icc.editors.handlers
com.adobe.icc.editors.managers
com.adobe.icc.editors.model
com.adobe.icc.editors.model.config
com.adobe.icc.editors.model.el
com.adobe.icc.editors.model.el.operands
com.adobe.icc.editors.model.el.operators
com.adobe.icc.enum
com.adobe.icc.external.dc
com.adobe.icc.obj
com.adobe.icc.services
com.adobe.icc.services.category
com.adobe.icc.services.config
com.adobe.icc.services.download
com.adobe.icc.services.export
com.adobe.icc.services.external
com.adobe.icc.services.formbridge
com.adobe.icc.services.fragmentlayout
com.adobe.icc.services.layout
com.adobe.icc.services.letter
com.adobe.icc.services.locator
com.adobe.icc.services.module
com.adobe.icc.services.render
com.adobe.icc.services.submit
com.adobe.icc.services.user
com.adobe.icc.token
com.adobe.icc.vo
com.adobe.icc.vo.render
com.adobe.icomm.assetplacement.controller
com.adobe.icomm.assetplacement.controller.utils
com.adobe.icomm.assetplacement.data
com.adobe.icomm.assetplacement.model
com.adobe.livecycle.assetmanager.client
com.adobe.livecycle.assetmanager.client.event
com.adobe.livecycle.assetmanager.client.handler
com.adobe.livecycle.assetmanager.client.managers
com.adobe.livecycle.assetmanager.client.model
com.adobe.livecycle.assetmanager.client.model.cms
com.adobe.livecycle.assetmanager.client.service
com.adobe.livecycle.assetmanager.client.service.search
com.adobe.livecycle.assetmanager.client.service.search.cms
com.adobe.livecycle.assetmanager.client.utils
com.adobe.livecycle.content
com.adobe.livecycle.rca.model
com.adobe.livecycle.rca.model.constant
com.adobe.livecycle.rca.model.document
com.adobe.livecycle.rca.model.participant
com.adobe.livecycle.rca.model.reminder
com.adobe.livecycle.rca.model.stage
com.adobe.livecycle.rca.service
com.adobe.livecycle.rca.service.core
com.adobe.livecycle.rca.service.core.delegate
com.adobe.livecycle.rca.service.process
com.adobe.livecycle.rca.service.process.delegate
com.adobe.livecycle.rca.token
com.adobe.livecycle.ria.security.api
com.adobe.livecycle.ria.security.service
com.adobe.mosaic.layouts
com.adobe.mosaic.layouts.dragAndDrop
com.adobe.mosaic.layouts.interfaces
com.adobe.mosaic.mxml
com.adobe.mosaic.om.constants
com.adobe.mosaic.om.events
com.adobe.mosaic.om.impl
com.adobe.mosaic.om.interfaces
com.adobe.mosaic.skinning
com.adobe.mosaic.sparklib.editors
com.adobe.mosaic.sparklib.optionMenu
com.adobe.mosaic.sparklib.scrollableMenu
com.adobe.mosaic.sparklib.scrollableMenu.skins
com.adobe.mosaic.sparklib.tabLayout
com.adobe.mosaic.sparklib.tabLayout.events
com.adobe.mosaic.sparklib.tabLayout.layouts
com.adobe.mosaic.sparklib.tabLayout.skins
com.adobe.mosaic.sparklib.text
com.adobe.mosaic.sparklib.util
com.adobe.solutions.acm.authoring.presentation
com.adobe.solutions.acm.authoring.presentation.actionbar
com.adobe.solutions.acm.authoring.presentation.common
com.adobe.solutions.acm.authoring.presentation.events
com.adobe.solutions.acm.authoring.presentation.fragment
com.adobe.solutions.acm.authoring.presentation.letter
com.adobe.solutions.acm.authoring.presentation.letter.data
com.adobe.solutions.acm.authoring.presentation.preview
com.adobe.solutions.acm.authoring.presentation.rte
com.adobe.solutions.acm.ccr.presentation
com.adobe.solutions.acm.ccr.presentation.contentcapture
com.adobe.solutions.acm.ccr.presentation.contentcapture.events
com.adobe.solutions.acm.ccr.presentation.contentcapture.preview
com.adobe.solutions.acm.ccr.presentation.datacapture
com.adobe.solutions.acm.ccr.presentation.datacapture.renderers
com.adobe.solutions.acm.ccr.presentation.pdf
com.adobe.solutions.exm
com.adobe.solutions.exm.authoring
com.adobe.solutions.exm.authoring.components.controls
com.adobe.solutions.exm.authoring.components.toolbars
com.adobe.solutions.exm.authoring.domain
com.adobe.solutions.exm.authoring.domain.expression
com.adobe.solutions.exm.authoring.domain.impl
com.adobe.solutions.exm.authoring.domain.method
com.adobe.solutions.exm.authoring.domain.variable
com.adobe.solutions.exm.authoring.enum
com.adobe.solutions.exm.authoring.events
com.adobe.solutions.exm.authoring.model
com.adobe.solutions.exm.authoring.renderer
com.adobe.solutions.exm.authoring.view
com.adobe.solutions.exm.expression
com.adobe.solutions.exm.impl
com.adobe.solutions.exm.impl.method
com.adobe.solutions.exm.method
com.adobe.solutions.exm.mock
com.adobe.solutions.exm.mock.method
com.adobe.solutions.exm.runtime
com.adobe.solutions.exm.runtime.impl
com.adobe.solutions.exm.variable
com.adobe.solutions.prm.constant
com.adobe.solutions.prm.domain
com.adobe.solutions.prm.domain.factory
com.adobe.solutions.prm.domain.impl
com.adobe.solutions.prm.domain.manager
com.adobe.solutions.prm.presentation.asset
com.adobe.solutions.prm.presentation.constant
com.adobe.solutions.prm.presentation.document
com.adobe.solutions.prm.presentation.event
com.adobe.solutions.prm.presentation.file
com.adobe.solutions.prm.presentation.project
com.adobe.solutions.prm.presentation.team
com.adobe.solutions.prm.presentation.util
com.adobe.solutions.prm.service
com.adobe.solutions.prm.services.impl
com.adobe.solutions.prm.vo
com.adobe.solutions.rca.constant
com.adobe.solutions.rca.domain
com.adobe.solutions.rca.domain.common
com.adobe.solutions.rca.domain.factory
com.adobe.solutions.rca.domain.impl
com.adobe.solutions.rca.domain.impl.manager
com.adobe.solutions.rca.domain.manager
com.adobe.solutions.rca.presentation
com.adobe.solutions.rca.presentation.comment
com.adobe.solutions.rca.presentation.constant
com.adobe.solutions.rca.presentation.event
com.adobe.solutions.rca.presentation.gantt
com.adobe.solutions.rca.presentation.gantt.ruler
com.adobe.solutions.rca.presentation.template
com.adobe.solutions.rca.presentation.template.audit
com.adobe.solutions.rca.presentation.template.definition
com.adobe.solutions.rca.presentation.template.documents
com.adobe.solutions.rca.presentation.template.stages
com.adobe.solutions.rca.presentation.util
com.adobe.solutions.rca.service
com.adobe.solutions.rca.services.impl
com.adobe.solutions.rca.vo
com.adobe.solutions.rca.vo.um
com.adobe.viewsource
fl.accessibility
fl.containers
fl.controls
fl.controls.dataGridClasses
fl.controls.listClasses
fl.controls.progressBarClasses
fl.core
fl.data
fl.display
fl.events
fl.ik
fl.lang
fl.livepreview
fl.managers
fl.motion
fl.motion.easing
fl.rsl
fl.text
fl.transitions
fl.transitions.easing
fl.video
flash.accessibility
flash.concurrent
flash.crypto
flash.data
flash.desktop
flash.display
flash.display3D
flash.display3D.textures
flash.errors
flash.events
flash.external
flash.filesystem
flash.filters
flash.geom
flash.globalization
flash.html
flash.media
flash.net
flash.net.dns
flash.net.drm
flash.notifications
flash.permissions
flash.printing
flash.profiler
flash.sampler
flash.security
flash.sensors
flash.system
flash.text
flash.text.engine
flash.text.ime
flash.ui
flash.utils
flash.xml
flashx.textLayout
flashx.textLayout.compose
flashx.textLayout.container
flashx.textLayout.conversion
flashx.textLayout.edit
flashx.textLayout.elements
flashx.textLayout.events
flashx.textLayout.factory
flashx.textLayout.formats
flashx.textLayout.operations
flashx.textLayout.utils
flashx.undo
ga.controls
ga.layouts
ga.model
ga.uiComponents
ga.util
ga.views
ga.wrappers
lc.foundation
lc.foundation.domain
lc.foundation.events
lc.foundation.ui
lc.foundation.util
lc.preloader
lc.procmgmt
lc.procmgmt.commands
lc.procmgmt.domain
lc.procmgmt.events
lc.procmgmt.formbridge
lc.procmgmt.impl
lc.procmgmt.ui.attachments
lc.procmgmt.ui.controls
lc.procmgmt.ui.controls.card
lc.procmgmt.ui.controls.renderer
lc.procmgmt.ui.help
lc.procmgmt.ui.layout
lc.procmgmt.ui.presentationmodel
lc.procmgmt.ui.process
lc.procmgmt.ui.search
lc.procmgmt.ui.startpoint
lc.procmgmt.ui.task
lc.procmgmt.ui.task.form
lc.procmgmt.ui.task.form.commands
lc.procmgmt.ui.tracking
mx.accessibility
mx.automation
mx.automation.air
mx.automation.delegates
mx.automation.delegates.advancedDataGrid
mx.automation.delegates.charts
mx.automation.delegates.containers
mx.automation.delegates.controls
mx.automation.delegates.controls.dataGridClasses
mx.automation.delegates.controls.fileSystemClasses
mx.automation.delegates.core
mx.automation.delegates.flashflexkit
mx.automation.events
mx.binding
mx.binding.utils
mx.charts
mx.charts.chartClasses
mx.charts.effects
mx.charts.effects.effectClasses
mx.charts.events
mx.charts.renderers
mx.charts.series
mx.charts.series.items
mx.charts.series.renderData
mx.charts.styles
mx.collections
mx.collections.errors
mx.containers
mx.containers.accordionClasses
mx.containers.dividedBoxClasses
mx.containers.errors
mx.containers.utilityClasses
mx.controls
mx.controls.advancedDataGridClasses
mx.controls.dataGridClasses
mx.controls.listClasses
mx.controls.menuClasses
mx.controls.olapDataGridClasses
mx.controls.scrollClasses
mx.controls.sliderClasses
mx.controls.textClasses
mx.controls.treeClasses
mx.controls.videoClasses
mx.core
mx.core.windowClasses
mx.data
mx.data.crypto
mx.data.errors
mx.data.events
mx.data.messages
mx.data.mxml
mx.data.offline.errors
mx.data.utils
mx.effects
mx.effects.easing
mx.effects.effectClasses
mx.events
mx.filters
mx.flash
mx.formatters
mx.geom
mx.graphics
mx.graphics.codec
mx.graphics.shaderClasses
mx.logging
mx.logging.errors
mx.logging.targets
mx.managers
mx.messaging
mx.messaging.channels
mx.messaging.config
mx.messaging.errors
mx.messaging.events
mx.messaging.management
mx.messaging.messages
mx.modules
mx.netmon
mx.olap
mx.olap.aggregators
mx.preloaders
mx.printing
mx.resources
mx.rpc
mx.rpc.events
mx.rpc.http
mx.rpc.http.mxml
mx.rpc.livecycle
mx.rpc.mxml
mx.rpc.remoting
mx.rpc.remoting.mxml
mx.rpc.soap
mx.rpc.soap.mxml
mx.rpc.wsdl
mx.rpc.xml
mx.skins
mx.skins.halo
mx.skins.spark
mx.skins.wireframe
mx.skins.wireframe.windowChrome
mx.states
mx.styles
mx.utils
mx.validators
org.osmf.containers
org.osmf.display
org.osmf.elements
org.osmf.events
org.osmf.layout
org.osmf.logging
org.osmf.media
org.osmf.metadata
org.osmf.net
org.osmf.net.dvr
org.osmf.net.httpstreaming
org.osmf.net.metrics
org.osmf.net.qos
org.osmf.net.rtmpstreaming
org.osmf.net.rules
org.osmf.traits
org.osmf.utils
spark.accessibility
spark.automation.delegates
spark.automation.delegates.components
spark.automation.delegates.components.gridClasses
spark.automation.delegates.components.mediaClasses
spark.automation.delegates.components.supportClasses
spark.automation.delegates.skins.spark
spark.automation.events
spark.collections
spark.components
spark.components.calendarClasses
spark.components.gridClasses
spark.components.mediaClasses
spark.components.supportClasses
spark.components.windowClasses
spark.core
spark.effects
spark.effects.animation
spark.effects.easing
spark.effects.interpolation
spark.effects.supportClasses
spark.events
spark.filters
spark.formatters
spark.formatters.supportClasses
spark.globalization
spark.globalization.supportClasses
spark.layouts
spark.layouts.supportClasses
spark.managers
spark.modules
spark.preloaders
spark.primitives
spark.primitives.supportClasses
spark.skins
spark.skins.mobile
spark.skins.mobile.supportClasses
spark.skins.spark
spark.skins.spark.mediaClasses.fullScreen
spark.skins.spark.mediaClasses.normal
spark.skins.spark.windowChrome
spark.skins.wireframe
spark.skins.wireframe.mediaClasses
spark.skins.wireframe.mediaClasses.fullScreen
spark.transitions
spark.utils
spark.validators
spark.validators.supportClasses
xd.core.axm.enterprise.view.components
xd.core.axm.enterprise.view.skins
xd.core.axm.view.components
xd.core.axm.view.components.support

Language Elements

Global Constants
Global Functions
Operators
Statements, Keywords & Directives
Special Types

Appendixes

What's New
Compiler Errors
Compiler Warnings
Run-Time Errors
Migrating to ActionScript 3
Supported Character Sets
MXML Only Tags
Motion XML Elements
Timed Text Tags
List of deprecated elements
Accessibility Implementation Constants
How to Use ActionScript Examples
Legal notices
Packagespark.transitions
Classpublic class ViewTransitionBase
InheritanceViewTransitionBase Inheritance EventDispatcher Inheritance Object
Subclasses CrossFadeViewTransition, FlipViewTransition, SlideViewTransition, ZoomViewTransition

Language Version: ActionScript 3.0
Product Version: Flex 4.5
Runtime Versions: AIR 2.5

The ViewTransitionBase class is the base class for all view transitions. It is not intended to be used as a transition on its own. In addition to providing common convenience and helper methods used by view transitions, this class provides a default action bar transition sequence.

When a view transition is initialized, the owning view navigator sets the startView and endView properties to the views the transition animates. The navigator property is set to the view navigator.

The lifecycle of a transition is as follows:

  • The transition starts with the captureStartValues() method. When this method is called, the navigator is currently in the start state. At this time, the transition should capture any start values or bitmaps that it requires.
  • A validation pass is performed on the pending view, and the captureEndValues() method is called. At this time, the transition captures any properties or bitmaps representations from the pending view.
  • The prepareForPlay() method is then called, which allows the transition to perform any further preparations, such as preparing a Spark effects sequence, or positioning transient elements on the display list.
  • After a final validation pass, if necessary, the play() method is called by the navigator to perform the actual transition.
  • Prior to any animation starting, the start event is dispatched.
  • When a transition completes, it dispatches an end event.

Note:Create and configure view transitions in ActionScript; you cannot create them in MXML.



Public Properties
 PropertyDefined By
 Inheritedconstructor : Object
A reference to the class object or constructor function for a given object instance.
Object
      duration : Number
Duration of the transition, in milliseconds.
ViewTransitionBase
      easer : IEaser
The easing behavior for this transition.
ViewTransitionBase
      endView : View
The view that the navigator is transitioning to, as set by the owning ViewNavigator object.
ViewTransitionBase
      navigator : ViewNavigator
Reference to the owning ViewNavigator instance set by the owning ViewNavigator.
ViewTransitionBase
      startView : View
The currently active view of the view navigator, as set by the owning view navigator.
ViewTransitionBase
      suspendBackgroundProcessing : Boolean
When set to true, the UIComponent.suspendBackgroundProcessing() method is invoked prior to the transition playing.
ViewTransitionBase
      transitionControlsWithContent : Boolean
When set to true, the primary view transition is used to transition the view navigator in its entirety, including the action bar.
ViewTransitionBase
Public Methods
 MethodDefined By
  
Constructor.
ViewTransitionBase
 Inherited
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
  
Called by the ViewNavigator during the preparation phase of a transition.
ViewTransitionBase
  
Called by the ViewNavigator during the preparation phase of a transition.
ViewTransitionBase
 Inherited
Dispatches an event into the event flow.
EventDispatcher
 Inherited
Checks whether the EventDispatcher object has any listeners registered for a specific type of event.
EventDispatcher
 Inherited
Indicates whether an object has a specified property defined.
Object
 Inherited
Indicates whether an instance of the Object class is in the prototype chain of the object specified as the parameter.
Object
  
    play():void
Called by the ViewNavigator when the transition should begin animating.
ViewTransitionBase
  
Called by the ViewNavigator during the preparation phase of a transition.
ViewTransitionBase
 Inherited
Indicates whether the specified property exists and is enumerable.
Object
 Inherited
removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void
Removes a listener from the EventDispatcher object.
EventDispatcher
 Inherited
Sets the availability of a dynamic property for loop operations.
Object
 Inherited
Returns the string representation of this object, formatted according to locale-specific conventions.
Object
 Inherited
Returns the string representation of the specified object.
Object
 Inherited
Returns the primitive value of the specified object.
Object
 Inherited
Checks whether an event listener is registered with this EventDispatcher object or any of its ancestors for the specified event type.
EventDispatcher
Protected Methods
 MethodDefined By
  
Determine if Flex can perform a transition on action bar or tab bar content independently of the views.
ViewTransitionBase
  
    cleanUp():void
Called after the transition completes.
ViewTransitionBase
  
Called by the default prepareForPlay() implementation, this method is responsible for creating the Spark effect played on the action bar when the transition starts.
ViewTransitionBase
  
Called by the default prepareForPlay() implementation, this method is responsible for creating the Spark effect played to transition the entire navigator, inclusive of the control bar content, when necessary.
ViewTransitionBase
  
Called by the default prepareForPlay() implementation, this method is responsible for creating the Spark effect played on the tab bar when the transition starts.
ViewTransitionBase
  
Called by the default prepareForPlay() implementation, this method is responsible for creating the Spark effect played on the current and next view when the transition starts.
ViewTransitionBase
  
    getSnapshot(target:UIComponent, padding:int = 4, globalPosition:Point = null):BitmapImage
Used to render snap shots of screen elements in preparation for transitioning.
ViewTransitionBase
  
Called by the transition to indicate that the transition has completed.
ViewTransitionBase
Events
 Event Summary Defined By
 Inherited[broadcast event] Dispatched when the Flash Player or AIR application gains operating system focus and becomes active.EventDispatcher
 Inherited[broadcast event] Dispatched when the Flash Player or AIR application operating loses system focus and is becoming inactive.EventDispatcher
  Dispatched when the transition completes.ViewTransitionBase
  Dispatched when the transition starts.ViewTransitionBase
Property Detail
    

duration

property
duration:Number

Language Version: ActionScript 3.0
Product Version: Flex 4.5
Runtime Versions: AIR 2.5

Duration of the transition, in milliseconds. The default may vary depending on the transition but is defined in ViewTransitionBase as 250 ms.



Implementation
    public function get duration():Number
    public function set duration(value:Number):void
    

easer

property 
easer:IEaser

Language Version: ActionScript 3.0
Product Version: Flex 4.5
Runtime Versions: AIR 2.5

The easing behavior for this transition. The IEaser object is generally propagated to the IEffect instance managing the actual transition animation.

The default value is Sine(.5);.



Implementation
    public function get easer():IEaser
    public function set easer(value:IEaser):void

Related API Elements

    

endView

property 
endView:View

Language Version: ActionScript 3.0
Product Version: Flex 4.5
Runtime Versions: AIR 2.5

The view that the navigator is transitioning to, as set by the owning ViewNavigator object. This property can be null.

The default value is null.



Implementation
    public function get endView():View
    public function set endView(value:View):void
    

navigator

property 
navigator:ViewNavigator

Language Version: ActionScript 3.0
Product Version: Flex 4.5
Runtime Versions: AIR 2.5

Reference to the owning ViewNavigator instance set by the owning ViewNavigator.

The default value is null.



Implementation
    public function get navigator():ViewNavigator
    public function set navigator(value:ViewNavigator):void
    

startView

property 
startView:View

Language Version: ActionScript 3.0
Product Version: Flex 4.5
Runtime Versions: AIR 2.5

The currently active view of the view navigator, as set by the owning view navigator. This property can be null.



Implementation
    public function get startView():View
    public function set startView(value:View):void
    

suspendBackgroundProcessing

property 
suspendBackgroundProcessing:Boolean

Language Version: ActionScript 3.0
Product Version: Flex 4.5
Runtime Versions: AIR 2.5

When set to true, the UIComponent.suspendBackgroundProcessing() method is invoked prior to the transition playing. This disables Flex's layout manager and improving performance. Upon completion of the transition, the layout manager function is restored by a call to the UIComponent.resumeBackgroundProcessing() method.

The default value is false.



Implementation
    public function get suspendBackgroundProcessing():Boolean
    public function set suspendBackgroundProcessing(value:Boolean):void

Related API Elements

    

transitionControlsWithContent

property 
transitionControlsWithContent:Boolean

Language Version: ActionScript 3.0
Product Version: Flex 4.5
Runtime Versions: AIR 2.5

When set to true, the primary view transition is used to transition the view navigator in its entirety, including the action bar. Specific transitions for the action bar are not performed. Because the tab bar is associated with the entire application, and not a view, view transitions do not affect it.

Note that even when set to false, there are cases where its not feasible to transition the action bar. For example, when the action bar does not exist in one of the two views, or if the action bar changes size.

The default value is false.



Implementation
    public function get transitionControlsWithContent():Boolean
    public function set transitionControlsWithContent(value:Boolean):void
Constructor Detail
    

ViewTransitionBase

()Constructor
public function ViewTransitionBase()

Language Version: ActionScript 3.0
Product Version: Flex 4.5
Runtime Versions: AIR 2.5

Constructor.

Method Detail

    canTransitionControlBarContent

()method
protected function canTransitionControlBarContent():Boolean

Language Version: ActionScript 3.0
Product Version: Flex 4.5
Runtime Versions: AIR 2.5

Determine if Flex can perform a transition on action bar or tab bar content independently of the views.

Flex cannot perform a transition on the control bars independently:

  • If the containing view navigator is a TabbedViewNavigator and its tab bar's visibility changes between views.
  • If the value of the view navigator's overlayControls property changes between views.
  • If the size or visibility of the action bar changes between views.

Returns
Booleanfalse if Flex determines controls bars between views are incompatible in some way.

    captureEndValues

()method 
public function captureEndValues():void

Language Version: ActionScript 3.0
Product Version: Flex 4.5
Runtime Versions: AIR 2.5

Called by the ViewNavigator during the preparation phase of a transition. It is invoked when the new view has been fully realized and validated and the action bar and tab bar content reflect the state of the new view. It is at this point that the transition can capture any values it requires from the pending view. In addition any bitmaps reflecting the state of the new view, tab bar, or action bar should be captured, if required for animation.

    captureStartValues

()method 
public function captureStartValues():void

Language Version: ActionScript 3.0
Product Version: Flex 4.5
Runtime Versions: AIR 2.5

Called by the ViewNavigator during the preparation phase of a transition. It is invoked when the new view has been fully realized and validated and the action bar and tab bar content reflect the state of the new view. The transition can use this method capture any values it requires from the pending view. Any bitmaps reflecting the state of the new view, tab bar, or action bar should be captured if required for animation.

    cleanUp

()method 
protected function cleanUp():void

Language Version: ActionScript 3.0
Product Version: Flex 4.5
Runtime Versions: AIR 2.5

Called after the transition completes. This method is responsible for releasing any references and temporary constructs used by the transition.

    createActionBarEffect

()method 
protected function createActionBarEffect():IEffect

Language Version: ActionScript 3.0
Product Version: Flex 4.5
Runtime Versions: AIR 2.5

Called by the default prepareForPlay() implementation, this method is responsible for creating the Spark effect played on the action bar when the transition starts. This method should be overridden by subclasses if a custom action bar effect is required. By default, this method returns a basic action bar effect.

Returns
IEffect — An IEffect instance serving as the action bar effect. This effect is played by the default play() method implementation.

    createConsolidatedEffect

()method 
protected function createConsolidatedEffect():IEffect

Language Version: ActionScript 3.0
Product Version: Flex 4.5
Runtime Versions: AIR 2.5

Called by the default prepareForPlay() implementation, this method is responsible for creating the Spark effect played to transition the entire navigator, inclusive of the control bar content, when necessary. This method should be overridden by subclasses. By default, this method returns null.

Returns
IEffect — An IEffect instance serving as the view transition. This effect is played by the default play() method implementation.

    createTabBarEffect

()method 
protected function createTabBarEffect():IEffect

Language Version: ActionScript 3.0
Product Version: Flex 4.5
Runtime Versions: AIR 2.5

Called by the default prepareForPlay() implementation, this method is responsible for creating the Spark effect played on the tab bar when the transition starts. This method should be overridden by subclasses. By default, this returns null.

Returns
IEffect — An IEffect instance serving as the tab bar transition. This effect is played by the default play() method implementation.

    createViewEffect

()method 
protected function createViewEffect():IEffect

Language Version: ActionScript 3.0
Product Version: Flex 4.5
Runtime Versions: AIR 2.5

Called by the default prepareForPlay() implementation, this method is responsible for creating the Spark effect played on the current and next view when the transition starts. This method should be overridden by subclasses. By default, this method returns null.

Returns
IEffect — An IEffect instance serving as the view transition. This effect is played by the default play() method implementation.

    getSnapshot

()method 
protected function getSnapshot(target:UIComponent, padding:int = 4, globalPosition:Point = null):BitmapImage

Language Version: ActionScript 3.0
Product Version: Flex 4.5
Runtime Versions: AIR 2.5

Used to render snap shots of screen elements in preparation for transitioning. The bitmap is returned in the form of a BitmapImage object.

The BitmapImage is in target's parent coordiantes space - it overlaps the target precisely if paranted to the same parent. When moving to a different parent, make sure to adjust the transformation of the BitmapImage to correctly account for the change in coordinate spaces. The updated value of the globalPosition parameter can be used for that.

Parameters

target:UIComponent — Display object to capture.
 
padding:int (default = 4) — Padding around the object to be included in the BitmapImage object.
 
globalPosition:Point (default = null) — When non-null, globalPosition will be updated with the origin of the BitmapImage in global coordiantes. When moving to a different coordinate space, this value can be used to adjust the snapshot's position so its global position on screen doesn't change.

Returns
BitmapImage — BitmapImage object representing the target.

    play

()method 
public function play():void

Language Version: ActionScript 3.0
Product Version: Flex 4.5
Runtime Versions: AIR 2.5

Called by the ViewNavigator when the transition should begin animating. At this time, the transition should dispatch a start event.

    prepareForPlay

()method 
public function prepareForPlay():void

Language Version: ActionScript 3.0
Product Version: Flex 4.5
Runtime Versions: AIR 2.5

Called by the ViewNavigator during the preparation phase of a transition. This method gives the transition the chance to create and configure the underlying IEffect instance, or to add any transient elements to the display list. Example transient elements include bitmap placeholders, temporary containers required during the transition, and other elements. If required, a final validation pass occurs prior to the invocation of the play() method.

If it is determined that a standard transition can be initiated, meaning one that transitions the control bars separately from the views, the default implementation of this method constructs a single Parallel effect which wraps the individual effect sequences for the view transition, the action bar transition, and the tab bar transition. This method uses the methods, createActionBarEffect(), createTabBarEffect(), and createViewEffect().

If transitionControlsWithContent is set to true, or if it is determined that the control bars cannot be transitioned independently, a single effect is created to transition the navigator in its entirety. In this case, only createConsolidatedEffect() is invoked.

    transitionComplete

()method 
protected function transitionComplete():void

Language Version: ActionScript 3.0
Product Version: Flex 4.5
Runtime Versions: AIR 2.5

Called by the transition to indicate that the transition has completed. This method dispatches the end event.

Event Detail
    

transitionEnd

Event
Event Object Type: mx.events.FlexEvent
property FlexEvent.type = mx.events.FlexEvent.TRANSITION_START

Language Version: ActionScript 3.0
Product Version: Flex 4.5
Runtime Versions: AIR 2.5

Dispatched when the transition completes.

The FlexEvent.TRANSITION_START constant defines the value of the type property of the event object for a transitionStart event.

This event will only be dispatched when there are one or more relevant listeners attached to the dispatching object.

The properties of the event object have the following values:

PropertyValue
bubblesfalse
cancelablefalse
currentTargetThe Object that defines the event listener that handles the event. For example, if you use myButton.addEventListener() to register an event listener, myButton is the value of the currentTarget.
targetThe Object that dispatched the event; it is not always the Object listening for the event. Use the currentTarget property to always access the Object listening for the event.
    

transitionStart

Event  
Event Object Type: mx.events.FlexEvent
property FlexEvent.type = mx.events.FlexEvent.TRANSITION_START

Language Version: ActionScript 3.0
Product Version: Flex 4.5
Runtime Versions: AIR 2.5

Dispatched when the transition starts.

The FlexEvent.TRANSITION_START constant defines the value of the type property of the event object for a transitionStart event.

This event will only be dispatched when there are one or more relevant listeners attached to the dispatching object.

The properties of the event object have the following values:

PropertyValue
bubblesfalse
cancelablefalse
currentTargetThe Object that defines the event listener that handles the event. For example, if you use myButton.addEventListener() to register an event listener, myButton is the value of the currentTarget.
targetThe Object that dispatched the event; it is not always the Object listening for the event. Use the currentTarget property to always access the Object listening for the event.