@maccesar/titools 4.4.0 → 4.5.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (45) hide show
  1. package/README.md +10 -13
  2. package/package.json +1 -1
  3. package/skills/purgetss/SKILL.md +4 -9
  4. package/skills/ti-api/references/api-core.md +24 -69
  5. package/skills/ti-api/references/api-data-network.md +18 -63
  6. package/skills/ti-api/references/api-media.md +225 -107
  7. package/skills/ti-api/references/api-modules-coremotion-urlsession.md +6 -20
  8. package/skills/ti-api/references/api-modules-map.md +45 -58
  9. package/skills/ti-api/references/api-modules-nfc.md +23 -56
  10. package/skills/ti-api/references/api-modules-social-misc.md +23 -3
  11. package/skills/ti-api/references/api-ui-android.md +16 -37
  12. package/skills/ti-api/references/api-ui-extras.md +106 -87
  13. package/skills/ti-api/references/api-ui-lists.md +103 -57
  14. package/skills/ti-api/references/api-ui-text-input.md +13 -39
  15. package/skills/ti-api/references/api-ui-windows-navigation.md +95 -93
  16. package/skills/ti-api/references/api-xml-global.md +25 -60
  17. package/skills/ti-expert/SKILL.md +8 -11
  18. package/skills/ti-expert/references/adaptive-layouts.md +15 -43
  19. package/skills/ti-expert/references/alloy-builtins.md +1 -4
  20. package/skills/ti-expert/references/alloy-structure.md +4 -12
  21. package/skills/ti-expert/references/anti-patterns.md +16 -45
  22. package/skills/ti-expert/references/code-conventions.md +2 -6
  23. package/skills/ti-expert/references/controller-patterns.md +1 -3
  24. package/skills/ti-expert/references/examples.md +3 -10
  25. package/skills/ti-expert/references/feedback-migration.md +17 -39
  26. package/skills/ti-expert/references/feedback-surfaces.md +19 -48
  27. package/skills/ti-expert/references/feedback-widget-contracts.md +31 -69
  28. package/skills/ti-expert/references/file-type-association.md +265 -0
  29. package/skills/ti-expert/references/migration-patterns.md +8 -18
  30. package/skills/ti-expert/references/sharing.md +227 -0
  31. package/skills/ti-expert/references/theming.md +20 -45
  32. package/skills/ti-guides/SKILL.md +5 -1
  33. package/skills/ti-guides/references/coding-best-practices.md +1 -2
  34. package/skills/ti-guides/references/compatibility-matrix.md +89 -0
  35. package/skills/ti-guides/references/resources.md +7 -1
  36. package/skills/ti-guides/references/sdk-release-notes.md +75 -0
  37. package/skills/ti-guides/references/style-and-conventions.md +1 -2
  38. package/skills/ti-howtos/references/debugging-profiling.md +1 -2
  39. package/skills/ti-howtos/references/location-and-maps.md +1 -2
  40. package/skills/ti-howtos/references/using-modules.md +1 -2
  41. package/skills/ti-howtos/references/web-content-integration.md +1 -2
  42. package/skills/ti-howtos/references/webpack-build-pipeline.md +1 -2
  43. package/skills/ti-ui/references/listviews-and-performance.md +5 -10
  44. package/skills/ti-ui/references/orientation.md +1 -2
  45. package/skills/ti-ui/references/scrolling-views.md +7 -1
@@ -24,21 +24,13 @@
24
24
  > Extends Ti.Proxy
25
25
  > Platforms: both
26
26
 
27
- An animation object describes the properties of an animation. At its most basic, an animation
28
- object represents a single-phase animation with an end state and a duration.
27
+ An animation object describes the properties of an animation. At its most basic, an animation object represents a single-phase animation with an end state and a duration.
29
28
 
30
- When [animate](Titanium.UI.View.animate) is called on a [View](Titanium.UI.View), the view is
31
- animated from its current state to the state described by the animation object. The properties
32
- that can be animated include the view's position, size, colors, transformation matrix and opacity.
29
+ When [animate](Titanium.UI.View.animate) is called on a [View](Titanium.UI.View), the view is animated from its current state to the state described by the animation object. The properties that can be animated include the view's position, size, colors, transformation matrix and opacity.
33
30
 
34
- You can also specify an animation curve or *easing function* to control the pace of the
35
- animation. To use an easing function, set the animation's `curve` property to one of the
36
- `ANIMATION_CURVE` constants defined in <Titanium.UI>. For example,
37
- [ANIMATION_CURVE_EASE_IN](Titanium.UI.ANIMATION_CURVE_EASE_IN) specifies an animation that
38
- starts slowly and then speeds up.
31
+ You can also specify an animation curve or *easing function* to control the pace of the animation. To use an easing function, set the animation's `curve` property to one of the `ANIMATION_CURVE` constants defined in <Titanium.UI>. For example, [ANIMATION_CURVE_EASE_IN](Titanium.UI.ANIMATION_CURVE_EASE_IN) specifies an animation that starts slowly and then speeds up.
39
32
 
