• Home
• com.vaadin.polymer
• vaadin-gwt-polymer-elements
• 1.9.3.1
• source code
• PaperButtonElement.java

×

Project download

Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $

You can buy this project and download/modify it how often you want.

com.vaadin.polymer.paper.PaperButtonElement Maven / Gradle / Ivy

/*
 * This code was generated with Vaadin Web Component GWT API Generator, 
 * from paper-button 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: Buttons
 * 
paper-button is a button. When the user touches the button, a ripple effect emanates
from the point of contact. It may be flat or raised. A raised button is styled with a
shadow.
 * 
Example:
 * 
<paper-button>Flat button</paper-button>
 * <paper-button raised>Raised button</paper-button>
 * <paper-button noink>No ripple effect</paper-button>
 * <paper-button toggles>Toggle-able button</paper-button>
 * 
 * 
 * 
A button that has toggles true will remain active after being clicked (and
will have an active attribute set). For more information, see the Polymer.IronButtonState
behavior.
 * 
You may use custom DOM in the button body to create a variety of buttons. For example, to
create a button with an icon and some text:
 * 
<paper-button>
 *   <iron-icon icon="favorite"></iron-icon>
 *   custom button content
 * </paper-button>
 * 
 * 
 * 
To use paper-button as a link, wrap it in an anchor tag. Since paper-button will already
receive focus, you may want to prevent the anchor tag from receiving focus as well by setting
its tabindex to -1.
 * 
<a href="https://www.polymer-project.org/" tabindex="-1">
 *   <paper-button raised>Polymer Project</paper-button>
 * </a>
 * 
 * 
 * 
Styling
 * 
Style the button with CSS as you would a normal DOM element.
 * 
paper-button.fancy {
 *   background: green;
 *   color: yellow;
 * }
 * 
 * paper-button.fancy:hover {
 *   background: lime;
 * }
 * 
 * paper-button[disabled],
 * paper-button[toggles][active] {
 *   background: red;
 * }
 * 
 * 
 * 
By default, the ripple is the same color as the foreground at 25% opacity. You may
customize the color using the --paper-button-ink-color custom property.
 * 
The following custom properties and mixins are also available for styling:
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
Custom property
Description
Default
--paper-button-ink-color
Background color of the ripple
Based on the button's color
--paper-button
Mixin applied to the button
{}
--paper-button-disabled
Mixin applied to the disabled button. Note that you can also use the paper-button[disabled] selector
{}
--paper-button-flat-keyboard-focus
Mixin applied to a flat button after it’s been focused using the keyboard
{}
--paper-button-raised-keyboard-focus
Mixin applied to a raised button after it’s been focused using the keyboard
{}
 */
@JsType(isNative=true)
public interface PaperButtonElement extends HTMLElement {

    @JsOverlay public static final String TAG = "paper-button";
    @JsOverlay public static final String SRC = "paper-button/paper-button.html";


    /**
     * 
If true, the button should be styled with a shadow.
     *
     * JavaScript Info:
     * @property raised
     * @type Boolean
     * 
     */
    @JsProperty boolean getRaised();
    /**
     * 
If true, the button should be styled with a shadow.
     *
     * JavaScript Info:
     * @property raised
     * @type Boolean
     * 
     */
    @JsProperty void setRaised(boolean value);

    /**
     * 
     *
     * JavaScript Info:
     * @property keyBindings
     * @type Object
     * @behavior PaperTab
     */
    @JsProperty JavaScriptObject getKeyBindings();
    /**
     * 
     *
     * JavaScript Info:
     * @property keyBindings
     * @type Object
     * @behavior PaperTab
     */
    @JsProperty void setKeyBindings(JavaScriptObject value);

    /**
     * 
The z-depth of this element, from 0-5. Setting to 0 will remove the
shadow, and each increasing number greater than 0 will be “deeper”
than the last.
     *
     * JavaScript Info:
     * @property elevation
     * @type Number
     * @behavior PaperFab
     */
    @JsProperty double getElevation();
    /**
     * 
The z-depth of this element, from 0-5. Setting to 0 will remove the
shadow, and each increasing number greater than 0 will be “deeper”
than the last.
     *
     * JavaScript Info:
     * @property elevation
     * @type Number
     * @behavior PaperFab
     */
    @JsProperty void setElevation(double value);

    /**
     * 
The EventTarget that will be firing relevant KeyboardEvents. Set it to
null to disable the listeners.
     *
     * JavaScript Info:
     * @property keyEventTarget
     * @type ?EventTarget
     * @behavior VaadinDatePicker
     */
    @JsProperty JavaScriptObject getKeyEventTarget();
    /**
     * 
The EventTarget that will be firing relevant KeyboardEvents. Set it to
null to disable the listeners.
     *
     * JavaScript Info:
     * @property keyEventTarget
     * @type ?EventTarget
     * @behavior VaadinDatePicker
     */
    @JsProperty void setKeyEventTarget(JavaScriptObject value);

    /**
     * 
If true, the user is currently holding down the button.
     *
     * JavaScript Info:
     * @property pressed
     * @type Boolean
     * @behavior PaperTab
     */
    @JsProperty boolean getPressed();
    /**
     * 
If true, the user is currently holding down the button.
     *
     * JavaScript Info:
     * @property pressed
     * @type Boolean
     * @behavior PaperTab
     */
    @JsProperty void setPressed(boolean value);

