• Home
• com.vaadin.polymer
• vaadin-gwt-polymer-elements
• 1.1.3.0-alpha1
• source code
• PaperCheckbox.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.widget.PaperCheckbox Maven / Gradle / Ivy

/*
 * This code was generated with Vaadin Web Component GWT API Generator, 
 * from paper-checkbox 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.change.widget.event.ChangeEvent;
import com.vaadin.polymer.change.widget.event.ChangeEventHandler;

import com.vaadin.polymer.iron.widget.event.IronChangeEvent;
import com.vaadin.polymer.iron.widget.event.IronChangeEventHandler;

import com.vaadin.polymer.iron.widget.event.IronFormElementRegisterEvent;
import com.vaadin.polymer.iron.widget.event.IronFormElementRegisterEventHandler;

import com.vaadin.polymer.iron.widget.event.IronFormElementUnregisterEvent;
import com.vaadin.polymer.iron.widget.event.IronFormElementUnregisterEventHandler;

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;

/**
 * 
paper-checkbox is a button that can be either checked or unchecked.  User
can tap the checkbox to check or uncheck it.  Usually you use checkboxes
to allow user to select multiple options from a set.  If you have a single
ON/OFF option, avoid using a single checkbox and use paper-toggle-button
instead.
 * 
Example:
 * 
<paper-checkbox>label</paper-checkbox>
 * 
 * <paper-checkbox checked> label</paper-checkbox>
 * 
 * 
 * 
Styling
 * 
The following custom properties and mixins are available for styling:
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
Custom property
Description
Default
--paper-checkbox-unchecked-background-color
Checkbox background color when the input is not checked
transparent
--paper-checkbox-unchecked-color
Checkbox border color when the input is not checked
--primary-text-color
--paper-checkbox-unchecked-ink-color
Selected/focus ripple color when the input is not checked
--primary-text-color
--paper-checkbox-checked-color
Checkbox color when the input is checked
--default-primary-color
--paper-checkbox-checked-ink-color
Selected/focus ripple color when the input is checked
--default-primary-color
--paper-checkbox-checkmark-color
Checkmark color
white
--paper-checkbox-label-color
Label color
--primary-text-color
--paper-checkbox-error-color
Checkbox color when invalid
--google-red-500
 */
public class PaperCheckbox extends PolymerWidget {
    /**
     * Default Constructor.
     */
    public PaperCheckbox() {
       this("");
    }

    /**
     * Constructor used by UIBinder to create widgets with content.
     */
    public PaperCheckbox(String html) {
        super(PaperCheckboxElement.TAG, PaperCheckboxElement.SRC, html);

        getPolymerElement().addEventListener(
                com.vaadin.polymer.change.element.event.ChangeEvent.NAME,
                new com.vaadin.polymer.change.element.event.ChangeEvent.Listener() {
            @Override
            protected void handleEvent(com.vaadin.polymer.change.element.event.ChangeEvent event) {
                fireEvent(new ChangeEvent(event));
            }
        });

        getPolymerElement().addEventListener(
                com.vaadin.polymer.iron.element.event.IronChangeEvent.NAME,
                new com.vaadin.polymer.iron.element.event.IronChangeEvent.Listener() {
            @Override
            protected void handleEvent(com.vaadin.polymer.iron.element.event.IronChangeEvent event) {
                fireEvent(new IronChangeEvent(event));
            }
        });

        getPolymerElement().addEventListener(
                com.vaadin.polymer.iron.element.event.IronFormElementRegisterEvent.NAME,
                new com.vaadin.polymer.iron.element.event.IronFormElementRegisterEvent.Listener() {
            @Override
            protected void handleEvent(com.vaadin.polymer.iron.element.event.IronFormElementRegisterEvent event) {
                fireEvent(new IronFormElementRegisterEvent(event));
            }
        });

        getPolymerElement().addEventListener(
                com.vaadin.polymer.iron.element.event.IronFormElementUnregisterEvent.NAME,
                new com.vaadin.polymer.iron.element.event.IronFormElementUnregisterEvent.Listener() {
            @Override
            protected void handleEvent(com.vaadin.polymer.iron.element.event.IronFormElementUnregisterEvent event) {
                fireEvent(new IronFormElementUnregisterEvent(event));
            }
        });

    }

