Titanium SDK

# Titanium.Platform.Android

The Android-specific Platform module, used to access the device's platform-related functionality.

Availability
1.8.2
Extends
Titanium.Module

# Properties

# apiName READONLY

Availability
3.2.0
apiName :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, Titanium.UI.Button returns Ti.UI.Button.

# bubbleParent

Availability
3.0.0
bubbleParent :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.

Default: true

# lifecycleContainer

Availability
3.6.0
lifecycleContainer :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.

# physicalSizeCategory READONLY

Availability
1.8.2
physicalSizeCategory :Number

The physical size category of the Android device or emulator.

This API can be assigned the following constants:

# Methods

# addEventListener

Availability
1.8.2
addEventListener(name, callback) → void

Adds the specified callback as an event listener for the named event.

Parameters

Name Type Description
name String

Name of the event.

callback Callback<Titanium.Event>

Callback function to invoke when the event is fired.

Returns

Type
void

# applyProperties

Availability
3.0.0
applyProperties(props) → void

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.

Parameters

Name Type Description
props Dictionary

A dictionary of properties to apply.

Returns

Type
void

# fireEvent

Availability
1.8.2
fireEvent(name[, event]) → void

Fires a synthesized event to any registered listeners.

Parameters

Name Type Description
name String

Name of the event.

event Dictionary

A dictionary of keys and values to add to the Titanium.Event object sent to the listeners.

Returns

Type
void

# removeEventListener

Availability
1.8.2
removeEventListener(name, callback) → void

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);

Parameters

Name Type Description
name String

Name of the event.

callback Callback<Titanium.Event>

Callback function to remove. Must be the same function passed to addEventListener.

Returns

Type
void

# Constants

# API_LEVEL

Availability
1.8.2
API_LEVEL :Number

Android API level identifier of the Operating System.

See the official Android Developers documentation for more information about API levels.

# PHYSICAL_SIZE_CATEGORY_LARGE

Availability
1.8.2
PHYSICAL_SIZE_CATEGORY_LARGE :Number

Constant to indicate that the physical size category of the current device/emulator is large

See the official Android Developers documentation for more information about large screen sizes

# PHYSICAL_SIZE_CATEGORY_NORMAL

Availability
1.8.2
PHYSICAL_SIZE_CATEGORY_NORMAL :Number

Constant to indicate that the physical size category of the current device/emulator is normal

See the official Android Developers documentation for more information about normal screen sizes

# PHYSICAL_SIZE_CATEGORY_SMALL

Availability
1.8.2
PHYSICAL_SIZE_CATEGORY_SMALL :Number

Constant to indicate that the physical size category of the current device/emulator is small

See the official Android Developers documentation for more information about small screen sizes

# PHYSICAL_SIZE_CATEGORY_UNDEFINED

Availability
1.8.2
PHYSICAL_SIZE_CATEGORY_UNDEFINED :Number

Constant to indicate that the physical size category of the current device/emulator is undefined

See the official Android Developers documentation for more information about undefined screen sizes

# PHYSICAL_SIZE_CATEGORY_XLARGE

Availability
1.8.2
PHYSICAL_SIZE_CATEGORY_XLARGE :Number

Constant to indicate that the physical size category of the current device/emulator is extra large

See the official Android Developers documentation for more information about extra large screen sizes

Contents