universum.studios.android.ui.graphics.drawable

Class RefreshDrawable

java.lang.Object

android.graphics.drawable.Drawable

universum.studios.android.ui.graphics.drawable.DrawableWrapper

universum.studios.android.ui.graphics.drawable.RefreshDrawable

All Implemented Interfaces:

android.graphics.drawable.Animatable, android.graphics.drawable.Drawable.Callback

public class RefreshDrawable
extends DrawableWrapper
implements android.graphics.drawable.Animatable

This drawable wraps background drawable with CircularProgressDrawable into the one drawable which can be used to show indicator for running refresh operation for some collection view like ListView or GridView at its top edge.

All necessary methods of the CircularProgressDrawable are delegated by this RefreshDrawable class to support some customization of the progress drawable, like its thickness, radius, colors and more.

Author:

Martin Albedinsky

Nested Class Summary

Nested classes/interfaces inherited from class android.graphics.drawable.Drawable

android.graphics.drawable.Drawable.Callback, android.graphics.drawable.Drawable.ConstantState

Constructor Summary

Constructors

Constructor and Description
RefreshDrawable() Creates a new instance of RefreshDrawable to wrap CircularProgressDrawable and background drawable into one drawable.

Method Summary

Modifier and Type	Method and Description
void	draw(android.graphics.Canvas canvas)
android.graphics.drawable.Drawable	getBackground() Returns the background of this refresh drawable.
android.graphics.drawable.Drawable	getCurrent() Returns this drawable instance.
android.graphics.drawable.Drawable	getDrawable() This is not supported operation.
int	getIntrinsicHeight()
int	getIntrinsicWidth()
int	getProgress() Delegate method for ProgressDrawable.getProgress().
int	getProgressAlpha() Delegate method for ProgressDrawable.getAlpha().
float	getProgressArrowScale() Delegate method for CircularProgressDrawable.getArrowScale().
int	getProgressColor() Delegate method for ProgressDrawable.getColor().
int[]	getProgressColors() Delegate method for ProgressDrawable.getColors().
float	getProgressIndeterminateSpeed() Delegate method for ProgressDrawable.getIndeterminateSpeed().
int	getProgressMode() Delegate method for CircularProgressDrawable.getMode().
int	getProgressRadius() Returns radius of the progress arc.
float	getProgressRotation() Delegate method for CircularProgressDrawable.getRotation().
float	getProgressThickness() Delegate method for ProgressDrawable.getThickness().
boolean	isInEditMode() Returns flag indicating whether this drawable draws its graphics in edit mode or not.
boolean	isProgressArrowVisible() Delegate method for CircularProgressDrawable.isArrowVisible().
boolean	isProgressMultiColored() Delegate method for ProgressDrawable.isMultiColored().
boolean	isProgressRounded() Delegate method for ProgressDrawable.isRounded().
boolean	isRunning() Delegate method for ProgressDrawable.isRunning().
protected void	onBoundsChange(android.graphics.Rect bounds)
void	setAlpha(int alpha)
void	setBackground(android.graphics.drawable.Drawable background) Sets the background for this refresh drawable.
void	setInEditMode(boolean inEditMode) Sets a boolean flag determining whether this drawable should draw its graphics in edit (preview) mode or not.
void	setProgress(int progress) Delegate method for ProgressDrawable.setProgress(int).
void	setProgressAlpha(int alpha) Delegate method for ProgressDrawable.setAlpha(int).
void	setProgressArrowScale(float scale) Delegate method for CircularProgressDrawable.setArrowScale(float).
void	setProgressArrowVisible(boolean visible) Delegate method for CircularProgressDrawable.setArrowVisible(boolean).
void	setProgressColor(int color) Delegate method for ProgressDrawable.setColor(int).
void	setProgressColors(int[] colors) Delegate method for ProgressDrawable.setColors(int[]).
void	setProgressIndeterminateSpeed(float speed) Delegate method for ProgressDrawable.setIndeterminateSpeed(float).
void	setProgressMode(int mode) Delegate method for CircularProgressDrawable.setMode(int).
void	setProgressMultiColored(boolean multiColored) Delegate method for ProgressDrawable.setMultiColored(boolean).
void	setProgressRadius(int radius) Sets the radius of the progress arc.
void	setProgressRotation(float rotation) Delegate method for CircularProgressDrawable.setRotation(float).
void	setProgressRounded(boolean rounded) Delegate method for ProgressDrawable.setRounded(boolean).
void	setProgressThickness(float thickness) Delegate method for ProgressDrawable.setThickness(float).
void	start() Delegate method for ProgressDrawable.start().
void	stop() Delegate method for ProgressDrawable.stop().
void	stopImmediate() Delegate method for ProgressDrawable.stopImmediate().