    /**
     * Gets a handle to the Polymer object's underlying DOM element.
     */
    public PaperCheckboxElement getPolymerElement() {
        try {
            return (PaperCheckboxElement) getElement();
        } catch (ClassCastException e) {
            jsinteropError();
            return null;
        }
    }


  
    /**
     * 
Fired when the checked state changes.
     *
     * JavaScript Info:
     * @property ariaActiveAttribute
     * @type String
     * 
     */
    public String getAriaActiveAttribute(){
        return getPolymerElement().getAriaActiveAttribute();
    }
    /**
     * 
Fired when the checked state changes.
     *
     * JavaScript Info:
     * @property ariaActiveAttribute
     * @type String
     * 
     */
    public void setAriaActiveAttribute(String value) {
        getPolymerElement().setAriaActiveAttribute(value);
    }
   
  

  
    /**
     * 
Update the checkbox aria-label. This is a temporary workaround not
being able to observe changes in 
(see: https://github.com/Polymer/polymer/issues/1773)
     * 
Call this if you manually change the contents of the checkbox
and want the aria-label to match the new contents.
     *
     * JavaScript Info:
     * @method updateAriaLabel
     * 
     */
    public void updateAriaLabel() {
        getPolymerElement().updateAriaLabel();
    }
  

  
    /**
     * 
     *
     * JavaScript Info:
     * @method attached
     * 
     */
    public void attached() {
        getPolymerElement().attached();
    }
  

  
    /**
     * 
     *
     * 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 PaperToggleButton
     */
    public JsArray getObservers(){
        return getPolymerElement().getObservers();
    }
    /**
     * 
     *
     * JavaScript Info:
     * @property observers
     * @type Array
     * @behavior PaperToggleButton
     */
    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 PaperTab
     */
    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 PaperTab
     */
    public void setActive(boolean value) {
        getPolymerElement().setActive(value);
    }
   
  

  
    /**
     * 
     *
     * JavaScript Info:
     * @property keyBindings
     * @type Object
     * @behavior PaperTab
     */
    public JavaScriptObject getKeyBindings(){
        return getPolymerElement().getKeyBindings();
    }
    /**
     * 
     *
     * JavaScript Info:
     * @property keyBindings
     * @type Object
     * @behavior PaperTab
     */
    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 PaperTab
     */
    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 PaperTab
     */
    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 PaperTab
     */
    public boolean getPressed(){
        return getPolymerElement().getPressed();
    }
    /**
     * 
If true, the user is currently holding down the button.
     *
     * JavaScript Info:
     * @property pressed
     * @type Boolean
     * @behavior PaperTab
     */
    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 PaperTab
     */
    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 PaperTab
     */
    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 PaperTab
     */
    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 PaperTab
     */
    public void setToggles(boolean value) {
        getPolymerElement().setToggles(value);
    }
   
  

  
    /**
     * 
     *
     * JavaScript Info:
     * @property listeners
     * @type Object
     * @behavior PaperTab
     */
    public JavaScriptObject getListeners(){
        return getPolymerElement().getListeners();
    }
    /**
     * 
     *
     * JavaScript Info:
     * @property listeners
     * @type Object
     * @behavior PaperTab
     */
    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 PaperTab
     */
    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 PaperTab
     */
    public JavaScriptObject getKeyEventTarget(){
        return getPolymerElement().getKeyEventTarget();
    }
    /**
     * 
The HTMLElement that will be firing relevant KeyboardEvents.
     *
     * JavaScript Info:
     * @property keyEventTarget
     * @type Object
     * @behavior PaperTab
     */
    public void setKeyEventTarget(JavaScriptObject value) {
        getPolymerElement().setKeyEventTarget(value);
    }
   
