qijingxi

src/java/net/micode/notes/tool/ResourceParser.java

@@ -14,6 +14,17 @@
  * limitations under the License.
  */
 
+
+ /**     
+  * 
+  * @ProjectName:    minode
+  * @Package:        net.micode.notes.data
+  * @ClassName:      ResourceParser
+  * @Description:    该类用于解析和获取应用中的资源。它定义了多种资源的常量和静态方法，用于获取笔记背景、笔记项
+                     背景、小部件背景和文本样式等资源。通过这些方法，可以方便地根据不同的条件获取相应的资源 ID，
+                     从而在应用中使用这些资源。
+  * @Author:         齐景熙
+ */
 package net.micode.notes.tool;
 
 import android.content.Context;
@@ -42,6 +53,18 @@ public class ResourceParser {
     public static final int BG_DEFAULT_FONT_SIZE = TEXT_MEDIUM;
 
     // 备忘录背景资源类
+
+    /**
+      * @method      NoteBgResources
+      * @description 该内部类用于获取笔记编辑背景和标题背景的资源 ID。
+      * @author:     齐景熙
+    */
+      /*
+功能介绍：该内部类用于获取笔记编辑背景和标题背景的资源 ID。
+成员变量：
+BG_EDIT_RESOURCES：存储不同颜色的笔记编辑背景资源 ID 的数组。
+BG_EDIT_TITLE_RESOURCES：存储不同颜色的笔记编辑标题背景资源 ID 的数组。 */
+
     public static class NoteBgResources {
         private final static int [] BG_EDIT_RESOURCES = new int [] {
             R.drawable.edit_yellow,
@@ -60,17 +83,56 @@ public class ResourceParser {
         };
 
         // 获取备忘录背景资源
+
+   /**
+      * @method      getNoteBgResource
+      * @description 根据传入的 ID 获取笔记编辑背景的资源 ID。通过索引访问 BG_EDIT_RESOURCES 数组，返回对应的资源 ID。
+      * @author:     齐景熙
+    */
+      /*
+功能介绍：根据传入的 ID 获取笔记编辑背景的资源 ID。通过索引访问 BG_EDIT_RESOURCES 数组，返回对应的资源 ID。
+参数：
+id：笔记背景颜色的 ID。
+返回值：笔记编辑背景的资源 ID。
+      */
+
         public static int getNoteBgResource(int id) {
             return BG_EDIT_RESOURCES[id];
         }
 
         // 获取备忘录标题背景资源
+
+  /**
+      * @method      getNoteTitleBgResource
+      * @description 根据传入的 ID 获取笔记编辑标题背景的资源 ID。通过索引访问 BG_EDIT_TITLE_RESOURCES 数组，返回对应的资源 ID。
+      * @author:     齐景熙
+    */
+      /*
+功能介绍：根据传入的 ID 获取笔记编辑标题背景的资源 ID。通过索引访问 BG_EDIT_TITLE_RESOURCES 数组，返回对应的资源 ID。
+参数：
+id：笔记背景颜色的 ID。
+返回值：笔记编辑标题背景的资源 ID。
+      */
+
         public static int getNoteTitleBgResource(int id) {
             return BG_EDIT_TITLE_RESOURCES[id];
         }
     }
 
     // 获取默认背景ID
+
+  /**
+      * @method      getDefaultBgId
+      * @description 获取默认的笔记背景颜色 ID。首先检查是否设置了背景颜色的偏好设置，如果设置了，则随机生成一个背
+                     景颜色 ID；否则，返回默认的背景颜色 ID（黄色）。
+      * @author:     齐景熙
+    */
+      /*
+功能介绍：获取默认的笔记背景颜色 ID。首先检查是否设置了背景颜色的偏好设置，如果设置了，则随机生成一个背景颜色 ID；否则，返回默认的背景颜色 ID（黄色）。
+参数：
+context：上下文对象，用于访问偏好设置。
+返回值：默认的笔记背景颜色 ID。
+      */
     public static int getDefaultBgId(Context context) {
         if (PreferenceManager.getDefaultSharedPreferences(context).getBoolean(
                 NotesPreferenceActivity.PREFERENCE_SET_BG_COLOR_KEY, false)) {
@@ -81,6 +143,21 @@ public class ResourceParser {
     }
 
     // 备忘录项目背景资源类
+
+  /**
+      * @method      NoteItemBgResources
+      * @description 该内部类用于获取笔记项背景的资源 ID。
+      * @author:     齐景熙
+    */
+      /*
+功能介绍：该内部类用于获取笔记项背景的资源 ID。
+成员变量：
+BG_FIRST_RESOURCES：存储不同颜色的笔记项第一个背景资源 ID 的数组。
+BG_NORMAL_RESOURCES：存储不同颜色的笔记项普通背景资源 ID 的数组。
+BG_LAST_RESOURCES：存储不同颜色的笔记项最后一个背景资源 ID 的数组。
+BG_SINGLE_RESOURCES：存储不同颜色的笔记项单个背景资源 ID 的数组。
+      */
+
     public static class NoteItemBgResources {
         private final static int [] BG_FIRST_RESOURCES = new int [] {
             R.drawable.list_yellow_up,
@@ -115,32 +192,117 @@ public class ResourceParser {
         };
 
         // 获取备忘录第一个背景资源
+
+  /**
+      * @method      getNoteBgFirstRes
+      * @description 该内部类用于获取笔记项背景的资源 ID。
+      * @author:     齐景熙
+    */
+      /*
+功能介绍：该内部类用于获取笔记项背景的资源 ID。
+成员变量：
+BG_FIRST_RESOURCES：存储不同颜色的笔记项第一个背景资源 ID 的数组。
+BG_NORMAL_RESOURCES：存储不同颜色的笔记项普通背景资源 ID 的数组。
+BG_LAST_RESOURCES：存储不同颜色的笔记项最后一个背景资源 ID 的数组。
+BG_SINGLE_RESOURCES：存储不同颜色的笔记项单个背景资源 ID 的数组。
+      */
+
         public static int getNoteBgFirstRes(int id) {
             return BG_FIRST_RESOURCES[id];
         }
 
         // 获取备忘录最后一个背景资源
+
+  /**
+      * @method      getNoteBgLastRes
+      * @description 根据传入的 ID 获取笔记项第一个背景的资源 ID。通过索引访问 BG_FIRST_RESOURCES 
+                     数组，返回对应的资源 ID。
+      * @author:     齐景熙
+    */
+      /*
+功能介绍：根据传入的 ID 获取笔记项第一个背景的资源 ID。通过索引访问 BG_FIRST_RESOURCES 数组，返回对应的资源 ID。
+参数：
+id：笔记背景颜色的 ID。
+返回值：笔记项第一个背景的资源 ID。
+      */
+
         public static int getNoteBgLastRes(int id) {
             return BG_LAST_RESOURCES[id];
         }
 
         // 获取备忘录单独背景资源
+
+        /**
+      * @method      getNoteBgSingleRes
+      * @description 根据传入的 ID 获取笔记项第一个背景的资源 ID。通过索引访问 BG_FIRST_RESOURCES 
+                     数组，返回对应的资源 ID。
+      * @author:     齐景熙
+    */
+      /*
+功能介绍：根据传入的 ID 获取笔记项最后一个背景的资源 ID。通过索引访问 BG_LAST_RESOURCES 数组，返回对应的资源 ID。
+参数：
+id：笔记背景颜色的 ID。
+返回值：笔记项最后一个背景的资源 ID。
+      */
         public static int getNoteBgSingleRes(int id) {
             return BG_SINGLE_RESOURCES[id];
         }
 
         // 获取备忘录正常背景资源
+
+ /**
+      * @method      getNoteBgNormalRes
+      * @description 根据传入的 ID 获取笔记项第一个背景的资源 ID。通过索引访问 BG_FIRST_RESOURCES 
+                     数组，返回对应的资源 ID。
+      * @author:     齐景熙
+    */
+      /*
+功能介绍：根据传入的 ID 获取笔记项单个背景的资源 ID。通过索引访问 BG_SINGLE_RESOURCES 数组，返回对应的资源 ID。
+参数：
+id：笔记背景颜色的 ID。
+返回值：笔记项单个背景的资源 ID。
+      */
+        
         public static int getNoteBgNormalRes(int id) {
             return BG_NORMAL_RESOURCES[id];
         }
 
         // 获取文件夹背景资源
+ /**
+      * @method      getFolderBgRes
+      * @description 根据传入的 ID 获取笔记项第一个背景的资源 ID。通过索引访问 BG_FIRST_RESOURCES 
+                     数组，返回对应的资源 ID。
+      * @author:     齐景熙
+    */
+      /*
+功能介绍：根据传入的 ID 获取笔记项普通背景的资源 ID。通过索引访问 BG_NORMAL_RESOURCES 数组，返回对应的资源 ID。
+参数：
+id：笔记背景颜色的 ID。
+返回值：笔记项普通背景的资源 ID。
+      */
         public static int getFolderBgRes() {
             return R.drawable.list_folder;
         }
     }
 
     // 小部件背景资源类
+
+ /**     
+  * 
+  * @ProjectName:    minode
+  * @Package:        net.micode.notes.data
+  * @ClassName:      WidgetBgResources
+  * @Description:    该内部类用于获取小部件背景的资源 ID。
+  * @Author:         齐景熙
+ */
+
+ /*
+功能介绍：该内部类用于获取小部件背景的资源 ID。
+成员变量：
+BG_2X_RESOURCES：存储不同颜色的 2x 小部件背景资源 ID 的数组。
+BG_4X_RESOURCES：存储不同颜色的 4x 小部件背景资源 ID 的数组。 
+*/
+
     public static class WidgetBgResources {
         private final static int [] BG_2X_RESOURCES = new int [] {
             R.drawable.widget_2x_yellow,
@@ -151,6 +313,18 @@ public class ResourceParser {
         };
 
         // 获取2x小部件背景资源
+
+ /**
+      * @method      getWidget2xBgResource
+      * @description 根据传入的 ID 获取 2x 小部件背景的资源 ID。通过索引访问 BG_2X_RESOURCES 数组，返回对应的资源 ID。
+      * @author:     齐景熙
+    */
+      /*
+功能介绍：根据传入的 ID 获取 2x 小部件背景的资源 ID。通过索引访问 BG_2X_RESOURCES 数组，返回对应的资源 ID。
+参数：
+id：小部件背景颜色的 ID。
+返回值：2x 小部件背景的资源 ID。
+      */
         public static int getWidget2xBgResource(int id) {
             return BG_2X_RESOURCES[id];
         }
@@ -164,12 +338,39 @@ public class ResourceParser {
         };
 
         // 获取4x小部件背景资源
+
+ /**
+      * @method      getWidget4xBgResource
+      * @description 根据传入的 ID 获取 4x 小部件背景的资源 ID。通过索引访问 BG_4X_RESOURCES 数组，返回对应的资源 ID。
+      * @author:     齐景熙
+    */
+      /*
+功能介绍：根据传入的 ID 获取 4x 小部件背景的资源 ID。通过索引访问 BG_4X_RESOURCES 数组，返回对应的资源 ID。
+参数：
+id：小部件背景颜色的 ID。
+返回值：4x 小部件背景的资源 ID。
+      */
         public static int getWidget4xBgResource(int id) {
             return BG_4X_RESOURCES[id];
         }
     }
 
     // 文本外观资源类
+
+ /**     
+  * 
+  * @ProjectName:    minode
+  * @Package:        net.micode.notes.data
+  * @ClassName:      TextAppearanceResources
+  * @Description:    该内部类用于获取文本样式的资源 ID。
+  * @Author:         齐景熙
+ */
+
+ /*
+功能介绍：该内部类用于获取文本样式的资源 ID。
+成员变量：
+TEXTAPPEARANCE_RESOURCES：存储不同大小的文本样式资源 ID 的数组。
+*/ 
     public static class TextAppearanceResources {
         private final static int [] TEXTAPPEARANCE_RESOURCES = new int [] {
             R.style.TextAppearanceNormal,
@@ -179,6 +380,20 @@ public class ResourceParser {
         };
 
         // 获取文本外观资源
+
+ /**
+      * @method      getTexAppearanceResource
+      * @description 根据传入的 ID 获取文本样式的资源 ID。首先检查 ID 是否超出数组长度，如果超出，则返回默认的文本样式 ID；
+                     否则，通过索引访问 TEXTAPPEARANCE_RESOURCES 数组，返回对应的资源 ID。
+      * @author:     齐景熙
+    */
+ /*
+功能介绍：根据传入的 ID 获取文本样式的资源 ID。首先检查 ID 是否超出数组长度，如果超出，则返回默认的文本样式 ID；
+否则，通过索引访问 TEXTAPPEARANCE_RESOURCES 数组，返回对应的资源 ID。
+参数：
+id：文本样式大小的 ID。
+返回值：文本样式的资源 ID。
+      */
         public static int getTexAppearanceResource(int id) {
             /**
              * HACKME: Fix bug of store the resource id in shared preference.
@@ -192,6 +407,16 @@ public class ResourceParser {
         }
 
         // 获取资源大小
+
+ /**
+      * @method      getResourcesSize
+      * @description 获取文本样式资源的大小。返回 TEXTAPPEARANCE_RESOURCES 数组的长度。
+      * @author:     齐景熙
+    */
+ /*
+功能介绍：获取文本样式资源的大小。返回 TEXTAPPEARANCE_RESOURCES 数组的长度。
+返回值：文本样式资源的大小。
+      */
         public static int getResourcesSize() {
             return TEXTAPPEARANCE_RESOURCES.length;
         }