@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
@@ -28,8 +28,7 @@ Use the <Titanium.UI.createTextField> method or **`<TextField>`** Alloy element
28
28
 
29
29
  ### `click` event in iOS
30
30
 
31
- In iOS 11+, `click` event in text field is not fired due to changes from apple.
32
- Use `touchstart` event instead of `click` event.
31
+ In iOS 11+, `click` event in text field is not fired due to changes from apple. Use `touchstart` event instead of `click` event.
33
32
 
34
33
  ### Properties (unique: 45/116)
35
34
  | Property | Type | Default | Platform | Description |
@@ -144,8 +143,7 @@ Use the <Titanium.UI.createTextArea> method or **&lt;TextArea&gt;** Alloy elemen
144
143
 
145
144
  ### `click` event in iOS
146
145
 
147
- In iOS 11+, `click` event in text area is not fired due to changes from apple.
148
- Use `touchstart` event instead of `click` event.
146
+ In iOS 11+, `click` event in text area is not fired due to changes from apple. Use `touchstart` event instead of `click` event.
149
147
 
150
148
  ### Properties (unique: 40/111)
151
149
  | Property | Type | Default | Platform | Description |
@@ -252,10 +250,7 @@ Use `touchstart` event instead of `click` event.
252
250
  | ------- | --- |
253
251
  | ![Android](./searchbar_android.png) | ![iOS](./searchbar_ios.png) |
254
252
 
255
- Search bars are most commonly used for filtering the rows in a [TableView](Titanium.UI.TableView) and
256
- [ListView](Titanium.UI.ListView). You can add a search bar to a table view via its
257
- [search](Titanium.UI.TableView.search) property. You can add a search bar to a list view via its
258
- [searchBar](Titanium.UI.SearchBar) property.
253
+ Search bars are most commonly used for filtering the rows in a [TableView](Titanium.UI.TableView) and [ListView](Titanium.UI.ListView). You can add a search bar to a table view via its [search](Titanium.UI.TableView.search) property. You can add a search bar to a list view via its [searchBar](Titanium.UI.SearchBar) property.
259
254
 
260
255
  A search bar can also be used on its own.
261
256
 
@@ -340,11 +335,9 @@ Use the <Titanium.UI.createSearchBar> method or Alloy **`<SearchBar>`** element
340
335
 
341
336
  The AttributedString proxy is created with the <Titanium.UI.createAttributedString> method.
342
337
 
343
- The `text` property must be set initially in the constructor when creating an attributed string.
344
- The [attributes](Titanium.UI.AttributedString.attributes) can either be set in the constructor or after it has been created.
338
+ The `text` property must be set initially in the constructor when creating an attributed string. The [attributes](Titanium.UI.AttributedString.attributes) can either be set in the constructor or after it has been created.
345
339
 
