The goog.fx.css3.Transition Class

goog.fx.css3.Transition
> goog.fx.TransitionBase
> goog.events.EventTarget
> goog.Disposable

goog.fx.css3.Transition(element, duration, initialStyle, finalStyle, transitions)

A class to handle targeted CSS3 transition. This class handles common features required for targeted CSS3 transition. Browser that does not support CSS3 transition will still receive all the events fired by the transition object, but will not have any transition played. If the browser supports the final state as set in setFinalState method, the element will ends in the final state. Transitioning multiple properties with the same setting is possible by setting Css3Property's property to 'all'. Performing multiple transitions can be done via setting multiple initialStyle, finalStyle and transitions. Css3Property's delay can be used to delay one of the transition. Here is an example for a transition that expands on the width and then followed by the height:

   initialStyle: {width: 10px, height: 10px}
   finalStyle: {width: 100px, height: 100px}
   transitions: [
     {property: width, duration: 1, timing: 'ease-in', delay: 0},
     {property: height, duration: 1, timing: 'ease-in', delay: 1}
   ]
 
element {Element}
The element to be transitioned.
duration {number}
The duration of the transition in seconds. This should be the longest of all transitions.
initialStyle {Object}
Initial style properties of the element before animating. Set using {@code goog.style.setStyle}.
finalStyle {Object}
Final style properties of the element after animating. Set using {@code goog.style.setStyle}.
transitions {goog.style.transition.Css3Property| Array.<goog.style.transition.Css3Property>}
A single CSS3 transition property or an array of it.

.addEventListener(type, handler, opt_capture, opt_handlerScope)

Inherited from goog.events.EventTarget .

Adds an event listener to the event target. The same handler can only be added once per the type. Even if you add the same handler multiple times using the same type then it will only be called once when the event is dispatched. Supported for legacy but use goog.events.listen(src, type, handler) instead.

type {string}
The type of the event to listen for.
handler {Function|Object}
The function to handle the event. The handler can also be an object that implements the handleEvent method which takes the event object as argument.
opt_capture {boolean=}
In DOM-compliant browsers, this determines whether the listener is fired during the capture or bubble phase of the event.
opt_handlerScope {Object=}
Object in whose scope to call the listener.

.addOnDisposeCallback(callback, opt_scope)

Inherited from goog.Disposable .

Invokes a callback function when this object is disposed. Callbacks are invoked in the order in which they were added.

callback {!Function}
The callback function.
opt_scope {Object=}
An optional scope to call the callback in.

.creationStack {string}

Inherited from goog.Disposable .

If monitoring the goog.Disposable instances is enabled, stores the creation stack trace of the Disposable instance.

.dispatchEvent(e)

Inherited from goog.events.EventTarget .

Dispatches an event (or event like object) and calls all listeners listening for events of this type. The type of the event is decided by the type property on the event object. If any of the listeners returns false OR calls preventDefault then this function will return false. If one of the capture listeners calls stopPropagation, then the bubble listeners won't fire.

e {string|Object|goog.events.Event}
Event object.
returns {boolean}
If anyone called preventDefault on the event object (or if any of the handlers returns false this will also return false.

.dispose()

Inherited from goog.Disposable .

Disposes of the object. If the object hasn't already been disposed of, calls {@link #disposeInternal}. Classes that extend {@code goog.Disposable} should override {@link #disposeInternal} in order to delete references to COM objects, DOM nodes, and other disposable objects. Reentrant.

returns {void}
Nothing.

.disposeInternal()

.getParentEventTarget()

Inherited from goog.events.EventTarget .

Returns the parent of this event target to use for bubbling.

returns {goog.events.EventTarget}
The parent EventTarget or null if there is no parent.

.getStateInternal()

Inherited from goog.fx.TransitionBase .

Returns the current state of the animation.

returns {goog.fx.TransitionBase.State}
State of the animation.

.isDisposed()

Inherited from goog.Disposable .

returns {boolean}
Whether the object has been disposed of.

.isPaused()

Inherited from goog.fx.TransitionBase .

returns {boolean}
True iff the current state of the animation is paused.

.isPlaying()

Inherited from goog.fx.TransitionBase .

returns {boolean}
True iff the current state of the animation is playing.

.isStopped()

Inherited from goog.fx.TransitionBase .

returns {boolean}
True iff the current state of the animation is stopped.

.pause()

Pausing CSS3 Transitions in not supported.

.play(opt_restart)

Plays the animation.

opt_restart {boolean=}
Optional parameter to restart the animation.
returns {boolean}
True iff the animation was started.

.registerDisposable(disposable)

Inherited from goog.Disposable .

Associates a disposable object with this object so that they will be disposed together.

disposable {goog.disposable.IDisposable}
that will be disposed when this object is disposed.

.removeEventListener(type, handler, opt_capture, opt_handlerScope)

Inherited from goog.events.EventTarget .

Removes an event listener from the event target. The handler must be the same object as the one added. If the handler has not been added then nothing is done.

type {string}
The type of the event to listen for.
handler {Function|Object}
The function to handle the event. The handler can also be an object that implements the handleEvent method which takes the event object as argument.
opt_capture {boolean=}
In DOM-compliant browsers, this determines whether the listener is fired during the capture or bubble phase of the event.
opt_handlerScope {Object=}
Object in whose scope to call the listener.

.setParentEventTarget(parent)

Inherited from goog.events.EventTarget .

Sets the parent of this event target to use for bubbling.

parent {goog.events.EventTarget?}
Parent EventTarget (null if none).

.stop(opt_gotoEnd)

Stops the animation.

opt_gotoEnd {boolean=}
Optional boolean parameter to go the the end of the animation.