Package org.opencms.gwt.client.util

Class CmsSlideAnimation

java.lang.Object
com.google.gwt.animation.client.Animation
org.opencms.gwt.client.util.A_CmsAnimation
org.opencms.gwt.client.util.CmsSlideAnimation
public class CmsSlideAnimation extends A_CmsAnimation
Slide animation. Sliding the element into view or sliding it out.

Uses the in-line CSS display property, clear after completion if appropriate.

Since:
8.0.0

  • Field Summary

    Fields inherited from class org.opencms.gwt.client.util.A_CmsAnimation

    m_callback

  • Constructor Summary

    Constructors
    Constructor
    Description
    CmsSlideAnimation(com.google.gwt.dom.client.Element element, boolean show, com.google.gwt.user.client.Command callback)
    Constructor.

  • Method Summary

    Modifier and Type
    Method
    Description
    protected void
    onComplete()
     
    protected void
    onUpdate(double progress)
     
    void
    run(int duration, double startTime)
     
    static CmsSlideAnimation
    slideIn(com.google.gwt.dom.client.Element element, com.google.gwt.user.client.Command callback, int duration)
    Slides the given element into view executing the callback afterwards.
    static CmsSlideAnimation
    slideOut(com.google.gwt.dom.client.Element element, com.google.gwt.user.client.Command callback, int duration)
    Slides the given element out of view executing the callback afterwards.

    Methods inherited from class com.google.gwt.animation.client.Animation

    cancel, interpolate, isRunning, onCancel, onStart, run, run, run

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • CmsSlideAnimation

      public CmsSlideAnimation(com.google.gwt.dom.client.Element element, boolean show, com.google.gwt.user.client.Command callback)
      Constructor.

      Parameters:
      element - the element to animate
      show - true to show the element, false to hide it away
      callback - the callback executed after the animation is completed

  • Method Details

    • slideIn

      public static CmsSlideAnimation slideIn(com.google.gwt.dom.client.Element element, com.google.gwt.user.client.Command callback, int duration)
      Slides the given element into view executing the callback afterwards.

      Parameters:
      element - the element to slide in
      callback - the callback
      duration - the animation duration
      Returns:
      the running animation object

    • slideOut

      public static CmsSlideAnimation slideOut(com.google.gwt.dom.client.Element element, com.google.gwt.user.client.Command callback, int duration)
      Slides the given element out of view executing the callback afterwards.

      Parameters:
      element - the element to slide out
      callback - the callback
      duration - the animation duration
      Returns:
      the running animation object

    • run

      public void run(int duration, double startTime)
      Overrides:
      run in class com.google.gwt.animation.client.Animation
      See Also:
      • Animation.run(int, double)

    • onComplete

      protected void onComplete()
      Overrides:
      onComplete in class A_CmsAnimation
      See Also:
      • Animation.onComplete()

    • onUpdate

      protected void onUpdate(double progress)
      Specified by:
      onUpdate in class com.google.gwt.animation.client.Animation
      See Also:
      • Animation.onUpdate(double)