40
- Animations can be set to reverse themselves automatically on completion, and to repeat a given
41
- number of times. For more complicated effects, multiple animations can be combined in sequence,
33
+ Animations can be set to reverse themselves automatically on completion, and to repeat a given number of times. For more complicated effects, multiple animations can be combined in sequence,
42
34
 
43
35
  *(See full overview in titanium-docs)*
44
36
 
@@ -100,8 +92,7 @@ number of times. For more complicated effects, multiple animations can be combin
100
92
  > Extends Ti.Proxy
101
93
  > Platforms: both
102
94
 
103
- A 2D matrix is used to rotate, scale, translate, or skew the objects in a two-dimensional space.
104
- A 2D affine transformation can be represented by a 3 by 3 matrix:
95
+ A 2D matrix is used to rotate, scale, translate, or skew the objects in a two-dimensional space. A 2D affine transformation can be represented by a 3 by 3 matrix:
105
96
 
106
97
  ### Properties (unique: 6/9)
107
98
  | Property | Type | Default | Platform | Description |
@@ -131,12 +122,9 @@ A 2D affine transformation can be represented by a 3 by 3 matrix:
131
122
  > Extends Ti.Proxy
132
123
  > Platforms: ios
133
124
 
134
- The 3D Matrix is created by <Titanium.UI.createMatrix3D>. A 3D transform is
135
- used to rotate, scale, translate, or skew the objects in three-dimensional
136
- space. A 3D transform is represented by a 4 by 4 matrix.
125
+ The 3D Matrix is created by <Titanium.UI.createMatrix3D>. A 3D transform is used to rotate, scale, translate, or skew the objects in three-dimensional space. A 3D transform is represented by a 4 by 4 matrix.
137
126
 
138
- You create an `identity matrix` by creating a 3D Matrix with an empty
139
- constructor.
127
+ You create an `identity matrix` by creating a 3D Matrix with an empty constructor.
140
128
 
141
129
  ### Properties (unique: 16/18)
142
130
  | Property | Type | Default | Platform | Description |
@@ -178,16 +166,13 @@ constructor.
178
166
 
179
167
  Use the <Titanium.UI.createWebView> method or **`<WebView>`** Alloy element to create a web view.
180
168
 
181
- Web views are more expensive to create than other native views because of the requirement to
182
- load the HTML browser into memory.
169
+ Web views are more expensive to create than other native views because of the requirement to load the HTML browser into memory.
183
170
 
184
- The web view content can be any valid web content such as HTML, PDF, SVG or other WebKit supported
185
- content types.
171
+ The web view content can be any valid web content such as HTML, PDF, SVG or other WebKit supported content types.
186
172
 
187
173
  ### JavaScript Context in WebViews--Local vs. Remote Content
188
174
 
189
- JavaScript in the web view executes in its own context. The web view can interact with this
190
- content, but most of this functionality is limited to local content.
175
+ JavaScript in the web view executes in its own context. The web view can interact with this content, but most of this functionality is limited to local content.
191
176
 
192
177
  **Local Scripts**
193
178
 
@@ -295,27 +280,90 @@ content, but most of this functionality is limited to local content.
295
280
  #### BackForwardList
296
281
  > The object returned to the <Titanium.UI.WebView.backForwardList> method.
297
282
 
298
- | Property | Type | Description |
299
- |----------|------|-------------|
300
- | currentItem | BackForwardListItem | The current item. |
301
- | backItem | BackForwardListItem | The item immediately preceding the current item. |
302
- | forwardItem | BackForwardListItem | The item immediately following the current item. |
303
- | backList | Array<BackForwardListItem> | The portion of the list preceding the current item. |
304
- | forwardList | Array<BackForwardListItem> | The portion of the list following the current item. |
283
+ | Property | Type | Platform | Description |
284
+ |----------|------|----------|-------------|
285
+ | currentItem | BackForwardListItem | ios | The current item. |
286
+ | backItem | BackForwardListItem | ios | The item immediately preceding the current item. |
287
+ | forwardItem | BackForwardListItem | ios | The item immediately following the current item. |
288
+ | backList | Array<BackForwardListItem> | ios | The portion of the list preceding the current item. |
289
+ | forwardList | Array<BackForwardListItem> | ios | The portion of the list following the current item. |
290
+
291
+ #### BackForwardListItem
292
+ > The object represents a webpage in the back-forward of a web view.
293
+
294
+ | Property | Type | Platform | Description |
295
+ |----------|------|----------|-------------|
296
+ | url | String | ios | The URL of the webpage represented by this item. |
297
+ | initialUrl | String | ios | The URL of the initial request that created this item. |
298
+ | title | String | ios | The title of the webpage represented by this item. |
299
+
300
+ #### DataCreationResult
301
+ > The parameter passed to the <Titanium.UI.WebView.createPDF> or <Titanium.UI.WebView.createWebArchive>callback.
302
+
303
+ | Property | Type | Platform | Description |
304
+ |----------|------|----------|-------------|
305
+ | data | Ti.Blob | ios | The created data. |
306
+ | success | Boolean | ios | Indicates if the data creation successful or not. |
307
+ | error | String | ios | Error message, if any returned. |
308
+
309
+ #### DataCreationResultAndroid
310
+ > Success callback in <Titanium.UI.WebView.createPDF>.
311
+
312
+ | Property | Type | Platform | Description |
313
+ |----------|------|----------|-------------|
314
+ | data | Ti.Blob | android | The created data. |
315
+
316
+ #### OnLinkURLResponse
317
+ > An object returned when the <Titanium.UI.WebView.onlink> callback is fired.
318
+
319
+ | Property | Type | Platform | Description |
320
+ |----------|------|----------|-------------|
321
+ | url | String | both | The URL of the link that should be navigated to. |
305
322
 
