Apache Flex 4.16.1 API Reference | All Packages | All Classes | Index | Frames No Frames |
SlideViewTransition

Package | spark.transitions
Class | public class SlideViewTransition
Inheritance | SlideViewTransition ViewTransitionBase flash.events.EventDispatcher

Language Version : | ActionScript 3.0

Product Version : | Flex 4.5

Runtime Versions : | AIR 2.5

The SlideViewTransition class performs a simple slide transition for views. The existing view slides out as the new view slides in. The slide transition supports several modes (push, cover, and uncover) as well as an optional direction (up, down, left, or right).

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

See also

SlideViewTransitionMode
ViewTransitionDirection

Public Properties
Hide Inherited Public Properties
Show Inherited Public Properties

| Property | Defined By
--- | --- | ---
|  | direction : String Specifies the direction of slide transition. | SlideViewTransition
|  | 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
|  | mode : String Specifies the type of slide transition to perform. | SlideViewTransition
|  | 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
Hide Inherited Public Methods
Show Inherited Public Methods

| Method | Defined By
--- | --- | ---
|  | SlideViewTransition() Constructor. | SlideViewTransition
|  | captureEndValues():void Called by the ViewNavigator during the preparation phase of a transition. | ViewTransitionBase
|  | captureStartValues():void Called by the ViewNavigator during the preparation phase of a transition. | ViewTransitionBase
|  | play():void Called by the ViewNavigator when the transition should begin animating. | ViewTransitionBase
|  | prepareForPlay():void Called by the ViewNavigator during the preparation phase of a transition. | ViewTransitionBase

Protected Methods
Show Inherited Protected Methods
Show Inherited Protected Methods

| Method | Defined By
--- | --- | ---
|  | canTransitionControlBarContent():Boolean 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
|  | createActionBarEffect():IEffect 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
|  | createConsolidatedEffect():IEffect 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
|  | createTabBarEffect():IEffect 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
|  | createViewEffect():IEffect 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
|  | transitionComplete():void Called by the transition to indicate that the transition has completed. | ViewTransitionBase

Events
Hide Inherited Events
Show Inherited Events

| Event | Summary | Defined By
--- | --- | --- | ---
|  | transitionEnd | Dispatched when the transition completes. | ViewTransitionBase
|  | transitionStart | Dispatched when the transition starts. | ViewTransitionBase

Property Detail

direction | property

`direction:String`

Language Version : | ActionScript 3.0

Product Version : | Flex 4.5

Runtime Versions : | AIR 2.5

Specifies the direction of slide transition.

The default value is `ViewTransitionDirection.LEFT`.

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

mode | property |

`mode:String`

Language Version : | ActionScript 3.0

Product Version : | Flex 4.5

Runtime Versions : | AIR 2.5

Specifies the type of slide transition to perform.

The default value is `SlideViewTransitionMode.PUSH`.

Implementation
`public function get mode():String`
`public function set mode(value:String):void`
Constructor Detail

SlideViewTransition | () | Constructor

`public function SlideViewTransition()`

Language Version : | ActionScript 3.0

Product Version : | Flex 4.5

Runtime Versions : | AIR 2.5

Constructor.

Wed Nov 15 2017, 09:50 AM +01:00