com.sencha.gxt.widget.core.client.toolbar.LabelToolItem.java Source code

Introduction

Here is the source code for com.sencha.gxt.widget.core.client.toolbar.LabelToolItem.java

Source

/**
 * Sencha GXT 4.0.0 - Sencha for GWT
 * Copyright (c) 2006-2015, Sencha Inc.
 *
 * licensing@sencha.com
 * http://www.sencha.com/products/gxt/license/
 *
 * ================================================================================
 * Open Source License
 * ================================================================================
 * This version of Sencha GXT is licensed under the terms of the Open Source GPL v3
 * license. You may use this license only if you are prepared to distribute and
 * share the source code of your application under the GPL v3 license:
 * http://www.gnu.org/licenses/gpl.html
 *
 * If you are NOT prepared to distribute and share the source code of your
 * application under the GPL v3 license, other commercial and oem licenses
 * are available for an alternate download of Sencha GXT.
 *
 * Please see the Sencha GXT Licensing page at:
 * http://www.sencha.com/products/gxt/license/
 *
 * For clarification or additional options, please contact:
 * licensing@sencha.com
 * ================================================================================
 *
 *
 * ================================================================================
 * Disclaimer
 * ================================================================================
 * THIS SOFTWARE IS DISTRIBUTED "AS-IS" WITHOUT ANY WARRANTIES, CONDITIONS AND
 * REPRESENTATIONS WHETHER EXPRESS OR IMPLIED, INCLUDING WITHOUT LIMITATION THE
 * IMPLIED WARRANTIES AND CONDITIONS OF MERCHANTABILITY, MERCHANTABLE QUALITY,
 * FITNESS FOR A PARTICULAR PURPOSE, DURABILITY, NON-INFRINGEMENT, PERFORMANCE AND
 * THOSE ARISING BY STATUTE OR FROM CUSTOM OR USAGE OF TRADE OR COURSE OF DEALING.
 * ================================================================================
 */
package com.sencha.gxt.widget.core.client.toolbar;

import com.google.gwt.core.client.GWT;
import com.google.gwt.dom.client.Element;
import com.google.gwt.safehtml.shared.SafeHtml;
import com.google.gwt.safehtml.shared.SafeHtmlBuilder;
import com.google.gwt.safehtml.shared.SafeHtmlUtils;
import com.sencha.gxt.core.client.dom.XDOM;
import com.sencha.gxt.widget.core.client.Component;

/**
 * A label tool item.
 */
public class LabelToolItem extends Component {

    public interface LabelToolItemAppearance {
        void render(SafeHtmlBuilder sb);
    }

    private SafeHtml label = SafeHtmlUtils.EMPTY_SAFE_HTML;
    private final LabelToolItemAppearance appearance;

    /**
     * Creates a new label.
     */
    public LabelToolItem() {
        this(GWT.<LabelToolItemAppearance>create(LabelToolItemAppearance.class));
    }

    public LabelToolItem(LabelToolItemAppearance appearance) {
        this.appearance = appearance;

        SafeHtmlBuilder markupBuilder = new SafeHtmlBuilder();
        this.appearance.render(markupBuilder);

        setElement((Element) XDOM.create(markupBuilder.toSafeHtml()));
    }

    /**
     * Creates a new label as text.
     *
     * Text that contains reserved html characters will be escaped.
     * 
     * @param text the label text
     */
    public LabelToolItem(String text) {
        this();
        setLabel(text);
    }

    /**
     * Creates a new label as html.
     *
     * @param html the label html
     */
    public LabelToolItem(SafeHtml html) {
        this();
        setLabel(html);
    }

    public LabelToolItemAppearance getAppearance() {
        return appearance;
    }

    /**
     * Returns the item's label.
     * 
     * @return the label
     */
    public SafeHtml getLabel() {
        return label;
    }

    /**
     * Sets the item's label as text.
     *
     * Text that contains reserved html characters will be escaped.
     * 
     * @param text the label text
     */
    public void setLabel(String text) {
        setLabel(SafeHtmlUtils.fromString(text));
    }

    /**
     * Sets the item's label as html.
     *
     * @param html the label html
     */
    public void setLabel(SafeHtml html) {
        this.label = html;
        getElement().setInnerSafeHtml(html);
    }

}