Class: Toybox.WatchUi.Menu2InputDelegate

Inherits:
Toybox.Lang.Object show all

Overview

Menu2InputDelegate responds to a Menu2 selection.

This class should be extended to handle selected Menu2 items.

See Also:

Example:

using Toybox.WatchUi;
using Toybox.System;

class MyMenu2InputDelegate extends WatchUi.Menu2InputDelegate {
    function initialize() {
        Menu2InputDelegate.initialize();
    }

    function onSelect(item) {
        System.println(item.getId());
    }
}

Since:

API Level 3.0.0

App Types:

  • Audio Content Provider

  • Data Field

  • Glance

  • Watch App

  • Watch Face

  • Widget

Supported Devices:

Instance Method Summary collapse

Instance Method Details

onBack() as Void

A Menu2 Back key was pressed. If this method is not overridden, it will pop the active view.

Since:

API Level 3.0.0

onDone() as Void

A Menu2 Done item was selected. This method is only triggered by a CheckboxMenu If this method is not overridden, it will pop the active view.

Since:

API Level 3.0.0

onFooter() as Void

A CustomMenu footer was selected.

This method is triggered on products with touch input when the user selects the footer area of a CustomMenu.

Note:

Prior to ConnectIQ API version 5.1.0, this function was only called on CustomMenu. It is now used for all Menu2 types.

Since:

API Level 3.0.0

onNextPage() as Lang.Boolean

Represents the Next Page behavior.

This is typically triggered when at the bottom of a Menu and the down button (KEY_DOWN) or a SWIPE_UP SwipeEvent input is received.

Returns:

Since:

API Level 5.1.0

onPreviousPage() as Lang.Boolean

Represents the Previous Page behavior.

This is typically triggered when at the top of a Menu and the up button (KEY_UP) or a SWIPE_DOWN SwipeEvent input is received.

Returns:

Since:

API Level 5.1.0

onSelect(item as WatchUi.MenuItem) as Void

A Menu2 MenuItem was selected.

Parameters:

Since:

API Level 3.0.0

onTitle() as Void

A CustomMenu title was selected.

This method is triggered on products with touch input when the user selects the title area of a CustomMenu.

Note:

Prior to ConnectIQ API version 5.1.0, this function was only called on CustomMenu. It is now used for all Menu2 types.

Since:

API Level 3.0.0

onWrap(key as WatchUi.Key) as Lang.Boolean

A Menu2 is preparing to wrap.

This method is triggered on button-based products when the user attempts to navigate off the end of a menu. If this method returns false the list will not wrap to the opposite end. If this method is not overridden, it will return true and allow the menu to wrap.

Parameters:

Returns:

Since:

API Level 3.0.0

Generated Mar 4, 2025, 4:09:54 PM