Boolean Input State Variable Reference

Related documents

• State Variables Overview
• StateVar Reference
• Built-in State Variables
• Input SV Type Reference

Table of contents

• Introduction
• Constructor
• Instance methods
  • Inherited methods
• Instance properties
  • Inherited properties
• DOM element properties

Introduction

Boolean input state variables represent inputs with true/false values. It will render as a checkbox.

Constructor

• Type string: 'booleanInput', class: BooleanInputSv

Syntax

ctl.createPage({
	...,
	stateVarInfo:[
		{type:'booleanInput', ...},
	],
})

Parameters

• info
  An object containing the state variable properties. The info object can contain the following properties, but subclasses of StateVar may have additional properties:
  • StateVar info properties.
  • Model SV type info properties.
  • Input SV type info properties.

Instance methods

Inherited methods

• StateVar methods
• ModelValueSv methods
• InputSv methods

Note: The component() method returns a BooleanInputSvCmp.

Instance properties

Inherited properties

• StateVar properties
• ModelValueSv properties
• InputSv properties

DOM element properties

• Standard DOM element properties
• The booleanInput Components will render an <input type="checkbox"> element.
• The <input> element's checked attribute will be synchronized with the value of the associated state variable.
• The <input> element will have a className that contains 'svIo_booleanInput'.