Class: Toybox.WatchUi.Menu2

Inherits:

Toybox.WatchUi.View

• Toybox.Lang.Object
• Toybox.WatchUi.View
• Toybox.WatchUi.Menu2

Overview

A representation of an on-screen menu. A Menu2 is a special View, similar to a Toybox::WatchUi::Menu, that presents the user with a list of options. A Menu2 offers more capabilities than a Toybox::WatchUi::Menu, like graphical titles, menu items that can be updated dynamically, and additional menu elements such as check boxes.

After an option is selected, the registered onSelect() method will be called. While a Menu2 can be generated programmatically, they should generally be created as a resource.

A Menu2 is pushed using pushView(), which provides a Menu2InputDelegate as the input delegate.

See Also:

• Toybox.WatchUi.Menu2InputDelegate
• Toybox.WatchUi.MenuItem
• Toybox.WatchUi.BehaviorDelegate
• WatchUi.pushView()

Note:

The look and feel of a Menu2 is device-specific.

Example:

Build a simple Menu2 programmatically

using Toybox.WatchUi;

class MyBehaviorDelegate extends WatchUi.BehaviorDelegate {
    function initialize() {
        BehaviorDelegate.initialize();
    }

    function onMenu() {
        var menu = new WatchUi.Menu2({:title=>"My Menu2"});
        var delegate;
        menu.addItem(
            new MenuItem(
                "Item 1 Label",
                "Item 1 subLabel",
                "itemOneId",
                {}
            )
        );
        menu.addItem(
            new MenuItem(
                "Item 2 Label",
                "Item 2 subLabel",
                "itemTwoId",
                {}
            )
        );
        delegate = new MyMenu2Delegate(); // a WatchUi.Menu2InputDelegate
        WatchUi.pushView(menu, delegate, WatchUi.SLIDE_IMMEDIATE);
        return true;
    }
}

Since:

API Level 3.0.0

Supported Devices:

• 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™ Mk1
• Descent™ Mk2 / Descent™ Mk2i
• Descent™ Mk2 S
• Edge® 1030 / Bontrager
• Edge® 1030 Plus
• Edge® 1030
• Edge® 1040 / 1040 Solar
• Edge® 520 Plus
• Edge® 530
• Edge® 540 / 540 Solar
• Edge® 820 / Explore
• Edge® 830
• Edge® 840 / 840 Solar
• Edge® Explore 2
• Edge® Explore
• Enduro™
• epix™ (Gen 2) / quatix® 7 Sapphire
• epix™ Pro (Gen 2) 42mm
• epix™ Pro (Gen 2) 47mm
• epix™ Pro (Gen 2) 51mm / tactix® 7 – AMOLED Edition
• First Avenger
• Forerunner® 245 Music
• Forerunner® 245
• Forerunner® 255 Music
• Forerunner® 255
• Forerunner® 255s Music
• Forerunner® 255s
• Forerunner® 265
• Forerunner® 265s
• Forerunner® 55
• Forerunner® 645 Music
• Forerunner® 645
• Forerunner® 745
• Forerunner® 935
• Forerunner® 945 LTE
• Forerunner® 945
• Forerunner® 955 / Solar
• Forerunner® 965
• 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
• fēnix® 7S Pro
• fēnix® 7S
• 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® 2 Plus
• Venu® 2
• Venu® 2S
• Venu® 3
• Venu® 3S
• Venu® Mercedes-Benz® Collection
• Venu® Sq 2 Music
• Venu® Sq 2
• Venu® Sq. Music Edition
• Venu® Sq
• 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

Direct Known Subclasses

WatchUi.CheckboxMenu, WatchUi.CustomMenu

Instance Method Summary

• addItem(item as WatchUi.MenuItem) as Void

  Add a MenuItem to a Menu2.

• deleteItem(index as Lang.Number) as Lang.Boolean or Null

  Delete a MenuItem from a Menu2.

• findItemById(identifier as Lang.Object) as Lang.Number

  Find a MenuItem by ID in a Menu2.

• 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.

• getItem(index as Lang.Number) as WatchUi.MenuItem or Null

  Get a MenuItem from a Menu2.

• initialize(options as { :title as Lang.String or Lang.Symbol or WatchUi.Drawable, :focus as Lang.Number, :icon as Graphics.BitmapType or WatchUi.Drawable or Lang.Symbol, :theme as WatchUi.MenuTheme or Null } or Null)

  Constructor.

