File : controls/checkboxInputControl/CheckboxInputControl.js

1
/*
2
Copyright - 2017 2023 - wwwouaiebe - Contact: https://www.ouaie.be/
3
4
This  program is free software;
5
you can redistribute it and/or modify it under the terms of the
6
GNU General Public License as published by the Free Software Foundation;
7
either version 3 of the License, or any later version.
8
9
This program is distributed in the hope that it will be useful,
10
but WITHOUT ANY WARRANTY; without even the implied warranty of
11
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12
GNU General Public License for more details.
13
14
You should have received a copy of the GNU General Public License
15
along with this program; if not, write to the Free Software
16
Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
17
*/
18
/*
19
Changes:
20
    - v4.0.0:
21
        - created from v3.6.0
22
Doc reviewed 202208
23
 */
24
25
import BaseControl from '../baseControl/BaseControl.js';
26
import theHTMLElementsFactory from '../../core/uiLib/HTMLElementsFactory.js';
27
28
/* ------------------------------------------------------------------------------------------------------------------------- */
29
/**
30
This class is a generic control with a checkbox input element
31
*/
32
/* ------------------------------------------------------------------------------------------------------------------------- */
33
34
class CheckboxInputControl extends BaseControl {
35
36
    /**
37
    The input HTMLElement
38
    @type {HTMLElement}
39
    */
40
41
    #valueInput;
42
43
    /**
44
    The constructor
45
    @param {Object} options An object with the  options ( beforeText, checked, datasetName, afterText )
46
    */
47
48
    constructor ( options ) {
49
        super ( );
50
        theHTMLElementsFactory.create (
51
            'text',
52
            {
53
                value : options?.beforeText || ''
54
            },
55
            this.controlHTMLElement
56
        );
57
        this.#valueInput = theHTMLElementsFactory.create (
58
            'input',
59
            {
60
                type : 'checkbox',
61
                className : 'TravelNotes-CheckboxInputControl-Checkbox',
62
                checked : options?.checked,
63
                dataset : { Name : options?.datasetName || 'CheckboxInputControl' }
64
            },
65
            this.controlHTMLElement
66
        );
67
        theHTMLElementsFactory.create (
68
            'text',
69
            {
70
                value : options?.afterText || ''
71
            },
72
            this.controlHTMLElement
73
        );
74
    }
75
76
    /**
77
    The value in the control
78
    @type {String}
79
    */
80
81
    get checked ( ) { return this.#valueInput.checked; }
82
83
    set checked ( checked ) { this.#valueInput.checked = checked; }
84
85
}
86
87
export default CheckboxInputControl;
88
89
/* --- End of file --------------------------------------------------------------------------------------------------------- */
90