The Android-specific UI capabilities. All properties, methods and events in this namespace will only work on Android systems.
Create preferences interface for the application.
app.jsvar button = Ti.UI.createButton({
title: 'Click to Open Preferences'
});
button.addEventListener('click', function() {
Ti.API.info('Current value for editText: ' + Ti.App.Properties.getString('editText'));
Ti.UI.Android.openPreferences();
});
Ti.UI.currentWindow.add(button);
platform/android/res/xml/preferences.xml<?xml version="1.0" encoding="utf-8"?>
<PreferenceScreen xmlns:android="http://schemas.android.com/apk/res/android"
android:title="Preferences">
<PreferenceScreen
android:title="Misc. Preferences"
android:summary="Click to see more options">
<EditTextPreference
android:title="Edit Text Preference"
android:summary="You may enter a string"
android:defaultValue=""
android:key="editText" />
</PreferenceScreen>
<PreferenceCategory android:title="Category One">
<CheckBoxPreference
android:title="CheckBox Preference"
android:defaultValue="false"
android:summary="You may enter a boolean"
android:key="checkbox" />
<RingtonePreference
android:title="Ringtone Preference"
android:summary="You may pick a ringtone"
android:defaultValue=""
android:key="ringtone" />
</PreferenceCategory>
<PreferenceCategory android:title="Category Two">
<ListPreference
android:title="List Preference"
android:summary="You may chose from multiple choices"
android:key="list"
android:entries="@array/listNames"
android:entryValues="@array/listValues"
/>
</PreferenceCategory>
</PreferenceScreen>
platform/android/res/values/array/array.xml<?xml version="1.0" encoding="utf-8"?>
<resources>
<string-array name="listNames">
<item>5 Minutes</item>
<item>10 Minutes</item>
<item>15 Minutes</item>
<item>30 Minutes</item>
<item>60 Minutes</item>
</string-array>
<string-array name="listValues">
<item>5</item>
<item>10</item>
<item>15</item>
<item>30</item>
<item>60</item>
</string-array>
</resources>
Raw bit controlling whether the right/bottom edge is clipped to its container, based on the gravity direction being applied.
Raw bit controlling how the right/bottom edge is placed.
Raw bit controlling how the right/bottom edge is placed.
Raw bit controlling how the left/top edge is placed.
Raw bit controlling how the left/top edge is placed.
Raw bit indicating the gravity for an axis has been specified.
Raw bit indicating the gravity for an axis has been specified.
Bits defining the horizontal axis.
Bits defining the horizontal axis.
Bits defining the vertical axis.
Bits defining the vertical axis.
Push object to the bottom of its container, not changing its size.
Push object to the bottom of its container, not changing its size.
Place the object in the center of its container in both the vertical and horizontal axis, not changing its size.
Place the object in the center of its container in both the vertical and horizontal axis, not changing its size.
Place object in the horizontal center of its container, not changing its size.
Place object in the horizontal center of its container, not changing its size.
Place object in the vertical center of its container, not changing its size.
Place object in the vertical center of its container, not changing its size.
Flag to clip the edges of the object to its container along the horizontal axis.
Flag to clip the edges of the object to its container along the horizontal axis.
Flag to clip the edges of the object to its container along the vertical axis.
Flag to clip the edges of the object to its container along the vertical axis.
Special constant to enable clipping to an overall display along the horizontal dimension.
Special constant to enable clipping to an overall display along the horizontal dimension.
Special constant to enable clipping to an overall display along the vertical dimension.
Special constant to enable clipping to an overall display along the vertical dimension.
Push object to x-axis position at the end of its container, not changing its size.
Push object to x-axis position at the end of its container, not changing its size.
Grow the horizontal and vertical size of the object if needed so it completely fills its container.
Grow the horizontal and vertical size of the object if needed so it completely fills its container.
Grow the horizontal size of the object if needed so it completely fills its container.
Grow the horizontal size of the object if needed so it completely fills its container.
Grow the vertical size of the object if needed so it completely fills its container.
Grow the vertical size of the object if needed so it completely fills its container.
Binary mask to get the absolute horizontal gravity of a gravity.
Binary mask to get the absolute horizontal gravity of a gravity.
Push object to the left of its container, not changing its size.
Push object to the left of its container, not changing its size.
Constant indicating that no gravity has been set
Constant indicating that no gravity has been set
Binary mask for the horizontal gravity and script specific direction bit.
Binary mask for the horizontal gravity and script specific direction bit.
Raw bit controlling whether the layout direction is relative or not (GRAVITY_START/GRAVITY_END instead of absolute GRAVITY_LEFT/GRAVITY_RIGHT).
Push object to the right of its container, not changing its size.
Push object to the right of its container, not changing its size.
Push object to x-axis position at the start of its container, not changing its size.
Push object to x-axis position at the start of its container, not changing its size.
Push object to the top of its container, not changing its size.
Push object to the top of its container, not changing its size.
Binary mask to get the vertical gravity of a gravity.
Binary mask to get the vertical gravity of a gravity.
Converts all detectable types of data into clickable links.
deprecated since 3.0.0
Use <Titanium.UI.AUTOLINK_ALL> instead.
Converts strings formatted as email addresses into clickable links.
deprecated since 3.0.0
Use <Titanium.UI.AUTOLINK_EMAIL_ADDRESSES> instead.
Converts strings formatted as addresses into clickable links.
deprecated since 3.0.0
Use <Titanium.UI.AUTOLINK_MAP_ADDRESSES> instead.
Converts strings formatted as phone numbers into clickable links.
deprecated since 3.0.0
Use <Titanium.UI.AUTOLINK_PHONE_NUMBERS> instead.
Converts strings formatted as URLs into clickable links.
deprecated since 3.0.0
Use <Titanium.UI.AUTOLINK_URLS> instead.
Always allow a user to over-scroll this view, provided it is a view that can scroll.
Always allow a user to over-scroll this view, provided it is a view that can scroll.
Use this with the following properties - Titanium.UI.ScrollableView.overScrollMode, Titanium.UI.ScrollView.overScrollMode, Titanium.UI.TableView.overScrollMode and Titanium.UI.WebView.overScrollMode.
Only applicable when Titanium.Platform.Android.API_LEVEL is 9 or above.
Allow a user to over-scroll this view only if the content is large enough to meaningfully scroll, provided it is a view that can scroll.
Use this with the following properties - Titanium.UI.ScrollableView.overScrollMode, Titanium.UI.ScrollView.overScrollMode, Titanium.UI.TableView.overScrollMode and Titanium.UI.WebView.overScrollMode.
Only applicable when Titanium.Platform.Android.API_LEVEL is 9 or above.
Never allow a user to over-scroll this view.
Never allow a user to over-scroll this view.
Use this with the following properties - Titanium.UI.ScrollableView.overScrollMode, Titanium.UI.ScrollView.overScrollMode, Titanium.UI.TableView.overScrollMode and Titanium.UI.WebView.overScrollMode.
Only applicable when Titanium.Platform.Android.API_LEVEL is 9 or above.
Android A_8 pixel format for Titanium.UI.Window. Selecting the correct pixel format can improve image clarity and performance.
See the Android Developer website for official documentation about the PixelFormat constants.
Android LA_88 pixel format for Titanium.UI.Window. Selecting the correct pixel format can improve image clarity and performance.
See the Android Developer website for official documentation about the PixelFormat constants.
Android L_8 pixel format for Titanium.UI.Window. Selecting the correct pixel format can improve image clarity and performance.
See the Android Developer website for official documentation about the PixelFormat constants.
Android OPAQUE pixel format for Titanium.UI.Window. Selecting the correct pixel format can improve image clarity and performance.
See the Android Developer website for official documentation about the PixelFormat constants.
Android RGBA_4444 pixel format for Titanium.UI.Window. Selecting the correct pixel format can improve image clarity and performance.
See the Android Developer website for official documentation about the PixelFormat constants.
Android RGBA_5551 pixel format for Titanium.UI.Window. Selecting the correct pixel format can improve image clarity and performance.
See the Android Developer website for official documentation about the PixelFormat constants.
Android RGBA_8888 pixel format for Titanium.UI.Window. Selecting the correct pixel format can improve image clarity and performance.
See the Android Developer website for official documentation about the PixelFormat constants.
Android RGBX_8888 pixel format for Titanium.UI.Window. Selecting the correct pixel format can improve image clarity and performance.
See the Android Developer website for official documentation about the PixelFormat constants.
Android RGB_332 pixel format for Titanium.UI.Window. Selecting the correct pixel format can improve image clarity and performance.
See the Android Developer website for official documentation about the PixelFormat constants.
Android RGB_565 pixel format for Titanium.UI.Window. Selecting the correct pixel format can improve image clarity and performance.
See the Android Developer website for official documentation about the PixelFormat constants.
Android RGB_888 pixel format for Titanium.UI.Window. Selecting the correct pixel format can improve image clarity and performance.
See the Android Developer website for official documentation about the PixelFormat constants.
Android TRANSLUCENT pixel format for Titanium.UI.Window. Selecting the correct pixel format can improve image clarity and performance.
See the Android Developer website for official documentation about the PixelFormat constants.
Android A_8 pixel format for Titanium.UI.Window. Selecting the correct pixel format can improve image clarity and performance.
See the Android Developer website for official documentation about the PixelFormat constants.
Android UNKNOWN pixel format for Titanium.UI.Window. Selecting the correct pixel format can improve image clarity and performance.
See the Android Developer website for official documentation about the PixelFormat constants.
Used with the Titanium.UI.Android.ProgressIndicator.type property to indicate an ongoing activity of determinate length.
Display Titanium.UI.Android.ProgressIndicator as a modal dialog. (default)
Used with the Titanium.UI.Android.ProgressIndicator.location property.
Used with the Titanium.UI.Android.ProgressIndicator.type property to indicate an ongoing activity of indeterminate length. (default)
Display Titanium.UI.Android.ProgressIndicator as a horizontal progress bar in the title of the window.
Display Titanium.UI.Android.ProgressIndicator as a horizontal progress bar in the title of the window.
Used with the Titanium.UI.Android.ProgressIndicator.location property.
Pan the current heavyweight window when the input method (ie software keyboard) is shown, to ensure that its contents are not obscured.
Used with the Titanium.UI.Window.windowSoftInputMode property.
One of the group of soft input adjustment constants, SOFT_INPUT_ADJUST_UNSPECIFIED, SOFT_INPUT_ADJUST_RESIZE, and SOFT_INPUT_ADJUST_PAN.
Resize the current heavyweight window when the input method (ie software keyboard) is shown, to ensure that its contents are not obscured.
Used with the Titanium.UI.Window.windowSoftInputMode property.
One of the group of soft input adjustment constants, SOFT_INPUT_ADJUST_UNSPECIFIED, SOFT_INPUT_ADJUST_RESIZE, and SOFT_INPUT_ADJUST_PAN.
Use the system-default behavior to determine how the soft input area (ie software keyboard) is accomodated by the current heavyweight window when it receives focus (default.)
Depends on the AndroidManifest.xml setting if defined or system-default otherwise to
determine how to accomodate the soft keyboard when visible.
Used with the Titanium.UI.Window.windowSoftInputMode property.
One of the group of soft input adjustment constants, SOFT_INPUT_ADJUST_UNSPECIFIED, SOFT_INPUT_ADJUST_RESIZE, and SOFT_INPUT_ADJUST_PAN.
Always hide the soft input area (ie software keyboard) when the current heavyweight window receives focus.
Always hide the soft input area (ie software keyboard) when the current heavyweight window receives focus.
Note that the unresolved bug #7115 on the Official Android Project website affects this functionality.
Used with the Titanium.UI.Window.windowSoftInputMode property.
One of the group of soft input visibility constants, SOFT_INPUT_STATE_ALWAYS_HIDDEN, SOFT_INPUT_STATE_ALWAYS_VISIBLE, SOFT_INPUT_STATE_HIDDEN, SOFT_INPUT_STATE_UNSPECIFIED, and SOFT_INPUT_STATE_VISIBLE.
Always show the soft input area (ie software keyboard) when the current heavyweight window receives focus.
Always show the soft input area (ie software keyboard) when the current heavyweight window receives focus.
Used with the Titanium.UI.Window.windowSoftInputMode property.
This constant is one of the group of soft input visibility constants, SOFT_INPUT_STATE_ALWAYS_HIDDEN, SOFT_INPUT_STATE_ALWAYS_VISIBLE, SOFT_INPUT_STATE_HIDDEN, SOFT_INPUT_STATE_UNSPECIFIED, and SOFT_INPUT_STATE_VISIBLE.
Attempt to hide the soft input area (ie software keyboard) when the current heavyweight window receives focus.
Attempt to hide the soft input area (ie software keyboard) when the current heavyweight window receives focus.
Used with the Titanium.UI.Window.windowSoftInputMode property.
This constant is one of the group of soft input visibility constants, SOFT_INPUT_STATE_ALWAYS_HIDDEN, SOFT_INPUT_STATE_ALWAYS_VISIBLE, SOFT_INPUT_STATE_HIDDEN, SOFT_INPUT_STATE_UNSPECIFIED, and SOFT_INPUT_STATE_VISIBLE.
Use the system-default behavior to determine whether to show the soft input area (ie software keyboard) when the current heavyweight window receives focus.
Used with the Titanium.UI.Window.windowSoftInputMode property.
This constant is one of the group of soft input visibility constants, SOFT_INPUT_STATE_ALWAYS_HIDDEN, SOFT_INPUT_STATE_ALWAYS_VISIBLE, SOFT_INPUT_STATE_HIDDEN, SOFT_INPUT_STATE_UNSPECIFIED, and SOFT_INPUT_STATE_VISIBLE.
Attempt to show the soft input area (ie software keyboard) when the current heavyweight window receives focus.
Attempt to show the soft input area (ie software keyboard) when the current heavyweight window receives focus.
Used with the Titanium.UI.Window.windowSoftInputMode property.
This constant is one of the group of soft input visibility constants, SOFT_INPUT_STATE_ALWAYS_HIDDEN, SOFT_INPUT_STATE_ALWAYS_VISIBLE, SOFT_INPUT_STATE_HIDDEN, SOFT_INPUT_STATE_UNSPECIFIED, and SOFT_INPUT_STATE_VISIBLE.
Use Android default behavior to handle keyboard visibility when a view receives focus. (default)
Attempt to hide the soft keyboard when a view receives focus. Note: system can override request.
Attempt to show the soft keyboard when a view receives focus. Note: system can override request.
Display a checkbox.
Display a checkbox.
Use with the Titanium.UI.Switch.style property.
Display a switch.
Display a switch.
Use with the Titanium.UI.Switch.style property.
Due to Android issue #78262, the thumb (circle icon) may not appear on the switch.
Display a toggle button.
Display a toggle button.
Use with the Titanium.UI.Switch.style property.
Captures layout bounds of target views before and after the scene change and animates those changes during the transition.
Use this only for shared element transition. Refers to ChangeBounds transition.
Captures the clip bounds before and after the scene change and animates those changes during the transition.
Captures the clip bounds before and after the scene change and animates those changes during the transition.
Use this only for shared element transition. Refers to ChangeClipBounds transition.
Captures an ImageView's matrix before and after the scene change and animates it during the transition.
Captures an ImageView's matrix before and after the scene change and animates it during the transition.
Use this only for shared element transition. Refers to ChangeImageTransform transition.
Captures scale and rotation for Views before and after the scene change and animates those changes during the transition.
Use this only for shared element transition. Refers to ChangeTransform transition.
Moves views in or out from the edges of the scene.
Moves views in or out from the edges of the scene.
Use this only for activity transition. Refers to Explode transition.
Resets transition to platform default.
Resets transition to platform default.
Can be used with activity and shared element transtion.
Use with WebView.cacheMode to override how the cache is used in a web view.
Use with WebView.cacheMode to override how the cache is used in a web view.
Use cached resources when they're available, even when they're expired. Otherwise load resources via network.
Use with WebView.cacheMode to override how the cache is used in a web view.
Use with WebView.cacheMode to override how the cache is used in a web view.
Don't use network, load from the cache only.
Use with WebView.cacheMode to override how the cache is used in a web view.
Use with WebView.cacheMode to override how the cache is used in a web view.
This is the default cache usage mode.
Use with WebView.cacheMode to override how the cache is used in a web view.
Use with WebView.cacheMode to override how the cache is used in a web view.
Don't use cache, load from the network.
Use with WebView.pluginState to disable plugins in a web view.
Use with WebView.pluginState to disable plugins in a web view.
Content that requires a plugin, such as Flash Player, is not loaded, and any alternative content is displayed instead.
Use with WebView.pluginState to enable plugins in a web view.
Use with WebView.pluginState to enable plugins in a web view.
Content that requires a plugin, such as Flash Player, is always loaded, whether or not a plugin is available for the content.
Display a placeholder and only load plugins when user selects it.
Display a placeholder and only load plugins when user selects it.
Content that requires a plugin, such as Flash Player, is replaced by a placeholder. When the user clicks on the placeholder, the plugin is loaded and the content is displayed.
Use with WebView.pluginState to load plugins on demand.
The name of the API that this proxy corresponds to.
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.
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.
Default: true
The Window or TabGroup whose Activity lifecycle should be triggered on the proxy.
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.
Adds the specified callback as an event listener for the named event.
Name of the event.
Callback function to invoke when the event is fired.
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.
A dictionary of properties to apply.
Creates and returns an instance of Titanium.UI.Android.CardView.
Properties to set on a new object, including any defined by Titanium.UI.Android.CardView except those marked not-creation or read-only.
Creates and returns an instance of Titanium.UI.Android.DrawerLayout.
Properties to set on a new object, including any defined by Titanium.UI.Android.DrawerLayout except those marked not-creation or read-only.
Creates and returns an instance of Titanium.UI.Android.ProgressIndicator.
Properties to set on a new object, including any defined by Titanium.UI.Android.ProgressIndicator except those marked not-creation or read-only.
Creates and returns an instance of Titanium.UI.Android.SearchView.
Properties to set on a new object, including any defined by Titanium.UI.Android.SearchView except those marked not-creation or read-only.
Fires a synthesized event to any registered listeners.
Name of the event.
A dictionary of keys and values to add to the Titanium.Event object sent to the listeners.
Hides the soft keyboard.
Be aware that it is not currently possible in the native Android API to detect that the keyboard is already visible or to globally show the keyboard.
Opens an application preferences dialog, using the native Android system settings interface,
defined by the platform-specific preferences.xml and array.xml files.
The preferences configuration files must be created in the project folders,
platform/android/res/xml/preferences.xml and platform/android/res/values/array/array.xml.
The preferences values can be accessed via Titanium.App.Properties.
See the example for a demonstration, and the official Android Developer documentation for the preferences.xml format.
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 of the event.
Callback function to remove. Must be the same function passed to addEventListener.
Sets the value of the bubbleParent property.
New value for the property.
Sets the value of the lifecycleContainer property.
New value for the property.