Class: Toybox.WatchUi.MenuItem

Inherits:

Toybox.Lang.Object

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

Overview

A representation of a menu item in a Menu2.

A MenuItem is a element of a Menu2 View that represents one of the options in the menu. A MenuItem can be added to a Menu2 using the addItem() method.

See Also:

• Toybox.WatchUi.Menu2

Since:

API Level 3.0.0

Supported Devices:

• Approach® S62
• Approach® S70 42mm
• Approach® S70 47mm
• Captain Marvel
• D2™ Air
• D2™ Air X10
• D2™ Charlie
• D2™ Delta
• D2™ Delta PX
• D2™ Delta S
• D2™ Mach 1
• Darth Vader™
• Descent™ G1 / G1 Solar
• Descent™ Mk1
• Descent™ Mk2 / Descent™ Mk2i
• Descent™ Mk2 S
• Edge® 1030
• Edge® 1030 / Bontrager
• Edge® 1030 Plus
• Edge® 1040 / 1040 Solar
• Edge® 520 Plus
• Edge® 530
• Edge® 540 / 540 Solar
• Edge® 820 / Explore
• Edge® 830
• Edge® 840 / 840 Solar
• Edge® Explore
• Edge® Explore 2
• Enduro™
• epix™ (Gen 2) / quatix® 7 Sapphire
• epix™ PRO (Gen 2) 42mm
• epix™ PRO (Gen 2) 47mm
• epix™ PRO (Gen 2) 51mm
• First Avenger
• Forerunner® 245
• Forerunner® 245 Music
• Forerunner® 255
• Forerunner® 255 Music
• Forerunner® 255s
• Forerunner® 255s Music
• Forerunner® 265
• Forerunner® 265s
• Forerunner® 55
• Forerunner® 645
• Forerunner® 645 Music
• Forerunner® 745
• Forerunner® 935
• Forerunner® 945
• Forerunner® 945 LTE
• Forerunner® 955 / Solar
• Forerunner® 965
• fēnix® 5 / quatix® 5
• fēnix® 5 Plus
• fēnix® 5S
• fēnix® 5S Plus
• 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
• fēnix® 7S
• fēnix® 7S PRO
• fēnix® 7X / tactix® 7 / quatix® 7X Solar / Enduro™ 2
• fēnix® 7X PRO
• fēnix® Chronos
• 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® Crossover
• MARQ® (Gen 2) Athlete / Adventurer / Captain / Golfer
• 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®
• Venu® 2
• Venu® 2 Plus
• Venu® 2S
• Venu® Mercedes-Benz® Collection
• Venu® Sq
• Venu® Sq 2
• Venu® Sq 2 Music
• Venu® Sq. Music Edition
• vívoactive® 3
• vívoactive® 3 Mercedes-Benz® Collection
• vívoactive® 3 Music
• vívoactive® 3 Music LTE
• vívoactive® 4
• vívoactive® 4S

Direct Known Subclasses

WatchUi.CheckboxMenuItem, WatchUi.CustomMenuItem, WatchUi.IconMenuItem, WatchUi.ToggleMenuItem

Constant Summary

Alignment

Since:

API Level 3.0.0

Name	Value	Since	Description
MENU_ITEM_LABEL_ALIGN_RIGHT	0	API Level 3.0.0	Right align a MenuItem label
MENU_ITEM_LABEL_ALIGN_LEFT	1	API Level 3.0.0	Left align a MenuItem label

Instance Method Summary

• getIcon() as Graphics.BitmapType or WatchUi.Drawable or Null

  Get the icon The icon that is used for the subscreen area will be returned If an icon is not been specified, this function will return null.

• getId() Lang.Object

  Get a MenuItem identifier.

• getLabel() as Lang.String

  Get a MenuItem label.

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

  Get a MenuItem substring label.

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

  Constructor.

• setIcon(icon as Graphics.BitmapType or WatchUi.Drawable or Lang.Symbol or Null) as Void

  Set the icon The specified icon will be displayed in the subscreen area when this Menu2 item is visible.

• setLabel(label as Lang.String or Lang.Symbol) as Void

  Set a MenuItem label.

• setSubLabel(subLabel as Lang.String or Lang.Symbol or Null) as Void

  Set a MenuItem substring label.

Instance Method Details

getIcon() as Graphics.BitmapType or WatchUi.Drawable or Null

Get the icon

The icon that is used for the subscreen area will be returned If an icon is not been specified, this function will return null

Supported Devices:

• Descent™ G1 / G1 Solar
• Instinct® 2 / Solar / Dual Power / dēzl Edition
• Instinct® 2S / Solar / Dual Power
• Instinct® 2X Solar

Returns:

• Graphics.BitmapType, Lang.Symbol, WatchUi.Drawable —

  The icon

Since:

API Level 3.4.0

getId() Lang.Object

Get a MenuItem identifier.

Returns:

• Lang.Object —

  The identifier for the MenuItem

Since:

API Level 3.0.0

getLabel() as Lang.String

Get a MenuItem label.

Returns:

• Lang.String —

  The text label for the MenuItem

Since:

API Level 3.0.0

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

Get a MenuItem substring label.

Returns:

• Lang.String —

  The substring text label for the MenuItem

Since:

API Level 3.0.0

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

Constructor

Note:

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

Parameters:

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

  The string label for the MenuItem

• subLabel — (Lang.String, Lang.Symbol) —

  The substring label for the MenuItem, which can be null

• identifier — (Lang.Object) —

  The identifier for this MenuItem, which is typically a String

• options — (Lang.Dictionary) —

  A Dictionary of options. Can be null

  • :alignment — (Lang.Number) —

    One of the WatchUi.MenuItem.MENU_ITEM_LABEL_ALIGN* values that indicates the text alignment for the menu item.

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

    for the subscreen area when the menu item is in focus

Since:

API Level 3.0.0

setIcon(icon as Graphics.BitmapType or WatchUi.Drawable or Lang.Symbol or Null) as Void

Set the icon

The specified icon will be displayed in the subscreen area when this Menu2 item is visible. If an icon is not been specified, the menu2 icon will be shown instead.

Parameters:

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

  The icon

Supported Devices:

• Descent™ G1 / G1 Solar
• Instinct® 2 / Solar / Dual Power / dēzl Edition
• Instinct® 2S / Solar / Dual Power
• Instinct® 2X Solar

Since:

API Level 3.4.0

setLabel(label as Lang.String or Lang.Symbol) as Void

Set a MenuItem label.

Parameters:

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

  The text label for the MenuItem

Since:

API Level 3.0.0

Throws:

• (Lang.UnexpectedTypeException) —

  Thrown if label is an invalid type, or if a resource ID does not point to a valid string resource

setSubLabel(subLabel as Lang.String or Lang.Symbol or Null) as Void

Set a MenuItem substring label.

Parameters:

• subLabel — (Lang.String, Lang.Symbol) —

  The substring text label for the MenuItem, which can be null

Since:

API Level 3.0.0

Throws:

• (Lang.UnexpectedTypeException) —

  Thrown if label is an invalid type, or if a resource ID does not point to a valid string resource