346
- For examples of Attributed Strings, see the
347
- [Attributed Strings guide](https://titaniumsdk.com/guide/Titanium_SDK/Titanium_SDK_How-tos/User_Interface_Deep_Dives/Attributed_Strings.html).
340
+ For examples of Attributed Strings, see the [Attributed Strings guide](https://titaniumsdk.com/guide/Titanium_SDK/Titanium_SDK_How-tos/User_Interface_Deep_Dives/Attributed_Strings.html).
348
341
 
349
342
  ### Properties (unique: 2/5)
350
343
  | Property | Type | Default | Platform | Description |
@@ -377,9 +370,7 @@ For examples of Attributed Strings, see the
377
370
  > Extends Ti.Proxy
378
371
  > Platforms: both
379
372
 
380
- This type may be used on iOS for assignment to any property typically taking a String color value.
381
- A developer is not expected to typically interact with a <Titanium.UI.Color> object, as we generate them
382
- under the hood when converting the passed in String representations. One major exception is use of the
373
+ This type may be used on iOS for assignment to any property typically taking a String color value. A developer is not expected to typically interact with a <Titanium.UI.Color> object, as we generate them under the hood when converting the passed in String representations. One major exception is use of the
383
374
 
384
375
 
385
376
  ### Methods (1)
@@ -396,18 +387,11 @@ under the hood when converting the passed in String representations. One major e
396
387
  > Platforms: both
397
388
  > Type: module
398
389
 
399
- The Clipboard is a temporary data store, used to save a single item of data that may then
400
- be accessed by the user using UI copy and paste interactions within an app or between apps.
390
+ The Clipboard is a temporary data store, used to save a single item of data that may then be accessed by the user using UI copy and paste interactions within an app or between apps.
401
391
 
402
- On iOS, the module's `setData()` and `getData()` methods enable multiple representations of the
403
- same data item to be stored together with their respective
404
- [MIME type](http://en.wikipedia.org/wiki/Internet_media_type) to describe their format. For
405
- example, `'text'` and `'text/plain'` for text, and `'image/jpg'` and `'image/png'` for an image.
406
- iOS Will report back the type of data representation in `getItems()` as
407
- [Universal Type Identifiers](https://developer.apple.com/library/archive/documentation/Miscellaneous/Reference/UTIRef/Articles/System-DeclaredUniformTypeIdentifiers.html).
392
+ On iOS, the module's `setData()` and `getData()` methods enable multiple representations of the same data item to be stored together with their respective [MIME type](http://en.wikipedia.org/wiki/Internet_media_type) to describe their format. For example, `'text'` and `'text/plain'` for text, and `'image/jpg'` and `'image/png'` for an image. iOS Will report back the type of data representation in `getItems()` as [Universal Type Identifiers](https://developer.apple.com/library/archive/documentation/Miscellaneous/Reference/UTIRef/Articles/System-DeclaredUniformTypeIdentifiers.html).
408
393
 
409
- When working with text, either of the `getData()`/`setData()` methods may be used with a `'text/plain'` type, or
410
- the `getText()`/`hasText()`/`setText()` methods without the need to specify the type.
394
+ When working with text, either of the `getData()`/`setData()` methods may be used with a `'text/plain'` type, or the `getText()`/`hasText()`/`setText()` methods without the need to specify the type.
411
395
 
412
396
  Android currently only supports text data to be stored.
413
397
 
@@ -464,15 +448,9 @@ Android currently only supports text data to be stored.
464
448
 
465
449
  Use the <Titanium.UI.createPicker> method or Alloy **`<Picker>`** element to create a picker control.
466
450
 
467
- On Android, the `useSpinner` property must be enabled to support multiple columns.
468
- By default, the spinner is automatically sized to fit its content and can overflow
469
- to additional spinner rows. The size of the picker can be adjusted with the `width`
470
- and `height` properties, but may omit picker columns or cut off picker rows
471
- if the size is set too small. This property is deprecated. Please use the default
472
- Android native "dropdown" style by not setting `useSpinner` to `true`.
451
+ On Android, the `useSpinner` property must be enabled to support multiple columns. By default, the spinner is automatically sized to fit its content and can overflow to additional spinner rows. The size of the picker can be adjusted with the `width` and `height` properties, but may omit picker columns or cut off picker rows if the size is set too small. This property is deprecated. Please use the default Android native "dropdown" style by not setting `useSpinner` to `true`.
473
452
 
474
- On iOS, the `height` property is only available in iOS 9 and later.
475
- By default, the size of the picker, including its background, is fixed at the
453
+ On iOS, the `height` property is only available in iOS 9 and later. By default, the size of the picker, including its background, is fixed at the
476
454
 
477
455
  *(See full overview in titanium-docs)*
478
456
 
@@ -542,9 +520,7 @@ By default, the size of the picker, including its background, is fixed at the
542
520
  > Extends Ti.UI.View
543
521
  > Platforms: both
544
522
 
545
- Use the <Titanium.UI.createPickerColumn> method to create a picker column control. In an Alloy application,
546
- you can use a **`<PickerColumn>`** element inside a `<Picker>` element. You can also use `<Column>`
547
- as a shorthand for `<PickerColumn>` (see Examples).
523
+ Use the <Titanium.UI.createPickerColumn> method to create a picker column control. In an Alloy application, you can use a **`<PickerColumn>`** element inside a `<Picker>` element. You can also use `<Column>` as a shorthand for `<PickerColumn>` (see Examples).
548
524
 
549
525
  On Android, the `useSpinner` property must be enabled to support multiple columns.
550
526
 
@@ -585,9 +561,7 @@ See <Titanium.UI.Picker> for further examples of usage.
585
561
  > Extends Ti.UI.View
586
562
  > Platforms: both
587
563
 
588
- Use the <Titanium.UI.createPickerRow> method to create a picker row control. In an Alloy application,
589
- you can use a **`<PickerRow>`** element inside a `<PickerColumn>` element. You can also use `<Row>`
590
- as a shorthand for `<PickerRow>` (see Examples).
564
+ Use the <Titanium.UI.createPickerRow> method to create a picker row control. In an Alloy application, you can use a **`<PickerRow>`** element inside a `<PickerColumn>` element. You can also use `<Row>` as a shorthand for `<PickerRow>` (see Examples).
591
565
 
592
566
  Views added to picker rows is only supported on iOS.
593
567
 
@@ -20,13 +20,9 @@
20
20
 
21
21
  To create a window, use the <Titanium.UI.createWindow> method or a **`<Window>`** Alloy element.
22
22
 
23
- A window is a top-level container which can contain other views. Windows can
24
- be *opened* and *closed*. Opening a window causes the window and its child
25
- views to be added to the application's render stack, on top of any previously opened
26
- windows. Closing a window removes the window and its children from the render stack.
23
+ A window is a top-level container which can contain other views. Windows can be *opened* and *closed*. Opening a window causes the window and its child views to be added to the application's render stack, on top of any previously opened windows. Closing a window removes the window and its children from the render stack.
27
24
 
28
- Windows *contain* other views, but in general they are not *contained* inside
29
- other views. There are a few specialized views that manage windows:
25
+ Windows *contain* other views, but in general they are not *contained* inside other views. There are a few specialized views that manage windows:
30
26
 
31
27
  * [NavigationWindow](Titanium.UI.NavigationWindow)
32
28
  * [SplitWindow](Titanium.UI.iOS.SplitWindow)
@@ -168,32 +164,60 @@ This applies to Windows inside both standalone NavigationWindow and TabGroup (wh
168
164
  #### AnimatedOptions
169
165
  > A JavaScript object holding an `animated` property. Used for many UI methods as a means of specifying some transition should be animated.
170
166
 
171
- | Property | Type | Description |
172
- |----------|------|-------------|
173
- | animated | Boolean | If `true`, animate a transition for the method/value change. Note that for most… |
167
+ | Property | Type | Platform | Description |
168
+ |----------|------|----------|-------------|
169
+ | animated | Boolean | both | If `true`, animate a transition for the method/value change. Note that for most… |
170
+
171
+ #### closeWindowParams
172
+ > Dictionary of options for the <Titanium.UI.Window.close> method.
173
+
174
+ | Property | Type | Platform | Description |
175
+ |----------|------|----------|-------------|
176
+ | animated | Boolean | both | Determines whether to use an animated effect when the window is closed. Default… |
177
+ | animationDuration | Number | ios | duration of the animation in milliseconds |
178
+ | animationStyle | Number | ios | Transition type to use during a transition animation. |
179
+ | activityEnterAnimation | Number | android | Animation resource to use for the incoming activity. |
180
+ | activityExitAnimation | Number | android | Animation resource to use for the outgoing activity. |
174
181
 
175
182
  #### Padding
176
183
  > Dictionary object of parameters for the padding/insets applied to all kinds of views.
177
184
 
178
- | Property | Type | Description |
179
- |----------|------|-------------|
180
- | left | Number | Left padding/inset |
181
- | right | Number | Right padding/inset |
182
- | top | Number | Top padding/inset |
183
- | bottom | Number | Bottom padding/inset |
185
+ | Property | Type | Platform | Description |
186
+ |----------|------|----------|-------------|
187
+ | left | Number | both | Left padding/inset |
188
+ | right | Number | both | Right padding/inset |
189
+ | top | Number | both | Top padding/inset |
190
+ | bottom | Number | both | Bottom padding/inset |
184
191
 
185
- #### closeWindowParams
186
- > Dictionary of options for the <Titanium.UI.Window.close> method.
192
+ #### shadowDict
193
+ > Dictionary describing the shadow effect for text.
187
194
 
188
- | Property | Type | Description |
189
- |----------|------|-------------|
190
- | animated | Boolean | Determines whether to use an animated effect when the window is closed. Default… |
191
- | animationDuration | Number | duration of the animation in milliseconds |
192
- | animationStyle | Number | Transition type to use during a transition animation. |
193
- | activityEnterAnimation | Number | Animation resource to use for the incoming activity. |
194
- | activityExitAnimation | Number | Animation resource to use for the outgoing activity. |
195
+ | Property | Type | Platform | Description |
196
+ |----------|------|----------|-------------|
197
+ | blurRadius | Number | both | Specifies the blur radius of the shadow. |
198
+ | color | String \| Ti.UI.Color | both | Color name or hex triplet specifying the color of the shadow. |
199
+ | offset | Size | both | <Size> with the properties `width` and `height` used as the horizontal and vert… |
200
+
201
+ #### titleAttributesParams
202
+ > Dictionary of options for the <Titanium.UI.Window.titleAttributes> property.
203
+
204
+ | Property | Type | Platform | Description |
205
+ |----------|------|----------|-------------|
206
+ | color | String \| Ti.UI.Color | both | Color of the window title, as a color name or hex triplet. |
207
+ | font | Font | ios | Font to use for the window title. |
208
+ | shadow | shadowDict | ios | Shadow color and offset for the window title. |
195
209
 
196
- *Plus 3 more types: windowToolbarParam*
210
+ #### windowToolbarParam
211
+ > Dictionary of options for the <Titanium.UI.Window.setToolbar> method.
212
+
213
+ | Property | Type | Platform | Description |
214
+ |----------|------|----------|-------------|
215
+ | translucent | Boolean | both | Defines if the toolbar is translucent. |
216
+ | animated | Boolean | both | Defines if the toolbar appearance is animated. |
217
+ | barColor | String \| Ti.UI.Color | both | Background color for the toolbar, as a color name or hex triplet. |
218
+ | tintColor | String \| Ti.UI.Color | both | The tintColor to apply to the tool bar. |
219
+
220
+ Also referenced by this API, documented elsewhere: `Dictionary`, [Font](api-ui-lists.md#font), [openWindowParams](#openwindowparams).
197
221
 
198
222
  ---
199
223
 
@@ -202,13 +226,9 @@ This applies to Windows inside both standalone NavigationWindow and TabGroup (wh
202
226
  > Extends Ti.UI.Window
203
227
  > Platforms: both
204
228
 
205
- You create a `NavigationWindow` with the <Titanium.UI.createNavigationWindow> factory method or
206
- a `<NavigationWindow>` Alloy element.
229
+ You create a `NavigationWindow` with the <Titanium.UI.createNavigationWindow> factory method or a `<NavigationWindow>` Alloy element.
207
230
 
208
- All `NavigationWindow` objects must have at least one root window that cannot be removed. When
209
- creating a `NavigationWindow` with the factory method, you must set its `window` property to the
210
- root level window. Equivalently, in an Alloy application, insert a `<Window>` element as a child of the
211
- `<NavigationWindow>` element. See examples below.
231
+ All `NavigationWindow` objects must have at least one root window that cannot be removed. When creating a `NavigationWindow` with the factory method, you must set its `window` property to the root level window. Equivalently, in an Alloy application, insert a `<Window>` element as a child of the `<NavigationWindow>` element. See examples below.
212
232
 
213
233
  This object is not meant to be added to other windows. However, it can be used within a <Titanium.UI.iOS.SplitWindow>.
214
234
 
@@ -250,14 +270,11 @@ This object is not meant to be added to other windows. However, it can be used w
250
270
  | ------- | --- |
251
271
  | ![Android](./tabgroup_android.png) | |
252
272
 
253
- A tab group can contain one or more [Tab](Titanium.UI.Tab) objects, each of which has an
254
- associated tab control that is used to bring it into focus.
273
+ A tab group can contain one or more [Tab](Titanium.UI.Tab) objects, each of which has an associated tab control that is used to bring it into focus.
255
274
 
256
- Use the <Titanium.UI.createTabGroup> method or **`<TabGroup>`** Alloy element to create a tab group
257
- that, in turn, contains one or more `<Tab>` elements.
275
+ Use the <Titanium.UI.createTabGroup> method or **`<TabGroup>`** Alloy element to create a tab group that, in turn, contains one or more `<Tab>` elements.
258
276
 
259
- You can add tabs to the group using [addTab](Titanium.UI.TabGroup.addTab), and programmatically
260
- switch to a specific tab using [setActiveTab](Titanium.UI.TabGroup.setActiveTab).
277
+ You can add tabs to the group using [addTab](Titanium.UI.TabGroup.addTab), and programmatically switch to a specific tab using [setActiveTab](Titanium.UI.TabGroup.setActiveTab).
261
278
 
262
279
  ### Platform Implementation Notes
263
280
 
@@ -345,45 +362,45 @@ switch to a specific tab using [setActiveTab](Titanium.UI.TabGroup.setActiveTab)
345
362
  #### closeWindowParams
346
363
  > Dictionary of options for the <Titanium.UI.Window.close> method.
347
364
 
348
- | Property | Type | Description |
349
- |----------|------|-------------|
350
- | animated | Boolean | Determines whether to use an animated effect when the window is closed. Default… |
351
- | animationDuration | Number | duration of the animation in milliseconds |
352
- | animationStyle | Number | Transition type to use during a transition animation. |
353
- | activityEnterAnimation | Number | Animation resource to use for the incoming activity. |
354
- | activityExitAnimation | Number | Animation resource to use for the outgoing activity. |
365
+ | Property | Type | Platform | Description |
366
+ |----------|------|----------|-------------|
367
+ | animated | Boolean | both | Determines whether to use an animated effect when the window is closed. Default… |
368
+ | animationDuration | Number | ios | duration of the animation in milliseconds |
369
+ | animationStyle | Number | ios | Transition type to use during a transition animation. |
370
+ | activityEnterAnimation | Number | android | Animation resource to use for the incoming activity. |
371
+ | activityExitAnimation | Number | android | Animation resource to use for the outgoing activity. |
355
372
 
356
373
  #### disableTabOptions
357
374
  > Dictionary of options for the <Titanium.UI.TabGroup.disableTabOptions> method.
358
375
 
359
- | Property | Type | Description |
360
- |----------|------|-------------|
361
- | animated | Boolean | Determines whether to use an animated effect to hide/show the navigation bar. |
362
- | enabled | Boolean | Show or hide the navigation bar. |
376
+ | Property | Type | Platform | Description |
377
+ |----------|------|----------|-------------|
378
+ | animated | Boolean | both | Determines whether to use an animated effect to hide/show the navigation bar. |
379
+ | enabled | Boolean | both | Show or hide the navigation bar. |
363
380
 
364
381
  #### openWindowParams
365
382
  > Dictionary of options for the <Titanium.UI.Window.open> method.
366
383
 
367
- | Property | Type | Description |
368
- |----------|------|-------------|
369
- | animated | Boolean | Determines whether to use an animated effect when the window is shown. |
370
- | bottom | Number \| String | Window's bottom position, in platform-specific units. |
371
- | fullscreen | Boolean | Determines if the window is fullscreen. |
372
- | height | Number \| String | Window's height, in platform-specific units. |
373
- | left | Number \| String | Window's left position, in platform-specific units. |
374
- | modal | Boolean | Determines whether to open the window modal in front of other windows. |
375
- | forceModal | Boolean | Indicates whether the window enforces modal behaviour. |
376
- | modalStyle | Number | Presentation style of this modal window. |
377
- | modalTransitionStyle | Number | Transition style of this modal window. |
378
- | navBarHidden | Boolean | For modal windows, hides the nav bar (`true`) or shows the nav bar (`false`). |
379
- | right | Number \| String | Window's right position, in platform-specific units. |
380
- | top | Number \| String | Window's top position, in platform-specific units. |
381
- | transition | Number | Transition style of this non-modal window. |
382
- | width | Number \| String | Window's width, in platform-specific units. |
383
- | activityEnterAnimation | Number | Animation resource to run on the activity being opened. |
384
- | activityExitAnimation | Number | Animation resource to run on the activity that is being put in background as a … |
385
-
386
- *Plus 1 more types: *
384
+ | Property | Type | Platform | Description |
385
+ |----------|------|----------|-------------|
386
+ | animated | Boolean | both | Determines whether to use an animated effect when the window is shown. |
387
+ | bottom | Number \| String | both | Window's bottom position, in platform-specific units. |
388
+ | fullscreen | Boolean | both | Determines if the window is fullscreen. |
389
+ | height | Number \| String | both | Window's height, in platform-specific units. |
390
+ | left | Number \| String | both | Window's left position, in platform-specific units. |
391
+ | modal | Boolean | both | Determines whether to open the window modal in front of other windows. |
392
+ | forceModal | Boolean | ios | Indicates whether the window enforces modal behaviour. |
393
+ | modalStyle | Number | ios | Presentation style of this modal window. |
394
+ | modalTransitionStyle | Number | ios | Transition style of this modal window. |
395
+ | navBarHidden | Boolean | both | For modal windows, hides the nav bar (`true`) or shows the nav bar (`false`). |
396
+ | right | Number \| String | both | Window's right position, in platform-specific units. |
397
+ | top | Number \| String | both | Window's top position, in platform-specific units. |
398
+ | transition | Number | ios | Transition style of this non-modal window. |
399
+ | width | Number \| String | both | Window's width, in platform-specific units. |
400
+ | activityEnterAnimation | Number | android | Animation resource to run on the activity being opened. |
401
+ | activityExitAnimation | Number | android | Animation resource to run on the activity that is being put in background as a … |
402
+
403
+ Also referenced by this API, documented elsewhere: `Dictionary`, [Font](api-ui-lists.md#font), [shadowDict](#shadowdict), [titleAttributesParams](#titleattributesparams).
387
404
 
388
405
  ---
389
406
 
@@ -392,21 +409,17 @@ switch to a specific tab using [setActiveTab](Titanium.UI.TabGroup.setActiveTab)
392
409
  > Extends Ti.UI.View
393
410
  > Platforms: both
394
411
 
395
- A `TabGroup` tab instance. Each tab includes a button and one or more windows, which
396
- holds the "contents" of the tab. Users can select a tab by clicking on the tab button.
412
+ A `TabGroup` tab instance. Each tab includes a button and one or more windows, which holds the "contents" of the tab. Users can select a tab by clicking on the tab button.
397
413
 
398
414
  Use the <Titanium.UI.createTab> method or **`<Tab>`** Alloy element to create a tab.
399
415
 
400
- Use [TabGroup.setActiveTab](Titanium.UI.TabGroup.setActiveTab) to switch between tabs
401
- in a tab group.
416
+ Use [TabGroup.setActiveTab](Titanium.UI.TabGroup.setActiveTab) to switch between tabs in a tab group.
402
417
 
403
- The behavior of tabs and tab groups follows the platform's native navigation style,
404
- which varies significantly between platforms.
418
+ The behavior of tabs and tab groups follows the platform's native navigation style, which varies significantly between platforms.
405
419
 
406
420
  ### iOS Platform Implementation Notes
407
421
 
408
- On iOS, the tab maintains a stack of windows. Windows on top
409
- of the stack can partially or totally obscure windows lower in the stack. Calling
422
+ On iOS, the tab maintains a stack of windows. Windows on top of the stack can partially or totally obscure windows lower in the stack. Calling
410
423
 
411
424
  *(See full overview in titanium-docs)*
412
425
 
@@ -502,15 +515,11 @@ of the stack can partially or totally obscure windows lower in the stack. Calli
502
515
 
503
516
  An alert dialog is created using <Titanium.UI.createAlertDialog> or **`<AlertDialog>`** Alloy element.
504
517
 
505
- Although this dialog always appears in the middle of the display (not touching the edges),
506
- other aspects of its aesthetics and the way the user interacts with it are different for each
507
- platform, as described below.
518
+ Although this dialog always appears in the middle of the display (not touching the edges), other aspects of its aesthetics and the way the user interacts with it are different for each platform, as described below.
508
519
 
509
520
  ### Android
510
521
 
511
- On Android, the default alert dialog displays text information, via a title and message, without
512
- any buttons. As the user can use the system hardware `back` button to dismiss it, a button is
513
- optional.
522
+ On Android, the default alert dialog displays text information, via a title and message, without any buttons. As the user can use the system hardware `back` button to dismiss it, a button is optional.
514
523
 
515
524
  *(See full overview in titanium-docs)*
516
525
 
@@ -586,16 +595,13 @@ optional.
586
595
  | ------- | ------ | ---- |
587
596
  | ![Android](./optiondialog_android.png) | ![iPhone](./optiondialog_iphone.png) | ![iPad](./optiondialog_ipad.png) |
588
597
 
589
- An option dialog is created using <Titanium.UI.createOptionDialog> or Alloy `<OptionDialog>`
590
- element. See Examples below for usage.
598
+ An option dialog is created using <Titanium.UI.createOptionDialog> or Alloy `<OptionDialog>` element. See Examples below for usage.
591
599
 
592
600
  This dialog is presented differently on each platform, as described below.
593
601
 
594
602
  ### Android
595
603
 
596
- On Android, the dialog is shown in the middle of the display (not touching the edges),
597
- with the option items represented in a picker. The previously-selected, or default, item can be
598
- set on creation.
604
+ On Android, the dialog is shown in the middle of the display (not touching the edges), with the option items represented in a picker. The previously-selected, or default, item can be set on creation.
599
605
 
600
606
 
601
607
  *(See full overview in titanium-docs)*
@@ -659,13 +665,9 @@ set on creation.
659
665
  | ------- | --- |
660
666
  | ![Android](./toast_android.png) | |
661
667
 
662
- A toast notification is an unobtrusive, pop-up notification that does not
663
- block the UI. Use the <Titanium.UI.createNotification> method or **`<Notification>`** Alloy element
664
- to create a Toast notification.
668
+ A toast notification is an unobtrusive, pop-up notification that does not block the UI. Use the <Titanium.UI.createNotification> method or **`<Notification>`** Alloy element to create a Toast notification.
665
669
 
666
- On Android, by default, a toast notification appears centered on the bottom half of the screen.
667
- On Windows Phone, by default, a toast notification appears over the status bar on the top part
668
- of the screen.
670
+ On Android, by default, a toast notification appears centered on the bottom half of the screen. On Windows Phone, by default, a toast notification appears over the status bar on the top part of the screen.
669
671
 
670
672
  ### Properties (unique: 7/10)
671
673
  | Property | Type | Default | Platform | Description |
@@ -39,8 +39,7 @@
39
39
 
40
40
  The API for this module is based on the W3C DOM specification.
41
41
 
42
- Android and iOS implement the [DOM Level 2](https://www.w3.org/TR/DOM-Level-2-Core/core.html) specification
43
- with some non-standard extensions, which are documented in the appropriate places.
42
+ Android and iOS implement the [DOM Level 2](https://www.w3.org/TR/DOM-Level-2-Core/core.html) specification with some non-standard extensions, which are documented in the appropriate places.
44
43
 
45
44
  Both iOS and Android lack DTD support.
46
45
 
@@ -59,8 +58,7 @@ Both iOS and Android lack DTD support.
59
58
  > Extends Ti.XML.Node
60
59
  > Platforms: both
61
60
 
62
- Implements the [DOM Level 2 API](https://www.w3.org/TR/DOM-Level-2-Core/core.html#ID-637646024) on
63
- Android and iOS.
61
+ Implements the [DOM Level 2 API](https://www.w3.org/TR/DOM-Level-2-Core/core.html#ID-637646024) on Android and iOS.
64
62
 
65
63
  ### Properties (unique: 4/35)
66
64
  | Property | Type | Default | Platform | Description |
@@ -80,8 +78,7 @@ Android and iOS.
80
78
  > Extends Ti.XML.Text
81
79
  > Platforms: both
82
80
 
83
- Implements the [DOM Level 2 API](https://www.w3.org/TR/DOM-Level-2-Core/core.html#ID-667469212) on
84
- Android and iOS with some non-standard extensions.
81
+ Implements the [DOM Level 2 API](https://www.w3.org/TR/DOM-Level-2-Core/core.html#ID-667469212) on Android and iOS with some non-standard extensions.
85
82
 
86
83
 
87
84
 
@@ -117,8 +114,7 @@ Android and iOS with some non-standard extensions.
117
114
  > Extends Ti.XML.CharacterData
118
115
  > Platforms: both
119
116
 
120
- Implements the [DOM Level 2 API](https://www.w3.org/TR/DOM-Level-2-Core/core.html#ID-1728279322) on
121
- Android and iOS with some non-standard extensions.
117
+ Implements the [DOM Level 2 API](https://www.w3.org/TR/DOM-Level-2-Core/core.html#ID-1728279322) on Android and iOS with some non-standard extensions.
122
118
 
123
119
 
124
120
 
@@ -146,12 +142,9 @@ Android and iOS with some non-standard extensions.
146
142
  > Extends Ti.XML.Node
147
143
  > Platforms: both
148
144
 
149
- Implements the [DOM Level 2 API](https://www.w3.org/TR/DOM-Level-2-Core/core.html#i-Document) on
150
- Android and iOS.
145
+ Implements the [DOM Level 2 API](https://www.w3.org/TR/DOM-Level-2-Core/core.html#i-Document) on Android and iOS.
151
146
 
152
- As of version 3.1, Android does not truly support DTDs. A document with a DTD can be
153
- parsed, however it is not validated, its default attributes are not be automatically
154
- added into the DOM tree, and so on.
147
+ As of version 3.1, Android does not truly support DTDs. A document with a DTD can be parsed, however it is not validated, its default attributes are not be automatically added into the DOM tree, and so on.
155
148
 
156
149
  This has been reported as [Android Issue #7395](http://code.google.com/p/android/issues/detail?id=7395).
157
150
 
@@ -189,11 +182,9 @@ This has been reported as [Android Issue #7395](http://code.google.com/p/android
189
182
  > Extends Ti.XML.Node
190
183
  > Platforms: both
191
184
 
192
- When a `DocumentFragment` is inserted into a DOM tree, children of the `DocumentFragment` are
193
- added, not the `DocumentFragment` itself.
185
+ When a `DocumentFragment` is inserted into a DOM tree, children of the `DocumentFragment` are added, not the `DocumentFragment` itself.
194
186
 
195
- Implements the [DOM Level 2 API](https://www.w3.org/TR/DOM-Level-2-Core/core.html#ID-B63ED1A3) on
196
- Android and iOS with some non-standard extensions.
187
+ Implements the [DOM Level 2 API](https://www.w3.org/TR/DOM-Level-2-Core/core.html#ID-B63ED1A3) on Android and iOS with some non-standard extensions.
197
188
 
198
189
 
199
190
 
@@ -205,12 +196,9 @@ Android and iOS with some non-standard extensions.
205
196
  > Extends Ti.XML.Node
206
197
  > Platforms: both
207
198
 
208
- This provides an interface to the list of entities that are defined for the document. Implements the
209
- [DOM Level 2 API](https://www.w3.org/TR/DOM-Level-2-Core/core.html#ID-412266927) on Android and iOS.
199
+ This provides an interface to the list of entities that are defined for the document. Implements the [DOM Level 2 API](https://www.w3.org/TR/DOM-Level-2-Core/core.html#ID-412266927) on Android and iOS.
210
200
 
211
- As of version 3.1, Android still does not truly support DTDs. A document with a DTD can be
212
- parsed, however it is not validated, none of its default attributes will automatically be put
213
- into the tree, etc. [Google is aware of the issue](http://code.google.com/p/android/issues/detail?id=7395).
201
+ As of version 3.1, Android still does not truly support DTDs. A document with a DTD can be parsed, however it is not validated, none of its default attributes will automatically be put into the tree, etc. [Google is aware of the issue](http://code.google.com/p/android/issues/detail?id=7395).
214
202
 
215
203
  ### Properties (unique: 6/37)
216
204
  | Property | Type | Default | Platform | Description |
@@ -284,8 +272,7 @@ into the tree, etc. [Google is aware of the issue](http://code.google.com/p/and
284
272
  > Extends Ti.XML.Node
285
273
  > Platforms: both
286
274
 
287
- Implements the [DOM Level 2 API](https://www.w3.org/TR/DOM-Level-2-Core/core.html#ID-11C98490)
288
- on Android and iOS.
275
+ Implements the [DOM Level 2 API](https://www.w3.org/TR/DOM-Level-2-Core/core.html#ID-11C98490) on Android and iOS.
289
276
 
290
277
 
291
278
 
@@ -322,13 +309,9 @@ on Android and iOS.
322
309
  > Extends Ti.Proxy
323
310
  > Platforms: both
324
311
 
325
- Implements the [DOM Level 2 API](https://www.w3.org/TR/DOM-Level-2-Core/core.html#ID-1950641247)
326
- on Android and iOS.
312
+ Implements the [DOM Level 2 API](https://www.w3.org/TR/DOM-Level-2-Core/core.html#ID-1950641247) on Android and iOS.
327
313
 
328
- Note that on iOS, only [Element](Titanium.XML.Element) nodes are mutable. This means
329
- that the methods `appendChild`, `insertBefore`, `removeChild`, and
330
- `replaceChild` only work on `Element` objects. If one of these methods is called on
331
- another type of node, it throws an exception.
314
+ Note that on iOS, only [Element](Titanium.XML.Element) nodes are mutable. This means that the methods `appendChild`, `insertBefore`, `removeChild`, and `replaceChild` only work on `Element` objects. If one of these methods is called on another type of node, it throws an exception.
332
315
 
333
316
  ### Properties (unique: 16/31)
334
317
  | Property | Type | Default | Platform | Description |
@@ -461,13 +444,11 @@ Titanium provides a number of global built-in objects, detailed below.
461
444
 
462
445
  ### String Utilities
463
446
 
464
- Titanium includes several extra utility functions for formatting text, attached to the
465
- global [String](Global.String) object.
447
+ Titanium includes several extra utility functions for formatting text, attached to the global [String](Global.String) object.
466
448
 
467
449
  ### console
468
450
 
469
- Titanium provides [console](Global.Console) support familiar to many JavaScript developers
470
- for logging at the toplevel, in addition to the [Titanium](Titanium.API) logging facilities.
451
+ Titanium provides [console](Global.Console) support familiar to many JavaScript developers for logging at the toplevel, in addition to the [Titanium](Titanium.API) logging facilities.
471
452
 
472
453
  ### Timers
473
454
 
@@ -551,13 +532,9 @@ Titanium has built-in support for one-off and repeating timers:
551
532
  > Platforms: both
552
533
  > Type: module
553
534
 
554
- The toplevel `console` support is intended to supplement <Titanium.API>
555
- and make it easier for developers to port existing JavaScript code
556
- (especially CommonJS modules) to Titanium.
535
+ The toplevel `console` support is intended to supplement <Titanium.API> and make it easier for developers to port existing JavaScript code (especially CommonJS modules) to Titanium.
557
536
 
558
- Note that `console` does not currently implement the complete
559
- [Console](https://developer.mozilla.org/de/docs/Web/API/Console) specification.
560
- See the following supported methods for details and submit a pull request to add more!
537
+ Note that `console` does not currently implement the complete [Console](https://developer.mozilla.org/de/docs/Web/API/Console) specification. See the following supported methods for details and submit a pull request to add more!
561
538
 
562
539
 
563
540
  ### Methods (15)
@@ -588,11 +565,9 @@ See the following supported methods for details and submit a pull request to add
588
565
  > Platforms: both
589
566
  > Type: module
590
567
 
591
- Provides support for localized number formatting, date/time formatting,
592
- and language sensitive string comparisons.
568
+ Provides support for localized number formatting, date/time formatting, and language sensitive string comparisons.
593
569
 
594
- For more detail, see the MDN website about
595
- [Intl](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Intl).
570
+ For more detail, see the MDN website about [Intl](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Intl).
596
571
 
597
572
 
598
573
  ### Methods (1)
@@ -611,8 +586,7 @@ For more detail, see the MDN website about
611
586
 
612
587
  A collator is used to perform a localized string compare or sort using a given language locale.
613
588
 
614
- For more detail, see the MDN website about
615
- [Intl.Collator](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Intl/Collator).
589
+ For more detail, see the MDN website about [Intl.Collator](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Intl/Collator).
616
590
 
617
591
  ### Properties (unique: 1/1)
618
592
  | Property | Type | Default | Platform | Description |
@@ -650,13 +624,9 @@ For more detail, see the MDN website about
650
624
  > Platforms: both
651
625
  > Type: module
652
626
 
653
- A `DateTimeFormat` object is used to format a `Date` object to a localized date and/or time string.
654
- This will respect the system's current language setting when outputting a full month or weekday name.
655
- It will also respect the current locale's date component ordering such as Month/Day/Year,
656
- Day/Month/Year, and Year/Month/Day.
627
+ A `DateTimeFormat` object is used to format a `Date` object to a localized date and/or time string. This will respect the system's current language setting when outputting a full month or weekday name. It will also respect the current locale's date component ordering such as Month/Day/Year, Day/Month/Year, and Year/Month/Day.
657
628
 
658
- For more detail, see the MDN website about
659
- [Intl.DateTimeFormat](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Intl/DateTimeFormat).
629
+ For more detail, see the MDN website about [Intl.DateTimeFormat](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Intl/DateTimeFormat).
660
630
 
661
631
  ### Properties (unique: 1/1)
662
632
  | Property | Type | Default | Platform | Description |
@@ -707,13 +677,9 @@ For more detail, see the MDN website about
707
677
  > Platforms: both
708
678
  > Type: module
709
679
 
710
- A `NumberFormat` object is used to convert a `Number` value to a localized numeric string.
711
- It provides various formatting options controlling the number of integer and fractional digits
712
- to be displayed. It can also output currency values, percentage based values, and
713
- scientific notation.
680
+ A `NumberFormat` object is used to convert a `Number` value to a localized numeric string. It provides various formatting options controlling the number of integer and fractional digits to be displayed. It can also output currency values, percentage based values, and scientific notation.
714
681
 
715
- For more detail, see the MDN website about
716
- [Intl.NumberFormat](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Intl/NumberFormat).
682
+ For more detail, see the MDN website about [Intl.NumberFormat](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Intl/NumberFormat).
717
683
 
718
684
  ### Properties (unique: 1/1)
719
685
  | Property | Type | Default | Platform | Description |
@@ -756,8 +722,7 @@ For more detail, see the MDN website about
756
722
  > Platforms: both
757
723
  > Type: module
758
724
 
759
- This module contains Titanium-only extensions for formatting data into locale-specific strings.
760
- The target locale is configured by the user in the device's system Settings.
725
+ This module contains Titanium-only extensions for formatting data into locale-specific strings. The target locale is configured by the user in the device's system Settings.
761
726
 
762
727
 
763
728
  ### Methods (5)