com.github.gwtbootstrap.client.ui.Icon Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of gwt-bootstrap Show documentation
A GWT Library that provides the widgets of Twitter Bootstrap.
There is a newer version: 2.3.2.0
/*
 *  Copyright 2012 GWT-Bootstrap
 *
 *  Licensed under the Apache License, Version 2.0 (the "License");
 *  you may not use this file except in compliance with the License.
 *  You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 *  Unless required by applicable law or agreed to in writing, software
 *  distributed under the License is distributed on an "AS IS" BASIS,
 *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *  See the License for the specific language governing permissions and
 *  limitations under the License.
 */
package com.github.gwtbootstrap.client.ui;

import com.github.gwtbootstrap.client.ui.base.StyleHelper;
import com.github.gwtbootstrap.client.ui.constants.BaseIconType;
import com.github.gwtbootstrap.client.ui.constants.IconSize;
import com.github.gwtbootstrap.client.ui.constants.IconType;
import com.google.gwt.uibinder.client.UiConstructor;
import com.google.gwt.user.client.DOM;
import com.google.gwt.user.client.ui.Widget;

//@formatter:off

/**
 * Widget with a black or white icon.
 * 
 * The icons are provided by Glyphicons
 * and Font Awesome.
 *
 * 

 * 

 * 
UiBinder Usage:
 * 
 * 
 * {@code
 * 
 * }
 * 
 * 
 *
 * @author Carlos Alexandro Becker
 * @author Dominik Mayer
 * @see Bootstrap documentation
 * @see Font Awesome page
 * @since 2.0.4.0
 */
//@formatter:on
public class Icon extends Widget {

    private BaseIconType type;

    /**
     * Creates a widget but doesn't set an icon yet.
     * 
     * (This is probably not what you want to do most of the time.)
     */
    public Icon() {
        setElement(DOM.createElement("i"));
    }

    /**
     * Creates a black icon of given type.
     *
     * @param type the icon type
     */
    @UiConstructor
    public Icon(IconType type) {
        this();
        setBaseType(type);
    }

    /**
     * Sets the icon type.
     *
     * @param type the icon type
     */
    public void setType(IconType type) {
        setBaseType(type);
    }

    /**
     * Sets the base icon type.
     *
     * @param type the icon type
     */
    public void setBaseType(BaseIconType type) {
        if(this.type != null) {
            StyleHelper.removeStyle(this, this.type);
        }
        this.type = type;
        StyleHelper.addStyle(this, type);
    }

    /**
     * Sets the icon size.
     *
     * @param size the icon size
     */
    public void setIconSize(IconSize size) {
        StyleHelper.changeStyle(this, size, IconSize.class);
    }
    
    /**
     * Get the icon type
     * 
     * @return icon type, or null, if the Icon is no instance of {@link IconType}
     */
    public IconType getIconType() {
        if(type instanceof IconType) {
            return (IconType) type;
        }
        return null;
    }

    /**
     * Get the base icon type
     *
     * @return base icon type
     */
    public BaseIconType getBaseIconType() {
        return type;
    }

    /**
     * Sets the base icon type.
     *
     * @param type the base icon type
     */
    public void setIcon(IconType type) {
        setBaseType(type);
    }
}