gwt.material.design.addins.client.pathanimator

Class MaterialPathAnimator

java.lang.Object

gwt.material.design.addins.client.pathanimator.MaterialPathAnimator

All Implemented Interfaces:

gwt.material.design.client.base.HasDurationTransition

public class MaterialPathAnimator
extends Object
implements gwt.material.design.client.base.HasDurationTransition

Custom component that provides meaningfull transition between two elements to show visual continuity.

 

 // CAN BE CALLED AS A HELPER STATIC CONTEXT
 MaterialPathAnimator.animate(Element source, Element target, Functions.Func animateCallback);

 // INSTANTIATE THE PUSHPIN COMPONENT
 MaterialPathAnimator animator = new MaterialPathAnimator();
 animator.setSourceElement(btnSource1.getElement());
 animator.setTargetElement(panelTarget1.getElement());
 animator.animate();
 // Reverse Animate
 animator.reverseAnimate();
 
 

Author:

kevzlou7979

See Also:

Material Path Animator, CTAJs 0.3.2

Constructor Summary

Constructors

Constructor and Description
MaterialPathAnimator()
MaterialPathAnimator(com.google.gwt.dom.client.Element sourceElement, com.google.gwt.dom.client.Element targetElement)

Method Summary

Modifier and Type	Method and Description
void	animate() Animate the path animator
static void	animate(com.google.gwt.dom.client.Element source, com.google.gwt.dom.client.Element target) Helper method to apply the path animator.
static void	animate(com.google.gwt.dom.client.Element sourceElement, com.google.gwt.dom.client.Element targetElement, gwt.material.design.jquery.client.api.Functions.Func animateCallback) Helper method to apply the path animator with callback.
static void	animate(com.google.gwt.user.client.ui.Widget source, com.google.gwt.user.client.ui.Widget target) Helper method to apply the path animator.
static void	animate(com.google.gwt.user.client.ui.Widget source, com.google.gwt.user.client.ui.Widget target, gwt.material.design.jquery.client.api.Functions.Func callback) Helper method to apply the path animator with callback.
gwt.material.design.jquery.client.api.Functions.Func	getAnimateCallback() Get the callback method when the path animator is applied
int	getDuration()
int	getExtraTransitionDuration()
gwt.material.design.jquery.client.api.Functions.Func	getReverseCallback() Get the reverse callback method when the path animator is applied
com.google.gwt.dom.client.Element	getSourceElement() Get the source element
com.google.gwt.dom.client.Element	getTargetElement() Get the target element
int	getTargetShowDuration()
boolean	isRelativeToWindow()
void	reverseAnimate() Reverse the Animation
static void	reverseAnimate(com.google.gwt.dom.client.Element sourceElement, com.google.gwt.dom.client.Element targetElement) Helper method to reverse animate the source element to target element.
static void	reverseAnimate(com.google.gwt.dom.client.Element sourceElement, com.google.gwt.dom.client.Element targetElement, gwt.material.design.jquery.client.api.Functions.Func reverseCallback) Helper method to reverse animate the source element to target element with reverse callback
static void	reverseAnimate(com.google.gwt.user.client.ui.Widget source, com.google.gwt.user.client.ui.Widget target) Helper method to reverse animate the source element to target element.
static void	reverseAnimate(com.google.gwt.user.client.ui.Widget source, com.google.gwt.user.client.ui.Widget target, gwt.material.design.jquery.client.api.Functions.Func reverseCallback) Helper method to reverse animate the source element to target element with reverse callback.
void	setAnimateCallback(gwt.material.design.jquery.client.api.Functions.Func animateCallback) Set the callback method when the path animator is applied
void	setDuration(int duration)
void	setExtraTransitionDuration(int extraTransitionDuration) Extra duration (in milliseconds) of targetElement to provide visual continuity between the animation and the rendering of the targetElement.
void	setRelativeToWindow(boolean relativeToWindow) Set to true if your target element is fixed positioned in the window.
void	setReverseCallback(gwt.material.design.jquery.client.api.Functions.Func reverseCallback) Set the reverse callback method when the path animator is applied
void	setSourceElement(com.google.gwt.dom.client.Element sourceElement) Set the source element
void	setTargetElement(com.google.gwt.dom.client.Element targetElement) Set the target element
void	setTargetShowDuration(int targetShowDuration) Duration (in milliseconds) of targetElement to become visible, if hidden initially.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

MaterialPathAnimator

public MaterialPathAnimator()

MaterialPathAnimator

public MaterialPathAnimator(com.google.gwt.dom.client.Element sourceElement,
                            com.google.gwt.dom.client.Element targetElement)

Method Detail

animate

public void animate()

Animate the path animator

animate

public static void animate(com.google.gwt.dom.client.Element source,
                           com.google.gwt.dom.client.Element target)

Helper method to apply the path animator.

Parameters:

