Class: Toybox.WatchUi.IconMenuItem

Inherits:

Toybox.WatchUi.MenuItem

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

Overview

A representation of an icon item in a Menu2.

An IconMenuItem is a element of a Menu2 View that represents one of the options in the menu. An IconMenuItem has an icon displayed on the left or right of the menu item labels.

An IconMenuItem can be added to a Menu2 using the addItem() method.

See Also:

• Toybox.WatchUi.Menu2
• 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™
• 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® 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 / 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

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

  Get IconMenuItem icon.

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

  Constructor.

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

  Set the IconMenuItem icon.

Instance Method Details

getIcon() as Graphics.BitmapType or WatchUi.Drawable

Get IconMenuItem icon.

Returns:

• Graphics.BitmapType, WatchUi.Drawable —

  The IconMenuItem icon

Since:

API Level 3.0.0

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

Constructor

Parameters:

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

  The string label for the IconMenuItem

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

  The substring label for the IconMenuItem, which can be null

• identifier — (Lang.Object) —

  The identifier for this IconMenuItem, which is typically a String

• icon — (WatchUi.Drawable, WatchUi.BitmapResource, Graphics.BitmapReference) —

  The Drawable used to render the icon for this item or the Graphics::BitmapReference object.

• options — (Lang.Dictionary) —

  A Dictionary of options

  • :alignment — (MenuItem.Alignment) —

    A WatchUi.MenuItem.MENU_ITEM_LABEL_ALIGN_* constant representing the label alignment, which defaults to MENU_ITEM_LABEL_ALIGN_LEFT

Since:

API Level 3.0.0

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

Set the IconMenuItem icon.

Parameters:

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

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

Since:

API Level 3.0.0

Throws:

• (Lang.UnexpectedTypeException) —

  Thrown if icon is not a valid type