com.vaadin.polymer.paper.PaperProgressElement Maven / Gradle / Ivy
/*
* This code was generated with Vaadin Web Component GWT API Generator,
* from paper-progress 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;
/**
* Material design: Progress & activity
* The progress bars are for situations where the percentage completed can be
determined. They give users a quick sense of how much longer an operation
will take.
* Example:
* <paper-progress value="10"></paper-progress>
*
*
*
There is also a secondary progress which is useful for displaying intermediate
progress, such as the buffer level during a streaming playback progress bar.
* Example:
* <paper-progress value="10" secondary-progress="30"></paper-progress>
*
*
*
Styling progress bar:
* To change the active progress bar color:
* paper-progress {
* --paper-progress-active-color: #e91e63;
* }
*
*
*
To change the secondary progress bar color:
* paper-progress {
* --paper-progress-secondary-color: #f8bbd0;
* }
*
*
*
To change the progress bar background color:
* paper-progress {
* --paper-progress-container-color: #64ffda;
* }
*
*
*
Add the class transiting
to a paper-progress to animate the progress bar when
the value changed. You can also customize the transition:
* paper-progress {
* --paper-progress-transition-duration: 0.08s;
* --paper-progress-transition-timing-function: ease;
* --paper-progress-transition-transition-delay: 0s;
* }
*
*
*
To change the duration of the indeterminate cycle:
* paper-progress {
* --paper-progress-indeterminate-cycle-duration: 2s;
* }
*
*
*
The following mixins are available for styling:
*
*
*
* Custom property
* Description
* Default
*
*
*
*
* --paper-progress-container
* Mixin applied to container
* {}
*
*
* --paper-progress-transition-duration
* Duration of the transition
* 0.008s
*
*
* --paper-progress-transition-timing-function
* The timing function for the transition
* ease
*
*
* --paper-progress-transition-delay
* delay for the transition
* 0s
*
*
* --paper-progress-container-color
* Color of the container
* --google-grey-300
*
*
* --paper-progress-active-color
* The color of the active bar
* --google-green-500
*
*
* --paper-progress-secondary-color
* The color of the secondary bar
* --google-green-100
*
*
* --paper-progress-disabled-active-color
* The color of the active bar if disabled
* --google-grey-500
*
*
* --paper-progress-disabled-secondary-color
* The color of the secondary bar if disabled
* --google-grey-300
*
*
* --paper-progress-height
* The height of the progress bar
* 4px
*
*
* --paper-progress-indeterminate-cycle-duration
* Duration of an indeterminate cycle
* 2s
*
*
*
*/
@JsType(isNative=true)
public interface PaperProgressElement extends HTMLElement {
@JsOverlay public static final String TAG = "paper-progress";
@JsOverlay public static final String SRC = "paper-progress/paper-progress.html";
/**
* True if the progress is disabled.
*
* JavaScript Info:
* @property disabled
* @type Boolean
*
*/
@JsProperty boolean getDisabled();
/**
* True if the progress is disabled.
*
* JavaScript Info:
* @property disabled
* @type Boolean
*
*/
@JsProperty void setDisabled(boolean value);
/**
* Use an indeterminate progress indicator.
*
* JavaScript Info:
* @property indeterminate
* @type Boolean
*
*/
@JsProperty boolean getIndeterminate();
/**
* Use an indeterminate progress indicator.
*
* JavaScript Info:
* @property indeterminate
* @type Boolean
*
*/
@JsProperty void setIndeterminate(boolean value);
/**
* The number that represents the current secondary progress.
*
* JavaScript Info:
* @property secondaryProgress
* @type Number
*
*/
@JsProperty double getSecondaryProgress();
/**
* The number that represents the current secondary progress.
*
* JavaScript Info:
* @property secondaryProgress
* @type Number
*
*/
@JsProperty void setSecondaryProgress(double value);
/**
* The secondary ratio
*
* JavaScript Info:
* @property secondaryRatio
* @type Number
*
*/
@JsProperty double getSecondaryRatio();
/**
* The secondary ratio
*
* JavaScript Info:
* @property secondaryRatio
* @type Number
*
*/
@JsProperty void setSecondaryRatio(double value);
/**
* The number that indicates the maximum value of the range.
*
* JavaScript Info:
* @property max
* @type Number
* @behavior PaperSlider
*/
@JsProperty double getMax();
/**
* The number that indicates the maximum value of the range.
*
* JavaScript Info:
* @property max
* @type Number
* @behavior PaperSlider
*/
@JsProperty void setMax(double value);
/**
* The number that indicates the minimum value of the range.
*
* JavaScript Info:
* @property min
* @type Number
* @behavior PaperSlider
*/
@JsProperty double getMin();
/**
* The number that indicates the minimum value of the range.
*
* JavaScript Info:
* @property min
* @type Number
* @behavior PaperSlider
*/
@JsProperty void setMin(double value);
/**
* Returns the ratio of the value.
*
* JavaScript Info:
* @property ratio
* @type Number
* @behavior PaperSlider
*/
@JsProperty double getRatio();
/**
* Returns the ratio of the value.
*
* JavaScript Info:
* @property ratio
* @type Number
* @behavior PaperSlider
*/
@JsProperty void setRatio(double value);
/**
* Specifies the value granularity of the range’s value.
*
* JavaScript Info:
* @property step
* @type Number
* @behavior PaperSlider
*/
@JsProperty double getStep();
/**
* Specifies the value granularity of the range’s value.
*
* JavaScript Info:
* @property step
* @type Number
* @behavior PaperSlider
*/
@JsProperty void setStep(double value);
/**
* The number that represents the current value.
*
* JavaScript Info:
* @property value
* @type Number
* @behavior PaperSlider
*/
@JsProperty double getValue();
/**
* The number that represents the current value.
*
* JavaScript Info:
* @property value
* @type Number
* @behavior PaperSlider
*/
@JsProperty void setValue(double value);
}