001/* 002 * Copyright 2012 GWT-Bootstrap 003 * 004 * Licensed under the Apache License, Version 2.0 (the "License"); 005 * you may not use this file except in compliance with the License. 006 * You may obtain a copy of the License at 007 * 008 * http://www.apache.org/licenses/LICENSE-2.0 009 * 010 * Unless required by applicable law or agreed to in writing, software 011 * distributed under the License is distributed on an "AS IS" BASIS, 012 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 013 * See the License for the specific language governing permissions and 014 * limitations under the License. 015 */ 016package com.github.gwtbootstrap.client.ui.base; 017 018import com.github.gwtbootstrap.client.ui.constants.BaseIconType; 019import com.github.gwtbootstrap.client.ui.constants.IconPosition; 020import com.github.gwtbootstrap.client.ui.constants.IconSize; 021import com.github.gwtbootstrap.client.ui.constants.IconType; 022 023/** 024 * Interface for widgets that have icons. 025 * 026 * @since 2.0.4.0 027 * 028 * @author Dominik Mayer 029 * 030 */ 031public interface HasIcon { 032 033 /** 034 * Sets the Type of the Icon. 035 * 036 * @param type 037 */ 038 public void setIcon(IconType type); 039 040 /** 041 * Sets the BaseType of the Icon. 042 * 043 * @param type 044 */ 045 public void setBaseIcon(BaseIconType type); 046 047 /** 048 * Sets the size of the icon. 049 * 050 * <p> 051 * Default is DEFAULT. 052 * 053 * @param size 054 * the new size. 055 */ 056 public void setIconSize(IconSize size); 057 058 /** 059 * Set custom icon style. 060 * <p> 061 * It sets css class name to {@literal <i>} tag. 062 * You can set any icons style. 063 * </p> 064 * 065 * @param customIconStyle 066 */ 067 public void setCustomIconStyle(String customIconStyle); 068 069 /** 070 * Set icon position , left or right 071 * @param position icon's position 072 */ 073 public void setIconPosition(IconPosition position); 074}