Since: API Level 1

public class

ProgressBar

extends View

java.lang.Object
↳	android.view.View
	↳	android.widget.ProgressBar

Known Direct Subclasses

AbsSeekBar

Known Indirect Subclasses

RatingBar, SeekBar

Class Overview

Visual indicator of progress in some operation. Displays a bar to the user representing how far the operation has progressed; the application can change the amount of progress (modifying the length of the bar) as it moves forward. There is also a secondary progress displayable on a progress bar which is useful for displaying intermediate progress, such as the buffer level during a streaming playback progress bar.

A progress bar can also be made indeterminate. In indeterminate mode, the progress bar shows a cyclic animation. This mode is used by applications when the length of the task is unknown.

The following code example shows how a progress bar can be used from a worker thread to update the user interface to notify the user of progress:

 public class MyActivity extends Activity {
     private static final int PROGRESS = 0x1;

     private ProgressBar mProgress;
     private int mProgressStatus = 0;

     private Handler mHandler = new Handler();

     protected void onCreate(Bundle icicle) {
         super.onCreate(icicle);

         setContentView(R.layout.progressbar_activity);

         mProgress = (ProgressBar) findViewById(R.id.progress_bar);

         // Start lengthy operation in a background thread
         new Thread(new Runnable() {
             public void run() {
                 while (mProgressStatus < 100) {
                     mProgressStatus = doWork();

                     // Update the progress bar
                     mHandler.post(new Runnable() {
                         public void run() {
                             mProgress.setProgress(mProgressStatus);
                         }
                     });
                 }
             }
         }).start();
     }
 }

XML attributes

See ProgressBar Attributes, View Attributes

Styles

Summary

XML Attributes
Attribute Name	Related Method	Description
android:progressBarStyle		Default ProgressBar style.
android:progressBarStyleHorizontal		Horizontal ProgressBar style.
android:progressBarStyleLarge		Large ProgressBar style.
android:progressBarStyleSmall		Small ProgressBar style.

[Expand]

Inherited XML Attributes

From class android.view.View

[Expand]

Inherited Constants

From class android.view.View

Public Constructors
	ProgressBar(Context context) Create a new progress bar with range 0...100 and initial progress of 0.
	ProgressBar(Context context, AttributeSet attrs)
	ProgressBar(Context context, AttributeSet attrs, int defStyle)

Public Methods
Drawable	getIndeterminateDrawable() Get the drawable used to draw the progress bar in indeterminate mode.
Interpolator	getInterpolator() Gets the acceleration curve type for the indeterminate animation.
synchronized int	getMax() Return the upper limit of this progress bar's range.
synchronized int	getProgress() Get the progress bar's current level of progress.
Drawable	getProgressDrawable() Get the drawable used to draw the progress bar in progress mode.
synchronized int	getSecondaryProgress() Get the progress bar's current level of secondary progress.
synchronized final void	incrementProgressBy(int diff) Increase the progress bar's progress by the specified amount.
synchronized final void	incrementSecondaryProgressBy(int diff) Increase the progress bar's secondary progress by the specified amount.
void	invalidateDrawable(Drawable dr) Invalidates the specified Drawable.
synchronized boolean	isIndeterminate() Indicate whether this progress bar is in indeterminate mode.
void	onRestoreInstanceState(Parcelable state) Hook allowing a view to re-apply a representation of its internal state that had previously been generated by `onSaveInstanceState()`.
Parcelable	onSaveInstanceState() Hook allowing a view to generate a representation of its internal state that can later be used to create a new instance with that same state.
void	postInvalidate() Cause an invalidate to happen on a subsequent cycle through the event loop.
synchronized void	setIndeterminate(boolean indeterminate) Change the indeterminate mode for this progress bar.
void	setIndeterminateDrawable(Drawable d) Define the drawable used to draw the progress bar in indeterminate mode.
void	setInterpolator(Context context, int resID) Sets the acceleration curve for the indeterminate animation.
void	setInterpolator(Interpolator interpolator) Sets the acceleration curve for the indeterminate animation.
synchronized void	setMax(int max) Set the range of the progress bar to 0...
synchronized void	setProgress(int progress) Set the current progress to the specified value.
void	setProgressDrawable(Drawable d) Define the drawable used to draw the progress bar in progress mode.
synchronized void	setSecondaryProgress(int secondaryProgress) Set the current secondary progress to the specified value.
void	setVisibility(int v) Set the enabled state of this view.

Protected Methods
void	drawableStateChanged() This function is called whenever the state of the view changes in such a way that it impacts the state of drawables being shown.
void	onAttachedToWindow() This is called when the view is attached to a window.
void	onDetachedFromWindow() This is called when the view is detached from a window.
synchronized void	onDraw(Canvas canvas) Implement this to do your drawing.
synchronized void	onMeasure(int widthMeasureSpec, int heightMeasureSpec) Measure the view and its content to determine the measured width and the measured height.
void	onSizeChanged(int w, int h, int oldw, int oldh) This is called during layout when the size of this view has changed.
void	onVisibilityChanged(View changedView, int visibility) Called when the visibility of the view or an ancestor of the view is changed.
boolean	verifyDrawable(Drawable who) If your view subclass is displaying its own Drawable objects, it should override this function and return true for any Drawable it is displaying.

[Expand]

Inherited Methods

From class android.view.View

