1/*
2 * Copyright (c) 1995, 2014, Oracle and/or its affiliates. All rights reserved.
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 *
5 * This code is free software; you can redistribute it and/or modify it
6 * under the terms of the GNU General Public License version 2 only, as
7 * published by the Free Software Foundation.  Oracle designates this
8 * particular file as subject to the "Classpath" exception as provided
9 * by Oracle in the LICENSE file that accompanied this code.
10 *
11 * This code is distributed in the hope that it will be useful, but WITHOUT
12 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
13 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
14 * version 2 for more details (a copy is included in the LICENSE file that
15 * accompanied this code).
16 *
17 * You should have received a copy of the GNU General Public License version
18 * 2 along with this work; if not, write to the Free Software Foundation,
19 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
20 *
21 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
22 * or visit www.oracle.com if you need additional information or have any
23 * questions.
24 */
25package java.awt.peer;
26
27import java.awt.Checkbox;
28import java.awt.CheckboxGroup;
29
30/**
31 * The peer interface for {@link Checkbox}.
32 *
33 * The peer interfaces are intended only for use in porting
34 * the AWT. They are not intended for use by application
35 * developers, and developers should not implement peers
36 * nor invoke any of the peer methods directly on the peer
37 * instances.
38 */
39public interface CheckboxPeer extends ComponentPeer {
40
41    /**
42     * Sets the state of the checkbox to be checked {@code true} or
43     * unchecked {@code false}.
44     *
45     * @param state the state to set on the checkbox
46     *
47     * @see Checkbox#setState(boolean)
48     */
49    void setState(boolean state);
50
51    /**
52     * Sets the checkbox group for this checkbox. Checkboxes in one checkbox
53     * group can only be selected exclusively (like radio buttons). A value
54     * of {@code null} removes this checkbox from any checkbox group.
55     *
56     * @param g the checkbox group to set, or {@code null} when this
57     *          checkbox should not be placed in any group
58     *
59     * @see Checkbox#setCheckboxGroup(CheckboxGroup)
60     */
61    void setCheckboxGroup(CheckboxGroup g);
62
63    /**
64     * Sets the label that should be displayed on the checkbox. A value of
65     * {@code null} means that no label should be displayed.
66     *
67     * @param label the label to be displayed on the checkbox, or
68     *              {@code null} when no label should be displayed.
69     */
70    void setLabel(String label);
71
72}
73