org.opencms.gwt.client.util.CmsFadeAnimation Maven / Gradle / Ivy
Show all versions of opencms-gwt Show documentation
/*
* This library is part of OpenCms -
* the Open Source Content Management System
*
* Copyright (c) Alkacon Software GmbH & Co. KG (http://www.alkacon.com)
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 2.1 of the License, or (at your option) any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* For further information about Alkacon Software, please see the
* company website: http://www.alkacon.com
*
* For further information about OpenCms, please see the
* project website: http://www.opencms.org
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
*/
package org.opencms.gwt.client.util;
import com.google.gwt.dom.client.Element;
import com.google.gwt.user.client.Command;
/**
* Fade animation. Fading the element into view or fading it out.
*
* @since 8.0.0
*/
public class CmsFadeAnimation extends A_CmsAnimation {
/** The element to animate. */
private Element m_element;
/** Show or hide flag. */
private boolean m_show;
/**
* Constructor.
*
* @param element the element to animate
* @param show true to show the element, false to hide it away
* @param callback the callback executed after the animation is completed
*/
public CmsFadeAnimation(Element element, boolean show, Command callback) {
super(callback);
m_show = show;
m_element = element;
}
/**
* Fades the given element into view executing the callback afterwards.
*
* @param element the element to fade in
* @param callback the callback
* @param duration the animation duration
*
* @return the running animation object
*/
public static CmsFadeAnimation fadeIn(Element element, Command callback, int duration) {
CmsFadeAnimation animation = new CmsFadeAnimation(element, true, callback);
animation.run(duration);
return animation;
}
/**
* Fades the given element out of view executing the callback afterwards.
*
* @param element the element to fade out
* @param callback the callback
* @param duration the animation duration
*
* @return the running animation object
*/
public static CmsFadeAnimation fadeOut(Element element, Command callback, int duration) {
CmsFadeAnimation animation = new CmsFadeAnimation(element, false, callback);
animation.run(duration);
return animation;
}
/**
* @see com.google.gwt.animation.client.Animation#onComplete()
*/
@Override
protected void onComplete() {
super.onComplete();
// using own implementation as GWT won't do it properly on IE7-8
CmsDomUtil.clearOpacity(m_element);
}
/**
* @see com.google.gwt.animation.client.Animation#onUpdate(double)
*/
@Override
protected void onUpdate(double progress) {
if (m_show) {
m_element.getStyle().setOpacity(progress);
} else {
m_element.getStyle().setOpacity(1 - progress);
}
}
}