diff --git a/MiNotes-master/app/src/main/java/net/micode/notes/tool/BackupUtils.java b/MiNotes-master/app/src/main/java/net/micode/notes/tool/BackupUtils.java index 39f6ec4..b9dc1c9 100644 --- a/MiNotes-master/app/src/main/java/net/micode/notes/tool/BackupUtils.java +++ b/MiNotes-master/app/src/main/java/net/micode/notes/tool/BackupUtils.java @@ -35,12 +35,21 @@ import java.io.FileOutputStream; import java.io.IOException; import java.io.PrintStream; - +/** + * 备份工具类 + * 提供将笔记导出为文本文件的功能 + * 支持导出普通笔记和通话记录笔记 + */ public class BackupUtils { private static final String TAG = "BackupUtils"; - // Singleton stuff + // 单例模式实例 private static BackupUtils sInstance; + /** + * 获取BackupUtils的单例实例 + * @param context 上下文 + * @return BackupUtils实例 + */ public static synchronized BackupUtils getInstance(Context context) { if (sInstance == null) { sInstance = new BackupUtils(context); @@ -49,43 +58,68 @@ public class BackupUtils { } /** - * Following states are signs to represents backup or restore - * status + * 备份状态常量定义 */ - // Currently, the sdcard is not mounted + // SD卡未挂载 public static final int STATE_SD_CARD_UNMOUONTED = 0; - // The backup file not exist + // 备份文件不存在 public static final int STATE_BACKUP_FILE_NOT_EXIST = 1; - // The data is not well formated, may be changed by other programs + // 数据格式损坏 public static final int STATE_DATA_DESTROIED = 2; - // Some run-time exception which causes restore or backup fails + // 系统错误 public static final int STATE_SYSTEM_ERROR = 3; - // Backup or restore success + // 备份成功 public static final int STATE_SUCCESS = 4; + // 文本导出工具实例 private TextExport mTextExport; + /** + * 私有构造函数 + * @param context 上下文 + */ private BackupUtils(Context context) { mTextExport = new TextExport(context); } + /** + * 检查外部存储是否可用 + * @return 外部存储是否可用 + */ private static boolean externalStorageAvailable() { return Environment.MEDIA_MOUNTED.equals(Environment.getExternalStorageState()); } + /** + * 导出笔记为文本文件 + * @return 导出状态 + */ public int exportToText() { return mTextExport.exportToText(); } + /** + * 获取导出的文本文件名 + * @return 文件名 + */ public String getExportedTextFileName() { return mTextExport.mFileName; } + /** + * 获取导出的文本文件目录 + * @return 文件目录 + */ public String getExportedTextFileDir() { return mTextExport.mFileDirectory; } + /** + * 文本导出工具类 + * 负责将笔记数据导出为可读的文本格式 + */ private static class TextExport { + // 笔记查询投影 private static final String[] NOTE_PROJECTION = { NoteColumns.ID, NoteColumns.MODIFIED_DATE, @@ -93,12 +127,12 @@ public class BackupUtils { NoteColumns.TYPE }; + // 笔记列索引 private static final int NOTE_COLUMN_ID = 0; - private static final int NOTE_COLUMN_MODIFIED_DATE = 1; - private static final int NOTE_COLUMN_SNIPPET = 2; + // 数据查询投影 private static final String[] DATA_PROJECTION = { DataColumns.CONTENT, DataColumns.MIME_TYPE, @@ -108,23 +142,30 @@ public class BackupUtils { DataColumns.DATA4, }; + // 数据列索引 private static final int DATA_COLUMN_CONTENT = 0; - private static final int DATA_COLUMN_MIME_TYPE = 1; - private static final int DATA_COLUMN_CALL_DATE = 2; - private static final int DATA_COLUMN_PHONE_NUMBER = 4; + // 文本格式数组 private final String [] TEXT_FORMAT; + // 格式类型常量 private static final int FORMAT_FOLDER_NAME = 0; private static final int FORMAT_NOTE_DATE = 1; private static final int FORMAT_NOTE_CONTENT = 2; + // 上下文 private Context mContext; + // 导出文件名 private String mFileName; + // 导出文件目录 private String mFileDirectory; + /** + * 构造函数 + * @param context 上下文 + */ public TextExport(Context context) { TEXT_FORMAT = context.getResources().getStringArray(R.array.format_for_exported_note); mContext = context; @@ -132,15 +173,22 @@ public class BackupUtils { mFileDirectory = ""; } + /** + * 获取指定格式的文本 + * @param id 格式ID + * @return 格式化的文本 + */ private String getFormat(int id) { return TEXT_FORMAT[id]; } /** - * Export the folder identified by folder id to text + * 将指定文件夹导出为文本 + * @param folderId 文件夹ID + * @param ps 打印流 */ private void exportFolderToText(String folderId, PrintStream ps) { - // Query notes belong to this folder + // 查询属于该文件夹的笔记 Cursor notesCursor = mContext.getContentResolver().query(Notes.CONTENT_NOTE_URI, NOTE_PROJECTION, NoteColumns.PARENT_ID + "=?", new String[] { folderId @@ -149,11 +197,11 @@ public class BackupUtils { if (notesCursor != null) { if (notesCursor.moveToFirst()) { do { - // Print note's last modified date + // 打印笔记的最后修改日期 ps.println(String.format(getFormat(FORMAT_NOTE_DATE), DateFormat.format( mContext.getString(R.string.format_datetime_mdhm), notesCursor.getLong(NOTE_COLUMN_MODIFIED_DATE)))); - // Query data belong to this note + // 查询该笔记的数据 String noteId = notesCursor.getString(NOTE_COLUMN_ID); exportNoteToText(noteId, ps); } while (notesCursor.moveToNext()); @@ -163,7 +211,9 @@ public class BackupUtils { } /** - * Export note identified by id to a print stream + * 将指定笔记导出为文本 + * @param noteId 笔记ID + * @param ps 打印流 */ private void exportNoteToText(String noteId, PrintStream ps) { Cursor dataCursor = mContext.getContentResolver().query(Notes.CONTENT_DATA_URI, @@ -176,7 +226,7 @@ public class BackupUtils { do { String mimeType = dataCursor.getString(DATA_COLUMN_MIME_TYPE); if (DataConstants.CALL_NOTE.equals(mimeType)) { - // Print phone number + // 打印电话号码 String phoneNumber = dataCursor.getString(DATA_COLUMN_PHONE_NUMBER); long callDate = dataCursor.getLong(DATA_COLUMN_CALL_DATE); String location = dataCursor.getString(DATA_COLUMN_CONTENT); @@ -185,11 +235,11 @@ public class BackupUtils { ps.println(String.format(getFormat(FORMAT_NOTE_CONTENT), phoneNumber)); } - // Print call date + // 打印通话日期 ps.println(String.format(getFormat(FORMAT_NOTE_CONTENT), DateFormat .format(mContext.getString(R.string.format_datetime_mdhm), callDate))); - // Print call attachment location + // 打印通话附件位置 if (!TextUtils.isEmpty(location)) { ps.println(String.format(getFormat(FORMAT_NOTE_CONTENT), location)); @@ -205,7 +255,7 @@ public class BackupUtils { } dataCursor.close(); } - // print a line separator between note + // 在笔记之间打印分隔符 try { ps.write(new byte[] { Character.LINE_SEPARATOR, Character.LETTER_NUMBER @@ -216,7 +266,8 @@ public class BackupUtils { } /** - * Note will be exported as text which is user readable + * 将笔记导出为可读的文本格式 + * @return 导出状态 */ public int exportToText() { if (!externalStorageAvailable()) { @@ -229,7 +280,7 @@ public class BackupUtils { Log.e(TAG, "get print stream error"); return STATE_SYSTEM_ERROR; } - // First export folder and its notes + // 首先导出文件夹及其笔记 Cursor folderCursor = mContext.getContentResolver().query( Notes.CONTENT_NOTE_URI, NOTE_PROJECTION, @@ -240,7 +291,7 @@ public class BackupUtils { if (folderCursor != null) { if (folderCursor.moveToFirst()) { do { - // Print folder's name + // 打印文件夹名称 String folderName = ""; if(folderCursor.getLong(NOTE_COLUMN_ID) == Notes.ID_CALL_RECORD_FOLDER) { folderName = mContext.getString(R.string.call_record_folder_name); @@ -257,7 +308,7 @@ public class BackupUtils { folderCursor.close(); } - // Export notes in root's folder + // 导出根目录下的笔记 Cursor noteCursor = mContext.getContentResolver().query( Notes.CONTENT_NOTE_URI, NOTE_PROJECTION, @@ -270,7 +321,7 @@ public class BackupUtils { ps.println(String.format(getFormat(FORMAT_NOTE_DATE), DateFormat.format( mContext.getString(R.string.format_datetime_mdhm), noteCursor.getLong(NOTE_COLUMN_MODIFIED_DATE)))); - // Query data belong to this note + // 查询该笔记的数据 String noteId = noteCursor.getString(NOTE_COLUMN_ID); exportNoteToText(noteId, ps); } while (noteCursor.moveToNext()); @@ -283,7 +334,8 @@ public class BackupUtils { } /** - * Get a print stream pointed to the file {@generateExportedTextFile} + * 获取指向导出文本文件的打印流 + * @return 打印流 */ private PrintStream getExportToTextPrintStream() { File file = generateFileMountedOnSDcard(mContext, R.string.file_path, @@ -310,7 +362,11 @@ public class BackupUtils { } /** - * Generate the text file to store imported data + * 在SD卡上生成用于存储导入数据的文本文件 + * @param context 上下文 + * @param filePathResId 文件路径资源ID + * @param fileNameFormatResId 文件名格式资源ID + * @return 生成的文件 */ private static File generateFileMountedOnSDcard(Context context, int filePathResId, int fileNameFormatResId) { StringBuilder sb = new StringBuilder(); diff --git a/MiNotes-master/app/src/main/java/net/micode/notes/tool/DataUtils.java b/MiNotes-master/app/src/main/java/net/micode/notes/tool/DataUtils.java index 2a14982..3d959ef 100644 --- a/MiNotes-master/app/src/main/java/net/micode/notes/tool/DataUtils.java +++ b/MiNotes-master/app/src/main/java/net/micode/notes/tool/DataUtils.java @@ -34,9 +34,19 @@ import net.micode.notes.ui.NotesListAdapter.AppWidgetAttribute; import java.util.ArrayList; import java.util.HashSet; - +/** + * DataUtils 工具类 + * 提供对 Notes 数据库的批量操作、查询及辅助方法 + */ public class DataUtils { public static final String TAG = "DataUtils"; + + /** + * 批量删除指定 ID 的笔记 + * @param resolver ContentResolver 实例，用于执行数据库操作 + * @param ids 要删除的笔记 ID 集合 + * @return 删除是否成功 + */ public static boolean batchDeleteNotes(ContentResolver resolver, HashSet ids) { if (ids == null) { Log.d(TAG, "the ids is null"); @@ -49,6 +59,7 @@ public class DataUtils { ArrayList operationList = new ArrayList(); for (long id : ids) { + // 跳过根文件夹，避免意外删除系统根目录 if(id == Notes.ID_ROOT_FOLDER) { Log.e(TAG, "Don't delete system folder root"); continue; @@ -59,6 +70,7 @@ public class DataUtils { } try { ContentProviderResult[] results = resolver.applyBatch(Notes.AUTHORITY, operationList); + // 判断返回结果是否有效 if (results == null || results.length == 0 || results[0] == null) { Log.d(TAG, "delete notes failed, ids:" + ids.toString()); return false; @@ -72,16 +84,31 @@ public class DataUtils { return false; } + /** + * 将单个笔记移动到目标文件夹 + * @param resolver ContentResolver 实例 + * @param id 笔记 ID + * @param srcFolderId 原始父文件夹 ID + * @param desFolderId 目标父文件夹 ID + */ public static void moveNoteToFoler(ContentResolver resolver, long id, long srcFolderId, long desFolderId) { ContentValues values = new ContentValues(); + // 更新父目录信息，并标记本地已修改 values.put(NoteColumns.PARENT_ID, desFolderId); values.put(NoteColumns.ORIGIN_PARENT_ID, srcFolderId); values.put(NoteColumns.LOCAL_MODIFIED, 1); resolver.update(ContentUris.withAppendedId(Notes.CONTENT_NOTE_URI, id), values, null, null); } + /** + * 批量移动笔记到指定文件夹 + * @param resolver ContentResolver 实例 + * @param ids 要移动的笔记 ID 集合 + * @param folderId 目标文件夹 ID + * @return 移动是否成功 + */ public static boolean batchMoveToFolder(ContentResolver resolver, HashSet ids, - long folderId) { + long folderId) { if (ids == null) { Log.d(TAG, "the ids is null"); return true; @@ -112,7 +139,9 @@ public class DataUtils { } /** - * Get the all folder count except system folders {@link Notes#TYPE_SYSTEM}} + * 获取用户创建的文件夹数量（不包括系统文件夹） + * @param resolver ContentResolver 实例 + * @return 文件夹数量 */ public static int getUserFolderCount(ContentResolver resolver) { Cursor cursor =resolver.query(Notes.CONTENT_NOTE_URI, @@ -136,6 +165,13 @@ public class DataUtils { return count; } + /** + * 检查指定类型笔记在数据库中是否可见（不在回收站中） + * @param resolver ContentResolver 实例 + * @param noteId 笔记 ID + * @param type 笔记类型 + * @return 是否可见 + */ public static boolean visibleInNoteDatabase(ContentResolver resolver, long noteId, int type) { Cursor cursor = resolver.query(ContentUris.withAppendedId(Notes.CONTENT_NOTE_URI, noteId), null, @@ -153,6 +189,12 @@ public class DataUtils { return exist; } + /** + * 检查指定笔记是否存在于笔记数据库中 + * @param resolver ContentResolver 实例 + * @param noteId 笔记 ID + * @return 是否存在 + */ public static boolean existInNoteDatabase(ContentResolver resolver, long noteId) { Cursor cursor = resolver.query(ContentUris.withAppendedId(Notes.CONTENT_NOTE_URI, noteId), null, null, null, null); @@ -167,6 +209,12 @@ public class DataUtils { return exist; } + /** + * 检查指定 dataId 是否存在于数据表中 + * @param resolver ContentResolver 实例 + * @param dataId 数据 ID + * @return 是否存在 + */ public static boolean existInDataDatabase(ContentResolver resolver, long dataId) { Cursor cursor = resolver.query(ContentUris.withAppendedId(Notes.CONTENT_DATA_URI, dataId), null, null, null, null); @@ -181,11 +229,17 @@ public class DataUtils { return exist; } + /** + * 检查同名文件夹是否可见，避免重名 + * @param resolver ContentResolver 实例 + * @param name 文件夹名称 + * @return 是否已存在 + */ public static boolean checkVisibleFolderName(ContentResolver resolver, String name) { Cursor cursor = resolver.query(Notes.CONTENT_NOTE_URI, null, NoteColumns.TYPE + "=" + Notes.TYPE_FOLDER + - " AND " + NoteColumns.PARENT_ID + "<>" + Notes.ID_TRASH_FOLER + - " AND " + NoteColumns.SNIPPET + "=?", + " AND " + NoteColumns.PARENT_ID + "<>" + Notes.ID_TRASH_FOLER + + " AND " + NoteColumns.SNIPPET + "=?", new String[] { name }, null); boolean exist = false; if(cursor != null) { @@ -197,6 +251,12 @@ public class DataUtils { return exist; } + /** + * 获取指定文件夹下所有笔记对应的 AppWidget 属性集合 + * @param resolver ContentResolver 实例 + * @param folderId 文件夹 ID + * @return AppWidgetAttribute 集合 + */ public static HashSet getFolderNoteWidget(ContentResolver resolver, long folderId) { Cursor c = resolver.query(Notes.CONTENT_NOTE_URI, new String[] { NoteColumns.WIDGET_ID, NoteColumns.WIDGET_TYPE }, @@ -210,6 +270,7 @@ public class DataUtils { set = new HashSet(); do { try { + // 创建并填充 AppWidgetAttribute 对象 AppWidgetAttribute widget = new AppWidgetAttribute(); widget.widgetId = c.getInt(0); widget.widgetType = c.getInt(1); @@ -224,6 +285,12 @@ public class DataUtils { return set; } + /** + * 根据笔记 ID 获取通话记录的电话号码 + * @param resolver ContentResolver 实例 + * @param noteId 笔记 ID + * @return 电话号码字符串，如果未找到则返回空字符串 + */ public static String getCallNumberByNoteId(ContentResolver resolver, long noteId) { Cursor cursor = resolver.query(Notes.CONTENT_DATA_URI, new String [] { CallNote.PHONE_NUMBER }, @@ -243,11 +310,18 @@ public class DataUtils { return ""; } + /** + * 根据电话号码和通话日期获取对应的笔记 ID + * @param resolver ContentResolver 实例 + * @param phoneNumber 电话号码字符串 + * @param callDate 通话日期（毫秒数） + * @return 笔记 ID，如果未找到则返回 0 + */ public static long getNoteIdByPhoneNumberAndCallDate(ContentResolver resolver, String phoneNumber, long callDate) { Cursor cursor = resolver.query(Notes.CONTENT_DATA_URI, new String [] { CallNote.NOTE_ID }, CallNote.CALL_DATE + "=? AND " + CallNote.MIME_TYPE + "=? AND PHONE_NUMBERS_EQUAL(" - + CallNote.PHONE_NUMBER + ",?)", + + CallNote.PHONE_NUMBER + ",?)", new String [] { String.valueOf(callDate), CallNote.CONTENT_ITEM_TYPE, phoneNumber }, null); @@ -264,6 +338,12 @@ public class DataUtils { return 0; } + /** + * 根据笔记 ID 获取笔记摘要文本 + * @param resolver ContentResolver 实例 + * @param noteId 笔记 ID + * @return 笔记摘要，未找到抛出异常 + */ public static String getSnippetById(ContentResolver resolver, long noteId) { Cursor cursor = resolver.query(Notes.CONTENT_NOTE_URI, new String [] { NoteColumns.SNIPPET }, @@ -282,12 +362,17 @@ public class DataUtils { throw new IllegalArgumentException("Note is not found with id: " + noteId); } + /** + * 格式化摘要文本：去除首尾空白，并截取首行内容 + * @param snippet 原始摘要 + * @return 格式化后的摘要 + */ public static String getFormattedSnippet(String snippet) { if (snippet != null) { - snippet = snippet.trim(); + snippet = snippet.trim(); // 去除首尾空白 int index = snippet.indexOf('\n'); if (index != -1) { - snippet = snippet.substring(0, index); + snippet = snippet.substring(0, index); // 截取第一行 } } return snippet; diff --git a/MiNotes-master/app/src/main/java/net/micode/notes/tool/GTaskStringUtils.java b/MiNotes-master/app/src/main/java/net/micode/notes/tool/GTaskStringUtils.java index 666b729..028c3b6 100644 --- a/MiNotes-master/app/src/main/java/net/micode/notes/tool/GTaskStringUtils.java +++ b/MiNotes-master/app/src/main/java/net/micode/notes/tool/GTaskStringUtils.java @@ -16,98 +16,110 @@ package net.micode.notes.tool; +/** + * GTaskStringUtils 工具类 + * + * 定义在 Google Task 同步流程中所使用的 JSON 字段常量， + * 以及 MIUI Notes 应用中涉及的文件夹名称和元数据前缀常量。 + */ public class GTaskStringUtils { + // ====== GTask JSON 操作相关字段 ====== + /** 操作 ID 标识 */ public final static String GTASK_JSON_ACTION_ID = "action_id"; - + /** 操作列表 */ public final static String GTASK_JSON_ACTION_LIST = "action_list"; - + /** 操作类型字段 */ public final static String GTASK_JSON_ACTION_TYPE = "action_type"; - + /** 创建操作 */ public final static String GTASK_JSON_ACTION_TYPE_CREATE = "create"; - + /** 获取所有操作 */ public final static String GTASK_JSON_ACTION_TYPE_GETALL = "get_all"; - + /** 移动操作 */ public final static String GTASK_JSON_ACTION_TYPE_MOVE = "move"; - + /** 更新操作 */ public final static String GTASK_JSON_ACTION_TYPE_UPDATE = "update"; + // ====== GTask JSON 通用字段 ====== + /** 创建者 ID */ public final static String GTASK_JSON_CREATOR_ID = "creator_id"; - + /** 子对象实体 */ public final static String GTASK_JSON_CHILD_ENTITY = "child_entity"; - + /** 客户端版本 */ public final static String GTASK_JSON_CLIENT_VERSION = "client_version"; - + /** 完成状态 */ public final static String GTASK_JSON_COMPLETED = "completed"; - + /** 当前列表 ID */ public final static String GTASK_JSON_CURRENT_LIST_ID = "current_list_id"; - + /** 默认列表 ID */ public final static String GTASK_JSON_DEFAULT_LIST_ID = "default_list_id"; - + /** 删除状态 */ public final static String GTASK_JSON_DELETED = "deleted"; - + /** 目标列表 */ public final static String GTASK_JSON_DEST_LIST = "dest_list"; - + /** 目标父节点 */ public final static String GTASK_JSON_DEST_PARENT = "dest_parent"; - + /** 目标父节点类型 */ public final static String GTASK_JSON_DEST_PARENT_TYPE = "dest_parent_type"; - + /** 实体差量 */ public final static String GTASK_JSON_ENTITY_DELTA = "entity_delta"; - + /** 实体类型 */ public final static String GTASK_JSON_ENTITY_TYPE = "entity_type"; - + /** 获取已删除项目标识 */ public final static String GTASK_JSON_GET_DELETED = "get_deleted"; - + /** 通用 ID 字段 */ public final static String GTASK_JSON_ID = "id"; - + /** 索引位置 */ public final static String GTASK_JSON_INDEX = "index"; - + /** 最后修改时间 */ public final static String GTASK_JSON_LAST_MODIFIED = "last_modified"; - + /** 最近同步点 */ public final static String GTASK_JSON_LATEST_SYNC_POINT = "latest_sync_point"; - + /** 列表 ID */ public final static String GTASK_JSON_LIST_ID = "list_id"; - + /** 列表集合 */ public final static String GTASK_JSON_LISTS = "lists"; - + /** 名称字段 */ public final static String GTASK_JSON_NAME = "name"; - + /** 新生成的 ID */ public final static String GTASK_JSON_NEW_ID = "new_id"; - + /** 备注字段 */ public final static String GTASK_JSON_NOTES = "notes"; - + /** 父节点 ID */ public final static String GTASK_JSON_PARENT_ID = "parent_id"; - + /** 前一个兄弟节点 ID */ public final static String GTASK_JSON_PRIOR_SIBLING_ID = "prior_sibling_id"; - + /** 操作结果集合 */ public final static String GTASK_JSON_RESULTS = "results"; - + /** 源列表 */ public final static String GTASK_JSON_SOURCE_LIST = "source_list"; - + /** 任务集合 */ public final static String GTASK_JSON_TASKS = "tasks"; - + /** 类型字段 */ public final static String GTASK_JSON_TYPE = "type"; - + /** 类型：分组 */ public final static String GTASK_JSON_TYPE_GROUP = "GROUP"; - + /** 类型：任务 */ public final static String GTASK_JSON_TYPE_TASK = "TASK"; - + /** 用户字段 */ public final static String GTASK_JSON_USER = "user"; + // ====== MIUI Notes 文件夹及元数据常量 ====== + /** MIUI Notes 文件夹前缀 */ public final static String MIUI_FOLDER_PREFFIX = "[MIUI_Notes]"; - + /** 默认文件夹名称 */ public final static String FOLDER_DEFAULT = "Default"; - + /** 通话记录文件夹名称 */ public final static String FOLDER_CALL_NOTE = "Call_Note"; - + /** 元数据文件夹名称 */ public final static String FOLDER_META = "METADATA"; - + /** 元数据头部：GTask ID */ public final static String META_HEAD_GTASK_ID = "meta_gid"; - + /** 元数据头部：Note ID */ public final static String META_HEAD_NOTE = "meta_note"; - + /** 元数据头部：Data ID */ public final static String META_HEAD_DATA = "meta_data"; - + /** 元数据备注名称（禁止更新和删除） */ public final static String META_NOTE_NAME = "[META INFO] DON'T UPDATE AND DELETE"; } diff --git a/MiNotes-master/app/src/main/java/net/micode/notes/tool/ResourceParser.java b/MiNotes-master/app/src/main/java/net/micode/notes/tool/ResourceParser.java index 1ad3ad6..977123d 100644 --- a/MiNotes-master/app/src/main/java/net/micode/notes/tool/ResourceParser.java +++ b/MiNotes-master/app/src/main/java/net/micode/notes/tool/ResourceParser.java @@ -22,158 +22,229 @@ import android.preference.PreferenceManager; import net.micode.notes.R; import net.micode.notes.ui.NotesPreferenceActivity; +/** + * 资源解析工具类 ResourceParser + * + * 提供笔记应用中背景色、字体大小等资源的常量定义及获取方法。 + * 支持随机背景色、列表项背景、组件背景以及文本样式资源的获取。 + */ public class ResourceParser { - public static final int YELLOW = 0; - public static final int BLUE = 1; - public static final int WHITE = 2; - public static final int GREEN = 3; - public static final int RED = 4; + // ====== 笔记背景颜色常量 ====== + public static final int YELLOW = 0; // 黄色 + public static final int BLUE = 1; // 蓝色 + public static final int WHITE = 2; // 白色 + public static final int GREEN = 3; // 绿色 + public static final int RED = 4; // 红色 + // 默认背景颜色：黄色 public static final int BG_DEFAULT_COLOR = YELLOW; - public static final int TEXT_SMALL = 0; - public static final int TEXT_MEDIUM = 1; - public static final int TEXT_LARGE = 2; - public static final int TEXT_SUPER = 3; + // ====== 文本大小常量 ====== + public static final int TEXT_SMALL = 0; // 小号字体 + public static final int TEXT_MEDIUM = 1; // 中号字体 + public static final int TEXT_LARGE = 2; // 大号字体 + public static final int TEXT_SUPER = 3; // 超大号字体 + // 默认字体大小：中号 public static final int BG_DEFAULT_FONT_SIZE = TEXT_MEDIUM; + /** + * NoteBgResources 嵌套类 + * + * 提供编辑界面中笔记背景和标题背景的 drawable 资源获取方法。 + */ public static class NoteBgResources { - private final static int [] BG_EDIT_RESOURCES = new int [] { - R.drawable.edit_yellow, - R.drawable.edit_blue, - R.drawable.edit_white, - R.drawable.edit_green, - R.drawable.edit_red + // 编辑界面背景资源数组 + private final static int[] BG_EDIT_RESOURCES = new int[] { + R.drawable.edit_yellow, + R.drawable.edit_blue, + R.drawable.edit_white, + R.drawable.edit_green, + R.drawable.edit_red }; - private final static int [] BG_EDIT_TITLE_RESOURCES = new int [] { - R.drawable.edit_title_yellow, - R.drawable.edit_title_blue, - R.drawable.edit_title_white, - R.drawable.edit_title_green, - R.drawable.edit_title_red + // 编辑界面标题背景资源数组 + private final static int[] BG_EDIT_TITLE_RESOURCES = new int[] { + R.drawable.edit_title_yellow, + R.drawable.edit_title_blue, + R.drawable.edit_title_white, + R.drawable.edit_title_green, + R.drawable.edit_title_red }; + /** + * 根据颜色 ID 获取笔记编辑背景资源 + */ public static int getNoteBgResource(int id) { return BG_EDIT_RESOURCES[id]; } + /** + * 根据颜色 ID 获取笔记编辑标题背景资源 + */ public static int getNoteTitleBgResource(int id) { return BG_EDIT_TITLE_RESOURCES[id]; } } + /** + * 获取默认背景色 ID + * + * 如果用户开启随机背景色偏好，从随机范围中获取； + * 否则返回默认颜色常量。 + */ public static int getDefaultBgId(Context context) { - if (PreferenceManager.getDefaultSharedPreferences(context).getBoolean( - NotesPreferenceActivity.PREFERENCE_SET_BG_COLOR_KEY, false)) { + boolean randomBg = PreferenceManager + .getDefaultSharedPreferences(context) + .getBoolean(NotesPreferenceActivity.PREFERENCE_SET_BG_COLOR_KEY, false); + if (randomBg) { + // 随机选取一种背景色 return (int) (Math.random() * NoteBgResources.BG_EDIT_RESOURCES.length); } else { return BG_DEFAULT_COLOR; } } + /** + * NoteItemBgResources 嵌套类 + * + * 提供笔记列表项不同状态（首、中、末、单独）的背景资源获取方法。 + */ public static class NoteItemBgResources { - private final static int [] BG_FIRST_RESOURCES = new int [] { - R.drawable.list_yellow_up, - R.drawable.list_blue_up, - R.drawable.list_white_up, - R.drawable.list_green_up, - R.drawable.list_red_up + private final static int[] BG_FIRST_RESOURCES = new int[] { + R.drawable.list_yellow_up, + R.drawable.list_blue_up, + R.drawable.list_white_up, + R.drawable.list_green_up, + R.drawable.list_red_up }; - private final static int [] BG_NORMAL_RESOURCES = new int [] { - R.drawable.list_yellow_middle, - R.drawable.list_blue_middle, - R.drawable.list_white_middle, - R.drawable.list_green_middle, - R.drawable.list_red_middle + private final static int[] BG_NORMAL_RESOURCES = new int[] { + R.drawable.list_yellow_middle, + R.drawable.list_blue_middle, + R.drawable.list_white_middle, + R.drawable.list_green_middle, + R.drawable.list_red_middle }; - private final static int [] BG_LAST_RESOURCES = new int [] { - R.drawable.list_yellow_down, - R.drawable.list_blue_down, - R.drawable.list_white_down, - R.drawable.list_green_down, - R.drawable.list_red_down, + private final static int[] BG_LAST_RESOURCES = new int[] { + R.drawable.list_yellow_down, + R.drawable.list_blue_down, + R.drawable.list_white_down, + R.drawable.list_green_down, + R.drawable.list_red_down, }; - private final static int [] BG_SINGLE_RESOURCES = new int [] { - R.drawable.list_yellow_single, - R.drawable.list_blue_single, - R.drawable.list_white_single, - R.drawable.list_green_single, - R.drawable.list_red_single + private final static int[] BG_SINGLE_RESOURCES = new int[] { + R.drawable.list_yellow_single, + R.drawable.list_blue_single, + R.drawable.list_white_single, + R.drawable.list_green_single, + R.drawable.list_red_single }; + /** + * 获取第一项背景资源 + */ public static int getNoteBgFirstRes(int id) { return BG_FIRST_RESOURCES[id]; } + /** + * 获取普通项背景资源 + */ + public static int getNoteBgNormalRes(int id) { + return BG_NORMAL_RESOURCES[id]; + } + + /** + * 获取末尾项背景资源 + */ public static int getNoteBgLastRes(int id) { return BG_LAST_RESOURCES[id]; } + /** + * 获取单独一项背景资源 + */ public static int getNoteBgSingleRes(int id) { return BG_SINGLE_RESOURCES[id]; } - public static int getNoteBgNormalRes(int id) { - return BG_NORMAL_RESOURCES[id]; - } - + /** + * 获取文件夹列表项背景资源 + */ public static int getFolderBgRes() { return R.drawable.list_folder; } } + /** + * WidgetBgResources 嵌套类 + * + * 提供 2x 和 4x 大小桌面组件背景资源获取方法。 + */ public static class WidgetBgResources { - private final static int [] BG_2X_RESOURCES = new int [] { - R.drawable.widget_2x_yellow, - R.drawable.widget_2x_blue, - R.drawable.widget_2x_white, - R.drawable.widget_2x_green, - R.drawable.widget_2x_red, + private final static int[] BG_2X_RESOURCES = new int[] { + R.drawable.widget_2x_yellow, + R.drawable.widget_2x_blue, + R.drawable.widget_2x_white, + R.drawable.widget_2x_green, + R.drawable.widget_2x_red, }; + /** + * 获取 2x 大小组件背景资源 + */ public static int getWidget2xBgResource(int id) { return BG_2X_RESOURCES[id]; } - private final static int [] BG_4X_RESOURCES = new int [] { - R.drawable.widget_4x_yellow, - R.drawable.widget_4x_blue, - R.drawable.widget_4x_white, - R.drawable.widget_4x_green, - R.drawable.widget_4x_red + private final static int[] BG_4X_RESOURCES = new int[] { + R.drawable.widget_4x_yellow, + R.drawable.widget_4x_blue, + R.drawable.widget_4x_white, + R.drawable.widget_4x_green, + R.drawable.widget_4x_red }; + /** + * 获取 4x 大小组件背景资源 + */ public static int getWidget4xBgResource(int id) { return BG_4X_RESOURCES[id]; } } + /** + * TextAppearanceResources 嵌套类 + * + * 提供文本样式（字体大小）资源获取方法，并包含边界检查逻辑。 + */ public static class TextAppearanceResources { - private final static int [] TEXTAPPEARANCE_RESOURCES = new int [] { - R.style.TextAppearanceNormal, - R.style.TextAppearanceMedium, - R.style.TextAppearanceLarge, - R.style.TextAppearanceSuper + // 文本样式资源数组 + private final static int[] TEXTAPPEARANCE_RESOURCES = new int[] { + R.style.TextAppearanceNormal, + R.style.TextAppearanceMedium, + R.style.TextAppearanceLarge, + R.style.TextAppearanceSuper }; + /** + * 根据文本大小 ID 获取对应的样式资源，超过范围时返回默认字体大小样式 + */ public static int getTexAppearanceResource(int id) { - /** - * HACKME: Fix bug of store the resource id in shared preference. - * The id may larger than the length of resources, in this case, - * return the {@link ResourceParser#BG_DEFAULT_FONT_SIZE} - */ - if (id >= TEXTAPPEARANCE_RESOURCES.length) { - return BG_DEFAULT_FONT_SIZE; + // 避免 sharedPreference 中存储的 ID 越界 + if (id < 0 || id >= TEXTAPPEARANCE_RESOURCES.length) { + return TEXTAPPEARANCE_RESOURCES[BG_DEFAULT_FONT_SIZE]; } return TEXTAPPEARANCE_RESOURCES[id]; } + /** + * 获取可用文本样式资源数量 + */ public static int getResourcesSize() { return TEXTAPPEARANCE_RESOURCES.length; } diff --git a/小米便签综合文档.docx b/小米便签综合文档.docx new file mode 100644 index 0000000..b73fa4f Binary files /dev/null and b/小米便签综合文档.docx differ