com.kaopiz.kprogresshud

Class KProgressHUD

java.lang.Object

com.kaopiz.kprogresshud.KProgressHUD

public class KProgressHUD
extends java.lang.Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	KProgressHUD.Style

Constructor Summary

Constructors

Constructor and Description
KProgressHUD(android.content.Context context)

Method Summary

Modifier and Type	Method and Description
static KProgressHUD	create(android.content.Context context) Create a new HUD.
static KProgressHUD	create(android.content.Context context, KProgressHUD.Style style) Create a new HUD.
void	dismiss()
boolean	isShowing()
KProgressHUD	setAnimationSpeed(int scale) Change animation speed relative to default.
KProgressHUD	setAutoDismiss(boolean isAutoDismiss) Specify whether this HUD closes itself if progress reaches max.
KProgressHUD	setBackgroundColor(int color) Specify the HUD background color
KProgressHUD	setCancellable(boolean isCancellable) Specify whether this HUD can be cancelled by using back button (default is false)
KProgressHUD	setCornerRadius(float radius) Specify corner radius of the HUD (default is 10)
KProgressHUD	setCustomView(android.view.View view) Provide a custom view to be displayed.
KProgressHUD	setDetailsLabel(java.lang.String detailsLabel) Optional detail description to be displayed on the HUD
KProgressHUD	setDetailsLabel(java.lang.String detailsLabel, int color) Optional detail description to be displayed
KProgressHUD	setDimAmount(float dimAmount) Specify the dim area around the HUD, like in Dialog
KProgressHUD	setGraceTime(int graceTimeMs) Grace period is the time (in milliseconds) that the invoked method may be run without showing the HUD.
KProgressHUD	setLabel(java.lang.String label) Optional label to be displayed.
KProgressHUD	setLabel(java.lang.String label, int color) Optional label to be displayed
KProgressHUD	setMaxProgress(int maxProgress) Max value for use in one of the determinate styles
void	setProgress(int progress) Set current progress.
KProgressHUD	setSize(int width, int height) Set HUD size.
KProgressHUD	setStyle(KProgressHUD.Style style) Specify the HUD style (not needed if you use a custom view)
KProgressHUD	setWindowColor(int color) Deprecated. As of release 1.1.0, replaced by setBackgroundColor(int)
KProgressHUD	show()

Methods inherited from class java.lang.Object

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

Constructor Detail

KProgressHUD

public KProgressHUD(android.content.Context context)

Method Detail

create

public static KProgressHUD create(android.content.Context context)

Create a new HUD. Have the same effect as the constructor. For convenient only.

Parameters:

context - Activity context that the HUD bound to

Returns:

An unique HUD instance

create

public static KProgressHUD create(android.content.Context context,
                                  KProgressHUD.Style style)

Create a new HUD. specify the HUD style (if you use a custom view, you need KProgressHUD.create(Context context)).

Parameters:

context - Activity context that the HUD bound to

style - One of the KProgressHUD.Style values

Returns:

An unique HUD instance

setStyle

public KProgressHUD setStyle(KProgressHUD.Style style)

Specify the HUD style (not needed if you use a custom view)

Parameters:

style - One of the KProgressHUD.Style values

Returns:

Current HUD

setDimAmount

public KProgressHUD setDimAmount(float dimAmount)

Specify the dim area around the HUD, like in Dialog

Parameters:

dimAmount - May take value from 0 to 1. Default to 0 (no dimming)

Returns:

Current HUD

setSize

public KProgressHUD setSize(int width,
                            int height)

Set HUD size. If not the HUD view will use WRAP_CONTENT instead

Parameters:

width - in dp

height - in dp

Returns:

Current HUD

setWindowColor

@Deprecated
public KProgressHUD setWindowColor(int color)

Deprecated. As of release 1.1.0, replaced by setBackgroundColor(int)

Parameters:

color - ARGB color

Returns:

Current HUD

setBackgroundColor

public KProgressHUD setBackgroundColor(int color)

Specify the HUD background color

Parameters:

color - ARGB color

Returns:

Current HUD

setCornerRadius

public KProgressHUD setCornerRadius(float radius)

Specify corner radius of the HUD (default is 10)

Parameters:

radius - Corner radius in dp

Returns:

Current HUD

setAnimationSpeed

public KProgressHUD setAnimationSpeed(int scale)

Change animation speed relative to default. Used with indeterminate style

Parameters:

scale - Default is 1. If you want double the speed, set the param at 2.

Returns:

Current HUD

setLabel

public KProgressHUD setLabel(java.lang.String label)

Optional label to be displayed.

Returns:

Current HUD

setLabel

public KProgressHUD setLabel(java.lang.String label,
                             int color)

Optional label to be displayed

Returns:

Current HUD

setDetailsLabel

public KProgressHUD setDetailsLabel(java.lang.String detailsLabel)

Optional detail description to be displayed on the HUD

Returns:

Current HUD

setDetailsLabel

public KProgressHUD setDetailsLabel(java.lang.String detailsLabel,
                                    int color)

Optional detail description to be displayed

Returns:

Current HUD

setMaxProgress

public KProgressHUD setMaxProgress(int maxProgress)

Max value for use in one of the determinate styles

Returns:

Current HUD

setProgress

public void setProgress(int progress)

Set current progress. Only have effect when use with a determinate style, or a custom view which implements Determinate interface.

setCustomView

public KProgressHUD setCustomView(android.view.View view)

Provide a custom view to be displayed.

Parameters:

view - Must not be null

Returns:

Current HUD

setCancellable

public KProgressHUD setCancellable(boolean isCancellable)

Specify whether this HUD can be cancelled by using back button (default is false)

Returns:

Current HUD

setAutoDismiss

public KProgressHUD setAutoDismiss(boolean isAutoDismiss)

Specify whether this HUD closes itself if progress reaches max. Default is true.

Returns:

Current HUD

setGraceTime

public KProgressHUD setGraceTime(int graceTimeMs)

Grace period is the time (in milliseconds) that the invoked method may be run without showing the HUD. If the task finishes before the grace time runs out, the HUD will not be shown at all. This may be used to prevent HUD display for very short tasks. Defaults to 0 (no grace time).

Parameters:

graceTimeMs - Grace time in milliseconds

Returns:

Current HUD

show

public KProgressHUD show()

isShowing

public boolean isShowing()

dismiss

public void dismiss()