306
- #### Dictionary
307
- > Plain JavaScript object.
323
+ #### SearchResult
324
+ > The parameter passed to the <Titanium.UI.WebView.findString>.
325
+
326
+ | Property | Type | Platform | Description |
327
+ |----------|------|----------|-------------|
328
+ | success | Boolean | ios | Indicates if string found or not. |
329
+ | error | String | ios | Error message, if any returned. |
330
+
331
+ #### setHtmlOptions
332
+ > Options used by <Titanium.UI.WebView.setHtml>
333
+
334
+ | Property | Type | Platform | Description |
335
+ |----------|------|----------|-------------|
336
+ | baseURL | String | both | Sets the URL that the web content's paths will be relative to. |
337
+ | mimeType | String | both | Sets the MIME type for the content. Defaults to "text/html" if not specified. |
338
+
339
+ #### SnapshotResult
340
+ > The parameter passed to the <Titanium.UI.WebView.takeSnapshot> callback.
341
+
342
+ | Property | Type | Platform | Description |
343
+ |----------|------|----------|-------------|
344
+ | snapshot | Ti.Blob | ios | The snapshot image. |
345
+ | success | Boolean | ios | Indicates if the snapshot taken. |
346
+ | error | String | ios | Error message, if any returned. |
308
347
 
309
348
  #### StringSearchOptions
310
349
  > The optional options to pass to the <Titanium.UI.WebView.findString>. Pass a dictionary with one or more of the following string-keys: * `caseSensitive` (Boolean value) * `backward` (Boolean value) * `wraps` (Boolean value)
311
350
 
312
- | Property | Type | Description |
313
- |----------|------|-------------|
314
- | caseSensitive | Boolean | Whether or not the search should be case sensitive. |
315
- | backward | Boolean | The direction to search from the current selection. The search will respect the… |
316
- | wraps | Boolean | Whether the search should start at the beginning of the document once it reache… |
351
+ | Property | Type | Platform | Description |
352
+ |----------|------|----------|-------------|
353
+ | caseSensitive | Boolean | both | Whether or not the search should be case sensitive. |
354
+ | backward | Boolean | both | The direction to search from the current selection. The search will respect the… |
355
+ | wraps | Boolean | both | Whether the search should start at the beginning of the document once it reache… |
356
+
357
+ #### UserScriptParams
358
+ > Dictionary of options for the <Titanium.UI.WebView.addUserScript> method.
359
+
360
+ | Property | Type | Platform | Description |
361
+ |----------|------|----------|-------------|
362
+ | source | String | ios | A script that can be injected into a webpage. |
363
+ | injectionTime | Number | ios | The time when the script should be injected into the webpage. |
364
+ | mainFrameOnly | Boolean | ios | A Boolean value indicating whether the script should be injected only into the … |
317
365
 
318
- *Plus 2 more types: *
366
+ Also referenced by this API, documented elsewhere: `Dictionary`.
319
367
 
320
368
  ---
321
369
 
@@ -326,19 +374,14 @@ content, but most of this functionality is limited to local content.
326
374
 
327
375
  A `Toolbar` is created by the <Titanium.UI.createToolbar> factory method or **`<Toolbar>`** Alloy element.
328
376
 
329
- To provide spacing between items in the toolbar, on iOS you can use the special system button types,
330
- [FIXED_SPACE](Titanium.UI.iOS.SystemButton.FIXED_SPACE) and
331
- [FLEXIBLE_SPACE](Titanium.UI.iOS.SystemButton.FLEXIBLE_SPACE).
377
+ To provide spacing between items in the toolbar, on iOS you can use the special system button types, [FIXED_SPACE](Titanium.UI.iOS.SystemButton.FIXED_SPACE) and [FLEXIBLE_SPACE](Titanium.UI.iOS.SystemButton.FLEXIBLE_SPACE).
332
378
 
