Titanium.UI.iOS
Apple iOS specific UI capabilities. All properties, methods and events in this namespace will only work on Apple iOS devices.
Extends: Titanium.Module · Since: 1.4.0, 1.4.0, 9.2.0 · Platforms: iphone, ipad, macos
Properties #
ALERT_SEVERITY_CRITICAL#
Type: Number
Indicates that the system should present the alert using the
critical, or caution, style.
Use with Titanium.UI.iOS.createAlertDialog to specify
the alert dialog severity on macOS Catalyst.
ALERT_SEVERITY_DEFAULT#
Type: Number
Indicates that the system should present the alert using the standard
alert style.
Use with Titanium.UI.iOS.createAlertDialog to specify
the alert dialog severity on macOS Catalyst.
apiName#
Type: String
The name of the API that this proxy corresponds to.
The value of this property is the fully qualified name of the API. For example, Button
returns Ti.UI.Button.
appBadge#
Type: Number
Value of the badge for the application's springboard icon.
In order to change the app icon badge number you will need to register for notifications.
Normally this is done by using local notifications or a push service like Firebase Cloud Messaging (FCM).
Ti.App.iOS.registerUserNotificationSettings({
types: [
Ti.App.iOS.USER_NOTIFICATION_TYPE_BADGE
]
});
appSupportsShakeToEdit#
Type: Boolean
Determines whether the shake to edit system-wide capability is enabled.
AUDIOVISUAL_MEDIA_TYPE_AUDIO#
Type: Number
Media types containing audio require a user gesture to begin playing.
AUDIOVISUAL_MEDIA_TYPE_VIDEO#
Type: Number
Media types containing video require a user gesture to begin playing.
BLUR_EFFECT_STYLE_DARK#
Type: Number
Use with BlurView.effect to specify a blur effect.
Creates a blurring effect in the view. The area of the view is darker in hue than the underlying view.
BLUR_EFFECT_STYLE_EXTRA_LIGHT#
Type: Number
Use with BlurView.effect to specify a blur effect.
Creates a blurring effect in the view. The area of the view is lighter in hue than the underlying view.
BLUR_EFFECT_STYLE_LIGHT#
Type: Number
Use with BlurView.effect to specify a blur effect.
Creates a blurring effect in the view. The area of the view is the same approximate hue
of the underlying view.
BLUR_EFFECT_STYLE_PROMINENT#
Type: Number
Use with BlurView.effect to specify a blur effect.
Creates a blurring effect in the view. The area of the view is presented more prominent than the underlying view.
BLUR_EFFECT_STYLE_REGULAR#
Type: Number
Use with BlurView.effect to specify a blur effect.
Creates a blurring effect in the view. The blurring effect is the default one specified in iOS 10.
BLUR_EFFECT_STYLE_SYSTEM_CHROME_MATERIAL#
Type: Number
Use with BlurView.effect to specify a blur effect.
Creates a blurring effect in the view. This is an adaptable blur effect that creates the appearance of the system chrome.
BLUR_EFFECT_STYLE_SYSTEM_CHROME_MATERIAL_DARK#
Type: Number
Use with BlurView.effect to specify a blur effect.
Creates a blurring effect in the view. This blur effect creates the appearance of an ultra-thin material and is always dark.
BLUR_EFFECT_STYLE_SYSTEM_CHROME_MATERIAL_LIGHT#
Type: Number
Use with BlurView.effect to specify a blur effect.
Creates a blurring effect in the view. This blur effect creates the appearance of the system chrome and is always light.
BLUR_EFFECT_STYLE_SYSTEM_MATERIAL#
Type: Number
Use with BlurView.effect to specify a blur effect.
Creates a blurring effect in the view. This is an adaptable blur effect that creates the appearance of a material with normal thickness.
BLUR_EFFECT_STYLE_SYSTEM_MATERIAL_DARK#
Type: Number
Use with BlurView.effect to specify a blur effect.
Creates a blurring effect in the view. This blur effect creates the appearance of a thin material and is always dark.
BLUR_EFFECT_STYLE_SYSTEM_MATERIAL_LIGHT#
Type: Number
Use with BlurView.effect to specify a blur effect.
Creates a blurring effect in the view. This blur effect creates the appearance of a material with normal thickness and is always light.
BLUR_EFFECT_STYLE_SYSTEM_THICK_MATERIAL#
Type: Number
Use with BlurView.effect to specify a blur effect.
Creates a blurring effect in the view. This is an adaptable blur effect that creates the appearance of a material that is thicker than normal.
BLUR_EFFECT_STYLE_SYSTEM_THICK_MATERIAL_DARK#
Type: Number
Use with BlurView.effect to specify a blur effect.
Creates a blurring effect in the view. This blur effect creates the appearance of a material with normal thickness and is always dark.
BLUR_EFFECT_STYLE_SYSTEM_THICK_MATERIAL_LIGHT#
Type: Number
Use with BlurView.effect to specify a blur effect.
Creates a blurring effect in the view. This blur effect creates the appearance of a material that is thicker than normal and is always light.
BLUR_EFFECT_STYLE_SYSTEM_THIN_MATERIAL#
Type: Number
Use with BlurView.effect to specify a blur effect.
Creates a blurring effect in the view. This is an adaptable blur effect that creates the appearance of a thin material.
BLUR_EFFECT_STYLE_SYSTEM_THIN_MATERIAL_DARK#
Type: Number
Use with BlurView.effect to specify a blur effect.
Creates a blurring effect in the view. This blur effect creates the appearance of a material that is thicker than normal and is always dark.
BLUR_EFFECT_STYLE_SYSTEM_THIN_MATERIAL_LIGHT#
Type: Number
Use with BlurView.effect to specify a blur effect.
Creates a blurring effect in the view. This blur effect creates the appearance of a thin material and is always light.
BLUR_EFFECT_STYLE_SYSTEM_ULTRA_THIN_MATERIAL#
Type: Number
Use with BlurView.effect to specify a blur effect.
Creates a blurring effect in the view. This is an adaptable blur effect that creates the appearance of a material with normal thickness.
BLUR_EFFECT_STYLE_SYSTEM_ULTRA_THIN_MATERIAL_DARK#
Type: Number
Use with BlurView.effect to specify a blur effect.
Creates a blurring effect in the view. This blur effect creates the appearance of the system chrome and is always dark.
BLUR_EFFECT_STYLE_SYSTEM_ULTRA_THIN_MATERIAL_LIGHT#
Type: Number
Use with BlurView.effect to specify a blur effect.
Creates a blurring effect in the view. This blur effect creates the appearance of an ultra-thin material and is always light.
bubbleParent#
Type: Boolean
Indicates if the proxy will bubble an event to its parent.
Some proxies (most commonly views) have a relationship to other proxies, often
established by the add() method. For example, for a button added to a window, a
click event on the button would bubble up to the window. Other common parents are
table sections to their rows, table views to their sections, and scrollable views
to their views. Set this property to false to disable the bubbling to the proxy's parent.
CACHE_POLICY_RELOAD_IGNORING_LOCAL_CACHE_DATA#
Type: Number
Specifies that the data for the URL load should be loaded from the originating source.
No existing cache data should be used to satisfy a URL load request.
Use with Titanium.UI.WebView.cachePolicy.
CACHE_POLICY_RETURN_CACHE_DATA_DONT_LOAD#
Type: Number
Specifies that the existing cache data should be used to satisfy a request,
regardless of its age or expiration date.
Use with Titanium.UI.WebView.cachePolicy. If there is no existing data in the cache corresponding
to a URL load request, no attempt is made to load the data from the originating source, and the load
is considered to have failed. This constant specifies a behavior that is similar to an offline mode.
CACHE_POLICY_RETURN_CACHE_DATA_ELSE_LOAD#
Type: Number
Specifies that the existing cached data should be used to satisfy the request,
regardless of its age or expiration date.
Use with Titanium.UI.WebView.cachePolicy. If there is no existing data in the cache
corresponding the request, the data is loaded from the originating source.
CACHE_POLICY_USE_PROTOCOL_CACHE_POLICY#
Type: Number
Specifies that the caching logic defined in the protocol implementation, if any,
is used for a particular URL load request.
Use with Titanium.UI.WebView.cachePolicy. This is the default policy for URL load requests.
If you are making HTTP or HTTPS byte-range requests, always use the
Titanium.UI.iOS.CACHE_POLICY_RELOAD_IGNORING_LOCAL_CACHE_DATA policy.
COLLISION_MODE_ALL#
Type: Number
Use with Titanium.UI.iOS.CollisionBehavior.collisionMode to specify collisions with both items and
boundaries.
COLLISION_MODE_BOUNDARY#
Type: Number
Use with Titanium.UI.iOS.CollisionBehavior.collisionMode to specify collisions with
boundaries only.
COLLISION_MODE_ITEM#
Type: Number
Use with Titanium.UI.iOS.CollisionBehavior.collisionMode to specify collisions with items only.
CREDENTIAL_PERSISTENCE_FOR_SESSION#
Type: Number
Credential should be stored only for this session.
Used with the persistence argument of Titanium.UI.WebView.setBasicAuthentication to set the persistence level.
CREDENTIAL_PERSISTENCE_NONE#
Type: Number
Credential should not be stored.
Used with the persistence argument of Titanium.UI.WebView.setBasicAuthentication to set the persistence level.
CREDENTIAL_PERSISTENCE_PERMANENT#
Type: Number
Credential should be stored in the keychain.
Used with the persistence argument of Titanium.UI.WebView.setBasicAuthentication to set the persistence level.
CREDENTIAL_PERSISTENCE_SYNCHRONIZABLE#
Type: Number
Credential should be stored permanently in the keychain, and in addition should be
distributed to other devices based on the owning AppleID.
Used with the persistence argument of Titanium.UI.WebView.setBasicAuthentication to set the persistence level.
DATE_PICKER_STYLE_AUTOMATIC (deprecated)#
Type: Number
Use with Titanium.UI.Picker.datePickerStyle to automatically pick the best style
available for the current platform & mode.
Note: Prior to iOS 14, this property is only used on iOS Catalyst apps.
DATE_PICKER_STYLE_COMPACT (deprecated)#
Type: Number
Use with Titanium.UI.Picker.datePickerStyle to show the picker with a compact style. Editing occurs in an overlay.
Note: Prior to iOS 14, this property is only used on iOS Catalyst apps.
DATE_PICKER_STYLE_INLINE (deprecated)#
Type: Number
Use with Titanium.UI.Picker.datePickerStyle to allow editing in place (as a calendar).
DATE_PICKER_STYLE_WHEELS (deprecated)#
Type: Number
Use with Titanium.UI.Picker.datePickerStyle to show the picker the wheels. Editing occurs inline.
FEEDBACK_GENERATOR_IMPACT_STYLE_HEAVY#
Type: Number
The heavy impact style used as the style argument when creating a Titanium.UI.iOS.FeedbackGenerator with the
type Titanium.UI.iOS.FEEDBACK_GENERATOR_TYPE_IMPACT.
FEEDBACK_GENERATOR_IMPACT_STYLE_LIGHT#
Type: Number
The light impact style used as the style argument when creating a Titanium.UI.iOS.FeedbackGenerator with the
type Titanium.UI.iOS.FEEDBACK_GENERATOR_TYPE_IMPACT.
FEEDBACK_GENERATOR_IMPACT_STYLE_MEDIUM#
Type: Number
The medium impact style used as the style argument when creating a Titanium.UI.iOS.FeedbackGenerator with the
type Titanium.UI.iOS.FEEDBACK_GENERATOR_TYPE_IMPACT.
FEEDBACK_GENERATOR_NOTIFICATION_TYPE_ERROR#
Type: Number
The error notification type used as the argument in Titanium.UI.iOS.FeedbackGenerator.notificationOccurred.
FEEDBACK_GENERATOR_NOTIFICATION_TYPE_SUCCESS#
Type: Number
The success notification type used as the argument in Titanium.UI.iOS.FeedbackGenerator.notificationOccurred.
FEEDBACK_GENERATOR_NOTIFICATION_TYPE_WARNING#
Type: Number
The warning notification type used as the argument in Titanium.UI.iOS.FeedbackGenerator.notificationOccurred.
FEEDBACK_GENERATOR_TYPE_IMPACT#
Type: Number
The feedback type to be used when specifying an impact in Titanium.UI.iOS.FeedbackGenerator.
FEEDBACK_GENERATOR_TYPE_NOTIFICATION#
Type: Number
The feedback type to be used when specifying a received notification in Titanium.UI.iOS.FeedbackGenerator.
FEEDBACK_GENERATOR_TYPE_SELECTION#
Type: Number
The feedback type to be used when specifying a selection in Titanium.UI.iOS.FeedbackGenerator.
forceTouchSupported#
Type: Boolean
Determines if the 3D-Touch capability "Force Touch" is supported (true) or not (false) by the device.
Returns true if the device supports 3D-Touch (iPhone 6S / iPhone 6S Plus and later) or false if not.
GLASS_EFFECT_STYLE_CLEAR#
Type: Number
Use with BlurView.glassEffect to specify a clear glass effect style.
Creates a glass effect with higher translucency and lighter blur intensity compared to the regular style.
This style provides a more transparent appearance while still maintaining the glass effect characteristics.
GLASS_EFFECT_STYLE_REGULAR#
Type: Number
Use with BlurView.glassEffect to specify a regular glass effect style.
Creates a standard glass effect with regular translucency and blur intensity. This is the default
style for glass effects and provides a balanced appearance suitable for most use cases.
INJECTION_TIME_DOCUMENT_END#
Type: Number
Inject the script after the document finishes loading, but before other subresources finish loading.
Used to set the injectionTime argument of Titanium.UI.WebView.addUserScript.
INJECTION_TIME_DOCUMENT_START#
Type: Number
Inject the script after the document element is created, but before any other content is loaded.
Used to set the injectionTime argument of Titanium.UI.WebView.addUserScript.
KEYBOARD_DISMISS_MODE_INTERACTIVE#
Type: Number
Use with Titanium.UI.ScrollView.keyboardDismissMode to control keyboard dismiss mode.
The keyboard follows the dragging touch offscreen, and can be pulled
upward again to cancel the dismiss.
KEYBOARD_DISMISS_MODE_NONE#
Type: Number
Use with Titanium.UI.ScrollView.keyboardDismissMode to control keyboard dismiss mode.
The keyboard does not get dismissed with a drag.
KEYBOARD_DISMISS_MODE_ON_DRAG#
Type: Number
Use with Titanium.UI.ScrollView.keyboardDismissMode to control keyboard dismiss mode.
The keyboard is dismissed when a drag begins.
LARGE_TITLE_DISPLAY_MODE_ALWAYS#
Type: Number
Always use a larger title when this item is top most.
Use with Titanium.UI.Window.largeTitleDisplayMode.
LARGE_TITLE_DISPLAY_MODE_AUTOMATIC#
Type: Number
Automatically use the large out-of-line title based on the state of the p
revious item in the navigation bar.
Use with Titanium.UI.Window.largeTitleDisplayMode. An item with this
constant will show or hide the large title based on the request of the
previous navigation item. If the first item pushed is set to Automatic,
then it will show the large title if the navigation bar has the property
Titanium.UI.Window.largeTitleEnabled set to true.
LARGE_TITLE_DISPLAY_MODE_NEVER#
Type: Number
Never use a larger title when this item is top most.
Use with Titanium.UI.Window.largeTitleDisplayMode.
lifecycleContainer#
Type: Titanium.UI.Window, Titanium.UI.TabGroup
The Window or TabGroup whose Activity lifecycle should be triggered on the proxy.
If this property is set to a Window or TabGroup, then the corresponding Activity lifecycle event callbacks
will also be called on the proxy. Proxies that require the activity lifecycle will need this property set
to the appropriate containing Window or TabGroup.
LIVEPHOTO_BADGE_OPTIONS_LIVE_OFF#
Type: Number
To indicate that the Live Photo aspect is turned off and it will
be treated as a still (e.g. for sharing).
Use with Titanium.UI.iOS.createLivePhotoBadge to specify
the badge behavior.
LIVEPHOTO_BADGE_OPTIONS_OVER_CONTENT#
Type: Number
Include treatments so this image can be shown directly over the content
of the Live Photo.
Use with Titanium.UI.iOS.createLivePhotoBadge to specify
the badge behavior.
LIVEPHOTO_PLAYBACK_STYLE_FULL#
Type: Number
Plays back the entire motion and sound content of the Live Photo, including transition
effects at the start and end.
This style matches the effect seen when pressing on a photo in the Photos app.
LIVEPHOTO_PLAYBACK_STYLE_HINT#
Type: Number
Plays back only a brief section of the motion content of the Live Photo, without sound.
This style matches the effect seen in various iOS interface elements for hinting to the user
when an asset contains Live Photo content.
MODAL_PRESENTATION_CURRENT_CONTEXT#
Type: Number
View presented with the same style as its parent window.
Used with the Titanium.UI.Window.open and Titanium.UI.Window.close methods.
One of the group of modal window presentation style constants
MODAL_PRESENTATION_OVER_CURRENT_FULL_SCREEN,
MODAL_PRESENTATION_OVER_CURRENT_CONTEXT,
MODAL_PRESENTATION_CURRENT_CONTEXT,
MODAL_PRESENTATION_FORMSHEET,
MODAL_PRESENTATION_FULLSCREEN,
and MODAL_PRESENTATION_PAGESHEET.
MODAL_PRESENTATION_FORMSHEET#
Type: Number
Window width and height are smaller than those of the screen and the view is centered on
the screen.
If the system is in a landscape orientation and the keyboard is visible, the position of the
view is adjusted upward so that the view remains visible. All uncovered areas are dimmed
and do not respond to touch to prevent the user from interacting with them.
Used with the Titanium.UI.Window.open and Titanium.UI.Window.close methods.
One of the group of modal window presentation style constants
MODAL_PRESENTATION_OVER_CURRENT_FULL_SCREEN,
MODAL_PRESENTATION_OVER_CURRENT_CONTEXT,
MODAL_PRESENTATION_CURRENT_CONTEXT,
MODAL_PRESENTATION_FORMSHEET,
MODAL_PRESENTATION_FULLSCREEN,
and MODAL_PRESENTATION_PAGESHEET.
MODAL_PRESENTATION_FULLSCREEN#
Type: Number
Window covers the screen.
Used with the Titanium.UI.Window.open and Titanium.UI.Window.close methods.
One of the group of modal window presentation style constants
MODAL_PRESENTATION_OVER_CURRENT_FULL_SCREEN,
MODAL_PRESENTATION_OVER_CURRENT_CONTEXT,
MODAL_PRESENTATION_CURRENT_CONTEXT,
MODAL_PRESENTATION_FORMSHEET,
MODAL_PRESENTATION_FULLSCREEN,
and MODAL_PRESENTATION_PAGESHEET.
MODAL_PRESENTATION_OVER_CURRENT_CONTEXT#
Type: Number
View presented over its parent window.
Used with the Titanium.UI.Window.open and Titanium.UI.Window.close methods.
One of the group of modal window presentation style constants
MODAL_PRESENTATION_OVER_CURRENT_FULL_SCREEN,
MODAL_PRESENTATION_OVER_CURRENT_CONTEXT,
MODAL_PRESENTATION_CURRENT_CONTEXT,
MODAL_PRESENTATION_FORMSHEET,
MODAL_PRESENTATION_FULLSCREEN,
and MODAL_PRESENTATION_PAGESHEET.
MODAL_PRESENTATION_OVER_CURRENT_FULL_SCREEN#
Type: Number
Presented view covers the screen.
The views beneath the presented content are not removed from the view hierarchy when the presentation finishes. So if the presented view controller does not fill the screen with opaque content, the underlying content shows through.
Used with the Titanium.UI.Window.open and Titanium.UI.Window.close methods.
One of the group of modal window presentation style constants
MODAL_PRESENTATION_OVER_CURRENT_FULL_SCREEN,
MODAL_PRESENTATION_OVER_CURRENT_CONTEXT,
MODAL_PRESENTATION_CURRENT_CONTEXT,
MODAL_PRESENTATION_FORMSHEET,
MODAL_PRESENTATION_FULLSCREEN,
and MODAL_PRESENTATION_PAGESHEET.
MODAL_PRESENTATION_PAGESHEET#
Type: Number
Window height is the height of the screen and width is equal to screen width in a portrait
orientation.
Any uncovered areas are dimmed and do not respond to touch, to prevent the user from
interacting with them. In portrait orientations, this option is essentially the same as
Titanium.UI.iOS.MODAL_PRESENTATION_FULLSCREEN.
Used with the Titanium.UI.Window.open and Titanium.UI.Window.close methods.
One of the group of modal window presentation style constants
MODAL_PRESENTATION_OVER_CURRENT_FULL_SCREEN,
MODAL_PRESENTATION_OVER_CURRENT_CONTEXT,
MODAL_PRESENTATION_CURRENT_CONTEXT,
MODAL_PRESENTATION_FORMSHEET,
MODAL_PRESENTATION_FULLSCREEN,
and MODAL_PRESENTATION_PAGESHEET.
MODAL_TRANSITION_STYLE_COVER_VERTICAL#
Type: Number
When the window is presented, its view slides up from the bottom of the screen. On dismissal,
the view slides back down (default.)
Used with the Titanium.UI.Window.open and Titanium.UI.Window.close methods.
One of the group of modal window transition style constants
MODAL_TRANSITION_STYLE_COVER_VERTICAL,
MODAL_TRANSITION_STYLE_CROSS_DISSOLVE,
MODAL_TRANSITION_STYLE_FLIP_HORIZONTAL,
and MODAL_TRANSITION_STYLE_PARTIAL_CURL.
MODAL_TRANSITION_STYLE_CROSS_DISSOLVE#
Type: Number
When the window is presented, the current view fades out while the new view fades in at the
same time. On dismissal, a similar type of cross-fade is used to return to the original view.
Used with the Titanium.UI.Window.open and Titanium.UI.Window.close methods.
One of the group of modal window transition style constants
MODAL_TRANSITION_STYLE_COVER_VERTICAL,
MODAL_TRANSITION_STYLE_CROSS_DISSOLVE,
MODAL_TRANSITION_STYLE_FLIP_HORIZONTAL,
and MODAL_TRANSITION_STYLE_PARTIAL_CURL.
MODAL_TRANSITION_STYLE_FLIP_HORIZONTAL#
Type: Number
When the window is presented, the current view initiates a horizontal 3D flip from
right-to-left, resulting in the revealing of the new view as if it were on the back of the
previous view. On dismissal, the flip occurs from left-to-right, returning to the original
view.
Used with the Titanium.UI.Window.open and Titanium.UI.Window.close methods.
One of the group of modal window transition style constants
MODAL_TRANSITION_STYLE_COVER_VERTICAL,
MODAL_TRANSITION_STYLE_CROSS_DISSOLVE,
MODAL_TRANSITION_STYLE_FLIP_HORIZONTAL,
and MODAL_TRANSITION_STYLE_PARTIAL_CURL.
MODAL_TRANSITION_STYLE_PARTIAL_CURL#
Type: Number
When the window is presented, one corner of the current view curls up to reveal the modal
view underneath. On dismissal, the curled up page unfurls itself back on top of the modal
view.
A modal view presented using this transition is itself prevented from presenting any
additional modal views. This transition style is supported only if the window is presenting
a Titanium.UI.iOS.MODAL_PRESENTATION_FULLSCREEN modal presentation style.
Used with the Titanium.UI.Window.open and Titanium.UI.Window.close methods.
One of the group of modal window transition style constants
MODAL_TRANSITION_STYLE_COVER_VERTICAL,
MODAL_TRANSITION_STYLE_CROSS_DISSOLVE,
MODAL_TRANSITION_STYLE_FLIP_HORIZONTAL,
and MODAL_TRANSITION_STYLE_PARTIAL_CURL.
PREVIEW_ACTION_STYLE_DEFAULT#
Type: Number
The normal style for preview actions.
Used in conjunction with Titanium.UI.iOS.PreviewAction.style / Titanium.UI.iOS.PreviewActionGroup.style
property.
PREVIEW_ACTION_STYLE_DESTRUCTIVE#
Type: Number
The destructive style for preview actions.
Used in conjunction with Titanium.UI.iOS.PreviewAction.style / Titanium.UI.iOS.PreviewActionGroup.style
property.
PREVIEW_ACTION_STYLE_SELECTED#
Type: Number
The selected style for preview actions.
Used in conjunction with Titanium.UI.iOS.PreviewAction.style / Titanium.UI.iOS.PreviewActionGroup.style
property.
PUSH_MODE_CONTINUOUS#
Type: Number
Use with Titanium.UI.iOS.PushBehavior.pushMode to specifiy a continuous force.
PUSH_MODE_INSTANTANEOUS#
Type: Number
Use with Titanium.UI.iOS.PushBehavior.pushMode to specifiy an instantaneous force.
ROW_ACTION_STYLE_DEFAULT#
Type: Number
The default style for <RowActionType>.
Used in conjunction with Titanium.UI.ListItem.editActions property and Titanium.UI.ListView.editaction event.
ROW_ACTION_STYLE_DESTRUCTIVE#
Type: Number
The destructive style for <RowActionType>.
Used in conjunction with Titanium.UI.ListItem.editActions property and Titanium.UI.ListView.editaction event.
ROW_ACTION_STYLE_NORMAL#
Type: Number
The normal style for <RowActionType>.
Used in conjunction with Titanium.UI.ListItem.editActions property and Titanium.UI.ListView.editaction event.
SCROLL_DECELERATION_RATE_FAST#
Type: Number
Use with Titanium.UI.ScrollView.decelerationRate to control deceleration rate.
SCROLL_DECELERATION_RATE_NORMAL#
Type: Number
Use with Titanium.UI.ScrollView.decelerationRate to control deceleration rate.
SCROLL_VIEW_EDGE_EFFECT_STYLE_AUTOMATIC#
Type: Number
Use with Titanium.UI.ScrollView.edgeEffect to apply the system default edge effect style.
SCROLL_VIEW_EDGE_EFFECT_STYLE_HARD#
Type: Number
Use with Titanium.UI.ScrollView.edgeEffect to apply a scroll edge effect with a hard cutoff and dividing line.
SCROLL_VIEW_EDGE_EFFECT_STYLE_SOFT#
Type: Number
Use with Titanium.UI.ScrollView.edgeEffect to apply a soft-edged scroll edge effect.
SEARCH_BAR_STYLE_MINIMAL#
Type: Number
Use with Titanium.UI.SearchBar.style to change the search bar style.
The search bar has no background, and the search field is translucent.
SEARCH_BAR_STYLE_PROMINENT#
Type: Number
Use with Titanium.UI.SearchBar.style to change the search bar style.
The search bar has a translucent background, and the search field is opaque.
SELECTION_GRANULARITY_CHARACTER#
Type: Number
Selection endpoints can be placed at any character boundary.
Use with Titanium.UI.WebView.selectionGranularity.
SELECTION_GRANULARITY_DYNAMIC#
Type: Number
Selection granularity varies automatically depending on the selection.
Use with Titanium.UI.WebView.selectionGranularity.
SHORTCUT_ICON_TYPE_ADD#
Type: Number
Number that represents the icon used for the application shortcut
An icon for a quick action that adds an item.
SHORTCUT_ICON_TYPE_ALARM#
Type: Number
Number that represents the icon used for the application shortcut
An icon for a quick action that offers creation of an alarm.
SHORTCUT_ICON_TYPE_AUDIO#
Type: Number
Number that represents the icon used for the application shortcut
An icon for a quick action that offers use of audio.
SHORTCUT_ICON_TYPE_BOOKMARK#
Type: Number
Number that represents the icon used for the application shortcut
An icon for a quick action that offers creation of a bookmark.
SHORTCUT_ICON_TYPE_CAPTURE_PHOTO#
Type: Number
Number that represents the icon used for the application shortcut
An icon for a quick action that offers photo capture.
SHORTCUT_ICON_TYPE_CAPTURE_VIDEO#
Type: Number
Number that represents the icon used for the application shortcut
An icon for a quick action that offers video capture.
SHORTCUT_ICON_TYPE_CLOUD#
Type: Number
Number that represents the icon used for the application shortcut
An icon for a quick action that offers cloud access.
SHORTCUT_ICON_TYPE_COMPOSE#
Type: Number
Number that represents the icon used for the application shortcut
An icon for a quick action that lets a user compose new content.
SHORTCUT_ICON_TYPE_CONFIRMATION#
Type: Number
Number that represents the icon used for the application shortcut
An icon for a quick action that indicates confirmation.
SHORTCUT_ICON_TYPE_CONTACT#
Type: Number
Number that represents the icon used for the application shortcut
An icon for a quick action that chooses a generic contact.
SHORTCUT_ICON_TYPE_DATE#
Type: Number
Number that represents the icon used for the application shortcut
An icon for a quick action that offers use of a calendar.
SHORTCUT_ICON_TYPE_FAVORITE#
Type: Number
Number that represents the icon used for the application shortcut
An icon for a quick action that lets a user designate a favorite item.
SHORTCUT_ICON_TYPE_HOME#
Type: Number
Number that represents the icon used for the application shortcut
An icon for a quick action that indicates home.
SHORTCUT_ICON_TYPE_INVITATION#
Type: Number
Number that represents the icon used for the application shortcut
An icon for a quick action that indicates an invitation.
SHORTCUT_ICON_TYPE_LOCATION#
Type: Number
Number that represents the icon used for the application shortcut
Will cause a magnifying glass icon to be displayed at that location in the index.
This should generally only be used as the first title in the index.
SHORTCUT_ICON_TYPE_LOVE#
Type: Number
Number that represents the icon used for the application shortcut
An icon for a quick action that lets a user designate a loved item.
SHORTCUT_ICON_TYPE_MAIL#
Type: Number
Number that represents the icon used for the application shortcut
An icon for a quick action that offers use of mail.
SHORTCUT_ICON_TYPE_MARK_LOCATION#
Type: Number
Number that represents the icon used for the application shortcut
An icon for a quick action that lets a user mark a location.
SHORTCUT_ICON_TYPE_MESSAGE#
Type: Number
Number that represents the icon used for the application shortcut
An icon for a quick action that offers use of messaging.
SHORTCUT_ICON_TYPE_PAUSE#
Type: Number
Number that represents the icon used for the application shortcut
An icon for a quick action that pauses media playback.
SHORTCUT_ICON_TYPE_PLAY#
Type: Number
Number that represents the icon used for the application shortcut
An icon for a quick action that plays media.
SHORTCUT_ICON_TYPE_PROHIBIT#
Type: Number
Number that represents the icon used for the application shortcut
An icon for a quick action that disallows something.
SHORTCUT_ICON_TYPE_SEARCH#
Type: Number
Number that represents the icon used for the application shortcut
An icon for a quick action that accesses the user's current location.
SHORTCUT_ICON_TYPE_SHARE#
Type: Number
Number that represents the icon used for the application shortcut
An icon for a quick action that offers content sharing.
SHORTCUT_ICON_TYPE_SHUFFLE#
Type: Number
Number that represents the icon used for the application shortcut
An icon for a quick action that offers shuffle mode.
SHORTCUT_ICON_TYPE_TASK#
Type: Number
Number that represents the icon used for the application shortcut
An icon for a quick action that offers task creation.
SHORTCUT_ICON_TYPE_TASK_COMPLETED#
Type: Number
Number that represents the icon used for the application shortcut
An icon for a quick action that offers task completion.
SHORTCUT_ICON_TYPE_TIME#
Type: Number
Number that represents the icon used for the application shortcut
An icon for a quick action that offers use of a clock or timer.
SHORTCUT_ICON_TYPE_UPDATE#
Type: Number
Number that represents the icon used for the application shortcut
An icon for a quick action that offers updating.
statusBarBackgroundColor#
Type: String, Titanium.UI.Color
Sets the global status bar background color for the application. Android does not support setting instances of Titanium.UI.Color
TAB_GROUP_MINIMIZE_BEHAVIOR_AUTOMATIC#
Type: Number
Automatically determine when the tab group minimizes.
Use with Titanium.UI.TabGroup.minimizeBehavior to let the system choose the appropriate
minimize behavior based on context and platform conventions.
TAB_GROUP_MINIMIZE_BEHAVIOR_NEVER#
Type: Number
Do not minimize the tab group.
Use with Titanium.UI.TabGroup.minimizeBehavior to keep the tab group visible and prevent
it from minimizing in response to scrolling.
TAB_GROUP_MINIMIZE_BEHAVIOR_ON_SCROLL_DOWN#
Type: Number
Minimize the tab group when scrolling down.
Use with Titanium.UI.TabGroup.minimizeBehavior to minimize the tab group as the user scrolls
downward.
TAB_GROUP_MINIMIZE_BEHAVIOR_ON_SCROLL_UP#
Type: Number
Minimize the tab group when scrolling up.
Use with Titanium.UI.TabGroup.minimizeBehavior to minimize the tab group as the user scrolls
upward.
TABLEVIEW_INDEX_SEARCH#
Type: String
String that represents the magnifying glass on the table view index bar
Will cause a magnifying glass icon to be displayed at that location in the index.
This should generally only be used as the first title in the index.
Methods #
addEventListener #
Adds the specified callback as an event listener for the named event.
| Name | Type | Summary | Optional |
|---|---|---|---|
name | String | Name of the event. | No |
callback | Callback<Titanium.Event> | Callback function to invoke when the event is fired. | No |
applyProperties #
Applies the properties to the proxy.
Properties are supplied as a dictionary. Each key-value pair in the object is applied to the proxy such that
myproxy[key] = value.
| Name | Type | Summary | Optional |
|---|---|---|---|
props | Dictionary | A dictionary of properties to apply. | No |
createButtonConfiguration #
Creates a button configuration object for customizing button appearance.
Creates a Titanium.UI.iOS.ButtonConfiguration object that can be used to configure
the appearance and behavior of buttons with modern styling options.
| Name | Type | Summary | Optional |
|---|---|---|---|
parameters | Dictionary<Titanium.UI.iOS.ButtonConfiguration> | Properties to set on the button configuration. | No |
Returns: Titanium.UI.iOS.ButtonConfiguration
createLivePhotoBadge #
Creates a live photo badge to be used together with the
Titanium.UI.iOS.LivePhotoView API.
Supported on iOS 9.1 and later.
| Name | Type | Summary | Optional |
|---|---|---|---|
type | Number | Constant defining the live photo badge behavior. | No |
Returns: Titanium.Blob
fireEvent #
Fires a synthesized event to any registered listeners.
| Name | Type | Summary | Optional |
|---|---|---|---|
name | String | Name of the event. | No |
event | Dictionary | A dictionary of keys and values to add to the Titanium.Event object sent to the listeners. | Yes |
removeEventListener #
Removes the specified callback as an event listener for the named event.
Multiple listeners can be registered for the same event, so the
callback parameter is used to determine which listener to remove.
When adding a listener, you must save a reference to the callback function
in order to remove the listener later:
var listener = function() { Ti.API.info("Event listener called."); }
window.addEventListener('click', listener);
To remove the listener, pass in a reference to the callback function:
window.removeEventListener('click', listener);
| Name | Type | Summary | Optional |
|---|---|---|---|
name | String | Name of the event. | No |
callback | Callback<Titanium.Event> | Callback function to remove. Must be the same function passed to addEventListener. | No |
systemImage #
Get image from SF Symbols provided by Apple.
More details on SF Symbols can be found here.
One can download SF Symbols app from here and
use it to lookup the built-in SF Symbol name. Example:
const win = Ti.UI.createWindow({ backgroundColor: '#fff' });
const imageView = Ti.UI.createImageView({
image: Ti.UI.iOS.systemImage('folder'), // folder icon
height: Ti.UI.FILL
});
// iOS 17+ symbol effect
imageView.addSymbolEffect({
symbolEffect: 'bounce',
animated: true,
options: { repeatCount: 4 }
});
win.add(imageView);
win.open();
| Name | Type | Summary | Optional |
|---|---|---|---|
name | String | Name of SF Symbol. | No |
parameters | SystemImageParameters | Additional parameters to pass to the SF Symbol. Available in Titanium SDK 10.1.0 and later | Yes |
Returns: Titanium.Blob