Class: RadioBox

Defined in: workingtitle-instruments-wt21/shared/Menus/Components/Radiobox.tsx:26

The RadioBox component.

Extends

• DisplayComponent<RadioBoxProps>

Constructors

Constructor

new RadioBox(props): RadioBox

Defined in: sdk/components/FSComponent.ts:73

Creates an instance of a DisplayComponent.

Parameters

Parameter	Type	Description
props	RadioBoxProps	The propertis of the component.

Returns

RadioBox

Inherited from

DisplayComponent.constructor

Properties

context?

optional context: [] = undefined

Defined in: sdk/components/FSComponent.ts:64

The context on this component, if any.

Inherited from

DisplayComponent.context

---

contextType?

readonly optional contextType: readonly [] = undefined

Defined in: sdk/components/FSComponent.ts:67

The type of context for this component, if any.

Inherited from

DisplayComponent.contextType

---

isEnabled

readonly isEnabled: Subject<boolean>

Defined in: workingtitle-instruments-wt21/shared/Menus/Components/Radiobox.tsx:27

---

props

props: RadioBoxProps & ComponentProps

Defined in: sdk/components/FSComponent.ts:61

The properties of the component.

Inherited from

DisplayComponent.props

Methods

destroy()

destroy(): void

Defined in: sdk/components/FSComponent.ts:98

Destroys this component.

Returns

void

Inherited from

DisplayComponent.destroy

---

getContext()

protected getContext(context): never

Defined in: sdk/components/FSComponent.ts:106

Gets a context data subscription from the context collection.

Parameters

Parameter	Type	Description
context	never	The context to get the subscription for.

Returns

never

The requested context.

Throws

An error if no data for the specified context type could be found.

Inherited from

DisplayComponent.getContext

---

onAfterRender()

onAfterRender(): void

Defined in: workingtitle-instruments-wt21/shared/Menus/Components/Radiobox.tsx:49

A callback that is called after the component is rendered.

Returns

void

Overrides

DisplayComponent.onAfterRender

---

onBeforeRender()

onBeforeRender(): void

Defined in: sdk/components/FSComponent.ts:80

A callback that is called before the component is rendered.

Returns

void

Inherited from

DisplayComponent.onBeforeRender

---

render()

render(): VNode

Defined in: workingtitle-instruments-wt21/shared/Menus/Components/Radiobox.tsx:62

Renders the component.

Returns

VNode

A JSX element to be rendered.

Overrides

DisplayComponent.render

---

setIsChecked()

setIsChecked(checked): void

Defined in: workingtitle-instruments-wt21/shared/Menus/Components/Radiobox.tsx:44

Sets the checkmark in the RadioBox.

Parameters

Parameter	Type	Description
checked	boolean	The boolean indicating whether the box should be checked.

Returns

void

---

setIsEnabled()

setIsEnabled(enabled): void

Defined in: workingtitle-instruments-wt21/shared/Menus/Components/Radiobox.tsx:36

Sets the ability to check this box.

Parameters

Parameter	Type	Description
enabled	boolean	The boolean indicating whether the box should be checkable.

Returns

void