com.vaadin.polymer.neon.element.NeonAnimatableElement Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of vaadin-gwt-polymer-elements Show documentation
vaadin-gwt-polymer-elements
There is a newer version: 1.9.3.1
Show newest version
/*
 * This code was generated with Vaadin Web Component GWT API Generator, 
 * from neon-animation project by The Polymer Authors
 * that is licensed with http://polymer.github.io/LICENSE.txt license.
 */
package com.vaadin.polymer.neon.element;

import com.vaadin.polymer.elemental.*;
import com.google.gwt.core.client.JavaScriptObject;
import com.google.gwt.core.client.JsArray;
import com.google.gwt.core.client.js.JsProperty;
import com.google.gwt.core.client.js.JsType;

/**
 * <neon-animatable> is a simple container element implementing Polymer.NeonAnimatableBehavior. This is a convenience element for use with <neon-animated-pages>.
 * <neon-animated-pages selected="0"
 *                      entry-animation="slide-from-right-animation"
 *                      exit-animation="slide-left-animation">
 *   <neon-animatable>1</neon-animatable>
 *   <neon-animatable>2</neon-animatable>
 * </neon-animated-pages>
 * 
 */
@JsType
public interface NeonAnimatableElement extends HTMLElement {

    public static final String TAG = "neon-animatable";
    public static final String SRC = "neon-animation/neon-animation.html";


    /**
     * Animation configuration. See README for more info.
     *
     * JavaScript Info:
     * @property animationConfig
     * @type Object
     * @behavior NeonAnimatable
     */
    @JsProperty JavaScriptObject getAnimationConfig();
    /**
     * Animation configuration. See README for more info.
     *
     * JavaScript Info:
     * @property animationConfig
     * @type Object
     * @behavior NeonAnimatable
     */
    @JsProperty void setAnimationConfig(JavaScriptObject value);
  
    /**
     * Convenience property for setting an ‘entry’ animation. Do not set animationConfig.entry
manually if using this. The animated node is set to this if using this property.
     *
     * JavaScript Info:
     * @property entryAnimation
     * @type String
     * @behavior NeonAnimatable
     */
    @JsProperty String getEntryAnimation();
    /**
     * Convenience property for setting an ‘entry’ animation. Do not set animationConfig.entry
manually if using this. The animated node is set to this if using this property.
     *
     * JavaScript Info:
     * @property entryAnimation
     * @type String
     * @behavior NeonAnimatable
     */
    @JsProperty void setEntryAnimation(String value);
  
    /**
     * Convenience property for setting an ‘exit’ animation. Do not set animationConfig.exit
manually if using this. The animated node is set to this if using this property.
     *
     * JavaScript Info:
     * @property exitAnimation
     * @type String
     * @behavior NeonAnimatable
     */
    @JsProperty String getExitAnimation();
    /**
     * Convenience property for setting an ‘exit’ animation. Do not set animationConfig.exit
manually if using this. The animated node is set to this if using this property.
     *
     * JavaScript Info:
     * @property exitAnimation
     * @type String
     * @behavior NeonAnimatable
     */
    @JsProperty void setExitAnimation(String value);
  
    /**
     * An element implementing Polymer.NeonAnimationRunnerBehavior calls this method to configure
an animation with an optional type. Elements implementing Polymer.NeonAnimatableBehavior
should define the property animationConfig, which is either a configuration object
or a map of animation type to array of configuration objects.
     *
     * JavaScript Info:
     * @method getAnimationConfig
     * @param {} type  
     * @behavior NeonAnimatable
     */
    void getAnimationConfig(JavaScriptObject type);

}