    /**
     * 
The HTMLElement that will be firing relevant KeyboardEvents.
     *
     * JavaScript Info:
     * @attribute key-event-target
     * @behavior PaperTab
     */
    public void setKeyEventTarget(String value) {
        getPolymerElement().setAttribute("key-event-target", value);
    }
   
  

  
    /**
     * 
     *
     * JavaScript Info:
     * @method keyboardEventMatchesKeys
     * @param {} event  
     * @param {} eventString  
     * @behavior PaperTab
     */
    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 PaperTab
     */
    public void removeOwnKeyBindings() {
        getPolymerElement().removeOwnKeyBindings();
    }
  

  
    /**
     * 
     *
     * JavaScript Info:
     * @method detached
     * @behavior PaperTab
     */
    public void detached() {
        getPolymerElement().detached();
    }
  

  
    /**
     * 
     *
     * JavaScript Info:
     * @method registered
     * @behavior PaperTab
     */
    public void registered() {
        getPolymerElement().registered();
    }
  

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

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

  
    /**
     * 
Gets or sets the state, true is checked and false is unchecked.
     *
     * JavaScript Info:
     * @property checked
     * @type Boolean
     * @behavior PaperToggleButton
     */
    public boolean getChecked(){
        return getPolymerElement().getChecked();
    }
    /**
     * 
Gets or sets the state, true is checked and false is unchecked.
     *
     * JavaScript Info:
     * @property checked
     * @type Boolean
     * @behavior PaperToggleButton
     */
    public void setChecked(boolean value) {
        getPolymerElement().setChecked(value);
    }
   
  

  
    /**
     * 
 Overriden from Polymer.IronFormElementBehavior 
     *
     * JavaScript Info:
     * @property value
     * @type String
     * @behavior PaperToggleButton
     */
    public String getValue(){
        return getPolymerElement().getValue();
    }
    /**
     * 
 Overriden from Polymer.IronFormElementBehavior 
     *
     * JavaScript Info:
     * @property value
     * @type String
     * @behavior PaperToggleButton
     */
    public void setValue(String value) {
        getPolymerElement().setValue(value);
    }
   
  

  
    /**
     * 
The name of this element.
     *
     * JavaScript Info:
     * @property name
     * @type String
     * @behavior PaperInput
     */
    public String getName(){
        return getPolymerElement().getName();
    }
    /**
     * 
The name of this element.
     *
     * JavaScript Info:
     * @property name
     * @type String
     * @behavior PaperInput
     */
    public void setName(String value) {
        getPolymerElement().setName(value);
    }
   
  

  
    /**
     * 
Set to true to mark the input as required. If used in a form, a
custom element that uses this behavior should also use
Polymer.IronValidatableBehavior and define a custom validation method.
Otherwise, a required element will always be considered valid.
It’s also strongly recomended to provide a visual style for the element
when it’s value is invalid.
     *
     * JavaScript Info:
     * @property required
     * @type Boolean
     * @behavior PaperInput
     */
    public boolean getRequired(){
        return getPolymerElement().getRequired();
    }
    /**
     * 
Set to true to mark the input as required. If used in a form, a
custom element that uses this behavior should also use
Polymer.IronValidatableBehavior and define a custom validation method.
Otherwise, a required element will always be considered valid.
It’s also strongly recomended to provide a visual style for the element
when it’s value is invalid.
     *
     * JavaScript Info:
     * @property required
     * @type Boolean
     * @behavior PaperInput
     */
    public void setRequired(boolean value) {
        getPolymerElement().setRequired(value);
    }
   
  

  
    /**
     * 
     *
     * JavaScript Info:
     * @method hasValidator
     * @behavior PaperToggleButton
     */
    public void hasValidator() {
        getPolymerElement().hasValidator();
    }
  

  
    /**
     * 
True if the last call to validate is invalid.
     *
     * JavaScript Info:
     * @property invalid
     * @type Boolean
     * @behavior PaperToggleButton
     */
    public boolean getInvalid(){
        return getPolymerElement().getInvalid();
    }
    /**
     * 
True if the last call to validate is invalid.
     *
     * JavaScript Info:
     * @property invalid
     * @type Boolean
     * @behavior PaperToggleButton
     */
    public void setInvalid(boolean value) {
        getPolymerElement().setInvalid(value);
    }
   
  

  
    /**
     * 
Returns true if the value is valid, and updates invalid. If you want
your element to have custom validation logic, do not override this method;
override _getValidity(value) instead.
     *
     * JavaScript Info:
     * @method validate
     * @param {Object} value  
     * @behavior PaperToggleButton
     */
    public void validate(JavaScriptObject value) {
        getPolymerElement().validate(value);
    }
  

  
    /**
     * 
Name of the validator to use.
     *
     * JavaScript Info:
     * @property validator
     * @type String
     * @behavior PaperToggleButton
     */
    public String getValidator(){
        return getPolymerElement().getValidator();
    }
    /**
     * 
Name of the validator to use.
     *
     * JavaScript Info:
     * @property validator
     * @type String
     * @behavior PaperToggleButton
     */
    public void setValidator(String value) {
        getPolymerElement().setValidator(value);
    }
   
  

  
    /**
     * 
Namespace for this validator.
     *
     * JavaScript Info:
     * @property validatorType
     * @type String
     * @behavior PaperToggleButton
     */
    public String getValidatorType(){
        return getPolymerElement().getValidatorType();
    }
    /**
     * 
Namespace for this validator.
     *
     * JavaScript Info:
     * @property validatorType
     * @type String
     * @behavior PaperToggleButton
     */
    public void setValidatorType(String value) {
        getPolymerElement().setValidatorType(value);
    }
   
  


    /**
     * 
Fired when the checked state changes due to user interaction.
     *
     * JavaScript Info:
     * @event change
     */
    public HandlerRegistration addChangeHandler(ChangeEventHandler handler) {
        return addHandler(handler, ChangeEvent.TYPE);
    }

    /**
     * 
Fired when the checked state changes.
     *
     * JavaScript Info:
     * @event iron-change
     */
    public HandlerRegistration addIronChangeHandler(IronChangeEventHandler handler) {
        return addHandler(handler, IronChangeEvent.TYPE);
    }

    /**
     * 
Fired when the element is added to an iron-form.
     *
     * JavaScript Info:
     * @event iron-form-element-register
     */
    public HandlerRegistration addIronFormElementRegisterHandler(IronFormElementRegisterEventHandler handler) {
        return addHandler(handler, IronFormElementRegisterEvent.TYPE);
    }

    /**
     * 
Fired when the element is removed from an iron-form.
     *
     * JavaScript Info:
     * @event iron-form-element-unregister
     */
    public HandlerRegistration addIronFormElementUnregisterHandler(IronFormElementUnregisterEventHandler handler) {
        return addHandler(handler, IronFormElementUnregisterEvent.TYPE);
    }

}