Class CheckboxAdapter

Inspector adapter for boolean properties rendered as checkboxes.

Hierarchy (View Summary)

InspectorAdapter
- CheckboxAdapter

Index

Constructors

Properties

cell mixedClassName returnKey?

Methods

setUnset setChangeHandler notifyChange extractValueFrom destroy showValue getValue setMixed

Constructors

constructor

new CheckboxAdapter(
    cell: HTMLElement,
    mixedClassName: string,
    initial: InspectorAdapterInit,
): CheckboxAdapter
Parameters
- cell: HTMLElement
- mixedClassName: string
- initial: InspectorAdapterInit
Returns CheckboxAdapter
Overrides InspectorAdapter.constructor
- Defined in src/editor/inspector/native/checkbox.adapter.ts:10

Properties

`Protected` `Readonly`cell

cell: HTMLElement

`Protected` `Readonly`mixedClassName

mixedClassName: string

`Protected` `Optional`returnKey

returnKey?: string

Methods

`Protected`setUnset

setUnset(unset: boolean): void
Toggles the unset/empty visual state on the cell element.
Parameters
- unset: boolean
  True when the current value is undefined or null.
Returns void
Inherited from InspectorAdapter.setUnset
- Defined in src/editor/inspector/inspector.adapter.ts:69

setChangeHandler

setChangeHandler(handler: ((value: unknown) => void) | null): void
Registers the callback invoked whenever the user changes the control value. Pass null to disconnect the handler.
Parameters
- handler: ((value: unknown) => void) | null
  The callback to invoke, or null to clear.
Returns void
Inherited from InspectorAdapter.setChangeHandler
- Defined in src/editor/inspector/inspector.adapter.ts:78

`Protected`notifyChange

notifyChange(value: unknown): void
Fires the registered change handler with the new value. No-op when no handler is registered.
Parameters
- value: unknown
  The new value produced by the control.
Returns void
Inherited from InspectorAdapter.notifyChange
- Defined in src/editor/inspector/inspector.adapter.ts:87

extractValueFrom

extractValueFrom(
record: EditableRecord,
key?: string,
): { key: string; value: unknown }
Extracts a key-value pair from a record, optionally by explicit key. Falls back to the first entry in the record when no key is given.
Parameters
- record: EditableRecord
  The source record.
- Optionalkey: string
  Optional explicit key override.
Returns { key: string; value: unknown }
An object containing the resolved key and its value.
Inherited from InspectorAdapter.extractValueFrom
- Defined in src/editor/inspector/inspector.adapter.ts:98

destroy

destroy(): void
Releases resources held by the adapter, including the change handler reference.

Returns void
Inherited from InspectorAdapter.destroy
- Defined in src/editor/inspector/inspector.adapter.ts:110

showValue

showValue(editable: EditableRecord): void
Populates the adapter's control with the value(s) from the given record.
Parameters
- editable: EditableRecord
  Record containing at least one key-value entry to display.
Returns void
Overrides InspectorAdapter.showValue
- Defined in src/editor/inspector/native/checkbox.adapter.ts:19

getValue

getValue(): EditableRecord
Returns the current value of the adapter's control as a record entry.

Returns EditableRecord
A single-entry record keyed by the last-shown property key.
Overrides InspectorAdapter.getValue
- Defined in src/editor/inspector/native/checkbox.adapter.ts:27

setMixed

setMixed(mixed: boolean): void
Toggles the mixed-value visual state on the cell element. Mixed state is shown when the selection contains more than one distinct value.
Parameters
- mixed: boolean
  True to enter mixed state, false to clear it.
Returns void
Overrides InspectorAdapter.setMixed
- Defined in src/editor/inspector/native/checkbox.adapter.ts:31