View Javadoc
1   /**
2    * This file Copyright (c) 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.field;
35  
36  import com.vaadin.shared.Registration;
37  import com.vaadin.ui.CheckBox;
38  import com.vaadin.ui.Component;
39  import com.vaadin.ui.CustomField;
40  
41  /**
42   * A field wrapper for a single CheckBox, supporting the FormLayout-managed (left) caption.
43   */
44  public class CheckBoxField extends CustomField<Boolean> {
45  
46      private final CheckBox checkBox;
47  
48      public CheckBoxField(String checkBoxCaption) {
49          this.checkBox = new CheckBox(checkBoxCaption);
50      }
51  
52      @Override
53      protected Component initContent() {
54          return checkBox;
55      }
56  
57      @Override
58      protected void doSetValue(Boolean value) {
59          if (value == null) {
60              value = false;
61          }
62          checkBox.setValue(value);
63      }
64  
65      @Override
66      public Boolean getValue() {
67          return checkBox.getValue();
68      }
69  
70      @Override
71      public Registration addValueChangeListener(ValueChangeListener<Boolean> listener) {
72          return checkBox.addValueChangeListener(listener);
73      }
74  }