SlideViewTransition

Package	spark.transitions
Class	public class SlideViewTransition
Inheritance	SlideViewTransition ViewTransitionBase EventDispatcher Object

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.

Related API Elements

SlideViewTransitionMode
ViewTransitionDirection

Public Properties

Hide Inherited Public Properties

Show Inherited Public Properties

	Property		Defined By
		constructor : Object A reference to the class object or constructor function for a given object instance.	Object
		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
		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
		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
		dispatchEvent(event:Event):Boolean Dispatches an event into the event flow.	EventDispatcher
		hasEventListener(type:String):Boolean Checks whether the EventDispatcher object has any listeners registered for a specific type of event.	EventDispatcher
		hasOwnProperty(name:String):Boolean Indicates whether an object has a specified property defined.	Object
		isPrototypeOf(theClass:Object):Boolean 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
		prepareForPlay():void Called by the ViewNavigator during the preparation phase of a transition.	ViewTransitionBase
		propertyIsEnumerable(name:String):Boolean Indicates whether the specified property exists and is enumerable.	Object
		removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void Removes a listener from the EventDispatcher object.	EventDispatcher
		setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void Sets the availability of a dynamic property for loop operations.	Object
		toLocaleString():String Returns the string representation of this object, formatted according to locale-specific conventions.	Object
		toString():String Returns the string representation of the specified object.	Object
		valueOf():Object Returns the primitive value of the specified object.	Object
		willTrigger(type:String):Boolean Checks whether an event listener is registered with this EventDispatcher object or any of its ancestors for the specified event type.	EventDispatcher

Protected Methods

Hide 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

Click for more information on events

Hide Inherited Events

Show Inherited Events

	Summary	Defined By
activate	[broadcast event] Dispatched when the Flash Player or AIR application gains operating system focus and becomes active.	EventDispatcher
deactivate	[broadcast event] Dispatched when the Flash Player or AIR application operating loses system focus and is becoming inactive.	EventDispatcher
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

()

Constructor

public function SlideViewTransition()

Language Version:

ActionScript 3.0

Product Version:

Flex 4.5

Runtime Versions:

AIR 2.5

Constructor.

SlideViewTransition - AS3 Flex

Classes x

direction

mode

SlideViewTransition

spark.transitions SlideViewTransition - AS3 Flex		Properties \| Properties \| Constructor \| Methods \| Global Constants \| Events \| Styles \| Skin Parts \| Skin States \| Effects \| Constants \| Global Functions \| Functions \| Interfaces \| Classes \| Examples