Titanium.Android.BigTextStyle
Helper object for generating large-format notifications that include a lot of text.
If the platform does not provide large-format notifications, this style helper has no effect. The user will always see the normal notification view.
This style object attaches to a Titanium.Android.Notification object and modifies its behavior.
Extends: Titanium.Proxy · Since: 5.4.0 · Platforms: android
Properties #
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.
bigContentTitle#
Type: String
Overrides Titanium.Android.Notification.contentTitle in the big form of the notification. This defaults to the value passed to Titanium.Android.Notification.contentTitle.
bigText#
Type: String
Sets the longer text to be displayed in the big form of the notification in place of the content text.
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.
summaryText#
Type: String
Set the first line of text after the detail section in the big form of the notification.
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 |
Examples #
Big text style Example
var bigTextStyle = Titanium.Android.createBigTextStyle({
bigText: "Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.",
bigContentTitle: "Title for big text",
summaryText: "Summary for big text"
});
// Create big text style notification
var notification = Titanium.Android.createNotification({
contentTitle: 'Something Happened',
contentText : 'Click to return to the application.',
style: bigTextStyle,
time: Date.now()
});
// Send the notification.
Titanium.Android.NotificationManager.notify(1, notification);