-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathindex.html
1914 lines (1635 loc) · 92.8 KB
/
index.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<!-- Douglas Silva - 2023 -->
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<meta name="viewport" content="width=device-width,height=device-height, initial-scale=1">
<title>WFE :: Documentation</title>
<meta name="description" content="Watch Face Editor (WFE) is a library to help you creating editor/customizar for Watch Facer for Wear OS that uses the Jetpack Watch Face API.">
<link rel="shortcut icon" href="img/favicon/favicon.ico" id="favicon">
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.9.0/styles/default.min.css">
<link rel="preconnect" href="https://fonts.googleapis.com">
<link rel="preconnect" href="https://fonts.gstatic.com" crossorigin>
<link href="https://fonts.googleapis.com/css2?family=Lato&display=swap" rel="stylesheet">
<link href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.0.3/styles/androidstudio.min.css" rel="stylesheet">
<link rel="stylesheet" type="text/css" href="css/style.css">
</head>
<body>
<div id="top_bar">
<span id="library_name">WatchFaceEditor</span>
<span class="library_version"></span>
<a title="My page" id="logo" href="https://hms-douglas.github.io/" target="_blank" rel="noopener noreferrer"></a>
<a title="Project on github" id="github" href="https://github.com/hms-douglas/wfe" target="_blank" rel="noopener noreferrer"></a>
<a title="Support me" id="support_me" href="https://www.paypal.com/donate/?hosted_button_id=QAHLC3GARUSVY" target="_blank" rel="noopener noreferrer"></a>
<input id="toggle" type="checkbox">
<label for="toggle" id="ui-hamburger">
<div class="top"></div>
<div class="middle"></div>
<div class="bottom"></div>
</label>
</div>
<div id="sidebar">
<div class="sidebar_title showing">
<span data-goto="GETTING_STARTED">Getting started</span>
<div class="sidebar_subtitle" data-goto="DEPENDECIES">
<span>Add the dependecies</span>
</div>
<div class="sidebar_subtitle" data-goto="CREATE_ACTIVITY">
<span>Create the activity</span>
</div>
<div class="sidebar_subtitle" data-goto="INIT">
<span>Init</span>
</div>
</div>
<div class="sidebar_title">
<span data-goto="WFE_ACTIVITY">WFEActivity</span>
<div class="sidebar_subtitle sidebar_subtitle-method" data-goto="INIT_EDITOR">
<span>initEditor()</span>
</div>
</div>
<div class="sidebar_title">
<span data-goto="WFE_OPTION">WFEOption</span>
<div class="sidebar_subtitle">
<span data-goto="WFE_BOOLEAN_OPTION">WFEBooleanOption</span>
<div class="sidebar_subtitle sidebar_subtitle-method" data-goto="WFE_BOOLEAN_OPTION_getId">
<span>getId()</span>
</div>
</div>
<div class="sidebar_subtitle">
<span data-goto="WFE_LIST_OPTION">WFEListOption</span>
<div class="sidebar_subtitle sidebar_subtitle-method" data-goto="WFE_LIST_OPTION_setFastScroll">
<span>setFastScroll()</span>
</div>
<div class="sidebar_subtitle sidebar_subtitle-method" data-goto="WFE_LIST_OPTION_isFastScroll">
<span>isFastScroll()</span>
</div>
<div class="sidebar_subtitle sidebar_subtitle-method" data-goto="WFE_LIST_OPTION_displayName">
<span>setDisplayOptionNameWhenSelected()</span>
</div>
<div class="sidebar_subtitle sidebar_subtitle-method" data-goto="WFE_LIST_OPTION_isDisplayName">
<span>isToDisplayOptionNameWhenSelected()</span>
</div>
</div>
<div class="sidebar_subtitle">
<span data-goto="WFE_COLOR_LIST_OPTION">WFEColorListOption</span>
<div class="sidebar_subtitle sidebar_subtitle-method" data-goto="WFE_COLOR_LIST_OPTION_getId">
<span>getId()</span>
</div>
<div class="sidebar_subtitle sidebar_subtitle-method" data-goto="WFE_COLOR_LIST_OPTION_setFastScroll">
<span>setFastScroll()</span>
</div>
<div class="sidebar_subtitle sidebar_subtitle-method" data-goto="WFE_COLOR_LIST_OPTION_isFastScroll">
<span>isFastScroll()</span>
</div>
</div>
<div class="sidebar_subtitle">
<span data-goto="WFE_DYNAMIC_COLOR_PICKER_OPTION">WFEDynamicColorPickerOption</span>
</div>
<div class="sidebar_subtitle">
<span data-goto="WFE_STATIC_COLOR_PICKER_OPTION">WFEStaticColorPickerOption</span>
<div class="sidebar_subtitle sidebar_subtitle-method" data-goto="WFE_STATIC_COLOR_PICKER_OPTION_setFastScroll">
<span>setFastScroll()</span>
</div>
<div class="sidebar_subtitle sidebar_subtitle-method" data-goto="WFE_STATIC_COLOR_PICKER_OPTION_isFastScroll">
<span>isFastScroll()</span>
</div>
</div>
<div class="sidebar_subtitle">
<span data-goto="WFE_COMPLICATION_OPTION">WFEComplicationOption</span>
</div>
<div class="sidebar_subtitle">
<span data-goto="WFE_DOUBLE_RANGE_OPTION">WFEDoubleRangeOption</span>
<div class="sidebar_subtitle sidebar_subtitle-interface" data-goto="WFE_DOUBLE_RANGE_OPTION_interface">
<span>@RangeLabel</span>
</div>
<div class="sidebar_subtitle sidebar_subtitle-method" data-goto="WFE_DOUBLE_RANGE_OPTION_getId">
<span>getId()</span>
</div>
<div class="sidebar_subtitle sidebar_subtitle-method" data-goto="WFE_DOUBLE_RANGE_OPTION_setStep">
<span>setStep()</span>
</div>
<div class="sidebar_subtitle sidebar_subtitle-method" data-goto="WFE_DOUBLE_RANGE_OPTION_getStep">
<span>getStep()</span>
</div>
<div class="sidebar_subtitle sidebar_subtitle-method" data-goto="WFE_DOUBLE_RANGE_OPTION_setRange">
<span>setRangeLabel()</span>
</div>
<div class="sidebar_subtitle sidebar_subtitle-method" data-goto="WFE_DOUBLE_RANGE_OPTION_getRange">
<span>getRangeLabel()</span>
</div>
<div class="sidebar_subtitle sidebar_subtitle-method" data-goto="WFE_DOUBLE_RANGE_OPTION_setFastScroll">
<span>setFastScroll()</span>
</div>
<div class="sidebar_subtitle sidebar_subtitle-method" data-goto="WFE_DOUBLE_RANGE_OPTION_getFastScroll">
<span>isFastScroll()</span>
</div>
</div>
<div class="sidebar_subtitle">
<span data-goto="WFE_LONG_RANGE_OPTION">WFELongRangeOption</span>
<div class="sidebar_subtitle sidebar_subtitle-interface" data-goto="WFE_LONG_RANGE_OPTION_interface">
<span>@RangeLabel</span>
</div>
<div class="sidebar_subtitle sidebar_subtitle-method" data-goto="WFE_LONG_RANGE_OPTION_getId">
<span>getId()</span>
</div>
<div class="sidebar_subtitle sidebar_subtitle-method" data-goto="WFE_LONG_RANGE_OPTION_setStep">
<span>setStep()</span>
</div>
<div class="sidebar_subtitle sidebar_subtitle-method" data-goto="WFE_LONG_RANGE_OPTION_getStep">
<span>getStep()</span>
</div>
<div class="sidebar_subtitle sidebar_subtitle-method" data-goto="WFE_LONG_RANGE_OPTION_setRange">
<span>setRangeLabel()</span>
</div>
<div class="sidebar_subtitle sidebar_subtitle-method" data-goto="WFE_LONG_RANGE_OPTION_getRange">
<span>getRangeLabel()</span>
</div>
<div class="sidebar_subtitle sidebar_subtitle-method" data-goto="WFE_LONG_RANGE_OPTION_setFastScroll">
<span>setFastScroll()</span>
</div>
<div class="sidebar_subtitle sidebar_subtitle-method" data-goto="WFE_LONG_RANGE_OPTION_getFastScroll">
<span>isFastScroll()</span>
</div>
</div>
<div class="sidebar_subtitle">
<span data-goto="WFE_LABEL_OPTION">WFELabelOption</span>
</div>
<div class="sidebar_subtitle">
<span data-goto="WFE_BUTTON_OPTION">WFEButtonOption</span>
</div>
<div class="sidebar_subtitle">
<span data-goto="WFE_WATCHFACE_OPTION">WFEWatchfaceOption</span>
</div>
</div>
<div class="sidebar_title">
<span data-goto="WFE_SETTINGS">WFESettings</span>
<div class="sidebar_subtitle sidebar_subtitle-method" data-goto="WFE_SETTINGS_setMainColor">
<span>setMainColor()</span>
</div>
<div class="sidebar_subtitle sidebar_subtitle-method" data-goto="WFE_SETTINGS_getMainColor">
<span>getMainColor()</span>
</div>
<div class="sidebar_subtitle sidebar_subtitle-method" data-goto="WFE_SETTINGS_setBackgroundColor">
<span>setBackgroundColor()</span>
</div>
<div class="sidebar_subtitle sidebar_subtitle-method" data-goto="WFE_SETTINGS_getBackgroundColor">
<span>getBackgroundColor()</span>
</div>
<div class="sidebar_subtitle sidebar_subtitle-method" data-goto="WFE_SETTINGS_setVibration">
<span>setVibrationFeedback()</span>
</div>
<div class="sidebar_subtitle sidebar_subtitle-method" data-goto="WFE_SETTINGS_getVibration">
<span>isVibrationFeedbackEnabled()</span>
</div>
<div class="sidebar_subtitle sidebar_subtitle-method" data-goto="WFE_SETTINGS_setScrollerColor">
<span>setScrollerColor()</span>
</div>
<div class="sidebar_subtitle sidebar_subtitle-method" data-goto="WFE_SETTINGS_getScrollerColor">
<span>getScrollerColor()</span>
</div>
<div class="sidebar_subtitle sidebar_subtitle-method" data-goto="WFE_SETTINGS_setAnimationId">
<span>setScaleAnimationDuration()</span>
</div>
<div class="sidebar_subtitle sidebar_subtitle-method" data-goto="WFE_SETTINGS_getAnimationId">
<span>getScaleAnimationDuration()</span>
</div>
<div class="sidebar_subtitle sidebar_subtitle-method" data-goto="WFE_SETTINGS_setPreviewDelay">
<span>setRenderPreviewDelay()</span>
</div>
<div class="sidebar_subtitle sidebar_subtitle-method" data-goto="WFE_SETTINGS_getPreviewDelay">
<span>getRenderPreviewDelay()</span>
</div>
</div>
<div class="sidebar_title">
<span data-goto="EXTRA">Extra</span>
<div class="sidebar_subtitle sidebar_subtitle-resource" data-goto="ROTARY_INPUT">
<span>Rotary input</span>
</div>
<div class="sidebar_subtitle sidebar_subtitle-resource" data-goto="CLASS_EXAMPLE">
<span>YouActivityClassNameHere</span>
</div>
</div>
<div class="sidebar_title">
<span data-goto="VERSIONS">Versions</span>
</div>
<div class="sidebar_title">
<span data-goto="LICENSE">License</span>
</div>
<div id="sidebar_topbar">
<div class="helper">
<a title="My page" id="logo" href="https://hms-douglas.github.io/" target="_blank" rel="noopener noreferrer"></a>
<a title="Project on github" id="github" href="https://github.com/hms-douglas/wfe" target="_blank" rel="noopener noreferrer"></a>
</div>
<a title="Support me" id="support_me" href="https://www.paypal.com/donate/?hosted_button_id=QAHLC3GARUSVY" target="_blank" rel="noopener noreferrer"></a>
<span class="library_version"></span>
</div>
</div>
<div id="documentation">
<div class="block" id="GETTING_STARTED">
<span class="title">Getting started</span>
<div class="text">
<p>While creating my first watch face using the Jetpack Watch Face API I discovered that there is no standard editor in the smartwatches, and that for each new watch face it is necessary to create a new editor.</p>
<p>As I intend to develop more watch faces using the Jetpack API, and I like the design and interaction mode of the WFS editor, I decided to create a module, with a similar interface, to standardize and simplify the creation of editors. I also decided to share this module, as a library, to help others.</p>
<p>This documentation guides on how to implement the library and how to use/customize it.</p>
</div>
<div class="block sub_block" id="DEPENDECIES">
<span class="title">Add the dependecies</span>
<div class="text">
<p>Add the jitpack repository to your <span class="file_name">settings.gradle</span> file.</p>
</div>
<pre><code class="language-java">
dependencyResolutionManagement {
repositoriesMode.set(RepositoriesMode.FAIL_ON_PROJECT_REPOS)
repositories {
//...
maven { url 'https://jitpack.io' } // <== ADD THIS LINE
}
}
</code></pre>
<div class="text">
<p>Add to your <span class="file_name">build.gradle</span> app module file the following dependency:</p>
</div>
<pre><code class="language-java">
implementation 'com.github.hms-douglas:wfe:1.0.1' //Always check for the latest
</code></pre>
</div>
<div class="block sub_block" id="CREATE_ACTIVITY">
<span class="title">Create the activity</span>
<div class="text">
<p>Declare an editor activity on you <span class="file_name">AndroidManifest.xml</span> file. The activity theme must be Theme.AppCompat.NoActionBar.</p>
</div>
<pre><code class="language-java">
<activity
android:name=".YouActivityClassNameHere"
android:exported="true"
android:theme="@style/Theme.AppCompat.NoActionBar">
<intent-filter>
<action android:name="androidx.wear.watchface.editor.action.WATCH_FACE_EDITOR"/>
<category android:name="com.google.android.wearable.watchface.category.WEARABLE_CONFIGURATION"/>
<category android:name="android.intent.category.DEFAULT"/>
</intent-filter>
</activity>
</code></pre>
<div class="text">
<p>Add to you watch face service tag the following meda data tag:</p>
</div>
<pre><code class="language-java">
<meta-data
android:name="com.google.android.wearable.watchface.wearableConfigurationAction"
android:value="androidx.wear.watchface.editor.action.WATCH_FACE_EDITOR"/>
</code></pre>
<div class="text">
<p>Create your <span class="file_name"><span class="text_link" data-goto="CLASS_EXAMPLE">YouActivityClassNameHere</span></span></span> file. This activity/class must extend the <span class="text_link" data-goto="WFE_ACTIVITY">WFEActivity</span> class. Example:</p>
</div>
<pre><code class="language-java">
public class YouActivityClassNameHere extends WFEActivity {
@Override
protected void onCreate(Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
}
}
</code></pre>
</div>
<div class="block sub_block" id="INIT">
<span class="title">Init</span>
<div class="text">
<p>To create the editor you must call the <span class="text_link" data-goto="INIT_EDITOR">initEditor()</span> function, passing the parameters to define the design of the editor and the options screens you want it to render.</p>
<p>The <span class="text_link" data-goto="INIT_EDITOR">initEditor()</span> function must be called before the super.onCreate() of the activity you have created. Example:</p>
</div>
<pre><code class="language-java">
public class YouActivityClassNameHere extends WFEActivity {
@Override
protected void onCreate(Bundle savedInstanceState) {
//...
initEditor(listenableEditorSession, wfes, wfeol);
super.onCreate(savedInstanceState);
}
}
</code></pre>
</div>
</div>
<div class="block" id="WFE_ACTIVITY">
<span class="title">WFEActivity<span class="subtitle s s100"></span></span>
<div class="text">
<p>Activity responsible for holding/rendering the editor.</p>
</div>
<div class="block sub_block" id="INIT_EDITOR">
<span class="title">initEditor()<span class="subtitle param"></span><span class="subtitle s s100"></span></span></span>
<table class="method_details">
<tr>
<th>Annotation</th>
<th>Type</th>
<th>Name</th>
<th>Description</th>
</tr>
<tr>
<td>@Nullable</td>
<td>ListenableEditorSession</td>
<td>listenableEditorSession</td>
<td>Used to get and set all the UserStyleSetting of the editor.<br>If null, the WFE will try to obtain it automatically. It is not recommended to set this parameter to null.</td>
</tr>
<tr>
<td>@Nullable</td>
<td><span class="text_link" data-goto="WFE_SETTINGS">WFESettings</span></td>
<td>wfeSettings</td>
<td>Object holding some style and behavior of the editor user interface.<br>If null, the default style and behavior will be applyed.</td>
</tr>
<tr>
<td>@NonNull</td>
<td>List<<span class="text_link" data-goto="WFE_OPTION">WFEOption</span>></td>
<td>wfeOptionList</td>
<td>List containing all the options avaiable to be edited by the user. Each item of the list will result in one option/setting screen.</td>
</tr>
</table>
</div>
</div>
<div class="block" id="WFE_OPTION">
<span class="title">WFEOption<span class="subtitle s s100"></span></span>
<div class="text">
<p>Class responsible for holding each option screen.</p>
</div>
<div class="block sub_block" id="WFE_BOOLEAN_OPTION">
<span class="title">WFEBooleanOption<span class="subtitle const"></span><span class="subtitle s s100"></span></span>
<div class="text">
<p>Class responsible for rendering the boolean option screen. The user can swipe up and down to toggle the option.</p>
</div>
<table class="method_details">
<tr>
<th>Annotation</th>
<th>Type</th>
<th>Name</th>
<th>Description</th>
</tr>
<tr>
<td>@NonNull</td>
<td>UserStyleSetting.Id</td>
<td>id</td>
<td>Id used to create the BooleanUserStyleSetting. This constructor will try to get the displayName used during the creation of the BooleanUserStyleSetting.</td>
</tr>
</table>
<table class="method_details">
<tr>
<th>Annotation</th>
<th>Type</th>
<th>Name</th>
<th>Description</th>
</tr>
<tr>
<td>@NonNull</td>
<td>UserStyleSetting.Id</td>
<td>id</td>
<td>Id used to create the BooleanUserStyleSetting.</td>
</tr>
<tr>
<td>@NonNull</td>
<td>String</td>
<td>customLabel</td>
<td>Custom label to be displayed at the top of the screen.</td>
</tr>
</table>
<div class="block sub_block" id="WFE_BOOLEAN_OPTION_getId">
<span class="title">getId()<span class="subtitle ret"></span><span class="subtitle s s100"></span></span>
<table class="method_details">
<tr>
<th>Type</th>
<th>Description</th>
</tr>
<tr>
<td>UserStyleSetting.Id</td>
<td>Id passed to the constructor representing the corresponding BooleanUserStyleSetting.</td>
</tr>
</table>
</div>
<div class="block sub_block" id="WFE_BOOLEAN_OPTION">
<span class="title">User Interface</span>
<div class="screenshots">
<img src="img/ui/b_0.png" loading="lazy">
</div>
</div>
</div>
<div class="block sub_block sub_block2" id="WFE_LIST_OPTION">
<span class="title">WFEListOption<span class="subtitle const"></span><span class="subtitle s s100"></span></span>
<div class="text multiline">
<p>Class responsible for rendering the basic list option screen.</p>
<p>The user can swipe up and down to switch between each list item.</p>
<p>The list "scrollbar" will render up to 12 items. If the list contains more the 12 items, a plus sign will be displayed at the top/bottom, allowing the user to keep scrolling.</p>
</div>
<table class="method_details">
<tr>
<th>Annotation</th>
<th>Type</th>
<th>Name</th>
<th>Description</th>
</tr>
<tr>
<td>@NonNull</td>
<td>UserStyleSetting.Id</td>
<td>id</td>
<td>Id used to create the ListUserStyleSetting. This constructor will try to get the displayName used during the creation of the ListUserStyleSetting.</td>
</tr>
</table>
<table class="method_details">
<tr>
<th>Annotation</th>
<th>Type</th>
<th>Name</th>
<th>Description</th>
</tr>
<tr>
<td>@NonNull</td>
<td>UserStyleSetting.Id</td>
<td>id</td>
<td>Id used to create the ListUserStyleSetting.</td>
</tr>
<tr>
<td>@NonNull</td>
<td>String</td>
<td>customLabel</td>
<td>Custom label to be displayed at the top of the screen.</td>
</tr>
</table>
<div class="block sub_block" id="WFE_LIST_OPTION_setFastScroll">
<span class="title">setFastScroll()<span class="subtitle param"></span><span class="subtitle s s100"></span></span>
<table class="method_details">
<tr>
<th>Annotation</th>
<th>Type</th>
<th>Default</th>
<th>Description</th>
</tr>
<tr>
<td>@NonNull</td>
<td>boolean</td>
<td>true</td>
<td>If true, the user can scroll through multiples items while swiping. If false, for each swipe the user will scroll only one item.</td>
</tr>
</table>
</div>
<div class="block sub_block" id="WFE_LIST_OPTION_isFastScroll">
<span class="title">isFastScroll()<span class="subtitle ret"></span><span class="subtitle s s100"></span></span>
<table class="method_details">
<tr>
<th>Type</th>
<th>Description</th>
</tr>
<tr>
<td>boolean</td>
<td>Whether fast scroll is enabled.</td>
</tr>
</table>
</div>
<div class="block sub_block" id="WFE_LIST_OPTION_displayName">
<span class="title">setDisplayOptionNameWhenSelected()<span class="subtitle param"></span><span class="subtitle s s100"></span></span>
<table class="method_details">
<tr>
<th>Annotation</th>
<th>Type</th>
<th>Default</th>
<th>Description</th>
</tr>
<tr>
<td>@NonNull</td>
<td>boolean</td>
<td>false</td>
<td>If true, a toast will be displayed with the displayName, of the selected item, set on the ListUserStyleSetting.ListOption.</td>
</tr>
</table>
</div>
<div class="block sub_block" id="WFE_LIST_OPTION_isDisplayName">
<span class="title">isToDisplayOptionNameWhenSelected()<span class="subtitle ret"></span><span class="subtitle s s100"></span></span>
<table class="method_details">
<tr>
<th>Type</th>
<th>Description</th>
</tr>
<tr>
<td>boolean</td>
<td>Whether a toast should be displayed with the displayName of the selected item.</td>
</tr>
</table>
</div>
<div class="block sub_block" id="WFE_LIST_OPTION">
<span class="title">User Interface</span>
<div class="screenshots">
<img src="img/ui/l_0.png" loading="lazy">
<img src="img/ui/l_1.png" loading="lazy">
</div>
</div>
</div>
<div class="block sub_block sub_block2" id="WFE_COLOR_LIST_OPTION">
<span class="title">WFEColorListOption<span class="subtitle const"></span><span class="subtitle s s100"></span></span>
<div class="text multiline">
<p>Class responsible for rendering the basic color list option screen.</p>
<p>The user can swipe up and down to switch between each color item.</p>
<p>The list "scrollbar" will render up to 9 items, but more items will be displayed, if avaiable, while scrolling.</p>
<p>This option uses the ListUserStyleSetting to render the colors.</p>
<p>Each ListUserStyleSetting.ListOption will represent one item.</p>
<p>Each color MUST be set, as hex string, in the displayName for each ListUserStyleSetting.ListOption. To display more than one color for item, separate each hex string using commans.</p>
</div>
<pre><code class="language-java">
// Example of ListUserStyleSetting.ListOption (not part of the editor/constructor).
new UserStyleSetting.ListUserStyleSetting.ListOption(
new UserStyleSetting.Option.Id("optionIdHere"),
getResources(),
R.string.option_string_here, // <<<< FOR ONE COLOR "#FF0000"
null);
// OR
new UserStyleSetting.ListUserStyleSetting.ListOption(
new UserStyleSetting.Option.Id("optionIdHere"),
getResources(),
R.string.option_string_here, // <<<< FOR N COLORS "#FF0000, #00FF00, ..."
null);
</code></pre>
<table class="method_details">
<tr>
<th>Annotation</th>
<th>Type</th>
<th>Name</th>
<th>Description</th>
</tr>
<tr>
<td>@NonNull</td>
<td>UserStyleSetting.Id</td>
<td>id</td>
<td>Id used to create the ListUserStyleSetting. This constructor will try to get the displayName used during the creation of the ListUserStyleSetting.</td>
</tr>
</table>
<table class="method_details">
<tr>
<th>Annotation</th>
<th>Type</th>
<th>Name</th>
<th>Description</th>
</tr>
<tr>
<td>@NonNull</td>
<td>UserStyleSetting.Id</td>
<td>id</td>
<td>Id used to create the ListUserStyleSetting.</td>
</tr>
<tr>
<td>@NonNull</td>
<td>String</td>
<td>customLabel</td>
<td>Custom label to be displayed at the top of the screen.</td>
</tr>
</table>
<div class="block sub_block" id="WFE_COLOR_LIST_OPTION_getId">
<span class="title">getId()<span class="subtitle ret"></span><span class="subtitle s s100"></span></span>
<table class="method_details">
<tr>
<th>Type</th>
<th>Description</th>
</tr>
<tr>
<td>UserStyleSetting.Id</td>
<td>Id passed to the constructor representing the corresponding ListUserStyleSetting.</td>
</tr>
</table>
</div>
<div class="block sub_block" id="WFE_COLOR_LIST_OPTION_setFastScroll">
<span class="title">setFastScroll()<span class="subtitle param"></span><span class="subtitle s s100"></span></span>
<table class="method_details">
<tr>
<th>Annotation</th>
<th>Type</th>
<th>Default</th>
<th>Description</th>
</tr>
<tr>
<td>@NonNull</td>
<td>boolean</td>
<td>true</td>
<td>If true, the user can scroll through multiples items while swiping. If false, for each swipe the user will scroll only one item.</td>
</tr>
</table>
</div>
<div class="block sub_block" id="WFE_COLOR_LIST_OPTION_isFastScroll">
<span class="title">isFastScroll()<span class="subtitle ret"></span><span class="subtitle s s100"></span></span>
<table class="method_details">
<tr>
<th>Type</th>
<th>Description</th>
</tr>
<tr>
<td>boolean</td>
<td>Whether fast scroll is enabled.</td>
</tr>
</table>
</div>
<div class="block sub_block" id="WFE_COLOR_LIST_OPTION">
<span class="title">User Interface</span>
<div class="screenshots">
<img src="img/ui/cl_0.png" loading="lazy">
<img src="img/ui/cl_1.png" loading="lazy">
<img src="img/ui/cl_2.png" loading="lazy">
</div>
</div>
</div>
<div class="block sub_block sub_block2" id="WFE_DYNAMIC_COLOR_PICKER_OPTION">
<span class="title">WFEDynamicColorPickerOption<span class="subtitle const"></span><span class="subtitle s s100"></span></span>
<div class="text multiline">
<p>Class responsible for rendering a color picker.</p>
<p>The user can swipe up and down to scroll through the picker. If the user swipe on the left half of the screen, the left scroller will move. If the user swipe on the right half of the screen, the right scroller will move.</p>
<p>This option uses the CustomValueUserStyleSetting to return the color picked. The color picked will be in string hex format (Example: "#FF0000").
<p>The default UserStyleSetting.Id string for the CustomValueUserStyleSetting.CustomValueOption is "CustomValue".</p>
</div>
<div class="text">
<p><b>*</b>Only one CustomValueUserStyleSetting is allowed. <u>This is a limitation of Wear OS.</u> Therefore this option will get in conflict with <span class="text_link" data-goto="WFE_STATIC_COLOR_PICKER_OPTION">WFEStaticColorPickerOption</span> if both options are added to the editor. This option will also get in conflict with itself if more than one is added to the editor.</p>
</div>
<table class="method_details">
<tr>
<th>Annotation</th>
<th>Type</th>
<th>Name</th>
<th>Description</th>
</tr>
<tr>
<td>@NonNull</td>
<td>String</td>
<td>label</td>
<td>Label to be displayed at the top of the screen.</td>
</tr>
</table>
<div class="block sub_block" id="WFE_DYNAMIC_COLOR_PICKER_OPTION">
<span class="title">User Interface</span>
<div class="screenshots">
<img src="img/ui/cd_0.png" loading="lazy">
<img src="img/ui/cd_1.png" loading="lazy">
</div>
</div>
</div>
<div class="block sub_block sub_block2" id="WFE_STATIC_COLOR_PICKER_OPTION">
<span class="title">WFEStaticColorPickerOption<span class="subtitle const"></span><span class="subtitle s s100"></span></span>
<div class="text multiline">
<p>Class responsible for rendering a color picker in list format.</p>
<p>The user can swipe up and down to switch between each list item.</p>
<p>This option uses the CustomValueUserStyleSetting to return the color picked. The color picked will be in string hex format (Example: "#FF0000").
<p>The default UserStyleSetting.Id string for the CustomValueUserStyleSetting.CustomValueOption is "CustomValue".</p>
</div>
<div class="text">
<p><b>*</b>Only one CustomValueUserStyleSetting is allowed. <u>This is a limitation of Wear OS.</u> Therefore this option will get in conflict with <span class="text_link" data-goto="WFE_DYNAMIC_COLOR_PICKER_OPTION">WFEDynamicColorPickerOption</span> if both options are added to the editor. This option will also get in conflict with itself if more than one is added to the editor.</p>
</div>
<table class="method_details">
<tr>
<th>Annotation</th>
<th>Type</th>
<th>Name</th>
<th>Description</th>
</tr>
<tr>
<td>@NonNull</td>
<td>String</td>
<td>label</td>
<td>Label to be displayed at the top of the screen.</td>
</tr>
</table>
<div class="block sub_block" id="WFE_STATIC_COLOR_PICKER_OPTION_setFastScroll">
<span class="title">setFastScroll()<span class="subtitle param"></span><span class="subtitle s s100"></span></span>
<table class="method_details">
<tr>
<th>Annotation</th>
<th>Type</th>
<th>Default</th>
<th>Description</th>
</tr>
<tr>
<td>@NonNull</td>
<td>boolean</td>
<td>true</td>
<td>If true, the user can scroll through multiples items while swiping. If false, for each swipe the user will scroll only one item.</td>
</tr>
</table>
</div>
<div class="block sub_block" id="WFE_STATIC_COLOR_PICKER_OPTION_isFastScroll">
<span class="title">isFastScroll()<span class="subtitle ret"></span><span class="subtitle s s100"></span></span>
<table class="method_details">
<tr>
<th>Type</th>
<th>Description</th>
</tr>
<tr>
<td>boolean</td>
<td>Whether fast scroll is enabled.</td>
</tr>
</table>
</div>
<div class="block sub_block" id="WFE_STATIC_COLOR_PICKER_OPTION">
<span class="title">User Interface</span>
<div class="screenshots">
<img src="img/ui/cs_0.png" loading="lazy">
<img src="img/ui/cs_1.png" loading="lazy">
<img src="img/ui/cs_2.png" loading="lazy">
</div>
</div>
<div class="block sub_block" id="WFE_STATIC_COLOR_PICKER_OPTION">
<span class="title">Colors</span>
<div class="text">
<p>129 colors are available in this color picker:</p>
</div>
<div class="colors">
<div data-c="#FE3333"></div><div data-c="#FE5433"></div><div data-c="#FE7333"></div><div data-c="#FE8C33"></div><div data-c="#FEA833"></div><div data-c="#FEC033"></div><div data-c="#FED633"></div><div data-c="#FEE833"></div><div data-c="#FEFB33"></div><div data-c="#E8FE33"></div><div data-c="#D0FE33"></div><div data-c="#B7FE33"></div><div data-c="#9BFE33"></div><div data-c="#54FE33"></div><div data-c="#33FE54"></div><div data-c="#33FE76"></div><div data-c="#33FEA8"></div><div data-c="#33FED3"></div><div data-c="#33FEFB"></div><div data-c="#33D6FE"></div><div data-c="#33ABFE"></div><div data-c="#338FFE"></div><div data-c="#3370FE"></div><div data-c="#334EFE"></div><div data-c="#4233FE"></div><div data-c="#7633FE"></div><div data-c="#9B33FE"></div><div data-c="#C933FE"></div><div data-c="#E833FE"></div><div data-c="#FE33FB"></div><div data-c="#FE33E2"></div><div data-c="#FE33C3"></div><div data-c="#FE33A1"></div><div data-c="#FE337C"></div><div data-c="#FE3373"></div><div data-c="#FF0000"></div><div data-c="#FF2700"></div><div data-c="#FF4600"></div><div data-c="#FF7C00"></div><div data-c="#FFB200"></div><div data-c="#FFF000"></div><div data-c="#E8FF00"></div><div data-c="#B2FF00"></div><div data-c="#7CFF00"></div><div data-c="#4DFF00"></div><div data-c="#13FF00"></div><div data-c="#00FF23"></div><div data-c="#00FF6C"></div><div data-c="#00FFB9"></div><div data-c="#00FFFB"></div><div data-c="#00C1FF"></div><div data-c="#0087FF"></div><div data-c="#0042FF"></div><div data-c="#0004FF"></div><div data-c="#4600FF"></div><div data-c="#7400FF"></div><div data-c="#9E00FF"></div><div data-c="#C900FF"></div><div data-c="#F700FF"></div><div data-c="#FF00CD"></div><div data-c="#FF00A6"></div><div data-c="#FF0083"></div><div data-c="#FF8383"></div><div data-c="#FFA483"></div><div data-c="#FFBB83"></div><div data-c="#FFD483"></div><div data-c="#FFF083"></div><div data-c="#F6FF83"></div><div data-c="#D7FF83"></div><div data-c="#BBFF83"></div><div data-c="#A1FF83"></div><div data-c="#83FF86"></div><div data-c="#83FFA4"></div><div data-c="#83FFC8"></div><div data-c="#83FFE3"></div><div data-c="#83FFF9"></div><div data-c="#83E6FF"></div><div data-c="#83C3FF"></div><div data-c="#839BFF"></div><div data-c="#8E83FF"></div><div data-c="#B283FF"></div><div data-c="#CE83FF"></div><div data-c="#E883FF"></div><div data-c="#FB83FF"></div><div data-c="#FF83EE"></div><div data-c="#FF83D9"></div><div data-c="#FF83BF"></div><div data-c="#FF83AE"></div><div data-c="#D99393"></div><div data-c="#D9A293"></div><div data-c="#D9AD93"></div><div data-c="#D9BF93"></div><div data-c="#D9D593"></div><div data-c="#BAD993"></div><div data-c="#A2D993"></div><div data-c="#93D999"></div><div data-c="#93D9AB"></div><div data-c="#93D9C1"></div><div data-c="#93D5D9"></div><div data-c="#93C4D9"></div><div data-c="#93B7D9"></div><div data-c="#93A4D9"></div><div data-c="#9399D9"></div><div data-c="#9D93D9"></div><div data-c="#A693D9"></div><div data-c="#B493D9"></div><div data-c="#C193D9"></div><div data-c="#CD93D9"></div><div data-c="#D993D7"></div><div data-c="#D993CB"></div><div data-c="#D993BB"></div><div data-c="#FFFFFF"></div><div data-c="#F5F5F5"></div><div data-c="#E9E9E9"></div><div data-c="#DCDCDC"></div><div data-c="#D3D3D3"></div><div data-c="#C6C6C6"></div><div data-c="#B9B9B9"></div><div data-c="#AEAEAE"></div><div data-c="#A1A1A1"></div><div data-c="#979797"></div><div data-c="#898989"></div><div data-c="#787878"></div><div data-c="#686868"></div><div data-c="#5D5D5D"></div><div data-c="#4E4E4E"></div><div data-c="#404040"></div><div data-c="#2B2B2B"></div><div data-c="#000000"></div>
</div>
</div>
</div>
<div class="block sub_block sub_block2" id="WFE_COMPLICATION_OPTION">
<span class="title">WFEComplicationOption<span class="subtitle const"></span><span class="subtitle s s100"></span></span>
<div class="text multiline">
<p>Class responsible for rendering a complication picker.</p>
<p>The user can tap on the desired slot to add a complication.</p>
<p>This option screen can be used multiple times.</p>
</div>
<table class="method_details">
<tr>
<th>Annotation</th>
<th>Type</th>
<th>Name</th>
<th>Description</th>
</tr>
<tr>
<td>-</td>
<td>-</td>
<td>-</td>
<td>This constructor receives no parameters. It will try to display all complications that are registered in your ComplicationSlotsManager. By default the label displayed using this constructor is "Complication" (for "pt-BR" language the default label will be "Info. Extra").</td>
</tr>
</table>
<table class="method_details">
<tr>
<th>Annotation</th>
<th>Type</th>
<th>Name</th>
<th>Description</th>
</tr>
<tr>
<td>@NonNull</td>
<td>String</td>
<td>customLabel</td>
<td>This constructor will try to display all complications that are registered in your ComplicationSlotsManager, along with a custom label to be displayed at the top of the screen.</td>
</tr>
</table>
<table class="method_details">
<tr>
<th>Annotation</th>
<th>Type</th>
<th>Name</th>
<th>Description</th>
</tr>
<tr>
<td>@NonNull</td>
<td>int...</td>
<td>ids</td>
<td>IDs of the ComplicationSlots that should be displayed. If the ID is not passed, the complication slot picker will not be rendered in this screen. By default the label displayed using this constructor is "Complication" (for "pt-BR" language the default label will be "Info. Extra").</td>
</tr>
</table>
<table class="method_details">
<tr>
<th>Annotation</th>
<th>Type</th>
<th>Name</th>
<th>Description</th>
</tr>
<tr>
<td>@NonNull</td>
<td>String</td>
<td>customLabel</td>
<td>Custom label to be displayed at the top of the screen.</td>
</tr>
<tr>
<td>@NonNull</td>
<td>int...</td>
<td>ids</td>
<td>IDs of the ComplicationSlots that should be displayed. If the ID is not passed, the complication slot picker will not be rendered in this screen.</td>
</tr>
</table>
<div class="block sub_block" id="WFE_COMPLICATION_OPTION">
<span class="title">User Interface</span>
<div class="screenshots">
<img src="img/ui/c_0.png" loading="lazy">
<img src="img/ui/c_1.png" loading="lazy">
<img src="img/ui/c_2.png" loading="lazy">
<img src="img/ui/c_3.png" loading="lazy">
<img src="img/ui/c_4.png" loading="lazy">
</div>
</div>
</div>
<div class="block sub_block sub_block2" id="WFE_DOUBLE_RANGE_OPTION">
<span class="title">WFEDoubleRangeOption<span class="subtitle const"></span><span class="subtitle s s100"></span></span>
<div class="text multiline">
<p>Class responsible for rendering a range input. This range input allow decimal values.</p>
<p>The minimum and maximum values are set in the DoubleRangeUserStyleSetting.</p>
</div>
<table class="method_details">
<tr>
<th>Annotation</th>
<th>Type</th>
<th>Name</th>
<th>Description</th>
</tr>
<tr>
<td>@NonNull</td>
<td>UserStyleSetting.Id</td>
<td>id</td>
<td>Id used to create the DoubleRangeUserStyleSetting. This constructor will try to get the displayName used during the creation of the DoubleRangeUserStyleSetting.</td>
</tr>
</table>
<table class="method_details">
<tr>
<th>Annotation</th>
<th>Type</th>
<th>Name</th>
<th>Description</th>
</tr>
<tr>