forked from tjweir/liftbook
/
chap-js_commands.lyx
3539 lines (2521 loc) · 63.8 KB
/
chap-js_commands.lyx
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
#LyX 1.6.7 created this file. For more info see http://www.lyx.org/
\lyxformat 345
\begin_document
\begin_header
\textclass book
\use_default_options false
\language english
\inputencoding auto
\font_roman default
\font_sans default
\font_typewriter default
\font_default_family default
\font_sc false
\font_osf false
\font_sf_scale 100
\font_tt_scale 100
\graphics default
\paperfontsize default
\spacing single
\use_hyperref false
\papersize default
\use_geometry false
\use_amsmath 1
\use_esint 1
\cite_engine basic
\use_bibtopic false
\paperorientation portrait
\secnumdepth 3
\tocdepth 3
\paragraph_separation indent
\defskip medskip
\quotes_language english
\papercolumns 1
\papersides 1
\paperpagestyle default
\tracking_changes false
\output_changes false
\author ""
\author ""
\end_header
\begin_body
\begin_layout Chapter
Lift and JavaScript
\begin_inset CommandInset label
LatexCommand label
name "cha:Lift-and-Javascript"
\end_inset
\end_layout
\begin_layout Standard
In this chapter we'll be discussing some of the techniques that Lift provides
for simplifying and abstracting access to JavaScript on the client side.
Using these facilities follows Lift's model of separating code from presentatio
n by allowing you to essentially write JavaScript code in Scala.
Lift also provides a layer that allows you to use advanced JavaScript functiona
lity via either the JQuery
\begin_inset Foot
status open
\begin_layout Plain Layout
\begin_inset CommandInset href
LatexCommand href
name "http://jquery.com/"
target "http://jquery.com/"
\end_inset
\end_layout
\end_inset
or YUI
\begin_inset Foot
status open
\begin_layout Plain Layout
\begin_inset CommandInset href
LatexCommand href
target "http://developer.yahoo.com/yui/"
\end_inset
\end_layout
\end_inset
user interface libraries.
\end_layout
\begin_layout Section
JavaScript high level abstractions
\end_layout
\begin_layout Standard
You may have noticed that Lift already comes with rich client side functionality
in the form of AJAX and COMET support (chapter
\begin_inset CommandInset ref
LatexCommand ref
reference "cha:AJAX-and-COMET"
\end_inset
).
Whenever you use this support, Lift automatically generates the proper
\family typewriter
<script>
\family default
elements in the returned page so that the libraries are included.
Lift goes one step further, however, by providing a class hierarchy representin
g JavaScript expressions.
For example, with an AJAX form element in Lift the callback method must
return JavaScript code to update the client side.
Instead of just returning a raw JavaScript string to be interpreted by
the client, you return an instance of the
\family typewriter
JsCmd
\family default
\begin_inset Foot
status open
\begin_layout Plain Layout
net.liftweb.http.js.JsCmd
\end_layout
\end_inset
trait (either directly or via implicit conversion) that is transformed
into the proper JavaScript for the client.
\end_layout
\begin_layout Standard
\family typewriter
JsCmd
\family default
represents a JavaScript command that can be executed on the client.
There is an additional
\begin_inset Quotes eld
\end_inset
base
\begin_inset Quotes erd
\end_inset
trait called
\family typewriter
JsExp
\family default
that represents a JavaScript expression.The differences between them are
not usually important to the developer, since a
\family typewriter
JsExp
\family default
instance is implicitly converted to a
\family typewriter
JsCmd
\family default
.
Also note that while Lift's JavaScript classes attempt to keep things type-safe
there are some limitations; in particular, Lift can't check semantic things
like whether the variable you're trying to access from a given
\family typewriter
JsCmd
\family default
actually exists.
Besides the obvious use in techniques like AJAX and COMET, Lift also makes
it simple to attach JavaScript to regular Scala XML objects, such as form
fields.
\end_layout
\begin_layout Standard
As a simple example, let's look at how we might add a simple alert to a
form if it doesn't validate.
In this example, we'll assume we have a
\family typewriter
name
\family default
form field that shouldn't be blank.
Listing
\begin_inset CommandInset ref
LatexCommand ref
reference "lst:Simple-Form-Validation"
\end_inset
shows a possible binding from our form snippet.
Let's break this down a bit: the first thing is that in order to reference
form elements (or any elements for that matter) from JavaScript, they need
to have an
\family typewriter
id
\family default
attribute.
We add the id attribute
\begin_inset Index
status open
\begin_layout Plain Layout
XML ! attributes
\end_layout
\end_inset
to our text field by passing a
\family typewriter
Pair[String,String]
\family default
.
Next, we need to define our actual validation.
We do this by adding some javascript to the
\family typewriter
onclick
\family default
attribute of our submit button.
The onclick attribute evaluates whatever javascript is assigned when the
button is clicked; if the javascript evaluates to true then submission
continues.
If it evaluates to false then submission is aborted.
In our case, we use the JsIf case class to check to see if the value of
our myName field is equal to an empty string.
In this case the JE object holds an implicit conversion from a Scala string
to a Str (JavaScript string) instance.
The second argument to JsIf is the body to be executed if the condition
is true.
In our case we want to pop up an alert to the user and stop form submission.
The JsCmd trait (which Alert mixes in) provides a
\begin_inset Quotes eld
\end_inset
&
\begin_inset Quotes erd
\end_inset
operator which allows you to chain multiple commands together.
Here we follow the Alert with a JsReturn, which returns the specified value;
again, there's an implicit conversion from Boolean to JsExp, so we can
simply provide the
\begin_inset Quotes eld
\end_inset
false
\begin_inset Quotes erd
\end_inset
value.
\end_layout
\begin_layout Standard
\begin_inset listings
inline false
status open
\begin_layout Plain Layout
\begin_inset Caption
\begin_layout Plain Layout
Simple Form Validation
\begin_inset CommandInset label
LatexCommand label
name "lst:Simple-Form-Validation"
\end_inset
\end_layout
\end_inset
\end_layout
\begin_layout Plain Layout
import JsCmds._
\end_layout
\begin_layout Plain Layout
import JE._
\end_layout
\begin_layout Plain Layout
\end_layout
\begin_layout Plain Layout
var myName = ""
\end_layout
\begin_layout Plain Layout
bind(...
\end_layout
\begin_layout Plain Layout
"name" -> text(myName, myName = _, "id" -> "myName"),
\end_layout
\begin_layout Plain Layout
"submit" -> submit("Save", ..., "onclick" ->
\end_layout
\begin_layout Plain Layout
JsIf(JsEq(ValById("myName"), ""),
\end_layout
\begin_layout Plain Layout
Alert("You must provide a name") & JsReturn(false))
\end_layout
\begin_layout Plain Layout
)
\end_layout
\begin_layout Plain Layout
)
\end_layout
\end_inset
\end_layout
\begin_layout Subsection
JsCmd and JsExp overview
\end_layout
\begin_layout Standard
If you peruse the Lift API docs you'll find a large number of traits and
classes under the JsCmds and JE objects; these provide the vast majority
of the functionality you would need to write simple JavaScript code directly
in Lift.
Having said that, however, it's important to realize that the Lift classes
are intended to be used for small code fragments.
If you need to write large portions of JavaScript code for your pages,
we recommend writing that code in
\emph on
pure
\emph default
JavaScript in an external file and then including that file in your pages.
In particular, if you write your code as JavaScript functions, you can
use the
\family typewriter
JE.Call
\family default
class to execute those functions from your Lift code.
Table
\begin_inset CommandInset ref
LatexCommand ref
reference "tab:Top-Level-JsCmds"
\end_inset
gives a brief overview of the available JsCmds, while table
\begin_inset CommandInset ref
LatexCommand ref
reference "tab:Top-Level-JE-abstractions"
\end_inset
shows the JE expression abstractions.
\end_layout
\begin_layout Standard
\begin_inset Float table
placement H
wide false
sideways false
status open
\begin_layout Plain Layout
\align center
\begin_inset Tabular
<lyxtabular version="3" rows="22" columns="2">
<features islongtable="true">
<column alignment="left" valignment="top" width="1.25in">
<column alignment="left" valignment="bottom" width="4.5in">
<row endhead="true" endfirsthead="true">
<cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
\begin_inset Text
\begin_layout Plain Layout
\size small
Command
\end_layout
\end_inset
</cell>
<cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
\begin_inset Text
\begin_layout Plain Layout
\size small
Description
\end_layout
\end_inset
</cell>
</row>
<row>
<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
\begin_inset Text
\begin_layout Plain Layout
\size small
After
\end_layout
\end_inset
</cell>
<cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
\begin_inset Text
\begin_layout Plain Layout
\size small
Executes the given JsCmd fragment after a given amount of time
\end_layout
\end_inset
</cell>
</row>
<row>
<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
\begin_inset Text
\begin_layout Plain Layout
\size small
Alert
\end_layout
\end_inset
</cell>
<cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
\begin_inset Text
\begin_layout Plain Layout
\size small
Corresponds directly to the JavaScript alert function
\end_layout
\end_inset
</cell>
</row>
<row>
<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
\begin_inset Text
\begin_layout Plain Layout
\size small
CmdPair
\end_layout
\end_inset
</cell>
<cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
\begin_inset Text
\begin_layout Plain Layout
\size small
Executes two JsCmd fragments in order
\end_layout
\end_inset
</cell>
</row>
<row>
<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
\begin_inset Text
\begin_layout Plain Layout
\size small
FocusOnLoad
\end_layout
\end_inset
</cell>
<cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
\begin_inset Text
\begin_layout Plain Layout
\size small
Forces focus on the given XML element when the document loads
\end_layout
\end_inset
</cell>
</row>
<row>
<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
\begin_inset Text
\begin_layout Plain Layout
\size small
Function
\end_layout
\end_inset
</cell>
<cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
\begin_inset Text
\begin_layout Plain Layout
\size small
Defines a JavaScript function with name, parameter list, and JsCmd body
\end_layout
\end_inset
</cell>
</row>
<row>
<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
\begin_inset Text
\begin_layout Plain Layout
\size small
JsBreak, JsContinue, JsReturn
\end_layout
\end_inset
</cell>
<cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
\begin_inset Text
\begin_layout Plain Layout
\size small
Corresponds directly to the JavaScript
\begin_inset Quotes eld
\end_inset
break
\begin_inset Quotes erd
\end_inset
,
\begin_inset Quotes eld
\end_inset
continue
\begin_inset Quotes erd
\end_inset
, and
\begin_inset Quotes eld
\end_inset
return
\begin_inset Quotes erd
\end_inset
keywords
\end_layout
\end_inset
</cell>
</row>
<row>
<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
\begin_inset Text
\begin_layout Plain Layout
\size small
JsFor, JsForIn, JsDoWhile, JsWhile
\end_layout
\end_inset
</cell>
<cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
\begin_inset Text
\begin_layout Plain Layout
\size small
These define loop constructs in JavaScript with conditions and execution
bodies
\end_layout
\end_inset
</cell>
</row>
<row>
<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
\begin_inset Text
\begin_layout Plain Layout
\size small
JsHideId, JsShowId
\end_layout
\end_inset
</cell>
<cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
\begin_inset Text
\begin_layout Plain Layout
\size small
Hides or shows the HTML element with the given Id.
This is actually handled via the LiftArtifacts' hide and show methods
\end_layout
\end_inset
</cell>
</row>
<row>
<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
\begin_inset Text
\begin_layout Plain Layout
\size small
JsIf
\end_layout
\end_inset
</cell>
<cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
\begin_inset Text
\begin_layout Plain Layout
\size small
Corresponds to the JavaScript
\begin_inset Quotes eld
\end_inset
if
\begin_inset Quotes erd
\end_inset
statement, with a condition, body to execute if the condition is true,
and optional
\begin_inset Quotes eld
\end_inset
else
\begin_inset Quotes erd
\end_inset
body statement
\end_layout
\end_inset
</cell>
</row>
<row>
<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
\begin_inset Text
\begin_layout Plain Layout
\size small
JsTry
\end_layout
\end_inset
</cell>
<cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
\begin_inset Text
\begin_layout Plain Layout
\size small
Defines a try/catch block tha can optionally alert if an exception is caught
\end_layout
\end_inset
</cell>
</row>
<row>
<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
\begin_inset Text
\begin_layout Plain Layout
\size small
JsWith
\end_layout
\end_inset
</cell>
<cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
\begin_inset Text
\begin_layout Plain Layout
\size small
Defines a with statement to reduce object references
\end_layout
\end_inset
</cell>
</row>
<row>
<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
\begin_inset Text
\begin_layout Plain Layout
\size small
OnLoad
\end_layout
\end_inset
</cell>
<cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
\begin_inset Text
\begin_layout Plain Layout
\size small
Defines a JavaScript statement that is executed on page load
\end_layout
\end_inset
</cell>
</row>
<row>
<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
\begin_inset Text
\begin_layout Plain Layout
\size small
Noop
\end_layout
\end_inset
</cell>
<cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
\begin_inset Text
\begin_layout Plain Layout
\size small
Defines an empty JavaScript statement
\end_layout
\end_inset
</cell>
</row>
<row>
<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
\begin_inset Text
\begin_layout Plain Layout
\size small
RedirectTo
\end_layout
\end_inset
</cell>
<cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
\begin_inset Text
\begin_layout Plain Layout
\size small
Uses window.location to redirect to a new page
\end_layout
\end_inset
</cell>
</row>
<row>
<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
\begin_inset Text
\begin_layout Plain Layout
\size small
ReplaceOptions
\end_layout
\end_inset
</cell>
<cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
\begin_inset Text
\begin_layout Plain Layout
\size small
Replaces options on a form Select with a new list of options.
\end_layout
\end_inset
</cell>
</row>
<row>
<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
\begin_inset Text
\begin_layout Plain Layout
\size small
Run
\end_layout
\end_inset
</cell>
<cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
\begin_inset Text
\begin_layout Plain Layout
\size small
Executes the given string as raw javascript
\end_layout
\end_inset
</cell>
</row>
<row>
<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
\begin_inset Text
\begin_layout Plain Layout
\size small
Script
\end_layout
\end_inset
</cell>
<cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
\begin_inset Text
\begin_layout Plain Layout
\size small
Defines a <script> element with proper CDATA escaping, etc to conform to
XHTML JavaScript support
\end_layout
\end_inset
</cell>
</row>
<row>
<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
\begin_inset Text
\begin_layout Plain Layout
\size small
SetElemById
\end_layout
\end_inset
</cell>
<cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
\begin_inset Text
\begin_layout Plain Layout
\size small
Assigns a statement to a given element by id.
Optional parameters allow you to specify properties on the element
\end_layout
\end_inset
</cell>
</row>
<row>
<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
\begin_inset Text
\begin_layout Plain Layout
\size small
SetExp
\end_layout
\end_inset
</cell>
<cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
\begin_inset Text
\begin_layout Plain Layout
\size small
Defines an assignment to an arbitrary JavaScript expression from another
JavaScript expression
\end_layout
\end_inset
</cell>
</row>
<row>
<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
\begin_inset Text
\begin_layout Plain Layout
\size small
SetHtml
\end_layout
\end_inset
</cell>
<cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
\begin_inset Text
\begin_layout Plain Layout
\size small
Sets the contents of a given HTML node by Id to a given NodeSeq.
This is especially useful in Ajax calls that update parts of the page
\end_layout
\end_inset
</cell>
</row>
<row>
<cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
\begin_inset Text
\begin_layout Plain Layout
\size small
SetValById
\end_layout
\end_inset
</cell>
<cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
\begin_inset Text
\begin_layout Plain Layout
\size small
Defines an assignment to a given element's
\begin_inset Quotes eld
\end_inset
value
\begin_inset Quotes erd
\end_inset
property
\end_layout
\end_inset
</cell>
</row>
</lyxtabular>
\end_inset
\end_layout
\begin_layout Plain Layout
\begin_inset Caption
\begin_layout Plain Layout
Basic JsCmds
\begin_inset CommandInset label
LatexCommand label
name "tab:Top-Level-JsCmds"
\end_inset
\end_layout
\end_inset