All Downloads are FREE. Search and download functionalities are using the official Maven repository.

com.vaadin.polymer.paper.element.PaperFabElement Maven / Gradle / Ivy

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-fab 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;

/**
 * 

Material Design: Button

*

paper-fab is a floating action button. It contains an image placed in the center and
comes in two sizes: regular size and a smaller size by applying the attribute mini. When
the user touches the button, a ripple effect emanates from the center of the button.

*

You may import iron-icons to use with this element, or provide a URL to a custom icon.
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-fab icon="add"></paper-fab>
 * <paper-fab mini icon="favorite"></paper-fab>
 * <paper-fab src="star.png"></paper-fab>
 * 
 * 
 * 
 * 

Styling

*

The following custom properties and mixins are available for styling:

* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
Custom propertyDescriptionDefault
--paper-fab-backgroundThe background color of the button--accent-color
--paper-fab-keyboard-focus-backgroundThe background color of the button when focused--paper-pink-900
--paper-fab-disabled-backgroundThe background color of the button when it’s disabled--paper-grey-300
--paper-fab-disabled-textThe text color of the button when it’s disabled--paper-grey-500
--paper-fabMixin applied to the button{}
--paper-fab-miniMixin applied to a mini button{}
--paper-fab-disabledMixin applied to a disabled button{}
*/ @JsType public interface PaperFabElement extends HTMLElement { public static final String TAG = "paper-fab"; public static final String SRC = "paper-fab/paper-fab.html"; /** *

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 * */ @JsProperty String 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 * */ @JsProperty void setIcon(String value); /** *

Set this to true to style this is a “mini” FAB.

* * JavaScript Info: * @property mini * @type Boolean * */ @JsProperty boolean getMini(); /** *

Set this to true to style this is a “mini” FAB.

* * JavaScript Info: * @property mini * @type Boolean * */ @JsProperty void setMini(boolean 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 * */ @JsProperty String 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 * */ @JsProperty void setSrc(String value); /** * * * JavaScript Info: * @property hostAttributes * @type Object * @behavior PaperFab */ @JsProperty JavaScriptObject getHostAttributes(); /** * * * JavaScript Info: * @property hostAttributes * @type Object * @behavior PaperFab */ @JsProperty void setHostAttributes(JavaScriptObject value); /** * * * JavaScript Info: * @property observers * @type Array * @behavior PaperFab */ @JsProperty JsArray getObservers(); /** * * * JavaScript Info: * @property observers * @type Array * @behavior PaperFab */ @JsProperty void setObservers(JsArray value); /** *

If true, the button is a toggle and is currently in the active state.

* * JavaScript Info: * @property active * @type Boolean * @behavior PaperSlider */ @JsProperty boolean getActive(); /** *

If true, the button is a toggle and is currently in the active state.

* * JavaScript Info: * @property active * @type Boolean * @behavior PaperSlider */ @JsProperty void setActive(boolean value); /** * * * JavaScript Info: * @property keyBindings * @type Object * @behavior PaperSlider */ @JsProperty JavaScriptObject getKeyBindings(); /** * * * JavaScript Info: * @property keyBindings * @type Object * @behavior PaperSlider */ @JsProperty void setKeyBindings(JavaScriptObject 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 */ @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 PaperSlider */ @JsProperty void setPointerDown(boolean value); /** *

If true, the user is currently holding down the button.

* * JavaScript Info: * @property pressed * @type Boolean * @behavior PaperSlider */ @JsProperty boolean getPressed(); /** *

If true, the user is currently holding down the button.

* * JavaScript Info: * @property pressed * @type Boolean * @behavior PaperSlider */ @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 PaperSlider */ @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 PaperSlider */ @JsProperty void setReceivedFocusFromKeyboard(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 PaperSlider */ @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 PaperSlider */ @JsProperty void setToggles(boolean value); /** * * * JavaScript Info: * @property listeners * @type Object * @behavior PaperSlider */ @JsProperty JavaScriptObject getListeners(); /** * * * JavaScript Info: * @property listeners * @type Object * @behavior PaperSlider */ @JsProperty void setListeners(JavaScriptObject 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 */ void addOwnKeyBinding(JavaScriptObject eventString, JavaScriptObject handlerName); /** *

The HTMLElement that will be firing relevant KeyboardEvents.

* * JavaScript Info: * @property keyEventTarget * @type Object * @behavior PaperTabs */ @JsProperty JavaScriptObject getKeyEventTarget(); /** *

The HTMLElement that will be firing relevant KeyboardEvents.

* * JavaScript Info: * @property keyEventTarget * @type Object * @behavior PaperTabs */ @JsProperty void setKeyEventTarget(JavaScriptObject value); /** * * * JavaScript Info: * @method keyboardEventMatchesKeys * @param {} event * @param {} eventString * @behavior PaperTabs */ void keyboardEventMatchesKeys(JavaScriptObject event, JavaScriptObject eventString); /** *

When called, will remove all imperatively-added key bindings.

* * JavaScript Info: * @method removeOwnKeyBindings * @behavior PaperTabs */ void removeOwnKeyBindings(); /** * * * JavaScript Info: * @method attached * @behavior PaperTabs */ void attached(); /** * * * JavaScript Info: * @method detached * @behavior PaperTabs */ void detached(); /** * * * JavaScript Info: * @method registered * @behavior PaperTabs */ void registered(); /** *

If true, the user cannot interact with this element.

* * JavaScript Info: * @property disabled * @type Boolean * @behavior PaperInput */ @JsProperty boolean getDisabled(); /** *

If true, the user cannot interact with this element.

* * JavaScript Info: * @property disabled * @type Boolean * @behavior PaperInput */ @JsProperty void setDisabled(boolean value); /** *

If true, the element currently has focus.

* * JavaScript Info: * @property focused * @type Boolean * @behavior PaperInput */ @JsProperty boolean getFocused(); /** *

If true, the element currently has focus.

* * JavaScript Info: * @property focused * @type Boolean * @behavior PaperInput */ @JsProperty void setFocused(boolean value); }




© 2015 - 2025 Weber Informatics LLC | Privacy Policy