Titanium.UI.Notification

Object of Titanium.UI.
Platform Since
Android 0.8

Summary

An Android Toast-style notification.

Description

A Toast notification is an unobtrusive, pop-up notification that doesn't block the UI. Use the Titanium.UI.createNotification method to create a Toast notification.

By default, a Toast notification appears centered on the bottom half of the screen.

This object will be moved to the Android namespace in a future release.

Code Examples

Simple Toast Notification

The simplest use case is also the most common.

var toast = Ti.UI.createNotification({
    message:"Please Stand By",
    duration: Ti.UI.NOTIFICATION_DURATION_LONG
});
toast.show();

Methods

Name Summary
add

Adds a child to this view's hierarchy.

addEventListener

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

animate

Animates this view.

convertPointToView

Translates a point from this view's coordinate system to another view's coordinate system.

fireEvent

Fires a synthesized event to any registered listeners.

hide

Hides this view.

remove

Removes a child view from this view's hierarchy.

removeEventListener

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

show

Show the notification.

toImage

Returns an image of the rendered view, as a Blob.

Properties

Name Type Summary
anchorPoint Point

Anchor point where animation should occur, relative to the view's boundaries.

animatedCenterPoint Point

Current position of the view during an animation. read-only

backgroundColor String

Background color of the view.

backgroundDisabledColor String

Disabled background color of the view.

backgroundDisabledImage String

Disabled background image for the view, specified as a local file path or URL.

backgroundFocusedColor String

Focused background color of the view.

backgroundFocusedImage String

Focused background image for the view, specified as a local file path or URL.

backgroundGradient Gradient

A background gradient for the view.

backgroundImage String

Background image for the view, specified as a local file path or URL.

backgroundLeftCap Number

Size of the left end cap.

backgroundSelectedColor String

Selected background color of the view.

backgroundSelectedImage String

Selected background image url for the view, specified as a local file path or URL.

backgroundTopCap Number

Size of the top end cap.

borderColor String

Border color of the view.

borderRadius Number

Border radius of the view.

borderWidth Number

Border width of the view.

bottom Number or String

View's bottom position, in platform-specific units.

center Point

View's center position, in the parent view's coordinates.

duration Number

Determines how long the notification stays on screen.

focusable Boolean

Whether view should be focusable while navigating with the trackball.

height Number or String

View height, in platform-specific units.

horizontalMargin Number

Horizontal placement of the notification, as a fraction of the screen width.

keepScreenOn Boolean

Whether to keep the device screen on.

layout String

Specifies how the view positions its children. One of: 'absolute', 'vertical', or 'horizontal'.

left Number or String

View's left position, in platform-specific units.

message String

Notification text to display.

opacity Number

Opacity of this view, from 0.0 (transparent) to 1.0 (opaque).

right Number or String

View's right position, in platform-specific units.

size Object

Size of the view as a dictionary of width and height properties.

softKeyboardOnFocus Number

Determines keyboard behavior when this view is focused.

top Number or String

The view's top position.

touchEnabled Boolean

Whether view should receive touch events.

transform Object

Transformation matrix to apply to the view.

verticalMargin Number

Vertical placement of the notifcation, as a fraction of the screen height.

visible Boolean

Boolean value indicating whether the view is visible.

width Number or String

View's width, in platform-specific units.

xOffset Number

X offset from the default position, in pixels.

yOffset Number

Y offset from the default position, in pixels.

zIndex Number

the z index position relative to other sibling views

Events

Name Summary
click

Fired when the device detects a click against the view.

dblclick

Fired when the device detects a double click against the view.

doubletap

Fired when the device detects a double tap against the view.

longclick

Fired when the device detects a long click.

longpress

Fired when the device detects a long press.

pinch

Fired when the device detects a pinch gesture.

singletap

Fired when the device detects a single tap against the view.

swipe

Fired when the device detects a swipe gesture (left or right) against the view.

touchcancel

Fired when a touch event is interrupted by the device.

touchend

Fired when a touch event is completed.

touchmove

Fired as soon as the device detects movement of a touch.

touchstart

Fired as soon as the device detects a touch gesture.

twofingertap

Fired when the device detects a two-finger tap against the view.