com.vaadin.polymer.paper.widget.PaperRipple Maven / Gradle / Ivy
/*
* This code was generated with Vaadin Web Component GWT API Generator,
* from paper-ripple project by The Polymer Authors
* that is licensed with http://polymer.github.io/LICENSE.txt license.
*/
package com.vaadin.polymer.paper.widget;
import com.vaadin.polymer.paper.element.*;
import com.vaadin.polymer.PolymerWidget;
import com.vaadin.polymer.elemental.*;
import com.google.gwt.core.client.JsArray;
import com.google.gwt.event.shared.HandlerRegistration;
import com.google.gwt.core.client.JavaScriptObject;
/**
* paper-ripple provides a visual effect that other paper elements can
use to simulate a rippling effect emanating from the point of contact. The
effect can be visualized as a concentric circle with motion.
* Example:
* <paper-ripple></paper-ripple>
*
*
*
paper-ripple listens to “mousedown” and “mouseup” events so it would display ripple
effect when touches on it. You can also defeat the default behavior and
manually route the down and up actions to the ripple element. Note that it is
important if you call downAction() you will have to make sure to call
upAction() so that paper-ripple would end the animation loop.
* Example:
* <paper-ripple id="ripple" style="pointer-events: none;"></paper-ripple>
* ...
* downAction: function(e) {
* this.$.ripple.downAction({x: e.x, y: e.y});
* },
* upAction: function(e) {
* this.$.ripple.upAction();
* }
*
*
*
Styling ripple effect:
* Use CSS color property to style the ripple:
* paper-ripple {
* color: #4285f4;
* }
*
*
*
Note that CSS color property is inherited so it is not required to set it on
the paper-ripple element directly.
* By default, the ripple is centered on the point of contact. Apply the recenters
attribute to have the ripple grow toward the center of its container.
* <paper-ripple recenters></paper-ripple>
*
*
*
You can also center the ripple inside its container from the start.
* <paper-ripple center></paper-ripple>
*
*
*
Apply circle class to make the rippling effect within a circle.
* <paper-ripple class="circle"></paper-ripple>
*
*
*
*/
public class PaperRipple extends PolymerWidget {
/**
* Default Constructor.
*/
public PaperRipple() {
this("");
}
/**
* Constructor used by UIBinder to create widgets with content.
*/
public PaperRipple(String html) {
super(PaperRippleElement.TAG, PaperRippleElement.SRC, html);
}
/**
* Gets a handle to the Polymer object's underlying DOM element.
*/
public PaperRippleElement getPolymerElement() {
return (PaperRippleElement) getElement();
}
/**
*
*
* JavaScript Info:
* @method addRipple
*
*/
public void addRipple() {
getPolymerElement().addRipple();
}
/**
*
*
* JavaScript Info:
* @method animate
*
*/
public void animate() {
getPolymerElement().animate();
}
/**
* True when there are visible ripples animating within the
element.
*
* JavaScript Info:
* @property animating
* @type Boolean
*
*/
public boolean getAnimating(){
return getPolymerElement().getAnimating();
}
/**
* True when there are visible ripples animating within the
element.
*
* JavaScript Info:
* @property animating
* @type Boolean
*
*/
public void setAnimating(boolean value) {
getPolymerElement().setAnimating(value);
}
/**
* If true, ripples will center inside its container
*
* JavaScript Info:
* @property center
* @type Boolean
*
*/
public boolean getCenter(){
return getPolymerElement().getCenter();
}
/**
* If true, ripples will center inside its container
*
* JavaScript Info:
* @property center
* @type Boolean
*
*/
public void setCenter(boolean value) {
getPolymerElement().setCenter(value);
}
/**
*
*
* JavaScript Info:
* @method downAction
* @param {Event=} event
*
*/
public void downAction(JavaScriptObject event) {
getPolymerElement().downAction(event);
}
/**
* If true, the ripple will remain in the “down” state until holdDown
is set to false again.
*
* JavaScript Info:
* @property holdDown
* @type Boolean
*
*/
public boolean getHoldDown(){
return getPolymerElement().getHoldDown();
}
/**
* If true, the ripple will remain in the “down” state until holdDown
is set to false again.
*
* JavaScript Info:
* @property holdDown
* @type Boolean
*
*/
public void setHoldDown(boolean value) {
getPolymerElement().setHoldDown(value);
}
/**
* The initial opacity set on the wave.
*
* JavaScript Info:
* @property initialOpacity
* @type Number
*
*/
public double getInitialOpacity(){
return getPolymerElement().getInitialOpacity();
}
/**
* The initial opacity set on the wave.
*
* JavaScript Info:
* @property initialOpacity
* @type Number
*
*/
public void setInitialOpacity(double value) {
getPolymerElement().setInitialOpacity(value);
}
/**
* The initial opacity set on the wave.
*
* JavaScript Info:
* @attribute initial-opacity
*
*/
public void setInitialOpacity(String value) {
getPolymerElement().setAttribute("initial-opacity", value);
}
/**
*
*
* JavaScript Info:
* @property keyBindings
* @type Object
*
*/
public JavaScriptObject getKeyBindings(){
return getPolymerElement().getKeyBindings();
}
/**
*
*
* JavaScript Info:
* @property keyBindings
* @type Object
*
*/
public void setKeyBindings(JavaScriptObject value) {
getPolymerElement().setKeyBindings(value);
}
/**
*
*
* JavaScript Info:
* @method onAnimationComplete
*
*/
public void onAnimationComplete() {
getPolymerElement().onAnimationComplete();
}
/**
* How fast (opacity per second) the wave fades out.
*
* JavaScript Info:
* @property opacityDecayVelocity
* @type Number
*
*/
public double getOpacityDecayVelocity(){
return getPolymerElement().getOpacityDecayVelocity();
}
/**
* How fast (opacity per second) the wave fades out.
*
* JavaScript Info:
* @property opacityDecayVelocity
* @type Number
*
*/
public void setOpacityDecayVelocity(double value) {
getPolymerElement().setOpacityDecayVelocity(value);
}
/**
* How fast (opacity per second) the wave fades out.
*
* JavaScript Info:
* @attribute opacity-decay-velocity
*
*/
public void setOpacityDecayVelocity(String value) {
getPolymerElement().setAttribute("opacity-decay-velocity", value);
}
/**
* If true, ripples will exhibit a gravitational pull towards
the center of their container as they fade away.
*
* JavaScript Info:
* @property recenters
* @type Boolean
*
*/
public boolean getRecenters(){
return getPolymerElement().getRecenters();
}
/**
* If true, ripples will exhibit a gravitational pull towards
the center of their container as they fade away.
*
* JavaScript Info:
* @property recenters
* @type Boolean
*
*/
public void setRecenters(boolean value) {
getPolymerElement().setRecenters(value);
}
/**
*
*
* JavaScript Info:
* @method removeRipple
* @param {} ripple
*
*/
public void removeRipple(JavaScriptObject ripple) {
getPolymerElement().removeRipple(ripple);
}
/**
* A list of the visual ripples.
*
* JavaScript Info:
* @property ripples
* @type Array
*
*/
public JsArray getRipples(){
return getPolymerElement().getRipples();
}
/**
* A list of the visual ripples.
*
* JavaScript Info:
* @property ripples
* @type Array
*
*/
public void setRipples(JsArray value) {
getPolymerElement().setRipples(value);
}
/**
* A list of the visual ripples.
*
* JavaScript Info:
* @attribute ripples
*
*/
public void setRipples(String value) {
getPolymerElement().setAttribute("ripples", value);
}
/**
*
*
* JavaScript Info:
* @method shouldKeepAnimating
*
*/
public void shouldKeepAnimating() {
getPolymerElement().shouldKeepAnimating();
}
/**
*
*
* JavaScript Info:
* @method simulatedRipple
*
*/
public void simulatedRipple() {
getPolymerElement().simulatedRipple();
}
/**
*
*
* JavaScript Info:
* @method target
*
*/
public void target() {
getPolymerElement().target();
}
/**
*
*
* JavaScript Info:
* @method upAction
* @param {Event=} event
*
*/
public void upAction(JavaScriptObject event) {
getPolymerElement().upAction(event);
}
/**
*
*
* JavaScript Info:
* @method attached
*
*/
public void attached() {
getPolymerElement().attached();
}
/**
* Can be used to imperatively add a key binding to the implementing
element. This is the imperative equivalent of declaring a keybinding
in the keyBindings prototype property.
*
* JavaScript Info:
* @method addOwnKeyBinding
* @param {} eventString
* @param {} handlerName
* @behavior PaperTabs
*/
public void addOwnKeyBinding(JavaScriptObject eventString, JavaScriptObject handlerName) {
getPolymerElement().addOwnKeyBinding(eventString, handlerName);
}
/**
* The HTMLElement that will be firing relevant KeyboardEvents.
*
* JavaScript Info:
* @property keyEventTarget
* @type Object
* @behavior PaperTabs
*/
public JavaScriptObject getKeyEventTarget(){
return getPolymerElement().getKeyEventTarget();
}
/**
* The HTMLElement that will be firing relevant KeyboardEvents.
*
* JavaScript Info:
* @property keyEventTarget
* @type Object
* @behavior PaperTabs
*/
public void setKeyEventTarget(JavaScriptObject value) {
getPolymerElement().setKeyEventTarget(value);
}
/**
* The HTMLElement that will be firing relevant KeyboardEvents.
*
* JavaScript Info:
* @attribute key-event-target
* @behavior PaperTabs
*/
public void setKeyEventTarget(String value) {
getPolymerElement().setAttribute("key-event-target", value);
}
/**
*
*
* JavaScript Info:
* @method keyboardEventMatchesKeys
* @param {} event
* @param {} eventString
* @behavior PaperTabs
*/
public void keyboardEventMatchesKeys(JavaScriptObject event, JavaScriptObject eventString) {
getPolymerElement().keyboardEventMatchesKeys(event, eventString);
}
/**
* When called, will remove all imperatively-added key bindings.
*
* JavaScript Info:
* @method removeOwnKeyBindings
* @behavior PaperTabs
*/
public void removeOwnKeyBindings() {
getPolymerElement().removeOwnKeyBindings();
}
/**
*
*
* JavaScript Info:
* @method detached
* @behavior PaperTabs
*/
public void detached() {
getPolymerElement().detached();
}
/**
*
*
* JavaScript Info:
* @property observers
* @type Array
* @behavior PaperTabs
*/
public JsArray getObservers(){
return getPolymerElement().getObservers();
}
/**
*
*
* JavaScript Info:
* @property observers
* @type Array
* @behavior PaperTabs
*/
public void setObservers(JsArray value) {
getPolymerElement().setObservers(value);
}
/**
*
*
* JavaScript Info:
* @method registered
* @behavior PaperTabs
*/
public void registered() {
getPolymerElement().registered();
}
}