void	addFocusables(ArrayList<View> views, int direction) Add any focusable views that are descendants of this view (possibly including this view if it is focusable itself) to views.
void	addFocusables(ArrayList<View> views, int direction, int focusableMode) Adds any focusable views that are descendants of this view (possibly including this view if it is focusable itself) to views.
void	addTouchables(ArrayList<View> views) Add any touchable views that are descendants of this view (possibly including this view if it is touchable itself) to views.
boolean	awakenScrollBars(int startDelay) Trigger the scrollbars to draw.
boolean	awakenScrollBars(int startDelay, boolean invalidate) Trigger the scrollbars to draw.
boolean	awakenScrollBars() Trigger the scrollbars to draw.
void	bringToFront() Change the view's z order in the tree, so it's on top of other sibling views
void	buildDrawingCache(boolean autoScale) Forces the drawing cache to be built if the drawing cache is invalid.
void	buildDrawingCache() Calling this method is equivalent to calling `buildDrawingCache(false)`.
void	cancelLongPress() Cancels a pending long press.
boolean	checkInputConnectionProxy(View view) Called by the `InputMethodManager` when a view who is not the current input connection target is trying to make a call on the manager.
void	clearAnimation() Cancels any animations for this view.
void	clearFocus() Called when this view wants to give up focus.
int	computeHorizontalScrollExtent() Compute the horizontal extent of the horizontal scrollbar's thumb within the horizontal range.
int	computeHorizontalScrollOffset() Compute the horizontal offset of the horizontal scrollbar's thumb within the horizontal range.
int	computeHorizontalScrollRange() Compute the horizontal range that the horizontal scrollbar represents.
void	computeScroll() Called by a parent to request that a child update its values for mScrollX and mScrollY if necessary.
int	computeVerticalScrollExtent() Compute the vertical extent of the horizontal scrollbar's thumb within the vertical range.
int	computeVerticalScrollOffset() Compute the vertical offset of the vertical scrollbar's thumb within the horizontal range.
int	computeVerticalScrollRange() Compute the vertical range that the vertical scrollbar represents.
void	createContextMenu(ContextMenu menu) Show the context menu for this view.
void	destroyDrawingCache() Frees the resources used by the drawing cache.
void	dispatchConfigurationChanged(Configuration newConfig) Dispatch a notification about a resource configuration change down the view hierarchy.
void	dispatchDisplayHint(int hint) Dispatch a hint about whether this view is displayed.
void	dispatchDraw(Canvas canvas) Called by draw to draw the child views.
boolean	dispatchKeyEvent(KeyEvent event) Dispatch a key event to the next view on the focus path.
boolean	dispatchKeyEventPreIme(KeyEvent event) Dispatch a key event before it is processed by any input method associated with the view hierarchy.
boolean	dispatchKeyShortcutEvent(KeyEvent event) Dispatches a key shortcut event.
boolean	dispatchPopulateAccessibilityEvent(AccessibilityEvent event) Dispatches an `AccessibilityEvent` to the `View` children to be populated.
void	dispatchRestoreInstanceState(SparseArray<Parcelable> container) Called by `restoreHierarchyState(SparseArray)` to retrieve the state for this view and its children.
void	dispatchSaveInstanceState(SparseArray<Parcelable> container) Called by `saveHierarchyState(SparseArray)` to store the state for this view and its children.
void	dispatchSetPressed(boolean pressed) Dispatch setPressed to all of this View's children.
void	dispatchSetSelected(boolean selected) Dispatch setSelected to all of this View's children.
boolean	dispatchTouchEvent(MotionEvent event) Pass the touch screen motion event down to the target view, or this view if it is the target.
boolean	dispatchTrackballEvent(MotionEvent event) Pass a trackball motion event down to the focused view.
boolean	dispatchUnhandledMove(View focused, int direction) This method is the last chance for the focused view and its ancestors to respond to an arrow key.
void	dispatchVisibilityChanged(View changedView, int visibility) Dispatch a view visibility change down the view hierarchy.
void	dispatchWindowFocusChanged(boolean hasFocus) Called when the window containing this view gains or loses window focus.
void	dispatchWindowVisibilityChanged(int visibility) Dispatch a window visibility change down the view hierarchy.
void	draw(Canvas canvas) Manually render this view (and all of its children) to the given Canvas.
void	drawableStateChanged() This function is called whenever the state of the view changes in such a way that it impacts the state of drawables being shown.
View	findFocus() Find the view in the hierarchy rooted at this view that currently has focus.
final View	findViewById(int id) Look for a child view with the given id.
final View	findViewWithTag(Object tag) Look for a child view with the given tag.
boolean	fitSystemWindows(Rect insets) Apply the insets for system windows to this view, if the FITS_SYSTEM_WINDOWS flag is set
View	focusSearch(int direction) Find the nearest view in the specified direction that can take focus.
void	forceLayout() Forces this view to be laid out during the next layout pass.
Animation	getAnimation() Get the animation currently associated with this view.
IBinder	getApplicationWindowToken() Retrieve a unique token identifying the top-level "real" window of the window that this view is attached to.
Drawable	getBackground() Gets the background drawable
int	getBaseline() Return the offset of the widget's text baseline from the widget's top boundary.
final int	getBottom() Bottom position of this view relative to its parent.
float	getBottomFadingEdgeStrength() Returns the strength, or intensity, of the bottom faded edge.
int	getBottomPaddingOffset() Amount by which to extend the bottom fading region.
CharSequence	getContentDescription() Gets the `View` description.
final Context	getContext() Returns the context the view is running in, through which it can access the current theme, resources, etc.
ContextMenu.ContextMenuInfo	getContextMenuInfo() Views should implement this if they have extra information to associate with the context menu.
static int	getDefaultSize(int size, int measureSpec) Utility to return a default size.
final int[]	getDrawableState() Return an array of resource IDs of the drawable states representing the current state of the view.
Bitmap	getDrawingCache(boolean autoScale) Returns the bitmap in which this view drawing is cached.
Bitmap	getDrawingCache() Calling this method is equivalent to calling `getDrawingCache(false)`.
int	getDrawingCacheBackgroundColor()
int	getDrawingCacheQuality() Returns the quality of the drawing cache.
void	getDrawingRect(Rect outRect) Return the visible drawing bounds of your view.
long	getDrawingTime() Return the time at which the drawing of the view hierarchy started.
boolean	getFilterTouchesWhenObscured() Gets whether the framework should discard touches when the view's window is obscured by another visible window.
ArrayList<View>	getFocusables(int direction) Find and return all focusable views that are descendants of this view, possibly including this view if it is focusable itself.
void	getFocusedRect(Rect r) When a view has focus and the user navigates away from it, the next view is searched for starting from the rectangle filled in by this method.
boolean	getGlobalVisibleRect(Rect r, Point globalOffset) If some part of this view is not clipped by any of its parents, then return that area in r in global (root) coordinates.
final boolean	getGlobalVisibleRect(Rect r)
Handler	getHandler()
final int	getHeight() Return the height of your view.
void	getHitRect(Rect outRect) Hit rectangle in parent's coordinates
int	getHorizontalFadingEdgeLength() Returns the size of the horizontal faded edges used to indicate that more content in this view is visible.
int	getHorizontalScrollbarHeight() Returns the height of the horizontal scrollbar.
int	getId() Returns this view's identifier.
boolean	getKeepScreenOn() Returns whether the screen should remain on, corresponding to the current value of `KEEP_SCREEN_ON`.
KeyEvent.DispatcherState	getKeyDispatcherState() Return the global `KeyEvent.DispatcherState` for this view's window.
ViewGroup.LayoutParams	getLayoutParams() Get the LayoutParams associated with this view.
final int	getLeft() Left position of this view relative to its parent.
float	getLeftFadingEdgeStrength() Returns the strength, or intensity, of the left faded edge.
int	getLeftPaddingOffset() Amount by which to extend the left fading region.
final boolean	getLocalVisibleRect(Rect r)
void	getLocationInWindow(int[] location) Computes the coordinates of this view in its window.
void	getLocationOnScreen(int[] location) Computes the coordinates of this view on the screen.
final int	getMeasuredHeight() The height of this view as measured in the most recent call to measure().
final int	getMeasuredWidth() The width of this view as measured in the most recent call to measure().
int	getNextFocusDownId()
int	getNextFocusLeftId()
int	getNextFocusRightId()
int	getNextFocusUpId()
View.OnFocusChangeListener	getOnFocusChangeListener() Returns the focus-change callback registered for this view.
int	getOverScrollMode() Returns the over-scroll mode for this view.
int	getPaddingBottom() Returns the bottom padding of this view.
int	getPaddingLeft() Returns the left padding of this view.
int	getPaddingRight() Returns the right padding of this view.
int	getPaddingTop() Returns the top padding of this view.
final ViewParent	getParent() Gets the parent of this view.
Resources	getResources() Returns the resources associated with this view.
final int	getRight() Right position of this view relative to its parent.
float	getRightFadingEdgeStrength() Returns the strength, or intensity, of the right faded edge.
int	getRightPaddingOffset() Amount by which to extend the right fading region.
View	getRootView() Finds the topmost view in the current view hierarchy.
int	getScrollBarStyle() Returns the current scrollbar style.
final int	getScrollX() Return the scrolled left position of this view.
final int	getScrollY() Return the scrolled top position of this view.
int	getSolidColor() Override this if your view is known to always be drawn on top of a solid color background, and needs to draw fading edges.
int	getSuggestedMinimumHeight() Returns the suggested minimum height that the view should use.
int	getSuggestedMinimumWidth() Returns the suggested minimum width that the view should use.
Object	getTag(int key) Returns the tag associated with this view and the specified key.
Object	getTag() Returns this view's tag.
final int	getTop() Top position of this view relative to its parent.
float	getTopFadingEdgeStrength() Returns the strength, or intensity, of the top faded edge.
int	getTopPaddingOffset() Amount by which to extend the top fading region.
TouchDelegate	getTouchDelegate() Gets the TouchDelegate for this View.
ArrayList<View>	getTouchables() Find and return all touchable views that are descendants of this view, possibly including this view if it is touchable itself.
int	getVerticalFadingEdgeLength() Returns the size of the vertical faded edges used to indicate that more content in this view is visible.
int	getVerticalScrollbarWidth() Returns the width of the vertical scrollbar.
ViewTreeObserver	getViewTreeObserver() Returns the ViewTreeObserver for this view's hierarchy.
int	getVisibility() Returns the visibility status for this view.
final int	getWidth() Return the width of the your view.
int	getWindowAttachCount()
IBinder	getWindowToken() Retrieve a unique token identifying the window this view is attached to.
int	getWindowVisibility() Returns the current visibility of the window this view is attached to (either `GONE`, `INVISIBLE`, or `VISIBLE`).
void	getWindowVisibleDisplayFrame(Rect outRect) Retrieve the overall visible display size in which the window this view is attached to has been positioned in.
boolean	hasFocus() Returns true if this view has focus iteself, or is the ancestor of the view that has focus.
boolean	hasFocusable() Returns true if this view is focusable or if it contains a reachable View for which `hasFocusable()` returns true.
boolean	hasWindowFocus() Returns true if this view is in a window that currently has window focus.
static View	inflate(Context context, int resource, ViewGroup root) Inflate a view from an XML resource.
void	initializeFadingEdge(TypedArray a) Initializes the fading edges from a given set of styled attributes.
void	initializeScrollbars(TypedArray a) Initializes the scrollbars from a given set of styled attributes.
void	invalidate(Rect dirty) Mark the the area defined by dirty as needing to be drawn.
void	invalidate(int l, int t, int r, int b) Mark the the area defined by the rect (l,t,r,b) as needing to be drawn.
void	invalidate() Invalidate the whole view.
void	invalidateDrawable(Drawable drawable) Invalidates the specified Drawable.
boolean	isClickable() Indicates whether this view reacts to click events or not.
boolean	isDrawingCacheEnabled() Indicates whether the drawing cache is enabled for this view.
boolean	isDuplicateParentStateEnabled() Indicates whether this duplicates its drawable state from its parent.
boolean	isEnabled() Returns the enabled status for this view.
final boolean	isFocusable() Returns whether this View is able to take focus.
final boolean	isFocusableInTouchMode() When a view is focusable, it may not want to take focus when in touch mode.
boolean	isFocused() Returns true if this view has focus
boolean	isHapticFeedbackEnabled()
boolean	isHorizontalFadingEdgeEnabled() Indicate whether the horizontal edges are faded when the view is scrolled horizontally.
boolean	isHorizontalScrollBarEnabled() Indicate whether the horizontal scrollbar should be drawn or not.
boolean	isInEditMode() Indicates whether this View is currently in edit mode.
boolean	isInTouchMode() Returns whether the device is currently in touch mode.
boolean	isLayoutRequested() Indicates whether or not this view's layout will be requested during the next hierarchy layout pass.
boolean	isLongClickable() Indicates whether this view reacts to long click events or not.
boolean	isOpaque() Indicates whether this View is opaque.
boolean	isPaddingOffsetRequired() If the View draws content inside its padding and enables fading edges, it needs to support padding offsets.
boolean	isPressed() Indicates whether the view is currently in pressed state.
boolean	isSaveEnabled() Indicates whether this view will save its state (that is, whether its `onSaveInstanceState()` method will be called).
boolean	isScrollbarFadingEnabled() Returns true if scrollbars will fade when this view is not scrolling
boolean	isSelected() Indicates the selection state of this view.
boolean	isShown() Returns the visibility of this view and all of its ancestors
boolean	isSoundEffectsEnabled()
boolean	isVerticalFadingEdgeEnabled() Indicate whether the vertical edges are faded when the view is scrolled horizontally.
boolean	isVerticalScrollBarEnabled() Indicate whether the vertical scrollbar should be drawn or not.
final void	layout(int l, int t, int r, int b) Assign a size and position to a view and all of its descendants This is the second phase of the layout mechanism.
final void	measure(int widthMeasureSpec, int heightMeasureSpec) This is called to find out how big a view should be.
static int[]	mergeDrawableStates(int[] baseState, int[] additionalState) Merge your own state values in `additionalState` into the base state values `baseState` that were returned by `onCreateDrawableState(int)`.
void	offsetLeftAndRight(int offset) Offset this view's horizontal location by the specified amount of pixels.
void	offsetTopAndBottom(int offset) Offset this view's vertical location by the specified number of pixels.
void	onAnimationEnd() Invoked by a parent ViewGroup to notify the end of the animation currently associated with this view.
void	onAnimationStart() Invoked by a parent ViewGroup to notify the start of the animation currently associated with this view.
void	onAttachedToWindow() This is called when the view is attached to a window.
boolean	onCheckIsTextEditor() Check whether the called view is a text editor, in which case it would make sense to automatically display a soft input window for it.
void	onConfigurationChanged(Configuration newConfig) Called when the current configuration of the resources being used by the application have changed.
void	onCreateContextMenu(ContextMenu menu) Views should implement this if the view itself is going to add items to the context menu.
int[]	onCreateDrawableState(int extraSpace) Generate the new `Drawable` state for this view.
InputConnection	onCreateInputConnection(EditorInfo outAttrs) Create a new InputConnection for an InputMethod to interact with the view.
void	onDetachedFromWindow() This is called when the view is detached from a window.
void	onDisplayHint(int hint) Gives this view a hint about whether is displayed or not.
void	onDraw(Canvas canvas) Implement this to do your drawing.
final void	onDrawScrollBars(Canvas canvas) Request the drawing of the horizontal and the vertical scrollbar.
boolean	onFilterTouchEventForSecurity(MotionEvent event) Filter the touch event to apply security policies.
void	onFinishInflate() Finalize inflating a view from XML.
void	onFinishTemporaryDetach() Called after `onStartTemporaryDetach()` when the container is done changing the view.
void	onFocusChanged(boolean gainFocus, int direction, Rect previouslyFocusedRect) Called by the view system when the focus state of this view changes.
boolean	onKeyDown(int keyCode, KeyEvent event) Default implementation of `KeyEvent.Callback.onKeyMultiple()`: perform press of the view when `KEYCODE_DPAD_CENTER` or `KEYCODE_ENTER` is released, if the view is enabled and clickable.
boolean	onKeyLongPress(int keyCode, KeyEvent event) Default implementation of `KeyEvent.Callback.onKeyLongPress()`: always returns false (doesn't handle the event).
boolean	onKeyMultiple(int keyCode, int repeatCount, KeyEvent event) Default implementation of `KeyEvent.Callback.onKeyMultiple()`: always returns false (doesn't handle the event).
boolean	onKeyPreIme(int keyCode, KeyEvent event) Handle a key event before it is processed by any input method associated with the view hierarchy.
boolean	onKeyShortcut(int keyCode, KeyEvent event) Called when an unhandled key shortcut event occurs.
boolean	onKeyUp(int keyCode, KeyEvent event) Default implementation of `KeyEvent.Callback.onKeyMultiple()`: perform clicking of the view when `KEYCODE_DPAD_CENTER` or `KEYCODE_ENTER` is released.
void	onLayout(boolean changed, int left, int top, int right, int bottom) Called from layout when this view should assign a size and position to each of its children.
void	onMeasure(int widthMeasureSpec, int heightMeasureSpec) Measure the view and its content to determine the measured width and the measured height.
void	onOverScrolled(int scrollX, int scrollY, boolean clampedX, boolean clampedY) Called by `overScrollBy(int, int, int, int, int, int, int, int, boolean)` to respond to the results of an over-scroll operation.
void	onRestoreInstanceState(Parcelable state) Hook allowing a view to re-apply a representation of its internal state that had previously been generated by `onSaveInstanceState()`.
Parcelable	onSaveInstanceState() Hook allowing a view to generate a representation of its internal state that can later be used to create a new instance with that same state.
void	onScrollChanged(int l, int t, int oldl, int oldt) This is called in response to an internal scroll in this view (i.e., the view scrolled its own contents).
boolean	onSetAlpha(int alpha) Invoked if there is a Transform that involves alpha.
void	onSizeChanged(int w, int h, int oldw, int oldh) This is called during layout when the size of this view has changed.
void	onStartTemporaryDetach() This is called when a container is going to temporarily detach a child, with `ViewGroup.detachViewFromParent`.
boolean	onTouchEvent(MotionEvent event) Implement this method to handle touch screen motion events.
boolean	onTrackballEvent(MotionEvent event) Implement this method to handle trackball motion events.
void	onVisibilityChanged(View changedView, int visibility) Called when the visibility of the view or an ancestor of the view is changed.
void	onWindowFocusChanged(boolean hasWindowFocus) Called when the window containing this view gains or loses focus.
void	onWindowVisibilityChanged(int visibility) Called when the window containing has change its visibility (between `GONE`, `INVISIBLE`, and `VISIBLE`).
boolean	overScrollBy(int deltaX, int deltaY, int scrollX, int scrollY, int scrollRangeX, int scrollRangeY, int maxOverScrollX, int maxOverScrollY, boolean isTouchEvent) Scroll the view with standard behavior for scrolling beyond the normal content boundaries.
boolean	performClick() Call this view's OnClickListener, if it is defined.
boolean	performHapticFeedback(int feedbackConstant, int flags) BZZZTT!!1! Like `performHapticFeedback(int)`, with additional options.
boolean	performHapticFeedback(int feedbackConstant) BZZZTT!!1! Provide haptic feedback to the user for this view.
boolean	performLongClick() Call this view's OnLongClickListener, if it is defined.
void	playSoundEffect(int soundConstant) Play a sound effect for this view.
boolean	post(Runnable action) Causes the Runnable to be added to the message queue.
boolean	postDelayed(Runnable action, long delayMillis) Causes the Runnable to be added to the message queue, to be run after the specified amount of time elapses.
void	postInvalidate(int left, int top, int right, int bottom) Cause an invalidate of the specified area to happen on a subsequent cycle through the event loop.
void	postInvalidate() Cause an invalidate to happen on a subsequent cycle through the event loop.
void	postInvalidateDelayed(long delayMilliseconds, int left, int top, int right, int bottom) Cause an invalidate of the specified area to happen on a subsequent cycle through the event loop.
void	postInvalidateDelayed(long delayMilliseconds) Cause an invalidate to happen on a subsequent cycle through the event loop.
void	refreshDrawableState() Call this to force a view to update its drawable state.
boolean	removeCallbacks(Runnable action) Removes the specified Runnable from the message queue.
boolean	requestFocus(int direction, Rect previouslyFocusedRect) Call this to try to give focus to a specific view or to one of its descendants and give it hints about the direction and a specific rectangle that the focus is coming from.
final boolean	requestFocus(int direction) Call this to try to give focus to a specific view or to one of its descendants and give it a hint about what direction focus is heading.
final boolean	requestFocus() Call this to try to give focus to a specific view or to one of its descendants.
final boolean	requestFocusFromTouch() Call this to try to give focus to a specific view or to one of its descendants.
void	requestLayout() Call this when something has changed which has invalidated the layout of this view.
boolean	requestRectangleOnScreen(Rect rectangle) Request that a rectangle of this view be visible on the screen, scrolling if necessary just enough.
boolean	requestRectangleOnScreen(Rect rectangle, boolean immediate) Request that a rectangle of this view be visible on the screen, scrolling if necessary just enough.
static int	resolveSize(int size, int measureSpec) Utility to reconcile a desired size with constraints imposed by a MeasureSpec.
void	restoreHierarchyState(SparseArray<Parcelable> container) Restore this view hierarchy's frozen state from the given container.
void	saveHierarchyState(SparseArray<Parcelable> container) Store this view hierarchy's frozen state into the given container.
void	scheduleDrawable(Drawable who, Runnable what, long when) Schedules an action on a drawable to occur at a specified time.
void	scrollBy(int x, int y) Move the scrolled position of your view.
void	scrollTo(int x, int y) Set the scrolled position of your view.
void	sendAccessibilityEvent(int eventType) Handles the request for sending an `AccessibilityEvent` given the event type.
void	sendAccessibilityEventUnchecked(AccessibilityEvent event) Handles the request for sending an `AccessibilityEvent`.
void	setAnimation(Animation animation) Sets the next animation to play for this view.
void	setBackgroundColor(int color) Sets the background color for this view.
void	setBackgroundDrawable(Drawable d) Set the background to a given Drawable, or remove the background.
void	setBackgroundResource(int resid) Set the background to a given resource.
void	setClickable(boolean clickable) Enables or disables click events for this view.
void	setContentDescription(CharSequence contentDescription) Sets the `View` description.
void	setDrawingCacheBackgroundColor(int color) Setting a solid background color for the drawing cache's bitmaps will improve perfromance and memory usage.
void	setDrawingCacheEnabled(boolean enabled) Enables or disables the drawing cache.
void	setDrawingCacheQuality(int quality) Set the drawing cache quality of this view.
void	setDuplicateParentStateEnabled(boolean enabled) Enables or disables the duplication of the parent's state into this view.
void	setEnabled(boolean enabled) Set the enabled state of this view.
void	setFadingEdgeLength(int length) Set the size of the faded edge used to indicate that more content in this view is available.
void	setFilterTouchesWhenObscured(boolean enabled) Sets whether the framework should discard touches when the view's window is obscured by another visible window.
void	setFocusable(boolean focusable) Set whether this view can receive the focus.
void	setFocusableInTouchMode(boolean focusableInTouchMode) Set whether this view can receive focus while in touch mode.
void	setHapticFeedbackEnabled(boolean hapticFeedbackEnabled) Set whether this view should have haptic feedback for events such as long presses.
void	setHorizontalFadingEdgeEnabled(boolean horizontalFadingEdgeEnabled) Define whether the horizontal edges should be faded when this view is scrolled horizontally.
void	setHorizontalScrollBarEnabled(boolean horizontalScrollBarEnabled) Define whether the horizontal scrollbar should be drawn or not.
void	setId(int id) Sets the identifier for this view.
void	setKeepScreenOn(boolean keepScreenOn) Controls whether the screen should remain on, modifying the value of `KEEP_SCREEN_ON`.
void	setLayoutParams(ViewGroup.LayoutParams params) Set the layout parameters associated with this view.
void	setLongClickable(boolean longClickable) Enables or disables long click events for this view.
final void	setMeasuredDimension(int measuredWidth, int measuredHeight) This mehod must be called by `onMeasure(int, int)` to store the measured width and measured height.
void	setMinimumHeight(int minHeight) Sets the minimum height of the view.
void	setMinimumWidth(int minWidth) Sets the minimum width of the view.
void	setNextFocusDownId(int nextFocusDownId) Set the id of the view to use for the next focus
void	setNextFocusLeftId(int nextFocusLeftId) Set the id of the view to use for the next focus
void	setNextFocusRightId(int nextFocusRightId) Set the id of the view to use for the next focus
void	setNextFocusUpId(int nextFocusUpId) Set the id of the view to use for the next focus
void	setOnClickListener(View.OnClickListener l) Register a callback to be invoked when this view is clicked.
void	setOnCreateContextMenuListener(View.OnCreateContextMenuListener l) Register a callback to be invoked when the context menu for this view is being built.
void	setOnFocusChangeListener(View.OnFocusChangeListener l) Register a callback to be invoked when focus of this view changed.
void	setOnKeyListener(View.OnKeyListener l) Register a callback to be invoked when a key is pressed in this view.
void	setOnLongClickListener(View.OnLongClickListener l) Register a callback to be invoked when this view is clicked and held.
void	setOnTouchListener(View.OnTouchListener l) Register a callback to be invoked when a touch event is sent to this view.
void	setOverScrollMode(int overScrollMode) Set the over-scroll mode for this view.
void	setPadding(int left, int top, int right, int bottom) Sets the padding.
void	setPressed(boolean pressed) Sets the pressed that for this view.
void	setSaveEnabled(boolean enabled) Controls whether the saving of this view's state is enabled (that is, whether its `onSaveInstanceState()` method will be called).
void	setScrollBarStyle(int style) Specify the style of the scrollbars.
void	setScrollContainer(boolean isScrollContainer) Change whether this view is one of the set of scrollable containers in its window.
void	setScrollbarFadingEnabled(boolean fadeScrollbars) Define whether scrollbars will fade when the view is not scrolling.
void	setSelected(boolean selected) Changes the selection state of this view.
void	setSoundEffectsEnabled(boolean soundEffectsEnabled) Set whether this view should have sound effects enabled for events such as clicking and touching.
void	setTag(int key, Object tag) Sets a tag associated with this view and a key.
void	setTag(Object tag) Sets the tag associated with this view.
void	setTouchDelegate(TouchDelegate delegate) Sets the TouchDelegate for this View.
void	setVerticalFadingEdgeEnabled(boolean verticalFadingEdgeEnabled) Define whether the vertical edges should be faded when this view is scrolled vertically.
void	setVerticalScrollBarEnabled(boolean verticalScrollBarEnabled) Define whether the vertical scrollbar should be drawn or not.
void	setVisibility(int visibility) Set the enabled state of this view.
void	setWillNotCacheDrawing(boolean willNotCacheDrawing) When a View's drawing cache is enabled, drawing is redirected to an offscreen bitmap.
void	setWillNotDraw(boolean willNotDraw) If this view doesn't do any drawing on its own, set this flag to allow further optimizations.
boolean	showContextMenu() Bring up the context menu for this view.
void	startAnimation(Animation animation) Start the specified animation now.
void	unscheduleDrawable(Drawable who) Unschedule any events associated with the given Drawable.
void	unscheduleDrawable(Drawable who, Runnable what) Cancels a scheduled action on a drawable.
boolean	verifyDrawable(Drawable who) If your view subclass is displaying its own Drawable objects, it should override this function and return true for any Drawable it is displaying.
boolean	willNotCacheDrawing() Returns whether or not this View can cache its drawing or not.
boolean	willNotDraw() Returns whether or not this View draws on its own.

From class java.lang.Object

Object	clone() Creates and returns a copy of this `Object`.
boolean	equals(Object o) Compares this instance with the specified object and indicates if they are equal.
void	finalize() Called before the object's memory is reclaimed by the VM.
final Class<? extends Object>	getClass() Returns the unique instance of `Class` that represents this object's class.
int	hashCode() Returns an integer hash code for this object.
final void	notify() Causes a thread which is waiting on this object's monitor (by means of calling one of the `wait()` methods) to be woken up.
final void	notifyAll() Causes all threads which are waiting on this object's monitor (by means of calling one of the `wait()` methods) to be woken up.
String	toString() Returns a string containing a concise, human-readable description of this object.
final void	wait() Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object.
final void	wait(long millis, int nanos) Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object or until the specified timeout expires.
final void	wait(long millis) Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object or until the specified timeout expires.

From interface android.graphics.drawable.Drawable.Callback

From interface android.view.KeyEvent.Callback

From interface android.view.accessibility.AccessibilityEventSource

XML Attributes

android:progressBarStyle

Since: API Level

Default ProgressBar style. This is a medium circular progress bar.

Must be a reference to another resource, in the form "@[+][package:]type:name" or to a theme attribute in the form "?[package:][type:]name".

This corresponds to the global attribute resource symbol progressBarStyle.

Related Methods

android:progressBarStyleHorizontal

Since: API Level

Horizontal ProgressBar style. This is a horizontal progress bar.

Must be a reference to another resource, in the form "@[+][package:]type:name" or to a theme attribute in the form "?[package:][type:]name".

This corresponds to the global attribute resource symbol progressBarStyleHorizontal.

Related Methods

android:progressBarStyleLarge

Since: API Level

Large ProgressBar style. This is a large circular progress bar.

Must be a reference to another resource, in the form "@[+][package:]type:name" or to a theme attribute in the form "?[package:][type:]name".

This corresponds to the global attribute resource symbol progressBarStyleLarge.

Related Methods

android:progressBarStyleSmall

Since: API Level

Small ProgressBar style. This is a small circular progress bar.

Must be a reference to another resource, in the form "@[+][package:]type:name" or to a theme attribute in the form "?[package:][type:]name".

This corresponds to the global attribute resource symbol progressBarStyleSmall.

Related Methods

Public Constructors

public ProgressBar (Context context)

Since: API Level 1

Create a new progress bar with range 0...100 and initial progress of 0.

Parameters

context	the application environment

public ProgressBar (Context context, AttributeSet attrs)

Since: API Level 1

public ProgressBar (Context context, AttributeSet attrs, int defStyle)

Since: API Level 1

Public Methods

public Drawable getIndeterminateDrawable ()

Since: API Level 1

Get the drawable used to draw the progress bar in indeterminate mode.

Returns

a Drawable instance

public Interpolator getInterpolator ()

Since: API Level 1

Gets the acceleration curve type for the indeterminate animation.

Returns

the Interpolator associated to this animation

public synchronized int getMax ()

Since: API Level 1

Return the upper limit of this progress bar's range.

Returns

a positive integer

public synchronized int getProgress ()

Since: API Level 1

Get the progress bar's current level of progress. Return 0 when the progress bar is in indeterminate mode.

Returns

the current progress, between 0 and getMax()

public Drawable getProgressDrawable ()

Since: API Level 1

Get the drawable used to draw the progress bar in progress mode.

Returns

a Drawable instance

public synchronized int getSecondaryProgress ()

Since: API Level 1

Get the progress bar's current level of secondary progress. Return 0 when the progress bar is in indeterminate mode.

Returns

the current secondary progress, between 0 and getMax()

public final synchronized void incrementProgressBy (int diff)

Since: API Level 1

Increase the progress bar's progress by the specified amount.

Parameters

diff	the amount by which the progress must be increased

public final synchronized void incrementSecondaryProgressBy (int diff)

Since: API Level 1

Increase the progress bar's secondary progress by the specified amount.

Parameters

diff	the amount by which the secondary progress must be increased

public void invalidateDrawable (Drawable dr)

Since: API Level 1

Invalidates the specified Drawable.

Parameters

dr	the drawable to invalidate

public synchronized boolean isIndeterminate ()

Since: API Level 1

Indicate whether this progress bar is in indeterminate mode.

Returns

true if the progress bar is in indeterminate mode

public void onRestoreInstanceState (Parcelable state)

Since: API Level 1

Hook allowing a view to re-apply a representation of its internal state that had previously been generated by onSaveInstanceState(). This function will never be called with a null state.

Parameters

state	The frozen state that had previously been returned by `onSaveInstanceState()`.

public Parcelable onSaveInstanceState ()

Since: API Level 1

Hook allowing a view to generate a representation of its internal state that can later be used to create a new instance with that same state. This state should only contain information that is not persistent or can not be reconstructed later. For example, you will never store your current position on screen because that will be computed again when a new instance of the view is placed in its view hierarchy.

Some examples of things you may store here: the current cursor position in a text view (but usually not the text itself since that is stored in a content provider or other persistent storage), the currently selected item in a list view.

Returns

Returns a Parcelable object containing the view's current dynamic state, or null if there is nothing interesting to save. The default implementation returns null.

public void postInvalidate ()

Since: API Level 1

Cause an invalidate to happen on a subsequent cycle through the event loop. Use this to invalidate the View from a non-UI thread.

public synchronized void setIndeterminate (boolean indeterminate)

Since: API Level 1

Change the indeterminate mode for this progress bar. In indeterminate mode, the progress is ignored and the progress bar shows an infinite animation instead.

If this progress bar's style only supports indeterminate mode (such as the circular progress bars), then this will be ignored.

Parameters

indeterminate	true to enable the indeterminate mode

public void setIndeterminateDrawable (Drawable d)

Since: API Level 1

Define the drawable used to draw the progress bar in indeterminate mode.

Parameters

d	the new drawable

public void setInterpolator (Context context, int resID)

Since: API Level 1

Sets the acceleration curve for the indeterminate animation. The interpolator is loaded as a resource from the specified context.

Parameters

context	The application environment
resID	The resource identifier of the interpolator to load

public void setInterpolator (Interpolator interpolator)

Since: API Level 1

Sets the acceleration curve for the indeterminate animation. Defaults to a linear interpolation.

Parameters

interpolator	The interpolator which defines the acceleration curve

public synchronized void setMax (int max)

Since: API Level 1

Set the range of the progress bar to 0...max.

Parameters

max	the upper range of this progress bar

public synchronized void setProgress (int progress)

Since: API Level 1

Set the current progress to the specified value. Does not do anything if the progress bar is in indeterminate mode.

Parameters

progress	the new progress, between 0 and `getMax()`

public void setProgressDrawable (Drawable d)

Since: API Level 1

Define the drawable used to draw the progress bar in progress mode.

Parameters

d	the new drawable

public synchronized void setSecondaryProgress (int secondaryProgress)

Since: API Level 1

Set the current secondary progress to the specified value. Does not do anything if the progress bar is in indeterminate mode.

Parameters

secondaryProgress	the new secondary progress, between 0 and `getMax()`

public void setVisibility (int v)

Since: API Level 1

Set the enabled state of this view.

Parameters

v	One of `VISIBLE`, `INVISIBLE`, or `GONE`.

Protected Methods

protected void drawableStateChanged ()

Since: API Level 1

This function is called whenever the state of the view changes in such a way that it impacts the state of drawables being shown.

Be sure to call through to the superclass when overriding this function.

protected void onAttachedToWindow ()

Since: API Level 1

This is called when the view is attached to a window. At this point it has a Surface and will start drawing. Note that this function is guaranteed to be called before onDraw(Canvas), however it may be called any time before the first onDraw -- including before or after onMeasure(int, int).

protected void onDetachedFromWindow ()

Since: API Level 1

This is called when the view is detached from a window. At this point it no longer has a surface for drawing.

protected synchronized void onDraw (Canvas canvas)

Since: API Level 1

Implement this to do your drawing.

Parameters

canvas	the canvas on which the background will be drawn

protected synchronized void onMeasure (int widthMeasureSpec, int heightMeasureSpec)

Since: API Level 1

Measure the view and its content to determine the measured width and the measured height. This method is invoked by measure(int, int) and should be overriden by subclasses to provide accurate and efficient measurement of their contents.

CONTRACT: When overriding this method, you must call setMeasuredDimension(int, int) to store the measured width and height of this view. Failure to do so will trigger an IllegalStateException, thrown by measure(int, int). Calling the superclass' onMeasure(int, int) is a valid use.

The base class implementation of measure defaults to the background size, unless a larger size is allowed by the MeasureSpec. Subclasses should override onMeasure(int, int) to provide better measurements of their content.

If this method is overridden, it is the subclass's responsibility to make sure the measured height and width are at least the view's minimum height and width (getSuggestedMinimumHeight() and getSuggestedMinimumWidth()).

Parameters

widthMeasureSpec	horizontal space requirements as imposed by the parent. The requirements are encoded with `View.MeasureSpec`.
heightMeasureSpec	vertical space requirements as imposed by the parent. The requirements are encoded with `View.MeasureSpec`.

protected void onSizeChanged (int w, int h, int oldw, int oldh)

Since: API Level 1

This is called during layout when the size of this view has changed. If you were just added to the view hierarchy, you're called with the old values of 0.

Parameters

w	Current width of this view.
h	Current height of this view.
oldw	Old width of this view.
oldh	Old height of this view.

protected void onVisibilityChanged (View changedView, int visibility)

Since: API Level 8

Called when the visibility of the view or an ancestor of the view is changed.

Parameters

changedView	The view whose visibility changed. Could be 'this' or an ancestor view.
visibility	The new visibility of changedView: `VISIBLE`, `INVISIBLE` or `GONE`.

protected boolean verifyDrawable (Drawable who)

Since: API Level 1

If your view subclass is displaying its own Drawable objects, it should override this function and return true for any Drawable it is displaying. This allows animations for those drawables to be scheduled.

Be sure to call through to the super class when overriding this function.

Parameters

who	The Drawable to verify. Return true if it is one you are displaying, else return the result of calling through to the super class.

Returns

boolean If true than the Drawable is being displayed in the view; else false and it is not allowed to animate.

Interfaces

Classes

Enums

Exceptions

ProgressBar

Class Overview

Summary

XML Attributes

android:progressBarStyle

Related Methods

android:progressBarStyleHorizontal

Related Methods

android:progressBarStyleLarge

Related Methods

android:progressBarStyleSmall

Related Methods

Public Constructors

public ProgressBar (Context context)

Parameters

public ProgressBar (Context context, AttributeSet attrs)

public ProgressBar (Context context, AttributeSet attrs, int defStyle)

Public Methods

public Drawable getIndeterminateDrawable ()

Returns

See Also

public Interpolator getInterpolator ()

Returns

public synchronized int getMax ()

Returns

See Also

public synchronized int getProgress ()

Returns

See Also

public Drawable getProgressDrawable ()

Returns

See Also

public synchronized int getSecondaryProgress ()

Returns

See Also

public final synchronized void incrementProgressBy (int diff)

Parameters

See Also

public final synchronized void incrementSecondaryProgressBy (int diff)

Parameters

See Also

public void invalidateDrawable (Drawable dr)

Parameters

public synchronized boolean isIndeterminate ()

Returns

public void onRestoreInstanceState (Parcelable state)

Parameters

public Parcelable onSaveInstanceState ()

Returns

public void postInvalidate ()

public synchronized void setIndeterminate (boolean indeterminate)

Parameters

public void setIndeterminateDrawable (Drawable d)

Parameters

See Also

public void setInterpolator (Context context, int resID)

Parameters

public void setInterpolator (Interpolator interpolator)

Parameters

public synchronized void setMax (int max)

Parameters

See Also

public synchronized void setProgress (int progress)

Parameters

See Also

public void setProgressDrawable (Drawable d)

Parameters

See Also

public synchronized void setSecondaryProgress (int secondaryProgress)

Parameters

See Also

public void setVisibility (int v)

Parameters

Protected Methods

protected void drawableStateChanged ()

protected void onAttachedToWindow ()