• setFocus(focus as Lang.Number or Null) as Void

  Set the focus of a MenuItem in a Menu2.

• 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.

• setTheme(theme as WatchUi.MenuTheme or Null) as Void

  Set the theme.

• setTitle(title as Lang.String or Lang.Symbol or WatchUi.Drawable or Null) as Void

  Set a Menu2 title.

• updateItem(item as WatchUi.MenuItem, index as Lang.Number) as Void

  Update a MenuItem in a Menu2.

Instance Method Details

addItem(item as WatchUi.MenuItem) as Void

Add a MenuItem to a Menu2.

Parameters:

• item — (WatchUi.MenuItem) —

  The MenuItem to add to the Menu2

  • May not be a CheckboxMenuItem

Since:

API Level 3.0.0

Throws:

• (WatchUi.InvalidMenuItemTypeException) —

  Thrown if item is a CheckboxMenuItem

• (Lang.UnexpectedTypeException) —

  Thrown if item is not a valid type

deleteItem(index as Lang.Number) as Lang.Boolean or Null

Delete a MenuItem from a Menu2.

Parameters:

• index — (Lang.Number) —

  The index of the MenuItem that should be deleted from the Menu2.

Returns:

• Toybox::Lang::Boolean true if the item exists, or null if the specified index it outside of the bounds of the menu items array.

Since:

API Level 3.0.0

findItemById(identifier as Lang.Object) as Lang.Number

Find a MenuItem by ID in a Menu2.

Parameters:

• identifier — (Lang.Object) —

  The identifier for which to search

Returns:

• Lang.Number —

  The index of the MenuItem assigned the supplied identifier

  • -1 if not found

Since:

API Level 3.0.0

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

getItem(index as Lang.Number) as WatchUi.MenuItem or Null

Get a MenuItem from a Menu2.

Parameters:

• index — (Lang.Number) —

  The index of the MenuItem to get

Returns:

• WatchUi.MenuItem

Since:

API Level 3.0.0

initialize(options as { :title as Lang.String or Lang.Symbol or WatchUi.Drawable, :focus as Lang.Number, :icon as Graphics.BitmapType or WatchUi.Drawable or Lang.Symbol, :theme as WatchUi.MenuTheme or Null } or Null)

Constructor

Note:

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

Note:

The :theme option is only used on ConnectIQ 4.1.8 devices with menu theme support.

Parameters:

• options — (Lang.Dictionary) —

  A Dictionary of options

  • Can be null

  • :title — (Lang.String, Lang.Symbol, WatchUi.Drawable) —

    The menu title

  • :focus — (Lang.Number) —

    The index of the MenuItem that should have initial focus

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

    the default icon for the menu items

  • :theme — (WatchUi.MenuTheme) —

    The menu theme, or null for no theme. Defaults to MENU_THEME_DEFAULT.

Since:

API Level 3.0.0

setFocus(focus as Lang.Number or Null) as Void

Set the focus of a MenuItem in a Menu2.

Parameters:

• focus — (Lang.Number) —

  The index of the MenuItem that should have focus

Since:

API Level 3.0.0

Throws:

• (Lang.UnexpectedTypeException) —

  Thrown if focus is not a valid type

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 app 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

setTheme(theme as WatchUi.MenuTheme or Null) as Void

Set the theme

Parameters:

• theme — (WatchUi.MenuTheme) —

  The theme for this menu.

Supported Devices:

• Forerunner® 265
• Forerunner® 265s
• Forerunner® 965

Since:

API Level 4.1.8

setTitle(title as Lang.String or Lang.Symbol or WatchUi.Drawable or Null) as Void

Set a Menu2 title.

Parameters:

• title — (Lang.String, Lang.Number, WatchUi.Drawable) —

  The menu title text, null, the resource identifier of a string resource, or a Drawable

Since:

API Level 3.0.0

Throws:

• (Lang.UnexpectedTypeException) —

  Thrown if title is not a valid type

updateItem(item as WatchUi.MenuItem, index as Lang.Number) as Void

Update a MenuItem in a Menu2.

Parameters:

• item — (WatchUi.MenuItem) —

  The MenuItem to update

• index — (Lang.Number) —

  The index of the MenuItem to update

Since:

API Level 3.0.0