Titanium.UI.ProgressBar

Object of Titanium.UI.

Platform	Since
Android	0.8
iPhone	0.8
iPad	0.8

Summary

A progress bar.

Description

A progress bar is used for displaying an ongoing activity with a defined progression. For an activity without a defined progression, you can use Titanium.UI.ActivityIndicator.

Unlike most views, progress bars are hidden by default, so you must explicitly show the progress bar.

Use the Titanium.UI.createProgressBar method to create a progress bar.

Code Examples

Simple Progress Bar

In this example we create a progress bar with the min value of 0 and the max value of 10 and the current value of 0. Changing the value property causes the displayed progress bar to update.

var pb=Titanium.UI.createProgressBar({
    top:10,
    width:250,
    height:'auto',
    min:0,
    max:10,
    value:0,
    color:'#fff',
    message:'Downloading 0 of 10',
    font:{fontSize:14, fontWeight:'bold'},
    style:Titanium.UI.iPhone.ProgressBarStyle.PLAIN,
});
win.add(pb);
pb.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. (iPhone, iPad only.)
getAnimatedCenterPoint	Gets the value of the animatedCenterPoint property.
getBackgroundColor	Gets the value of the backgroundColor property.
getBackgroundDisabledColor	Gets the value of the backgroundDisabledColor property. (Android only.)
getBackgroundDisabledImage	Gets the value of the backgroundDisabledImage property. (Android only.)
getBackgroundFocusedColor	Gets the value of the backgroundFocusedColor property. (Android only.)
getBackgroundFocusedImage	Gets the value of the backgroundFocusedImage property. (Android only.)
getBackgroundGradient	Gets the value of the backgroundGradient property.
getBackgroundImage	Gets the value of the backgroundImage property.
getBackgroundLeftCap	Gets the value of the backgroundLeftCap property. (iPhone, iPad only.)
getBackgroundSelectedColor	Gets the value of the backgroundSelectedColor property. (Android, Mobile Web only.)
getBackgroundSelectedImage	Gets the value of the backgroundSelectedImage property. (Android, Mobile Web only.)
getBackgroundTopCap	Gets the value of the backgroundTopCap property. (iPhone, iPad only.)
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.
getColor	Gets the value of the color property.
getFocusable	Gets the value of the focusable property. (Android only.)
getFont	Gets the value of the font property.
getHeight	Gets the value of the height property.
getKeepScreenOn	Gets the value of the keepScreenOn property. (Android only.)
getLayout	Gets the value of the layout property.
getLeft	Gets the value of the left property.
getMax	Gets the value of the max property.
getMessage	Gets the value of the message property.
getMin	Gets the value of the min 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. (Android only.)
getStyle	Gets the value of the style property. (iPhone, iPad only.)
getTop	Gets the value of the top property.
getTouchEnabled	Gets the value of the touchEnabled property.
getTransform	Gets the value of the transform property.
getValue	Gets the value of the value property.
getVisible	Gets the value of the visible property.
getWidth	Gets the value of the width 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. (iPhone, iPad only.)
setBackgroundColor	Sets the value of the backgroundColor property.
setBackgroundDisabledColor	Sets the value of the backgroundDisabledColor property. (Android only.)
setBackgroundDisabledImage	Sets the value of the backgroundDisabledImage property. (Android only.)
setBackgroundFocusedColor	Sets the value of the backgroundFocusedColor property. (Android only.)
setBackgroundFocusedImage	Sets the value of the backgroundFocusedImage property. (Android only.)
setBackgroundGradient	Sets the value of the backgroundGradient property.
setBackgroundImage	Sets the value of the backgroundImage property.
setBackgroundLeftCap	Sets the value of the backgroundLeftCap property. (iPhone, iPad only.)
setBackgroundSelectedColor	Sets the value of the backgroundSelectedColor property. (Android, Mobile Web only.)
setBackgroundSelectedImage	Sets the value of the backgroundSelectedImage property. (Android, Mobile Web only.)
setBackgroundTopCap	Sets the value of the backgroundTopCap property. (iPhone, iPad only.)
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.
setColor	Sets the value of the color property.
setFocusable	Sets the value of the focusable property. (Android only.)
setFont	Sets the value of the font property.
setHeight	Sets the value of the height property.
setKeepScreenOn	Sets the value of the keepScreenOn property. (Android only.)
setLayout	Sets the value of the layout property.
setLeft	Sets the value of the left property.
setMax	Sets the value of the max property.
setMessage	Sets the value of the message property.
setMin	Sets the value of the min property.
setOpacity	Sets the value of the opacity property.
setRight	Sets the value of the right property.
setSize	Sets the value of the size property.
setSoftKeyboardOnFocus	Sets the value of the softKeyboardOnFocus property. (Android only.)
setStyle	Sets the value of the style property. (iPhone, iPad only.)
setTop	Sets the value of the top property.
setTouchEnabled	Sets the value of the touchEnabled property.
setTransform	Sets the value of the transform property.
setValue	Sets the value of the value property.
setVisible	Sets the value of the visible property.
setWidth	Sets the value of the width property.
setZIndex	Sets the value of the zIndex property.
show	Makes this view visible.
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. (iPhone, iPad only.)
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. (Android only.)
backgroundDisabledImage	String	Disabled background image for the view, specified as a local file path or URL. (Android only.)
backgroundFocusedColor	String	Focused background color of the view. (Android only.)
backgroundFocusedImage	String	Focused background image for the view, specified as a local file path or URL. (Android only.)
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. (iPhone, iPad only.)
backgroundSelectedColor	String	Selected background color of the view. (Android, Mobile Web only.)
backgroundSelectedImage	String	Selected background image url for the view, specified as a local file path or URL. (Android, Mobile Web only.)
backgroundTopCap	Number	Size of the top end cap. (iPhone, iPad only.)
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.
color	String	Color of the progress bar text.
focusable	Boolean	Whether view should be focusable while navigating with the trackball. (Android only.)
font	`Font`	Font for the progress bar text.
height	Number or String	View height, in platform-specific units.
keepScreenOn	Boolean	Whether to keep the device screen on. (Android only.)
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.
max	Number	Maximum value of the progress bar.
message	String	Progress bar text.
min	Number	Minimum value of the progress bar.
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. (Android only.)
style	Number	Style of the progress bar. (iPhone, iPad only.)
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.
value	Number	Current value of the progress bar.
visible	Boolean	Boolean value indicating whether the view is visible.
width	Number or String	View's width, in platform-specific units.
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. (Android only.)
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.