/
wizard.xbl
978 lines (858 loc) · 60.6 KB
/
wizard.xbl
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
<!--
Copyright (C) 2012 Orbeon, Inc.
This program is free software; you can redistribute it and/or modify it under the terms of the
GNU Lesser General Public License as published by the Free Software Foundation; either version
2.1 of the License, or (at your option) any later version.
This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY;
without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
See the GNU Lesser General Public License for more details.
The full text of the license is available at http://www.gnu.org/copyleft/lesser.html
-->
<xbl:xbl
xmlns:xh="http://www.w3.org/1999/xhtml"
xmlns:xf="http://www.w3.org/2002/xforms"
xmlns:xs="http://www.w3.org/2001/XMLSchema"
xmlns:xxf="http://orbeon.org/oxf/xml/xforms"
xmlns:fr="http://orbeon.org/oxf/xml/form-runner"
xmlns:xbl="http://www.w3.org/ns/xbl"
xmlns:xxbl="http://orbeon.org/oxf/xml/xbl"
xmlns:xsl="http://www.w3.org/1999/XSL/Transform"
xmlns:oxf="http://www.orbeon.com/oxf/processors"
xmlns:frf="java:org.orbeon.oxf.fr.FormRunner"
xmlns:array="http://www.w3.org/2005/xpath-functions/array"
xmlns:map="http://www.w3.org/2005/xpath-functions/map"
xmlns:ErrorSummary="java:org.orbeon.xbl.ErrorSummary"
xmlns:Wizard="java:org.orbeon.xbl.Wizard">
<xbl:binding
id="fr-wizard"
element="fr|wizard"
xxf:external-events="fr-wizard-focus">
<xbl:resources>
<xbl:style src="/xbl/orbeon/wizard/wizard.css"/>
</xbl:resources>
<xbl:handlers>
<xbl:handler event="fr-prev" phase="target">
<!-- NOTE: The target shouldn't be in the outer scope ideally. -->
<xf:dispatch
name="DOMActivate"
targetid="fr-wizard-prev"
xxbl:scope="outer"/>
</xbl:handler>
<xbl:handler event="fr-next" phase="target">
<!-- NOTE: The target shouldn't be in the outer scope ideally. -->
<xf:dispatch
name="DOMActivate"
targetid="fr-wizard-next"
xxbl:scope="outer"/>
</xbl:handler>
<xbl:handler event="fr-show-toc" phase="target">
<xf:action if="$local/separate-toc/data(.)">
<xf:setvalue
ref="$local/show-toc"
value="true()"/>
<xf:setvalue
ref="$local/show-body"
value="false()"/>
</xf:action>
</xbl:handler>
<xbl:handler event="fr-update-validity" phase="target">
<!-- NOTE: The target shouldn't be in the outer scope ideally. -->
<xf:dispatch
name="DOMActivate"
targetid="fr-wizard-update-validity"
xxbl:scope="outer"/>
</xbl:handler>
<xbl:handler event="fr-visit-all" phase="target">
<!-- See https://github.com/orbeon/orbeon-forms/issues/3178 -->
<!-- NOTE: The target shouldn't be in the outer scope ideally. -->
<xf:dispatch
if="xxf:instance('local')/validate/data(.) = 'free'"
name="fr-wizard-visit-all"
targetid="fr-wizard-visit-all"
xxbl:scope="outer"/>
<xf:dispatch
if="xxf:instance('local')/validate/data(.) != 'free'"
name="fr-wizard-visit-all-to-current"
targetid="fr-wizard-visit-all-to-current"
xxbl:scope="outer"/>
</xbl:handler>
<!-- For client-side API -->
<xbl:handler event="fr-wizard-focus" phase="target">
<!-- TODO: Support `lax` and `strict` modes. -->
<xf:action if="xxf:instance('local')/validate/data(.) = 'free'">
<xf:setfocus
control="{event('fr-control-name')}-control"
xxf:repeat-indexes="{event('fr-repeat-indexes')}"
xxbl:scope="outer"/>
</xf:action>
</xbl:handler>
<!-- When a page/section is shown, create the associated `fr:section-status` attribute if needed -->
<xbl:handler event="fr-section-shown" phase="target">
<xf:var
name="section-binding"
value="event('section-binding')"/>
<xf:insert
if="not(exists($section-binding/@fr:section-status))"
context="$section-binding"
origin="xf:attribute('fr:section-status', '')"/>
<xf:dispatch
name="fr-update-section-status"
targetid="fr-wizard-outer-group"
xxbl:scope="outer"/>
</xbl:handler>
</xbl:handlers>
<xbl:implementation>
<xf:model>
<xf:instance id="local" xxf:expose-xpath-types="true">
<local>
<current-case-id/>
<show-toc/>
<show-body/>
<readwrite/>
<validate/>
<separate-toc/>
</local>
</xf:instance>
<xf:var name="local" value="instance('local')"/>
<xf:bind ref="validate" xxf:default="Wizard:normalizeWizardMode(xxf:component-param-value('validate'))"/>
<xf:bind ref="separate-toc" type="xs:boolean" xxf:default="Wizard:isWizardSeparateToc()"/>
<xf:bind ref="show-toc" type="xs:boolean" xxf:default="true()"/>
<xf:bind ref="show-body" type="xs:boolean" xxf:default="not(Wizard:isWizardSeparateToc())"/>
<xf:instance id="available-top-level-sections" xxf:expose-xpath-types="true">
<available-top-level-sections/>
</xf:instance>
</xf:model>
</xbl:implementation>
<xbl:template xxbl:transform="oxf:unsafe-xslt">
<xsl:transform version="2.0">
<xsl:import href="oxf:/oxf/xslt/utils/copy-modes.xsl"/>
<!-- `app` and `form` must be passed as attributes (see view.xsl) -->
<xsl:variable name="static-app" select="/*/@app/string()"/>
<xsl:variable name="static-form" select="/*/@form/string()"/>
<xsl:variable name="static-validation-mode" select="/*/@validation-mode/string()"/>
<xsl:variable name="do-next-handler" as="element()">
<xf:action event="DOMActivate">
<xsl:choose>
<xsl:when test="$static-validation-mode = 'explicit'">
<!-- Update validity, refresh, then try again -->
<xxf:update-validity
control="{{string-join(($prev-nav-case-ids, $current-nav-case-id), ' ')}}"
recurse="true"/>
<!-- This ensures that when `fr-do-next` runs, UI variables have been updated -->
<xf:refresh/>
</xsl:when>
<xsl:otherwise>
<!-- Do action immediately -->
</xsl:otherwise>
</xsl:choose>
<xf:dispatch
name="fr-do-next"
targetid="{{event('xxf:targetid')}}"/>
</xf:action>
</xsl:variable>
<xsl:variable
xmlns:p="http://www.orbeon.com/oxf/pipeline"
name="static-subsections-nav"
select="p:property(string-join(('oxf.xforms.xbl.fr.wizard.subsections-nav', $static-app, $static-form), '.')) = true()"
as="xs:boolean"/>
<!-- `all | active | none` -->
<xsl:variable
xmlns:p="http://www.orbeon.com/oxf/pipeline"
name="static-subsections-toc"
select="
(
p:property(string-join(('oxf.xforms.xbl.fr.wizard.subsections-toc', $static-app, $static-form), '.'))[. = ('all', 'none')],
'active'
)[1]"
as="xs:string"/>
<xsl:variable
name="static-nav-sections-or-grids"
select="
if ($static-subsections-nav) then
/*//(
fr:section[
(
(: Top-level section :)
count(ancestor::fr:section) = 0 and (
empty(fr:section) or
@subsections-nav = 'false' or
frf:isRepeat(.)
)
) or (
(: First-level subsection :)
count(ancestor::fr:section) = 1 and
not(../@subsections-nav = 'false') and
not(frf:isRepeat(..))
)
],
(: Grid within a top-level section which also contains subsections
and top-level section doesn't have Subsection navigation explicitly
disabled and is not repeated :)
fr:grid[
count(ancestor::fr:section) = 1 and
not(../@subsections-nav = 'false') and
not(frf:isRepeat(..)) and
exists((preceding-sibling::fr:section | following-sibling::fr:section))
]
)
else
(: Top-level sections :)
/*/fr:section
"/>
<xsl:variable
name="static-matching-top-level-section-ids"
select="
(
for $s in $static-nav-sections-or-grids
return $s/ancestor-or-self::fr:section[last()]
)/@id
"/>
<xsl:variable
name="static-nav-section-or-grid-ids"
select="$static-nav-sections-or-grids/((@id/string(), concat(generate-id(), '-wizard-grid'))[1])"/>
<xsl:variable
name="static-top-level-section-ids"
select="/*/fr:section/@id/string()"/>
<xsl:template match="/*">
<xf:group appearance="xxf:internal">
<xh:div class="fr-wizard-body{{if (xxf:instance('local')/show-body/data(.)) then '' else ' xforms-hidden'}}">
<!-- FIXME: Don't like that this is a top-level `switch` id! -->
<xf:switch id="switch" xbl:attr="caseref=sectionref" xxf:element="div" xxbl:scope="outer">
<!-- We need a way to listen to each case, but we don't want to duplicate the script and
anyway event.target doesn't work within case (which would be a bug) -->
<xf:action type="javascript" event="fr-section-scroll" target="#observer">
<![CDATA[
var $ = ORBEON.jQuery;
var target = event.target;
var sectionTitle = $(target).closest('.xbl-fr-wizard').find('.fr-wizard-body .xforms-case-selected .fr-section-title')[0];
if (sectionTitle) {
var r = sectionTitle.getBoundingClientRect();
if (r.top < 0 || r.bottom > $(window).height()) {
window.scrollTo($(window).scrollLeft(), $(sectionTitle).offset().top);
}
}
]]>
</xf:action>
<!-- Wrap each top-level fr:section within each own case -->
<xsl:for-each select="fr:section">
<xsl:variable name="static-section-id" select="@id"/>
<xf:case id="{$static-section-id}-case">
<xsl:if test="/*/@sectionref">
<xsl:attribute
name="value"
select="concat('''', frf:controlNameFromId($static-section-id), '''')"
xmlns:frf="java:org.orbeon.oxf.fr.FormRunner"/>
</xsl:if>
<!-- Visit current section when leaving it -->
<xxf:setvisited
event="xforms-deselect"
target="#observer"
control="{{event('xxf:targetid')}}"
visited="true"
recurse="true"/>
<!-- Check that incoming `xforms-focus` is allowed -->
<!-- TODO: See https://github.com/orbeon/orbeon-forms/issues/3323. -->
<!-- Un-visit all subsequent sections upon error in current section in `strict` mode -->
<!-- Use `delay="0"`, so we dispatch all the `fr-wizard-unvisit-following` after all the
`xforms-invalid`, avoiding a `StackOverflowError` on large forms -->
<xf:dispatch
event="xforms-invalid"
if="xxf:instance('local')/validate/data(.) = 'strict'"
name="fr-wizard-unvisit-following"
targetid="fr-wizard-unvisit-following"
delay="0"/>
<!-- Subsection nav enabled AND the top-level section is not part of the nav, which
means we navigate it's subsections/grids. -->
<xsl:variable
name="has-subsection-nav"
select="$static-subsections-nav and not($static-nav-section-or-grid-ids = @id)"/>
<xf:action event="xforms-select" target="#observer">
<xsl:if test="not($has-subsection-nav)">
<!-- Keep `current-case-id` up to date in case switch happened via toggling. -->
<!-- Q: Could we use `caseref`? -->
<xf:setvalue
ref="xxf:instance('local')/current-case-id"
value="event('xxf:targetid')"/>
</xsl:if>
<xf:dispatch name="fr-section-scroll" targetid="switch"/>
<xf:var
name="section-id"
value="replace(event('xxf:targetid'), '-case$', '')"
xxbl:scope="inner"/>
<xf:dispatch name="fr-section-shown" targetid="fr-wizard" xxbl:scope="inner">
<xf:property name="section-binding" value="xxf:binding(replace(event('xxf:targetid'), '-case$', ''))" xxbl:scope="outer"/>
<xf:property name="section-name" value="frf:controlNameFromIdOpt($section-id)"/>
<xf:property name="validate" value="$local/validate/data(.)"/>
<xf:property name="separate-toc" value="$local/separate-toc/data(.)"/>
</xf:dispatch>
</xf:action>
<xf:group appearance="xxf:internal">
<!-- Update section status upon incremental changes to controls.
- `fr:error-summary` listens to events during the capture phase so that it is up to
date once the wizard processes them.
- We don't listen to `xforms-enabled` here because we have `fr-section-shown`.
- `xxforms-constraints-changed` subsumes `xforms-valid`/`xforms-invalid`.
-->
<xf:action event="xxforms-constraints-changed xforms-disabled" xxf:phantom="true">
<xf:dispatch name="fr-update-section-status" targetid="fr-wizard-outer-group"/>
</xf:action>
<xsl:copy>
<xsl:attribute name="collapse">false</xsl:attribute>
<xsl:apply-templates select="@* except (@collapse | @open)"/>
<!-- Update the `changed` token -->
<xf:action event="xforms-value-changed">
<xf:setvalue
ref="@fr:section-status"
value="
let $tokens := distinct-values(xxf:split(.))
return
if (empty(index-of($tokens, 'changed'))) then
string-join(($tokens, 'changed'), ' ')
else
."/>
</xf:action>
<xsl:choose>
<xsl:when test="$has-subsection-nav">
<!-- Don't forget the enclosing section lHHA -->
<xsl:apply-templates select="xf:label | xf:help | xf:hint | xf:alert"/>
<!-- Subsections -->
<xf:switch id="{$static-section-id}-switch" xxf:element="div">
<xsl:for-each select="fr:section | fr:grid">
<!-- fr:grid might not have an id, and we need one to toggle -->
<xsl:variable name="section-or-grid-id" select="(@id, concat(generate-id(), '-wizard-grid'))[1]"/>
<xf:case id="{$section-or-grid-id}-case">
<xxf:setvisited
event="xforms-deselect"
target="#observer"
control="{{event('xxf:targetid')}}"
visited="true"
recurse="true"/>
<xf:action event="xforms-select" target="#observer">
<!-- Keep `current-case-id` up to date in case switch happened via toggling. -->
<!-- Q: Could we use `caseref`? -->
<xf:setvalue
ref="xxf:instance('local')/current-case-id"
value="event('xxf:targetid')"/>
<xf:dispatch name="fr-section-scroll" targetid="switch"/>
</xf:action>
<xf:group appearance="xxf:internal">
<xsl:copy>
<xsl:if test="self::fr:section">
<xsl:attribute name="collapse">false</xsl:attribute>
</xsl:if>
<xsl:if test="not(@id)">
<xsl:attribute name="id" select="$section-or-grid-id"/>
</xsl:if>
<xsl:apply-templates select="@* except (@collapse | @open) | node()"/>
</xsl:copy>
</xf:group>
</xf:case>
</xsl:for-each>
</xf:switch>
</xsl:when>
<xsl:otherwise>
<!-- No subsection nav -->
<xsl:apply-templates select="node()"/>
</xsl:otherwise>
</xsl:choose>
</xsl:copy>
</xf:group>
</xf:case>
</xsl:for-each>
</xf:switch>
</xh:div>
<xf:group
class="fr-wizard-toc{{
' xforms-hidden' [not($local/show-toc/data(.))],
' fr-wizard-separate-toc'[$local/separate-toc/data(.)]
}}">
<!-- Dispatch fr-toc-shown event as needed -->
<xf:group appearance="xxf:internal" ref=".[$local/show-toc/data(.)]">
<xf:action
event="xforms-enabled"
target="#observer">
<xf:dispatch
name="fr-toc-shown"
targetid="fr-wizard">
<xf:property name="validate" value="$local/validate/data(.)"/>
<xf:property name="separate-toc" value="$local/separate-toc/data(.)"/>
</xf:dispatch>
</xf:action>
</xf:group>
<xf:group appearance="xxf:internal" xxbl:scope="outer" id="fr-wizard-outer-group">
<!-- Statically-known section and grid ids -->
<xf:var
name="nav-section-or-grid-ids"
value="{string-join(for $id in $static-nav-section-or-grid-ids return concat('''', $id, ''''), ',')}"/>
<xf:var
name="nav-matching-top-level-section-ids"
value="{string-join(for $id in $static-matching-top-level-section-ids return concat('''', $id, ''''), ',')}"/>
<xf:var
name="top-level-section-ids"
value="{string-join(for $id in $static-top-level-section-ids return concat('''', $id, ''''), ',')}"/>
<xf:var
name="validated-mode"
value="xxf:instance('local')/validate/data(.) != 'free'"/>
<xf:var
name="separate-toc-mode"
value="xxf:instance('local')/separate-toc/data(.)"/>
<xf:var
name="relevant-nav-section-or-grid-ids"
value="
$nav-section-or-grid-ids[xxf:is-control-relevant(.)]"/>
<!-- TODO: maybe use xxf:is-control-relevant(.) too -->
<xf:var
name="relevant-top-level-section-ids"
value="
$top-level-section-ids[
exists(xxf:binding(.)) and xxf:relevant(xxf:binding(.))
]"/>
<xf:var
name="relevant-nav-case-ids"
value="
for $section-id in $relevant-nav-section-or-grid-ids
return concat($section-id, '-case')"/>
<xf:var
name="relevant-top-level-case-ids"
value="
for $section-id in $relevant-top-level-section-ids
return concat($section-id, '-case')"/>
<xf:var
name="current-top-level-case-id"
value="case('switch')"/>
<!-- NOTE: Initially, current-case-id might be empty, so default to the first relevant case id. -->
<xf:var
name="current-nav-case-id"
value="(xxf:instance('local')/current-case-id[xxf:non-blank()]/string(), $relevant-nav-case-ids)[1]"/>
<xf:var
name="nav-case-index"
value="index-of($relevant-nav-case-ids, $current-nav-case-id)"/>
<xf:var
name="top-level-case-index"
value="index-of($relevant-top-level-case-ids, $current-top-level-case-id)"/>
<xf:var
name="prev-nav-case-ids"
value="$relevant-nav-case-ids[position() lt $nav-case-index]"/>
<xf:var
name="next-nav-case-ids"
value="$relevant-nav-case-ids[position() gt $nav-case-index]"/>
<xf:var
name="next-top-level-case-ids"
value="$relevant-top-level-case-ids[position() gt $top-level-case-index]"/>
<xf:var
name="allow-next-top-level"
value="
let $next-top-level-case-id := $next-top-level-case-ids[1]
return
exists($next-top-level-case-id) and
exists(
index-of(
xxf:split(xxf:instance('available-top-level-sections')),
frf:controlNameFromIdOpt(replace($next-top-level-case-id, '-case$', ''))
)
)"/>
<!-- True if we can go to the next top-level section OR if next is not in different top-level section -->
<xf:var
name="allow-next"
value="
$allow-next-top-level or
replace($current-top-level-case-id, '-case$', '') =
$nav-matching-top-level-section-ids[
index-of(
$nav-section-or-grid-ids,
replace($next-nav-case-ids[1], '-case$', '')
)
]"/>
<xf:var
id="fr-wizard-is-first-nav"
name="is-first-nav"
value="empty($prev-nav-case-ids)"/>
<xf:var
id="fr-wizard-is-last-nav"
name="is-last-nav"
value="empty($next-nav-case-ids)"/>
<xf:var name="prev-button-ref" value="if (not($is-first-nav)) then xxf:instance('local')/readwrite else ''"/>
<xf:var name="next-button-ref" value="if (not($is-last-nav)) then xxf:instance('local')/readwrite else ''"/>
<!-- We put this here because we need `$relevant-top-level-section-ids` -->
<xf:action event="fr-update-section-status">
<xf:var
name="maps"
value="Wizard:gatherTopLevelSectionStatusJava($relevant-top-level-section-ids)"/>
<!-- Update available sections instance -->
<!-- We do this because we don't want to run `Wizard:gatherSectionStatusJava` at each refresh, and we want to
depend on instance values, although in practice it might not make much of a difference. -->
<xf:setvalue
ref="xxf:instance('available-top-level-sections')"
value="
string-join(
for $m in $maps
return
if (map:get($m, 'is-available')) then map:get($m, 'name') else (),
' '
)"/>
<!-- Update section statuses for all relevant sections -->
<xf:action iterate="$relevant-top-level-section-ids">
<xf:var
name="section-binding"
value="xxf:binding(.)"/>
<xf:action if="exists($section-binding/@fr:section-status)">
<xf:var
name="map"
value="
for $m in $maps
return
if (map:get($m, 'name') = name($section-binding)) then $m else ()"/>
<xf:var
name="existing-tokens"
value="
distinct-values(
xxf:split($section-binding/@fr:section-status)
)"/>
<xf:var
name="new-tokens"
value="
distinct-values(
(
$existing-tokens[not(. = ('incomplete', 'invalid'))] , (: these toggle so remove them first :)
'incomplete' [map:get($map, 'has-incomplete-fields')],
'invalid' [map:get($map, 'has-error-fields')]
)
)"/>
<xf:setvalue
if="not(count($existing-tokens) = count($new-tokens) and empty($existing-tokens[not(. = $new-tokens)]))"
ref="$section-binding/@fr:section-status"
value="string-join($new-tokens, ' ')"/>
</xf:action>
</xf:action>
</xf:action>
<!-- This id is used to expose visibility to buttons outside the wizard -->
<xf:group
id="fr-wizard-submit-hide"
ref="xxf:instance('local')/readwrite[not($validated-mode) or empty($next-top-level-case-ids)]"/>
<xh:ul class="nav nav-list">
<xsl:apply-templates mode="toc-sections"/>
</xh:ul>
<xh:div class="fr-wizard-navigation{{if (xxf:instance('local')/separate-toc/data(.)) then ' xforms-hidden' else ''}}">
<xf:action event="xforms-enabled" target="#observer">
<!-- Make sure the first relevant case is shown initially -->
<!-- NOTE: Ideally, we should also handle the case where the fr:section in the
currently-selected case becomes non-relevant. However, this should not happen
in a well-designed form (that would be very user unfriendly). If xf:case supported
relevance, we might be able to let this behavior be handled by the XForms engine.
-->
<!-- Initial status (unless `xxforms-constraints-changed` ran before) -->
<xf:dispatch
name="fr-update-section-status"
targetid="fr-wizard-outer-group"/>
<!-- Find the last available AND visited section -->
<xf:var
name="last-available-and-visited-top-level-section-id"
value="
(
(: First relevant section by default :)
$relevant-top-level-section-ids[1],
(: But also check subsequent sections for availability and visited :)
(
for $id in $relevant-top-level-section-ids[position() gt 1]
return
if (
exists(
index-of(
xxf:split(xxf:instance('available-top-level-sections')),
frf:controlNameFromIdOpt($id)
)
) and
exists(xxf:binding($id)/@fr:section-status)
) then
$id
else
()
)
)[last()]"/>
<!-- Set initial current section -->
<xf:action if="exists($last-available-and-visited-top-level-section-id)">
<xf:var
name="last-available-and-visited-top-level-case-id"
value="concat($last-available-and-visited-top-level-section-id, '-case')"/>
<!-- See https://github.com/orbeon/orbeon-forms/issues/3433 -->
<xf:setvalue
ref="xxf:instance('local')/current-case-id"
value="Wizard:caseIdsForTopLevelSection($last-available-and-visited-top-level-section-id)[1]"/>
<xf:toggle
case="{{$last-available-and-visited-top-level-case-id}}"/>
<!-- Dispatch `fr-section-shown` the first time the body is shown if needed -->
<xf:action if="xxf:instance('local')/show-body/data(.)">
<xf:dispatch name="fr-section-shown" targetid="fr-wizard" xxbl:scope="inner">
<xf:property name="section-binding" value="xxf:binding($last-available-and-visited-top-level-section-id)" xxbl:scope="outer"/>
<xf:property name="section-name" value="frf:controlNameFromIdOpt($last-available-and-visited-top-level-section-id)" xxbl:scope="outer"/>
<xf:property name="validate" value="xxf:instance('local')/validate/data(.)"/>
<xf:property name="separate-toc" value="xxf:instance('local')/separate-toc/data(.)"/>
</xf:dispatch>
</xf:action>
</xf:action>
</xf:action>
<xh:div class="pagination pagination-centered">
<xh:ul>
<xh:li class="{{if ($prev-button-ref instance of xs:string) then 'disabled' else ''}}">
<xf:trigger id="fr-wizard-prev" ref="$prev-button-ref" appearance="minimal" class="fr-wizard-prev">
<!-- https://github.com/orbeon/orbeon-forms/issues/723
https://github.com/orbeon/orbeon-forms/issues/1042 -->
<xf:label>
<xh:i class="icon-chevron-left"/>​
</xf:label>
<xf:action event="DOMActivate">
<xf:setvalue
ref="xxf:instance('local')/current-case-id"
value="$prev-nav-case-ids[last()]"/>
<xf:toggle
case="{{$prev-nav-case-ids[last()]}}"/>
<xf:setfocus
control="{{$prev-nav-case-ids[last()]}}"
includes="{{frf:xpathFormRunnerStringProperty('oxf.fr.detail.focus.includes')}}"
excludes="{{frf:xpathFormRunnerStringProperty('oxf.fr.detail.focus.excludes')}}"/>
</xf:action>
</xf:trigger>
</xh:li>
<xh:li>
<xh:span class="fr-page-number">
<xf:output value="$nav-case-index"/>
<xf:output value="concat(' ', $fr-resources/summary/paging/of, ' ')"/>
<xf:output value="count($relevant-nav-case-ids)"/>
</xh:span>
</xh:li>
<xh:li class="{{if ($next-button-ref instance of xs:string) then 'disabled' else ''}}">
<xf:trigger id="fr-wizard-next" ref="$next-button-ref" appearance="minimal" class="fr-wizard-next">
<xf:label>
<xh:i class="icon-chevron-right"/>​
</xf:label>
<!-- DOMActivate handler which depends on `$static-validation-mode` -->
<xsl:copy-of select="$do-next-handler"/>
<xf:action event="fr-do-next">
<xf:dispatch
name="fr-wizard-visit-all-to-current"
targetid="fr-wizard-visit-all-to-current"/>
<xf:action if="$allow-next">
<xf:setvalue
ref="xxf:instance('local')/current-case-id"
value="$next-nav-case-ids[1]"/>
<xf:toggle
case="{{$next-nav-case-ids[1]}}"/>
<xf:setfocus
control="{{$next-nav-case-ids[1]}}"
includes="{{frf:xpathFormRunnerStringProperty('oxf.fr.detail.focus.includes')}}"
excludes="{{frf:xpathFormRunnerStringProperty('oxf.fr.detail.focus.excludes')}}"/>
</xf:action>
<xf:action if="not($allow-next)">
<xf:setfocus
control="{{$current-nav-case-id}}"
includes="{{frf:xpathFormRunnerStringProperty('oxf.fr.detail.focus.includes')}}"
excludes="{{frf:xpathFormRunnerStringProperty('oxf.fr.detail.focus.excludes')}}"/>
</xf:action>
</xf:action>
</xf:trigger>
</xh:li>
</xh:ul>
<!-- We put these here so that `$do-next-handler` has the right variables in scope -->
<!-- NOTE: This shouldn't be in the outer scope ideally. -->
<xf:group id="fr-wizard-update-validity" appearance="xxf:internal">
<xsl:copy-of select="$do-next-handler"/>
</xf:group>
<xf:group id="fr-wizard-visit-all" appearance="xxf:internal">
<xxf:setvisited
event="fr-wizard-visit-all"
control="switch"
visited="true"
recurse="true"/>
</xf:group>
<xf:group id="fr-wizard-visit-all-to-current" appearance="xxf:internal">
<!-- NOTE: We visit the current page upon xforms-deselect too. -->
<xxf:setvisited
event="fr-wizard-visit-all-to-current"
if="$validated-mode"
iterate="$prev-nav-case-ids, $current-nav-case-id"
control="{{.}}"
visited="true"
recurse="true"/>
</xf:group>
<xf:group id="fr-wizard-unvisit-following" appearance="xxf:internal">
<xxf:setvisited
event="fr-wizard-unvisit-following"
iterate="$next-nav-case-ids"
control="{{.}}"
visited="false"
recurse="true"/>
</xf:group>
</xh:div>
</xh:div>
</xf:group>
</xf:group>
<!-- In case the view contains elements other than sections (like dialogs) -->
<xh:div class="fr-wizard-other">
<xf:group appearance="xxf:internal" xxbl:scope="outer">
<xsl:apply-templates select="* except fr:section"/>
</xf:group>
</xh:div>
</xf:group>
</xsl:template>
<!-- TOC: Swallow non-relevant nodes -->
<xsl:template match="text()" mode="toc-sections"/>
<xsl:template match="*" mode="toc-sections">
<xsl:apply-templates mode="toc-sections"/>
</xsl:template>
<!-- TOC: handle section -->
<xsl:template match="fr:section" mode="toc-sections">
<xsl:variable name="static-section-id" select="@id"/>
<!-- Propagate binding so that entry for section disappears if the section is non-relevant -->
<xf:group>
<xsl:copy-of select="@model | @context | @bind | @ref"/>
<xsl:variable
name="static-current-section"
select="."/>
<xsl:variable
name="static-is-top-level-section"
select="empty($static-current-section/ancestor::fr:section)"/>
<xsl:variable
name="static-top-level-section-id"
select="($static-current-section/ancestor-or-self::fr:section/@id)[1]"/>
<xsl:variable
name="static-top-level-section-case-id"
select="concat($static-top-level-section-id, '-case')"/>
<xf:var name="top-level-section-available">
<xxf:value
value="
exists(
index-of(
xxf:split(xxf:instance('available-top-level-sections')),
'{frf:controlNameFromIdOpt($static-top-level-section-id)}'
)
)"
xxbl:scope="inner"/>
</xf:var>
<xf:var
name="top-level-section-visited"
value="exists(@fr:section-status)"/>
<xf:var
name="top-level-section-tokens"
value="xxf:split(@fr:section-status)"/>
<!-- NOTE: Only make active top-level sections -->
<xf:var
name="top-level-section-active"
value="not($separate-toc-mode) and $current-top-level-case-id = '{concat($static-section-id, '-case')}'"/>
<xh:li class="{{
'disabled' [not($top-level-section-available)],
'active' [$top-level-section-active ],
'started' [$top-level-section-visited ],
$top-level-section-tokens
}}">
<xf:var
name="section-label"
value="xxf:label('{$static-section-id}')"/>
<xf:trigger appearance="minimal">
<xf:label>
<xf:output value="$section-label"/>
<xh:span class="fr-toc-edit"><xf:output value="xxf:r('components.wizard.edit', '|fr-fr-resources|')"/></xh:span>
<xsl:if test="$static-is-top-level-section">
<!-- NOTE: Hide labels when not in `separate-toc` mode as they take a lot of space -->
<xh:span class="{{'xforms-hidden'[not(xxf:instance('local')/separate-toc/data(.))]}} label{{
if ($top-level-section-tokens = 'invalid') then
' label-important'
else if ($top-level-section-tokens = 'incomplete') then
' label-warning'
else if ($top-level-section-visited) then
' label-success'
else
''
}}"><xf:output value="
xxf:r(
if ($top-level-section-tokens = 'invalid') then
'components.wizard.errors'
else if ($top-level-section-tokens = 'incomplete') then
'components.wizard.incomplete'
else if ($top-level-section-visited) then
'components.wizard.complete'
else
'components.wizard.not-started',
'|fr-fr-resources|'
)"/></xh:span>
</xsl:if>
</xf:label>
<xf:hint value="$section-label"/>
<!-- DOMActivate handler which depends on `$static-validation-mode` -->
<xsl:copy-of select="$do-next-handler"/>
<xf:action event="fr-do-next" if="$top-level-section-available">
<!-- Figure out the nav section id based on whether we support subsection navigation AND where in the hierarchy
the clicked TOC section is. -->
<xsl:variable
name="static-nav-section-id"
select="
if ($static-subsections-nav) then
(
if ($static-is-top-level-section) then
(: Current section is a top-level section. Try first subsection or grid if any,
otherwise the top-level section itself, which means that there are no subsections
or grids. Unfortunately, there is some logic duplication between here and the
computation of `$static-nav-sections-or-grids` above. :)
(
$static-current-section[
not(@subsections-nav = 'false') and
not(frf:isRepeat(.)) and
exists(fr:section)
]/(fr:section | fr:grid)[1],
$static-current-section
)[1]
else
(: Current section is a subsection. Take first subsection from the top, as only two levels of
section navigation are supported. :)
($static-current-section/ancestor-or-self::fr:section)[2]
)/(
@id,
concat(generate-id(), '-wizard-grid')
)[1]
else
$static-top-level-section-id
"/>
<!-- Remember where we are toggling to, toggle... -->
<xf:setvalue
ref="xxf:instance('local')/current-case-id"
value="'{$static-nav-section-id}-case'"/>
<xf:toggle
case="{$static-nav-section-id}-case"/>
<!-- ...and always focus on specific sub-section -->
<xf:setfocus
control="{$static-section-id}"
includes="{{frf:xpathFormRunnerStringProperty('oxf.fr.detail.focus.includes')}}"
excludes="{{frf:xpathFormRunnerStringProperty('oxf.fr.detail.focus.excludes')}}"/>
<!-- Show body if needed -->
<xf:var name="local" value="xxf:instance('local')"/>
<xf:action if="$local/separate-toc/data(.)">
<xf:setvalue
ref="$local/show-toc"
value="false()"/>
<xf:setvalue
ref="$local/show-body"
value="true()"/>
</xf:action>
</xf:action>
</xf:trigger>
<xsl:choose>
<xsl:when test="$static-subsections-toc = 'all' and exists(.//fr:section)">
<xh:ul class="nav nav-list">
<xsl:apply-templates mode="toc-sections"/>
</xh:ul>
</xsl:when>
<xsl:when test="$static-subsections-toc = 'active' and exists(.//fr:section)">
<xh:ul class="nav nav-list{{' xforms-hidden'[not($top-level-section-active)]}}">
<xsl:apply-templates mode="toc-sections"/>
</xh:ul>
</xsl:when>
<xsl:otherwise>
<!-- No content -->
</xsl:otherwise>
</xsl:choose>
</xh:li>
</xf:group>
</xsl:template>
</xsl:transform>
</xbl:template>
</xbl:binding>
</xbl:xbl>