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

/*
 * This code was generated with Vaadin Web Component GWT API Generator, 
 * from paper-badge 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;

/**
 * 
<paper-badge> is a circular text badge that is displayed on the top right
corner of an element, representing a status or a notification. It will badge
the anchor element specified in the for attribute, or, if that doesn’t exist,
centered to the parent node containing it.
 * 
Example:
 * 
<div style="display:inline-block">
 *   <span>Inbox</span>
 *   <paper-badge label="3"></paper-badge>
 * </div>
 * 
 * <div>
 *   <paper-button id="btn">Status</button>
 *   <paper-badge for="btn" label="♥︎">b/paper-badge>
 * </div>
 * 
 * 
 * 
Styling
 * 
The following custom properties and mixins are available for styling:
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
Custom property
Description
Default
--paper-badge-background
The background color of the badge
--accent-color
--paper-badge-opacity
The opacity of the badge
1.0
--paper-badge-text-color
The color of the badge text
white
--paper-badge-width
The width of the badge circle
22px
--paper-badge-height
The height of the badge circle
22px
--paper-badge-margin-left
Optional spacing added to the left of the badge.
0px
--paper-badge-margin-bottom
TOptional spacing added to the bottom of the badge.
0px
--paper-badge
Mixin applied to the badge
{}
 */
@JsType
public interface PaperBadgeElement extends HTMLElement {

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


    /**
     * 
The id of the element that the badge is anchored to. This element
must be a sibling of the badge.
     *
     * JavaScript Info:
     * @property for
     * @type String
     * 
     */
    @JsProperty String getFor();
    /**
     * 
The id of the element that the badge is anchored to. This element
must be a sibling of the badge.
     *
     * JavaScript Info:
     * @property for
     * @type String
     * 
     */
    @JsProperty void setFor(String value);
  
    /**
     * 
The label displayed in the badge. The label is centered, and ideally
should have very few characters.
     *
     * JavaScript Info:
     * @property label
     * @type String
     * 
     */
    @JsProperty String getLabel();
    /**
     * 
The label displayed in the badge. The label is centered, and ideally
should have very few characters.
     *
     * JavaScript Info:
     * @property label
     * @type String
     * 
     */
    @JsProperty void setLabel(String value);
  
    /**
     * 
Returns the target element that this badge is anchored to. It is
either the element given by the for attribute, or the immediate parent
of the badge.
     *
     * JavaScript Info:
     * @method target
     * 
     */
    void target();

    /**
     * 
Repositions the badge relative to its anchor element. This is called
automatically when the badge is attached or an iron-resize event is
fired (for exmaple if the window has resized, or your target is a
custom element that implements IronResizableBehavior).
     * 
You should call this in all other cases when the achor’s position
might have changed (for example, if it’s visibility has changed, or
you’ve manually done a page re-layout).
     *
     * JavaScript Info:
     * @method updatePosition
     * 
     */
    void updatePosition();

    /**
     * 
     *
     * JavaScript Info:
     * @method attached
     * 
     */
    void attached();

    /**
     * 
     *
     * JavaScript Info:
     * @property listeners
     * @type Object
     * 
     */
    @JsProperty JavaScriptObject getListeners();
    /**
     * 
     *
     * JavaScript Info:
     * @property listeners
     * @type Object
     * 
     */
    @JsProperty void setListeners(JavaScriptObject value);
  
    /**
     * 
Used to assign the closest resizable ancestor to this resizable
if the ancestor detects a request for notifications.
     *
     * JavaScript Info:
     * @method assignParentResizable
     * @param {} parentResizable  
     * @behavior PaperTabs
     */
    void assignParentResizable(JavaScriptObject parentResizable);

    /**
     * 
Can be called to manually notify a resizable and its descendant
resizables of a resize change.
     *
     * JavaScript Info:
     * @method notifyResize
     * @behavior PaperTabs
     */
    void notifyResize();

    /**
     * 
This method can be overridden to filter nested elements that should or
should not be notified by the current element. Return true if an element
should be notified, or false if it should not be notified.
     *
     * JavaScript Info:
     * @method resizerShouldNotify
     * @param {HTMLElement} element  
     * @behavior PaperTabs
     */
    void resizerShouldNotify(JavaScriptObject element);

    /**
     * 
Used to remove a resizable descendant from the list of descendants
that should be notified of a resize change.
     *
     * JavaScript Info:
     * @method stopResizeNotificationsFor
     * @param {} target  
     * @behavior PaperTabs
     */
    void stopResizeNotificationsFor(JavaScriptObject target);

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

}