Class: Toybox.WatchUi.CustomMenuItem

Inherits:

Toybox.WatchUi.MenuItem

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

Overview

A representation of a custom item in a CustomMenu.

A CustomMenuItem is a element of a CustomMenu View that represents one of the items in the menu. When selected, the onSelect() delegate callback will be invoked. The selected state of the item may change when it is being selected. This state can be evaluated using the isSelected() method and can be used to control the look of a selected item.

A CustomMenuItem can be added to a CustomMenu using the addItem() method.

See Also:

• Toybox.WatchUi.CustomMenu
• Toybox.WatchUi.MenuItem

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
• 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
• 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® 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 - 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
• fēnix® 8 Solar 47mm
• fēnix® 8 Solar 51mm
• fēnix® Chronos
• fēnix® E
• 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 / 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. 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

Instance Method Summary

• draw(dc as Graphics.Dc) as Void

  Draw method for a CustomMenuItem.

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

  Get the divider icon.

• initialize(identifier as Lang.Object or Null, options as { :alignment as MenuItem.Alignment, :drawable as WatchUi.Drawable, :icon as Graphics.BitmapType or WatchUi.Drawable or Lang.ResourceId, :dividerIcon as Graphics.BitmapType or WatchUi.Drawable or Lang.ResourceId })

  Constructor.

• isFocused() as Lang.Boolean

  Get the CustomMenuItem focus state.

• isSelected() as Lang.Boolean

  Get the CustomMenuItem selected state.

• setDividerIcon(icon as Graphics.BitmapType or WatchUi.Drawable or Lang.ResourceId or Null) as Void

  Set or change the menu icon.

• setDrawable(drawable as WatchUi.Drawable or Null) as Void

  Set a CustomMenuItem Drawable.

Instance Method Details

draw(dc as Graphics.Dc) as Void

Draw method for a CustomMenuItem.

This is called when a menu item is rendering.

Parameters:

• dc — (Graphics.Dc) —

  The item's drawing context

Since:

API Level 3.0.0

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

Get the divider icon.

Supported Devices:

• Enduro™ 3
• fēnix® 8 43mm
• fēnix® 8 47mm / 51mm
• fēnix® 8 Solar 47mm
• fēnix® 8 Solar 51mm
• fēnix® E

Returns:

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

  The icon

See Also:

• CustomMenuItem.setDividerIcon()

Since:

API Level 5.0.1

initialize(identifier as Lang.Object or Null, options as { :alignment as MenuItem.Alignment, :drawable as WatchUi.Drawable, :icon as Graphics.BitmapType or WatchUi.Drawable or Lang.ResourceId, :dividerIcon as Graphics.BitmapType or WatchUi.Drawable or Lang.ResourceId })

Constructor

Note:

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

Parameters:

• identifier — (Lang.Object) —

  The identifier for this item which is typically a String

• options — (Lang.Dictionary) —

  A Dictionary of options

  • :drawable — (WatchUi.Drawable) —

    A Drawable that draws the item. (required)

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

    for the subscreen area when the menu item is in focus

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

    icon for the divider area.

See Also:

• MenuItem.initialize()
• CustomMenuItem.setDividerIcon()

Since:

API Level 3.0.0

Throws:

• (Lang.UnexpectedTypeException) —

  Thrown if the :drawable option is not a Drawable or is null.

isFocused() as Lang.Boolean

Get the CustomMenuItem focus state.

Returns:

• Lang.Boolean —

  The current focus state of the CustomMenuItem

Since:

API Level 3.0.0

isSelected() as Lang.Boolean

Get the CustomMenuItem selected state.

Returns:

• Lang.Boolean —

  The current selected state of the CustomMenuItem

Since:

API Level 3.0.0

setDividerIcon(icon as Graphics.BitmapType or WatchUi.Drawable or Lang.ResourceId or Null) as Void

Set or change the menu icon.

If device support Menu2.DividerType and parent menu is set to DIVIDER_TYPE_ICON, icon (if not +null+) will be rendered on the left side of the divider.

Parameters:

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

  The Drawable or ResourceId used to render the icon for this item

Supported Devices:

• Enduro™ 3
• fēnix® 8 43mm
• fēnix® 8 47mm / 51mm
• fēnix® 8 Solar 47mm
• fēnix® 8 Solar 51mm
• fēnix® E

Since:

API Level 5.0.1

Throws:

• (Lang.UnexpectedTypeException) —

  Thrown if icon is not a valid type.

setDrawable(drawable as WatchUi.Drawable or Null) as Void

Set a CustomMenuItem Drawable.

Parameters:

• drawable — (WatchUi.Drawable) —

  A Drawable to render on top of the menu items, or null.

Since:

API Level 3.0.0

Throws:

• (Lang.UnexpectedTypeException) —

  Thrown if drawable is not a Drawable or is null.