333
- Note that toolbars are positioned like other views (using the `top` and `bottom` properties,
334
- for example), but the [iOS Human Interface Guidelines](https://developer.apple.com/ios/human-interface-guidelines/overview/themes/#//apple_ref/doc/uid/TP40006556-CH12-SW4)
335
- have specific requirements for placing toolbars, specifically:
379
+ Note that toolbars are positioned like other views (using the `top` and `bottom` properties, for example), but the [iOS Human Interface Guidelines](https://developer.apple.com/ios/human-interface-guidelines/overview/themes/#//apple_ref/doc/uid/TP40006556-CH12-SW4) have specific requirements for placing toolbars, specifically:
336
380
 
337
381
  * On the iPhone and Android, a toolbar should be at the bottom of the window.
338
382
  * On the iPad, a toolbar should appear at the top or bottom of a window.
339
383
 
340
- Due to an iOS limitation, the buttons in the toolbar only support the `click` event.
341
- The native object underlying a toolbar button does not generate standard view events,
384
+ Due to an iOS limitation, the buttons in the toolbar only support the `click` event. The native object underlying a toolbar button does not generate standard view events,
342
385
 
343
386
  *(See full overview in titanium-docs)*
344
387
 
@@ -393,15 +436,11 @@ The native object underlying a toolbar button does not generate standard view ev
393
436
  | ------- | --- |
394
437
  | ![Android](./buttonbar_android.png) | |
395
438
 
396
- The button bar is a set of buttons joined into a single control.
397
- On iOS, you can set up the buttons with either a title or image, but not both.
398
- On Android, you can set up the buttons with a title, image, or both.
439
+ The button bar is a set of buttons joined into a single control. On iOS, you can set up the buttons with either a title or image, but not both. On Android, you can set up the buttons with a title, image, or both.
399
440
 
400
441
  Use the <Titanium.UI.createButtonBar> method or **`<ButtonBar>`** Alloy element to create a button bar.
401
442
 
402
- The [TabbedBar](Titanium.UI.iOS.TabbedBar) control is a button bar where the
403
- last selected button maintains a pressed or selected state. The following discussion
404
- applies to both button bar and tabbed bar.
443
+ The [TabbedBar](Titanium.UI.iOS.TabbedBar) control is a button bar where the last selected button maintains a pressed or selected state. The following discussion applies to both button bar and tabbed bar.
405
444
 
406
445
  ### Properties (unique: 5/76)
407
446
  | Property | Type | Default | Platform | Description |
@@ -426,11 +465,7 @@ applies to both button bar and tabbed bar.
426
465
  > Extends Ti.UI.View
427
466
  > Platforms: both
428
467
 
429
- A tabbed bar is a button bar that
430
- maintains a state (visually distinguished as a pressed or selected look).
431
- It is closely related to the `ButtonBar` control. See the description of
432
- [ButtonBar](Titanium.UI.ButtonBar) for information on styling tabbed bars and buttons
433
- bars.
468
+ A tabbed bar is a button bar that maintains a state (visually distinguished as a pressed or selected look). It is closely related to the `ButtonBar` control. See the description of [ButtonBar](Titanium.UI.ButtonBar) for information on styling tabbed bars and buttons bars.
434
469
 
435
470
  Use the <Titanium.UI.createTabbedBar> method to create a Tabbed Bar.
436
471
 
@@ -465,11 +500,9 @@ Use the <Titanium.UI.createTabbedBar> method to create a Tabbed Bar.
465
500
 
466
501
  This is a view which shows a list of options where only 1 option is selectable by the user.
467
502
 
468
- On iOS, this displays a
469
- [segmented control](https://developer.apple.com/design/human-interface-guidelines/ios/controls/segmented-controls/).
503
+ On iOS, this displays a [segmented control](https://developer.apple.com/design/human-interface-guidelines/ios/controls/segmented-controls/).
470
504
 
471
- On Android, this displays a
472
- [toggle button group](https://material.io/components/buttons/android#toggle-button).
505
+ On Android, this displays a [toggle button group](https://material.io/components/buttons/android#toggle-button).
473
506
 
474
507
  Use the <Titanium.UI.createOptionBar> method to create a Option Bar.
475
508
 
@@ -498,11 +531,9 @@ Use the <Titanium.UI.createOptionBar> method to create a Option Bar.
498
531
  > Extends Ti.Proxy
499
532
  > Platforms: both
500
533
 
501
- Allows the creation of application shortcuts, which can be detected using
502
- the `click` event from <Titanium.UI.Shortcut>.
534
+ Allows the creation of application shortcuts, which can be detected using the `click` event from <Titanium.UI.Shortcut>.
503
535
 
504
- On iOS, shortcuts are only supported on a 3D Touch compatible device.
505
- Use the <Titanium.UI.iOS.forceTouchSupported> property to see if it's supported.
536
+ On iOS, shortcuts are only supported on a 3D Touch compatible device. Use the <Titanium.UI.iOS.forceTouchSupported> property to see if it's supported.
506
537
 
507
538
  ### Properties (unique: 2/5)
508
539
  | Property | Type | Default | Platform | Description |
@@ -531,15 +562,12 @@ Use the <Titanium.UI.iOS.forceTouchSupported> property to see if it's supported.
531
562
  > Extends Ti.Proxy
532
563
  > Platforms: both
533
564
 
534
- Allows the creation of dynamic application shortcut items which can be set in the app to
535
- offer a dynamic behavior at runtime.
565
+ Allows the creation of dynamic application shortcut items which can be set in the app to offer a dynamic behavior at runtime.
536
566
 
537
- Use the <Titanium.UI.createShortcutItem> method to create a shortcut item and pass it to
538
- the <Titanium.UI.Shortcut.add> method to add it to the application.
567
+ Use the <Titanium.UI.createShortcutItem> method to create a shortcut item and pass it to the <Titanium.UI.Shortcut.add> method to add it to the application.
539
568
 
540
569
  ### Android Static Shortcuts
541
- Google documents how to add static shortcuts
542
- [here](https://developer.android.com/guide/topics/ui/shortcuts/creating-shortcuts#static).
570
+ Google documents how to add static shortcuts [here](https://developer.android.com/guide/topics/ui/shortcuts/creating-shortcuts#static).
543
571
 
544
572
  In the `tiapp.xml` file, you will need to add a shortcuts `<meta-data/>` element to your main activity.
545
573
 
@@ -573,9 +601,7 @@ In the `tiapp.xml` file, you will need to add a shortcuts `<meta-data/>` element
573
601
  | ------- | --- |
574
602
  | ![Android](./emaildialog_android.png) | ![iOS](./emaildialog_ios.png) |
575
603
 
576
- The Email Dialog is created with the <Titanium.UI.createEmailDialog> method. The user needs to
577
- register an e-mail account on the device in order to open the dialog. The dialog will not
578
- open when there is not a registered e-mail account.
604
+ The Email Dialog is created with the <Titanium.UI.createEmailDialog> method. The user needs to register an e-mail account on the device in order to open the dialog. The dialog will not open when there is not a registered e-mail account.
579
605
 
580
606
  **iOS Platform Notes**
581
607
 
@@ -624,20 +650,13 @@ On iOS, you cannot test the e-mail dialog on the iOS Simulator. Test the email d
624
650
  > Extends Ti.UI.View
625
651
  > Platforms: ios
626
652
 
627
- The DashboardView is created using the <Titanium.UI.createDashboardView> method or **`<DashboardView>`**
628
- Alloy element.
653
+ The DashboardView is created using the <Titanium.UI.createDashboardView> method or **`<DashboardView>`** Alloy element.
629
654
 
630
- Dashboard view's edit mode may be activated by a longpress of a <Titanium.UI.DashboardItem> item,
631
- unless this behavior has been disabled by the [editable](Titanium.UI.DashboardView.editable)
632
- property. As a dashboard view does not inherently provide a way to exit edit mode, this must be
633
- explicitly defined.
655
+ Dashboard view's edit mode may be activated by a longpress of a <Titanium.UI.DashboardItem> item, unless this behavior has been disabled by the [editable](Titanium.UI.DashboardView.editable) property. As a dashboard view does not inherently provide a way to exit edit mode, this must be explicitly defined.
634
656
 
635
- When edit mode has been activated, the item icons wobble by default to act as a visual cue.
636
- This behavior may be disabled using the [wobble](Titanium.UI.DashboardView.wobble) property.
657
+ When edit mode has been activated, the item icons wobble by default to act as a visual cue. This behavior may be disabled using the [wobble](Titanium.UI.DashboardView.wobble) property.
637
658
 
638
- If a dashboard contains more than 9 items, it will be paged into screens in a 3 x 3 formation
639
- using its built-in scrollable view. A paging control is added to the bottom of the view to
640
- indicate the active page.
659
+ If a dashboard contains more than 9 items, it will be paged into screens in a 3 x 3 formation using its built-in scrollable view. A paging control is added to the bottom of the view to indicate the active page.
641
660
 
642
661
 
643
662
  *(See full overview in titanium-docs)*
@@ -25,9 +25,7 @@
25
25
 
26
26
  Use the <Titanium.UI.createListView> method or **`<ListView>`** Alloy element to create a `ListView`.
27
27
 
28
- A `ListView` object is a container for [ListSection](Titanium.UI.ListSection)
29
- objects that are, in turn, containers for [ListItem](Titanium.UI.ListItem) objects. This is
30
- easily visualized as an Alloy view:
28
+ A `ListView` object is a container for [ListSection](Titanium.UI.ListSection) objects that are, in turn, containers for [ListItem](Titanium.UI.ListItem) objects. This is easily visualized as an Alloy view:
31
29
 
32
30
 
33
31
  ### Properties (unique: 54/122)
@@ -133,22 +131,54 @@ easily visualized as an Alloy view:
133
131
  #### AnimatedOptions
134
132
  > A JavaScript object holding an `animated` property. Used for many UI methods as a means of specifying some transition should be animated.
135
133
 
136
- | Property | Type | Description |
137
- |----------|------|-------------|
138
- | animated | Boolean | If `true`, animate a transition for the method/value change. Note that for most… |
134
+ | Property | Type | Platform | Description |
135
+ |----------|------|----------|-------------|
136
+ | animated | Boolean | both | If `true`, animate a transition for the method/value change. Note that for most… |
139
137
 
140
138
  #### AnimatedWithDurationOptions
141
139
  > A JavaScript object holding `animated` and `duration` properties. Used on iOS For [TableView](Titanium.UI.TableView) and [ListView](Titanium.UI.ListView) content offset transitions.
142
140
 
143
- | Property | Type | Description |
144
- |----------|------|-------------|
145
- | animated | Boolean | If `true`, animate a transition for the method/value change. Note that for most… |
146
- | duration | Number | The duration in `milliseconds` for animation |
141
+ | Property | Type | Platform | Description |
142
+ |----------|------|----------|-------------|
143
+ | animated | Boolean | both | If `true`, animate a transition for the method/value change. Note that for most… |
144
+ | duration | Number | both | The duration in `milliseconds` for animation |
145
+
146
+ #### ListItemEventType
147
+ > The arguments for the <Titanium.UI.ListView.prefetch> and <Titanium.UI.ListView.cancelprefetch> events.
148
+
149
+ | Property | Type | Platform | Description |
150
+ |----------|------|----------|-------------|
151
+ | section | Ti.UI.ListSection | ios | List section if the item is contained in a list section. |
152
+ | sectionIndex | Number | ios | Section index. |
153
+ | itemIndex | Number | ios | Item index. |
154
+ | itemId | String | ios | The item ID bound to the list item that generated the event. |
155
+
156
+ #### ListViewIndexEntry
157
+ > A simple object that represents an index entry in a `ListView`.
147
158
 
148
- #### Dictionary
149
- > Plain JavaScript object.
159
+ | Property | Type | Platform | Description |
160
+ |----------|------|----------|-------------|
161
+ | title | String | ios | Title to display in the index bar. |
162
+ | index | Number | ios | Section index associated with this title. |
150
163
 
151
- *Plus 6 more types: ListViewMarkerProps, Padding, Point, SelectedItem*
164
+ #### ListViewMarkerProps
165
+ > The parameter for [setMarker](Titanium.UI.ListView.setMarker) and [addMarker](Titanium.UI.ListView.addMarker) methods.
166
+
167
+ | Property | Type | Platform | Description |
168
+ |----------|------|----------|-------------|
169
+ | sectionIndex | Number | both | The sectionIndex of the reference item. |
170
+ | itemIndex | Number | both | The itemIndex of the reference item. |
171
+
172
+ #### SelectedItem
173
+ > The arguments for the <Titanium.UI.ListView.itemsselected> event.
174
+
175
+ | Property | Type | Platform | Description |
176
+ |----------|------|----------|-------------|
177
+ | section | Ti.UI.ListSection | both | List section if the item is contained in a list section. |
178
+ | sectionIndex | Number | both | Section index. |
179
+ | itemIndex | Number | both | Item index. |
180
+
181
+ Also referenced by this API, documented elsewhere: `Dictionary`, [HorizontalInsets](#horizontalinsets), [ListViewAnimationProperties](#listviewanimationproperties), [Padding](api-ui-windows-navigation.md#padding), [Point](api-ui-extras.md#point).
152
182
 
153
183
  ---
154
184
 
@@ -157,16 +187,11 @@ easily visualized as an Alloy view:
157
187
  > Extends Ti.Proxy
158
188
  > Platforms: both
159
189
 
160
- A list item is a combination of a <ListDataItem> and <ItemTemplate>. The list data item
161
- represents the actual data, while the item template represents the style elements of the item.
190
+ A list item is a combination of a <ListDataItem> and <ItemTemplate>. The list data item represents the actual data, while the item template represents the style elements of the item.
162
191
 
163
- You should not create `ListItem` objects with a JavaScript factory method, as you do other Titanium proxies.
164
- Instead, you should pass a <ListDataItem> array to the `setItems` method of a `ListSection`. The list data items
165
- contain the data you want to display in the list.
192
+ You should not create `ListItem` objects with a JavaScript factory method, as you do other Titanium proxies. Instead, you should pass a <ListDataItem> array to the `setItems` method of a `ListSection`. The list data items contain the data you want to display in the list.
166
193
 
167
- Alloy applications can use **`<ListItem>`** elements to create `ListItem` objects. `<ListItem>` elements
168
- must be nested inside a **`<ListSection>`** element, which itself is nested in a `<ListView>` element,
169
- as shown below:
194
+ Alloy applications can use **`<ListItem>`** elements to create `ListItem` objects. `<ListItem>` elements must be nested inside a **`<ListSection>`** element, which itself is nested in a `<ListView>` element, as shown below:
170
195
 
171
196
 
172
197
  ### Properties (unique: 26/28)
@@ -238,8 +263,7 @@ as shown below:
238
263
 
239
264
  Use the <Titanium.UI.createListSection> method or **`<ListSection>`** Alloy element to create a `ListSection`.
240
265
 
241
- List sections are used to manipulate and organize list items contained within it. For examples
242
- of using list sections, see the examples in <Titanium.UI.ListView> and <Titanium.UI.ListItem>.
266
+ List sections are used to manipulate and organize list items contained within it. For examples of using list sections, see the examples in <Titanium.UI.ListView> and <Titanium.UI.ListItem>.
243
267
 
244
268
  ### Properties (unique: 7/9)
245
269
  | Property | Type | Default | Platform | Description |
@@ -308,8 +332,7 @@ of using list sections, see the examples in <Titanium.UI.ListView> and <Titanium
308
332
  | ------- | --- |
309
333
  | ![Android](./tableview_android.png) | ![iOS](./tableview_ios.png) |
310
334
 
311
- A `TableView` object is a container for [TableViewSection](Titanium.UI.TableViewSection)
312
- objects that are, in turn, containers for [TableViewRow](Titanium.UI.TableViewRow) objects.
335
+ A `TableView` object is a container for [TableViewSection](Titanium.UI.TableViewSection) objects that are, in turn, containers for [TableViewRow](Titanium.UI.TableViewRow) objects.
313
336
 
314
337
  Use the <Titanium.UI.createTableView> method or **`<TableView>`** Alloy element to create a `TableView`.
315
338
 
@@ -431,27 +454,62 @@ There are few approaches to creating and using `TableView` object.
431
454
  #### AnimatedOptions
432
455
  > A JavaScript object holding an `animated` property. Used for many UI methods as a means of specifying some transition should be animated.
433
456
 
434
- | Property | Type | Description |
435
- |----------|------|-------------|
436
- | animated | Boolean | If `true`, animate a transition for the method/value change. Note that for most… |
457
+ | Property | Type | Platform | Description |
458
+ |----------|------|----------|-------------|
459
+ | animated | Boolean | both | If `true`, animate a transition for the method/value change. Note that for most… |
437
460
 
438
461
  #### AnimatedWithDurationOptions
439
462
  > A JavaScript object holding `animated` and `duration` properties. Used on iOS For [TableView](Titanium.UI.TableView) and [ListView](Titanium.UI.ListView) content offset transitions.
440
463
 
441
- | Property | Type | Description |
442
- |----------|------|-------------|
443
- | animated | Boolean | If `true`, animate a transition for the method/value change. Note that for most… |
444
- | duration | Number | The duration in `milliseconds` for animation |
464
+ | Property | Type | Platform | Description |
465
+ |----------|------|----------|-------------|
466
+ | animated | Boolean | both | If `true`, animate a transition for the method/value change. Note that for most… |
467
+ | duration | Number | both | The duration in `milliseconds` for animation |
445
468
 
446
469
  #### HorizontalInsets
447
470
  > Dictionary object of parameters for horizontal-only insets applied to [Table](Titanium.UI.TableView) and [List](Titanium.UI.ListView) views. Only `left` and `right` properties are used (see <Padding>).
448
471
 
449
- | Property | Type | Description |
450
- |----------|------|-------------|
451
- | left | Number | Left padding/inset |
452
- | right | Number | Right padding/inset |
472
+ | Property | Type | Platform | Description |
473
+ |----------|------|----------|-------------|
474
+ | left | Number | both | Left padding/inset |
475
+ | right | Number | both | Right padding/inset |
476
+
477
+ #### SelectedRowObject
478
+ > The arguments for the <Titanium.UI.TableView.rowsselected> event.
479
+
480
+ | Property | Type | Platform | Description |
481
+ |----------|------|----------|-------------|
482
+ | index | Number | both | Row index. |
483
+ | row | Ti.UI.TableViewRow | both | Table view row object. |
484
+ | rowData | Dictionary<Titanium.UI.TableViewRow> | both | Properties of the row. Use this property rather than `row` to access any custom… |
485
+ | section | Ti.UI.TableViewSection | both | Table view section object, if the clicked row is contained in a section. |
486
+
487
+ #### Size
488
+ > A simple object consisting of size measurements.
489
+
490
+ | Property | Type | Platform | Description |
491
+ |----------|------|----------|-------------|
492
+ | height | Number | both | The height measurement. |
493
+ | width | Number | both | The width measurement. |
494
+
495
+ #### TableViewAnimationProperties
496
+ > A simple object for specifying the animation properties to use when inserting or deleting rows, or scrolling the table.
497
+
498
+ | Property | Type | Platform | Description |
499
+ |----------|------|----------|-------------|
500
+ | animated | Boolean | both | Whether this table change should be animated. Ignored if any `animationStyle` v… |
501
+ | animationStyle | Number | both | Type of animation to use for row insertions and deletions. |
502
+ | position | Number | both | Specifies what position to scroll the selected row to. |
503
+
504
+ #### TableViewIndexEntry
505
+ > A simple object that represents an index entry in a `TableView`.
506
+
507
+ | Property | Type | Platform | Description |
508
+ |----------|------|----------|-------------|
509
+ | title | String | both | Title to display in the index bar for this item. |
510
+ | index | Number | both | Row index associated with this item. |
453
511
 
454
- *Plus 5 more types: SelectedRowObject, Size, TableViewAnimationProperties*
512
+ Also referenced by this API, documented elsewhere: `Dictionary`, [Padding](api-ui-windows-navigation.md#padding), [Point](api-ui-extras.md#point).
455
513
 
456
514
  ---
457
515
 
@@ -460,20 +518,15 @@ There are few approaches to creating and using `TableView` object.
460
518
  > Extends Ti.UI.View
461
519
  > Platforms: both
462
520
 
463
- Use the <Titanium.UI.createTableViewRow> method or **`<TableViewRow>`** Alloy element to create
464
- a table view row.
521
+ Use the <Titanium.UI.createTableViewRow> method or **`<TableViewRow>`** Alloy element to create a table view row.
465
522
 
466
- These may be explicitly added to [TableViewSection](Titanium.UI.TableViewSection) objects, which are applied
467
- to a [TableView](Titanium.UI.TableView). If a table section is not specified, one will be
468
- automatically created.
523
+ These may be explicitly added to [TableViewSection](Titanium.UI.TableViewSection) objects, which are applied to a [TableView](Titanium.UI.TableView). If a table section is not specified, one will be automatically created.
469
524
 
470
- A row's contents can be as simple as a single line of text, or comprised of a completely
471
- customized layout of child views.
525
+ A row's contents can be as simple as a single line of text, or comprised of a completely customized layout of child views.
472
526
 
473
527
  ### Creating Table View Rows
474
528
 
475
- Rows may be created using the properties directly available on the `TableViewRow` object, to
476
- achieve the following:
529
+ Rows may be created using the properties directly available on the `TableViewRow` object, to achieve the following:
477
530
 
478
531
 
479
532
  *(See full overview in titanium-docs)*
@@ -539,20 +592,13 @@ achieve the following:
539
592
  > Extends Ti.Proxy
540
593
  > Platforms: both
541
594
 
542
- Use the <Titanium.UI.createTableViewSection> method or **`<TableViewSection>`** Alloy element to
543
- create a `TableViewSection`.
595
+ Use the <Titanium.UI.createTableViewSection> method or **`<TableViewSection>`** Alloy element to create a `TableViewSection`.
544
596
 
545
- Before the table is rendered, the `TableViewSection` [add](Titanium.UI.TableViewSection.add)
546
- method may be used to add [TableViewRow](Titanium.UI.TableViewRow) objects to a section. After
547
- it is rendered, one of the `TableView` [insertRowBefore](Titanium.UI.TableView.insertRowBefore),
548
- [insertRowAfter](Titanium.UI.TableView.insertRowAfter), or
549
- [appendRow](Titanium.UI.TableView.appendRow) methods must be used instead.
597
+ Before the table is rendered, the `TableViewSection` [add](Titanium.UI.TableViewSection.add) method may be used to add [TableViewRow](Titanium.UI.TableViewRow) objects to a section. After it is rendered, one of the `TableView` [insertRowBefore](Titanium.UI.TableView.insertRowBefore), [insertRowAfter](Titanium.UI.TableView.insertRowAfter), or [appendRow](Titanium.UI.TableView.appendRow) methods must be used instead.
550
598
 
551
- To remove a row from a section after the table is rendered, use the `TableView`
552
- [deleteRow](Titanium.UI.TableView.deleteRow) method.
599
+ To remove a row from a section after the table is rendered, use the `TableView` [deleteRow](Titanium.UI.TableView.deleteRow) method.
553
600
 
554
- In order for a section to be visible, either its `headerTitle` or `headerView` property must be
555
- configured.
601
+ In order for a section to be visible, either its `headerTitle` or `headerView` property must be configured.
556
602
 
557
603
 
558
604
  *(See full overview in titanium-docs)*