com.vaadin.polymer.paper.element.PaperProgressElement 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 paper-progress project by The Polymer Authors
 * that is licensed with http://polymer.github.io/LICENSE.txt license.
 */
package com.vaadin.polymer.paper.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;

/**
 * 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;
 * }
 * 
 * 
 * 
 */
@JsType
public interface PaperProgressElement extends HTMLElement {

    public static final String TAG = "paper-progress";
    public static final String SRC = "paper-progress/paper-progress.html";


    /**
     * 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);
  
    /**
     * 
     *
     * JavaScript Info:
     * @property observers
     * @type Array
     * 
     */
    @JsProperty JsArray getObservers();
    /**
     * 
     *
     * JavaScript Info:
     * @property observers
     * @type Array
     * 
     */
    @JsProperty void setObservers(JsArray 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);
  
}