• Home
• com.vaadin.polymer
• vaadin-gwt-polymer-elements
• 1.0.2.0-alpha2
• source code
• IronOverlayBackdropElement.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.iron.element.IronOverlayBackdropElement Maven / Gradle / Ivy

/*
 * This code was generated with Vaadin Web Component GWT API Generator, 
 * from iron-overlay-behavior project by The Polymer Authors
 * that is licensed with http://polymer.github.io/LICENSE.txt license.
 */
package com.vaadin.polymer.iron.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;

/**
 * 
iron-overlay-backdrop is a backdrop used by Polymer.IronOverlayBehavior. It should be a
singleton.
 * 
Styling
 * 
The following custom properties and mixins are available for styling.
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
Custom property
Description
Default
--iron-overlay-backdrop-background-color
Backdrop background color
#000
--iron-overlay-backdrop-opacity
Backdrop opacity
0.6
--iron-overlay-backdrop
Mixin applied to iron-overlay-backdrop.
{}
--iron-overlay-backdrop-opened
Mixin applied to iron-overlay-backdrop when it is displayed
{}
 */
@JsType
public interface IronOverlayBackdropElement extends HTMLElement {

    public static final String TAG = "iron-overlay-backdrop";
    public static final String SRC = "iron-overlay-behavior/iron-overlay-behavior.html";


    /**
     * 
Hides the backdrop if needed.
     *
     * JavaScript Info:
     * @method close
     * 
     */
    void close();

    /**
     * 
Removes the backdrop from document body if needed.
     *
     * JavaScript Info:
     * @method complete
     * 
     */
    void complete();

    /**
     * 
Shows the backdrop if needed.
     *
     * JavaScript Info:
     * @method open
     * 
     */
    void open();

    /**
     * 
Returns true if the backdrop is opened.
     *
     * JavaScript Info:
     * @property opened
     * @type Boolean
     * 
     */
    @JsProperty boolean getOpened();
    /**
     * 
Returns true if the backdrop is opened.
     *
     * JavaScript Info:
     * @property opened
     * @type Boolean
     * 
     */
    @JsProperty void setOpened(boolean value);
  
    /**
     * 
Appends the backdrop to document body and sets its z-index to be below the latest overlay.
     *
     * JavaScript Info:
     * @method prepare
     * 
     */
    void prepare();

}