source - Source element to apply the Path Animator

target - Target element to apply the Path Animator

animate

public static void animate(com.google.gwt.user.client.ui.Widget source,
                           com.google.gwt.user.client.ui.Widget target)

Helper method to apply the path animator.

Parameters:

source - Source widget to apply the Path Animator

target - Target widget to apply the Path Animator

animate

public static void animate(com.google.gwt.user.client.ui.Widget source,
                           com.google.gwt.user.client.ui.Widget target,
                           gwt.material.design.jquery.client.api.Functions.Func callback)

Helper method to apply the path animator with callback.

Parameters:

source - Source widget to apply the Path Animator

target - Target widget to apply the Path Animator

callback - The callback method to be called when the path animator is applied

animate

public static void animate(com.google.gwt.dom.client.Element sourceElement,
                           com.google.gwt.dom.client.Element targetElement,
                           gwt.material.design.jquery.client.api.Functions.Func animateCallback)

Helper method to apply the path animator with callback.

Parameters:

sourceElement - Source widget to apply the Path Animator

targetElement - Target widget to apply the Path Animator

animateCallback - The callback method to be called when the path animator is applied

reverseAnimate

public void reverseAnimate()

Reverse the Animation

reverseAnimate

public static void reverseAnimate(com.google.gwt.dom.client.Element sourceElement,
                                  com.google.gwt.dom.client.Element targetElement)

Helper method to reverse animate the source element to target element.

Parameters:

sourceElement - Source element to apply the Path Animator

targetElement - Target element to apply the Path Animator

reverseAnimate

public static void reverseAnimate(com.google.gwt.user.client.ui.Widget source,
                                  com.google.gwt.user.client.ui.Widget target)

Helper method to reverse animate the source element to target element.

Parameters:

source - Source widget to apply the Path Animator

target - Target widget to apply the Path Animator

reverseAnimate

public static void reverseAnimate(com.google.gwt.user.client.ui.Widget source,
                                  com.google.gwt.user.client.ui.Widget target,
                                  gwt.material.design.jquery.client.api.Functions.Func reverseCallback)

Helper method to reverse animate the source element to target element with reverse callback.

Parameters:

source - Source widget to apply the Path Animator

target - Target widget to apply the Path Animator

reverseCallback - The reverse callback method to be called when the path animator is applied

reverseAnimate

public static void reverseAnimate(com.google.gwt.dom.client.Element sourceElement,
                                  com.google.gwt.dom.client.Element targetElement,
                                  gwt.material.design.jquery.client.api.Functions.Func reverseCallback)

Helper method to reverse animate the source element to target element with reverse callback

Parameters:

sourceElement - Source element to apply the Path Animator

targetElement - Target element to apply the Path Animator

reverseCallback - The reverse callback method to be called when the path animator is applied

getSourceElement

public com.google.gwt.dom.client.Element getSourceElement()

Get the source element

setSourceElement

public void setSourceElement(com.google.gwt.dom.client.Element sourceElement)

Set the source element

getTargetElement

public com.google.gwt.dom.client.Element getTargetElement()

Get the target element

setTargetElement

public void setTargetElement(com.google.gwt.dom.client.Element targetElement)

Set the target element

getAnimateCallback

public gwt.material.design.jquery.client.api.Functions.Func getAnimateCallback()

Get the callback method when the path animator is applied

setAnimateCallback

public void setAnimateCallback(gwt.material.design.jquery.client.api.Functions.Func animateCallback)

Set the callback method when the path animator is applied

getReverseCallback

public gwt.material.design.jquery.client.api.Functions.Func getReverseCallback()

Get the reverse callback method when the path animator is applied

setReverseCallback

public void setReverseCallback(gwt.material.design.jquery.client.api.Functions.Func reverseCallback)

Set the reverse callback method when the path animator is applied

setDuration

public void setDuration(int duration)

Specified by:

setDuration in interface gwt.material.design.client.base.HasDurationTransition

getDuration

public int getDuration()

Specified by:

getDuration in interface gwt.material.design.client.base.HasDurationTransition

setTargetShowDuration

public void setTargetShowDuration(int targetShowDuration)

Duration (in milliseconds) of targetElement to become visible, if hidden initially. The library will automatically try to figure this out from the element's computed styles. Default is 0 seconds.

getTargetShowDuration

public int getTargetShowDuration()

setExtraTransitionDuration

public void setExtraTransitionDuration(int extraTransitionDuration)

Extra duration (in milliseconds) of targetElement to provide visual continuity between the animation and the rendering of the targetElement. Default is 1 second

getExtraTransitionDuration

public int getExtraTransitionDuration()

isRelativeToWindow

public boolean isRelativeToWindow()

setRelativeToWindow

public void setRelativeToWindow(boolean relativeToWindow)

Set to true if your target element is fixed positioned in the window. Default is relative to document (works good with normal elements).