001/*
002 * #%L
003 * GwtMaterial
004 * %%
005 * Copyright (C) 2015 - 2017 GwtMaterialDesign
006 * %%
007 * Licensed under the Apache License, Version 2.0 (the "License");
008 * you may not use this file except in compliance with the License.
009 * You may obtain a copy of the License at
010 * 
011 *      http://www.apache.org/licenses/LICENSE-2.0
012 * 
013 * Unless required by applicable law or agreed to in writing, software
014 * distributed under the License is distributed on an "AS IS" BASIS,
015 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
016 * See the License for the specific language governing permissions and
017 * limitations under the License.
018 * #L%
019 */
020package gwt.material.design.client.base;
021
022import com.google.gwt.dom.client.Style;
023import gwt.material.design.client.constants.Color;
024import gwt.material.design.client.constants.IconPosition;
025import gwt.material.design.client.constants.IconSize;
026import gwt.material.design.client.constants.IconType;
027import gwt.material.design.client.ui.MaterialIcon;
028
029public interface HasIcon {
030
031    /**
032     * Get the icon widget.
033     */
034    MaterialIcon getIcon();
035
036    /**
037     * Set Material Design icon.
038     * @see <a href="//www.google.com/design/icons/">Material Design Icons</a>
039     */
040    void setIconType(IconType iconType);
041
042    /**
043     * Set the position of the icon.
044     */
045    void setIconPosition(IconPosition position);
046
047    /**
048     * Size of icon.
049     */
050    void setIconSize(IconSize size);
051
052    /**
053     * Set the font size of the icon.
054     */
055    void setIconFontSize(double size, Style.Unit unit);
056
057    /**
058     * Sets the color of the icon.
059     */
060    void setIconColor(Color iconColor);
061
062    /**
063     * Get the color of the icon
064     */
065    Color getIconColor();
066
067    /**
068     * Make the icon prefix in its container.
069     */
070    void setIconPrefix(boolean prefix);
071
072    /**
073     * Is the icon prefix in the container.
074     */
075    boolean isIconPrefix();
076}