Methods inherited from class universum.studios.android.ui.graphics.drawable.DrawableWrapper

applyTheme, attachCallback, canApplyTheme, getAlpha, getChangingConfigurations, getColorFilter, getConstantState, getDirtyBounds, getHotspotBounds, getMinimumHeight, getMinimumWidth, getOpacity, getOutline, getPadding, getTransparentRegion, inflate, inflate, invalidateDrawable, isAutoMirrored, isFilterBitmap, isStateful, jumpToCurrentState, mutate, onLayoutDirectionChanged, onLevelChange, onStateChange, scheduleDrawable, setAutoMirrored, setChangingConfigurations, setColorFilter, setDither, setFilterBitmap, setHotspot, setHotspotBounds, setTint, setTintList, setTintMode, setVisible, unscheduleDrawable

Methods inherited from class android.graphics.drawable.Drawable

clearColorFilter, copyBounds, copyBounds, createFromPath, createFromResourceStream, createFromResourceStream, createFromStream, createFromXml, createFromXml, createFromXmlInner, createFromXmlInner, getBounds, getCallback, getLayoutDirection, getLevel, getOpticalInsets, getState, invalidateSelf, isProjected, isVisible, resolveOpacity, scheduleSelf, setBounds, setBounds, setCallback, setColorFilter, setLayoutDirection, setLevel, setState, setTintBlendMode, unscheduleSelf

Methods inherited from class java.lang.Object

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

Constructor Detail

RefreshDrawable

public RefreshDrawable()

Creates a new instance of RefreshDrawable to wrap CircularProgressDrawable and background drawable into one drawable.

Method Detail

setInEditMode

public final void setInEditMode(boolean inEditMode)

Sets a boolean flag determining whether this drawable should draw its graphics in edit (preview) mode or not.

Parameters:

inEditMode - True to draw graphics in edit mode, false otherwise.

See Also:

isInEditMode(), View.isInEditMode()

isInEditMode

public final boolean isInEditMode()

Returns flag indicating whether this drawable draws its graphics in edit mode or not.

Returns:

True if graphics is drawn in edit (preview) mode, false otherwise.

draw

public void draw(android.graphics.Canvas canvas)

Overrides:

draw in class DrawableWrapper

start

public void start()

Delegate method for ProgressDrawable.start().

Specified by:

start in interface android.graphics.drawable.Animatable

stop

public void stop()

Delegate method for ProgressDrawable.stop().

Specified by:

stop in interface android.graphics.drawable.Animatable

stopImmediate

public void stopImmediate()

Delegate method for ProgressDrawable.stopImmediate().

isRunning

public boolean isRunning()

Delegate method for ProgressDrawable.isRunning().

Specified by:

isRunning in interface android.graphics.drawable.Animatable

getCurrent

@NonNull
public android.graphics.drawable.Drawable getCurrent()

Returns this drawable instance.

Overrides:

getCurrent in class DrawableWrapper

getDrawable

@NonNull
public android.graphics.drawable.Drawable getDrawable()

This is not supported operation.

Overrides:

getDrawable in class DrawableWrapper

Returns:

Wrapped drawable.

Throws:

UnsupportedOperationException

setBackground

public void setBackground(@Nullable
                          android.graphics.drawable.Drawable background)

Sets the background for this refresh drawable.

Parameters:

background - The desired background.

getBackground

@Nullable
public android.graphics.drawable.Drawable getBackground()

Returns the background of this refresh drawable.

Returns:

Background drawable or null if this refresh drawable does not have background set.

getIntrinsicWidth

public int getIntrinsicWidth()

Overrides:

getIntrinsicWidth in class DrawableWrapper

getIntrinsicHeight

public int getIntrinsicHeight()

Overrides:

getIntrinsicHeight in class DrawableWrapper

setAlpha

public void setAlpha(int alpha)

Overrides:

