com.vaadin.polymer.iron.IronDocPropertyElement 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-doc-viewer 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;

/**
 * Renders documentation describing a specific property of an element.
 * Give it a hydrolysis PropertyDescriptor (via descriptor), and watch it go!
 */
@JsType(isNative=true)
public interface IronDocPropertyElement extends HTMLElement {

    @JsOverlay public static final String TAG = "iron-doc-property";
    @JsOverlay public static final String SRC = "iron-doc-viewer/iron-doc-viewer.html";


    /**
     * Whether the property should show a one-liner, or full summary.
     * Note that this property is reflected as an attribute, but we perform
the reflection manually. In order to support the CSS transitions, we
must calculate the element height before setting the attribute.
     *
     * JavaScript Info:
     * @property collapsed
     * @type Boolean
     * 
     */
    @JsProperty boolean getCollapsed();
    /**
     * Whether the property should show a one-liner, or full summary.
     * Note that this property is reflected as an attribute, but we perform
the reflection manually. In order to support the CSS transitions, we
must calculate the element height before setting the attribute.
     *
     * JavaScript Info:
     * @property collapsed
     * @type Boolean
     * 
     */
    @JsProperty void setCollapsed(boolean value);

    /**
     * The Hydrolysis-generated
element descriptor to display details for.
     * Alternatively, the element descriptor can be provided as JSON via the text content
of this element.
     *
     * JavaScript Info:
     * @property descriptor
     * @type hydrolysis.PropertyDescriptor
     * 
     */
    @JsProperty JavaScriptObject getDescriptor();
    /**
     * The Hydrolysis-generated
element descriptor to display details for.
     * Alternatively, the element descriptor can be provided as JSON via the text content
of this element.
     *
     * JavaScript Info:
     * @property descriptor
     * @type hydrolysis.PropertyDescriptor
     * 
     */
    @JsProperty void setDescriptor(JavaScriptObject value);

    /**
     * Unique anchor ID for deep-linking.
     *
     * JavaScript Info:
     * @property anchorId
     * @type String
     * 
     */
    @JsProperty String getAnchorId();
    /**
     * Unique anchor ID for deep-linking.
     *
     * JavaScript Info:
     * @property anchorId
     * @type String
     * 
     */
    @JsProperty void setAnchorId(String value);


}