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.
getAnchorPoint	Gets the value of the anchorPoint property.
getAnimatedCenterPoint	Gets the value of the animatedCenterPoint property.
getBackgroundColor	Gets the value of the backgroundColor property.
getBackgroundDisabledColor	Gets the value of the backgroundDisabledColor property.
getBackgroundDisabledImage	Gets the value of the backgroundDisabledImage property.
getBackgroundFocusedColor	Gets the value of the backgroundFocusedColor property.
getBackgroundFocusedImage	Gets the value of the backgroundFocusedImage property.
getBackgroundGradient	Gets the value of the backgroundGradient property.
getBackgroundImage	Gets the value of the backgroundImage property.
getBackgroundLeftCap	Gets the value of the backgroundLeftCap property.
getBackgroundRepeat	Gets the value of the backgroundRepeat property.
getBackgroundSelectedColor	Gets the value of the backgroundSelectedColor property.
getBackgroundSelectedImage	Gets the value of the backgroundSelectedImage property.
getBackgroundTopCap	Gets the value of the backgroundTopCap property.
getBorderColor	Gets the value of the borderColor property.
getBorderRadius	Gets the value of the borderRadius property.
getBorderWidth	Gets the value of the borderWidth property.
getBottom	Gets the value of the bottom property.
getCenter	Gets the value of the center property.
getChildren	Gets the value of the children property.
getDuration	Gets the value of the duration property.
getFocusable	Gets the value of the focusable property.
getHeight	Gets the value of the height property.
getHorizontalMargin	Gets the value of the horizontalMargin property.
getKeepScreenOn	Gets the value of the keepScreenOn property.
getLayout	Gets the value of the layout property.
getLeft	Gets the value of the left property.
getMessage	Gets the value of the message property.
getOpacity	Gets the value of the opacity property.
getRight	Gets the value of the right property.
getSize	Gets the value of the size property.
getSoftKeyboardOnFocus	Gets the value of the softKeyboardOnFocus property.
getTop	Gets the value of the top property.
getTouchEnabled	Gets the value of the touchEnabled property.
getTransform	Gets the value of the transform property.
getVerticalMargin	Gets the value of the verticalMargin property.
getVisible	Gets the value of the visible property.
getWidth	Gets the value of the width property.
getXOffset	Gets the value of the xOffset property.
getYOffset	Gets the value of the yOffset property.
getZIndex	Gets the value of the zIndex property.
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.
setAnchorPoint	Sets the value of the anchorPoint property.
setBackgroundColor	Sets the value of the backgroundColor property.
setBackgroundDisabledColor	Sets the value of the backgroundDisabledColor property.
setBackgroundDisabledImage	Sets the value of the backgroundDisabledImage property.
setBackgroundFocusedColor	Sets the value of the backgroundFocusedColor property.
setBackgroundFocusedImage	Sets the value of the backgroundFocusedImage property.
setBackgroundGradient	Sets the value of the backgroundGradient property.
setBackgroundImage	Sets the value of the backgroundImage property.
setBackgroundLeftCap	Sets the value of the backgroundLeftCap property.
setBackgroundRepeat	Sets the value of the backgroundRepeat property.
setBackgroundSelectedColor	Sets the value of the backgroundSelectedColor property.
setBackgroundSelectedImage	Sets the value of the backgroundSelectedImage property.
setBackgroundTopCap	Sets the value of the backgroundTopCap property.
setBorderColor	Sets the value of the borderColor property.
setBorderRadius	Sets the value of the borderRadius property.
setBorderWidth	Sets the value of the borderWidth property.
setBottom	Sets the value of the bottom property.
setCenter	Sets the value of the center property.
setDuration	Sets the value of the duration property.
setFocusable	Sets the value of the focusable property.
setHeight	Sets the value of the height property.
setHorizontalMargin	Sets the value of the horizontalMargin property.
setKeepScreenOn	Sets the value of the keepScreenOn property.
setLayout	Sets the value of the layout property.
setLeft	Sets the value of the left property.
setMessage	Sets the value of the message property.
setOpacity	Sets the value of the opacity property.
setRight	Sets the value of the right property.
setSoftKeyboardOnFocus	Sets the value of the softKeyboardOnFocus property.
setTop	Sets the value of the top property.
setTouchEnabled	Sets the value of the touchEnabled property.
setTransform	Sets the value of the transform property.
setVerticalMargin	Sets the value of the verticalMargin property.
setVisible	Sets the value of the visible property.
setWidth	Sets the value of the width property.
setXOffset	Sets the value of the xOffset property.
setYOffset	Sets the value of the yOffset property.
setZIndex	Sets the value of the zIndex property.
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.
backgroundRepeat	Boolean	Toggle for whether or not to tile a background across a view.
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.
children	Array<`Titanium.UI.View`>	Array of this view's child views. read-only
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	Rendered size of the view as a dictionary of width and height properties. read-only
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	`Titanium.UI.2DMatrix` or `Titanium.UI.iOS.3DMatrix`	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	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.