Skip to main content
The CheckboxElement class is utilised to create a single selection input element in a user interface.

​
Constructor

NameTypeDescription
elementIdstringThis property in constructor accepts the Id for the element
labelstringThis property in constructor accepts the label for CheckboxElement
optionsList<OptionElement>This property in constructor accepts options for CheckboxElement

​
Class Usage

Here’s how to create an instance of the CheckboxElement class:
  • Java
OptionElement option1 = new OptionElement("Option1", "1");
OptionElement option2 = new OptionElement("Option2", "2");
List<OptionElement> optionElementList = new ArrayList<>();
optionElementList.add(option1);
optionElementList.add(option2);

CheckboxElement checkboxElement = new CheckboxElement("idSelect", "Choose an option", optionElementList);
In this example, a new instance of CheckboxElement is created with an elementId “idSelect”, a label “Choose an option”, and a list of two options.

​
Key Properties and Methods

​
Default Value of the Input Element

The setDefaultValue() method sets the default value in the single select input, while the getDefaultValue() retrieves it. For example:
  • Java
checkboxElement.setDefaultValue("1");

​
Example

Here is an example that showcases the creation and manipulation of an instance of CheckboxElement:
  • Java
// Create some options
OptionElement option1 = new OptionElement("Option1", "1");
OptionElement option2 = new OptionElement("Option2", "2");
List<OptionElement> optionElementList = new ArrayList<>();
optionElementList.add(option1);
optionElementList.add(option2);

// Create a new instance of SingleSelectElement
CheckboxElement checkboxElement = new CheckboxElement("1", "Choose an option", optionElementList);

// Set and get the default value
checkboxElement.setDefaultValue("1");
⌘I