Class: SoftKeyBooleanController

A controller which binds a softkey to a boolean state. Once bound, the softkey will display the bound state and each press of the softkey will toggle the value of the state.

Constructors

constructor

• new SoftKeyBooleanController(softkeyMenu, softkeyIndex, softkeyLabel, state): SoftKeyBooleanController

Constructor.

Parameters

Name	Type	Description
softkeyMenu	SoftKeyMenu	The softkey menu to which this controller's softkey belongs.
softkeyIndex	number	The index in the softkey menu at which this controller's softkey is located.
softkeyLabel	string	The text label of this controller's softkey.
state	MutableSubscribable<boolean, boolean>	The state bound to this controller's softkey.

Returns

SoftKeyBooleanController

Defined in

src/garminsdk/softkey/SoftKeyControllers.ts:24

Methods

destroy

▸ destroy(): void

Destroys this controller. This will remove the softkey menu item bound to this controller's state.

Returns

void

Defined in

src/garminsdk/softkey/SoftKeyControllers.ts:58

---

init

▸ init(): SoftKeyMenuItem

Initializes this controller. This will create a softkey menu item and bind it to this controller's state.

Returns

SoftKeyMenuItem

The softkey menu item bound to this controller's state.

Throws

Error if this controller has been destroyed.

Defined in

src/garminsdk/softkey/SoftKeyControllers.ts:37