com.vaadin.polymer.paper.widget.PaperDialogScrollable 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-scrollable 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.*;

import com.vaadin.polymer.*;
import com.vaadin.polymer.elemental.*;
import com.vaadin.polymer.PolymerWidget;
import com.google.gwt.core.client.JsArray;
import com.google.gwt.event.shared.HandlerRegistration;
import com.google.gwt.core.client.JavaScriptObject;

/**
 * Material design: Dialogs
 * paper-dialog-scrollable implements a scrolling area used in a Material Design dialog. It shows
a divider at the top and/or bottom indicating more content, depending on scroll position. Use this
together with elements implementing Polymer.PaperDialogBehavior.
 * <paper-dialog-impl>
 *   <h2>Header</h2>
 *   <paper-dialog-scrollable>
 *     Lorem ipsum...
 *   </paper-dialog-scrollable>
 *   <div class="buttons">
 *     <paper-button>OK</paper-button>
 *   </div>
 * </paper-dialog-impl>
 * 
 * 
 * 
It shows a top divider after scrolling if it is not the first child in its parent container,
indicating there is more content above. It shows a bottom divider if it is scrollable and it is not
the last child in its parent container, indicating there is more content below. The bottom divider
is hidden if it is scrolled to the bottom.
 * If paper-dialog-scrollable is not a direct child of the element implementing Polymer.PaperDialogBehavior,
remember to set the dialogElement:
 * <paper-dialog-impl id="myDialog">
 *   <h2>Header</h2>
 *   <div class="my-content-wrapper">
 *     <h4>Sub-header</h4>
 *     <paper-dialog-scrollable>
 *       Lorem ipsum...
 *     </paper-dialog-scrollable>
 *   </div>
 *   <div class="buttons">
 *     <paper-button>OK</paper-button>
 *   </div>
 * </paper-dialog-impl>
 * 
 * <script>
 *   var scrollable = Polymer.dom(myDialog).querySelector('paper-dialog-scrollable');
 *   scrollable.dialogElement = myDialog;
 * </script>
 * 
 * 
 * 
Styling
 * The following custom properties and mixins are available for styling:
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * Custom property Description Default
--paper-dialog-scrollable Mixin for the scrollable content {}
 */
public class PaperDialogScrollable extends PolymerWidget {
    /**
     * Default Constructor.
     */
    public PaperDialogScrollable() {
       this("");
    }

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

    /**
     * Gets a handle to the Polymer object's underlying DOM element.
     */
    public PaperDialogScrollableElement getPolymerElement() {
        return (PaperDialogScrollableElement) getElement();
    }


    /**
     * The dialog element that implements Polymer.PaperDialogBehavior containing this element.
     *
     * JavaScript Info:
     * @property dialogElement
     * @type ?Node
     * 
     */
    public JavaScriptObject getDialogElement() {
        return getPolymerElement().getDialogElement();
    }
    /**
     * The dialog element that implements Polymer.PaperDialogBehavior containing this element.
     *
     * JavaScript Info:
     * @property dialogElement
     * @type ?Node
     * 
     */
    public void setDialogElement(JavaScriptObject value) {
        getPolymerElement().setDialogElement(value);
    }


    // Needed in UIBinder
    /**
     * The dialog element that implements Polymer.PaperDialogBehavior containing this element.
     *
     * JavaScript Info:
     * @attribute dialog-element
     * 
     */
    public void setDialogElement(String value) {
        Polymer.property(this.getPolymerElement(), "dialogElement", value);
    }



}