Class: Toybox.WatchUi.CheckboxMenu

Inherits:

Toybox.WatchUi.Menu2

Overview

A representation of a check box menu.

A CheckboxMenu is a specialized Menu2 View that presents the user with a list of check box options. After an option is selected, the registered onSelect() method will be called. While a CheckboxMenu can be generated programmatically, they should generally be created as a resource.

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

using Toybox.WatchUi;

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

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

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

addItem(item as WatchUi.CheckboxMenuItem) as Void

Add a CheckboxMenuItem to a CheckboxMenu.
initialize(options as { :title as Lang.String or Lang.ResourceId or WatchUi.Drawable, :footer as Lang.String or Lang.ResourceId or WatchUi.Drawable, :focus as Lang.Number, :icon as Graphics.BitmapType or Lang.ResourceId or WatchUi.Drawable, :theme as WatchUi.MenuTheme or Null, :dividerType as Menu2.DividerType or Null } or Null)

Constructor.

Instance Method Details

addItem(item as WatchUi.CheckboxMenuItem) as Void

Add a CheckboxMenuItem to a CheckboxMenu.

Parameters:

item — (WatchUi.CheckboxMenuItem) —

The CheckboxMenuItem to add to the CheckboxMenu

Since:

API Level 3.0.0

Throws:

(WatchUi.InvalidMenuItemTypeException) —

Thrown if item is not a [Toybox::WatchUi::CheckboxMenuItem]
(Lang.UnexpectedTypeException) —

Thrown if item is not a valid type

initialize(options as { :title as Lang.String or Lang.ResourceId or WatchUi.Drawable, :footer as Lang.String or Lang.ResourceId or WatchUi.Drawable, :focus as Lang.Number, :icon as Graphics.BitmapType or Lang.ResourceId or WatchUi.Drawable, :theme as WatchUi.MenuTheme or Null, :dividerType as Menu2.DividerType 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.

Note:

The :dividerType option is only used on ConnectIQ 5.0.1 devices with divider support.

Note:

The :footer option is only used on ConnectIQ 5.1.0 devices.

Parameters:

options — (Lang.Dictionary) —
A Dictionary of options
- Can be null
- :title — (Lang.String, Lang.ResourceId, WatchUi.Drawable) —
  
  The menu title
- :footer — (Lang.String, Lang.ResourceId, WatchUi.Drawable) —
  
  The menu footer
- :focus — (Lang.Number) —
  
  The index of the CheckboxMenuItem that should have initial focus
- :icon — (Graphics.BitmapType, WatchUi.Drawable, Lang.ResourceId) —
  
  the default icon for menu items
- :theme — (WatchUi.MenuTheme) —
  
  The menu theme, or null for no theme. Defaults to MENU_THEME_DEFAULT.
- :dividerType — (Menu2.DividerType) —
  
  The divider type, Defaults to DIVIDER_TYPE_DEFAULT or when null is passed as value.

Class: Toybox.WatchUi.CheckboxMenu

Overview

See Also:

Instance Method Summary collapse

Instance Method Details

addItem(item as WatchUi.CheckboxMenuItem) as Void