com.beardedhen.androidbootstrap

Class BootstrapProgressBar

java.lang.Object

View

com.beardedhen.androidbootstrap.BootstrapProgressBar

All Implemented Interfaces:

BootstrapBrandView, BootstrapSizeView, ProgressView, RoundableView

public class BootstrapProgressBar
extends View
implements ProgressView, BootstrapBrandView, RoundableView, BootstrapSizeView

BootstrapProgressBar displays determinate progress to the user, and is colored with BootstrapBrands. Striped effects and progress update animations are supported out of the box.

Field Summary

Fields inherited from interface com.beardedhen.androidbootstrap.api.view.ProgressView

KEY_ANIMATED, KEY_DRAWN_PROGRESS, KEY_STRIPED, KEY_USER_PROGRESS

Fields inherited from interface com.beardedhen.androidbootstrap.api.view.BootstrapBrandView

KEY

Fields inherited from interface com.beardedhen.androidbootstrap.api.view.RoundableView

KEY

Fields inherited from interface com.beardedhen.androidbootstrap.api.view.BootstrapSizeView

KEY

Constructor Summary

Constructors

Constructor and Description
BootstrapProgressBar(Context context)
BootstrapProgressBar(Context context, AttributeSet attrs)
BootstrapProgressBar(Context context, AttributeSet attrs, int defStyleAttr)

Method Summary

Modifier and Type	Method and Description
BootstrapBrand	getBootstrapBrand()
float	getBootstrapSize() Retrieves the scale factor that should be used to scale a view from its baseline size.
int	getProgress()
boolean	isAnimated()
boolean	isRounded()
boolean	isStriped()
protected void	onDraw(Canvas canvas)
protected void	onMeasure(int widthMeasureSpec, int heightMeasureSpec)
void	onRestoreInstanceState(Parcelable state)
Parcelable	onSaveInstanceState()
protected void	onSizeChanged(int w, int h, int oldw, int oldh)
void	setAnimated(boolean animated) Sets whether the view should animate itself.
void	setBootstrapBrand(BootstrapBrand bootstrapBrand) Changes the color of the view to match the given Bootstrap Brand
void	setBootstrapSize(DefaultBootstrapSize bootstrapSize) Convenience method that sets the scale factor using a default bootstrap size enum value.
void	setBootstrapSize(float bootstrapSize) Sets the scale factor that should be used to scale a view from its baseline size.
void	setProgress(int progress) Updates the amount of progress displayed to the user.
void	setRounded(boolean rounded) Sets whether the view should display rounded corners or not
void	setStriped(boolean striped) Sets whether the view should display a striped pattern.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

BootstrapProgressBar

public BootstrapProgressBar(Context context)

BootstrapProgressBar

public BootstrapProgressBar(Context context,
                            AttributeSet attrs)

BootstrapProgressBar

public BootstrapProgressBar(Context context,
                            AttributeSet attrs,
                            int defStyleAttr)

Method Detail

onSaveInstanceState

public Parcelable onSaveInstanceState()

onRestoreInstanceState

public void onRestoreInstanceState(Parcelable state)

onMeasure

protected void onMeasure(int widthMeasureSpec,
                         int heightMeasureSpec)

onSizeChanged

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

onDraw

protected void onDraw(Canvas canvas)

setProgress

public void setProgress(int progress)

Description copied from interface: ProgressView

Updates the amount of progress displayed to the user.

Specified by:

setProgress in interface ProgressView

Parameters:

progress - an integer between 0-100

getProgress

public int getProgress()

Specified by:

getProgress in interface ProgressView

Returns:

the amount of progress displayed to the user (0-100)

setStriped

public void setStriped(boolean striped)

Description copied from interface: ProgressView

Sets whether the view should display a striped pattern.

Specified by:

setStriped in interface ProgressView

Parameters:

striped - true for a striped pattern, false for a plain pattern

isStriped

public boolean isStriped()

Specified by:

isStriped in interface ProgressView

Returns:

true if the view is displaying a striped pattern, otherwise false

setAnimated

public void setAnimated(boolean animated)

Description copied from interface: ProgressView

Sets whether the view should animate itself. If the view is striped, the animation will run in an infinite loop; if the view is not striped, the animation will only be visible when setProgress() is called.

Specified by:

setAnimated in interface ProgressView

Parameters:

animated - whether the view should animate its updates or not.

isAnimated

public boolean isAnimated()

Specified by:

isAnimated in interface ProgressView

Returns:

true if the view should animate itself

setBootstrapBrand

public void setBootstrapBrand(@NonNull
                              BootstrapBrand bootstrapBrand)

Description copied from interface: BootstrapBrandView

Changes the color of the view to match the given Bootstrap Brand

Specified by:

setBootstrapBrand in interface BootstrapBrandView

Parameters:

bootstrapBrand - the Bootstrap Brand

getBootstrapBrand

@NonNull
public BootstrapBrand getBootstrapBrand()

Specified by:

getBootstrapBrand in interface BootstrapBrandView

Returns:

the current Bootstrap Brand

setRounded

public void setRounded(boolean rounded)

Description copied from interface: RoundableView

Sets whether the view should display rounded corners or not

Specified by:

setRounded in interface RoundableView

Parameters:

rounded - whether the view should be rounded

isRounded

public boolean isRounded()

Specified by:

isRounded in interface RoundableView

Returns:

true if the view is displaying rounded corners, otherwise false

getBootstrapSize

public float getBootstrapSize()

Description copied from interface: BootstrapSizeView

Retrieves the scale factor that should be used to scale a view from its baseline size. For example, specifying that a Button should use a scale factor of 2.0 may increase its padding and font size by that factor.

Specified by:

getBootstrapSize in interface BootstrapSizeView

Returns:

the scale factor

setBootstrapSize

public void setBootstrapSize(float bootstrapSize)

Description copied from interface: BootstrapSizeView

Sets the scale factor that should be used to scale a view from its baseline size. For example, specifying that a Button should use a scale factor of 2.0 may increase its padding and font size by that factor.

Specified by:

setBootstrapSize in interface BootstrapSizeView

Parameters:

bootstrapSize - the scale factor

setBootstrapSize

public void setBootstrapSize(DefaultBootstrapSize bootstrapSize)

Description copied from interface: BootstrapSizeView

Convenience method that sets the scale factor using a default bootstrap size enum value.

Specified by:

setBootstrapSize in interface BootstrapSizeView

Parameters:

bootstrapSize - a default scale factor