Class: Toybox.WatchUi.ToggleMenuItem

Inherits:

Toybox.WatchUi.MenuItem

• Toybox.Lang.Object
• Toybox.WatchUi.MenuItem
• Toybox.WatchUi.ToggleMenuItem

Overview

A representation of a toggle item in a Menu2.

A ToggleMenuItem is a element of a Menu2 View that represents one of the options in the menu, and includes an indicator on the menu item that appears in one of two states: enabled or disabled. When selected, the state of the ToggleMenuItem changes to the state opposite of the state prior to the onSelect delegate callback invocation.

A ToggleMenuItem can be added to a Menu2 using the addItem() method.

See Also:

• Toybox.WatchUi.Menu2
• Toybox.WatchUi.MenuItem

Since:

API Level 3.0.0

App Types:

• Audio Content Provider

• Data Field

• Glance

• Watch App

• Watch Face

• Widget

Supported Devices:

• Approach® S50
• Approach® S62
• Approach® S70 42mm
• Approach® S70 47mm
• Captain Marvel
• D2™ Air X10
• D2™ Air
• D2™ Charlie
• D2™ Delta PX
• D2™ Delta S
• D2™ Delta
• D2™ Mach 1
• Darth Vader™
• Descent™ G1 / G1 Solar
• Descent™ G2
• Descent™ Mk1
• Descent™ Mk2 / Descent™ Mk2i
• Descent™ Mk2 S
• Descent™ Mk3 43mm / Mk3i 43mm
• Descent™ Mk3i 51mm
• Edge® 1030 / Bontrager
• Edge® 1030 Plus
• Edge® 1030
• Edge® 1040 / 1040 Solar
• Edge® 1050
• Edge® 520 Plus
• Edge® 530
• Edge® 540 / 540 Solar
• Edge® 820 / Explore
• Edge® 830
• Edge® 840 / 840 Solar
• Edge® Explore 2
• Edge® Explore
• Enduro™ 3
• Enduro™
• epix™ (Gen 2) / quatix® 7 Sapphire
• epix™ Pro (Gen 2) 42mm
• epix™ Pro (Gen 2) 47mm / quatix® 7 Pro
• epix™ Pro (Gen 2) 51mm / D2™ Mach 1 Pro / tactix® 7 – AMOLED Edition
• fēnix® 5 / quatix® 5
• fēnix® 5 Plus
• fēnix® 5S Plus
• fēnix® 5S
• fēnix® 5X / tactix® Charlie
• fēnix® 5X Plus
• fēnix® 6 / 6 Solar / 6 Dual Power
• fēnix® 6 Pro / 6 Sapphire / 6 Pro Solar / 6 Pro Dual Power / quatix® 6
• fēnix® 6S / 6S Solar / 6S Dual Power
• fēnix® 6S Pro / 6S Sapphire / 6S Pro Solar / 6S Pro Dual Power
• fēnix® 6X Pro / 6X Sapphire / 6X Pro Solar / tactix® Delta Sapphire / Delta Solar / Delta Solar - Ballistics Edition / quatix® 6X / 6X Solar / 6X Dual Power
• fēnix® 7 / quatix® 7
• fēnix® 7 Pro - Solar Edition (no Wi-Fi)
• fēnix® 7 Pro
• fēnix® 7S Pro
• fēnix® 7S
• fēnix® 7X / tactix® 7 / quatix® 7X Solar / Enduro™ 2
• fēnix® 7X Pro - Solar Edition (no Wi-Fi)
• fēnix® 7X Pro
• fēnix® 8 43mm
• fēnix® 8 47mm / 51mm / tactix® 8 47mm / 51mm
• fēnix® 8 Solar 47mm
• fēnix® 8 Solar 51mm / tactix® 8 Solar 51mm
• fēnix® Chronos
• fēnix® E
• First Avenger
• Forerunner® 165 Music
• Forerunner® 165
• Forerunner® 245 Music
• Forerunner® 245
• Forerunner® 255 Music
• Forerunner® 255
• Forerunner® 255s Music
• Forerunner® 255s
• Forerunner® 265
• Forerunner® 265s
• Forerunner® 55
• Forerunner® 570 42mm
• Forerunner® 570 47mm
• Forerunner® 645 Music
• Forerunner® 645
• Forerunner® 745
• Forerunner® 935
• Forerunner® 945 LTE
• Forerunner® 945
• Forerunner® 955 / Solar
• Forerunner® 965
• Forerunner® 970
• GPSMAP® 66s / 66i / 66sr / 66st
• GPSMAP® 67 / 67i
• GPSMAP® 86s / 86sc / 86i / 86sci
• Instinct® 2 / Solar / Dual Power / dēzl Edition
• Instinct® 2S / Solar / Dual Power
• Instinct® 2X Solar
• Instinct® 3 AMOLED 45mm
• Instinct® 3 AMOLED 50mm
• Instinct® 3 Solar 45mm / 50mm
• Instinct® Crossover
• Instinct® E 40mm
• Instinct® E 45mm
• MARQ® (Gen 2) Athlete / Adventurer / Captain / Golfer / Carbon Edition / Commander - Carbon Edition
• MARQ® (Gen 2) Aviator
• MARQ® Adventurer
• MARQ® Athlete
• MARQ® Aviator
• MARQ® Captain / MARQ® Captain: American Magic Edition
• MARQ® Commander
• MARQ® Driver
• MARQ® Expedition
• MARQ® Golfer
• Montana® 7 Series
• Oregon® 7 Series
• Rey™
• Rino® 7 Series
• Venu® 2 Plus
• Venu® 2
• Venu® 2S
• Venu® 3
• Venu® 3S
• Venu® Mercedes-Benz® Collection
• Venu® Sq 2 Music
• Venu® Sq 2
• Venu® Sq
• Venu® Sq. Music Edition
• Venu®
• vívoactive® 3 Mercedes-Benz® Collection
• vívoactive® 3 Music LTE
• vívoactive® 3 Music
• vívoactive® 3
• vívoactive® 4
• vívoactive® 4S
• vívoactive® 5
• vívoactive® 6

