# Titanium.UI.Android

The Android-specific UI capabilities. All properties, methods and events in this namespace will only work on Android systems.

# Drawer Layout

The drawer-layout components acts as a top-level container for window content that allows for interactive "drawer" views to be pulled out from one or both vertical edges of the window. It is represented by a centerView and optional leftView and rightView components that can be swiped in and out with additional configuration and transitions. Learn more about drawer-layouts in it's dedicated Titanium.UI.Android.DrawerLayout docs.

Availability

1.0

Extends

Titanium.Module

# Examples

# Android Preferences Example

Create preferences interface for the application.

# `app.js`

var 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();
});
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>

# Methods

# createCardView

Availability

5.1.0

createCardView([parameters]) → Titanium.UI.Android.CardView

Creates and returns an instance of Titanium.UI.Android.CardView.

Parameters

Name	Type	Description
`parameters`	Dictionary<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.

Returns

Type: Titanium.UI.Android.CardView

# createDrawerLayout

Availability

6.2.0

createDrawerLayout([parameters]) → Titanium.UI.Android.DrawerLayout

Creates and returns an instance of Titanium.UI.Android.DrawerLayout.

Parameters

Name	Type	Description
`parameters`	Dictionary<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.

Returns

Type: Titanium.UI.Android.DrawerLayout

# createProgressIndicator

Availability

3.0.0

createProgressIndicator([parameters]) → Titanium.UI.Android.ProgressIndicator

Creates and returns an instance of Titanium.UI.Android.ProgressIndicator.

Parameters

Name	Type	Description
`parameters`	Dictionary<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.

Returns

Type: Titanium.UI.Android.ProgressIndicator

# createSearchView

Availability

3.0.2

createSearchView([parameters]) → Titanium.UI.Android.SearchView

Creates and returns an instance of Titanium.UI.Android.SearchView.

Parameters

Name	Type	Description
`parameters`	Dictionary<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.

Returns

Type: Titanium.UI.Android.SearchView

# getColorResource

Availability

9.1.0

getColorResource(resourceIdOrColorName) → Titanium.UI.Color

Returns a <Ti.Color> instance for a color defined by the system or user resources (colors.xml)

This method allows converting a known color resource id or short name to an actual color instance.

The resource id values can be accessed via color and <Titanium.App.Android.R.color> properties.

See the official Android Developer documentation for the R.color constants.

Parameters

Name	Type	Description
`resourceIdOrColorName`	Number \| String	integer resource id for a color, or the name of the color defined in the application resources (colors.xml).

Returns

Type: Titanium.UI.Color

# hideSoftKeyboard

Availability

1.0

hideSoftKeyboard() → void

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.

Returns

Type: void

# openPreferences

Availability

1.0

openPreferences() → void

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.

Returns

Type: void

# Constants

# FLAG_LAYOUT_NO_LIMITS

Availability

10.1.0

FLAG_LAYOUT_NO_LIMITS :Number

Flag allowing window to extend into the status bar and navigation bar.

When assigned to windowFlags, this flag will make the window ignore the system's insets such as the top status bar and bottom navigation bar so that they overlap the window. The system may make the status bar and navigation bar completely transparent, but this behavior is not guaranteed to happen.

When using this flag, it's also recommended to set the extendSafeArea property to true.

Warning: Using this flag causes safeAreaPadding to return all zeros. This flag also breaks keyboard adjustPan support.

# FLAG_TRANSLUCENT_NAVIGATION

Availability

7.5.0

FLAG_TRANSLUCENT_NAVIGATION :Number

Window flag which makes the Android system's navigation bar semi-transparent.

When assigned to windowFlags, this flag will make the Android system's bottom navigation bar semi-transparent. This flag will only work if you also set the extendSafeArea property to true.

This flag is only supported by Android 4.4 and newer OS versions. This flag is ignored on older versions. On Android 4.4, navigation bar can only be translucent in portrait mode while newer OS versions support this flag for all orientations.

# FLAG_TRANSLUCENT_STATUS

Availability

7.5.0

