/
UI.yml
2445 lines (2088 loc) · 83.1 KB
/
UI.yml
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
---
name: Titanium.UI
summary: The main <Titanium.UI> module.
description: |
The UI module is responsible for native user-interface components and interaction inside
Titanium. The goal of the UI module is to provide a native experience along with native
performance by compiling Javascript code into their native counterparts as part of the
build process.
#### Design
The UI module is broken down into 3 major area:
* **Views** - [Views](Titanium.UI.View) are containers that host visual elements such as
controls or other views. Views can have their properties customized, such as their border color
and radius, can fire events such as swipe events or touches, and can optionally contain a
hierarchy or other views as children. In Titanium, most views are specialized to perform both a
visual function and set of interaction behaviors such as [Table View](Titanium.UI.TableView) or
[Coverflow View](Titanium.UI.iOS.CoverFlowView). Views are always named with the suffix `View`.
* **Controls** - controls, or sometimes referred as widgets, are visual elements such as
[sliders](Titanium.UI.Slider), [buttons](Titanium.UI.Button) and [switches](Titanium.UI.Switch).
They provide a visual element which has a defined behavior and typical have special
configuration and special events. Controls themselves are views and also inherit a views
properties, functions and events.
* **Windows** - [Windows](Titanium.UI.Window) are typically top-level visual constructs that are
the main part of your interface. An application will always have at least one window and windows
can take different shapes and sizes, can have display and interaction properties such as
fullscreen or modal and can be customized, such as changing their opacity or background color.
Windows themselves are views and also inherit a views properties, functions and events. There
are a few specialization of Windows such as a [Tab Group](Titanium.UI.TabGroup) which offer
additional behavior beyond the basic Window.
Titanium uses the [Factory Pattern](http://en.wikipedia.org/wiki/Factory_method_pattern) for
constructing objects and a general naming pattern for APIs. For example, to construct a
[Alert Dialog](Titanium.UI.AlertDialog), you call the method <Titanium.UI.createAlertDialog>.
To create a [TextArea](Titanium.UI.TextArea), you call the method <Titanium.UI.createTextArea>.
Once an object is created, it will be available until it goes out of scope.
#### Optimizations
UI objects are optimized by Titanium to not be realized into the drawing context and placed into
the device UI surface until needed. That means that you can create UI objects, set their
properties and add them to their hierarchy without much worry about memory or performance.
When the native drawing surface needs to render a specific view or control, Titanium will
automatically create the view as needed. Additionally, Titanium is optimized to also release
memory once the view is no longer needed, on screen or in low memory situations. However, it's
a good idea to help Titanium along in certain cases where you are no longer using objects. For
example, you should call `close` on a [Window](Titanium.UI.Window) instance when you are no
longer using it. You can safely call `open` on the window again to re-open it.
#### Global Context and Threading
Be careful with the objects that are created in `app.js` but only used once. Since the `app.js`
context is global and generally is not garbage collected until the application exits, you
should think about the design of your application as it relates to this fact.
[Window](Titanium.UI.Window) objects that are opened up with the `url` property to another
JavaScript file provide a nice way to decompose your application into smaller units.
Additionally, Window objects created with a `url` value run in a separate JavaScript context
and thread. While all UI processing is done on the main UI thread, other processing inside
a Window or the `app.js` that does not have UI interaction will run in its own thread.
The other benefit of using the `url` property is that when the window is closed, resources
allocated in the window's context can be immediately cleaned up, saving resources such as
memory and CPU.
For more information, see the sections "Sub-contexts" and "Passing Data Between Contexts" on the
[Window](Titanium.UI.Window) reference page.
#### Portability
Titanium components are designed to be portable across as many platforms as it supports.
However, there are cases where a device either does not support a specific feature or capability
or where it support additional functionality. For cases where the device OS supports
capabilities that other platforms do not, we attempt to place those capabilities in a separate
namespace, such as <Titanium.UI.iPhone>. However, in cases where the control is in a common
namespace and support additional features, we continue to place that functionality directly on
the object.
#### Events
Event listeners must be defined before their respective events are likely to be fired, otherwise
they are not guaranteed to be called. The open and focus [Window](Titanium.UI.Window) event
listeners, for instance, must be defined before the window is opened.
Evaluating events as late as possible while bearing the above consideration in mind, however,
can significantly improve application responsiveness. For example, an event listener for a
click event may be defined after the parent window has been opened.
#### Colors
Many UI components have properties that control their color.
Colors may be specified as a hex triplet to determine the red, green and blue channels. Thus,
`'#000000'` is specified for black, `'#ff0000'` for red, `'#00ff00'` for green, `'#0000ff'` for
blue, and `'#ffffff'` for white, etc. A channel may be abbreviated when its two hex digits are
identical, such as `'#000'`, `'#f00'`, `'#0f0#'`, `'#00f'` and `'#fff'` for the above colors,
respectively.
An additional alpha channel is supported as a prefix to the hex triplet. So, to make
the purple-like color `'#ff00ff'` semi-opaque, you could use an alpha value of `'55'`, giving,
`'#55ff00ff'` or `'#5f0f'`.
Note that while the pound symbol, `#`, is not mandatory on iOS when using the hex triplet format,
it is recommended to include it to provide compatibility with other platforms.
iOS also accepts colors specified in the form, `rgb(R,G,B)` and `rgba(R,G,B,A)`, with the color
channels inside the parethesis represented by integer numbers between `0` and `255` and the
alpha channel by a float number between `0` and `1.0` (transparent to opaque, respectively).
For example, an opaque purple could be obtained using `'rgb(255,0,255)'` and a semi-opaque purple
using `'rgba(255,0,255,0.3)'`. Note that although this format will work if the `rgb` or `rgba`
prefix is omitted, this is not officially supported and thus not recommended.
Alternatively, the following set of color names are recognized.
`'aqua'`, `'black'`, `'blue'`, `'brown'`, `'cyan'`, `'darkgray'`, `'fuchsia'`, `'gray'`,
`'green'`, `'lightgray'`, `'lime'`, `'magenta'`, `'maroon'`, `'navy'`, `'olive'`, `'orange'`,
`'pink'`, `'purple'`, `'red'`, `'silver'`, `'teal'`, `'white'`, `'yellow'`.
All color properties also accept a value of `'transparent'`.
On Android, if you want to create a semi-transparent window, set the `opacity`
property **before** opening the window.
If a color property is undefined, the default color of the particular UI element is applied.
If a color value is not valid on iOS, the default color is applied, whereas, on Android, the
color yellow is applied.
extends: Titanium.Module
since: "0.4"
methods:
- name: create2DMatrix
summary: Creates and returns an instance of <Titanium.UI.2DMatrix>.
returns:
type: Titanium.UI.2DMatrix
parameters:
- name: parameters
summary: Initial transformation of the matrix.
type: MatrixCreationDict
optional: true
- name: convertUnits
summary: Converts one type of unit to another using the metrics of the main display.
description: As this method does not support percentages, `0` is returned if they are specified.
returns:
type: Number
since: "2.0.0"
parameters:
- name: convertFromValue
summary: |
Measurement and optional unit to convert from, i.e. 160, "120dip". Percentages are
not accepted.
type: String
- name: convertToUnits
summary: Desired unit for the conversion result.
type: Number
constants: Titanium.UI.UNIT_*
properties:
- name: ANIMATION_CURVE_EASE_IN
summary: |
Use with [Animation.curve](Titanium.UI.Animation.curve) to specify an animation that starts
slowly and speeds up.
type: Number
permission: read-only
platforms: [iphone, ipad, mobileweb]
- name: ANIMATION_CURVE_EASE_IN_OUT
summary: |
Use with [Animation.curve](Titanium.UI.Animation.curve) to specify an animation that starts
slowly, and speeds up, then slows down at the end of the animation.
type: Number
permission: read-only
platforms: [iphone, ipad, mobileweb]
- name: ANIMATION_CURVE_EASE_OUT
summary: |
Use with [Animation.curve](Titanium.UI.Animation.curve) to specify an animation that starts
quickly, then slows down at the end of the animation.
type: Number
permission: read-only
platforms: [iphone, ipad, mobileweb]
- name: ANIMATION_CURVE_LINEAR
summary: |
Use with [Animation.curve](Titanium.UI.Animation.curve) to specify an animation that proceeds
at a constant rate.
type: Number
permission: read-only
platforms: [iphone, ipad, mobileweb]
- name: ATTRIBUTE_FONT
summary: |
Use with <Attribute.type> to specify a font.
description: |
Use a <Font> dictionary for <Attribute.value>.
See <Attribute> for more information.
type: Number
platforms: [android, iphone, ipad]
since: "3.6.0"
osver: {ios: {min: "6.0"}}
permission: read-only
- name: ATTRIBUTE_FOREGROUND_COLOR
summary: |
Use with <Attribute.type> to specify a font color.
description: |
Use a color name or hex value for <Attribute.value>.
See <Attribute> for more information.
type: Number
platforms: [android, iphone, ipad]
since: "3.6.0"
osver: {ios: {min: "6.0"}}
permission: read-only
- name: ATTRIBUTE_BACKGROUND_COLOR
summary: |
Use with <Attribute.type> to specify a background color.
description: |
Use a color name or hex value for <Attribute.value>.
See <Attribute> for more information.
type: Number
platforms: [android, iphone, ipad]
since: "3.6.0"
osver: {ios: {min: "6.0"}}
permission: read-only
- name: ATTRIBUTE_LIGATURE
summary: |
Use with <Attribute.type> to enable or disable ligatures.
description: |
Set <Attribute.value> to `1` to enable ligatures, else `0` to disable.
Ligatures are only supported on certain fonts.
See <Attribute> for more information.
type: Number
platforms: [iphone, ipad]
since: "3.6.0"
osver: {ios: {min: "6.0"}}
permission: read-only
- name: ATTRIBUTE_LETTERPRESS_STYLE
summary: |
Use with <Attribute.value> to use a letterpress text effect.
description: |
Use this constant when <Attribute.type> is
<Titanium.UI.ATTRIBUTE_TEXT_EFFECT>.
See <Attribute> for more information.
type: Number
platforms: [iphone, ipad]
since: "3.6.0"
osver: {ios: {min: "7.0"}}
permission: read-only
- name: ATTRIBUTE_KERN
summary: |
Use with <Attribute.type> to specify kerning (space between characters).
description: |
Set <Attribute.value> to a float value specifying how many pixels to increase the character
spacing.
See <Attribute> for more information.
type: Number
platforms: [iphone, ipad]
since: "3.6.0"
osver: {ios: {min: "6.0"}}
permission: read-only
- name: ATTRIBUTE_STRIKETHROUGH_STYLE
summary: |
Use with <Attribute.type> to place a horizontal line through the text.
description: |
Set the `value` property to a `Titanium.UI.ATTRIBUTE_UNDERLINE_*` constant.
See <Attribute> for more information.
type: Number
platforms: [android, iphone, ipad]
since: "3.6.0"
osver: {ios: {min: "6.0"}}
permission: read-only
- name: ATTRIBUTE_UNDERLINES_STYLE
summary: |
Use with <Attribute.type> to place a horizontal line under the text.
description: |
Set the `value` property to a `Titanium.UI.ATTRIBUTE_UNDERLINE_*` constant.
See <Attribute> for more information.
type: Number
platforms: [android, iphone, ipad]
since: "3.6.0"
osver: {ios: {min: "6.0"}}
permission: read-only
- name: ATTRIBUTE_STROKE_COLOR
summary: |
Use with <Attribute.type> to specify a color for the stroke text.
description: |
Use a color name or hex value for the `value` property in the attributes dictionary.
See <Attribute> for more information on type modes.
type: Number
platforms: [iphone, ipad]
since: "3.6.0"
osver: {ios: {min: "6.0"}}
permission: read-only
- name: ATTRIBUTE_STROKE_WIDTH
summary: |
Use with <Attribute.type> to specify the width of the stroke text.
description: |
Set <Attribute.value> to a float value specifying the size of stroke width as a percentage of the
font size. A positive value displays an outline of the charater, while a negative value
fills the character.
See <Attribute> for more information.
type: Number
platforms: [iphone, ipad]
since: "3.6.0"
osver: {ios: {min: "6.0"}}
permission: read-only
- name: ATTRIBUTE_SHADOW
summary: |
Use with <Attribute.type> to display a shadow behind the text.
description: |
Set <Attribute.value> to a [Shadow](shadowDict) dictionary.
See <Attribute> for more information.
type: Number
platforms: [iphone, ipad]
since: "3.6.0"
osver: {ios: {min: "6.0"}}
permission: read-only
- name: ATTRIBUTE_WRITING_DIRECTION
summary: |
Use with <Attribute.type> to control the direction of the text.
description: |
Set <Attribute.value> to a `Titanium.UI.ATTRIBUTE_WRITING_DIRECTION_*` constant.
See <Attribute> for more information on type modes.
type: Number
platforms: [iphone, ipad]
since: "3.6.0"
osver: {ios: {min: "7.0"}}
permission: read-only
- name: ATTRIBUTE_TEXT_EFFECT
summary: |
Use with <Attribute.type> to apply a text effect.
description: |
Set <Attribute.value> to `Titainium.UI.ATTRIBUTE_LETTERPRESS_STYLE` to apply a
letterpress effect to the text.
See <Attribute> for more information.
type: Number
platforms: [iphone, ipad]
since: "3.6.0"
osver: {ios: {min: "7.0"}}
permission: read-only
- name: ATTRIBUTE_LINK
summary: |
Use with <Attribute.type> to create a link.
description: |
Set <Attribute.value> to a URL.
Use the Label's [link](Titanium.UI.Label.link) event to determine when the user triggers a
long press (not a click) event on the linked text.
See <Attribute> for more information.
type: Number
platforms: [android, iphone, ipad]
since: "3.6.0"
osver: {ios: {min: "7.0"}}
permission: read-only
- name: ATTRIBUTE_BASELINE_OFFSET
summary: |
Use with <Attribute.type> to apply a different baseline to the text.
description: |
Set <Attribute.value> to a number to specify how many pixels to raise or lower the text.
See <Attribute> for more information.
type: Number
platforms: [iphone, ipad]
since: "3.6.0"
osver: {ios: {min: "7.0"}}
permission: read-only
- name: ATTRIBUTE_UNDERLINE_COLOR
summary: |
Use with <Attribute.type> to change the color of the horizontal line.
description: |
Use a color name or hex value for <Attribute.value>.
See <Attribute> for more information.
type: Number
platforms: [iphone, ipad]
since: "3.6.0"
osver: {ios: {min: "7.0"}}
permission: read-only
- name: ATTRIBUTE_STRIKETHROUGH_COLOR
summary: |
Use with <Attribute.type> to change the color of the horizontal line.
description: |
Use a color name or hex value for <Attribute.value>.
See <Attribute> for more information.
type: Number
platforms: [iphone, ipad]
since: "3.6.0"
osver: {ios: {min: "7.0"}}
permission: read-only
- name: ATTRIBUTE_OBLIQUENESS
summary: |
Use with <Attribute.type> to skew the text.
description: |
Set <Attribute.value> to a float value to specify how much to skew the text.
See <Attribute> for more information.
type: Number
platforms: [iphone, ipad]
since: "3.6.0"
osver: {ios: {min: "7.0"}}
permission: read-only
- name: ATTRIBUTE_EXPANSION
summary: |
Use with <Attribute.type> to stretch the text horizontally.
description: |
Set <Attribute.value> to a float value to specify how much to stretch the text.
See <Attribute> for more information.
type: Number
platforms: [iphone, ipad]
since: "3.6.0"
osver: {ios: {min: "7.0"}}
permission: read-only
- name: ATTRIBUTE_LINE_BREAK
summary: |
Use with <Attribute.type> to wrap and truncate the text.
description: |
Set <Attribute.value> to a `Titanium.UI.ATTRIBUTE_LINE_BREAK_*` constant.
See <Attribute> for more information on type modes.
type: Number
platforms: [iphone, ipad]
since: "5.0.0"
osver: {ios: {min: "7.0"}}
permission: read-only
- name: ATTRIBUTE_UNDERLINE_STYLE_NONE
summary: |
Use with <Attribute.value> to not draw a line.
description: |
Use this constant when <Attribute.type> is either
<Titanium.UI.ATTRIBUTE_UNDERLINES_STYLE> or
<Titanium.UI.ATTRIBUTE_STRIKETHROUGH_STYLE>.
See <Attribute> for more information.
type: Number
platforms: [iphone, ipad]
since: "3.6.0"
osver: {ios: {min: "6.0"}}
permission: read-only
- name: ATTRIBUTE_UNDERLINE_STYLE_SINGLE
summary: |
Use with <Attribute.value> to draw a single line.
description: |
Use this constant when <Attribute.type> is either
<Titanium.UI.ATTRIBUTE_UNDERLINES_STYLE> or
<Titanium.UI.ATTRIBUTE_STRIKETHROUGH_STYLE>.
See <Attribute> for more information.
type: Number
platforms: [iphone, ipad]
since: "3.6.0"
osver: {ios: {min: "6.0"}}
permission: read-only
- name: ATTRIBUTE_UNDERLINE_STYLE_THICK
summary: |
Use with <Attribute.value> to draw a thick line.
description: |
Use this constant when <Attribute.type> is either
<Titanium.UI.ATTRIBUTE_UNDERLINES_STYLE> or
<Titanium.UI.ATTRIBUTE_STRIKETHROUGH_STYLE>.
See <Attribute> for more information.
type: Number
platforms: [iphone, ipad]
since: "3.6.0"
osver: {ios: {min: "7.0"}}
permission: read-only
- name: ATTRIBUTE_UNDERLINE_STYLE_DOUBLE
summary: |
Use with <Attribute.value> to draw a double line.
description: |
Use this constant when <Attribute.type> is either
<Titanium.UI.ATTRIBUTE_UNDERLINES_STYLE> or
<Titanium.UI.ATTRIBUTE_STRIKETHROUGH_STYLE>.
See <Attribute> for more information.
type: Number
platforms: [iphone, ipad]
since: "3.6.0"
osver: {ios: {min: "7.0"}}
permission: read-only
- name: ATTRIBUTE_UNDERLINE_PATTERN_SOLID
summary: |
Use with <Attribute.value> to draw a solid line.
description: |
Use this constant when <Attribute.type> is either
<Titanium.UI.ATTRIBUTE_UNDERLINES_STYLE> or
<Titanium.UI.ATTRIBUTE_STRIKETHROUGH_STYLE>.
See <Attribute> for more information.
type: Number
platforms: [iphone, ipad]
since: "3.6.0"
osver: {ios: {min: "7.0"}}
permission: read-only
- name: ATTRIBUTE_UNDERLINE_PATTERN_DOT
summary: |
Use with <Attribute.value> to draw a dotted line.
description: |
Use this constant when <Attribute.type> is either
<Titanium.UI.ATTRIBUTE_UNDERLINES_STYLE> or
<Titanium.UI.ATTRIBUTE_STRIKETHROUGH_STYLE>.
See <Attribute> for more information.
type: Number
platforms: [iphone, ipad]
since: "3.6.0"
osver: {ios: {min: "7.0"}}
permission: read-only
- name: ATTRIBUTE_UNDERLINE_PATTERN_DASH
summary: |
Use with <Attribute.value> to draw a dashed line.
description: |
Use this constant when <Attribute.type> is either
<Titanium.UI.ATTRIBUTE_UNDERLINES_STYLE> or
<Titanium.UI.ATTRIBUTE_STRIKETHROUGH_STYLE>.
See <Attribute> for more information.
type: Number
platforms: [iphone, ipad]
since: "3.6.0"
osver: {ios: {min: "7.0"}}
permission: read-only
- name: ATTRIBUTE_UNDERLINE_PATTERN_DASH_DOT
summary: |
Use with <Attribute.value> to draw an alternating line of dashes and dots.
description: |
Use this constant when <Attribute.type> is either
<Titanium.UI.ATTRIBUTE_UNDERLINES_STYLE> or
<Titanium.UI.ATTRIBUTE_STRIKETHROUGH_STYLE>.
See <Attribute> for more information.
type: Number
platforms: [iphone, ipad]
since: "3.6.0"
osver: {ios: {min: "7.0"}}
permission: read-only
- name: ATTRIBUTE_UNDERLINE_PATTERN_DASH_DOT_DOT
summary: |
Use with <Attribute.value> to draw an alternating line of dashes and two dots.
description: |
Use this constant when <Attribute.type> is either
<Titanium.UI.ATTRIBUTE_UNDERLINES_STYLE> or
<Titanium.UI.ATTRIBUTE_STRIKETHROUGH_STYLE>.
See <Attribute> for more information.
type: Number
platforms: [iphone, ipad]
since: "3.6.0"
osver: {ios: {min: "7.0"}}
permission: read-only
- name: ATTRIBUTE_UNDERLINE_BY_WORD
summary: |
Use with <Attribute.value> to draw a line only underneath or through words.
description: |
Use this constant when <Attribute.type> is either
<Titanium.UI.ATTRIBUTE_UNDERLINES_STYLE> or
<Titanium.UI.ATTRIBUTE_STRIKETHROUGH_STYLE>.
See <Attribute> for more information.
type: Number
platforms: [iphone, ipad]
since: "3.6.0"
osver: {ios: {min: "7.0"}}
permission: read-only
- name: ATTRIBUTE_WRITING_DIRECTION_EMBEDDING
summary: |
Use with <Attribute.value> to use the embedded text direction.
description: |
Use this constant when <Attribute.type> is
<Titanium.UI.ATTRIBUTE_WRITING_DIRECTION>.
See <Attribute> for more information.
type: Number
platforms: [iphone, ipad]
since: "3.6.0"
osver: {ios: {min: "7.0"}}
permission: read-only
- name: ATTRIBUTE_WRITING_DIRECTION_OVERRIDE
summary: |
Use with <Attribute.value> to override the text direction.
description: |
Use this constant when <Attribute.type> is
<Titanium.UI.ATTRIBUTE_WRITING_DIRECTION>.
See <Attribute> for more information.
type: Number
platforms: [iphone, ipad]
since: "3.6.0"
osver: {ios: {min: "7.0"}}
permission: read-only
- name: ATTRIBUTE_WRITING_DIRECTION_NATURAL
summary: |
Use with <Attribute.value> to use the
[Unicode Bidirection Algorithm rules P2 and P3](http://www.unicode.org/reports/tr9/#The_Paragraph_Level)
to determine which direction to use.
description: |
Use this constant when <Attribute.type> is
<Titanium.UI.ATTRIBUTE_WRITING_DIRECTION>.
See <Attribute> for more information.
type: Number
platforms: [iphone, ipad]
since: "3.6.0"
osver: {ios: {min: "7.0"}}
permission: read-only
- name: ATTRIBUTE_WRITING_DIRECTION_LEFT_TO_RIGHT
summary: |
Use with <Attribute.value> to write text left to right.
description: |
Use this constant when <Attribute.type> is
<Titanium.UI.ATTRIBUTE_WRITING_DIRECTION>.
See <Attribute> for more information.
type: Number
platforms: [iphone, ipad]
since: "3.6.0"
osver: {ios: {min: "7.0"}}
permission: read-only
- name: ATTRIBUTE_WRITING_DIRECTION_RIGHT_TO_LEFT
summary: |
Use with <Attribute.value> to write text right to left.
description: |
Use this constant when <Attribute.type> is
<Titanium.UI.ATTRIBUTE_WRITING_DIRECTION>.
See <Attribute> for more information.
type: Number
platforms: [iphone, ipad]
since: "3.6.0"
osver: {ios: {min: "7.0"}}
permission: read-only
- name: ATTRIBUTE_LINE_BREAK_BY_WORD_WRAPPING
summary: |
Use with <Attribute.value> to wrap words at word boundaries.
description: |
Use this constant when <Attribute.type> is
<Titanium.UI.ATTRIBUTE_LINE_BREAK>.
See <Attribute> for more information.
type: Number
platforms: [iphone, ipad]
since: "5.0.0"
osver: {ios: {min: "7.0"}}
permission: read-only
- name: ATTRIBUTE_LINE_BREAK_BY_CHAR_WRAPPING
summary: |
Use with <Attribute.value> to wrap words at word boundaries.
description: |
Use this constant when <Attribute.type> is
<Titanium.UI.ATTRIBUTE_LINE_BREAK>.
See <Attribute> for more information.
type: Number
platforms: [iphone, ipad]
since: "5.0.0"
osver: {ios: {min: "7.0"}}
permission: read-only
- name: ATTRIBUTE_LINE_BREAK_BY_CLIPPING
summary: |
Use with <Attribute.value> to set lines to not draw past the edge of the text container.
description: |
Use this constant when <Attribute.type> is
<Titanium.UI.ATTRIBUTE_LINE_BREAK>.
See <Attribute> for more information.
type: Number
platforms: [iphone, ipad]
since: "5.0.0"
osver: {ios: {min: "7.0"}}
permission: read-only
- name: ATTRIBUTE_LINE_BREAK_BY_TRUNCATING_HEAD
summary: |
Use with <Attribute.value> to use ellipsis glyph at the beginning of the line for missing text.
description: |
Use this constant when <Attribute.type> is
<Titanium.UI.ATTRIBUTE_LINE_BREAK>.
See <Attribute> for more information.
type: Number
platforms: [iphone, ipad]
since: "5.0.0"
osver: {ios: {min: "7.0"}}
permission: read-only
- name: ATTRIBUTE_LINE_BREAK_BY_TRUNCATING_MIDDLE
summary: |
Use with <Attribute.value> to use ellipsis glyph at the middle of the line for missing text.
description: |
Use this constant when <Attribute.type> is
<Titanium.UI.ATTRIBUTE_LINE_BREAK>.
See <Attribute> for more information.
type: Number
platforms: [iphone, ipad]
since: "5.0.0"
osver: {ios: {min: "7.0"}}
permission: read-only
- name: ATTRIBUTE_LINE_BREAK_BY_TRUNCATING_TAIL
summary: |
Use with <Attribute.value> to use ellipsis glyph at the end of the line for missing text.
description: |
Use this constant when <Attribute.type> is
<Titanium.UI.ATTRIBUTE_LINE_BREAK>.
See <Attribute> for more information.
type: Number
platforms: [iphone, ipad]
since: "5.0.0"
osver: {ios: {min: "7.0"}}
permission: read-only
- name: AUTODETECT_ADDRESS
deprecated:
since: "1.8.0"
notes: Use <Titanium.UI.AUTOLINK_MAP_ADDRESSES> instead.
removed: "6.0.0"
summary: Converts strings formatted as addresses into clickable links.
type: Number
osver: {ios: {min: "4.0"}}
permission: read-only
platforms: [iphone, ipad]
- name: AUTODETECT_ALL
deprecated:
since: "1.8.0"
notes: Use <Titanium.UI.AUTOLINK_ALL> instead.
removed: "6.0.0"
summary: Converts all detectable types of data into clickable links.
type: Number
permission: read-only
platforms: [iphone, ipad]
- name: AUTODETECT_CALENDAR
deprecated:
since: "1.8.0"
notes: Use <Titanium.UI.AUTOLINK_CALENDAR> instead.
removed: "6.0.0"
summary: Converts strings formatted as calendar events into clickable links.
type: Number
osver: {ios: {min: "4.0"}}
permission: read-only
platforms: [iphone, ipad]
- name: AUTODETECT_LINK
deprecated:
since: "1.8.0"
notes: Use <Titanium.UI.AUTOLINK_URLS> instead.
removed: "6.0.0"
summary: Converts strings formatted as URLs into clickable links.
type: Number
permission: read-only
platforms: [iphone, ipad]
- name: AUTODETECT_NONE
deprecated:
since: "1.8.0"
notes: Use <Titanium.UI.AUTOLINK_NONE> instead.
removed: "6.0.0"
summary: Disables converting strings into clickable links.
type: Number
permission: read-only
platforms: [iphone, ipad]
- name: AUTODETECT_PHONE
deprecated:
since: "1.8.0"
notes: Use <Titanium.UI.AUTOLINK_PHONE_NUMBERS> instead.
removed: "6.0.0"
summary: Converts strings formatted as phone numbers into clickable links.
type: Number
permission: read-only
platforms: [iphone, ipad]
- name: AUTOLINK_MAP_ADDRESSES
summary: Converts strings formatted as addresses into clickable links.
description: |
Two or more autolink constants can be combined using bitwise or.
On iOS:
Use with the <Titanium.UI.TextArea.autoLink> property.
On Android:
Use with <Titanium.UI.TextArea.autoLink>, <Titanium.UI.TextField.autoLink>, and <Titanium.UI.Label.autoLink> properties.
type: Number
osver: {ios: {min: "4.0"}}
since: "3.0.0"
permission: read-only
platforms: [android, iphone, ipad]
- name: AUTOLINK_ALL
summary: Converts all detectable types of data into clickable links.
description: |
Two or more autolink constants can be combined using bitwise or.
On iOS:
Use with the <Titanium.UI.TextArea.autoLink> property.
On Android:
Use with <Titanium.UI.TextArea.autoLink>, <Titanium.UI.TextField.autoLink>, and <Titanium.UI.Label.autoLink> properties.
type: Number
since: "3.0.0"
permission: read-only
platforms: [android, iphone, ipad]
- name: AUTOLINK_CALENDAR
summary: Converts strings formatted as calendar events into clickable links.
description: Use with the <Titanium.UI.TextArea.autoLink> property. Two or more autolink constants can be combined using bitwise or.
type: Number
osver: {ios: {min: "4.0"}}
since: "3.0.0"
permission: read-only
platforms: [iphone, ipad]
- name: AUTOLINK_URLS
summary: Converts strings formatted as URLs into clickable links.
description: |
Two or more autolink constants can be combined using bitwise or.
On iOS:
Use with the <Titanium.UI.TextArea.autoLink> property. This property will also convert strings formatted
as email addresses into clickable links.
On Android:
Use with <Titanium.UI.TextArea.autoLink>, <Titanium.UI.TextField.autoLink>, and <Titanium.UI.Label.autoLink> properties.
type: Number
since: "3.0.0"
permission: read-only
platforms: [android, iphone, ipad]
- name: AUTOLINK_NONE
summary: Disables converting strings into clickable links.
description: |
Two or more autolink constants can be combined using bitwise or.
On iOS:
Use with the <Titanium.UI.TextArea.autoLink> property.
On Android:
Use with <Titanium.UI.TextArea.autoLink>, <Titanium.UI.TextField.autoLink>, and <Titanium.UI.Label.autoLink> properties.
type: Number
permission: read-only
since: "3.0.0"
platforms: [android, iphone, ipad]
- name: AUTOLINK_PHONE_NUMBERS
summary: Converts strings formatted as phone numbers into clickable links.
description: |
Two or more autolink constants can be combined using bitwise or.
On iOS:
Use with the <Titanium.UI.TextArea.autoLink> property.
On Android:
Use with <Titanium.UI.TextArea.autoLink>, <Titanium.UI.TextField.autoLink>, and <Titanium.UI.Label.autoLink> properties.
type: Number
permission: read-only
since: "3.0.0"
platforms: [android, iphone, ipad]
- name: AUTOLINK_EMAIL_ADDRESSES
summary: Converts strings formatted as email addresses into clickable links.
description: |
Two or more autolink constants can be combined using bitwise or.
On iOS:
Use with the <Titanium.UI.TextArea.autoLink> property. This property will also convert strings formatted
as URLs into clickable links.
On Android:
Use with <Titanium.UI.TextArea.autoLink>, <Titanium.UI.TextField.autoLink>, and <Titanium.UI.Label.autoLink> properties.
type: Number
permission: read-only
since: "3.0.0"
platforms: [android, iphone, ipad]
- name: BLEND_MODE_CLEAR
deprecated:
since: "1.8.0"
notes: Use <Titanium.UI.iOS.BLEND_MODE_CLEAR> instead.
removed: "6.0.0"
summary: |
Use with [MaskedImage.mode](Titanium.UI.MaskedImage.mode) to specify a blend mode.
type: Number
permission: read-only
platforms: [iphone, ipad]
- name: BLEND_MODE_COLOR
deprecated:
since: "1.8.0"
notes: Use <Titanium.UI.iOS.BLEND_MODE_COLOR> instead.
removed: "6.0.0"
summary: |
Use with [MaskedImage.mode](Titanium.UI.MaskedImage.mode) to specify a blend mode.
type: Number
permission: read-only
platforms: [iphone, ipad]
- name: BLEND_MODE_COLOR_BURN
deprecated:
since: "1.8.0"
notes: Use <Titanium.UI.iOS.BLEND_MODE_COLOR_BURN> instead.
removed: "6.0.0"
summary: |
Use with [MaskedImage.mode](Titanium.UI.MaskedImage.mode) to specify a blend mode.
type: Number
permission: read-only
platforms: [iphone, ipad]
- name: BLEND_MODE_COLOR_DODGE
deprecated:
since: "1.8.0"
notes: Use <Titanium.UI.iOS.BLEND_MODE_COLOR_DODGE> instead.
removed: "6.0.0"
summary: |
Use with [MaskedImage.mode](Titanium.UI.MaskedImage.mode) to specify a blend mode.
type: Number
permission: read-only
platforms: [iphone, ipad]
- name: BLEND_MODE_COPY
deprecated:
since: "1.8.0"
notes: Use <Titanium.UI.iOS.BLEND_MODE_COPY> instead.
removed: "6.0.0"
summary: |
Use with [MaskedImage.mode](Titanium.UI.MaskedImage.mode) to specify a blend mode.
type: Number
permission: read-only
platforms: [iphone, ipad]
- name: BLEND_MODE_DARKEN
deprecated:
since: "1.8.0"
notes: Use <Titanium.UI.iOS.BLEND_MODE_DARKEN> instead.
removed: "6.0.0"
summary: |
Use with [MaskedImage.mode](Titanium.UI.MaskedImage.mode) to specify a blend mode.
type: Number