Class: Toybox.WatchUi.Selectable

Inherits:

Toybox.WatchUi.Drawable

• Toybox.Lang.Object
• Toybox.WatchUi.Drawable
• Toybox.WatchUi.Selectable

Overview

A representation of an on-screen selectable object with defined states depending on selection mode.

See Also:

• Toybox.WatchUi.Drawable

Note:

See the Selectable sample distributed with the SDK for an example of the use of the Selectable class

Since:

API Level 2.1.0

Direct Known Subclasses

WatchUi.Button

Instance Member Summary

• stateDefault as Graphics.ColorType or WatchUi.Drawable or Null

  The default state of a Selectable object.

• stateDisabled as Graphics.ColorType or WatchUi.Drawable or Null

  The disabled state of a Selectable object.

• stateHighlighted as Graphics.ColorType or WatchUi.Drawable or Null

  The highlighted state of a Selectable object.

• stateSelected as Graphics.ColorType or WatchUi.Drawable or Null

  The selected state of a Selectable object.

Instance Method Summary

• draw(dc as Graphics.Dc) as Void

  Draw the Selectable to the device context (Dc).

• getState() as Lang.Symbol

  Get the current state of a Selectable object.

• initialize(options as { :locX as Lang.Numeric, :locY as Lang.Numeric, :width as Lang.Numeric, :height as Lang.Numeric, :stateDefault as Graphics.ColorType or WatchUi.Drawable, :stateHighlighted as Graphics.ColorType or WatchUi.Drawable, :stateSelected as Graphics.ColorType or WatchUi.Drawable, :stateDisabled as Graphics.ColorType or WatchUi.Drawable, :identifier as Lang.Object, :visible as Lang.Boolean })

  Constructor.

• setState(state as Lang.Symbol) as Void

  Set the current state of a Selectable object.

Instance Attribute Details

var stateDefault as Graphics.ColorType or WatchUi.Drawable or Null

The default state of a Selectable object.

A Drawable, Graphics.COLOR_* constant, or 24-bit integer of the form 0xRRGGBB representing the default state of the Selectable

Since:

API Level 2.1.0

Returns:

• Lang.Object

var stateDisabled as Graphics.ColorType or WatchUi.Drawable or Null

The disabled state of a Selectable object.

A Drawable, Graphics.COLOR_* constant, or 24-bit integer of the form 0xRRGGBB representing the disabled state of the Selectable

Since:

API Level 2.1.0

Returns:

• Lang.Object

var stateHighlighted as Graphics.ColorType or WatchUi.Drawable or Null

The highlighted state of a Selectable object.

A Drawable, Graphics.COLOR_* constant, or 24-bit integer of the form 0xRRGGBB representing the highlighted state of the Selectable

Since:

API Level 2.1.0

Returns:

• Lang.Object

var stateSelected as Graphics.ColorType or WatchUi.Drawable or Null

The selected state of a Selectable object.

A Drawable, Graphics.COLOR_* constant, or 24-bit integer of the form 0xRRGGBB representing the selected state of the Selectable

Since:

API Level 2.1.0

Returns:

• Lang.Object

Instance Method Details

draw(dc as Graphics.Dc) as Void

Draw the Selectable to the device context (Dc).

This method assumes that the device context has already been configured to the proper options.

Parameters:

• dc — (Graphics.Dc) —

  The device context

Since:

API Level 2.1.0

getState() as Lang.Symbol

Get the current state of a Selectable object.

Returns:

• Lang.Symbol —

  The current state:

  • :stateDefault

  • :stateHighlighted

  • :stateSelected

  • :stateDisabled

Since:

API Level 2.1.0

initialize(options as { :locX as Lang.Numeric, :locY as Lang.Numeric, :width as Lang.Numeric, :height as Lang.Numeric, :stateDefault as Graphics.ColorType or WatchUi.Drawable, :stateHighlighted as Graphics.ColorType or WatchUi.Drawable, :stateSelected as Graphics.ColorType or WatchUi.Drawable, :stateDisabled as Graphics.ColorType or WatchUi.Drawable, :identifier as Lang.Object, :visible as Lang.Boolean })

Constructor

Parameters:

• options — (Lang.Dictionary) —

  A Dictionary containing options for the Selectable object

  • :locX — (Lang.Numeric) —

    The absolute, on-screen x-coordinate for the Selectable object (required)

  • :locY — (Lang.Numeric) —

    The absolute, on-screen y-coordinate for the Selectable object (required)

  • :width — (Lang.Numeric) —

    The clip width of the Selectable object (required)

  • :height — (Lang.Numeric) —

    The clip height of the Selectable object (required)

  • :stateDefault — (Graphics.ColorType, WatchUi.Drawable) —

    The Drawable or color to display in default state (optional)

  • :stateHighlighted — (Graphics.ColorType, WatchUi.Drawable) —

    The Drawable or color to display in highlighted state (optional)

  • :stateSelected — (Graphics.ColorType, WatchUi.Drawable) —

    The Drawable or color to display in selected state (optional)

  • :stateDisabled — (Graphics.ColorType, WatchUi.Drawable) —

    The Drawable or color to display in disabled state (optional)

See Also:

• Drawable.initialize()

Since:

API Level 2.1.0

setState(state as Lang.Symbol) as Void

Set the current state of a Selectable object.

Parameters:

• state — (Lang.Symbol) —

  The desired state:

  • :stateDefault

  • :stateHighlighted

  • :stateSelected

  • :stateDisabled

Since:

API Level 2.1.0

Throws:

• (WatchUi.InvalidSelectableStateException)