com.vaadin.polymer.paper.widget.PaperSpinner Maven / Gradle / Ivy
/*
* This code was generated with Vaadin Web Component GWT API Generator,
* from paper-spinner 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.*;
import com.vaadin.polymer.*;
import com.vaadin.polymer.elemental.*;
import com.vaadin.polymer.PolymerWidget;
import com.google.gwt.core.client.JsArray;
import com.google.gwt.event.shared.HandlerRegistration;
import com.google.gwt.core.client.JavaScriptObject;
/**
* Material design: Progress & activity
* Element providing a multiple color material design circular spinner.
* <paper-spinner active></paper-spinner>
*
*
*
The default spinner cycles between four layers of colors; by default they are
blue, red, yellow and green. It can be customized to cycle between four different
colors. Use for single color spinners.
* Accessibility
* Alt attribute should be set to provide adequate context for accessibility. If not provided,
it defaults to ‘loading’.
Empty alt can be provided to mark the element as decorative if alternative content is provided
in another form (e.g. a text block following the spinner).
* <paper-spinner alt="Loading contacts list" active></paper-spinner>
*
*
*
Styling
* The following custom properties and mixins are available for styling:
*
*
*
* Custom property
* Description
* Default
*
*
*
*
* --paper-spinner-layer-1-color
* Color of the first spinner rotation
* --google-blue-500
*
*
* --paper-spinner-layer-2-color
* Color of the second spinner rotation
* --google-red-500
*
*
* --paper-spinner-layer-3-color
* Color of the third spinner rotation
* --google-yellow-500
*
*
* --paper-spinner-layer-4-color
* Color of the fourth spinner rotation
* --google-green-500
*
*
* --paper-spinner-stroke-width
* The width of the spinner stroke
* 3px
*
*
*
*/
public class PaperSpinner extends PolymerWidget {
/**
* Default Constructor.
*/
public PaperSpinner() {
this("");
}
/**
* Constructor used by UIBinder to create widgets with content.
*/
public PaperSpinner(String html) {
super(PaperSpinnerElement.TAG, PaperSpinnerElement.SRC, html);
}
/**
* Gets a handle to the Polymer object's underlying DOM element.
*/
public PaperSpinnerElement getPolymerElement() {
return (PaperSpinnerElement) getElement();
}
/**
* Displays the spinner.
*
* JavaScript Info:
* @property active
* @type Boolean
*
*/
public boolean getActive() {
return getPolymerElement().getActive();
}
/**
* Displays the spinner.
*
* JavaScript Info:
* @property active
* @type Boolean
*
*/
public void setActive(boolean value) {
getPolymerElement().setActive(value);
}
/**
* Alternative text content for accessibility support.
If alt is present, it will add an aria-label whose content matches alt when active.
If alt is not present, it will default to ‘loading’ as the alt value.
*
* JavaScript Info:
* @property alt
* @type String
*
*/
public String getAlt() {
return getPolymerElement().getAlt();
}
/**
* Alternative text content for accessibility support.
If alt is present, it will add an aria-label whose content matches alt when active.
If alt is not present, it will default to ‘loading’ as the alt value.
*
* JavaScript Info:
* @property alt
* @type String
*
*/
public void setAlt(String value) {
getPolymerElement().setAlt(value);
}
}