KProgressHUD (kprogresshud 1.2.0 API)

java.lang.Object
- com.kaopiz.kprogresshud.KProgressHUD

public class KProgressHUD
extends java.lang.Object

ネストされたクラスの概要

ネストされたクラス
修飾子とタイプクラス説明

static class KProgressHUD.Style

ネストされたクラス
修飾子とタイプ	クラス	説明
`static class`	`KProgressHUD.Style`

コンストラクタの概要

コンストラクタ
コンストラクタ説明

KProgressHUD(android.content.Context context)

コンストラクタ
コンストラクタ	説明
`KProgressHUD(android.content.Context context)`

メソッドの概要

すべてのメソッド staticメソッドインスタンス・メソッド concreteメソッド推奨されていないメソッド
修飾子とタイプ	メソッド	説明
`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. specify the HUD style (if you use a custom view, you need `KProgressHUD.create(Context context)`).
`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) Setting a cancelable to true with this method will set a null callback, clearing any callback previously set with `setCancellable(DialogInterface.OnCancelListener)`
`KProgressHUD`	`setCancellable(android.content.DialogInterface.OnCancelListener listener)`	Specify a callback to run when using the back button (default is null)
`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)`	推奨されていません。 As of release 1.1.0, replaced by `setBackgroundColor(int)`
`KProgressHUD`	`show()`

クラスから継承されたメソッド java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- コンストラクタの詳細
  - KProgressHUD
```
public KProgressHUD(android.content.Context context)
```
- メソッドの詳細
  - create
```
public static KProgressHUD create(android.content.Context context)
```
    Create a new HUD. Have the same effect as the constructor. For convenient only.
    
    パラメータ:
    
    context - Activity context that the HUD bound to
    
    戻り値:
    
    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)).
    
    パラメータ:
    
    context - Activity context that the HUD bound to
    
    style - One of the KProgressHUD.Style values
    
    戻り値:
    
    An unique HUD instance
  - setStyle
```
public KProgressHUD setStyle(KProgressHUD.Style style)
```
    Specify the HUD style (not needed if you use a custom view)
    
    パラメータ:
    
    style - One of the KProgressHUD.Style values
    
    戻り値:
    
    Current HUD
  - setDimAmount
```
public KProgressHUD setDimAmount(float dimAmount)
```
    Specify the dim area around the HUD, like in Dialog
    
    パラメータ:
    
    dimAmount - May take value from 0 to 1. Default to 0 (no dimming)
    
    戻り値:
    
    Current HUD
  - setSize
```
public KProgressHUD setSize(int width,
                            int height)
```
    Set HUD size. If not the HUD view will use WRAP_CONTENT instead
    
    パラメータ:
    
    width - in dp
    
    height - in dp
    
    戻り値:
    
    Current HUD
  - setWindowColor
```
@Deprecated
public KProgressHUD setWindowColor(int color)
```
    推奨されていません。
    As of release 1.1.0, replaced by setBackgroundColor(int)
    
    パラメータ:
    
    color - ARGB color
    
    戻り値:
    
    Current HUD
  - setBackgroundColor
```
public KProgressHUD setBackgroundColor(int color)
```
    Specify the HUD background color
    
    パラメータ:
    
    color - ARGB color
    
    戻り値:
    
    Current HUD
  - setCornerRadius
```
public KProgressHUD setCornerRadius(float radius)
```
    Specify corner radius of the HUD (default is 10)
    
    パラメータ:
    
    radius - Corner radius in dp
    
    戻り値:
    
    Current HUD
  - setAnimationSpeed
```
public KProgressHUD setAnimationSpeed(int scale)
```
    Change animation speed relative to default. Used with indeterminate style
    
    パラメータ:
    
    scale - Default is 1. If you want double the speed, set the param at 2.
    
    戻り値:
    
    Current HUD
  - setLabel
```
public KProgressHUD setLabel(java.lang.String label)
```
    Optional label to be displayed.
    
    戻り値:
    
    Current HUD
  - setLabel
```
public KProgressHUD setLabel(java.lang.String label,
                             int color)
```
    Optional label to be displayed
    
    戻り値:
    
    Current HUD
  - setDetailsLabel
```
public KProgressHUD setDetailsLabel(java.lang.String detailsLabel)
```
    Optional detail description to be displayed on the HUD
    
    戻り値:
    
    Current HUD
  - setDetailsLabel
```
public KProgressHUD setDetailsLabel(java.lang.String detailsLabel,
                                    int color)
```
    Optional detail description to be displayed
    
    戻り値:
    
    Current HUD
  - setMaxProgress
```
public KProgressHUD setMaxProgress(int maxProgress)
```
    Max value for use in one of the determinate styles
    
    戻り値:
    
    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.
    
    パラメータ:
    
    view - Must not be null
    
    戻り値:
    
    Current HUD
  - setCancellable
```
public KProgressHUD setCancellable(boolean isCancellable)
```
    Specify whether this HUD can be cancelled by using back button (default is false) Setting a cancelable to true with this method will set a null callback, clearing any callback previously set with setCancellable(DialogInterface.OnCancelListener)
    
    戻り値:
    
    Current HUD
  - setCancellable
```
public KProgressHUD setCancellable(android.content.DialogInterface.OnCancelListener listener)
```
    Specify a callback to run when using the back button (default is null)
    
    パラメータ:
    
    listener - The code that will run if the user presses the back button. If you pass null, the dialog won't be cancellable, just like if you had called setCancellable(boolean) passing false.
    
    戻り値:
    
    Current HUD
  - setAutoDismiss
```
public KProgressHUD setAutoDismiss(boolean isAutoDismiss)
```
    Specify whether this HUD closes itself if progress reaches max. Default is true.
    
    戻り値:
    
    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).
    
    パラメータ:
    
    graceTimeMs - Grace time in milliseconds
    
    戻り値:
    
    Current HUD
  - show
```
public KProgressHUD show()
```
  - isShowing
```
public boolean isShowing()
```
  - dismiss
```
public void dismiss()
```

クラス KProgressHUD

ネストされたクラスの概要

コンストラクタの概要

メソッドの概要

クラスから継承されたメソッド java.lang.Object

コンストラクタの詳細

KProgressHUD

メソッドの詳細

create

create

setStyle

setDimAmount

setSize

setWindowColor

setBackgroundColor

setCornerRadius

setAnimationSpeed

setLabel

setLabel

setDetailsLabel

setDetailsLabel

setMaxProgress

setProgress

setCustomView

setCancellable

setCancellable

setAutoDismiss

setGraceTime

show

isShowing

dismiss