com.vaadin.polymer.app.AppHeaderLayoutElement 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 app-layout project by The Polymer Authors
 * that is licensed with https://polymer.github.io/LICENSE.txt license.
 */
package com.vaadin.polymer.app;

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;

/**
 * app-header-layout is a wrapper element that positions an app-header and other content. This
element uses the document scroll by default, but it can also define its own scrolling region.
 * Using the document scroll:
 * <app-header-layout>
 *   <app-header fixed condenses effects="waterfall">
 *     <app-toolbar>
 *       <div main-title>App name</div>
 *     </app-toolbar>
 *   </app-header>
 *   <div>
 *     main content
 *   </div>
 * </app-header-layout>
 * 
 * Using an own scrolling region:
 * <app-header-layout has-scrolling-region style="width: 300px; height: 400px;">
 *   <app-header fixed condenses effects="waterfall">
 *     <app-toolbar>
 *       <div main-title>App name</div>
 *     </app-toolbar>
 *   </app-header>
 *   <div>
 *     main content
 *   </div>
 * </app-header-layout>
 * 
 * Add the fullbleed attribute to app-header-layout to make it fit the size of its container:
 * <app-header-layout fullbleed>
 *  ...
 * </app-header-layout>
 * 
 */
@JsType(isNative=true)
public interface AppHeaderLayoutElement extends HTMLElement {

    @JsOverlay public static final String TAG = "app-header-layout";
    @JsOverlay public static final String SRC = "app-layout/app-layout.html";


    /**
     * If true, the current element will have its own scrolling region.
Otherwise, it will use the document scroll to control the header.
     *
     * JavaScript Info:
     * @property hasScrollingRegion
     * @type Boolean
     * 
     */
    @JsProperty boolean getHasScrollingRegion();
    /**
     * If true, the current element will have its own scrolling region.
Otherwise, it will use the document scroll to control the header.
     *
     * JavaScript Info:
     * @property hasScrollingRegion
     * @type Boolean
     * 
     */
    @JsProperty void setHasScrollingRegion(boolean value);


    /**
     * 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 VaadinSplitLayout
     * 
     */
    void stopResizeNotificationsFor(Object target);

    /**
     * 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 VaadinSplitLayout
     * 
     */
    void assignParentResizable(Object parentResizable);

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

    /**
     * Resets the layout. This method is automatically called when the element is attached
to the DOM.
     *
     * JavaScript Info:
     * @method resetLayout
     * 
     * 
     */
    void resetLayout();

    /**
     * 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 VaadinSplitLayout
     * @return {boolean}
     */
    boolean resizerShouldNotify(JavaScriptObject element);

}