Titanium.Platform.Android
The Android-specific Platform module, used to access the device's platform-related functionality.
Extends: Titanium.Module · Since: 1.8.2 · Platforms: android
Properties #
API_LEVEL#
Type: Number
Android API level identifier of the Operating System.
See the official Android Developers documentation for more information about
API levels.
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.
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.
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.
PHYSICAL_SIZE_CATEGORY_LARGE#
Type: 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#
Type: 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#
Type: 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#
Type: 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#
Type: 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
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 |
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 |