    /**
     * 
True if the input device that caused the element to receive focus
was a keyboard.
     *
     * JavaScript Info:
     * @property receivedFocusFromKeyboard
     * @type Boolean
     * @behavior PaperTab
     */
    @JsProperty boolean getReceivedFocusFromKeyboard();
    /**
     * 
True if the input device that caused the element to receive focus
was a keyboard.
     *
     * JavaScript Info:
     * @property receivedFocusFromKeyboard
     * @type Boolean
     * @behavior PaperTab
     */
    @JsProperty void setReceivedFocusFromKeyboard(boolean value);

    /**
     * 
If true, this property will cause the implementing element to
automatically stop propagation on any handled KeyboardEvents.
     *
     * JavaScript Info:
     * @property stopKeyboardEventPropagation
     * @type Boolean
     * @behavior VaadinDatePicker
     */
    @JsProperty boolean getStopKeyboardEventPropagation();
    /**
     * 
If true, this property will cause the implementing element to
automatically stop propagation on any handled KeyboardEvents.
     *
     * JavaScript Info:
     * @property stopKeyboardEventPropagation
     * @type Boolean
     * @behavior VaadinDatePicker
     */
    @JsProperty void setStopKeyboardEventPropagation(boolean value);

    /**
     * 
If true, the button toggles the active state with each tap or press
of the spacebar.
     *
     * JavaScript Info:
     * @property toggles
     * @type Boolean
     * @behavior PaperTab
     */
    @JsProperty boolean getToggles();
    /**
     * 
If true, the button toggles the active state with each tap or press
of the spacebar.
     *
     * JavaScript Info:
     * @property toggles
     * @type Boolean
     * @behavior PaperTab
     */
    @JsProperty void setToggles(boolean value);

    /**
     * 
If true, the button is a toggle and is currently in the active state.
     *
     * JavaScript Info:
     * @property active
     * @type Boolean
     * @behavior PaperTab
     */
    @JsProperty boolean getActive();
    /**
     * 
If true, the button is a toggle and is currently in the active state.
     *
     * JavaScript Info:
     * @property active
     * @type Boolean
     * @behavior PaperTab
     */
    @JsProperty void setActive(boolean value);

    /**
     * 
If true, the element will not produce a ripple effect when interacted
with via the pointer.
     *
     * JavaScript Info:
     * @property noink
     * @type Boolean
     * @behavior PaperFab
     */
    @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
     * @behavior PaperFab
     */
    @JsProperty void setNoink(boolean value);

    /**
     * 
If true, the user cannot interact with this element.
     *
     * JavaScript Info:
     * @property disabled
     * @type Boolean
     * @behavior PaperTab
     */
    @JsProperty boolean getDisabled();
    /**
     * 
If true, the user cannot interact with this element.
     *
     * JavaScript Info:
     * @property disabled
     * @type Boolean
     * @behavior PaperTab
     */
    @JsProperty void setDisabled(boolean value);

    /**
     * 
If true, the element currently has focus.
     *
     * JavaScript Info:
     * @property focused
     * @type Boolean
     * @behavior PaperTab
     */
    @JsProperty boolean getFocused();
    /**
     * 
If true, the element currently has focus.
     *
     * JavaScript Info:
     * @property focused
     * @type Boolean
     * @behavior PaperTab
     */
    @JsProperty void setFocused(boolean value);

    /**
     * 
True if the element is currently being pressed by a “pointer,” which
is loosely defined as mouse or touch input (but specifically excluding
keyboard input).
     *
     * JavaScript Info:
     * @property pointerDown
     * @type Boolean
     * @behavior PaperTab
     */
    @JsProperty boolean getPointerDown();
    /**
     * 
True if the element is currently being pressed by a “pointer,” which
is loosely defined as mouse or touch input (but specifically excluding
keyboard input).
     *
     * JavaScript Info:
     * @property pointerDown
     * @type Boolean
     * @behavior PaperTab
     */
    @JsProperty void setPointerDown(boolean value);

    /**
     * 
The aria attribute to be set if the button is a toggle and in the
active state.
     *
     * JavaScript Info:
     * @property ariaActiveAttribute
     * @type String
     * @behavior PaperTab
     */
    @JsProperty String getAriaActiveAttribute();
    /**
     * 
The aria attribute to be set if the button is a toggle and in the
active state.
     *
     * JavaScript Info:
     * @property ariaActiveAttribute
     * @type String
     * @behavior PaperTab
     */
    @JsProperty void setAriaActiveAttribute(String value);


    /**
     * 
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 VaadinDatePicker
     * 
     */
    void addOwnKeyBinding(Object eventString, Object handlerName);

    /**
     * 
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
     * @behavior PaperFab
     * 
     */
    void getRipple();

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

    /**
     * 
When called, will remove all imperatively-added key bindings.
     *
     * JavaScript Info:
     * @method removeOwnKeyBindings
     * @behavior VaadinDatePicker
     * 
     */
    void removeOwnKeyBindings();

    /**
     * 
Returns true if a keyboard event matches eventString.
     *
     * JavaScript Info:
     * @method keyboardEventMatchesKeys
     * @param {KeyboardEvent} event  
     * @param {string} eventString  
     * @behavior VaadinDatePicker
     * @return {boolean}
     */
    boolean keyboardEventMatchesKeys(JavaScriptObject event, String eventString);

    /**
     * 
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  
     * @behavior PaperTab
     * 
     */
    void ensureRipple(JavaScriptObject optTriggeringEvent);

}