FLAG_TRANSLUCENT_STATUS :Number

Window flag which makes the Android system's top status bar semi-transparent.

When assigned to windowFlags, this flag will make the Android system's top status bar semi-transparent. This flag will only work if you also set the extendSafeArea property to true.

This flag is only supported by Android 4.4 and newer OS versions. This flag is ignored on older versions.

# GRAVITY_AXIS_CLIP

Availability

5.4.0

GRAVITY_AXIS_CLIP :Number

Raw bit controlling whether the right/bottom edge is clipped to its container, based on the gravity direction being applied.

# GRAVITY_AXIS_PULL_AFTER

Availability

5.4.0

GRAVITY_AXIS_PULL_AFTER :Number

Raw bit controlling how the right/bottom edge is placed.

# GRAVITY_AXIS_PULL_BEFORE

Availability

5.4.0

GRAVITY_AXIS_PULL_BEFORE :Number

Raw bit controlling how the left/top edge is placed.

# GRAVITY_AXIS_SPECIFIED

Availability

5.4.0

GRAVITY_AXIS_SPECIFIED :Number

Raw bit indicating the gravity for an axis has been specified.

# GRAVITY_AXIS_X_SHIFT

Availability

5.4.0

GRAVITY_AXIS_X_SHIFT :Number

Bits defining the horizontal axis.

# GRAVITY_AXIS_Y_SHIFT

Availability

5.4.0

GRAVITY_AXIS_Y_SHIFT :Number

Bits defining the vertical axis.

# GRAVITY_BOTTOM

Availability

5.4.0

GRAVITY_BOTTOM :Number

Push object to the bottom of its container, not changing its size.

# GRAVITY_CENTER

Availability

5.4.0

GRAVITY_CENTER :Number

Place the object in the center of its container in both the vertical and horizontal axis, not changing its size.

# GRAVITY_CENTER_HORIZONTAL

Availability

5.4.0

GRAVITY_CENTER_HORIZONTAL :Number

Place object in the horizontal center of its container, not changing its size.

# GRAVITY_CENTER_VERTICAL

Availability

5.4.0

GRAVITY_CENTER_VERTICAL :Number

Place object in the vertical center of its container, not changing its size.

# GRAVITY_CLIP_HORIZONTAL

Availability

5.4.0

GRAVITY_CLIP_HORIZONTAL :Number

Flag to clip the edges of the object to its container along the horizontal axis.

# GRAVITY_CLIP_VERTICAL

Availability

5.4.0

GRAVITY_CLIP_VERTICAL :Number

Flag to clip the edges of the object to its container along the vertical axis.

# GRAVITY_DISPLAY_CLIP_HORIZONTAL

Availability

5.4.0

GRAVITY_DISPLAY_CLIP_HORIZONTAL :Number

Special constant to enable clipping to an overall display along the horizontal dimension.

# GRAVITY_DISPLAY_CLIP_VERTICAL

Availability

5.4.0

GRAVITY_DISPLAY_CLIP_VERTICAL :Number

Special constant to enable clipping to an overall display along the vertical dimension.

# GRAVITY_END

Availability

5.4.0

GRAVITY_END :Number

Push object to x-axis position at the end of its container, not changing its size.

# GRAVITY_FILL

Availability

5.4.0

GRAVITY_FILL :Number

Grow the horizontal and vertical size of the object if needed so it completely fills its container.

# GRAVITY_FILL_HORIZONTAL

Availability

5.4.0

GRAVITY_FILL_HORIZONTAL :Number

Grow the horizontal size of the object if needed so it completely fills its container.

# GRAVITY_FILL_VERTICAL

Availability

5.4.0

GRAVITY_FILL_VERTICAL :Number

Grow the vertical size of the object if needed so it completely fills its container.

# GRAVITY_HORIZONTAL_GRAVITY_MASK

Availability

5.4.0

GRAVITY_HORIZONTAL_GRAVITY_MASK :Number

Binary mask to get the absolute horizontal gravity of a gravity.

# GRAVITY_LEFT

Availability

5.4.0

GRAVITY_LEFT :Number

