CheckBox Class

Overview

The CheckBox class represents a check box control.

Base Class

FormControl

Constructor

CheckBox(text : String, x_pos : Integer, y_pos : Integer, width : Integer, height : Integer)

Events

CheckBox.click

Fired when the check box is clicked.

Methods

CheckBox.getLabel

Gets the text associated with the check box control.

CheckBox.getValue

Gets the visible state of the check in the check box control.

CheckBox.setLabel

Sets the text associated with the check box control.

CheckBox.setValue

Turns the check in the check box on or off.

Inherited Methods

FormControl.captureMouse

Captures the mouse on this form control.

FormControl.disablePaint

Disables the window from redrawing itself.

FormControl.enablePaint

Enables the window to redraw itself.

FormControl.getBackgroundColor

Gets the background color of the form control.

FormControl.getClientSize

Gets the client size of the form control.

FormControl.getEnabled

Indicates whether or not a form control is enabled.

FormControl.getFont

Gets the default font for the text of form control.

FormControl.getForegroundColor

Gets the foreground color of the form control.

FormControl.getMaxSize

Gets the maximum size of the form control.

FormControl.getMinSize

Gets the minimum size of the form control.

FormControl.getMousePosition

Gets the mouse position relative to this form control.

FormControl.getNativeHandle

Gets the native handle of the window/control

FormControl.getPosition

Gets the position of a form control.

FormControl.getSize

Gets the size of the form control.

FormControl.invalidate

Invalidates a form control, which will cause it to be repainted on the next paint event.

FormControl.refresh

Refreshes a form control, which immediately repaints the entire form control.

FormControl.releaseMouse

Releases the mouse from being captured on this form control.

FormControl.setBackgroundColor

Sets the background color of the form control.

FormControl.setClientSize

Sets the client size of a form control.

FormControl.setEnabled

Enables or disables the form control.

FormControl.setFocus

Sets the focus to the form control.

FormControl.setFont

Sets the default font for the text of the form control.

FormControl.setForegroundColor

Sets the foreground color of the form control.

FormControl.setMaxSize

Sets the maximum size of a form control.

FormControl.setMinSize

Sets the minimum size of a form control.

FormControl.setPosition

Sets the position of a form control relative to the the form control's parent.

FormControl.setSize

Sets the size of a form control.

FormControl.show

Shows or hides the form control.

FormControl.update

Updates a form control, which will immediately repaint any invalid areas.

Example

// define the checkbox sample form
class MyForm extends Form {
    // the textbox the event handler writes to
    textbox = null;

    constructor(caption, x_pos, y_pos, width, height) {
        // the constructor gets called when a new object is created;
        // the super() function calls the constructor on the base
        // class, which in this case is Form since MyForm extends Form
        super(caption, x_pos, y_pos, width, height);

        // create checkboxes with various color labels
        const checkbox1 = new CheckBox("Red");
        const checkbox2 = new CheckBox("Yellow");
        const checkbox3 = new CheckBox("Green");
        const checkbox4 = new CheckBox("Blue");

        // create a new line
        const line = new Line(Line.Horizontal);

        // create a new textbox; store it on this.textbox so the
        // event handler can output results to it
        this.textbox = new TextBox();
        this.textbox.setMultiline(true);

        // add the checkboxes to the top part of the form;
        // use a layout object to space the elements horizontally
        const layout_top = new BoxLayout(Layout.Horizontal);
        layout_top.addSpacer();
        layout_top.add(checkbox1, 0, Layout.Expand | Layout.Top | Layout.Bottom, 5);
        layout_top.addSpacer(10);
        layout_top.add(checkbox2, 0, Layout.Expand | Layout.Top | Layout.Bottom, 5);
        layout_top.addSpacer(10);
        layout_top.add(checkbox3, 0, Layout.Expand | Layout.Top | Layout.Bottom, 5);
        layout_top.addSpacer(10);
        layout_top.add(checkbox4, 0, Layout.Expand | Layout.Top | Layout.Bottom, 5);

        // add the checkboxes, line, and the textbox to the form
        const layout_main = new BoxLayout(Layout.Vertical);
        layout_main.addSpacer();
        layout_main.add(layout_top, 0, Layout.Expand | Layout.Left | Layout.Right, 5);
        layout_main.addSpacer(10);
        layout_main.add(line, 0, Layout.Expand | Layout.Left | Layout.Right, 5);
        layout_main.addSpacer(10);
        layout_main.add(this.textbox, 1, Layout.Expand | Layout.Left | Layout.Right, 5);
        layout_main.addSpacer();

        // use layout_main for the main form layout
        this.setLayout(layout_main);

        // connect the checkbox events to the event handler
        checkbox1.click.connect(this, this.onCheckBoxClicked);
        checkbox2.click.connect(this, this.onCheckBoxClicked);
        checkbox3.click.connect(this, this.onCheckBoxClicked);
        checkbox4.click.connect(this, this.onCheckBoxClicked);
    }

    onCheckBoxClicked(sender, event_args) {
        // when a checkbox is clicked, output the label and
        // check status to the textbox
        const state = sender.getValue() ? "checked" : "unchecked";
        this.textbox.appendText(`${sender.getLabel()} ${state}.\n`);
    }
}

// create a new checkbox sample form
const f = new MyForm("CheckBox Example", 0, 0, 400, 300);
f.center();
f.show();
Application.run();