com.vaadin.polymer.app.AppRouteConverterBehavior 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-route project by The Polymer Authors
 * that is licensed with http://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;


/**
 * Provides bidirectional mapping between path and queryParams and a
app-route compatible route object.
 * For more information, see the docs for app-route-converter.
 */
@JsType(isNative=true)
public interface AppRouteConverterBehavior {

    @JsOverlay public static final String NAME = "Polymer.AppRouteConverterBehavior";
    @JsOverlay public static final String SRC = "app-route/app-route-converter.html";


    /**
     * A set of key/value pairs that are universally accessible to branches of
the route tree.
     *
     * JavaScript Info:
     * @property queryParams
     * @type ?Object
     * 
     */
    @JsProperty JavaScriptObject getQueryParams();
    /**
     * A set of key/value pairs that are universally accessible to branches of
the route tree.
     *
     * JavaScript Info:
     * @property queryParams
     * @type ?Object
     * 
     */
    @JsProperty void setQueryParams(JavaScriptObject value);

    /**
     * A model representing the deserialized path through the route tree, as
well as the current queryParams.
     * A route object is the kernel of the routing system. It is intended to
be fed into consuming elements such as app-route.
     *
     * JavaScript Info:
     * @property route
     * @type ?Object
     * 
     */
    @JsProperty JavaScriptObject getRoute();
    /**
     * A model representing the deserialized path through the route tree, as
well as the current queryParams.
     * A route object is the kernel of the routing system. It is intended to
be fed into consuming elements such as app-route.
     *
     * JavaScript Info:
     * @property route
     * @type ?Object
     * 
     */
    @JsProperty void setRoute(JavaScriptObject value);

    /**
     * The serialized path through the route tree. This corresponds to the
window.location.pathname value, and will update to reflect changes
to that value.
     *
     * JavaScript Info:
     * @property path
     * @type String
     * 
     */
    @JsProperty String getPath();
    /**
     * The serialized path through the route tree. This corresponds to the
window.location.pathname value, and will update to reflect changes
to that value.
     *
     * JavaScript Info:
     * @property path
     * @type String
     * 
     */
    @JsProperty void setPath(String value);


}