setAlpha in class DrawableWrapper

setProgressAlpha

public void setProgressAlpha(int alpha)

Delegate method for ProgressDrawable.setAlpha(int).

setProgressRadius

public void setProgressRadius(@Px
                              int radius)

Sets the radius of the progress arc.

Parameters:

radius - The desired radius.

See Also:

getProgressRadius()

getProgressRadius

@Px
public int getProgressRadius()

Returns radius of the progress arc.

Returns:

Progress arc's radius.

See Also:

setProgressRadius(int)

getProgressAlpha

public int getProgressAlpha()

Delegate method for ProgressDrawable.getAlpha().

setProgressMode

public void setProgressMode(int mode)

Delegate method for CircularProgressDrawable.setMode(int).

See Also:

getProgressMode()

getProgressMode

public int getProgressMode()

Delegate method for CircularProgressDrawable.getMode().

See Also:

setProgressMode(int)

setProgress

public void setProgress(int progress)

Delegate method for ProgressDrawable.setProgress(int).

See Also:

getProgress()

getProgress

public int getProgress()

Delegate method for ProgressDrawable.getProgress().

See Also:

setProgress(int)

setProgressRotation

public void setProgressRotation(float rotation)

Delegate method for CircularProgressDrawable.setRotation(float).

See Also:

getProgressRotation()

getProgressRotation

public float getProgressRotation()

Delegate method for CircularProgressDrawable.getRotation().

See Also:

setProgressRotation(float)

setProgressThickness

public void setProgressThickness(float thickness)

Delegate method for ProgressDrawable.setThickness(float).

See Also:

getProgressThickness()

getProgressThickness

public float getProgressThickness()

Delegate method for ProgressDrawable.getThickness().

See Also:

setProgressThickness(float)

setProgressColor

public void setProgressColor(int color)

Delegate method for ProgressDrawable.setColor(int).

See Also:

getProgressColor()

getProgressColor

public int getProgressColor()

Delegate method for ProgressDrawable.getColor().

See Also:

setProgressColor(int)

setProgressColors

public void setProgressColors(int[] colors)

Delegate method for ProgressDrawable.setColors(int[]).

See Also:

getProgressColors()

getProgressColors

public int[] getProgressColors()

Delegate method for ProgressDrawable.getColors().

See Also:

setProgressColors(int[])

setProgressMultiColored

public void setProgressMultiColored(boolean multiColored)

Delegate method for ProgressDrawable.setMultiColored(boolean).

See Also:

isProgressMultiColored()

isProgressMultiColored

public boolean isProgressMultiColored()

Delegate method for ProgressDrawable.isMultiColored().

See Also:

setProgressMultiColored(boolean)

setProgressRounded

public void setProgressRounded(boolean rounded)

Delegate method for ProgressDrawable.setRounded(boolean).

See Also:

isProgressRounded()

isProgressRounded

public boolean isProgressRounded()

Delegate method for ProgressDrawable.isRounded().

See Also:

setProgressRounded(boolean)

setProgressArrowVisible

public void setProgressArrowVisible(boolean visible)

Delegate method for CircularProgressDrawable.setArrowVisible(boolean).

See Also:

isProgressArrowVisible()

isProgressArrowVisible

public boolean isProgressArrowVisible()

Delegate method for CircularProgressDrawable.isArrowVisible().

See Also:

setProgressArrowVisible(boolean)

setProgressArrowScale

public void setProgressArrowScale(float scale)

Delegate method for CircularProgressDrawable.setArrowScale(float).

See Also:

getProgressArrowScale()

getProgressArrowScale

public float getProgressArrowScale()

Delegate method for CircularProgressDrawable.getArrowScale().

See Also:

setProgressArrowScale(float)

setProgressIndeterminateSpeed

public void setProgressIndeterminateSpeed(float speed)

Delegate method for ProgressDrawable.setIndeterminateSpeed(float).

See Also:

getProgressIndeterminateSpeed()

getProgressIndeterminateSpeed

public float getProgressIndeterminateSpeed()

Delegate method for ProgressDrawable.getIndeterminateSpeed().

See Also:

setProgressIndeterminateSpeed(float)

onBoundsChange

protected void onBoundsChange(android.graphics.Rect bounds)

Overrides:

onBoundsChange in class DrawableWrapper