Instance Method Summary

• getSubLabel() as Lang.String or Lang.Dictionary<Lang.Symbol, Lang.String or Null> or Null

  Get a ToggleMenuItem label substring.

• initialize(label as Lang.String or Lang.ResourceId, subLabel as Lang.String or Lang.ResourceId or { :enabled as Lang.String or Lang.ResourceId or Null, :disabled as Lang.String or Lang.ResourceId or Null } or Null, identifier as Lang.Object or Null, enabled as Lang.Boolean, options as { :alignment as MenuItem.Alignment, :icon as Graphics.BitmapType or WatchUi.Drawable or Lang.ResourceId } or Null)

  Constructor.

• isEnabled() as Lang.Boolean

  Get a ToggleMenuItem state.

• setEnabled(enabled as Lang.Boolean) as Void

  Set a ToggleMenuItem state.

• setSubLabel(subLabel as Lang.String or Lang.ResourceId or { :enabled as Lang.String or Lang.ResourceId or Null, :disabled as Lang.String or Lang.ResourceId or Null } or Null) as Void

  Set a ToggleMenuItem label substring.

Instance Method Details

getSubLabel() as Lang.String or Lang.Dictionary<Lang.Symbol, Lang.String or Null> or Null

Get a ToggleMenuItem label substring.

Returns:

• Lang.String, Lang.Dictionary —

  The substring text label for the ToggleMenuItem

Since:

API Level 3.0.0

initialize(label as Lang.String or Lang.ResourceId, subLabel as Lang.String or Lang.ResourceId or { :enabled as Lang.String or Lang.ResourceId or Null, :disabled as Lang.String or Lang.ResourceId or Null } or Null, identifier as Lang.Object or Null, enabled as Lang.Boolean, options as { :alignment as MenuItem.Alignment, :icon as Graphics.BitmapType or WatchUi.Drawable or Lang.ResourceId } or Null)

Constructor

Note:

The :icon option is only used on ConnectIQ 3.4.0 devices with subscreen support.

Parameters:

• label — (Lang.String, Lang.ResourceId) —

  The string label for the ToggleMenuItem

• subLabel — (Lang.String, Lang.ResourceId, Lang.Dictionary) —

  The substring label for the item or a dictionary of toggle states mapped to sub-label strings, which can be null

  • :enabled — (Lang.String, Lang.ResourceId) —

    The string displayed when the ToggleMenuItem is enabled, or null

  • :disabled — (Lang.String, Lang.ResourceId) —

    The string displayed when the ToggleMenuItem is disabled, or null

• identifier — (Lang.Object) —

  The identifier for this ToggleMenuItem, which is typically a String

• enabled — (Lang.Boolean) —

  The initial state of the ToggleMenuItem; enabled if true, disabled if false

• options — (Lang.Dictionary) —

  A Dictionary of options

  • :alignment — (MenuItem.Alignment) —

    A WatchUi.MenuItem.MENU_ITEM_LABEL_ALIGN_* constant representing the label alignment, which defaults to the system default for toggle menu items if not specified.

  • :icon — (Graphics.BitmapType, WatchUi.Drawable, Lang.ResourceId) —

    for the subscreen area when the menu item is in focus

Since:

API Level 3.0.0

isEnabled() as Lang.Boolean

Get a ToggleMenuItem state.

Returns:

• Lang.Boolean —

  The current state of the ToggleMenuItem

Since:

API Level 3.0.0

setEnabled(enabled as Lang.Boolean) as Void

Set a ToggleMenuItem state.

Parameters:

• enabled — (Lang.Boolean) —

  The intended state of the ToggleMenuItem; enabled if true, disabled if false

Since:

API Level 3.0.0

Throws:

• (Lang.UnexpectedTypeException) —

  Thrown if enabled is not a valid type

setSubLabel(subLabel as Lang.String or Lang.ResourceId or { :enabled as Lang.String or Lang.ResourceId or Null, :disabled as Lang.String or Lang.ResourceId or Null } or Null) as Void

Set a ToggleMenuItem label substring.

Parameters:

• subLabel — (Lang.String, Lang.ResourceId, Lang.Dictionary) —

  The substring label for the item or a dictionary of toggle states mapped to sub-label strings, which can be null

  • :enabled — (Lang.String) —

    The string displayed when the ToggleMenuItem is enabled, or null

  • :disabled — (Lang.String) —

    The string displayed when the ToggleMenuItem is disabled, or null

Since:

API Level 3.0.0