com.vaadin.polymer.paper.PaperDialogBehavior Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of vaadin-gwt-polymer-elements Show documentation
vaadin-gwt-polymer-elements
The newest version!
/*
 * This code was generated with Vaadin Web Component GWT API Generator, 
 * from paper-dialog-behavior project by The Polymer Authors
 * that is licensed with http://polymer.github.io/LICENSE.txt license.
 */
package com.vaadin.polymer.paper;

import com.vaadin.polymer.elemental.*;
import com.google.gwt.core.client.JavaScriptObject;
import com.google.gwt.core.client.JsArray;
import jsinterop.annotations.JsOverlay;
import jsinterop.annotations.JsProperty;
import jsinterop.annotations.JsType;


/**
 * Use Polymer.PaperDialogBehavior and paper-dialog-shared-styles.html to implement a Material Design
dialog.
 * For example, if <paper-dialog-impl> implements this behavior:
 * <paper-dialog-impl>
 *     <h2>Header</h2>
 *     <div>Dialog body</div>
 *     <div class="buttons">
 *         <paper-button dialog-dismiss>Cancel</paper-button>
 *         <paper-button dialog-confirm>Accept</paper-button>
 *     </div>
 * </paper-dialog-impl>
 * 
 * 
 * 
paper-dialog-shared-styles.html provide styles for a header, content area, and an action area for buttons.
Use the <h2> tag for the header and the buttons class for the action area. You can use the
paper-dialog-scrollable element (in its own repository) if you need a scrolling content area.
 * Use the dialog-dismiss and dialog-confirm attributes on interactive controls to close the
dialog. If the user dismisses the dialog with dialog-confirm, the closingReason will update
to include confirmed: true.
 * Accessibility
 * This element has role="dialog" by default. Depending on the context, it may be more appropriate
to override this attribute with role="alertdialog".
 * If modal is set, the element will prevent the focus from exiting the element.
It will also ensure that focus remains in the dialog.
 */
@JsType(isNative=true)
public interface PaperDialogBehavior {

    @JsOverlay public static final String NAME = "Polymer.PaperDialogBehavior";
    @JsOverlay public static final String SRC = "paper-dialog-behavior/paper-dialog-behavior.html";


    /**
     * If modal is true, this implies no-cancel-on-outside-click, no-cancel-on-esc-key and with-backdrop.
     *
     * JavaScript Info:
     * @property modal
     * @type Boolean
     * @behavior PaperDialog
     */
    @JsProperty boolean getModal();
    /**
     * If modal is true, this implies no-cancel-on-outside-click, no-cancel-on-esc-key and with-backdrop.
     *
     * JavaScript Info:
     * @property modal
     * @type Boolean
     * @behavior PaperDialog
     */
    @JsProperty void setModal(boolean value);


}