com.vaadin.polymer.hero.element.HeroAnimationElement 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.hero.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;

/**
 * <hero-animation> is a shared element animation that scales and transform an element such that it
appears to be shared between two pages. Use this in <neon-animated-pages>. The source page
should use this animation in an ‘exit’ animation and set the fromPage configuration property to
itself, and the destination page should use this animation in an entry animation and set the
toPage configuration property to itself. They should also define the hero elements in the
sharedElements property (not a configuration property, see
Polymer.NeonSharedElementAnimatableBehavior).
 * Configuration:
 * {
 *   name: 'hero-animation',
 *   id: <shared-element-id>,
 *   timing: <animation-timing>,
 *   toPage: <node>, /* define for the destination page * /
 *   fromPage: <node>, /* define for the source page * /
 * }
 * 
 */
@JsType
public interface HeroAnimationElement extends HTMLElement {

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


    /**
     * 
     *
     * JavaScript Info:
     * @method complete
     * @param {} config  
     * 
     */
    void complete(JavaScriptObject config);

    /**
     * 
     *
     * JavaScript Info:
     * @method configure
     * @param {} config  
     * 
     */
    void configure(JavaScriptObject config);

    /**
     * Finds shared elements based on config.
     *
     * JavaScript Info:
     * @method findSharedElements
     * @param {} config  
     * @behavior RippleAnimation
     */
    void findSharedElements(JavaScriptObject config);

    /**
     * Cached copy of shared elements.
     *
     * JavaScript Info:
     * @property sharedElements
     * @type Object
     * @behavior RippleAnimation
     */
    @JsProperty JavaScriptObject getSharedElements();
    /**
     * Cached copy of shared elements.
     *
     * JavaScript Info:
     * @property sharedElements
     * @type Object
     * @behavior RippleAnimation
     */
    @JsProperty void setSharedElements(JavaScriptObject value);
  
    /**
     * Defines the animation timing.
     *
     * JavaScript Info:
     * @property animationTiming
     * @type Object
     * @behavior TransformAnimation
     */
    @JsProperty JavaScriptObject getAnimationTiming();
    /**
     * Defines the animation timing.
     *
     * JavaScript Info:
     * @property animationTiming
     * @type Object
     * @behavior TransformAnimation
     */
    @JsProperty void setAnimationTiming(JavaScriptObject value);
  
    /**
     * Sets transform and transformOrigin properties along with the prefixed versions.
     *
     * JavaScript Info:
     * @method setPrefixedProperty
     * @param {} node  
     * @param {} property  
     * @param {} value  
     * @behavior TransformAnimation
     */
    void setPrefixedProperty(JavaScriptObject node, JavaScriptObject property, JavaScriptObject value);

    /**
     * Returns the animation timing by mixing in properties from config to the defaults defined
by the animation.
     *
     * JavaScript Info:
     * @method timingFromConfig
     * @param {} config  
     * @behavior TransformAnimation
     */
    void timingFromConfig(JavaScriptObject config);

    /**
     * 
     *
     * JavaScript Info:
     * @method registered
     * @behavior TransformAnimation
     */
    void registered();

}