Class: Toybox.WatchUi.ViewLoop

Inherits:

Toybox.Lang.Object

Overview

An object representing the view loop with a collection of scrollable views.

Since:

API Level 3.4.0

Supported Devices:

Name	Value	Since	Description	See Also
DIRECTION_NEXT	0	API Level 3.4.0	Loop in the forward direction
DIRECTION_PREVIOUS	1	API Level 3.4.0	Loop in the backward direction

changeView(direction as ViewLoop.Direction) as Lang.Boolean

Change the view to the next/previous one in the view loop based on the direction and display the page indicator after transitioning.
initialize(factory as WatchUi.ViewLoopFactory, options as { :page as Lang.Number, :wrap as Lang.Boolean, :color as Graphics.ColorType } or Null)

Constructor for the ViewLoop.

Change the view to the next/previous one in the view loop based on the direction and display the page indicator after transitioning.

Parameters:

Returns:

Lang.Boolean —

true if view is changed, otherwise false, e.g. reached the start/end of of non-wrapping loop.

Since:

API Level 3.4.0

Throws:

(Lang.OperationNotAllowedException) —

Thrown when the view loop is not an active page for the app.

Constructor for the ViewLoop

Parameters:

factory — (WatchUi.ViewLoopFactory) —

A factory object for the view loop to retrieve view and delegates managed with in this view loop
options — (Lang.Dictionary) —

Options for this view loop object
- :page — (Lang.Number) —
  
  initial page index for the view loop. The default value is 0.
- :wrap — (Lang.Boolean) —
  
  if wrapping through the pages is allowed The default value is true.
- :color — (Graphics.ColorType) —
  
  accent color for the page indicator. The :color option may be ignored if the device does not support accent colors.

Since:

API Level 3.4.0

Throws:

(Lang.ValueOutOfBoundsException) —

Thrown if ViewLoopFactory returns a size less than or equal to 0.
(Lang.ValueOutOfBoundsException) —

Thrown if Number :page option value is negative or greater than the value returned by the ViewLoopFactory

Generated Dec 11, 2024, 8:58:44 AM