1 /*
2 * Tethys: GUI Utilities
3 * Copyright 2012-2026. Tony Washer
4 *
5 * Licensed under the Apache License, Version 2.0 (the "License"); you may not
6 * use this file except in compliance with the License. You may obtain a copy
7 * of the License at
8 *
9 * http://www.apache.org/licenses/LICENSE-2.0
10 *
11 * Unless required by applicable law or agreed to in writing, software
12 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
13 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
14 * License for the specific language governing permissions and limitations under
15 * the License.
16 */
17 package io.github.tonywasher.joceanus.tethys.api.control;
18
19 import io.github.tonywasher.joceanus.oceanus.event.OceanusEventRegistrar.OceanusEventProvider;
20 import io.github.tonywasher.joceanus.tethys.api.base.TethysUIComponent;
21 import io.github.tonywasher.joceanus.tethys.api.base.TethysUIEvent;
22
23 /**
24 * Check Box.
25 * <p>
26 * The EventProvider fires the following events.
27 * <ul>
28 * <li>TethysUIEvent.NEWVALUE is fired when the checkBox value is changed.
29 * </ul>
30 */
31 public interface TethysUICheckBox
32 extends OceanusEventProvider<TethysUIEvent>, TethysUIComponent {
33 /**
34 * handle selected.
35 *
36 * @param pText the text.
37 */
38 void setText(String pText);
39
40 /**
41 * Set the changed status.
42 *
43 * @param pChanged is the checkBox changed?
44 */
45 void setChanged(boolean pChanged);
46
47 /**
48 * set selected.
49 *
50 * @param pSelected is the box selected?
51 */
52 void setSelected(boolean pSelected);
53
54 /**
55 * Is the box selected?
56 *
57 * @return true/false
58 */
59 boolean isSelected();
60 }