1 /**
2 * This file Copyright (c) 2014-2018 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.gwt.client.form.widget;
35
36 import info.magnolia.ui.vaadin.gwt.client.icon.widget.IconWidget;
37
38 import com.google.gwt.dom.client.Style;
39 import com.google.gwt.user.client.DOM;
40 import com.google.gwt.user.client.Element;
41
42 /**
43 * This class is an {@code IconWidget} which can be toggled.
44 * It shows a "?" which indicates some help.
45 * <br/>
46 * Note, that there is no corresponding Vaadin-server-class available.
47 */
48 public class HelpIconWidget extends IconWidget {
49
50 private static final String CLASSNAME = "help-icon";
51 private static final String highlighted = "highlighted";
52 private static final String helpWithCircleClassName = "icon-help-l";
53
54 private Element innerSpan1 = DOM.createSpan();
55 private Element innerSpan2 = DOM.createSpan();
56 private Element innerSpan3 = DOM.createSpan();
57
58 /**
59 * Creates a HelpIconWidget; right after instantiation it is not highlighted.<br/>
60 * (See {@code #setHighlighted})
61 */
62 public HelpIconWidget() {
63 super();
64
65 addStyleName(CLASSNAME);
66 getElement().appendChild(innerSpan1);
67
68 innerSpan1.addClassName(helpWithCircleClassName);
69 innerSpan2.getStyle().setMarginLeft(-1, Style.Unit.EM);
70 innerSpan2.addClassName("icon-shape-circle");
71 innerSpan3.getStyle().setMarginLeft(-1, Style.Unit.EM);
72 innerSpan3.addClassName("icon-help-mark");
73 }
74
75
76 /**
77 * Change the visual state to show the icon more or less obtrusive.
78 */
79 public void setHighlighted(boolean highlight) {
80 if (highlight) {
81 getElement().addClassName(highlighted);
82 innerSpan1.removeClassName(helpWithCircleClassName);
83 innerSpan1.addClassName("icon-shape-circle-plus");
84 getElement().appendChild(innerSpan2);
85 getElement().appendChild(innerSpan3);
86 } else {
87 getElement().removeClassName(highlighted);
88 innerSpan1.addClassName(helpWithCircleClassName);
89 innerSpan1.removeClassName("icon-shape-circle-plus");
90 getElement().removeChild(innerSpan2);
91 getElement().removeChild(innerSpan3);
92 }
93 }
94
95 }