com.vaadin.polymer.paper.widget.PaperIconButton Maven / Gradle / Ivy
/*
* This code was generated with Vaadin Web Component GWT API Generator,
* from paper-icon-button 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;
/**
* Material Design: Buttons
* paper-icon-button is a button with an image placed at the center. When the user touches
the button, a ripple effect emanates from the center of the button.
* paper-icon-button includes a default icon set. Use icon to specify which icon
from the icon set to use.
* <paper-icon-button icon="menu"></paper-icon-button>
*
*
*
See iron-iconset for more information about
how to use a custom icon set.
* Example:
* <link href="path/to/iron-icons/iron-icons.html" rel="import">
*
* <paper-icon-button icon="favorite"></paper-icon-button>
* <paper-icon-button src="star.png"></paper-icon-button>
*
*
*
Styling
* Style the button with CSS as you would a normal DOM element. If you are using the icons
provided by iron-icons, they will inherit the foreground color of the button.
* /* make a red "favorite" button * /
* <paper-icon-button icon="favorite" style="color: red;"></paper-icon-button>
*
*
*
By default, the ripple is the same color as the foreground at 25% opacity. You may
customize the color using this selector:
* /* make #my-button use a blue ripple instead of foreground color * /
* #my-button::shadow #ripple {
* color: blue;
* }
*
*
*
The opacity of the ripple is not customizable via CSS.
* The following custom properties and mixins are available for styling:
*
*
*
* Custom property
* Description
* Default
*
*
*
*
* --paper-icon-button-disabled-textThe color of the disabled button
* --primary-text-color
*
* --paper-icon-button-ink-colorSelected/focus ripple color
* --default-primary-color
*
* --paper-icon-buttonMixin for a button
* {}
*
* --paper-icon-button-disabledMixin for a disabled button
* {}
*
*
*/
public class PaperIconButton extends PolymerWidget {
/**
* Default Constructor.
*/
public PaperIconButton() {
this("");
}
/**
* Constructor used by UIBinder to create widgets with content.
*/
public PaperIconButton(String html) {
super(PaperIconButtonElement.TAG, PaperIconButtonElement.SRC, html);
}
/**
* Gets a handle to the Polymer object's underlying DOM element.
*/
public PaperIconButtonElement getPolymerElement() {
return (PaperIconButtonElement) getElement();
}
/**
* Specifies the alternate text for the button, for accessibility.
*
* JavaScript Info:
* @property alt
* @type String
*
*/
public String getAlt(){
return getPolymerElement().getAlt();
}
/**
* Specifies the alternate text for the button, for accessibility.
*
* JavaScript Info:
* @property alt
* @type String
*
*/
public void setAlt(String value) {
getPolymerElement().setAlt(value);
}
/**
* Specifies the icon name or index in the set of icons available in
the icon’s icon set. If the icon property is specified,
the src property should not be.
*
* JavaScript Info:
* @property icon
* @type String
*
*/
public String getIcon(){
return getPolymerElement().getIcon();
}
/**
* Specifies the icon name or index in the set of icons available in
the icon’s icon set. If the icon property is specified,
the src property should not be.
*
* JavaScript Info:
* @property icon
* @type String
*
*/
public void setIcon(String value) {
getPolymerElement().setIcon(value);
}
/**
* The URL of an image for the icon. If the src property is specified,
the icon property should not be.
*
* JavaScript Info:
* @property src
* @type String
*
*/
public String getSrc(){
return getPolymerElement().getSrc();
}
/**
* The URL of an image for the icon. If the src property is specified,
the icon property should not be.
*
* JavaScript Info:
* @property src
* @type String
*
*/
public void setSrc(String value) {
getPolymerElement().setSrc(value);
}
/**
*
*
* JavaScript Info:
* @property hostAttributes
* @type Object
*
*/
public JavaScriptObject getHostAttributes(){
return getPolymerElement().getHostAttributes();
}
/**
*
*
* JavaScript Info:
* @property hostAttributes
* @type Object
*
*/
public void setHostAttributes(JavaScriptObject value) {
getPolymerElement().setHostAttributes(value);
}
/**
*
*
* JavaScript Info:
* @property observers
* @type Array
* @behavior PaperSlider
*/
public JsArray getObservers(){
return getPolymerElement().getObservers();
}
/**
*
*
* JavaScript Info:
* @property observers
* @type Array
* @behavior PaperSlider
*/
public void setObservers(JsArray value) {
getPolymerElement().setObservers(value);
}
/**
* If true, the button is a toggle and is currently in the active state.
*
* JavaScript Info:
* @property active
* @type Boolean
* @behavior PaperSlider
*/
public boolean getActive(){
return getPolymerElement().getActive();
}
/**
* If true, the button is a toggle and is currently in the active state.
*
* JavaScript Info:
* @property active
* @type Boolean
* @behavior PaperSlider
*/
public void setActive(boolean value) {
getPolymerElement().setActive(value);
}
/**
*
*
* JavaScript Info:
* @property keyBindings
* @type Object
* @behavior PaperSlider
*/
public JavaScriptObject getKeyBindings(){
return getPolymerElement().getKeyBindings();
}
/**
*
*
* JavaScript Info:
* @property keyBindings
* @type Object
* @behavior PaperSlider
*/
public void setKeyBindings(JavaScriptObject value) {
getPolymerElement().setKeyBindings(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 PaperSlider
*/
public boolean getPointerDown(){
return getPolymerElement().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 PaperSlider
*/
public void setPointerDown(boolean value) {
getPolymerElement().setPointerDown(value);
}
/**
* If true, the user is currently holding down the button.
*
* JavaScript Info:
* @property pressed
* @type Boolean
* @behavior PaperSlider
*/
public boolean getPressed(){
return getPolymerElement().getPressed();
}
/**
* If true, the user is currently holding down the button.
*
* JavaScript Info:
* @property pressed
* @type Boolean
* @behavior PaperSlider
*/
public void setPressed(boolean value) {
getPolymerElement().setPressed(value);
}
/**
* True if the input device that caused the element to receive focus
was a keyboard.
*
* JavaScript Info:
* @property receivedFocusFromKeyboard
* @type Boolean
* @behavior PaperSlider
*/
public boolean getReceivedFocusFromKeyboard(){
return getPolymerElement().getReceivedFocusFromKeyboard();
}
/**
* True if the input device that caused the element to receive focus
was a keyboard.
*
* JavaScript Info:
* @property receivedFocusFromKeyboard
* @type Boolean
* @behavior PaperSlider
*/
public void setReceivedFocusFromKeyboard(boolean value) {
getPolymerElement().setReceivedFocusFromKeyboard(value);
}
/**
* If true, the button toggles the active state with each tap or press
of the spacebar.
*
* JavaScript Info:
* @property toggles
* @type Boolean
* @behavior PaperSlider
*/
public boolean getToggles(){
return getPolymerElement().getToggles();
}
/**
* If true, the button toggles the active state with each tap or press
of the spacebar.
*
* JavaScript Info:
* @property toggles
* @type Boolean
* @behavior PaperSlider
*/
public void setToggles(boolean value) {
getPolymerElement().setToggles(value);
}
/**
*
*
* JavaScript Info:
* @property listeners
* @type Object
* @behavior PaperSlider
*/
public JavaScriptObject getListeners(){
return getPolymerElement().getListeners();
}
/**
*
*
* JavaScript Info:
* @property listeners
* @type Object
* @behavior PaperSlider
*/
public void setListeners(JavaScriptObject value) {
getPolymerElement().setListeners(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 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 attached
* @behavior PaperTabs
*/
public void attached() {
getPolymerElement().attached();
}
/**
*
*
* JavaScript Info:
* @method detached
* @behavior PaperTabs
*/
public void detached() {
getPolymerElement().detached();
}
/**
*
*
* JavaScript Info:
* @method registered
* @behavior PaperTabs
*/
public void registered() {
getPolymerElement().registered();
}
/**
* If true, the user cannot interact with this element.
*
* JavaScript Info:
* @property disabled
* @type Boolean
* @behavior PaperInput
*/
public boolean getDisabled(){
return getPolymerElement().getDisabled();
}
/**
* If true, the user cannot interact with this element.
*
* JavaScript Info:
* @property disabled
* @type Boolean
* @behavior PaperInput
*/
public void setDisabled(boolean value) {
getPolymerElement().setDisabled(value);
}
/**
* If true, the element currently has focus.
*
* JavaScript Info:
* @property focused
* @type Boolean
* @behavior PaperInput
*/
public boolean getFocused(){
return getPolymerElement().getFocused();
}
/**
* If true, the element currently has focus.
*
* JavaScript Info:
* @property focused
* @type Boolean
* @behavior PaperInput
*/
public void setFocused(boolean value) {
getPolymerElement().setFocused(value);
}
}