com.vaadin.polymer.iron.IronLabelElement 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-label 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;

/**
 * <iron-label> provides a version of the <label> element that works with Custom Elements as well as native elements.
 * All text in the iron-label will be applied to the target element as a screen-reader accessible description.
 * There are three ways to use iron-label to target an element:
 * 
 * place an element inside iron-label and some text:
 * <iron-label>
 *   Label for the Button
 *   <paper-button>button</paper-button>
 * </iron-label>
 * 
 * 
 * place some elements inside iron-label and target one with the iron-label-target attribute.
The other elements will provide the label for that element
Note: This is not necessary if the element you want to label is the first
element child of iron-label:
 * <iron-label>
 *   <span>Label for the Button</span>
 *   <paper-button iron-label-target>button</paper-button>
 * </iron-label>
 * 
 * <iron-label>
 *   <paper-button>button</paper-button>
 *   <span>Label for the Button</span>
 * </iron-label>
 * 
 * 
 * Set the for attribute on the iron-label element with the id of the target
element in the same document or ShadowRoot:
 * <iron-label for="foo">
 *   Context for the button with the "foo" class"
 * </iron-label>
 * <paper-button id="foo">Far away button</paper-button>
 * 
 * 
 * 
 * 
 * All taps on the iron-label will be forwarded to the “target” element.
 */
@JsType(isNative=true)
public interface IronLabelElement extends HTMLElement {

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


    /**
     * An ID reference to another element that needs to be
labelled by this iron-label element.
     *
     * JavaScript Info:
     * @property for
     * @type String
     * 
     */
    @JsProperty String getFor();
    /**
     * An ID reference to another element that needs to be
labelled by this iron-label element.
     *
     * JavaScript Info:
     * @property for
     * @type String
     * 
     */
    @JsProperty void setFor(String value);


}