Class CheckboxGroup

Class used to create a CheckboxGroup which contains groups of checkbox buttons

Hierarchy

SelectorGroup
- CheckboxGroup

Index

Constructors

constructor

Properties

name

Accessors

Methods

Constructors

constructor

new CheckboxGroup(name: string): CheckboxGroup

Inherited from SelectorGroup.constructor
- Defined in .temp/docdirectory/doc.d.ts:101136
Creates a new SelectorGroup

Parameters
- name: string
  
  of group, used as a group heading
Returns CheckboxGroup

Properties

nameSearch playground for name

name: string

name of SelectorGroup

Accessors

groupPanel

get groupPanel(): StackPanel

Inherited from SelectorGroup.groupPanel
- Defined in .temp/docdirectory/doc.d.ts:101145
Gets the groupPanel of the SelectorGroup

Returns StackPanel

header

get header(): string
set header(label: string): any

Inherited from SelectorGroup.header
- Defined in .temp/docdirectory/doc.d.ts:101149
Gets and sets the group header

Returns string
Inherited from SelectorGroup.header
- Defined in .temp/docdirectory/doc.d.ts:101150
Gets and sets the group header

Parameters
- label: string
Returns any

selectors

get selectors(): StackPanel[]

Inherited from SelectorGroup.selectors
- Defined in .temp/docdirectory/doc.d.ts:101147
Gets the selectors array

Returns StackPanel[]

Methods

addCheckboxSearch playground for addCheckbox

addCheckbox(text: string, func?: (s: boolean) => void, checked?: boolean): void

- Defined in .temp/docdirectory/doc.d.ts:101175
Adds a checkbox as a control

Parameters
- text: string
  
  is the label for the selector
- Optional func: (s: boolean) => void
  
  is the function called when the Selector is checked
  - - (s: boolean): void
    - Parameters
      - s: boolean
      Returns void
- Optional checked: boolean
  
  is true when Selector is checked
Returns void

removeSelectorSearch playground for removeSelector

removeSelector(selectorNb: number): void

Inherited from SelectorGroup.removeSelector
- Defined in .temp/docdirectory/doc.d.ts:101164
Removes the selector at the given position

Parameters
- selectorNb: number
  
  the position of the selector within the group
Returns void