com.vaadin.polymer.iron.IronScrollTargetBehavior 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 iron-scroll-target-behavior project by The Polymer Authors
 * that is licensed with http://polymer.github.io/LICENSE.txt license.
 */
package com.vaadin.polymer.iron;

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;


/**
 * Polymer.IronScrollTargetBehavior allows an element to respond to scroll events from a
designated scroll target.
 * Elements that consume this behavior can override the _scrollHandler
method to add logic on the scroll event.
 */
@JsType(isNative=true)
public interface IronScrollTargetBehavior {

    @JsOverlay public static final String NAME = "Polymer.IronScrollTargetBehavior";
    @JsOverlay public static final String SRC = "iron-scroll-target-behavior/iron-scroll-target-behavior.html";


    /**
     * Specifies the element that will handle the scroll event
on the behalf of the current element. This is typically a reference to an element,
but there are a few more posibilities:
     * Elements id
     * <div id="scrollable-element" style="overflow: auto;">
     *  <x-element scroll-target="scrollable-element">
     *    <!-- Content-->
     *  </x-element>
     * </div>
     * 
     * In this case, the scrollTarget will point to the outer div element.
     * Document scrolling
     * For document scrolling, you can use the reserved word document:
     * <x-element scroll-target="document">
     *   <!-- Content -->
     * </x-element>
     * 
     * Elements reference
     * appHeader.scrollTarget = document.querySelector('#scrollable-element');
     * 
     *
     * JavaScript Info:
     * @property scrollTarget
     * @type Element
     * @behavior IronScrollThreshold
     */
    @JsProperty Element getScrollTarget();
    /**
     * Specifies the element that will handle the scroll event
on the behalf of the current element. This is typically a reference to an element,
but there are a few more posibilities:
     * Elements id
     * <div id="scrollable-element" style="overflow: auto;">
     *  <x-element scroll-target="scrollable-element">
     *    <!-- Content-->
     *  </x-element>
     * </div>
     * 
     * In this case, the scrollTarget will point to the outer div element.
     * Document scrolling
     * For document scrolling, you can use the reserved word document:
     * <x-element scroll-target="document">
     *   <!-- Content -->
     * </x-element>
     * 
     * Elements reference
     * appHeader.scrollTarget = document.querySelector('#scrollable-element');
     * 
     *
     * JavaScript Info:
     * @property scrollTarget
     * @type Element
     * @behavior IronScrollThreshold
     */
    @JsProperty void setScrollTarget(Element value);


    /**
     * Enables or disables the scroll event listener.
     *
     * JavaScript Info:
     * @method toggleScrollListener
     * @param {boolean} yes  
     * @behavior IronScrollThreshold
     * 
     */
    void toggleScrollListener(boolean yes);

    /**
     * Scrolls the content to a particular place.
     *
     * JavaScript Info:
     * @method scroll
     * @param {number} left  
     * @param {number} top  
     * @behavior IronScrollThreshold
     * 
     */
    void scroll(double left, double top);

}