fx.css3.Transition Extends goog.fx.TransitionBase
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}
  ]

Inheritance

Constructor

goog.fx.css3.Transition(elementdurationinitialStylefinalStyletransitions)

Parameters

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 goog.style.setStyle.
finalStyle : Object
Final style properties of the element after animating. Set using goog.style.setStyle.
transitions : goog.style.transition.Css3Property |  Array.<goog.style.transition.Css3Property>
A single CSS3 transition property or an array of it.

Instance Methods

Public Protected Private
disposeInternal()
No description.
code »
pause()
Pausing CSS3 Transitions in not supported.
code »
play()
No description.
code »
play_()
Helper method for play method. This needs to be executed on a timer.
code »
stop()
No description.
code »
stop_(stopped)
Helper method for stop method.
Arguments:
stopped : boolean
If the transition was stopped.
code »
dispatchAnimationEvent(type)
Dispatches an event object for the current animation.
Arguments:
type : string
Event type that will be dispatched.
code »
getStateInternal() goog.fx.TransitionBase.State
Returns the current state of the animation.
Returns: goog.fx.TransitionBase.State  State of the animation.
code »
isPaused() boolean
No description.
Returns: boolean  True iff the current state of the animation is paused.
code »
isPlaying() boolean
No description.
Returns: boolean  True iff the current state of the animation is playing.
code »
isStopped() boolean
No description.
Returns: boolean  True iff the current state of the animation is stopped.
code »
onBegin()
Dispatches the BEGIN event. Sub classes should override this instead of listening to the event, and call this instead of dispatching the event.
code »
onEnd()
Dispatches the END event. Sub classes should override this instead of listening to the event, and call this instead of dispatching the event.
code »
onFinish()
Dispatches the FINISH event. Sub classes should override this instead of listening to the event, and call this instead of dispatching the event.
code »
onPause()
Dispatches the PAUSE event. Sub classes should override this instead of listening to the event, and call this instead of dispatching the event.
code »
onPlay()
Dispatches the PLAY event. Sub classes should override this instead of listening to the event, and call this instead of dispatching the event.
code »
onResume()
Dispatches the RESUME event. Sub classes should override this instead of listening to the event, and call this instead of dispatching the event.
code »
onStop()
Dispatches the STOP event. Sub classes should override this instead of listening to the event, and call this instead of dispatching the event.
code »
play(opt_restart) boolean
Plays the animation.
Arguments:
opt_restart : boolean=
Optional parameter to restart the animation.
Returns: boolean  True iff the animation was started.
code »
setStatePaused()
Sets the current state of the animation to paused.
code »
setStatePlaying()
Sets the current state of the animation to playing.
code »
setStateStopped()
Sets the current state of the animation to stopped.
code »
stop(opt_gotoEnd)
Stops the animation.
Arguments:
opt_gotoEnd : boolean=
Optional boolean parameter to go the the end of the animation.
code »
addEventListener(typeopt_captureopt_handlerScope)
Use #listen instead, when possible. Otherwise, use goog.events.listen if you are passing Object (instead of Function) as handler. 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.
Arguments:
type : string
The type of the event to listen for.
: ?function():? | ?{handleEvent:function():?
No description.
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.
code »
assertInitialized_()
Asserts that the event target instance is initialized properly.
code »
dispatchEvent()
No description.
code »
disposeInternal()
Removes listeners from this object. Classes that extend EventTarget may need to override this method in order to remove references to DOM Elements and additional listeners.
code »
fireListeners()
No description.
code »
getListener()
No description.
code »
getListeners()
No description.
code »
getParentEventTarget() 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.
code »
hasListener()
No description.
code »
listen()
No description.
code »
listenOnce()
No description.
code »
removeAllListeners()
No description.
code »
removeEventListener(typeopt_captureopt_handlerScope)
Use #unlisten instead, when possible. Otherwise, use goog.events.unlisten if you are passing Object (instead of Function) as handler. 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.
Arguments:
type : string
The type of the event to listen for.
: ?function():? | ?{handleEvent:function():?
No description.
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.
code »
setParentEventTarget(parent)
Sets the parent of this event target to use for capture/bubble mechanism.
Arguments:
parent : goog.events.EventTarget
Parent listenable (null if none).
code »
setTargetForTesting(target)
Sets the target to be used for event.target when firing event. Mainly used for testing. For example, see goog.testing.events.mixinListenable.
Arguments:
target : !Object
The target.
code »
unlisten()
No description.
code »
unlistenByKey()
No description.
code »
addOnDisposeCallback(callbackopt_scope)
Invokes a callback function when this object is disposed. Callbacks are invoked in the order in which they were added.
Arguments:
callback : function(this:T):?
The callback function.
opt_scope : T=
An optional scope to call the callback in.
code »
dispose() void
Disposes of the object. If the object hasn't already been disposed of, calls #disposeInternal. Classes that extend goog.Disposable should override #disposeInternal in order to delete references to COM objects, DOM nodes, and other disposable objects. Reentrant.
Returns: void  Nothing.
code »
disposeInternal()
Deletes or nulls out any references to COM objects, DOM nodes, or other disposable objects. Classes that extend goog.Disposable should override this method. Not reentrant. To avoid calling it twice, it must only be called from the subclass' disposeInternal method. Everywhere else the public dispose method must be used. For example:
  mypackage.MyClass = function() {
    mypackage.MyClass.base(this, 'constructor');
    // Constructor logic specific to MyClass.
    ...
  };
  goog.inherits(mypackage.MyClass, goog.Disposable);

  mypackage.MyClass.prototype.disposeInternal = function() {
    // Dispose logic specific to MyClass.
    ...
    // Call superclass's disposeInternal at the end of the subclass's, like
    // in C++, to avoid hard-to-catch issues.
    mypackage.MyClass.base(this, 'disposeInternal');
  };
code »
getDisposed() boolean
Use #isDisposed instead. No description.
Returns: boolean  Whether the object has been disposed of.
code »
isDisposed() boolean
No description.
Returns: boolean  Whether the object has been disposed of.
code »
registerDisposable(disposable)
Associates a disposable object with this object so that they will be disposed together.
Arguments:
disposable : goog.disposable.IDisposable
that will be disposed when this object is disposed.
code »

Instance Properties

constructor :
No description.
Code »
duration_ :
No description.
Code »
element_ :
No description.
Code »
finalStyle_ :
No description.
Code »
initialStyle_ :
No description.
Code »
timerId_ :
Timer id to be used to cancel animation part-way.
Code »
transitions_ :
No description.
Code »
constructor :
No description.
Code »
endTime :
Timestamp for when the animation finished or was stopped.
Code »
pause :
Pauses the animation.
Code »
startTime :
Timestamp for when the animation was started.
Code »
state_ :
The internal state of the animation.
Code »
actualEventTarget_ : goog.events.EventTarget
The object to use for event.target. Useful when mixing in an EventTarget to another object.
Code »
constructor :
No description.
Code »
eventTargetListeners_ : goog.events.ListenerMap
Maps of event type to an array of listeners.
Code »
parentEventTarget_ : goog.events.EventTarget
Parent event target, used during event bubbling. TODO(user): Change this to goog.events.Listenable. This currently breaks people who expect getParentEventTarget to return goog.events.EventTarget.
Code »
creationStack :
If monitoring the goog.Disposable instances is enabled, stores the creation stack trace of the Disposable instance.
Code »
disposed_ :
Whether the object has been disposed of.
Code »
onDisposeCallbacks_ :
Callbacks to invoke when this object is disposed.
Code »

Static Properties

goog.fx.css3.Transition.superClass_ :
No description.
Code »

Package fx.css3

Package Reference