diff --git a/src/net/micode/notes/tool/BackupUtils.java b/src/net/micode/notes/tool/BackupUtils.java index 39f6ec4..31410fc 100644 --- a/src/net/micode/notes/tool/BackupUtils.java +++ b/src/net/micode/notes/tool/BackupUtils.java @@ -35,12 +35,20 @@ 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 +57,61 @@ public class BackupUtils { } /** - * Following states are signs to represents backup or restore - * status + * 备份/恢复状态码定义 */ - // Currently, the sdcard is not mounted - 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; + public static final int STATE_SD_CARD_UNMOUONTED = 0; // SD卡未挂载 + public static final int STATE_BACKUP_FILE_NOT_EXIST = 1; // 备份文件不存在 + public static final int STATE_DATA_DESTROIED = 2; // 数据被破坏 + public static final int STATE_SYSTEM_ERROR = 3; // 系统错误 + public static final int STATE_SUCCESS = 4; // 操作成功 + private TextExport mTextExport; // 文本导出处理器 + + /** + * 私有构造函数 + * @param context 上下文对象 + */ private BackupUtils(Context context) { mTextExport = new TextExport(context); } + /** + * 检查外部存储是否可用 + * @return true如果外部存储已挂载且可写 + */ 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 +119,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,52 +134,68 @@ 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 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; + 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; mFileName = ""; 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 - }, null); + // 查询属于该文件夹的所有笔记 + Cursor notesCursor = mContext.getContentResolver().query( + Notes.CONTENT_NOTE_URI, + NOTE_PROJECTION, + NoteColumns.PARENT_ID + "=?", + new String[]{folderId}, + null); 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 + // 打印笔记的最后修改日期 + ps.println(String.format( + getFormat(FORMAT_NOTE_DATE), + DateFormat.format( + mContext.getString(R.string.format_datetime_mdhm), + notesCursor.getLong(NOTE_COLUMN_MODIFIED_DATE))); + + // 导出该笔记的内容 String noteId = notesCursor.getString(NOTE_COLUMN_ID); exportNoteToText(noteId, ps); } while (notesCursor.moveToNext()); @@ -163,41 +205,56 @@ 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, - DATA_PROJECTION, DataColumns.NOTE_ID + "=?", new String[] { - noteId - }, null); + // 查询该笔记的所有数据项 + Cursor dataCursor = mContext.getContentResolver().query( + Notes.CONTENT_DATA_URI, + DATA_PROJECTION, + DataColumns.NOTE_ID + "=?", + new String[]{noteId}, + null); if (dataCursor != null) { if (dataCursor.moveToFirst()) { 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); if (!TextUtils.isEmpty(phoneNumber)) { - ps.println(String.format(getFormat(FORMAT_NOTE_CONTENT), + 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), + + // 打印通话日期 + 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), + ps.println(String.format( + getFormat(FORMAT_NOTE_CONTENT), location)); } - } else if (DataConstants.NOTE.equals(mimeType)) { + } + // 处理普通笔记类型 + else if (DataConstants.NOTE.equals(mimeType)) { String content = dataCursor.getString(DATA_COLUMN_CONTENT); if (!TextUtils.isEmpty(content)) { - ps.println(String.format(getFormat(FORMAT_NOTE_CONTENT), + ps.println(String.format( + getFormat(FORMAT_NOTE_CONTENT), content)); } } @@ -205,51 +262,60 @@ public class BackupUtils { } dataCursor.close(); } - // print a line separator between note + + // 在笔记之间打印分隔线 try { - ps.write(new byte[] { - Character.LINE_SEPARATOR, Character.LETTER_NUMBER - }); + ps.write(new byte[]{Character.LINE_SEPARATOR, Character.LETTER_NUMBER}); } catch (IOException e) { Log.e(TAG, e.toString()); } } /** - * Note will be exported as text which is user readable + * 执行导出到文本文件操作 + * @return 操作状态码 */ public int exportToText() { + // 检查SD卡是否可用 if (!externalStorageAvailable()) { Log.d(TAG, "Media was not mounted"); return STATE_SD_CARD_UNMOUONTED; } + // 获取打印流 PrintStream ps = getExportToTextPrintStream(); if (ps == null) { 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, "(" + NoteColumns.TYPE + "=" + Notes.TYPE_FOLDER + " AND " + NoteColumns.PARENT_ID + "<>" + Notes.ID_TRASH_FOLER + ") OR " - + NoteColumns.ID + "=" + Notes.ID_CALL_RECORD_FOLDER, null, null); + + NoteColumns.ID + "=" + Notes.ID_CALL_RECORD_FOLDER, + null, null); 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); } else { folderName = folderCursor.getString(NOTE_COLUMN_SNIPPET); } + if (!TextUtils.isEmpty(folderName)) { - ps.println(String.format(getFormat(FORMAT_FOLDER_NAME), folderName)); + ps.println(String.format( + getFormat(FORMAT_FOLDER_NAME), + folderName)); } + + // 导出该文件夹下的笔记 String folderId = folderCursor.getString(NOTE_COLUMN_ID); exportFolderToText(folderId, ps); } while (folderCursor.moveToNext()); @@ -257,47 +323,56 @@ public class BackupUtils { folderCursor.close(); } - // Export notes in root's folder + // 导出根目录下的笔记 Cursor noteCursor = mContext.getContentResolver().query( Notes.CONTENT_NOTE_URI, NOTE_PROJECTION, - NoteColumns.TYPE + "=" + +Notes.TYPE_NOTE + " AND " + NoteColumns.PARENT_ID - + "=0", null, null); + NoteColumns.TYPE + "=" + +Notes.TYPE_NOTE + " AND " + NoteColumns.PARENT_ID + "=0", + null, null); if (noteCursor != null) { if (noteCursor.moveToFirst()) { do { - 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 + ps.println(String.format( + getFormat(FORMAT_NOTE_DATE), + DateFormat.format( + mContext.getString(R.string.format_datetime_mdhm), + noteCursor.getLong(NOTE_COLUMN_MODIFIED_DATE))); + + // 导出该笔记的内容 String noteId = noteCursor.getString(NOTE_COLUMN_ID); exportNoteToText(noteId, ps); } while (noteCursor.moveToNext()); } noteCursor.close(); } + ps.close(); - return STATE_SUCCESS; } /** - * Get a print stream pointed to the file {@generateExportedTextFile} + * 获取指向导出文件的打印流 + * @return PrintStream对象，失败返回null */ private PrintStream getExportToTextPrintStream() { - File file = generateFileMountedOnSDcard(mContext, R.string.file_path, + // 在SD卡上创建导出文件 + File file = generateFileMountedOnSDcard( + mContext, + R.string.file_path, R.string.file_name_txt_format); + if (file == null) { Log.e(TAG, "create file to exported failed"); return null; } + mFileName = file.getName(); mFileDirectory = mContext.getString(R.string.file_path); - PrintStream ps = null; + try { FileOutputStream fos = new FileOutputStream(file); - ps = new PrintStream(fos); + return new PrintStream(fos); } catch (FileNotFoundException e) { e.printStackTrace(); return null; @@ -305,31 +380,46 @@ public class BackupUtils { e.printStackTrace(); return null; } - return ps; } } /** - * Generate the text file to store imported data + * 在SD卡上生成导出文件 + * @param context 上下文对象 + * @param filePathResId 文件路径资源ID + * @param fileNameFormatResId 文件名格式资源ID + * @return 生成的File对象，失败返回null */ - private static File generateFileMountedOnSDcard(Context context, int filePathResId, int fileNameFormatResId) { + private static File generateFileMountedOnSDcard( + Context context, + int filePathResId, + int fileNameFormatResId) { + StringBuilder sb = new StringBuilder(); sb.append(Environment.getExternalStorageDirectory()); sb.append(context.getString(filePathResId)); + File filedir = new File(sb.toString()); + sb.append(context.getString( fileNameFormatResId, - DateFormat.format(context.getString(R.string.format_date_ymd), + DateFormat.format( + context.getString(R.string.format_date_ymd), System.currentTimeMillis()))); + File file = new File(sb.toString()); try { + // 创建目录（如果不存在） if (!filedir.exists()) { filedir.mkdir(); } + + // 创建文件（如果不存在） if (!file.exists()) { file.createNewFile(); } + return file; } catch (SecurityException e) { e.printStackTrace(); @@ -339,6 +429,4 @@ public class BackupUtils { return null; } -} - - +} \ No newline at end of file diff --git a/src/net/micode/notes/tool/DataUtils.java b/src/net/micode/notes/tool/DataUtils.java index 2a14982..8b809f8 100644 --- a/src/net/micode/notes/tool/DataUtils.java +++ b/src/net/micode/notes/tool/DataUtils.java @@ -34,9 +34,18 @@ import net.micode.notes.ui.NotesListAdapter.AppWidgetAttribute; import java.util.ArrayList; import java.util.HashSet; - +/** + * 数据操作工具类，提供对笔记数据的各种操作功能 + */ public class DataUtils { - public static final String TAG = "DataUtils"; + private static final String TAG = "DataUtils"; + + /** + * 批量删除笔记 + * @param resolver ContentResolver对象 + * @param ids 要删除的笔记ID集合 + * @return true表示删除成功，false表示失败 + */ public static boolean batchDeleteNotes(ContentResolver resolver, HashSet ids) { if (ids == null) { Log.d(TAG, "the ids is null"); @@ -47,17 +56,21 @@ public class DataUtils { return true; } + // 创建批量操作列表 ArrayList operationList = new ArrayList(); for (long id : ids) { if(id == Notes.ID_ROOT_FOLDER) { Log.e(TAG, "Don't delete system folder root"); - continue; + continue; // 跳过系统根目录 } + // 构建删除操作 ContentProviderOperation.Builder builder = ContentProviderOperation .newDelete(ContentUris.withAppendedId(Notes.CONTENT_NOTE_URI, id)); operationList.add(builder.build()); } + 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()); @@ -72,14 +85,28 @@ 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); + values.put(NoteColumns.PARENT_ID, desFolderId); // 设置新的父文件夹ID + values.put(NoteColumns.ORIGIN_PARENT_ID, srcFolderId); // 记录原始父文件夹ID + 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 true表示移动成功，false表示失败 + */ public static boolean batchMoveToFolder(ContentResolver resolver, HashSet ids, long folderId) { if (ids == null) { @@ -89,10 +116,11 @@ public class DataUtils { ArrayList operationList = new ArrayList(); for (long id : ids) { + // 构建更新操作 ContentProviderOperation.Builder builder = ContentProviderOperation .newUpdate(ContentUris.withAppendedId(Notes.CONTENT_NOTE_URI, id)); - builder.withValue(NoteColumns.PARENT_ID, folderId); - builder.withValue(NoteColumns.LOCAL_MODIFIED, 1); + builder.withValue(NoteColumns.PARENT_ID, folderId); // 设置新的父文件夹ID + builder.withValue(NoteColumns.LOCAL_MODIFIED, 1); // 标记为已修改 operationList.add(builder.build()); } @@ -112,7 +140,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 +166,13 @@ public class DataUtils { return count; } + /** + * 检查指定类型笔记是否在数据库中可见（不在回收站中） + * @param resolver ContentResolver对象 + * @param noteId 笔记ID + * @param type 笔记类型 + * @return true表示可见，false表示不可见 + */ public static boolean visibleInNoteDatabase(ContentResolver resolver, long noteId, int type) { Cursor cursor = resolver.query(ContentUris.withAppendedId(Notes.CONTENT_NOTE_URI, noteId), null, @@ -153,6 +190,12 @@ public class DataUtils { return exist; } + /** + * 检查笔记是否存在于数据库中 + * @param resolver ContentResolver对象 + * @param noteId 笔记ID + * @return true表示存在，false表示不存在 + */ 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 +210,12 @@ public class DataUtils { return exist; } + /** + * 检查数据项是否存在于数据库中 + * @param resolver ContentResolver对象 + * @param dataId 数据项ID + * @return true表示存在，false表示不存在 + */ public static boolean existInDataDatabase(ContentResolver resolver, long dataId) { Cursor cursor = resolver.query(ContentUris.withAppendedId(Notes.CONTENT_DATA_URI, dataId), null, null, null, null); @@ -181,6 +230,12 @@ public class DataUtils { return exist; } + /** + * 检查指定名称的文件夹是否已存在（可见文件夹中） + * @param resolver ContentResolver对象 + * @param name 文件夹名称 + * @return true表示存在，false表示不存在 + */ public static boolean checkVisibleFolderName(ContentResolver resolver, String name) { Cursor cursor = resolver.query(Notes.CONTENT_NOTE_URI, null, NoteColumns.TYPE + "=" + Notes.TYPE_FOLDER + @@ -197,6 +252,12 @@ public class DataUtils { return exist; } + /** + * 获取文件夹关联的小部件属性集合 + * @param resolver ContentResolver对象 + * @param folderId 文件夹ID + * @return 小部件属性集合，可能为null + */ public static HashSet getFolderNoteWidget(ContentResolver resolver, long folderId) { Cursor c = resolver.query(Notes.CONTENT_NOTE_URI, new String[] { NoteColumns.WIDGET_ID, NoteColumns.WIDGET_TYPE }, @@ -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,6 +310,13 @@ 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 }, @@ -264,6 +338,13 @@ public class DataUtils { return 0; } + /** + * 根据笔记ID获取内容摘要 + * @param resolver ContentResolver对象 + * @param noteId 笔记ID + * @return 内容摘要 + * @throws IllegalArgumentException 如果笔记不存在 + */ public static String getSnippetById(ContentResolver resolver, long noteId) { Cursor cursor = resolver.query(Notes.CONTENT_NOTE_URI, new String [] { NoteColumns.SNIPPET }, @@ -282,6 +363,11 @@ 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(); @@ -292,4 +378,4 @@ public class DataUtils { } return snippet; } -} +} \ No newline at end of file diff --git a/src/net/micode/notes/tool/GTaskStringUtils.java b/src/net/micode/notes/tool/GTaskStringUtils.java index 666b729..0756a70 100644 --- a/src/net/micode/notes/tool/GTaskStringUtils.java +++ b/src/net/micode/notes/tool/GTaskStringUtils.java @@ -1,113 +1,239 @@ -/* - * Copyright (c) 2010-2011, The MiCode Open Source Community (www.micode.net) - * - * Licensed under the Apache License, Version 2.0 (the "License"); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. +/** + * GTaskStringUtils 是一个工具类，用于定义与 Google 任务 (GTask) 相关的 JSON 字符串常量。 + * 这些常量主要用于在与 GTask 相关的 JSON 数据交互中标识不同的字段和值。 + * 该类提供了一组统一的字符串常量，便于在代码中引用和维护，避免了硬编码字符串的使用，提高了代码的可读性和可维护性。 */ - package net.micode.notes.tool; public class GTaskStringUtils { + /** + * 表示 JSON 数据中的 "action_id" 字段，用于标识操作的唯一 ID。 + */ public final static String GTASK_JSON_ACTION_ID = "action_id"; + /** + * 表示 JSON 数据中的 "action_list" 字段，用于标识操作列表。 + */ public final static String GTASK_JSON_ACTION_LIST = "action_list"; + /** + * 表示 JSON 数据中的 "action_type" 字段，用于标识操作类型。 + */ public final static String GTASK_JSON_ACTION_TYPE = "action_type"; + /** + * 表示 JSON 数据中的 "create" 操作类型，用于创建新任务或列表。 + */ public final static String GTASK_JSON_ACTION_TYPE_CREATE = "create"; + /** + * 表示 JSON 数据中的 "get_all" 操作类型，用于获取所有任务或列表。 + */ public final static String GTASK_JSON_ACTION_TYPE_GETALL = "get_all"; + /** + * 表示 JSON 数据中的 "move" 操作类型，用于移动任务或列表。 + */ public final static String GTASK_JSON_ACTION_TYPE_MOVE = "move"; + /** + * 表示 JSON 数据中的 "update" 操作类型，用于更新任务或列表。 + */ public final static String GTASK_JSON_ACTION_TYPE_UPDATE = "update"; + /** + * 表示 JSON 数据中的 "creator_id" 字段，用于标识创建者的 ID。 + */ public final static String GTASK_JSON_CREATOR_ID = "creator_id"; + /** + * 表示 JSON 数据中的 "child_entity" 字段，用于标识子实体。 + */ public final static String GTASK_JSON_CHILD_ENTITY = "child_entity"; + /** + * 表示 JSON 数据中的 "client_version" 字段，用于标识客户端版本。 + */ public final static String GTASK_JSON_CLIENT_VERSION = "client_version"; + /** + * 表示 JSON 数据中的 "completed" 字段，用于标识任务是否完成。 + */ public final static String GTASK_JSON_COMPLETED = "completed"; + /** + * 表示 JSON 数据中的 "current_list_id" 字段，用于标识当前列表的 ID。 + */ public final static String GTASK_JSON_CURRENT_LIST_ID = "current_list_id"; + /** + * 表示 JSON 数据中的 "default_list_id" 字段，用于标识默认列表的 ID。 + */ public final static String GTASK_JSON_DEFAULT_LIST_ID = "default_list_id"; + /** + * 表示 JSON 数据中的 "deleted" 字段，用于标识任务或列表是否被删除。 + */ public final static String GTASK_JSON_DELETED = "deleted"; + /** + * 表示 JSON 数据中的 "dest_list" 字段，用于标识目标列表。 + */ public final static String GTASK_JSON_DEST_LIST = "dest_list"; + /** + * 表示 JSON 数据中的 "dest_parent" 字段，用于标识目标父实体。 + */ public final static String GTASK_JSON_DEST_PARENT = "dest_parent"; + /** + * 表示 JSON 数据中的 "dest_parent_type" 字段，用于标识目标父实体的类型。 + */ public final static String GTASK_JSON_DEST_PARENT_TYPE = "dest_parent_type"; + /** + * 表示 JSON 数据中的 "entity_delta" 字段，用于标识实体的差异信息。 + */ public final static String GTASK_JSON_ENTITY_DELTA = "entity_delta"; + /** + * 表示 JSON 数据中的 "entity_type" 字段，用于标识实体的类型。 + */ public final static String GTASK_JSON_ENTITY_TYPE = "entity_type"; + /** + * 表示 JSON 数据中的 "get_deleted" 字段，用于标识是否获取已删除的任务或列表。 + */ public final static String GTASK_JSON_GET_DELETED = "get_deleted"; + /** + * 表示 JSON 数据中的 "id" 字段，用于标识任务或列表的唯一 ID。 + */ public final static String GTASK_JSON_ID = "id"; + /** + * 表示 JSON 数据中的 "index" 字段，用于标识任务或列表的索引位置。 + */ public final static String GTASK_JSON_INDEX = "index"; + /** + * 表示 JSON 数据中的 "last_modified" 字段，用于标识任务或列表的最后修改时间。 + */ public final static String GTASK_JSON_LAST_MODIFIED = "last_modified"; + /** + * 表示 JSON 数据中的 "latest_sync_point" 字段，用于标识最新的同步点。 + */ public final static String GTASK_JSON_LATEST_SYNC_POINT = "latest_sync_point"; + /** + * 表示 JSON 数据中的 "list_id" 字段，用于标识列表的 ID。 + */ public final static String GTASK_JSON_LIST_ID = "list_id"; + /** + * 表示 JSON 数据中的 "lists" 字段，用于标识列表集合。 + */ public final static String GTASK_JSON_LISTS = "lists"; + /** + * 表示 JSON 数据中的 "name" 字段，用于标识任务或列表的名称。 + */ public final static String GTASK_JSON_NAME = "name"; + /** + * 表示 JSON 数据中的 "new_id" 字段，用于标识新任务或列表的 ID。 + */ public final static String GTASK_JSON_NEW_ID = "new_id"; + /** + * 表示 JSON 数据中的 "notes" 字段，用于标识任务的备注信息。 + */ public final static String GTASK_JSON_NOTES = "notes"; + /** + * 表示 JSON 数据中的 "parent_id" 字段，用于标识父实体的 ID。 + */ public final static String GTASK_JSON_PARENT_ID = "parent_id"; + /** + * 表示 JSON 数据中的 "prior_sibling_id" 字段，用于标识前一个兄弟实体的 ID。 + */ public final static String GTASK_JSON_PRIOR_SIBLING_ID = "prior_sibling_id"; + /** + * 表示 JSON 数据中的 "results" 字段，用于标识操作结果。 + */ public final static String GTASK_JSON_RESULTS = "results"; + /** + * 表示 JSON 数据中的 "source_list" 字段，用于标识源列表。 + */ public final static String GTASK_JSON_SOURCE_LIST = "source_list"; + /** + * 表示 JSON 数据中的 "tasks" 字段，用于标识任务集合。 + */ public final static String GTASK_JSON_TASKS = "tasks"; + /** + * 表示 JSON 数据中的 "type" 字段，用于标识实体的类型。 + */ public final static String GTASK_JSON_TYPE = "type"; + /** + * 表示 JSON 数据中的 "GROUP" 类型，用于标识组实体。 + */ public final static String GTASK_JSON_TYPE_GROUP = "GROUP"; + /** + * 表示 JSON 数据中的 "TASK" 类型，用于标识任务实体。 + */ public final static String GTASK_JSON_TYPE_TASK = "TASK"; + /** + * 表示 JSON 数据中的 "user" 字段，用于标识用户信息。 + */ public final static String GTASK_JSON_USER = "user"; + /** + * 表示 MIUI 笔记文件夹的前缀名称。 + */ 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"; + /** + * 表示元数据头部的笔记字段。 + */ public final static String META_HEAD_NOTE = "meta_note"; + /** + * 表示元数据头部的数据字段。 + */ public final static String META_HEAD_DATA = "meta_data"; + /** + * 表示元数据笔记的名称，用于标识元数据笔记，提示用户不要更新和删除。 + */ public final static String META_NOTE_NAME = "[META INFO] DON'T UPDATE AND DELETE"; - -} +} \ No newline at end of file diff --git a/src/net/micode/notes/tool/ResourceParser.java b/src/net/micode/notes/tool/ResourceParser.java index 1ad3ad6..3ed095c 100644 --- a/src/net/micode/notes/tool/ResourceParser.java +++ b/src/net/micode/notes/tool/ResourceParser.java @@ -1,71 +1,79 @@ /* * Copyright (c) 2010-2011, The MiCode Open Source Community (www.micode.net) * - * Licensed under the Apache License, Version 2.0 (the "License"); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. + * 根据Apache License 2.0授权 (http://www.apache.org/licenses/LICENSE-2.0) */ package net.micode.notes.tool; import android.content.Context; import android.preference.PreferenceManager; - import net.micode.notes.R; import net.micode.notes.ui.NotesPreferenceActivity; +/** + * 资源解析工具类 + * 提供便签背景、文字大小等资源的解析功能 + */ 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 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; + public static final int BG_DEFAULT_FONT_SIZE = TEXT_MEDIUM; // 默认字体大小(中号) + /** + * 便签编辑界面背景资源 + */ public static class NoteBgResources { + // 编辑区域背景资源ID数组 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 + R.drawable.edit_yellow, // 黄色背景 + R.drawable.edit_blue, // 蓝色背景 + R.drawable.edit_white, // 白色背景 + R.drawable.edit_green, // 绿色背景 + R.drawable.edit_red // 红色背景 }; + // 标题区域背景资源ID数组 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 + 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 + * @param context 上下文对象 + * @return 背景ID (如果设置了随机背景则返回随机ID，否则返回默认黄色背景) + */ public static int getDefaultBgId(Context context) { + // 检查偏好设置中是否启用了随机背景颜色 if (PreferenceManager.getDefaultSharedPreferences(context).getBoolean( NotesPreferenceActivity.PREFERENCE_SET_BG_COLOR_KEY, false)) { return (int) (Math.random() * NoteBgResources.BG_EDIT_RESOURCES.length); @@ -74,15 +82,20 @@ public class ResourceParser { } } + /** + * 便签列表项背景资源 + */ 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 + 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, @@ -91,6 +104,7 @@ public class ResourceParser { R.drawable.list_red_middle }; + // 列表最后一项背景资源 private final static int [] BG_LAST_RESOURCES = new int [] { R.drawable.list_yellow_down, R.drawable.list_blue_down, @@ -99,6 +113,7 @@ public class ResourceParser { R.drawable.list_red_down, }; + // 列表单项背景资源(当列表只有一项时使用) private final static int [] BG_SINGLE_RESOURCES = new int [] { R.drawable.list_yellow_single, R.drawable.list_blue_single, @@ -107,28 +122,37 @@ public class ResourceParser { R.drawable.list_red_single }; + // 获取列表第一项背景资源 public static int getNoteBgFirstRes(int id) { return BG_FIRST_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; } } + /** + * 桌面小部件背景资源 + */ public static class WidgetBgResources { + // 2x大小小部件背景资源 private final static int [] BG_2X_RESOURCES = new int [] { R.drawable.widget_2x_yellow, R.drawable.widget_2x_blue, @@ -137,10 +161,12 @@ public class ResourceParser { R.drawable.widget_2x_red, }; + // 获取2x大小小部件背景资源 public static int getWidget2xBgResource(int id) { return BG_2X_RESOURCES[id]; } + // 4x大小小部件背景资源 private final static int [] BG_4X_RESOURCES = new int [] { R.drawable.widget_4x_yellow, R.drawable.widget_4x_blue, @@ -149,33 +175,41 @@ public class ResourceParser { R.drawable.widget_4x_red }; + // 获取4x大小小部件背景资源 public static int getWidget4xBgResource(int id) { return BG_4X_RESOURCES[id]; } } + /** + * 文字外观资源 + */ public static class TextAppearanceResources { + // 文字外观样式资源数组 private final static int [] TEXTAPPEARANCE_RESOURCES = new int [] { - R.style.TextAppearanceNormal, - R.style.TextAppearanceMedium, - R.style.TextAppearanceLarge, - R.style.TextAppearanceSuper + R.style.TextAppearanceNormal, // 正常大小 + R.style.TextAppearanceMedium, // 中等大小 + R.style.TextAppearanceLarge, // 大号 + R.style.TextAppearanceSuper // 超大号 }; + /** + * 获取文字外观资源 + * @param id 资源ID + * @return 样式资源ID (如果id超出范围则返回默认字体大小) + * + * 注意：修复了在SharedPreference中存储资源id可能越界的bug + */ 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; } return TEXTAPPEARANCE_RESOURCES[id]; } + // 获取可用文字外观资源数量 public static int getResourcesSize() { return TEXTAPPEARANCE_RESOURCES.length; } } -} +} \ No newline at end of file