ViewTransitionBase

Paket	spark.transitions
Klass	public class ViewTransitionBase
Arv	ViewTransitionBase EventDispatcher Object
Underklasser	CrossFadeViewTransition, FlipViewTransition, SlideViewTransition, ZoomViewTransition

Språkversion:

ActionScript 3.0

Produktversion:

Flex 4.5

Körningsmiljöversioner:

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.

Publika egenskaper

Dölj ärvda publika egenskaper

Visa ärvda publika egenskaper

	Egenskap		Definieras med
		constructor : Object En referens till klassobjektet eller konstruktorfunktionen för en given objektinstans.	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

Publika metoder

Dölj ärvda publika metoder

Visa ärvda publika metoder

	Metod		Definieras med
		ViewTransitionBase() Constructor.	ViewTransitionBase
		addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void Registrerar ett händelseavlyssnarobjekt för ett EventDispatcher-objekt så att avlyssnaren får meddelanden om händelser.	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 Skickar en händelse till händelseflödet.	EventDispatcher
		hasEventListener(type:String):Boolean Kontrollerar om EventDispatcher-objektet har några avlyssnare registrerade för en viss typ av händelse.	EventDispatcher
		hasOwnProperty(name:String):Boolean Anger om det finns en egenskap angiven för ett objekt.	Object
		isPrototypeOf(theClass:Object):Boolean Anger om en instans av klassen Object finns i prototypkedjan för objektet som anges som 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 Anger om den angivna egenskapen finns och är uppräkningsbar.	Object
		removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void Tar bort en avlyssnare från EventDispatcher-objektet.	EventDispatcher
		setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void Anger tillgänglighet för en dynamisk egenskap för slingåtgärder.	Object
		toLocaleString():String Returnerar det här objektets strängrepresentation, formaterad i enlighet med språkspecifika konventioner.	Object
		toString():String Returnerar det angivna objektets strängbeteckning.	Object
		valueOf():Object Returnerar det angivna objektets primitiva värde.	Object
		willTrigger(type:String):Boolean Kontrollerar om en händelseavlyssnare är registrerad för det här EventDispatcher-objektet eller något av dess överordnade objekt för den angivna händelsetypen.	EventDispatcher

Skyddade metoder

	Metod		Definieras med
		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

Händelser

Klicka för mer information om händelser

Dölj ärvda händelser

Visa ärvda händelser

	Sammanfattning	Definieras med
activate	[utsändningshändelse] Skickas när Flash Player eller AIR får operativsystemfokus och blir aktivt.	EventDispatcher
deactivate	[utsändningshändelse] Skickas när Flash Player eller AIR förlorar operativsystemfokus och blir inaktivt.	EventDispatcher
transitionEnd	Dispatched when the transition completes.	ViewTransitionBase
transitionStart	Dispatched when the transition starts.	ViewTransitionBase

Egenskapsdetaljer

duration

egenskap

duration:Number

Språkversion:

ActionScript 3.0

Produktversion:

Flex 4.5

Körningsmiljöversioner:

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.

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

easer

egenskap

easer:IEaser

Språkversion:

ActionScript 3.0

Produktversion:

Flex 4.5

Körningsmiljöversioner:

AIR 2.5

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

Standardvärdet är Sine(.5);.

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

Relaterade API-element

spark.effects.easing

endView

egenskap

endView:View

Språkversion:

ActionScript 3.0

Produktversion:

Flex 4.5

Körningsmiljöversioner:

AIR 2.5

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

Standardvärdet är null.

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

navigator

egenskap

navigator:ViewNavigator

Språkversion:

ActionScript 3.0

Produktversion:

Flex 4.5

Körningsmiljöversioner:

AIR 2.5

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

Standardvärdet är null.

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

startView

egenskap

startView:View

Språkversion:

ActionScript 3.0

Produktversion:

Flex 4.5

Körningsmiljöversioner:

AIR 2.5

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

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

suspendBackgroundProcessing

egenskap

suspendBackgroundProcessing:Boolean

Språkversion:

ActionScript 3.0

Produktversion:

Flex 4.5

Körningsmiljöversioner:

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.

Standardvärdet är false.

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

Relaterade API-element

mx.core.UIComponent.suspendBackgroundProcessing()
mx.core.UIComponent.resumeBackgroundProcessing()

transitionControlsWithContent

egenskap

transitionControlsWithContent:Boolean

Språkversion:

ActionScript 3.0

Produktversion:

Flex 4.5

Körningsmiljöversioner:

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.

Standardvärdet är false.

Implementering
public function get transitionControlsWithContent():Boolean
public function set transitionControlsWithContent(value:Boolean):void

Konstruktordetaljer

()

Konstruktor

public function ViewTransitionBase()

Språkversion:

ActionScript 3.0

Produktversion:

Flex 4.5

Körningsmiljöversioner:

AIR 2.5

Constructor.

Metoddetaljer

canTransitionControlBarContent

()

metod

protected function canTransitionControlBarContent():Boolean

Språkversion:

ActionScript 3.0

Produktversion:

Flex 4.5

Körningsmiljöversioner:

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.

Returnerar

Boolean — false if Flex determines controls bars between views are incompatible in some way.

captureEndValues

()

metod

public function captureEndValues():void

Språkversion:

ActionScript 3.0

Produktversion:

Flex 4.5

Körningsmiljöversioner:

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

()

metod

public function captureStartValues():void

Språkversion:

ActionScript 3.0

Produktversion:

Flex 4.5

Körningsmiljöversioner:

AIR 2.5

()

metod

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

Språkversion:

ActionScript 3.0

Produktversion:

Flex 4.5

Körningsmiljöversioner:

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.

Parametrar

	`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.

Returnerar

BitmapImage — BitmapImage object representing the target.

play

()

metod

public function play():void

Språkversion:

ActionScript 3.0

Produktversion:

Flex 4.5

Körningsmiljöversioner:

AIR 2.5

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

prepareForPlay

()

metod

public function prepareForPlay():void

Språkversion:

ActionScript 3.0

Produktversion:

Flex 4.5

Körningsmiljöversioner:

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

()

metod

protected function transitionComplete():void

Språkversion:

ActionScript 3.0

Produktversion:

Flex 4.5

Körningsmiljöversioner:

AIR 2.5

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

Händelsedetaljer

transitionEnd

Händelse

Typ av händelseobjekt: mx.events.FlexEvent
egenskap FlexEvent.type = mx.events.FlexEvent.TRANSITION_START

Språkversion:

ActionScript 3.0

Produktversion:

Flex 4.5

Körningsmiljöversioner:

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:

Property	Value
`bubbles`	false
`cancelable`	false
`currentTarget`	The 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`.
`target`	The 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

Händelse

Typ av händelseobjekt: mx.events.FlexEvent
egenskap FlexEvent.type = mx.events.FlexEvent.TRANSITION_START

Språkversion:

ActionScript 3.0

Produktversion:

Flex 4.5

Körningsmiljöversioner:

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:

Property	Value
`bubbles`	false
`cancelable`	false
`currentTarget`	The 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`.
`target`	The 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.

Juridiska meddelanden | Onlinesekretesspolicy

ViewTransitionBase - AS3 Flex

Klasser x

duration

easer

endView

navigator

startView

suspendBackgroundProcessing

transitionControlsWithContent