see 03/03 log

Author: Blankj

utilcode/src/main/java/com/blankj/utilcode/util/SnackbarUtils.java

@@ -23,7 +23,7 @@
  *     author: Blankj
  *     blog  : http://blankj.com
  *     time  : 2016/10/16
- *     desc  : Snackbar 相关工具类
+ *     desc  : utils about snackbar
  * </pre>
  */
 public final class SnackbarUtils {
@@ -45,7 +45,7 @@ public final class SnackbarUtils {
 
     private static WeakReference<Snackbar> sReference;
 
-    private View                 parent;
+    private View                 view;
     private CharSequence         message;
     private int                  messageColor;
     private int                  bgColor;
@@ -58,7 +58,7 @@ public final class SnackbarUtils {
 
     private SnackbarUtils(final View parent) {
         setDefault();
-        this.parent = parent;
+        this.view = parent;
     }
 
     private void setDefault() {
@@ -73,94 +73,94 @@ private void setDefault() {
     }
 
     /**
-     * 设置 snackbar 依赖 view
+     * Set the view to find a parent from.
      *
-     * @param parent 依赖 view
-     * @return {@link SnackbarUtils}
+     * @param view The view to find a parent from.
+     * @return the single {@link SnackbarUtils} instance
      */
-    public static SnackbarUtils with(@NonNull final View parent) {
-        return new SnackbarUtils(parent);
+    public static SnackbarUtils with(@NonNull final View view) {
+        return new SnackbarUtils(view);
     }
 
     /**
-     * 设置消息
+     * Set the message.
      *
-     * @param msg 消息
-     * @return {@link SnackbarUtils}
+     * @param msg The message.
+     * @return the single {@link SnackbarUtils} instance
      */
     public SnackbarUtils setMessage(@NonNull final CharSequence msg) {
         this.message = msg;
         return this;
     }
 
     /**
-     * 设置消息颜色
+     * Set the color of message.
      *
-     * @param color 颜色
-     * @return {@link SnackbarUtils}
+     * @param color The color of message.
+     * @return the single {@link SnackbarUtils} instance
      */
     public SnackbarUtils setMessageColor(@ColorInt final int color) {
         this.messageColor = color;
         return this;
     }
 
     /**
-     * 设置背景色
+     * Set the color of background.
      *
-     * @param color 背景色
-     * @return {@link SnackbarUtils}
+     * @param color The color of background.
+     * @return the single {@link SnackbarUtils} instance
      */
     public SnackbarUtils setBgColor(@ColorInt final int color) {
         this.bgColor = color;
         return this;
     }
 
     /**
-     * 设置背景资源
+     * Set the resource of background.
      *
-     * @param bgResource 背景资源
-     * @return {@link SnackbarUtils}
+     * @param bgResource The resource of background.
+     * @return the single {@link SnackbarUtils} instance
      */
     public SnackbarUtils setBgResource(@DrawableRes final int bgResource) {
         this.bgResource = bgResource;
         return this;
     }
 
     /**
-     * 设置显示时长
+     * Set the duration.
      *
-     * @param duration 时长
+     * @param duration The duration.
      *                 <ul>
-     *                 <li>{@link Duration#LENGTH_INDEFINITE}永久</li>
-     *                 <li>{@link Duration#LENGTH_SHORT}短时</li>
-     *                 <li>{@link Duration#LENGTH_LONG}长时</li>
+     *                 <li>{@link Duration#LENGTH_INDEFINITE}</li>
+     *                 <li>{@link Duration#LENGTH_SHORT     }</li>
+     *                 <li>{@link Duration#LENGTH_LONG      }</li>
      *                 </ul>
-     * @return {@link SnackbarUtils}
+     * @return the single {@link SnackbarUtils} instance
      */
     public SnackbarUtils setDuration(@Duration final int duration) {
         this.duration = duration;
         return this;
     }
 
     /**
-     * 设置行为
+     * Set the action.
      *
-     * @param text     文本
-     * @param listener 事件
-     * @return {@link SnackbarUtils}
+     * @param text     The text.
+     * @param listener The click listener.
+     * @return the single {@link SnackbarUtils} instance
      */
     public SnackbarUtils setAction(@NonNull final CharSequence text,
                                    @NonNull final View.OnClickListener listener) {
         return setAction(text, COLOR_DEFAULT, listener);
     }
 
     /**
-     * 设置行为
+     * Set the action.
      *
-     * @param text     文本
-     * @param color    文本颜色
-     * @param listener 事件
-     * @return {@link SnackbarUtils}
+     * @param text     The text.
+     * @param color    The color of text.
+     * @param listener The click listener.
+     * @return the single {@link SnackbarUtils} instance
      */
 
     public SnackbarUtils setAction(@NonNull final CharSequence text,
@@ -173,20 +173,20 @@ public SnackbarUtils setAction(@NonNull final CharSequence text,
     }
 
     /**
-     * 设置底边距
+     * Set the bottom margin.
      *
-     * @param bottomMargin 底边距
+     * @param bottomMargin The size of bottom margin, in pixel.
      */
     public SnackbarUtils setBottomMargin(@IntRange(from = 1) final int bottomMargin) {
         this.bottomMargin = bottomMargin;
         return this;
     }
 
     /**
-     * 显示 snackbar
+     * Show the snackbar.
      */
     public void show() {
-        final View view = parent;
+        final View view = this.view;
         if (view == null) return;
         if (messageColor != COLOR_DEFAULT) {
             SpannableString spannableString = new SpannableString(message);
@@ -220,7 +220,7 @@ public void show() {
     }
 
     /**
-     * 显示预设成功的 snackbar
+     * Show the snackbar with success style.
      */
     public void showSuccess() {
         bgColor = COLOR_SUCCESS;
@@ -230,7 +230,7 @@ public void showSuccess() {
     }
 
     /**
-     * 显示预设警告的 snackbar
+     * Show the snackbar with warning style.
      */
     public void showWarning() {
         bgColor = COLOR_WARNING;
@@ -240,7 +240,7 @@ public void showWarning() {
     }
 
     /**
-     * 显示预设错误的 snackbar
+     * Show the snackbar with error style.
      */
     public void showError() {
         bgColor = COLOR_ERROR;
@@ -250,7 +250,7 @@ public void showError() {
     }
 
     /**
-     * 消失 snackbar
+     * Dismiss the snackbar.
      */
     public static void dismiss() {
         if (sReference != null && sReference.get() != null) {
@@ -260,9 +260,9 @@ public static void dismiss() {
     }
 
     /**
-     * 获取 snackbar 视图
+     * Return the view of snackbar.
      *
-     * @return snackbar 视图
+     * @return the view of snackbar
      */
     public static View getView() {
         Snackbar snackbar = sReference.get();
@@ -271,11 +271,11 @@ public static View getView() {
     }
 
     /**
-     * 添加 snackbar 视图
-     * <p>在{@link #show()}之后调用</p>
+     * Add view to the snackbar.
+     * <p>call it after {@link #show()}</p>
      *
-     * @param layoutId 布局文件
-     * @param params   布局参数
+     * @param layoutId The id of layout.
+     * @param params   The params.
      */
     public static void addView(@LayoutRes final int layoutId,
                                @NonNull final ViewGroup.LayoutParams params) {
@@ -289,11 +289,11 @@ public static void addView(@LayoutRes final int layoutId,
     }
 
     /**
-     * 添加 snackbar 视图
-     * <p>在{@link #show()}之后调用</p>
+     * Add view to the snackbar.
+     * <p>call it after {@link #show()}</p>
      *
-     * @param child  要添加的 view
-     * @param params 布局参数
+     * @param child  The child view.
+     * @param params The params.
      */
     public static void addView(@NonNull final View child,
                                @NonNull final ViewGroup.LayoutParams params) {