View Javadoc

1   /**
2    * This file Copyright (c) 2010-2013 Magnolia International
3    * Ltd.  (http://www.magnolia-cms.com). All rights reserved.
4    *
5    *
6    * This file is dual-licensed under both the Magnolia
7    * Network Agreement and the GNU General Public License.
8    * You may elect to use one or the other of these licenses.
9    *
10   * This file is distributed in the hope that it will be
11   * useful, but AS-IS and WITHOUT ANY WARRANTY; without even the
12   * implied warranty of MERCHANTABILITY or FITNESS FOR A
13   * PARTICULAR PURPOSE, TITLE, or NONINFRINGEMENT.
14   * Redistribution, except as permitted by whichever of the GPL
15   * or MNA you select, is prohibited.
16   *
17   * 1. For the GPL license (GPL), you can redistribute and/or
18   * modify this file under the terms of the GNU General
19   * Public License, Version 3, as published by the Free Software
20   * Foundation.  You should have received a copy of the GNU
21   * General Public License, Version 3 along with this program;
22   * if not, write to the Free Software Foundation, Inc., 51
23   * Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
24   *
25   * 2. For the Magnolia Network Agreement (MNA), this file
26   * and the accompanying materials are made available under the
27   * terms of the MNA which accompanies this distribution, and
28   * is available at http://www.magnolia-cms.com/mna.html
29   *
30   * Any modifications to this file must keep this entire header
31   * intact.
32   *
33   */
34  package info.magnolia.ui.vaadin.icon;
35  
36  import info.magnolia.ui.vaadin.gwt.client.icon.connector.IconState;
37  
38  import com.vaadin.ui.AbstractComponent;
39  
40  /**
41   * The Icon is a lightweight component that outputs a simple scalable icon. The client-side
42   * implementation is based on the icon font technique, which means it only allows for monochromatic
43   * icons. For multilayer icons, please head to the CompositeIcon.
44   */
45  public class Icon extends AbstractComponent {
46  
47      public transient static final String COLOR_ERROR = "#9a3332";
48  
49      public transient static final String COLOR_WARNING = "#ffbf28";
50  
51      public transient static final String COLOR_INFO = "#999";
52  
53      public transient static final String COLOR_GREEN_BADGE = "#689600";
54  
55      public transient static final String COLOR_HELP = "#4b8e9e";
56  
57      public transient static final int SIZE_DEFAULT = 24;
58  
59      public Icon(String iconName) {
60          this(iconName, SIZE_DEFAULT);
61      }
62  
63      public Icon(String iconName, int size) {
64          this(iconName, size, null);
65      }
66  
67      public Icon(String iconName, String color) {
68          this(iconName, SIZE_DEFAULT, color);
69      }
70  
71      public Icon(String iconName, int size, String color) {
72          setIconName(iconName);
73          setSize(size);
74          setColor(color);
75      }
76  
77      @Override
78      protected IconState getState(boolean markDirty) {
79          return (IconState) super.getState(markDirty);
80      }
81  
82      @Override
83      protected IconState getState() {
84          return (IconState) super.getState();
85      }
86  
87      public String getIconName() {
88          return getState(false).iconName;
89      }
90  
91      public void setIconName(String iconName) {
92          getState().iconName = iconName;
93      }
94  
95      public int getSize() {
96          return getState(false).size;
97      }
98  
99      public void setSize(int size) {
100         getState().size = size;
101     }
102 
103     public String getColor() {
104         return getState(false).color;
105     }
106 
107     public void setColor(String color) {
108         getState().color = color;
109     }
110 
111 }