Interface: TransitionAnimation

olympe.ui.std. TransitionAnimation

Interface for classes that represents an animation during a transition between 2 screens

Methods


<abstract> run(oldElement, newElement, oldElementId, newElementId, container [, onAnimationEnd])

Function called to run the animation on two elements WARNING : onAnimationEnd must be called for compatibility

Parameters:
Name Type Argument Description
oldElement olympe.ui.std.DockableElement | olympe.df.Proxy.<olympe.ui.std.DockableElement>

screen to hide

newElement olympe.ui.std.DockableElement | olympe.df.Proxy.<olympe.ui.std.DockableElement>

screen to display

oldElementId string
newElementId string
container olympe.ui.std.DockableElement
onAnimationEnd function <optional>

<abstract> runForward(element [, elementId] [, container] [, onAnimationEnd] [, synchronizedAnimatedValue])

Function running the animation 0->1 on a single element. WARNING : onAnimationEnd must be called for compatibility

Parameters:
Name Type Argument Description
element olympe.ui.std.DockableElement | olympe.df.Proxy.<olympe.ui.std.DockableElement>

UI element to animate

elementId string <optional>
container olympe.ui.std.DockableElement <optional>
onAnimationEnd function <optional>
synchronizedAnimatedValue olympe.df.PONumber <optional>

Use an already existing animated ONumber to synchronize animations

Returns:

animated ONumber

Type
olympe.df.PONumber

<abstract> runReverse(element [, elementId] [, container] [, onAnimationEnd] [, synchronizedAnimatedValue])

Function running the animation 1->0 on a single element. WARNING : onAnimationEnd must be called for compatibility

Parameters:
Name Type Argument Description
element olympe.ui.std.DockableElement | olympe.df.Proxy.<olympe.ui.std.DockableElement>

UI element to animate

elementId string <optional>
container olympe.ui.std.DockableElement <optional>
onAnimationEnd function <optional>
synchronizedAnimatedValue olympe.df.PONumber <optional>

Use an already existing animated ONumber to synchronize animations

Returns:

animated ONumber

Type
olympe.df.PONumber