Skip to main content

Class: RadioBoxSelect

Defined in: workingtitle-instruments-wt21/shared/Menus/Components/RadioboxSelect.tsx:20

The RadioBoxSelect component.

Extends

  • DisplayComponent<RadioBoxSelectProps>

Constructors

Constructor

new RadioBoxSelect(props): RadioBoxSelect

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

Creates an instance of a DisplayComponent.

Parameters

ParameterTypeDescription
propsRadioBoxSelectPropsThe propertis of the component.

Returns

RadioBoxSelect

Inherited from

DisplayComponent<RadioBoxSelectProps>.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


inputRef

protected readonly inputRef: NodeReference<HTMLInputElement>

Defined in: workingtitle-instruments-wt21/shared/Menus/Components/RadioboxSelect.tsx:24


isChecked

protected readonly isChecked: Subject<boolean>

Defined in: workingtitle-instruments-wt21/shared/Menus/Components/RadioboxSelect.tsx:23


isEnabled

readonly isEnabled: Subject<boolean>

Defined in: workingtitle-instruments-wt21/shared/Menus/Components/RadioboxSelect.tsx:22


props

props: RadioBoxSelectProps & 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

ParameterTypeDescription
contextneverThe 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/RadioboxSelect.tsx:43

Returns

void

Inherit Doc

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/RadioboxSelect.tsx:55

Returns

VNode

Inherit Doc

Overrides

DisplayComponent.render


setIsChecked()

setIsChecked(checked): void

Defined in: workingtitle-instruments-wt21/shared/Menus/Components/RadioboxSelect.tsx:38

Sets the checkmark in the RadioBoxSelect.

Parameters

ParameterTypeDescription
checkedbooleanThe boolean indicating whether the box should be checked.

Returns

void


setIsEnabled()

setIsEnabled(enabled): void

Defined in: workingtitle-instruments-wt21/shared/Menus/Components/RadioboxSelect.tsx:30

Sets the ability to check this box.

Parameters

ParameterTypeDescription
enabledbooleanThe boolean indicating whether the box should be checkable.

Returns

void