Push object to the left of its container, not changing its size.

# GRAVITY_NO_GRAVITY

Availability

5.4.0

GRAVITY_NO_GRAVITY :Number

Constant indicating that no gravity has been set

# GRAVITY_RELATIVE_HORIZONTAL_GRAVITY_MASK

Availability

5.4.0

GRAVITY_RELATIVE_HORIZONTAL_GRAVITY_MASK :Number

Binary mask for the horizontal gravity and script specific direction bit.

# GRAVITY_RELATIVE_LAYOUT_DIRECTION

Availability

5.4.0

GRAVITY_RELATIVE_LAYOUT_DIRECTION :Number

Raw bit controlling whether the layout direction is relative or not (GRAVITY_START/GRAVITY_END instead of absolute GRAVITY_LEFT/GRAVITY_RIGHT).

# GRAVITY_RIGHT

Availability

5.4.0

GRAVITY_RIGHT :Number

Push object to the right of its container, not changing its size.

# GRAVITY_START

Availability

5.4.0

GRAVITY_START :Number

Push object to x-axis position at the start of its container, not changing its size.

# GRAVITY_TOP

Availability

5.4.0

GRAVITY_TOP :Number

Push object to the top of its container, not changing its size.

# GRAVITY_VERTICAL_GRAVITY_MASK

Availability

5.4.0

GRAVITY_VERTICAL_GRAVITY_MASK :Number

Binary mask to get the vertical gravity of a gravity.

# LINKIFY_ALL DEPRECATED

Availability

1.0

LINKIFY_ALL :Number

DEPRECATED SINCE 3.0.0

Use AUTOLINK_ALL instead.

Converts all detectable types of data into clickable links.

# LINKIFY_EMAIL_ADDRESSES DEPRECATED

Availability

1.0

LINKIFY_EMAIL_ADDRESSES :Number

DEPRECATED SINCE 3.0.0

Use AUTOLINK_EMAIL_ADDRESSES instead.

Converts strings formatted as email addresses into clickable links.

# LINKIFY_MAP_ADDRESSES DEPRECATED

Availability

1.0

LINKIFY_MAP_ADDRESSES :Number

DEPRECATED SINCE 3.0.0

Use AUTOLINK_MAP_ADDRESSES instead.

Converts strings formatted as addresses into clickable links.

# LINKIFY_PHONE_NUMBERS DEPRECATED

Availability

1.0

LINKIFY_PHONE_NUMBERS :Number

DEPRECATED SINCE 3.0.0

Use AUTOLINK_PHONE_NUMBERS instead.

Converts strings formatted as phone numbers into clickable links.

# LINKIFY_WEB_URLS DEPRECATED

Availability

1.0

LINKIFY_WEB_URLS :Number

DEPRECATED SINCE 3.0.0

Use AUTOLINK_URLS instead.

Converts strings formatted as URLs into clickable links.

# OVER_SCROLL_ALWAYS

Availability

3.1.0

OVER_SCROLL_ALWAYS :Number

Always allow a user to over-scroll this view, provided it is a view that can scroll.

Use this with the following properties - overScrollMode, overScrollMode, overScrollMode and overScrollMode.

Only applicable when API_LEVEL is 9 or above.

# OVER_SCROLL_IF_CONTENT_SCROLLS

Availability

3.1.0

OVER_SCROLL_IF_CONTENT_SCROLLS :Number

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 - overScrollMode, overScrollMode, overScrollMode and overScrollMode.

Only applicable when API_LEVEL is 9 or above.

# OVER_SCROLL_NEVER

Availability

3.1.0

OVER_SCROLL_NEVER :Number

Never allow a user to over-scroll this view.

Use this with the following properties - overScrollMode, overScrollMode, overScrollMode and overScrollMode.

Only applicable when API_LEVEL is 9 or above.

# PIXEL_FORMAT_A_8

Availability

1.8.0

PIXEL_FORMAT_A_8 :Number

Android A_8 pixel format for Titanium.UI.Window. Selecting the correct pixel format can improve image clarity and performance.