com.vaadin.polymer.paper.PaperRippleBehavior 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
The newest version!
/*
 * This code was generated with Vaadin Web Component GWT API Generator, 
 * from paper-behaviors project by The Polymer Authors
 * that is licensed with http://polymer.github.io/LICENSE.txt license.
 */
package com.vaadin.polymer.paper;

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


/**
 * Polymer.PaperRippleBehavior dynamically implements a ripple
when the element has focus via pointer or keyboard.
 * NOTE: This behavior is intended to be used in conjunction with and after
Polymer.IronButtonState and Polymer.IronControlState.
 */
@JsType(isNative=true)
public interface PaperRippleBehavior {

    @JsOverlay public static final String NAME = "Polymer.PaperRippleBehavior";
    @JsOverlay public static final String SRC = "paper-behaviors/paper-checked-element-behavior.html";


    /**
     * If true, the element will not produce a ripple effect when interacted
with via the pointer.
     *
     * JavaScript Info:
     * @property noink
     * @type Boolean
     * 
     */
    @JsProperty boolean getNoink();
    /**
     * If true, the element will not produce a ripple effect when interacted
with via the pointer.
     *
     * JavaScript Info:
     * @property noink
     * @type Boolean
     * 
     */
    @JsProperty void setNoink(boolean value);


    /**
     * Returns the <paper-ripple> element used by this element to create
ripple effects. The element’s ripple is created on demand, when
necessary, and calling this method will force the
ripple to be created.
     *
     * JavaScript Info:
     * @method getRipple
     * 
     * 
     */
    void getRipple();

    /**
     * Returns true if this element currently contains a ripple effect.
     *
     * JavaScript Info:
     * @method hasRipple
     * 
     * @return {boolean}
     */
    boolean hasRipple();

    /**
     * Ensures this element contains a ripple effect. For startup efficiency
the ripple effect is dynamically on demand when needed.
     *
     * JavaScript Info:
     * @method ensureRipple
     * @param {!Event=} optTriggeringEvent  
     * 
     * 
     */
    void ensureRipple(JavaScriptObject optTriggeringEvent);

}