com.vaadin.polymer.iron.element.IronSignalsElement 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

There is a newer version: 1.9.3.1

Show newest version

/*
 * This code was generated with Vaadin Web Component GWT API Generator, 
 * from iron-signals 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-signals provides basic publish-subscribe functionality.
 * Note: avoid using iron-signals whenever you can use
a controller (parent element) to mediate communication
instead.
 * To send a signal, fire a custom event of type iron-signal, with
a detail object containing name and data fields.
 * this.fire('iron-signal', {name: 'hello', data: null});
 * 
 * 
 * 
To receive a signal, listen for iron-signal-<name> event on a
iron-signals element.
 *   
 * 
 * You can fire a signal event from anywhere, and all
iron-signals elements will receive the event, regardless
of where they are in DOM.
 */
@JsType
public interface IronSignalsElement extends HTMLElement {

    public static final String TAG = "iron-signals";
    public static final String SRC = "iron-signals/iron-signals.html";


    /**
     * 
     *
     * JavaScript Info:
     * @method attached
     * 
     */
    void attached();

    /**
     * 
     *
     * JavaScript Info:
     * @method detached
     * 
     */
    void detached();

}