From cdcea59d78360029c4211b0d74bebf1432f79bb1 Mon Sep 17 00:00:00 2001 From: linue <1355214509@qq.com> Date: Tue, 23 Dec 2025 18:30:38 +0800 Subject: [PATCH] 1 --- src/notes/data/Contact.java | 58 +- src/notes/data/Notes.java | 259 ++++++--- src/notes/data/NotesDatabaseHelper.java | 425 +++++++++----- src/notes/data/NotesProvider.java | 242 +++++++- src/notes/gtask/data/MetaData.java | 83 ++- src/notes/gtask/data/Node.java | 118 +++- src/notes/gtask/data/SqlData.java | 154 ++++- src/notes/tool/BackupUtils.java | 425 ++++++++++---- src/notes/tool/DataUtils.java | 275 +++++++-- src/notes/tool/GTaskStringUtils.java | 130 ++++- src/notes/tool/ResourceParser.java | 259 ++++++--- src/notes/ui/AlarmAlertActivity.java | 206 +++++-- src/notes/ui/AlarmInitReceiver.java | 126 +++- src/notes/ui/AlarmReceiver.java | 55 +- src/notes/ui/DateTimePicker.java | 609 +++++++++++++------- src/notes/ui/DateTimePickerDialog.java | 146 ++++- src/notes/ui/DropdownMenu.java | 133 ++++- src/notes/ui/FoldersListAdapter.java | 147 ++++- src/notes/ui/NoteEditActivity.java | 576 +++++++++++++----- src/notes/ui/NoteEditText.java | 232 ++++++-- src/notes/ui/NoteItemData.java | 309 ++++++++-- src/notes/ui/NotesListActivity.java | 514 +++++++++++++---- src/notes/ui/NotesListAdapter.java | 184 +++++- src/notes/ui/NotesListItem.java | 233 ++++++-- src/notes/ui/NotesPreferenceActivity.java | 300 ++++++++-- src/notes/widget/NoteWidgetProvider.java | 193 +++++-- src/notes/widget/NoteWidgetProvider_2x.java | 66 ++- src/notes/widget/NoteWidgetProvider_4x.java | 72 ++- 28 files changed, 5118 insertions(+), 1411 deletions(-) diff --git a/src/notes/data/Contact.java b/src/notes/data/Contact.java index d97ac5d..782ede7 100644 --- a/src/notes/data/Contact.java +++ b/src/notes/data/Contact.java @@ -25,28 +25,73 @@ import android.util.Log; import java.util.HashMap; +/** + * 联系人工具类 + * 核心功能：根据电话号码从安卓系统的联系人数据库中查询对应的联系人名称， + * 并通过静态HashMap实现缓存机制，避免重复查询数据库，提升查询性能 + * 该类为工具类，所有成员和方法均为静态，无需实例化即可调用 + */ public class Contact { + /** + * 静态缓存集合，存储电话号码与联系人名称的映射关系 + * Key：电话号码（String类型），Value：对应的联系人名称（String类型） + * 采用静态HashMap实现全局缓存，跨多次方法调用共享数据 + */ private static HashMap sContactCache; + + /** + * 日志标签，用于Logcat输出时标识当前类，方便调试时定位问题 + */ private static final String TAG = "Contact"; + /** + * 联系人查询的筛选条件模板（SQL WHERE子句） + * 逻辑拆解： + * 1. PHONE_NUMBERS_EQUAL(Phone.NUMBER,?)：使用系统方法匹配传入的电话号码（兼容不同格式的号码） + * 2. Data.MIMETYPE = Phone.CONTENT_ITEM_TYPE：限定查询数据类型为电话类型（过滤非电话的联系人数据） + * 3. Data.RAW_CONTACT_ID IN (子查询)：关联phone_lookup表，获取匹配的原始联系人ID（"+"为占位符，后续替换为具体匹配值） + */ private static final String CALLER_ID_SELECTION = "PHONE_NUMBERS_EQUAL(" + Phone.NUMBER - + ",?) AND " + Data.MIMETYPE + "='" + Phone.CONTENT_ITEM_TYPE + "'" - + " AND " + Data.RAW_CONTACT_ID + " IN " + + ",?) AND " + Data.MIMETYPE + "='" + Phone.CONTENT_ITEM_TYPE + "'" + + " AND " + Data.RAW_CONTACT_ID + " IN " + "(SELECT raw_contact_id " + " FROM phone_lookup" + " WHERE min_match = '+')"; + /** + * 根据电话号码获取对应的联系人名称 + * 处理流程： + * 1. 初始化缓存集合（首次调用时） + * 2. 检查缓存：若电话号码已在缓存中，直接返回联系人名称（缓存命中） + * 3. 处理筛选条件：替换模板中的占位符为电话号码的最小匹配值 + * 4. 查询联系人数据库：通过ContentResolver获取联系人名称 + * 5. 将查询结果存入缓存，返回名称；若查询失败则返回null + * + * @param context 上下文对象，用于获取ContentResolver以访问安卓联系人数据库 + * @param phoneNumber 要查询的电话号码（String类型，支持不同格式的号码） + * @return 对应的联系人名称（查询不到则返回null） + */ public static String getContact(Context context, String phoneNumber) { + // 首次调用方法时，初始化静态缓存集合 if(sContactCache == null) { sContactCache = new HashMap(); } + // 缓存命中：直接返回缓存中的联系人名称，避免数据库查询 if(sContactCache.containsKey(phoneNumber)) { return sContactCache.get(phoneNumber); } + // 替换筛选条件模板中的"+"占位符为电话号码的最小匹配值（系统工具类处理，提升号码匹配准确性） String selection = CALLER_ID_SELECTION.replace("+", PhoneNumberUtils.toCallerIDMinMatch(phoneNumber)); + // 调用ContentResolver查询联系人数据库 + // 参数说明： + // 1. Data.CONTENT_URI：安卓联系人数据的总URI + // 2. 投影数组：仅查询Phone.DISPLAY_NAME列（联系人名称），减少数据传输 + // 3. selection：处理后的筛选条件 + // 4. selectionArgs：传入电话号码作为查询参数（防止SQL注入） + // 5. sortOrder：排序规则（null表示无需排序） Cursor cursor = context.getContentResolver().query( Data.CONTENT_URI, new String [] { Phone.DISPLAY_NAME }, @@ -54,20 +99,27 @@ public class Contact { new String[] { phoneNumber }, null); + // 游标非空且包含数据时，处理查询结果 if (cursor != null && cursor.moveToFirst()) { try { + // 获取联系人名称（索引0对应投影数组中的Phone.DISPLAY_NAME） String name = cursor.getString(0); + // 将电话号码和名称存入缓存，供后续调用使用 sContactCache.put(phoneNumber, name); + // 返回查询到的联系人名称 return name; } catch (IndexOutOfBoundsException e) { + // 捕获索引越界异常（如游标数据异常时），输出错误日志 Log.e(TAG, " Cursor get string error " + e.toString()); return null; } finally { + // 最终关闭游标，释放数据库资源（必须执行，避免资源泄漏） cursor.close(); } } else { + // 游标为空或无数据时，输出调试日志，返回null Log.d(TAG, "No contact matched with number:" + phoneNumber); return null; } } -} +} \ No newline at end of file diff --git a/src/notes/data/Notes.java b/src/notes/data/Notes.java index f240604..1592d5d 100644 --- a/src/notes/data/Notes.java +++ b/src/notes/data/Notes.java @@ -17,263 +17,368 @@ package net.micode.notes.data; import android.net.Uri; + +/** + * 笔记应用的核心数据常量类 + * 该类集中定义了笔记应用的所有核心常量：包括ContentProvider的授权名、数据URI、笔记/文件夹类型、系统文件夹ID、 + * Intent传递的参数键、Widget类型、数据表列名、文本笔记/通话笔记的专属常量等 + * 是整个应用数据交互（ContentProvider、Intent传参、数据库操作）的核心常量定义类，采用静态常量和内部类/接口的方式组织，提高代码可读性和维护性 + * + * @author MiCode Open Source Community + * @date 2010-2011 + */ public class Notes { + /** + * ContentProvider的授权名（Authority），是ContentProvider的唯一标识 + * 用于ContentResolver访问应用的NotesProvider（content://micode_notes/...） + */ public static final String AUTHORITY = "micode_notes"; + + /** + * 日志标签，用于Logcat输出时标识当前类，方便调试定位问题 + */ public static final String TAG = "Notes"; + + /** + * 数据类型常量：普通笔记类型 + */ public static final int TYPE_NOTE = 0; + + /** + * 数据类型常量：文件夹类型 + */ public static final int TYPE_FOLDER = 1; + + /** + * 数据类型常量：系统类型（系统文件夹/系统笔记） + */ public static final int TYPE_SYSTEM = 2; /** - * Following IDs are system folders' identifiers - * {@link Notes#ID_ROOT_FOLDER } is default folder - * {@link Notes#ID_TEMPARAY_FOLDER } is for notes belonging no folder - * {@link Notes#ID_CALL_RECORD_FOLDER} is to store call records + * 以下是系统文件夹的唯一标识ID，用于区分不同的系统预设文件夹 + * {@link Notes#ID_ROOT_FOLDER }：根文件夹（默认文件夹） + * {@link Notes#ID_TEMPARAY_FOLDER }：临时文件夹（存放无归属的笔记） + * {@link Notes#ID_CALL_RECORD_FOLDER}：通话记录文件夹（专门存储通话记录笔记） + * {@link Notes#ID_TRASH_FOLER}：回收站文件夹（存放被删除的笔记/文件夹） */ + // 根文件夹ID（默认文件夹，所有无指定文件夹的笔记默认归属此文件夹） public static final int ID_ROOT_FOLDER = 0; + // 临时文件夹ID（存放临时、无归属的笔记） public static final int ID_TEMPARAY_FOLDER = -1; + // 通话记录文件夹ID（专门存储通话记录类型的笔记） public static final int ID_CALL_RECORD_FOLDER = -2; + // 回收站文件夹ID（存放被用户删除的笔记或文件夹） public static final int ID_TRASH_FOLER = -3; + /** + * Intent传递参数的键常量：笔记的提醒日期（alert_date） + */ public static final String INTENT_EXTRA_ALERT_DATE = "net.micode.notes.alert_date"; + /** + * Intent传递参数的键常量：笔记的背景颜色ID（background_color_id） + */ public static final String INTENT_EXTRA_BACKGROUND_ID = "net.micode.notes.background_color_id"; + /** + * Intent传递参数的键常量：Widget的ID（widget_id） + */ public static final String INTENT_EXTRA_WIDGET_ID = "net.micode.notes.widget_id"; + /** + * Intent传递参数的键常量：Widget的类型（widget_type） + */ public static final String INTENT_EXTRA_WIDGET_TYPE = "net.micode.notes.widget_type"; + /** + * Intent传递参数的键常量：文件夹的ID（folder_id） + */ public static final String INTENT_EXTRA_FOLDER_ID = "net.micode.notes.folder_id"; + /** + * Intent传递参数的键常量：通话记录的日期（call_date） + */ public static final String INTENT_EXTRA_CALL_DATE = "net.micode.notes.call_date"; + /** + * Widget类型常量：无效的Widget类型 + */ public static final int TYPE_WIDGET_INVALIDE = -1; + /** + * Widget类型常量：2x2尺寸的笔记Widget + */ public static final int TYPE_WIDGET_2X = 0; + /** + * Widget类型常量：4x4尺寸的笔记Widget + */ public static final int TYPE_WIDGET_4X = 1; + /** + * 数据类型常量内部类：封装文本笔记和通话笔记的MIME类型常量 + * 用于区分不同类型的笔记数据（ContentProvider的MIME类型标识） + */ public static class DataConstants { + // 文本笔记的MIME类型（对应TextNote的CONTENT_ITEM_TYPE） public static final String NOTE = TextNote.CONTENT_ITEM_TYPE; + // 通话笔记的MIME类型（对应CallNote的CONTENT_ITEM_TYPE） public static final String CALL_NOTE = CallNote.CONTENT_ITEM_TYPE; } /** - * Uri to query all notes and folders + * ContentProvider的URI常量：用于查询所有笔记和文件夹的URI + * 格式：content://micode_notes/note */ public static final Uri CONTENT_NOTE_URI = Uri.parse("content://" + AUTHORITY + "/note"); /** - * Uri to query data + * ContentProvider的URI常量：用于查询笔记明细数据的URI + * 格式：content://micode_notes/data */ public static final Uri CONTENT_DATA_URI = Uri.parse("content://" + AUTHORITY + "/data"); + /** + * 笔记/文件夹表的列名接口 + * 定义了note表中所有列的名称、数据类型和业务含义，是数据库操作和ContentProvider查询的核心列名规范 + */ public interface NoteColumns { /** - * The unique ID for a row - *

Type: INTEGER (long)

+ * 行的唯一ID（主键） + *

数据类型: INTEGER (long)

*/ public static final String ID = "_id"; /** - * The parent's id for note or folder - *

Type: INTEGER (long)

+ * 笔记/文件夹的父级ID（用于关联文件夹和子笔记/子文件夹） + *

数据类型: INTEGER (long)

*/ public static final String PARENT_ID = "parent_id"; /** - * Created data for note or folder - *

Type: INTEGER (long)

+ * 笔记/文件夹的创建时间 + *

数据类型: INTEGER (long)（时间戳，毫秒）

*/ public static final String CREATED_DATE = "created_date"; /** - * Latest modified date - *

Type: INTEGER (long)

+ * 笔记/文件夹的最后修改时间 + *

数据类型: INTEGER (long)（时间戳，毫秒）

*/ public static final String MODIFIED_DATE = "modified_date"; - /** - * Alert date - *

Type: INTEGER (long)

+ * 笔记的提醒时间（文件夹无此属性） + *

数据类型: INTEGER (long)（时间戳，毫秒）

*/ public static final String ALERTED_DATE = "alert_date"; /** - * Folder's name or text content of note - *

Type: TEXT

+ * 文件夹的名称 / 笔记的文本摘要（预览内容） + *

数据类型: TEXT

*/ public static final String SNIPPET = "snippet"; /** - * Note's widget id - *

Type: INTEGER (long)

+ * 笔记关联的Widget ID（若笔记被添加到桌面Widget，存储对应的Widget ID） + *

数据类型: INTEGER (long)

*/ public static final String WIDGET_ID = "widget_id"; /** - * Note's widget type - *

Type: INTEGER (long)

+ * 笔记关联的Widget类型（2x2/4x4，对应TYPE_WIDGET_2X/TYPE_WIDGET_4X） + *

数据类型: INTEGER (long)

*/ public static final String WIDGET_TYPE = "widget_type"; /** - * Note's background color's id - *

Type: INTEGER (long)

+ * 笔记的背景颜色ID（对应预设的背景颜色资源ID） + *

数据类型: INTEGER (long)

*/ public static final String BG_COLOR_ID = "bg_color_id"; /** - * For text note, it doesn't has attachment, for multi-media - * note, it has at least one attachment - *

Type: INTEGER

+ * 笔记是否有附件（文本笔记无附件，多媒体笔记有附件） + *

数据类型: INTEGER（1：有附件，0：无附件）

*/ public static final String HAS_ATTACHMENT = "has_attachment"; /** - * Folder's count of notes - *

Type: INTEGER (long)

+ * 文件夹下的笔记数量（用于文件夹的数量统计） + *

数据类型: INTEGER (long)

*/ public static final String NOTES_COUNT = "notes_count"; /** - * The file type: folder or note - *

Type: INTEGER

+ * 数据类型（区分笔记/文件夹/系统类型，对应TYPE_NOTE/TYPE_FOLDER/TYPE_SYSTEM） + *

数据类型: INTEGER

*/ public static final String TYPE = "type"; /** - * The last sync id - *

Type: INTEGER (long)

+ * 最后一次同步的ID（用于GTask同步，标记同步状态） + *

数据类型: INTEGER (long)

*/ public static final String SYNC_ID = "sync_id"; /** - * Sign to indicate local modified or not - *

Type: INTEGER

+ * 本地修改标记（标记数据是否在本地被修改，需要同步到远程/GTask） + *

数据类型: INTEGER（1：已修改，0：未修改）

*/ public static final String LOCAL_MODIFIED = "local_modified"; /** - * Original parent id before moving into temporary folder - *

Type : INTEGER

+ * 移动到临时文件夹前的原始父级ID（用于恢复笔记的原始归属文件夹） + *

数据类型: INTEGER (long)

*/ public static final String ORIGIN_PARENT_ID = "origin_parent_id"; /** - * The gtask id - *

Type : TEXT

+ * GTask的ID（用于笔记与谷歌任务的同步关联） + *

数据类型: TEXT

*/ public static final String GTASK_ID = "gtask_id"; /** - * The version code - *

Type : INTEGER (long)

+ * 版本号（用于数据同步时的版本控制，避免数据冲突） + *

数据类型: INTEGER (long)

*/ public static final String VERSION = "version"; } + /** + * 笔记明细数据表的列名接口 + * 定义了data表中所有列的名称、数据类型和业务含义，data表存储笔记的具体内容（文本、通话记录等） + */ public interface DataColumns { /** - * The unique ID for a row - *

Type: INTEGER (long)

+ * 行的唯一ID（主键） + *

数据类型: INTEGER (long)

*/ public static final String ID = "_id"; /** - * The MIME type of the item represented by this row. - *

Type: Text

+ * 数据的MIME类型（区分文本笔记/通话笔记，对应TextNote/CALLNote的CONTENT_ITEM_TYPE） + *

数据类型: Text

*/ public static final String MIME_TYPE = "mime_type"; /** - * The reference id to note that this data belongs to - *

Type: INTEGER (long)

+ * 关联的笔记ID（指向note表的_id，建立data表与note表的关联） + *

数据类型: INTEGER (long)

*/ public static final String NOTE_ID = "note_id"; /** - * Created data for note or folder - *

Type: INTEGER (long)

+ * 数据的创建时间 + *

数据类型: INTEGER (long)（时间戳，毫秒）

*/ public static final String CREATED_DATE = "created_date"; /** - * Latest modified date - *

Type: INTEGER (long)

+ * 数据的最后修改时间 + *

数据类型: INTEGER (long)（时间戳，毫秒）

*/ public static final String MODIFIED_DATE = "modified_date"; /** - * Data's content - *

Type: TEXT

+ * 数据的内容（文本笔记的文本内容、通话笔记的附件位置等） + *

数据类型: TEXT

*/ public static final String CONTENT = "content"; - /** - * Generic data column, the meaning is {@link #MIMETYPE} specific, used for - * integer data type - *

Type: INTEGER

+ * 通用数据列1（含义由MIME_TYPE决定，用于整型数据） + *

数据类型: INTEGER

*/ public static final String DATA1 = "data1"; /** - * Generic data column, the meaning is {@link #MIMETYPE} specific, used for - * integer data type - *

Type: INTEGER

+ * 通用数据列2（含义由MIME_TYPE决定，用于整型数据） + *

数据类型: INTEGER

*/ public static final String DATA2 = "data2"; /** - * Generic data column, the meaning is {@link #MIMETYPE} specific, used for - * TEXT data type - *

Type: TEXT

+ * 通用数据列3（含义由MIME_TYPE决定，用于文本数据） + *

数据类型: TEXT

*/ public static final String DATA3 = "data3"; /** - * Generic data column, the meaning is {@link #MIMETYPE} specific, used for - * TEXT data type - *

Type: TEXT

+ * 通用数据列4（含义由MIME_TYPE决定，用于文本数据） + *

数据类型: TEXT

*/ public static final String DATA4 = "data4"; /** - * Generic data column, the meaning is {@link #MIMETYPE} specific, used for - * TEXT data type - *

Type: TEXT

+ * 通用数据列5（含义由MIME_TYPE决定，用于文本数据） + *

数据类型: TEXT

*/ public static final String DATA5 = "data5"; } + /** + * 文本笔记的专属常量类，实现DataColumns接口复用列名定义 + * 定义了文本笔记的模式（普通/复选列表）、MIME类型、ContentProvider URI等专属常量 + */ public static final class TextNote implements DataColumns { /** - * Mode to indicate the text in check list mode or not - *

Type: Integer 1:check list mode 0: normal mode

+ * 文本笔记的模式（对应DATA1列）：标识是否为复选列表模式 + *

数据类型: Integer（1：复选列表模式，0：普通文本模式）

*/ public static final String MODE = DATA1; + /** + * 文本笔记的模式常量：复选列表模式 + */ public static final int MODE_CHECK_LIST = 1; + /** + * 文本笔记的集合MIME类型（对应ContentProvider的dir类型） + * 格式：vnd.android.cursor.dir/text_note + */ public static final String CONTENT_TYPE = "vnd.android.cursor.dir/text_note"; + /** + * 文本笔记的单个项目MIME类型（对应ContentProvider的item类型） + * 格式：vnd.android.cursor.item/text_note + */ public static final String CONTENT_ITEM_TYPE = "vnd.android.cursor.item/text_note"; + /** + * 文本笔记的ContentProvider URI + * 格式：content://micode_notes/text_note + */ public static final Uri CONTENT_URI = Uri.parse("content://" + AUTHORITY + "/text_note"); } + /** + * 通话记录笔记的专属常量类，实现DataColumns接口复用列名定义 + * 定义了通话笔记的通话日期、电话号码的列映射、MIME类型、ContentProvider URI等专属常量 + */ public static final class CallNote implements DataColumns { /** - * Call date for this record - *

Type: INTEGER (long)

+ * 通话记录的日期（对应DATA1列，存储通话时间戳） + *

数据类型: INTEGER (long)（时间戳，毫秒）

*/ public static final String CALL_DATE = DATA1; /** - * Phone number for this record - *

Type: TEXT

+ * 通话记录的电话号码（对应DATA3列，存储电话号码字符串） + *

数据类型: TEXT

*/ public static final String PHONE_NUMBER = DATA3; + /** + * 通话笔记的集合MIME类型（对应ContentProvider的dir类型） + * 格式：vnd.android.cursor.dir/call_note + */ public static final String CONTENT_TYPE = "vnd.android.cursor.dir/call_note"; + /** + * 通话笔记的单个项目MIME类型（对应ContentProvider的item类型） + * 格式：vnd.android.cursor.item/call_note + */ public static final String CONTENT_ITEM_TYPE = "vnd.android.cursor.item/call_note"; + /** + * 通话笔记的ContentProvider URI + * 格式：content://micode_notes/call_note + */ public static final Uri CONTENT_URI = Uri.parse("content://" + AUTHORITY + "/call_note"); } -} +} \ No newline at end of file diff --git a/src/notes/data/NotesDatabaseHelper.java b/src/notes/data/NotesDatabaseHelper.java index ffe5d57..516988f 100644 --- a/src/notes/data/NotesDatabaseHelper.java +++ b/src/notes/data/NotesDatabaseHelper.java @@ -26,198 +26,282 @@ import net.micode.notes.data.Notes.DataColumns; import net.micode.notes.data.Notes.DataConstants; import net.micode.notes.data.Notes.NoteColumns; - +/** + * 笔记应用的SQLite数据库帮助类，继承自Android的SQLiteOpenHelper + * 核心功能： + * 1. 采用单例模式管理数据库实例，避免多实例导致的数据库锁问题； + * 2. 创建笔记应用的核心数据表（note表、data表）及索引； + * 3. 定义数据库触发器，实现数据联动逻辑（如文件夹笔记数量自动更新、笔记内容同步等）； + * 4. 初始化系统预设文件夹（根目录、通话记录、临时、回收站）； + * 5. 处理数据库版本升级，保证数据迁移的兼容性。 + * + * @author MiCode Open Source Community + * @date 2010-2011 + */ public class NotesDatabaseHelper extends SQLiteOpenHelper { + /** + * 数据库文件名，存储在应用的私有数据目录下 + */ private static final String DB_NAME = "note.db"; + /** + * 数据库版本号，用于版本升级控制（当前为4） + */ private static final int DB_VERSION = 4; + /** + * 数据表名称接口，定义note表和data表的名称常量，提高代码可读性 + */ public interface TABLE { + // 笔记/文件夹表名称 public static final String NOTE = "note"; - + // 笔记明细数据表名称（存储文本、通话记录等具体内容） public static final String DATA = "data"; } + /** + * 日志标签，用于Logcat输出时标识当前类，方便调试定位问题 + */ private static final String TAG = "NotesDatabaseHelper"; + /** + * 单例实例，全局唯一的NotesDatabaseHelper对象 + * 采用静态变量存储，避免多次创建数据库帮助类实例 + */ private static NotesDatabaseHelper mInstance; + // ====================== 数据表创建SQL语句 ====================== + /** + * 创建note表的SQL语句 + * note表存储笔记和文件夹的基础信息（如ID、父级ID、创建时间、类型等） + * 所有列均设置默认值，保证数据完整性；主键为ID（自增整型） + */ private static final String CREATE_NOTE_TABLE_SQL = - "CREATE TABLE " + TABLE.NOTE + "(" + - NoteColumns.ID + " INTEGER PRIMARY KEY," + - NoteColumns.PARENT_ID + " INTEGER NOT NULL DEFAULT 0," + - NoteColumns.ALERTED_DATE + " INTEGER NOT NULL DEFAULT 0," + - NoteColumns.BG_COLOR_ID + " INTEGER NOT NULL DEFAULT 0," + - NoteColumns.CREATED_DATE + " INTEGER NOT NULL DEFAULT (strftime('%s','now') * 1000)," + - NoteColumns.HAS_ATTACHMENT + " INTEGER NOT NULL DEFAULT 0," + - NoteColumns.MODIFIED_DATE + " INTEGER NOT NULL DEFAULT (strftime('%s','now') * 1000)," + - NoteColumns.NOTES_COUNT + " INTEGER NOT NULL DEFAULT 0," + - NoteColumns.SNIPPET + " TEXT NOT NULL DEFAULT ''," + - NoteColumns.TYPE + " INTEGER NOT NULL DEFAULT 0," + - NoteColumns.WIDGET_ID + " INTEGER NOT NULL DEFAULT 0," + - NoteColumns.WIDGET_TYPE + " INTEGER NOT NULL DEFAULT -1," + - NoteColumns.SYNC_ID + " INTEGER NOT NULL DEFAULT 0," + - NoteColumns.LOCAL_MODIFIED + " INTEGER NOT NULL DEFAULT 0," + - NoteColumns.ORIGIN_PARENT_ID + " INTEGER NOT NULL DEFAULT 0," + - NoteColumns.GTASK_ID + " TEXT NOT NULL DEFAULT ''," + - NoteColumns.VERSION + " INTEGER NOT NULL DEFAULT 0" + - ")"; + "CREATE TABLE " + TABLE.NOTE + "(" + + NoteColumns.ID + " INTEGER PRIMARY KEY," + // 主键ID + NoteColumns.PARENT_ID + " INTEGER NOT NULL DEFAULT 0," + // 父级ID（关联文件夹） + NoteColumns.ALERTED_DATE + " INTEGER NOT NULL DEFAULT 0," + // 提醒时间 + NoteColumns.BG_COLOR_ID + " INTEGER NOT NULL DEFAULT 0," + // 背景颜色ID + // 创建时间：默认值为当前时间戳（秒转毫秒） + NoteColumns.CREATED_DATE + " INTEGER NOT NULL DEFAULT (strftime('%s','now') * 1000)," + + NoteColumns.HAS_ATTACHMENT + " INTEGER NOT NULL DEFAULT 0," + // 是否有附件 + // 修改时间：默认值为当前时间戳 + NoteColumns.MODIFIED_DATE + " INTEGER NOT NULL DEFAULT (strftime('%s','now') * 1000)," + + NoteColumns.NOTES_COUNT + " INTEGER NOT NULL DEFAULT 0," + // 文件夹下的笔记数量 + NoteColumns.SNIPPET + " TEXT NOT NULL DEFAULT ''," + // 文件夹名称/笔记摘要 + NoteColumns.TYPE + " INTEGER NOT NULL DEFAULT 0," + // 类型（笔记/文件夹/系统） + NoteColumns.WIDGET_ID + " INTEGER NOT NULL DEFAULT 0," + // 关联的Widget ID + NoteColumns.WIDGET_TYPE + " INTEGER NOT NULL DEFAULT -1," + // 关联的Widget类型 + NoteColumns.SYNC_ID + " INTEGER NOT NULL DEFAULT 0," + // 同步ID（GTask） + NoteColumns.LOCAL_MODIFIED + " INTEGER NOT NULL DEFAULT 0," + // 本地修改标记 + NoteColumns.ORIGIN_PARENT_ID + " INTEGER NOT NULL DEFAULT 0," + // 原始父级ID + NoteColumns.GTASK_ID + " TEXT NOT NULL DEFAULT ''," + // GTask ID + NoteColumns.VERSION + " INTEGER NOT NULL DEFAULT 0" + // 版本号 + ")"; + /** + * 创建data表的SQL语句 + * data表存储笔记的具体内容（文本、通话记录等），与note表通过NOTE_ID关联 + */ private static final String CREATE_DATA_TABLE_SQL = - "CREATE TABLE " + TABLE.DATA + "(" + - DataColumns.ID + " INTEGER PRIMARY KEY," + - DataColumns.MIME_TYPE + " TEXT NOT NULL," + - DataColumns.NOTE_ID + " INTEGER NOT NULL DEFAULT 0," + - NoteColumns.CREATED_DATE + " INTEGER NOT NULL DEFAULT (strftime('%s','now') * 1000)," + - NoteColumns.MODIFIED_DATE + " INTEGER NOT NULL DEFAULT (strftime('%s','now') * 1000)," + - DataColumns.CONTENT + " TEXT NOT NULL DEFAULT ''," + - DataColumns.DATA1 + " INTEGER," + - DataColumns.DATA2 + " INTEGER," + - DataColumns.DATA3 + " TEXT NOT NULL DEFAULT ''," + - DataColumns.DATA4 + " TEXT NOT NULL DEFAULT ''," + - DataColumns.DATA5 + " TEXT NOT NULL DEFAULT ''" + - ")"; + "CREATE TABLE " + TABLE.DATA + "(" + + DataColumns.ID + " INTEGER PRIMARY KEY," + // 主键ID + DataColumns.MIME_TYPE + " TEXT NOT NULL," + // 数据类型（文本/通话记录） + DataColumns.NOTE_ID + " INTEGER NOT NULL DEFAULT 0," + // 关联的note表ID + NoteColumns.CREATED_DATE + " INTEGER NOT NULL DEFAULT (strftime('%s','now') * 1000)," + // 创建时间 + NoteColumns.MODIFIED_DATE + " INTEGER NOT NULL DEFAULT (strftime('%s','now') * 1000)," + // 修改时间 + DataColumns.CONTENT + " TEXT NOT NULL DEFAULT ''," + // 数据内容 + DataColumns.DATA1 + " INTEGER," + // 通用整型列1 + DataColumns.DATA2 + " INTEGER," + // 通用整型列2 + DataColumns.DATA3 + " TEXT NOT NULL DEFAULT ''," + // 通用文本列3 + DataColumns.DATA4 + " TEXT NOT NULL DEFAULT ''," + // 通用文本列4 + DataColumns.DATA5 + " TEXT NOT NULL DEFAULT ''" + // 通用文本列5 + ")"; + /** + * 创建data表的NOTE_ID索引的SQL语句 + * 索引用于提升根据NOTE_ID查询data表的性能（频繁关联查询场景） + */ private static final String CREATE_DATA_NOTE_ID_INDEX_SQL = - "CREATE INDEX IF NOT EXISTS note_id_index ON " + - TABLE.DATA + "(" + DataColumns.NOTE_ID + ");"; + "CREATE INDEX IF NOT EXISTS note_id_index ON " + + TABLE.DATA + "(" + DataColumns.NOTE_ID + ");"; + // ====================== 数据库触发器SQL语句（note表） ====================== /** - * Increase folder's note count when move note to the folder + * 触发器：更新笔记的父级ID时，增加新文件夹的笔记数量 + * 触发时机：note表的PARENT_ID列更新后 + * 逻辑：将新父级文件夹的NOTES_COUNT加1 */ private static final String NOTE_INCREASE_FOLDER_COUNT_ON_UPDATE_TRIGGER = - "CREATE TRIGGER increase_folder_count_on_update "+ - " AFTER UPDATE OF " + NoteColumns.PARENT_ID + " ON " + TABLE.NOTE + - " BEGIN " + - " UPDATE " + TABLE.NOTE + - " SET " + NoteColumns.NOTES_COUNT + "=" + NoteColumns.NOTES_COUNT + " + 1" + - " WHERE " + NoteColumns.ID + "=new." + NoteColumns.PARENT_ID + ";" + - " END"; + "CREATE TRIGGER increase_folder_count_on_update "+ + " AFTER UPDATE OF " + NoteColumns.PARENT_ID + " ON " + TABLE.NOTE + + " BEGIN " + + " UPDATE " + TABLE.NOTE + + " SET " + NoteColumns.NOTES_COUNT + "=" + NoteColumns.NOTES_COUNT + " + 1" + + " WHERE " + NoteColumns.ID + "=new." + NoteColumns.PARENT_ID + ";" + + " END"; /** - * Decrease folder's note count when move note from folder + * 触发器：更新笔记的父级ID时，减少旧文件夹的笔记数量 + * 触发时机：note表的PARENT_ID列更新后 + * 逻辑：将旧父级文件夹的NOTES_COUNT减1（需保证数量大于0） */ private static final String NOTE_DECREASE_FOLDER_COUNT_ON_UPDATE_TRIGGER = - "CREATE TRIGGER decrease_folder_count_on_update " + - " AFTER UPDATE OF " + NoteColumns.PARENT_ID + " ON " + TABLE.NOTE + - " BEGIN " + - " UPDATE " + TABLE.NOTE + - " SET " + NoteColumns.NOTES_COUNT + "=" + NoteColumns.NOTES_COUNT + "-1" + - " WHERE " + NoteColumns.ID + "=old." + NoteColumns.PARENT_ID + - " AND " + NoteColumns.NOTES_COUNT + ">0" + ";" + - " END"; + "CREATE TRIGGER decrease_folder_count_on_update " + + " AFTER UPDATE OF " + NoteColumns.PARENT_ID + " ON " + TABLE.NOTE + + " BEGIN " + + " UPDATE " + TABLE.NOTE + + " SET " + NoteColumns.NOTES_COUNT + "=" + NoteColumns.NOTES_COUNT + "-1" + + " WHERE " + NoteColumns.ID + "=old." + NoteColumns.PARENT_ID + + " AND " + NoteColumns.NOTES_COUNT + ">0" + ";" + + " END"; /** - * Increase folder's note count when insert new note to the folder + * 触发器：插入新笔记时，增加对应文件夹的笔记数量 + * 触发时机：note表插入数据后 + * 逻辑：将新笔记的父级文件夹的NOTES_COUNT加1 */ private static final String NOTE_INCREASE_FOLDER_COUNT_ON_INSERT_TRIGGER = - "CREATE TRIGGER increase_folder_count_on_insert " + - " AFTER INSERT ON " + TABLE.NOTE + - " BEGIN " + - " UPDATE " + TABLE.NOTE + - " SET " + NoteColumns.NOTES_COUNT + "=" + NoteColumns.NOTES_COUNT + " + 1" + - " WHERE " + NoteColumns.ID + "=new." + NoteColumns.PARENT_ID + ";" + - " END"; + "CREATE TRIGGER increase_folder_count_on_insert " + + " AFTER INSERT ON " + TABLE.NOTE + + " BEGIN " + + " UPDATE " + TABLE.NOTE + + " SET " + NoteColumns.NOTES_COUNT + "=" + NoteColumns.NOTES_COUNT + " + 1" + + " WHERE " + NoteColumns.ID + "=new." + NoteColumns.PARENT_ID + ";" + + " END"; /** - * Decrease folder's note count when delete note from the folder + * 触发器：删除笔记时，减少对应文件夹的笔记数量 + * 触发时机：note表删除数据后 + * 逻辑：将被删除笔记的父级文件夹的NOTES_COUNT减1（需保证数量大于0） */ private static final String NOTE_DECREASE_FOLDER_COUNT_ON_DELETE_TRIGGER = - "CREATE TRIGGER decrease_folder_count_on_delete " + - " AFTER DELETE ON " + TABLE.NOTE + - " BEGIN " + - " UPDATE " + TABLE.NOTE + - " SET " + NoteColumns.NOTES_COUNT + "=" + NoteColumns.NOTES_COUNT + "-1" + - " WHERE " + NoteColumns.ID + "=old." + NoteColumns.PARENT_ID + - " AND " + NoteColumns.NOTES_COUNT + ">0;" + - " END"; - + "CREATE TRIGGER decrease_folder_count_on_delete " + + " AFTER DELETE ON " + TABLE.NOTE + + " BEGIN " + + " UPDATE " + TABLE.NOTE + + " SET " + NoteColumns.NOTES_COUNT + "=" + NoteColumns.NOTES_COUNT + "-1" + + " WHERE " + NoteColumns.ID + "=old." + NoteColumns.PARENT_ID + + " AND " + NoteColumns.NOTES_COUNT + ">0;" + + " END"; + + // ====================== 数据库触发器SQL语句（data表） ====================== /** - * Update note's content when insert data with type {@link DataConstants#NOTE} + * 触发器：插入文本笔记数据时，同步更新note表的摘要内容 + * 触发时机：data表插入数据后（且数据类型为文本笔记） + * 逻辑：将note表的SNIPPET列设为data表的CONTENT内容 */ private static final String DATA_UPDATE_NOTE_CONTENT_ON_INSERT_TRIGGER = - "CREATE TRIGGER update_note_content_on_insert " + - " AFTER INSERT ON " + TABLE.DATA + - " WHEN new." + DataColumns.MIME_TYPE + "='" + DataConstants.NOTE + "'" + - " BEGIN" + - " UPDATE " + TABLE.NOTE + - " SET " + NoteColumns.SNIPPET + "=new." + DataColumns.CONTENT + - " WHERE " + NoteColumns.ID + "=new." + DataColumns.NOTE_ID + ";" + - " END"; + "CREATE TRIGGER update_note_content_on_insert " + + " AFTER INSERT ON " + TABLE.DATA + + " WHEN new." + DataColumns.MIME_TYPE + "='" + DataConstants.NOTE + "'" + + " BEGIN" + + " UPDATE " + TABLE.NOTE + + " SET " + NoteColumns.SNIPPET + "=new." + DataColumns.CONTENT + + " WHERE " + NoteColumns.ID + "=new." + DataColumns.NOTE_ID + ";" + + " END"; /** - * Update note's content when data with {@link DataConstants#NOTE} type has changed + * 触发器：更新文本笔记数据时，同步更新note表的摘要内容 + * 触发时机：data表更新数据后（且数据类型为文本笔记） */ private static final String DATA_UPDATE_NOTE_CONTENT_ON_UPDATE_TRIGGER = - "CREATE TRIGGER update_note_content_on_update " + - " AFTER UPDATE ON " + TABLE.DATA + - " WHEN old." + DataColumns.MIME_TYPE + "='" + DataConstants.NOTE + "'" + - " BEGIN" + - " UPDATE " + TABLE.NOTE + - " SET " + NoteColumns.SNIPPET + "=new." + DataColumns.CONTENT + - " WHERE " + NoteColumns.ID + "=new." + DataColumns.NOTE_ID + ";" + - " END"; + "CREATE TRIGGER update_note_content_on_update " + + " AFTER UPDATE ON " + TABLE.DATA + + " WHEN old." + DataColumns.MIME_TYPE + "='" + DataConstants.NOTE + "'" + + " BEGIN" + + " UPDATE " + TABLE.NOTE + + " SET " + NoteColumns.SNIPPET + "=new." + DataColumns.CONTENT + + " WHERE " + NoteColumns.ID + "=new." + DataColumns.NOTE_ID + ";" + + " END"; /** - * Update note's content when data with {@link DataConstants#NOTE} type has deleted + * 触发器：删除文本笔记数据时，清空note表的摘要内容 + * 触发时机：data表删除数据后（且数据类型为文本笔记） */ private static final String DATA_UPDATE_NOTE_CONTENT_ON_DELETE_TRIGGER = - "CREATE TRIGGER update_note_content_on_delete " + - " AFTER delete ON " + TABLE.DATA + - " WHEN old." + DataColumns.MIME_TYPE + "='" + DataConstants.NOTE + "'" + - " BEGIN" + - " UPDATE " + TABLE.NOTE + - " SET " + NoteColumns.SNIPPET + "=''" + - " WHERE " + NoteColumns.ID + "=old." + DataColumns.NOTE_ID + ";" + - " END"; + "CREATE TRIGGER update_note_content_on_delete " + + " AFTER delete ON " + TABLE.DATA + + " WHEN old." + DataColumns.MIME_TYPE + "='" + DataConstants.NOTE + "'" + + " BEGIN" + + " UPDATE " + TABLE.NOTE + + " SET " + NoteColumns.SNIPPET + "=''" + + " WHERE " + NoteColumns.ID + "=old." + DataColumns.NOTE_ID + ";" + + " END"; /** - * Delete datas belong to note which has been deleted + * 触发器：删除笔记时，级联删除对应的data表数据 + * 触发时机：note表删除数据后 + * 逻辑：删除data表中NOTE_ID等于被删除笔记ID的所有数据，避免数据冗余 */ private static final String NOTE_DELETE_DATA_ON_DELETE_TRIGGER = - "CREATE TRIGGER delete_data_on_delete " + - " AFTER DELETE ON " + TABLE.NOTE + - " BEGIN" + - " DELETE FROM " + TABLE.DATA + - " WHERE " + DataColumns.NOTE_ID + "=old." + NoteColumns.ID + ";" + - " END"; + "CREATE TRIGGER delete_data_on_delete " + + " AFTER DELETE ON " + TABLE.NOTE + + " BEGIN" + + " DELETE FROM " + TABLE.DATA + + " WHERE " + DataColumns.NOTE_ID + "=old." + NoteColumns.ID + ";" + + " END"; /** - * Delete notes belong to folder which has been deleted + * 触发器：删除文件夹时，级联删除该文件夹下的所有笔记 + * 触发时机：note表删除数据后（删除的是文件夹） + * 逻辑：删除note表中PARENT_ID等于被删除文件夹ID的所有笔记 */ private static final String FOLDER_DELETE_NOTES_ON_DELETE_TRIGGER = - "CREATE TRIGGER folder_delete_notes_on_delete " + - " AFTER DELETE ON " + TABLE.NOTE + - " BEGIN" + - " DELETE FROM " + TABLE.NOTE + - " WHERE " + NoteColumns.PARENT_ID + "=old." + NoteColumns.ID + ";" + - " END"; + "CREATE TRIGGER folder_delete_notes_on_delete " + + " AFTER DELETE ON " + TABLE.NOTE + + " BEGIN" + + " DELETE FROM " + TABLE.NOTE + + " WHERE " + NoteColumns.PARENT_ID + "=old." + NoteColumns.ID + ";" + + " END"; /** - * Move notes belong to folder which has been moved to trash folder + * 触发器：将文件夹移至回收站时，同步移动该文件夹下的所有笔记至回收站 + * 触发时机：note表的PARENT_ID更新为回收站ID后 + * 逻辑：将该文件夹下的所有笔记的PARENT_ID设为回收站ID */ private static final String FOLDER_MOVE_NOTES_ON_TRASH_TRIGGER = - "CREATE TRIGGER folder_move_notes_on_trash " + - " AFTER UPDATE ON " + TABLE.NOTE + - " WHEN new." + NoteColumns.PARENT_ID + "=" + Notes.ID_TRASH_FOLER + - " BEGIN" + - " UPDATE " + TABLE.NOTE + - " SET " + NoteColumns.PARENT_ID + "=" + Notes.ID_TRASH_FOLER + - " WHERE " + NoteColumns.PARENT_ID + "=old." + NoteColumns.ID + ";" + - " END"; + "CREATE TRIGGER folder_move_notes_on_trash " + + " AFTER UPDATE ON " + TABLE.NOTE + + " WHEN new." + NoteColumns.PARENT_ID + "=" + Notes.ID_TRASH_FOLER + + " BEGIN" + + " UPDATE " + TABLE.NOTE + + " SET " + NoteColumns.PARENT_ID + "=" + Notes.ID_TRASH_FOLER + + " WHERE " + NoteColumns.PARENT_ID + "=old." + NoteColumns.ID + ";" + + " END"; + /** + * 构造方法，调用父类SQLiteOpenHelper的构造方法初始化数据库 + * + * @param context 上下文对象，用于访问应用的资源和私有目录 + */ public NotesDatabaseHelper(Context context) { super(context, DB_NAME, null, DB_VERSION); } + /** + * 创建note表，并初始化相关触发器和系统文件夹 + * + * @param db SQLiteDatabase对象，用于执行SQL语句 + */ public void createNoteTable(SQLiteDatabase db) { + // 执行创建note表的SQL db.execSQL(CREATE_NOTE_TABLE_SQL); + // 重新创建note表的触发器 reCreateNoteTableTriggers(db); + // 初始化系统文件夹 createSystemFolder(db); Log.d(TAG, "note table has been created"); } + /** + * 重新创建note表的所有触发器（先删除旧触发器，再创建新触发器） + * 用于数据库升级或触发器重建场景，避免触发器重复创建 + * + * @param db SQLiteDatabase对象 + */ private void reCreateNoteTableTriggers(SQLiteDatabase db) { + // 删除旧触发器（如果存在） db.execSQL("DROP TRIGGER IF EXISTS increase_folder_count_on_update"); db.execSQL("DROP TRIGGER IF EXISTS decrease_folder_count_on_update"); db.execSQL("DROP TRIGGER IF EXISTS decrease_folder_count_on_delete"); @@ -226,6 +310,7 @@ public class NotesDatabaseHelper extends SQLiteOpenHelper { db.execSQL("DROP TRIGGER IF EXISTS folder_delete_notes_on_delete"); db.execSQL("DROP TRIGGER IF EXISTS folder_move_notes_on_trash"); + // 创建新触发器 db.execSQL(NOTE_INCREASE_FOLDER_COUNT_ON_UPDATE_TRIGGER); db.execSQL(NOTE_DECREASE_FOLDER_COUNT_ON_UPDATE_TRIGGER); db.execSQL(NOTE_DECREASE_FOLDER_COUNT_ON_DELETE_TRIGGER); @@ -235,26 +320,32 @@ public class NotesDatabaseHelper extends SQLiteOpenHelper { db.execSQL(FOLDER_MOVE_NOTES_ON_TRASH_TRIGGER); } + /** + * 初始化系统预设文件夹（通话记录、根目录、临时、回收站） + * 向note表插入系统文件夹数据，类型为TYPE_SYSTEM + * + * @param db SQLiteDatabase对象 + */ private void createSystemFolder(SQLiteDatabase db) { ContentValues values = new ContentValues(); /** - * call record foler for call notes + * 1. 通话记录文件夹：存储通话记录笔记 */ - values.put(NoteColumns.ID, Notes.ID_CALL_RECORD_FOLDER); - values.put(NoteColumns.TYPE, Notes.TYPE_SYSTEM); + values.put(NoteColumns.ID, Notes.ID_CALL_RECORD_FOLDER); // 设置固定ID + values.put(NoteColumns.TYPE, Notes.TYPE_SYSTEM); // 类型为系统文件夹 db.insert(TABLE.NOTE, null, values); /** - * root folder which is default folder + * 2. 根文件夹：默认文件夹，存储无归属的笔记 */ - values.clear(); + values.clear(); // 清空ContentValues values.put(NoteColumns.ID, Notes.ID_ROOT_FOLDER); values.put(NoteColumns.TYPE, Notes.TYPE_SYSTEM); db.insert(TABLE.NOTE, null, values); /** - * temporary folder which is used for moving note + * 3. 临时文件夹：用于移动笔记时的临时存储 */ values.clear(); values.put(NoteColumns.ID, Notes.ID_TEMPARAY_FOLDER); @@ -262,7 +353,7 @@ public class NotesDatabaseHelper extends SQLiteOpenHelper { db.insert(TABLE.NOTE, null, values); /** - * create trash folder + * 4. 回收站文件夹：存储被删除的笔记和文件夹 */ values.clear(); values.put(NoteColumns.ID, Notes.ID_TRASH_FOLER); @@ -270,93 +361,159 @@ public class NotesDatabaseHelper extends SQLiteOpenHelper { db.insert(TABLE.NOTE, null, values); } + /** + * 创建data表，初始化相关触发器和索引 + * + * @param db SQLiteDatabase对象 + */ public void createDataTable(SQLiteDatabase db) { + // 执行创建data表的SQL db.execSQL(CREATE_DATA_TABLE_SQL); + // 重新创建data表的触发器 reCreateDataTableTriggers(db); + // 创建note_id索引，提升查询性能 db.execSQL(CREATE_DATA_NOTE_ID_INDEX_SQL); Log.d(TAG, "data table has been created"); } + /** + * 重新创建data表的所有触发器（先删除旧触发器，再创建新触发器） + * + * @param db SQLiteDatabase对象 + */ private void reCreateDataTableTriggers(SQLiteDatabase db) { + // 删除旧触发器 db.execSQL("DROP TRIGGER IF EXISTS update_note_content_on_insert"); db.execSQL("DROP TRIGGER IF EXISTS update_note_content_on_update"); db.execSQL("DROP TRIGGER IF EXISTS update_note_content_on_delete"); + // 创建新触发器 db.execSQL(DATA_UPDATE_NOTE_CONTENT_ON_INSERT_TRIGGER); db.execSQL(DATA_UPDATE_NOTE_CONTENT_ON_UPDATE_TRIGGER); db.execSQL(DATA_UPDATE_NOTE_CONTENT_ON_DELETE_TRIGGER); } + /** + * 获取NotesDatabaseHelper的单例实例（线程安全） + * 采用synchronized关键字保证多线程环境下实例的唯一性，避免数据库锁问题 + * + * @param context 上下文对象（建议使用Application Context，避免内存泄漏） + * @return 全局唯一的NotesDatabaseHelper实例 + */ static synchronized NotesDatabaseHelper getInstance(Context context) { + // 懒汉式加载：实例为null时才创建 if (mInstance == null) { mInstance = new NotesDatabaseHelper(context); } return mInstance; } + /** + * 数据库首次创建时调用的方法 + * 执行note表和data表的创建逻辑 + * + * @param db SQLiteDatabase对象 + */ @Override public void onCreate(SQLiteDatabase db) { createNoteTable(db); createDataTable(db); } + /** + * 数据库版本升级时调用的方法 + * 处理从旧版本（1/2/3）升级到新版本（4）的逻辑，包括表结构修改、数据迁移、触发器重建等 + * + * @param db SQLiteDatabase对象 + * @param oldVersion 旧数据库版本号 + * @param newVersion 新数据库版本号 + */ @Override public void onUpgrade(SQLiteDatabase db, int oldVersion, int newVersion) { + // 是否需要重建触发器的标记 boolean reCreateTriggers = false; + // 是否跳过版本2升级的标记（版本1升级包含版本2的逻辑） boolean skipV2 = false; + // 从版本1升级到版本2 if (oldVersion == 1) { upgradeToV2(db); - skipV2 = true; // this upgrade including the upgrade from v2 to v3 + skipV2 = true; // 版本1的升级已包含版本2到3的逻辑 oldVersion++; } + // 从版本2升级到版本3（未跳过的情况） if (oldVersion == 2 && !skipV2) { upgradeToV3(db); - reCreateTriggers = true; + reCreateTriggers = true; // 需要重建触发器 oldVersion++; } + // 从版本3升级到版本4 if (oldVersion == 3) { upgradeToV4(db); oldVersion++; } + // 如果需要，重建触发器 if (reCreateTriggers) { reCreateNoteTableTriggers(db); reCreateDataTableTriggers(db); } + // 升级失败时抛出异常，提示版本升级错误 if (oldVersion != newVersion) { throw new IllegalStateException("Upgrade notes database to version " + newVersion + "fails"); } } + /** + * 从版本1升级到版本2的逻辑 + * 删除旧表，重新创建新表（全量重建，会丢失数据，适用于早期版本） + * + * @param db SQLiteDatabase对象 + */ private void upgradeToV2(SQLiteDatabase db) { + // 删除旧的note表和data表 db.execSQL("DROP TABLE IF EXISTS " + TABLE.NOTE); db.execSQL("DROP TABLE IF EXISTS " + TABLE.DATA); + // 重新创建表和初始化数据 createNoteTable(db); createDataTable(db); } + /** + * 从版本2升级到版本3的逻辑 + * 1. 删除无用的触发器； + * 2. 为note表添加GTASK_ID列； + * 3. 新增回收站系统文件夹。 + * + * @param db SQLiteDatabase对象 + */ private void upgradeToV3(SQLiteDatabase db) { - // drop unused triggers + // 删除无用的触发器（更新笔记修改时间的触发器） db.execSQL("DROP TRIGGER IF EXISTS update_note_modified_date_on_insert"); db.execSQL("DROP TRIGGER IF EXISTS update_note_modified_date_on_delete"); db.execSQL("DROP TRIGGER IF EXISTS update_note_modified_date_on_update"); - // add a column for gtask id + // 为note表添加GTASK_ID列（用于GTask同步） db.execSQL("ALTER TABLE " + TABLE.NOTE + " ADD COLUMN " + NoteColumns.GTASK_ID + " TEXT NOT NULL DEFAULT ''"); - // add a trash system folder + // 新增回收站系统文件夹 ContentValues values = new ContentValues(); values.put(NoteColumns.ID, Notes.ID_TRASH_FOLER); values.put(NoteColumns.TYPE, Notes.TYPE_SYSTEM); db.insert(TABLE.NOTE, null, values); } + /** + * 从版本3升级到版本4的逻辑 + * 为note表添加VERSION列（用于数据同步的版本控制） + * + * @param db SQLiteDatabase对象 + */ private void upgradeToV4(SQLiteDatabase db) { db.execSQL("ALTER TABLE " + TABLE.NOTE + " ADD COLUMN " + NoteColumns.VERSION + " INTEGER NOT NULL DEFAULT 0"); } -} +} \ No newline at end of file diff --git a/src/notes/data/NotesProvider.java b/src/notes/data/NotesProvider.java index edb0a60..e0c01d2 100644 --- a/src/notes/data/NotesProvider.java +++ b/src/notes/data/NotesProvider.java @@ -34,182 +34,312 @@ import net.micode.notes.data.Notes.DataColumns; import net.micode.notes.data.Notes.NoteColumns; import net.micode.notes.data.NotesDatabaseHelper.TABLE; - +/** + * 笔记应用的ContentProvider实现类，继承自Android的ContentProvider + * 核心功能： + * 1. 作为应用数据的对外统一访问接口，封装SQLite数据库的CRUD（增删改查）操作； + * 2. 通过UriMatcher匹配不同的Uri，处理note表、data表的单条/多条数据操作； + * 3. 支持安卓系统的搜索框架，提供笔记搜索和搜索建议功能； + * 4. 数据变更时发送通知（notifyChange），让UI组件同步更新数据； + * 5. 更新笔记时自动增加版本号，用于数据同步的版本控制。 + * + * ContentProvider是安卓四大组件之一，用于跨应用/进程的数据共享，本类也是应用内部数据访问的统一入口。 + * + * @author MiCode Open Source Community + * @date 2010-2011 + */ public class NotesProvider extends ContentProvider { + /** + * Uri匹配器，用于将外部传入的Uri匹配为对应的操作类型（如查询所有笔记、查询单条数据、搜索等） + * 静态常量，类加载时初始化，全局唯一 + */ private static final UriMatcher mMatcher; + /** + * 数据库帮助类实例，用于获取SQLiteDatabase对象执行数据库操作 + */ private NotesDatabaseHelper mHelper; + /** + * 日志标签，用于Logcat输出时标识当前类，方便调试定位问题 + */ private static final String TAG = "NotesProvider"; + // ====================== Uri匹配类型常量 ====================== + /** + * Uri匹配类型：查询/操作note表的所有数据 + */ private static final int URI_NOTE = 1; + /** + * Uri匹配类型：查询/操作note表的单条数据（通过ID，如note/1） + */ private static final int URI_NOTE_ITEM = 2; + /** + * Uri匹配类型：查询/操作data表的所有数据 + */ private static final int URI_DATA = 3; + /** + * Uri匹配类型：查询/操作data表的单条数据（通过ID，如data/1） + */ private static final int URI_DATA_ITEM = 4; - + /** + * Uri匹配类型：执行笔记搜索操作 + */ private static final int URI_SEARCH = 5; + /** + * Uri匹配类型：提供搜索建议（适配安卓SearchManager） + */ private static final int URI_SEARCH_SUGGEST = 6; + /** + * 静态代码块：初始化UriMatcher，添加Uri匹配规则 + * 规则格式：authority（授权名） + path（路径） -> 匹配类型常量 + */ static { + // 初始化UriMatcher，默认匹配失败返回UriMatcher.NO_MATCH mMatcher = new UriMatcher(UriMatcher.NO_MATCH); + // 匹配note表所有数据：content://micode_notes/note -> URI_NOTE mMatcher.addURI(Notes.AUTHORITY, "note", URI_NOTE); + // 匹配note表单条数据：content://micode_notes/note/#（#表示数字ID） -> URI_NOTE_ITEM mMatcher.addURI(Notes.AUTHORITY, "note/#", URI_NOTE_ITEM); + // 匹配data表所有数据：content://micode_notes/data -> URI_DATA mMatcher.addURI(Notes.AUTHORITY, "data", URI_DATA); + // 匹配data表单条数据：content://micode_notes/data/# -> URI_DATA_ITEM mMatcher.addURI(Notes.AUTHORITY, "data/#", URI_DATA_ITEM); + // 匹配搜索操作：content://micode_notes/search -> URI_SEARCH mMatcher.addURI(Notes.AUTHORITY, "search", URI_SEARCH); + // 匹配搜索建议（空查询）：content://micode_notes/suggestions/query -> URI_SEARCH_SUGGEST mMatcher.addURI(Notes.AUTHORITY, SearchManager.SUGGEST_URI_PATH_QUERY, URI_SEARCH_SUGGEST); + // 匹配搜索建议（带关键词）：content://micode_notes/suggestions/query/关键词 -> URI_SEARCH_SUGGEST mMatcher.addURI(Notes.AUTHORITY, SearchManager.SUGGEST_URI_PATH_QUERY + "/*", URI_SEARCH_SUGGEST); } /** - * x'0A' represents the '\n' character in sqlite. For title and content in the search result, - * we will trim '\n' and white space in order to show more information. + * 笔记搜索的投影（Projection）字符串，定义了搜索结果需要返回的列 + * 适配安卓SearchManager的搜索建议列名，核心处理逻辑： + * 1. x'0A'是SQLite中的换行符\n，替换并修剪空格，让搜索结果显示更整洁； + * 2. 映射SearchManager的标准列名（如SUGGEST_COLUMN_TEXT_1、SUGGEST_COLUMN_ICON_1），供搜索框架使用； + * 3. 包含笔记ID、内容、图标、意图动作等信息，用于搜索建议的展示和跳转。 */ private static final String NOTES_SEARCH_PROJECTION = NoteColumns.ID + "," - + NoteColumns.ID + " AS " + SearchManager.SUGGEST_COLUMN_INTENT_EXTRA_DATA + "," - + "TRIM(REPLACE(" + NoteColumns.SNIPPET + ", x'0A','')) AS " + SearchManager.SUGGEST_COLUMN_TEXT_1 + "," - + "TRIM(REPLACE(" + NoteColumns.SNIPPET + ", x'0A','')) AS " + SearchManager.SUGGEST_COLUMN_TEXT_2 + "," - + R.drawable.search_result + " AS " + SearchManager.SUGGEST_COLUMN_ICON_1 + "," - + "'" + Intent.ACTION_VIEW + "' AS " + SearchManager.SUGGEST_COLUMN_INTENT_ACTION + "," - + "'" + Notes.TextNote.CONTENT_TYPE + "' AS " + SearchManager.SUGGEST_COLUMN_INTENT_DATA; + + NoteColumns.ID + " AS " + SearchManager.SUGGEST_COLUMN_INTENT_EXTRA_DATA + "," + + "TRIM(REPLACE(" + NoteColumns.SNIPPET + ", x'0A','')) AS " + SearchManager.SUGGEST_COLUMN_TEXT_1 + "," + + "TRIM(REPLACE(" + NoteColumns.SNIPPET + ", x'0A','')) AS " + SearchManager.SUGGEST_COLUMN_TEXT_2 + "," + + R.drawable.search_result + " AS " + SearchManager.SUGGEST_COLUMN_ICON_1 + "," + + "'" + Intent.ACTION_VIEW + "' AS " + SearchManager.SUGGEST_COLUMN_INTENT_ACTION + "," + + "'" + Notes.TextNote.CONTENT_TYPE + "' AS " + SearchManager.SUGGEST_COLUMN_INTENT_DATA; + /** + * 笔记搜索的SQL查询语句，逻辑： + * 1. 选择NOTES_SEARCH_PROJECTION定义的列； + * 2. 从note表查询； + * 3. 条件：摘要包含搜索关键词（LIKE ?）、不在回收站（PARENT_ID != 回收站ID）、类型为普通笔记（TYPE=NOTE）。 + */ private static String NOTES_SNIPPET_SEARCH_QUERY = "SELECT " + NOTES_SEARCH_PROJECTION - + " FROM " + TABLE.NOTE - + " WHERE " + NoteColumns.SNIPPET + " LIKE ?" - + " AND " + NoteColumns.PARENT_ID + "<>" + Notes.ID_TRASH_FOLER - + " AND " + NoteColumns.TYPE + "=" + Notes.TYPE_NOTE; + + " FROM " + TABLE.NOTE + + " WHERE " + NoteColumns.SNIPPET + " LIKE ?" + + " AND " + NoteColumns.PARENT_ID + "<>" + Notes.ID_TRASH_FOLER + + " AND " + NoteColumns.TYPE + "=" + Notes.TYPE_NOTE; + /** + * ContentProvider创建时调用的方法，初始化数据库帮助类实例 + * @return true表示ContentProvider创建成功，false表示失败 + */ @Override public boolean onCreate() { + // 获取NotesDatabaseHelper的单例实例，上下文使用ContentProvider的上下文 mHelper = NotesDatabaseHelper.getInstance(getContext()); return true; } + /** + * 处理数据查询请求，是ContentProvider的核心方法之一 + * 根据Uri匹配的类型，执行不同的数据库查询逻辑，返回Cursor对象 + * + * @param uri 要查询的Uri + * @param projection 要返回的列（投影），null表示返回所有列 + * @param selection 查询条件（WHERE子句），?作为占位符 + * @param selectionArgs 查询条件的参数，替换selection中的? + * @param sortOrder 排序规则（ORDER BY子句） + * @return 查询结果的Cursor对象，若查询失败返回null + */ @Override public Cursor query(Uri uri, String[] projection, String selection, String[] selectionArgs, - String sortOrder) { + String sortOrder) { Cursor c = null; + // 获取只读的SQLiteDatabase对象（查询操作使用只读数据库，提升性能） SQLiteDatabase db = mHelper.getReadableDatabase(); - String id = null; + String id = null; // 存储Uri中的ID（如note/1中的1） + + // 根据Uri匹配的类型执行不同的查询逻辑 switch (mMatcher.match(uri)) { case URI_NOTE: + // 查询note表的所有数据 c = db.query(TABLE.NOTE, projection, selection, selectionArgs, null, null, sortOrder); break; case URI_NOTE_ITEM: + // 获取Uri中的ID（路径的第二个分段，如note/1的路径分段是["note", "1"]） id = uri.getPathSegments().get(1); + // 查询note表的单条数据，条件：ID=id + 传入的selection c = db.query(TABLE.NOTE, projection, NoteColumns.ID + "=" + id + parseSelection(selection), selectionArgs, null, null, sortOrder); break; case URI_DATA: + // 查询data表的所有数据 c = db.query(TABLE.DATA, projection, selection, selectionArgs, null, null, sortOrder); break; case URI_DATA_ITEM: + // 获取Uri中的ID id = uri.getPathSegments().get(1); + // 查询data表的单条数据，条件：ID=id + 传入的selection c = db.query(TABLE.DATA, projection, DataColumns.ID + "=" + id + parseSelection(selection), selectionArgs, null, null, sortOrder); break; case URI_SEARCH: case URI_SEARCH_SUGGEST: + // 搜索操作不允许指定sortOrder和projection，否则抛出异常 if (sortOrder != null || projection != null) { throw new IllegalArgumentException( "do not specify sortOrder, selection, selectionArgs, or projection" + "with this query"); } + // 获取搜索关键词：搜索建议从路径获取，普通搜索从查询参数获取 String searchString = null; if (mMatcher.match(uri) == URI_SEARCH_SUGGEST) { + // 搜索建议：路径分段大于1时，第二个分段是关键词（如query/笔记） if (uri.getPathSegments().size() > 1) { searchString = uri.getPathSegments().get(1); } } else { + // 普通搜索：从查询参数"pattern"中获取关键词 searchString = uri.getQueryParameter("pattern"); } + // 关键词为空时返回null if (TextUtils.isEmpty(searchString)) { return null; } try { + // 拼接SQL的LIKE关键词（%表示任意字符，如%笔记%） searchString = String.format("%%%s%%", searchString); + // 执行原生SQL查询，获取搜索结果 c = db.rawQuery(NOTES_SNIPPET_SEARCH_QUERY, new String[] { searchString }); } catch (IllegalStateException ex) { + // 捕获异常，输出错误日志 Log.e(TAG, "got exception: " + ex.toString()); } break; default: + // 未知Uri，抛出异常 throw new IllegalArgumentException("Unknown URI " + uri); } + + // 为Cursor设置通知Uri，当数据变更时，Cursor会收到通知并更新 if (c != null) { c.setNotificationUri(getContext().getContentResolver(), uri); } return c; } + /** + * 处理数据插入请求，向note表或data表插入数据 + * + * @param uri 要插入的Uri + * @param values 要插入的数据（ContentValues键值对） + * @return 插入数据后的新Uri（包含插入的ID，如content://micode_notes/note/1） + */ @Override public Uri insert(Uri uri, ContentValues values) { + // 获取可写的SQLiteDatabase对象（插入操作需要写权限） SQLiteDatabase db = mHelper.getWritableDatabase(); - long dataId = 0, noteId = 0, insertedId = 0; + long dataId = 0, noteId = 0, insertedId = 0; // 存储插入的ID + + // 根据Uri匹配的类型执行插入逻辑 switch (mMatcher.match(uri)) { case URI_NOTE: + // 插入note表，获取插入的ID insertedId = noteId = db.insert(TABLE.NOTE, null, values); break; case URI_DATA: + // 插入data表时，先获取关联的noteId（必须包含NOTE_ID列） if (values.containsKey(DataColumns.NOTE_ID)) { noteId = values.getAsLong(DataColumns.NOTE_ID); } else { + // 无NOTE_ID时输出调试日志 Log.d(TAG, "Wrong data format without note id:" + values.toString()); } + // 插入data表，获取插入的ID insertedId = dataId = db.insert(TABLE.DATA, null, values); break; default: + // 未知Uri，抛出异常 throw new IllegalArgumentException("Unknown URI " + uri); } - // Notify the note uri + + // 发送通知：note表数据变更，通知对应的Uri if (noteId > 0) { getContext().getContentResolver().notifyChange( ContentUris.withAppendedId(Notes.CONTENT_NOTE_URI, noteId), null); } - // Notify the data uri + // 发送通知：data表数据变更，通知对应的Uri if (dataId > 0) { getContext().getContentResolver().notifyChange( ContentUris.withAppendedId(Notes.CONTENT_DATA_URI, dataId), null); } + // 返回包含插入ID的新Uri return ContentUris.withAppendedId(uri, insertedId); } + /** + * 处理数据删除请求，从note表或data表删除数据 + * + * @param uri 要删除的Uri + * @param selection 删除条件（WHERE子句） + * @param selectionArgs 删除条件的参数 + * @return 删除的行数 + */ @Override public int delete(Uri uri, String selection, String[] selectionArgs) { - int count = 0; - String id = null; + int count = 0; // 存储删除的行数 + String id = null; // 存储Uri中的ID + // 获取可写的SQLiteDatabase对象 SQLiteDatabase db = mHelper.getWritableDatabase(); - boolean deleteData = false; + boolean deleteData = false; // 标记是否删除的是data表数据 + + // 根据Uri匹配的类型执行删除逻辑 switch (mMatcher.match(uri)) { case URI_NOTE: + // 删除note表数据，条件：传入的selection + ID>0（排除系统文件夹） selection = "(" + selection + ") AND " + NoteColumns.ID + ">0 "; count = db.delete(TABLE.NOTE, selection, selectionArgs); break; case URI_NOTE_ITEM: + // 获取Uri中的ID id = uri.getPathSegments().get(1); /** - * ID that smaller than 0 is system folder which is not allowed to - * trash + * ID小于等于0的是系统文件夹，不允许删除 */ long noteId = Long.valueOf(id); if (noteId <= 0) { break; } + // 删除note表单条数据，条件：ID=id + 传入的selection count = db.delete(TABLE.NOTE, NoteColumns.ID + "=" + id + parseSelection(selection), selectionArgs); break; case URI_DATA: + // 删除data表数据 count = db.delete(TABLE.DATA, selection, selectionArgs); deleteData = true; break; case URI_DATA_ITEM: + // 获取Uri中的ID，删除data表单条数据 id = uri.getPathSegments().get(1); count = db.delete(TABLE.DATA, DataColumns.ID + "=" + id + parseSelection(selection), selectionArgs); @@ -218,37 +348,58 @@ public class NotesProvider extends ContentProvider { default: throw new IllegalArgumentException("Unknown URI " + uri); } + + // 数据删除成功时，发送通知更新UI if (count > 0) { + // 删除data表数据时，同时通知note表的Uri（因为data表变更会影响note表的摘要） if (deleteData) { getContext().getContentResolver().notifyChange(Notes.CONTENT_NOTE_URI, null); } + // 通知当前Uri的数据变更 getContext().getContentResolver().notifyChange(uri, null); } return count; } + /** + * 处理数据更新请求，更新note表或data表的数据 + * + * @param uri 要更新的Uri + * @param values 要更新的数据（ContentValues键值对） + * @param selection 更新条件（WHERE子句） + * @param selectionArgs 更新条件的参数 + * @return 更新的行数 + */ @Override public int update(Uri uri, ContentValues values, String selection, String[] selectionArgs) { - int count = 0; - String id = null; + int count = 0; // 存储更新的行数 + String id = null; // 存储Uri中的ID + // 获取可写的SQLiteDatabase对象 SQLiteDatabase db = mHelper.getWritableDatabase(); - boolean updateData = false; + boolean updateData = false; // 标记是否更新的是data表数据 + + // 根据Uri匹配的类型执行更新逻辑 switch (mMatcher.match(uri)) { case URI_NOTE: + // 更新note表前，增加笔记的版本号 increaseNoteVersion(-1, selection, selectionArgs); count = db.update(TABLE.NOTE, values, selection, selectionArgs); break; case URI_NOTE_ITEM: + // 获取Uri中的ID id = uri.getPathSegments().get(1); + // 更新note表单条数据前，增加版本号 increaseNoteVersion(Long.valueOf(id), selection, selectionArgs); count = db.update(TABLE.NOTE, values, NoteColumns.ID + "=" + id + parseSelection(selection), selectionArgs); break; case URI_DATA: + // 更新data表数据 count = db.update(TABLE.DATA, values, selection, selectionArgs); updateData = true; break; case URI_DATA_ITEM: + // 获取Uri中的ID，更新data表单条数据 id = uri.getPathSegments().get(1); count = db.update(TABLE.DATA, values, DataColumns.ID + "=" + id + parseSelection(selection), selectionArgs); @@ -258,48 +409,81 @@ public class NotesProvider extends ContentProvider { throw new IllegalArgumentException("Unknown URI " + uri); } + // 数据更新成功时，发送通知更新UI if (count > 0) { + // 更新data表数据时，同时通知note表的Uri if (updateData) { getContext().getContentResolver().notifyChange(Notes.CONTENT_NOTE_URI, null); } + // 通知当前Uri的数据变更 getContext().getContentResolver().notifyChange(uri, null); } return count; } + /** + * 辅助方法：处理选择条件，拼接AND和括号 + * 若selection不为空，返回" AND (selection)"；否则返回空字符串 + * 用于将Uri的ID条件和传入的selection条件拼接，避免SQL语法错误 + * + * @param selection 传入的选择条件 + * @return 处理后的选择条件字符串 + */ private String parseSelection(String selection) { return (!TextUtils.isEmpty(selection) ? " AND (" + selection + ')' : ""); } + /** + * 辅助方法：增加笔记的版本号（VERSION列） + * 执行SQL语句将VERSION列加1，用于数据同步的版本控制，标记数据已修改 + * + * @param id 笔记的ID（-1表示更新多条数据） + * @param selection 更新条件 + * @param selectionArgs 更新条件的参数 + */ private void increaseNoteVersion(long id, String selection, String[] selectionArgs) { - StringBuilder sql = new StringBuilder(120); + StringBuilder sql = new StringBuilder(120); // 构建SQL语句的字符串构建器 + // 拼接UPDATE语句：UPDATE note SET VERSION=VERSION+1 [WHERE 条件] sql.append("UPDATE "); sql.append(TABLE.NOTE); sql.append(" SET "); sql.append(NoteColumns.VERSION); sql.append("=" + NoteColumns.VERSION + "+1 "); + // 添加WHERE子句（ID>0或selection不为空时） if (id > 0 || !TextUtils.isEmpty(selection)) { sql.append(" WHERE "); } + // 添加ID条件（id>0时） if (id > 0) { sql.append(NoteColumns.ID + "=" + String.valueOf(id)); } + // 添加传入的selection条件（替换占位符?为实际参数） if (!TextUtils.isEmpty(selection)) { + // 处理selection：已有ID时拼接，否则直接使用 String selectString = id > 0 ? parseSelection(selection) : selection; + // 替换selection中的?为selectionArgs的参数（简单替换，适用于基础场景） for (String args : selectionArgs) { selectString = selectString.replaceFirst("\\?", args); } sql.append(selectString); } + // 执行SQL语句 mHelper.getWritableDatabase().execSQL(sql.toString()); } + /** + * 获取Uri对应的MIME类型，适配ContentProvider的规范 + * 本类暂未实现该方法，返回null + * + * @param uri 要查询的Uri + * @return Uri对应的MIME类型 + */ @Override public String getType(Uri uri) { // TODO Auto-generated method stub return null; } -} +} \ No newline at end of file diff --git a/src/notes/gtask/data/MetaData.java b/src/notes/gtask/data/MetaData.java index 3a2050b..7c1f0e5 100644 --- a/src/notes/gtask/data/MetaData.java +++ b/src/notes/gtask/data/MetaData.java @@ -24,59 +24,136 @@ import net.micode.notes.tool.GTaskStringUtils; import org.json.JSONException; import org.json.JSONObject; - +/** + * GTask（谷歌任务）的元数据模型类 + * 继承自抽象基类{@link Task}，专门处理与GTask关联的元数据（如关联的GTask ID） + * 核心功能：存储元数据的JSON信息、解析远程GTask的JSON数据获取关联ID、标记元数据是否值得保存 + * 该类部分父类方法被重写为抛出异常，因为元数据不需要本地JSON处理和同步动作判断的逻辑 + * + * @author MiCode Open Source Community + * @date 2010-2011 + * @see Task 抽象任务基类 + */ public class MetaData extends Task { + /** + * 日志标签，使用类的简单名称（MetaData），便于Logcat中定位日志来源 + */ private final static String TAG = MetaData.class.getSimpleName(); + /** + * 与当前元数据关联的GTask唯一标识（Gid） + * Gid是GTask系统中用于标识任务的唯一ID，用于笔记与GTask的关联同步 + */ private String mRelatedGid = null; + /** + * 设置元数据内容：将关联的GTask ID存入JSON对象，并设置元数据的名称和笔记内容 + * 步骤： + * 1. 向传入的JSON元数据对象中添加GTask ID的键值对 + * 2. 将JSON对象转为字符串，设置为当前任务的笔记内容（notes字段） + * 3. 设置当前任务的名称为元数据专用名称（{@link GTaskStringUtils#META_NOTE_NAME}） + * + * @param gid 关联的GTask唯一标识（Gid） + * @param metaInfo 存储元数据的JSON对象，用于封装元数据键值对 + */ public void setMeta(String gid, JSONObject metaInfo) { try { + // 向JSON对象中添加GTask ID的键值对，键为META_HEAD_GTASK_ID metaInfo.put(GTaskStringUtils.META_HEAD_GTASK_ID, gid); } catch (JSONException e) { + // 捕获JSON操作异常，输出错误日志 Log.e(TAG, "failed to put related gid"); } + // 将JSON对象转为字符串，设置为任务的笔记内容（父类Task的notes属性） setNotes(metaInfo.toString()); + // 设置任务名称为元数据专用名称（区分普通任务和元数据任务） setName(GTaskStringUtils.META_NOTE_NAME); } + /** + * 获取与当前元数据关联的GTask ID + * + * @return 关联的GTask ID（null表示未设置或解析失败） + */ public String getRelatedGid() { return mRelatedGid; } + /** + * 重写父类方法，判断当前元数据是否值得保存到本地/远程 + * 判定条件：任务的笔记内容（元数据JSON字符串）不为null + * 该方法用于同步时过滤无意义的元数据，避免空数据存储 + * + * @return true表示值得保存（笔记内容非空），false表示无需保存 + */ @Override public boolean isWorthSaving() { return getNotes() != null; } + /** + * 重写父类方法，根据远程GTask的JSON数据设置元数据内容 + * 步骤： + * 1. 调用父类方法初始化基础任务内容 + * 2. 若笔记内容（元数据JSON字符串）非空，解析JSON获取关联的GTask ID + * 3. 捕获JSON解析异常，输出警告日志并将GTask ID置为null + * + * @param js 远程GTask返回的JSON对象，包含元数据信息 + */ @Override public void setContentByRemoteJSON(JSONObject js) { + // 调用父类方法，处理基础的任务内容（如名称、笔记等） super.setContentByRemoteJSON(js); + // 若笔记内容（元数据JSON字符串）非空，则解析关联的GTask ID if (getNotes() != null) { try { + // 将笔记内容转为JSON对象（去除首尾空格，避免解析错误） JSONObject metaInfo = new JSONObject(getNotes().trim()); + // 从JSON对象中获取GTask ID并赋值给成员变量 mRelatedGid = metaInfo.getString(GTaskStringUtils.META_HEAD_GTASK_ID); } catch (JSONException e) { + // 捕获JSON解析异常，输出警告日志，将GTask ID置为null Log.w(TAG, "failed to get related gid"); mRelatedGid = null; } } } + /** + * 重写父类方法，禁止调用该方法（元数据不需要本地JSON处理） + * 该方法被调用时会抛出非法访问错误，提示开发者该方法不适用 + * + * @throws IllegalAccessError 调用该方法时立即抛出异常 + */ @Override public void setContentByLocalJSON(JSONObject js) { - // this function should not be called + // 抛出异常，说明该方法不应被调用（元数据仅处理远程GTask的JSON，不处理本地JSON） throw new IllegalAccessError("MetaData:setContentByLocalJSON should not be called"); } + /** + * 重写父类方法，禁止调用该方法（元数据不需要生成本地JSON） + * 该方法被调用时会抛出非法访问错误，提示开发者该方法不适用 + * + * @throws IllegalAccessError 调用该方法时立即抛出异常 + * @return 无返回值（因为会直接抛出异常） + */ @Override public JSONObject getLocalJSONFromContent() { throw new IllegalAccessError("MetaData:getLocalJSONFromContent should not be called"); } + /** + * 重写父类方法，禁止调用该方法（元数据不需要判断同步动作） + * 该方法被调用时会抛出非法访问错误，提示开发者该方法不适用 + * + * @param c 数据库游标（用于查询本地数据），此处未使用 + * @throws IllegalAccessError 调用该方法时立即抛出异常 + * @return 无返回值（因为会直接抛出异常） + */ @Override public int getSyncAction(Cursor c) { throw new IllegalAccessError("MetaData:getSyncAction should not be called"); } -} +} \ No newline at end of file diff --git a/src/notes/gtask/data/Node.java b/src/notes/gtask/data/Node.java index 63950e0..879059e 100644 --- a/src/notes/gtask/data/Node.java +++ b/src/notes/gtask/data/Node.java @@ -20,33 +20,87 @@ import android.database.Cursor; import org.json.JSONObject; +/** + * GTask同步的核心抽象节点类 + * 该类是所有GTask同步数据（如笔记、文件夹）的基类，定义了同步所需的通用属性（GID、名称、修改时间、删除标记）、 + * 同步动作常量以及需要子类实现的抽象方法（JSON序列化/反序列化、同步动作判断等）。 + * 作为抽象类，它封装了GTask同步的通用逻辑，子类需根据具体数据类型（笔记/文件夹）实现抽象方法，完成具体的同步逻辑。 + * + * @author MiCode Open Source Community + * @date 2010-2011 + */ public abstract class Node { + // ====================== 同步动作常量 ====================== + /** + * 同步动作：无操作（数据一致，无需同步） + */ public static final int SYNC_ACTION_NONE = 0; + /** + * 同步动作：向远程GTask添加数据（本地新增数据，需要同步到远程） + */ public static final int SYNC_ACTION_ADD_REMOTE = 1; + /** + * 同步动作：向本地添加数据（远程GTask新增数据，需要同步到本地） + */ public static final int SYNC_ACTION_ADD_LOCAL = 2; + /** + * 同步动作：删除远程GTask数据（本地删除数据，需要同步删除远程数据） + */ public static final int SYNC_ACTION_DEL_REMOTE = 3; + /** + * 同步动作：删除本地数据（远程GTask删除数据，需要同步删除本地数据） + */ public static final int SYNC_ACTION_DEL_LOCAL = 4; + /** + * 同步动作：更新远程GTask数据（本地数据修改，需要同步更新远程数据） + */ public static final int SYNC_ACTION_UPDATE_REMOTE = 5; + /** + * 同步动作：更新本地数据（远程GTask数据修改，需要同步更新本地数据） + */ public static final int SYNC_ACTION_UPDATE_LOCAL = 6; + /** + * 同步动作：数据冲突（本地和远程数据都被修改，需要处理冲突） + */ public static final int SYNC_ACTION_UPDATE_CONFLICT = 7; + /** + * 同步动作：同步错误（同步过程中出现异常，标记为错误状态） + */ public static final int SYNC_ACTION_ERROR = 8; + // ====================== 成员变量 ====================== + /** + * GTask的唯一标识ID（Gid），用于关联本地数据和远程GTask数据 + */ private String mGid; + /** + * 节点名称（如笔记标题、文件夹名称） + */ private String mName; + /** + * 最后修改时间戳（毫秒），用于判断数据是否需要同步（本地与远程时间对比） + */ private long mLastModified; + /** + * 删除标记：true表示数据已被删除（本地或远程），需要同步删除操作 + */ private boolean mDeleted; + /** + * 构造方法：初始化节点的默认属性 + * Gid为null，名称为空字符串，最后修改时间为0，删除标记为false + */ public Node() { mGid = null; mName = ""; @@ -54,48 +108,110 @@ public abstract class Node { mDeleted = false; } + // ====================== 抽象方法（子类需实现） ====================== + /** + * 获取创建动作的JSON对象（用于向远程GTask发送创建请求） + * @param actionId 动作ID（标识本次创建动作的唯一ID） + * @return 包含创建动作信息的JSONObject + */ public abstract JSONObject getCreateAction(int actionId); + /** + * 获取更新动作的JSON对象（用于向远程GTask发送更新请求） + * @param actionId 动作ID（标识本次更新动作的唯一ID） + * @return 包含更新动作信息的JSONObject + */ public abstract JSONObject getUpdateAction(int actionId); + /** + * 根据远程GTask的JSON数据设置节点内容（将远程数据同步到本地） + * @param js 远程GTask返回的JSON数据对象 + */ public abstract void setContentByRemoteJSON(JSONObject js); + /** + * 根据本地的JSON数据设置节点内容（本地数据序列化后的恢复） + * @param js 本地存储的JSON数据对象 + */ public abstract void setContentByLocalJSON(JSONObject js); + /** + * 从节点内容中获取本地JSON数据（将本地数据序列化为JSON，用于存储或同步） + * @return 包含本地节点内容的JSONObject + */ public abstract JSONObject getLocalJSONFromContent(); + /** + * 根据本地数据库的Cursor数据判断当前节点的同步动作类型 + * 核心逻辑：对比本地数据和远程GTask数据的状态（新增、修改、删除），返回对应的同步动作常量 + * @param c 本地数据库的Cursor对象（包含本地数据的状态信息） + * @return 同步动作类型（对应SYNC_ACTION_*常量） + */ public abstract int getSyncAction(Cursor c); + // ====================== 成员变量的setter/getter方法 ====================== + /** + * 设置GTask的唯一标识ID（Gid） + * @param gid 远程GTask的Gid字符串 + */ public void setGid(String gid) { this.mGid = gid; } + /** + * 设置节点名称 + * @param name 节点名称字符串（笔记标题/文件夹名称） + */ public void setName(String name) { this.mName = name; } + /** + * 设置最后修改时间戳 + * @param lastModified 最后修改时间（毫秒） + */ public void setLastModified(long lastModified) { this.mLastModified = lastModified; } + /** + * 设置删除标记 + * @param deleted true表示数据已被删除，false表示数据正常 + */ public void setDeleted(boolean deleted) { this.mDeleted = deleted; } + /** + * 获取GTask的唯一标识ID（Gid） + * @return Gid字符串，若未关联远程数据则返回null + */ public String getGid() { return this.mGid; } + /** + * 获取节点名称 + * @return 节点名称字符串 + */ public String getName() { return this.mName; } + /** + * 获取最后修改时间戳 + * @return 最后修改时间（毫秒） + */ public long getLastModified() { return this.mLastModified; } + /** + * 获取删除标记 + * @return true表示数据已被删除，false表示数据正常 + */ public boolean getDeleted() { return this.mDeleted; } -} +} \ No newline at end of file diff --git a/src/notes/gtask/data/SqlData.java b/src/notes/gtask/data/SqlData.java index d3ec3be..cf5e62f 100644 --- a/src/notes/gtask/data/SqlData.java +++ b/src/notes/gtask/data/SqlData.java @@ -34,107 +34,230 @@ import net.micode.notes.gtask.exception.ActionFailureException; import org.json.JSONException; import org.json.JSONObject; - +/** + * 笔记应用data表的数据操作封装类 + * 该类专门处理Android ContentProvider对data表的增改、数据差异对比、JSON序列化/反序列化以及持久化操作， + * 是GTask同步过程中处理data表数据的核心类。它会记录数据的变更差异（mDiffDataValues），仅提交有变化的数据， + * 同时支持创建新数据和更新已有数据两种场景，并提供版本验证机制保证数据同步的一致性。 + * + * @author MiCode Open Source Community + * @date 2010-2011 + */ public class SqlData { + /** + * 日志标签，使用类的简单名称，便于调试时定位日志来源 + */ private static final String TAG = SqlData.class.getSimpleName(); + /** + * 无效的ID常量，用于标记数据ID尚未初始化或不存在（区别于数据库的自增ID） + */ private static final int INVALID_ID = -99999; + /** + * data表的查询投影（Projection），定义了查询时需要返回的列，减少数据传输开销 + * 包含：ID、MIME_TYPE、CONTENT、DATA1、DATA3 + */ public static final String[] PROJECTION_DATA = new String[] { DataColumns.ID, DataColumns.MIME_TYPE, DataColumns.CONTENT, DataColumns.DATA1, DataColumns.DATA3 }; + // ====================== PROJECTION_DATA的列索引常量 ====================== + /** + * PROJECTION_DATA中ID列的索引（对应DataColumns.ID） + */ public static final int DATA_ID_COLUMN = 0; + /** + * PROJECTION_DATA中MIME_TYPE列的索引（对应DataColumns.MIME_TYPE） + */ public static final int DATA_MIME_TYPE_COLUMN = 1; + /** + * PROJECTION_DATA中CONTENT列的索引（对应DataColumns.CONTENT） + */ public static final int DATA_CONTENT_COLUMN = 2; + /** + * PROJECTION_DATA中DATA1列的索引（对应DataColumns.DATA1） + */ public static final int DATA_CONTENT_DATA_1_COLUMN = 3; + /** + * PROJECTION_DATA中DATA3列的索引（对应DataColumns.DATA3） + */ public static final int DATA_CONTENT_DATA_3_COLUMN = 4; + // ====================== 成员变量 ====================== + /** + * Android内容解析器，用于访问ContentProvider进行数据的增删改查操作 + */ private ContentResolver mContentResolver; + /** + * 数据创建标记：true表示当前是新数据（需要插入数据库），false表示已有数据（需要更新数据库） + */ private boolean mIsCreate; + /** + * data表的主键ID，关联到具体的行数据 + */ private long mDataId; + /** + * 数据的MIME类型（如文本笔记：DataConstants.NOTE，通话笔记：DataConstants.CALL_NOTE） + */ private String mDataMimeType; + /** + * 数据的内容（如文本笔记的文本内容） + */ private String mDataContent; + /** + * DATA1列的数据（整型，如文本笔记的模式、通话笔记的通话时间） + */ private long mDataContentData1; + /** + * DATA3列的数据（文本，如通话笔记的电话号码） + */ private String mDataContentData3; + /** + * 数据差异的ContentValues，仅存储有变化的字段，用于提交到数据库（减少不必要的更新） + */ private ContentValues mDiffDataValues; + /** + * 构造方法：初始化新的SqlData对象（用于创建新数据） + * + * @param context 上下文对象，用于获取ContentResolver + */ public SqlData(Context context) { + // 获取ContentResolver实例，用于访问ContentProvider mContentResolver = context.getContentResolver(); + // 标记为新数据，需要插入数据库 mIsCreate = true; + // 初始化ID为无效值 mDataId = INVALID_ID; + // 默认MIME类型为文本笔记 mDataMimeType = DataConstants.NOTE; + // 初始化内容为空字符串 mDataContent = ""; + // 初始化DATA1为0 mDataContentData1 = 0; + // 初始化DATA3为空字符串 mDataContentData3 = ""; + // 初始化数据差异容器 mDiffDataValues = new ContentValues(); } + /** + * 构造方法：从Cursor中加载已有数据初始化SqlData对象（用于更新已有数据） + * + * @param context 上下文对象，用于获取ContentResolver + * @param c 包含data表数据的Cursor对象（需使用PROJECTION_DATA投影查询） + */ public SqlData(Context context, Cursor c) { mContentResolver = context.getContentResolver(); + // 标记为已有数据，需要更新数据库 mIsCreate = false; + // 从Cursor中加载数据到成员变量 loadFromCursor(c); + // 初始化数据差异容器 mDiffDataValues = new ContentValues(); } + /** + * 辅助方法：从Cursor中加载数据到成员变量 + * 需保证Cursor使用PROJECTION_DATA投影查询，否则会出现列索引越界异常 + * + * @param c 包含data表数据的Cursor对象 + */ private void loadFromCursor(Cursor c) { + // 从Cursor中获取ID（长整型） mDataId = c.getLong(DATA_ID_COLUMN); + // 获取MIME类型（字符串） mDataMimeType = c.getString(DATA_MIME_TYPE_COLUMN); + // 获取内容（字符串） mDataContent = c.getString(DATA_CONTENT_COLUMN); + // 获取DATA1（长整型） mDataContentData1 = c.getLong(DATA_CONTENT_DATA_1_COLUMN); + // 获取DATA3（字符串） mDataContentData3 = c.getString(DATA_CONTENT_DATA_3_COLUMN); } + /** + * 根据JSON对象设置数据内容，并记录数据差异到mDiffDataValues + * 核心逻辑：对比当前数据与JSON中的数据，仅将有变化的字段加入差异容器，新数据则直接加入所有字段 + * + * @param js 包含data表数据的JSON对象 + * @throws JSONException JSON解析异常（如字段类型不匹配、缺失等） + */ public void setContent(JSONObject js) throws JSONException { + // 从JSON中获取ID，默认值为INVALID_ID long dataId = js.has(DataColumns.ID) ? js.getLong(DataColumns.ID) : INVALID_ID; + // 新数据或ID变化时，将ID加入差异容器 if (mIsCreate || mDataId != dataId) { mDiffDataValues.put(DataColumns.ID, dataId); } + // 更新当前ID mDataId = dataId; + // 从JSON中获取MIME类型，默认值为文本笔记 String dataMimeType = js.has(DataColumns.MIME_TYPE) ? js.getString(DataColumns.MIME_TYPE) : DataConstants.NOTE; + // 新数据或MIME类型变化时，将MIME_TYPE加入差异容器 if (mIsCreate || !mDataMimeType.equals(dataMimeType)) { mDiffDataValues.put(DataColumns.MIME_TYPE, dataMimeType); } + // 更新当前MIME类型 mDataMimeType = dataMimeType; + // 从JSON中获取内容，默认值为空字符串 String dataContent = js.has(DataColumns.CONTENT) ? js.getString(DataColumns.CONTENT) : ""; + // 新数据或内容变化时，将CONTENT加入差异容器 if (mIsCreate || !mDataContent.equals(dataContent)) { mDiffDataValues.put(DataColumns.CONTENT, dataContent); } + // 更新当前内容 mDataContent = dataContent; + // 从JSON中获取DATA1，默认值为0 long dataContentData1 = js.has(DataColumns.DATA1) ? js.getLong(DataColumns.DATA1) : 0; + // 新数据或DATA1变化时，将DATA1加入差异容器 if (mIsCreate || mDataContentData1 != dataContentData1) { mDiffDataValues.put(DataColumns.DATA1, dataContentData1); } + // 更新当前DATA1 mDataContentData1 = dataContentData1; + // 从JSON中获取DATA3，默认值为空字符串 String dataContentData3 = js.has(DataColumns.DATA3) ? js.getString(DataColumns.DATA3) : ""; + // 新数据或DATA3变化时，将DATA3加入差异容器 if (mIsCreate || !mDataContentData3.equals(dataContentData3)) { mDiffDataValues.put(DataColumns.DATA3, dataContentData3); } + // 更新当前DATA3 mDataContentData3 = dataContentData3; } + /** + * 将当前数据序列化为JSON对象 + * 仅当数据已存在（非新数据）时才会序列化，否则输出错误日志并返回null + * + * @return 包含data表数据的JSON对象 + * @throws JSONException JSON序列化异常（如字段写入失败） + */ public JSONObject getContent() throws JSONException { + // 新数据尚未持久化，输出错误日志并返回null if (mIsCreate) { Log.e(TAG, "it seems that we haven't created this in database yet"); return null; } + // 创建JSON对象并写入所有数据字段 JSONObject js = new JSONObject(); js.put(DataColumns.ID, mDataId); js.put(DataColumns.MIME_TYPE, mDataMimeType); @@ -144,46 +267,69 @@ public class SqlData { return js; } + /** + * 提交数据变更到数据库（插入或更新） + * 支持版本验证机制，保证同步时数据的一致性（仅当note表的版本匹配时才更新） + * + * @param noteId 关联的note表ID（data表的NOTE_ID列） + * @param validateVersion 是否开启版本验证：true表示验证，false表示不验证 + * @param version 需要验证的note表版本号（仅当validateVersion为true时生效） + */ public void commit(long noteId, boolean validateVersion, long version) { - + // 新数据：执行插入操作 if (mIsCreate) { + // 若ID为无效值且差异容器中包含ID，移除该ID（数据库自增ID，无需手动设置） if (mDataId == INVALID_ID && mDiffDataValues.containsKey(DataColumns.ID)) { mDiffDataValues.remove(DataColumns.ID); } + // 添加关联的note表ID到差异容器 mDiffDataValues.put(DataColumns.NOTE_ID, noteId); + // 插入数据到ContentProvider，获取返回的Uri（包含新数据的ID） Uri uri = mContentResolver.insert(Notes.CONTENT_DATA_URI, mDiffDataValues); try { + // 从Uri中解析出新数据的ID（Uri路径分段的第二个元素，如data/123中的123） mDataId = Long.valueOf(uri.getPathSegments().get(1)); } catch (NumberFormatException e) { + // 解析ID失败，输出错误日志并抛出同步失败异常 Log.e(TAG, "Get note id error :" + e.toString()); throw new ActionFailureException("create note failed"); } } else { + // 已有数据：仅当存在差异时执行更新操作 if (mDiffDataValues.size() > 0) { int result = 0; if (!validateVersion) { + // 不验证版本：直接更新数据（根据data表ID） result = mContentResolver.update(ContentUris.withAppendedId( Notes.CONTENT_DATA_URI, mDataId), mDiffDataValues, null, null); } else { + // 验证版本：仅当note表中对应ID的版本号匹配时才更新 result = mContentResolver.update(ContentUris.withAppendedId( - Notes.CONTENT_DATA_URI, mDataId), mDiffDataValues, + Notes.CONTENT_DATA_URI, mDataId), mDiffDataValues, " ? in (SELECT " + NoteColumns.ID + " FROM " + TABLE.NOTE + " WHERE " + NoteColumns.VERSION + "=?)", new String[] { String.valueOf(noteId), String.valueOf(version) }); } + // 更新结果为0，说明数据未更新（可能同步时用户修改了数据），输出警告日志 if (result == 0) { Log.w(TAG, "there is no update. maybe user updates note when syncing"); } } } + // 清空差异容器，标记数据为已存在（非新数据） mDiffDataValues.clear(); mIsCreate = false; } + /** + * 获取当前data表数据的ID + * + * @return data表的主键ID，若未初始化则返回INVALID_ID + */ public long getId() { return mDataId; } -} +} \ No newline at end of file diff --git a/src/notes/tool/BackupUtils.java b/src/notes/tool/BackupUtils.java index 39f6ec4..b9f0b86 100644 --- a/src/notes/tool/BackupUtils.java +++ b/src/notes/tool/BackupUtils.java @@ -14,294 +14,453 @@ * limitations under the License. */ +// BackupUtils.java - 小米便签备份工具类 +// 主要功能：将便签数据导出为文本文件格式，方便用户备份和查看 package net.micode.notes.tool; -import android.content.Context; -import android.database.Cursor; -import android.os.Environment; -import android.text.TextUtils; -import android.text.format.DateFormat; -import android.util.Log; - -import net.micode.notes.R; -import net.micode.notes.data.Notes; -import net.micode.notes.data.Notes.DataColumns; -import net.micode.notes.data.Notes.DataConstants; -import net.micode.notes.data.Notes.NoteColumns; - -import java.io.File; -import java.io.FileNotFoundException; -import java.io.FileOutputStream; -import java.io.IOException; -import java.io.PrintStream; - - +// ======================= 导入区域 ======================= +// Android系统相关类 +import android.content.Context; // 上下文，用于获取资源、ContentResolver等 +import android.database.Cursor; // 数据库查询结果游标 +import android.os.Environment; // 环境相关，用于访问外部存储 +import android.text.TextUtils; // 文本处理工具类 +import android.text.format.DateFormat; // 日期格式化工具 +import android.util.Log; // 日志工具 + +// 应用内部资源 +import net.micode.notes.R; // 资源文件R类 + +// 应用数据模型相关 +import net.micode.notes.data.Notes; // Notes主类 +import net.micode.notes.data.Notes.DataColumns; // 数据表列定义 +import net.micode.notes.data.Notes.DataConstants;// 数据常量定义 +import net.micode.notes.data.Notes.NoteColumns; // 便签表列定义 + +// Java IO相关 +import java.io.File; // 文件操作 +import java.io.FileNotFoundException; // 文件未找到异常 +import java.io.FileOutputStream; // 文件输出流 +import java.io.IOException; // IO异常 +import java.io.PrintStream; // 打印输出流 + +// ======================= 备份工具主类 ======================= +/** + * BackupUtils - 便签备份工具 + * 采用单例设计模式，确保整个应用只有一个备份工具实例 + * 主要功能：将数据库中的便签数据导出为可读的文本文件 + */ public class BackupUtils { + // TAG - 日志标签，用于Logcat日志筛选 private static final String TAG = "BackupUtils"; - // Singleton stuff + + // ======================= 单例模式实现 ======================= + // sInstance - 静态单例实例，volatile确保多线程可见性 private static BackupUtils sInstance; + /** + * 获取BackupUtils单例实例 + * synchronized - 线程安全，防止多线程环境下创建多个实例 + * @param context 应用上下文，用于初始化 + * @return BackupUtils唯一实例 + */ public static synchronized BackupUtils getInstance(Context context) { + // 懒加载：首次调用时创建实例 if (sInstance == null) { sInstance = new BackupUtils(context); } return sInstance; } + // ======================= 备份状态常量定义 ======================= /** - * 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; + 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; // 操作成功完成 + // mTextExport - 文本导出器实例，实际执行导出操作 private TextExport mTextExport; + /** + * 私有构造函数 - 单例模式关键，防止外部直接实例化 + * @param context 应用上下文，用于初始化TextExport + */ private BackupUtils(Context context) { + // 创建文本导出器，传入上下文用于资源访问 mTextExport = new TextExport(context); } + /** + * 检查外部存储状态 + * @return true: SD卡已挂载可读写; false: SD卡不可用 + */ private static boolean externalStorageAvailable() { + // Environment.MEDIA_MOUNTED - 存储介质已挂载且可读写 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; } + // ======================= 文本导出内部类 ======================= + /** + * TextExport - 文本导出器内部类 + * 私有静态内部类，封装具体的导出逻辑 + * 负责：查询数据 -> 格式化 -> 写入文件 + */ private static class TextExport { + // ======================= 数据库查询配置 ======================= + + // NOTE_PROJECTION - 便签表查询字段投影 + // 指定从数据库查询哪些字段，避免查询不必要的数据 private static final String[] NOTE_PROJECTION = { - NoteColumns.ID, - NoteColumns.MODIFIED_DATE, - NoteColumns.SNIPPET, - NoteColumns.TYPE + NoteColumns.ID, // 0 - 便签ID，主键 + NoteColumns.MODIFIED_DATE, // 1 - 最后修改时间 + NoteColumns.SNIPPET, // 2 - 便签摘要/标题 + NoteColumns.TYPE // 3 - 便签类型（文件夹/便签） }; - 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 int NOTE_COLUMN_ID = 0; // ID列索引 + private static final int NOTE_COLUMN_MODIFIED_DATE = 1; // 修改时间列索引 + private static final int NOTE_COLUMN_SNIPPET = 2; // 摘要列索引 + // DATA_PROJECTION - 便签数据表查询字段投影 + // 便签具体内容存储在数据表中 private static final String[] DATA_PROJECTION = { - DataColumns.CONTENT, - DataColumns.MIME_TYPE, - DataColumns.DATA1, - DataColumns.DATA2, - DataColumns.DATA3, - DataColumns.DATA4, + DataColumns.CONTENT, // 0 - 便签内容 + DataColumns.MIME_TYPE, // 1 - 数据类型（普通便签/通话记录） + DataColumns.DATA1, // 2 - 扩展数据1（通话记录时为通话时间） + DataColumns.DATA2, // 3 - 扩展数据2 + DataColumns.DATA3, // 4 - 扩展数据3 + DataColumns.DATA4, // 5 - 扩展数据4（通话记录时为电话号码） }; - private static final int DATA_COLUMN_CONTENT = 0; - - private static final int DATA_COLUMN_MIME_TYPE = 1; + // 数据表字段索引常量 + 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 static final int DATA_COLUMN_CALL_DATE = 2; - - private static final int DATA_COLUMN_PHONE_NUMBER = 4; + // ======================= 文本格式化配置 ======================= + // TEXT_FORMAT - 文本格式化模板数组 + // 从strings.xml的format_for_exported_note数组加载 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 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; // 导出的文件目录 + /** + * TextExport构造函数 + * @param context 应用上下文，用于获取格式化模板 + */ public TextExport(Context context) { + // 从资源文件加载格式化模板 TEXT_FORMAT = context.getResources().getStringArray(R.array.format_for_exported_note); mContext = context; + // 初始化为空字符串 mFileName = ""; mFileDirectory = ""; } + /** + * 获取指定索引的格式化模板 + * @param id 模板索引（FORMAT_FOLDER_NAME等） + * @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); - + // 查询该文件夹下的所有便签 + // Notes.CONTENT_NOTE_URI - 便签内容URI + // NoteColumns.PARENT_ID - 父文件夹ID条件 + Cursor notesCursor = mContext.getContentResolver().query( + Notes.CONTENT_NOTE_URI, // 便签表URI + NOTE_PROJECTION, // 查询的字段 + NoteColumns.PARENT_ID + "=?", // 查询条件：父ID等于指定文件夹 + new String[] { folderId }, // 查询参数 + null // 排序方式（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 + // 1. 打印便签修改时间 + // 使用格式化模板，将时间戳格式化为可读字符串 + ps.println(String.format( + getFormat(FORMAT_NOTE_DATE), + DateFormat.format( + mContext.getString(R.string.format_datetime_mdhm), // 日期时间格式 + notesCursor.getLong(NOTE_COLUMN_MODIFIED_DATE) // 时间戳 + ) + )); + + // 2. 导出该便签的具体内容 String noteId = notesCursor.getString(NOTE_COLUMN_ID); exportNoteToText(noteId, ps); - } while (notesCursor.moveToNext()); + + } while (notesCursor.moveToNext()); // 继续下一个便签 } + // 关闭游标，释放数据库资源 notesCursor.close(); } } /** - * 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, // 便签数据表URI + DATA_PROJECTION, // 查询字段 + DataColumns.NOTE_ID + "=?", // 查询条件：便签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 + // ===== 通话记录类型 ===== + // 1. 获取通话相关数据 String phoneNumber = dataCursor.getString(DATA_COLUMN_PHONE_NUMBER); long callDate = dataCursor.getLong(DATA_COLUMN_CALL_DATE); String location = dataCursor.getString(DATA_COLUMN_CONTENT); + // 2. 打印电话号码（如果有） if (!TextUtils.isEmpty(phoneNumber)) { - ps.println(String.format(getFormat(FORMAT_NOTE_CONTENT), - phoneNumber)); + 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 + + // 3. 打印通话时间 + ps.println(String.format( + getFormat(FORMAT_NOTE_CONTENT), + DateFormat.format( + mContext.getString(R.string.format_datetime_mdhm), + callDate + ) + )); + + // 4. 打印位置信息（如果有） if (!TextUtils.isEmpty(location)) { - ps.println(String.format(getFormat(FORMAT_NOTE_CONTENT), - location)); + ps.println(String.format(getFormat(FORMAT_NOTE_CONTENT), location)); } + } 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), - content)); + ps.println(String.format(getFormat(FORMAT_NOTE_CONTENT), content)); } } - } while (dataCursor.moveToNext()); + } while (dataCursor.moveToNext()); // 继续下一个数据项 } + // 关闭游标 dataCursor.close(); } - // print a line separator between note + + // 在便签之间添加分隔符 + // 使用换行符分隔不同便签，提高可读性 try { ps.write(new byte[] { - Character.LINE_SEPARATOR, Character.LETTER_NUMBER + Character.LINE_SEPARATOR, // 行分隔符 + Character.LETTER_NUMBER // 字母数字 }); } catch (IOException e) { + // 记录异常，但不中断导出流程 Log.e(TAG, e.toString()); } } /** - * Note will be exported as text which is user readable + * 导出所有便签到文本文件 - 主导出方法 + * 导出流程： + * 1. 检查SD卡状态 + * 2. 创建输出文件 + * 3. 导出文件夹便签 + * 4. 导出根目录便签 + * 5. 关闭流 + * @return 导出状态码 */ public int exportToText() { + // 1. 检查SD卡是否可用 if (!externalStorageAvailable()) { Log.d(TAG, "Media was not mounted"); return STATE_SD_CARD_UNMOUONTED; } + // 2. 获取输出流 PrintStream ps = getExportToTextPrintStream(); if (ps == null) { Log.e(TAG, "get print stream error"); return STATE_SYSTEM_ERROR; } - // First export folder and its notes + + // 3. 导出文件夹及其便签 + // 查询条件说明： + // - 类型为文件夹 且 不在回收站中 + // - 或者 ID是通话记录文件夹 Cursor folderCursor = mContext.getContentResolver().query( - Notes.CONTENT_NOTE_URI, - NOTE_PROJECTION, + 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)); } + + // 导出该文件夹下的所有便签 String folderId = folderCursor.getString(NOTE_COLUMN_ID); exportFolderToText(folderId, ps); + } while (folderCursor.moveToNext()); } folderCursor.close(); } - // Export notes in root's folder + // 4. 导出根目录下的便签（没有父文件夹的便签） + // 查询条件：类型为普通便签 且 父ID为0（根目录） 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(); } + + // 5. 关闭输出流 ps.close(); return STATE_SUCCESS; } /** - * Get a print stream pointed to the file {@generateExportedTextFile} + * 创建输出文件并获取打印流 + * 文件路径：SD卡根目录 + 配置路径 + 日期时间文件名 + * @return PrintStream 输出流，失败返回null */ private PrintStream getExportToTextPrintStream() { - File file = generateFileMountedOnSDcard(mContext, R.string.file_path, - R.string.file_name_txt_format); + // 生成输出文件 + File file = generateFileMountedOnSDcard( + mContext, + R.string.file_path, // 文件路径资源ID + R.string.file_name_txt_format // 文件名格式资源ID + ); + if (file == null) { Log.e(TAG, "create file to exported failed"); return null; } - mFileName = file.getName(); - mFileDirectory = mContext.getString(R.string.file_path); + + // 保存文件信息 + mFileName = file.getName(); // 文件名 + mFileDirectory = mContext.getString(R.string.file_path); // 文件目录 + PrintStream ps = null; try { + // 创建文件输出流 FileOutputStream fos = new FileOutputStream(file); + // 创建打印流，方便文本输出 ps = new PrintStream(fos); } catch (FileNotFoundException e) { + // 文件未找到异常 e.printStackTrace(); return null; } catch (NullPointerException e) { + // 空指针异常 e.printStackTrace(); return null; } @@ -309,36 +468,62 @@ public class BackupUtils { } } + // ======================= 静态工具方法 ======================= /** - * Generate the text file to store imported data + * 在SD卡上创建导出文件 + * 文件命名规则：使用当前日期时间，避免重复 + * @param context 上下文 + * @param filePathResId 文件路径资源ID（如："/backup/"） + * @param fileNameFormatResId 文件名格式资源ID（如："notes_%s.txt"） + * @return 创建的文件对象，失败返回null */ - private static File generateFileMountedOnSDcard(Context context, int filePathResId, int fileNameFormatResId) { + private static File generateFileMountedOnSDcard( + Context context, + int filePathResId, + int fileNameFormatResId + ) { + // 使用StringBuilder构建文件路径，提高性能 StringBuilder sb = new StringBuilder(); + + // 1. SD卡根目录 sb.append(Environment.getExternalStorageDirectory()); + // 2. 应用指定的文件路径 sb.append(context.getString(filePathResId)); + + // 创建目录对象 File filedir = new File(sb.toString()); + + // 3. 添加文件名（使用当前日期格式化） + // 格式如：notes_20231215.txt sb.append(context.getString( fileNameFormatResId, - DateFormat.format(context.getString(R.string.format_date_ymd), - System.currentTimeMillis()))); + DateFormat.format( + context.getString(R.string.format_date_ymd), // 日期格式 + System.currentTimeMillis() // 当前时间戳 + ) + )); + + // 创建文件对象 File file = new File(sb.toString()); try { + // 创建目录（如果不存在） if (!filedir.exists()) { - filedir.mkdir(); + filedir.mkdir(); // 创建单级目录 } + // 创建文件（如果不存在） if (!file.exists()) { file.createNewFile(); } return file; } catch (SecurityException e) { + // 权限异常：无SD卡写入权限 e.printStackTrace(); } catch (IOException e) { + // IO异常：磁盘空间不足等 e.printStackTrace(); } - return null; + return null; // 创建失败返回null } -} - - +} \ No newline at end of file diff --git a/src/notes/tool/DataUtils.java b/src/notes/tool/DataUtils.java index 2a14982..4c6ecdd 100644 --- a/src/notes/tool/DataUtils.java +++ b/src/notes/tool/DataUtils.java @@ -14,95 +14,158 @@ * limitations under the License. */ +// DataUtils.java - 小米便签数据工具类 +// 主要功能：提供便签数据的批量操作、查询、验证等工具方法 package net.micode.notes.tool; -import android.content.ContentProviderOperation; -import android.content.ContentProviderResult; -import android.content.ContentResolver; -import android.content.ContentUris; -import android.content.ContentValues; -import android.content.OperationApplicationException; -import android.database.Cursor; -import android.os.RemoteException; -import android.util.Log; +// ======================= 导入区域 ======================= +// Android数据操作相关类 +import android.content.ContentProviderOperation; // 内容提供者批量操作 +import android.content.ContentProviderResult; // 批量操作结果 +import android.content.ContentResolver; // 内容解析器，用于访问ContentProvider +import android.content.ContentUris; // URI工具，用于构建带ID的URI +import android.content.ContentValues; // 键值对容器，用于插入/更新数据 +import android.content.OperationApplicationException; // 批量操作异常 +import android.database.Cursor; // 数据库查询结果游标 +import android.os.RemoteException; // 远程调用异常 +import android.util.Log; // 日志工具 -import net.micode.notes.data.Notes; -import net.micode.notes.data.Notes.CallNote; -import net.micode.notes.data.Notes.NoteColumns; -import net.micode.notes.ui.NotesListAdapter.AppWidgetAttribute; - -import java.util.ArrayList; -import java.util.HashSet; +// 应用内部数据模型 +import net.micode.notes.data.Notes; // Notes主类 +import net.micode.notes.data.Notes.CallNote; // 通话记录相关常量 +import net.micode.notes.data.Notes.NoteColumns; // 便签表列定义 +import net.micode.notes.ui.NotesListAdapter.AppWidgetAttribute; // 小部件属性类 +// Java集合类 +import java.util.ArrayList; // 动态数组 +import java.util.HashSet; // 哈希集合，用于存储唯一ID +// ======================= 数据工具主类 ======================= +/** + * DataUtils - 便签数据操作工具类 + * 包含对便签数据的批量删除、移动、查询、验证等常用操作 + * 所有方法都是静态工具方法，无需实例化即可使用 + */ public class DataUtils { + // TAG - 日志标签，用于Logcat日志筛选 public static final String TAG = "DataUtils"; + + /** + * 批量删除便签 + * 使用ContentProvider批量操作，提高删除效率 + * @param resolver 内容解析器，用于访问ContentProvider + * @param ids 要删除的便签ID集合（HashSet保证ID唯一性） + * @return true: 删除成功; false: 删除失败 + */ public static boolean batchDeleteNotes(ContentResolver resolver, HashSet ids) { + // 参数验证 if (ids == null) { Log.d(TAG, "the ids is null"); - return true; + return true; // 空集合视为成功，无需操作 } if (ids.size() == 0) { Log.d(TAG, "no id is in the hashset"); - return true; + return true; // 空集合视为成功 } - ArrayList operationList = new ArrayList(); + // 创建批量操作列表 + ArrayList operationList = + new ArrayList(); + + // 遍历ID集合，为每个便签创建删除操作 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()); return false; } return true; + } catch (RemoteException e) { + // 远程调用异常 Log.e(TAG, String.format("%s: %s", e.toString(), e.getMessage())); } catch (OperationApplicationException e) { + // 批量操作应用异常 Log.e(TAG, String.format("%s: %s", e.toString(), e.getMessage())); } return false; } + /** + * 移动单个便签到其他文件夹 + * 更新便签的父文件夹ID，并标记为本地已修改 + * @param resolver 内容解析器 + * @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 内容解析器 + * @param ids 要移动的便签ID集合 + * @param folderId 目标文件夹ID + * @return true: 移动成功; false: 移动失败 + */ public static boolean batchMoveToFolder(ContentResolver resolver, HashSet ids, - long folderId) { + long folderId) { + // 参数验证 if (ids == null) { Log.d(TAG, "the ids is null"); - return true; + return true; // 空集合视为成功 } - ArrayList operationList = new ArrayList(); + // 创建批量操作列表 + 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()); } + // 执行批量操作 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; } return true; + } catch (RemoteException e) { Log.e(TAG, String.format("%s: %s", e.toString(), e.getMessage())); } catch (OperationApplicationException e) { @@ -112,39 +175,56 @@ public class DataUtils { } /** - * Get the all folder count except system folders {@link Notes#TYPE_SYSTEM}} + * 获取用户文件夹数量（排除系统文件夹） + * 统计所有用户创建的文件夹，不包括系统预置文件夹 + * @param resolver 内容解析器 + * @return 用户文件夹数量 */ public static int getUserFolderCount(ContentResolver resolver) { + // 查询条件：类型为文件夹 且 不在回收站中 Cursor cursor =resolver.query(Notes.CONTENT_NOTE_URI, - new String[] { "COUNT(*)" }, - NoteColumns.TYPE + "=? AND " + NoteColumns.PARENT_ID + "<>?", - new String[] { String.valueOf(Notes.TYPE_FOLDER), String.valueOf(Notes.ID_TRASH_FOLER)}, + new String[] { "COUNT(*)" }, // 只查询数量 + NoteColumns.TYPE + "=? AND " + NoteColumns.PARENT_ID + "<>?", // 查询条件 + new String[] { + String.valueOf(Notes.TYPE_FOLDER), // 参数1：文件夹类型 + String.valueOf(Notes.ID_TRASH_FOLER) // 参数2：排除回收站 + }, null); int count = 0; if(cursor != null) { if(cursor.moveToFirst()) { try { - count = cursor.getInt(0); + count = cursor.getInt(0); // 获取第一列（COUNT(*)结果） } catch (IndexOutOfBoundsException e) { Log.e(TAG, "get folder count failed:" + e.toString()); } finally { - cursor.close(); + cursor.close(); // 确保游标关闭 } } } return count; } + /** + * 检查便签在数据库中是否可见 + * 可见条件：指定类型 且 不在回收站中 + * @param resolver 内容解析器 + * @param noteId 便签ID + * @param type 便签类型（Notes.TYPE_NOTE 或 Notes.TYPE_FOLDER） + * @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, + null, // 查询所有列 NoteColumns.TYPE + "=? AND " + NoteColumns.PARENT_ID + "<>" + Notes.ID_TRASH_FOLER, - new String [] {String.valueOf(type)}, + new String [] {String.valueOf(type)}, // 类型参数 null); boolean exist = false; if (cursor != null) { + // 只要查询到记录就表示可见 if (cursor.getCount() > 0) { exist = true; } @@ -153,7 +233,15 @@ public class DataUtils { return exist; } + /** + * 检查便签是否存在于数据库中 + * 不关心是否在回收站，只要存在就返回true + * @param resolver 内容解析器 + * @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 +255,13 @@ public class DataUtils { return exist; } + /** + * 检查数据项是否存在于数据表中 + * 数据表存储便签的具体内容 + * @param resolver 内容解析器 + * @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,12 +276,21 @@ public class DataUtils { return exist; } + /** + * 检查可见文件夹名称是否已存在 + * 用于创建文件夹时的重名检查 + * @param resolver 内容解析器 + * @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 + - " AND " + NoteColumns.PARENT_ID + "<>" + Notes.ID_TRASH_FOLER + - " AND " + NoteColumns.SNIPPET + "=?", + " AND " + NoteColumns.PARENT_ID + "<>" + Notes.ID_TRASH_FOLER + + " AND " + NoteColumns.SNIPPET + "=?", // SNIPPET字段存储文件夹名称 new String[] { name }, null); + boolean exist = false; if(cursor != null) { if(cursor.getCount() > 0) { @@ -197,76 +301,118 @@ public class DataUtils { return exist; } + /** + * 获取文件夹下所有便签的小部件信息 + * 用于桌面小部件管理 + * @param resolver 内容解析器 + * @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 }, - NoteColumns.PARENT_ID + "=?", + new String[] { NoteColumns.WIDGET_ID, NoteColumns.WIDGET_TYPE }, // 小部件相关字段 + NoteColumns.PARENT_ID + "=?", // 父文件夹条件 new String[] { String.valueOf(folderId) }, null); HashSet set = null; if (c != null) { if (c.moveToFirst()) { - set = new HashSet(); + set = new HashSet(); // 创建集合 do { try { + // 创建小部件属性对象 AppWidgetAttribute widget = new AppWidgetAttribute(); - widget.widgetId = c.getInt(0); - widget.widgetType = c.getInt(1); - set.add(widget); + widget.widgetId = c.getInt(0); // 小部件ID + widget.widgetType = c.getInt(1); // 小部件类型 + set.add(widget); // 添加到集合 } catch (IndexOutOfBoundsException e) { - Log.e(TAG, e.toString()); + Log.e(TAG, e.toString()); // 字段索引异常 } - } while (c.moveToNext()); + } while (c.moveToNext()); // 遍历所有便签 } c.close(); } return set; } + /** + * 根据便签ID获取通话记录的电话号码 + * 用于通话记录类型便签 + * @param resolver 内容解析器 + * @param noteId 便签ID + * @return 电话号码，空字符串表示未找到 + */ public static String getCallNumberByNoteId(ContentResolver resolver, long noteId) { + // 查询条件：便签ID匹配 且 类型为通话记录 Cursor cursor = resolver.query(Notes.CONTENT_DATA_URI, - new String [] { CallNote.PHONE_NUMBER }, + new String [] { CallNote.PHONE_NUMBER }, // 只查询电话号码 CallNote.NOTE_ID + "=? AND " + CallNote.MIME_TYPE + "=?", - new String [] { String.valueOf(noteId), CallNote.CONTENT_ITEM_TYPE }, + new String [] { + String.valueOf(noteId), // 参数1：便签ID + CallNote.CONTENT_ITEM_TYPE // 参数2：通话记录类型 + }, null); if (cursor != null && cursor.moveToFirst()) { try { - return cursor.getString(0); + return cursor.getString(0); // 返回电话号码 } catch (IndexOutOfBoundsException e) { Log.e(TAG, "Get call number fails " + e.toString()); } finally { - cursor.close(); + cursor.close(); // finally块确保游标关闭 } } - return ""; + return ""; // 未找到返回空字符串 } + /** + * 根据电话号码和通话时间查找便签ID + * 用于避免创建重复的通话记录 + * @param resolver 内容解析器 + * @param phoneNumber 电话号码 + * @param callDate 通话时间戳 + * @return 便签ID，0表示未找到 + */ public static long getNoteIdByPhoneNumberAndCallDate(ContentResolver resolver, String phoneNumber, long callDate) { + // 查询条件：通话时间匹配 且 类型为通话记录 且 电话号码匹配 + // PHONE_NUMBERS_EQUAL是自定义函数，用于比较电话号码（可能处理格式差异） Cursor cursor = resolver.query(Notes.CONTENT_DATA_URI, - new String [] { CallNote.NOTE_ID }, + new String [] { CallNote.NOTE_ID }, // 只查询便签ID CallNote.CALL_DATE + "=? AND " + CallNote.MIME_TYPE + "=? AND PHONE_NUMBERS_EQUAL(" - + CallNote.PHONE_NUMBER + ",?)", - new String [] { String.valueOf(callDate), CallNote.CONTENT_ITEM_TYPE, phoneNumber }, + + CallNote.PHONE_NUMBER + ",?)", + new String [] { + String.valueOf(callDate), // 参数1：通话时间 + CallNote.CONTENT_ITEM_TYPE, // 参数2：通话记录类型 + phoneNumber // 参数3：电话号码 + }, null); if (cursor != null) { if (cursor.moveToFirst()) { try { - return cursor.getLong(0); + return cursor.getLong(0); // 返回便签ID } catch (IndexOutOfBoundsException e) { Log.e(TAG, "Get call note id fails " + e.toString()); } } cursor.close(); } - return 0; + return 0; // 未找到返回0 } + /** + * 根据便签ID获取便签摘要 + * 摘要通常显示在列表视图中 + * @param resolver 内容解析器 + * @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 }, + new String [] { NoteColumns.SNIPPET }, // 只查询摘要字段 NoteColumns.ID + "=?", new String [] { String.valueOf(noteId)}, null); @@ -274,7 +420,7 @@ public class DataUtils { if (cursor != null) { String snippet = ""; if (cursor.moveToFirst()) { - snippet = cursor.getString(0); + snippet = cursor.getString(0); // 获取摘要 } cursor.close(); return snippet; @@ -282,14 +428,23 @@ 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); } } return snippet; } -} +} \ No newline at end of file diff --git a/src/notes/tool/GTaskStringUtils.java b/src/notes/tool/GTaskStringUtils.java index 666b729..747dae3 100644 --- a/src/notes/tool/GTaskStringUtils.java +++ b/src/notes/tool/GTaskStringUtils.java @@ -14,100 +14,184 @@ * limitations under the License. */ +// GTaskStringUtils.java - Google任务（GTasks）同步相关的字符串常量工具类 +// 主要功能：定义与Google Tasks API交互时使用的JSON键名、操作类型、元数据标识等常量 +// 这些常量用于序列化和反序列化Google Tasks的JSON数据 package net.micode.notes.tool; +// ======================= Google Tasks JSON键名常量 ======================= +/** + * GTaskStringUtils - Google Tasks同步字符串常量工具类 + * 包含所有与Google Tasks API通信时使用的JSON键名、操作类型、文件夹标识等常量 + * 所有常量都是public static final，确保全局唯一且不可修改 + */ public class GTaskStringUtils { + // ======================= 操作相关键名 ======================= + + /** 操作ID键名 - JSON中标识操作的唯一ID */ public final static String GTASK_JSON_ACTION_ID = "action_id"; + /** 操作列表键名 - JSON中包含多个操作的数组 */ public final static String GTASK_JSON_ACTION_LIST = "action_list"; + /** 操作类型键名 - JSON中标识操作类型的字段 */ 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"; + // ======================= 创建者和版本信息 ======================= + + /** 创建者ID键名 - JSON中标识创建者的字段 */ public final static String GTASK_JSON_CREATOR_ID = "creator_id"; + /** 客户端版本键名 - JSON中标识客户端版本的字段 */ + public final static String GTASK_JSON_CLIENT_VERSION = "client_version"; + + // ======================= 实体和子项相关 ======================= + + /** 子实体键名 - JSON中表示子项的列表 */ public final static String GTASK_JSON_CHILD_ENTITY = "child_entity"; - public final static String GTASK_JSON_CLIENT_VERSION = "client_version"; + /** 实体增量键名 - JSON中表示实体变更的字段 */ + public final static String GTASK_JSON_ENTITY_DELTA = "entity_delta"; - public final static String GTASK_JSON_COMPLETED = "completed"; + /** 实体类型键名 - JSON中标识实体类型的字段 */ + public final static String GTASK_JSON_ENTITY_TYPE = "entity_type"; - public final static String GTASK_JSON_CURRENT_LIST_ID = "current_list_id"; + // ======================= 状态和删除相关 ======================= - public final static String GTASK_JSON_DEFAULT_LIST_ID = "default_list_id"; + /** 完成状态键名 - JSON中标识任务是否完成的字段 */ + public final static String GTASK_JSON_COMPLETED = "completed"; + /** 删除状态键名 - JSON中标识项是否被删除的字段 */ public final static String GTASK_JSON_DELETED = "deleted"; - public final static String GTASK_JSON_DEST_LIST = "dest_list"; + /** 获取删除项键名 - JSON中标识是否获取已删除项的字段 */ + public final static String GTASK_JSON_GET_DELETED = "get_deleted"; - public final static String GTASK_JSON_DEST_PARENT = "dest_parent"; + // ======================= ID和索引相关 ======================= - public final static String GTASK_JSON_DEST_PARENT_TYPE = "dest_parent_type"; + /** ID键名 - JSON中最基本的ID字段 */ + public final static String GTASK_JSON_ID = "id"; - public final static String GTASK_JSON_ENTITY_DELTA = "entity_delta"; + /** 新ID键名 - JSON中表示新生成的ID字段（用于创建操作） */ + public final static String GTASK_JSON_NEW_ID = "new_id"; - public final static String GTASK_JSON_ENTITY_TYPE = "entity_type"; + /** 索引键名 - JSON中表示项在列表中的位置索引 */ + public final static String GTASK_JSON_INDEX = "index"; - public final static String GTASK_JSON_GET_DELETED = "get_deleted"; + /** 父项ID键名 - JSON中表示父项的ID */ + public final static String GTASK_JSON_PARENT_ID = "parent_id"; - public final static String GTASK_JSON_ID = "id"; + /** 前一个兄弟项ID键名 - JSON中表示同一层级中前一项的ID（用于确定位置） */ + public final static String GTASK_JSON_PRIOR_SIBLING_ID = "prior_sibling_id"; - public final static String GTASK_JSON_INDEX = "index"; + // ======================= 列表相关 ======================= - public final static String GTASK_JSON_LAST_MODIFIED = "last_modified"; + /** 当前列表ID键名 - JSON中表示当前活动列表的ID */ + public final static String GTASK_JSON_CURRENT_LIST_ID = "current_list_id"; - public final static String GTASK_JSON_LATEST_SYNC_POINT = "latest_sync_point"; + /** 默认列表ID键名 - JSON中表示默认列表的ID */ + public final static String GTASK_JSON_DEFAULT_LIST_ID = "default_list_id"; + /** 列表ID键名 - JSON中表示列表的ID */ public final static String GTASK_JSON_LIST_ID = "list_id"; + /** 列表集合键名 - JSON中包含多个列表的数组 */ public final static String GTASK_JSON_LISTS = "lists"; - public final static String GTASK_JSON_NAME = "name"; + /** 源列表键名 - JSON中表示移动操作的源列表 */ + public final static String GTASK_JSON_SOURCE_LIST = "source_list"; - public final static String GTASK_JSON_NEW_ID = "new_id"; + /** 目标列表键名 - JSON中表示移动操作的目标列表 */ + public final static String GTASK_JSON_DEST_LIST = "dest_list"; - public final static String GTASK_JSON_NOTES = "notes"; + // ======================= 移动操作相关 ======================= - public final static String GTASK_JSON_PARENT_ID = "parent_id"; + /** 目标父项键名 - JSON中表示移动操作的目标父项 */ + public final static String GTASK_JSON_DEST_PARENT = "dest_parent"; - public final static String GTASK_JSON_PRIOR_SIBLING_ID = "prior_sibling_id"; + /** 目标父项类型键名 - JSON中表示移动操作的目标父项类型 */ + public final static String GTASK_JSON_DEST_PARENT_TYPE = "dest_parent_type"; - public final static String GTASK_JSON_RESULTS = "results"; + // ======================= 时间和同步相关 ======================= - public final static String GTASK_JSON_SOURCE_LIST = "source_list"; + /** 最后修改时间键名 - JSON中表示项的最后修改时间戳 */ + public final static String GTASK_JSON_LAST_MODIFIED = "last_modified"; + /** 最新同步点键名 - JSON中表示最新的同步时间点（用于增量同步） */ + public final static String GTASK_JSON_LATEST_SYNC_POINT = "latest_sync_point"; + + // ======================= 名称和内容相关 ======================= + + /** 名称键名 - JSON中表示项的名称/标题字段 */ + public final static String GTASK_JSON_NAME = "name"; + + /** 便签内容键名 - JSON中表示便签具体内容的字段 */ + public final static String GTASK_JSON_NOTES = "notes"; + + // ======================= 结果和任务相关 ======================= + + /** 结果键名 - JSON中表示操作结果集的字段 */ + public final static String GTASK_JSON_RESULTS = "results"; + + /** 任务集合键名 - JSON中包含多个任务的数组 */ public final static String GTASK_JSON_TASKS = "tasks"; + // ======================= 类型相关 ======================= + + /** 类型键名 - JSON中表示项的类型字段 */ public final static String GTASK_JSON_TYPE = "type"; + /** 组类型值 - JSON中表示组/文件夹类型的值 */ public final static String GTASK_JSON_TYPE_GROUP = "GROUP"; + /** 任务类型值 - JSON中表示任务/便签类型的值 */ public final static String GTASK_JSON_TYPE_TASK = "TASK"; + // ======================= 用户相关 ======================= + + /** 用户键名 - JSON中表示用户信息的字段 */ public final static String GTASK_JSON_USER = "user"; + // ======================= MIUI便签专用文件夹前缀 ======================= + + /** MIUI文件夹前缀 - 用于标识MIUI便签创建的Google Tasks文件夹 */ public final static String MIUI_FOLDER_PREFFIX = "[MIUI_Notes]"; + /** 默认文件夹名称 - 在Google Tasks中创建的默认文件夹名称 */ public final static String FOLDER_DEFAULT = "Default"; + /** 通话记录文件夹名称 - 在Google Tasks中创建的通话记录专用文件夹 */ public final static String FOLDER_CALL_NOTE = "Call_Note"; + // ======================= 元数据相关 ======================= + + /** 元数据文件夹标识 - 用于标识存储同步元数据的特殊文件夹 */ public final static String FOLDER_META = "METADATA"; + /** 元数据头-GTaskID - 元数据中存储Google Task 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/notes/tool/ResourceParser.java b/src/notes/tool/ResourceParser.java index 1ad3ad6..13b5cdb 100644 --- a/src/notes/tool/ResourceParser.java +++ b/src/notes/tool/ResourceParser.java @@ -14,168 +14,297 @@ * limitations under the License. */ +// ResourceParser.java - 资源解析工具类 +// 主要功能：管理便签应用的颜色主题、背景资源、字体大小等UI相关资源的映射和获取 package net.micode.notes.tool; -import android.content.Context; -import android.preference.PreferenceManager; +// ======================= 导入区域 ======================= +// Android相关类 +import android.content.Context; // 上下文，用于访问偏好设置 +import android.preference.PreferenceManager; // 偏好设置管理器 -import net.micode.notes.R; -import net.micode.notes.ui.NotesPreferenceActivity; +// 应用内部资源 +import net.micode.notes.R; // 资源文件R类 +import net.micode.notes.ui.NotesPreferenceActivity; // 设置Activity，包含偏好设置键名 +// ======================= 资源解析主类 ======================= +/** + * ResourceParser - 资源解析工具类 + * 集中管理便签应用的UI资源映射关系 + * 包括：背景颜色、字体大小、编辑界面背景、列表项背景、小部件背景等 + */ 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; // 默认为中号字体 + // ======================= 编辑界面背景资源类 ======================= + /** + * NoteBgResources - 便签编辑界面背景资源类 + * 管理便签编辑页面的背景图片资源 + */ public static class NoteBgResources { + // 便签编辑区域背景资源数组 + // 数组索引对应颜色常量：0=黄, 1=蓝, 2=白, 3=绿, 4=红 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 // 红色编辑背景 }; + // 便签标题栏背景资源数组 + // 与编辑区域背景对应，但用于标题栏部分 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 + * @param id 颜色索引（YELLOW/BLUE/WHITE/GREEN/RED） + * @return 对应的drawable资源ID + */ public static int getNoteBgResource(int id) { return BG_EDIT_RESOURCES[id]; } + /** + * 获取便签标题栏背景资源ID + * @param id 颜色索引（YELLOW/BLUE/WHITE/GREEN/RED） + * @return 对应的drawable资源ID + */ public static int getNoteTitleBgResource(int id) { return BG_EDIT_TITLE_RESOURCES[id]; } } + /** + * 获取默认背景颜色ID + * 根据用户设置决定：随机颜色或默认颜色 + * @param context 上下文，用于读取偏好设置 + * @return 背景颜色索引 + */ public static int getDefaultBgId(Context context) { + // 从偏好设置读取是否启用随机背景颜色 if (PreferenceManager.getDefaultSharedPreferences(context).getBoolean( - NotesPreferenceActivity.PREFERENCE_SET_BG_COLOR_KEY, false)) { + NotesPreferenceActivity.PREFERENCE_SET_BG_COLOR_KEY, // 偏好设置键名 + false)) { // 默认值为false（不随机） + // 随机选择一种颜色 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 + 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 + 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, + 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 + 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 // 红色单独项背景 }; + /** + * 获取列表首项背景资源ID + * @param id 颜色索引 + * @return 对应的drawable资源ID + */ public static int getNoteBgFirstRes(int id) { return BG_FIRST_RESOURCES[id]; } + /** + * 获取列表末项背景资源ID + * @param id 颜色索引 + * @return 对应的drawable资源ID + */ public static int getNoteBgLastRes(int id) { return BG_LAST_RESOURCES[id]; } + /** + * 获取列表单独项背景资源ID + * @param id 颜色索引 + * @return 对应的drawable资源ID + */ public static int getNoteBgSingleRes(int id) { return BG_SINGLE_RESOURCES[id]; } + /** + * 获取列表中间项背景资源ID + * @param id 颜色索引 + * @return 对应的drawable资源ID + */ public static int getNoteBgNormalRes(int id) { return BG_NORMAL_RESOURCES[id]; } + /** + * 获取文件夹项背景资源ID + * 文件夹使用统一的背景，不区分颜色 + * @return 文件夹专用背景资源ID + */ public static int getFolderBgRes() { return R.drawable.list_folder; } } + // ======================= 小部件背景资源类 ======================= + /** + * WidgetBgResources - 桌面小部件背景资源类 + * 管理不同尺寸桌面小部件的背景图片资源 + */ public static class WidgetBgResources { + // 2x尺寸小部件背景资源数组 + // 用于2x2尺寸的桌面小部件 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, + R.drawable.widget_2x_yellow, // 黄色2x小部件背景 + R.drawable.widget_2x_blue, // 蓝色2x小部件背景 + R.drawable.widget_2x_white, // 白色2x小部件背景 + R.drawable.widget_2x_green, // 绿色2x小部件背景 + R.drawable.widget_2x_red, // 红色2x小部件背景 }; + /** + * 获取2x尺寸小部件背景资源ID + * @param id 颜色索引 + * @return 对应的drawable资源ID + */ public static int getWidget2xBgResource(int id) { return BG_2X_RESOURCES[id]; } + // 4x尺寸小部件背景资源数组 + // 用于4x4尺寸的桌面小部件 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 + R.drawable.widget_4x_yellow, // 黄色4x小部件背景 + R.drawable.widget_4x_blue, // 蓝色4x小部件背景 + R.drawable.widget_4x_white, // 白色4x小部件背景 + R.drawable.widget_4x_green, // 绿色4x小部件背景 + R.drawable.widget_4x_red // 红色4x小部件背景 }; + /** + * 获取4x尺寸小部件背景资源ID + * @param id 颜色索引 + * @return 对应的drawable资源ID + */ public static int getWidget4xBgResource(int id) { return BG_4X_RESOURCES[id]; } } + // ======================= 文本外观资源类 ======================= + /** + * TextAppearanceResources - 文本外观资源类 + * 管理便签内容的字体大小样式资源 + * 包含对偏好设置中存储异常的处理 + */ public static class TextAppearanceResources { + // 文本外观样式资源数组 + // 索引对应字体大小常量：0=小, 1=中, 2=大, 3=超大 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 // 超大号字体样式 }; + /** + * 获取文本外观样式资源ID + * 包含对偏好设置中存储错误ID的修复处理 + * @param id 字体大小索引 + * @return 对应的style资源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} + * HACKME: 修复在偏好设置中存储资源ID的bug + * 问题：从偏好设置读取的id可能超过资源数组长度 + * 解决：如果id超出范围，返回默认字体大小 */ if (id >= TEXTAPPEARANCE_RESOURCES.length) { - return BG_DEFAULT_FONT_SIZE; + return BG_DEFAULT_FONT_SIZE; // 返回默认字体大小索引 } return TEXTAPPEARANCE_RESOURCES[id]; } + /** + * 获取文本外观资源数组长度 + * 用于验证和边界检查 + * @return 字体大小样式总数 + */ public static int getResourcesSize() { return TEXTAPPEARANCE_RESOURCES.length; } } -} +} \ No newline at end of file diff --git a/src/notes/ui/AlarmAlertActivity.java b/src/notes/ui/AlarmAlertActivity.java index 85723be..5de17e8 100644 --- a/src/notes/ui/AlarmAlertActivity.java +++ b/src/notes/ui/AlarmAlertActivity.java @@ -14,145 +14,257 @@ * limitations under the License. */ +// AlarmAlertActivity.java - 闹钟提醒Activity +// 主要功能：显示便签闹钟提醒，在指定时间弹出提醒对话框并播放提示音 package net.micode.notes.ui; -import android.app.Activity; -import android.app.AlertDialog; -import android.content.Context; -import android.content.DialogInterface; -import android.content.DialogInterface.OnClickListener; -import android.content.DialogInterface.OnDismissListener; -import android.content.Intent; -import android.media.AudioManager; -import android.media.MediaPlayer; -import android.media.RingtoneManager; -import android.net.Uri; -import android.os.Bundle; -import android.os.PowerManager; -import android.provider.Settings; -import android.view.Window; -import android.view.WindowManager; - -import net.micode.notes.R; -import net.micode.notes.data.Notes; -import net.micode.notes.tool.DataUtils; - -import java.io.IOException; +// ======================= 导入区域 ======================= +// Android基础类 +import android.app.Activity; // Activity基类 +import android.app.AlertDialog; // 警告对话框 +import android.content.Context; // 上下文 +import android.content.DialogInterface; // 对话框接口 +import android.content.DialogInterface.OnClickListener; // 对话框点击监听 +import android.content.DialogInterface.OnDismissListener; // 对话框关闭监听 +import android.content.Intent; // Intent，用于跳转 +import android.media.AudioManager; // 音频管理 +import android.media.MediaPlayer; // 媒体播放器 +import android.media.RingtoneManager; // 铃声管理器 +import android.net.Uri; // URI +import android.os.Bundle; // Bundle，用于保存状态 +import android.os.PowerManager; // 电源管理 +import android.provider.Settings; // 系统设置 +import android.view.Window; // 窗口 +import android.view.WindowManager; // 窗口管理器 +// 应用内部资源 +import net.micode.notes.R; // 资源文件R类 +import net.micode.notes.data.Notes; // Notes主类 +import net.micode.notes.tool.DataUtils; // 数据工具类 +// Java IO +import java.io.IOException; // IO异常 + +// ======================= 闹钟提醒Activity ======================= +/** + * AlarmAlertActivity - 闹钟提醒Activity + * 全屏对话框形式显示，即使在锁屏状态下也会弹出 + * 实现功能：显示便签内容、播放提示音、提供操作按钮 + * 实现接口：OnClickListener（对话框按钮点击），OnDismissListener（对话框关闭） + */ public class AlarmAlertActivity extends Activity implements OnClickListener, OnDismissListener { - private long mNoteId; - private String mSnippet; - private static final int SNIPPET_PREW_MAX_LEN = 60; - MediaPlayer mPlayer; + // 成员变量 + private long mNoteId; // 便签ID，从Intent中获取 + private String mSnippet; // 便签摘要，用于对话框显示 + private static final int SNIPPET_PREW_MAX_LEN = 60; // 摘要预览最大长度 + MediaPlayer mPlayer; // 媒体播放器，用于播放提示音 + // ======================= 生命周期方法 ======================= + + /** + * onCreate - Activity创建时的初始化方法 + * 主要任务： + * 1. 设置窗口属性（全屏、锁屏显示） + * 2. 获取便签ID和内容 + * 3. 检查便签是否存在 + * 4. 显示提醒对话框 + * 5. 播放提示音 + * @param savedInstanceState 保存的状态（此处为null，因是新建Activity） + */ @Override protected void onCreate(Bundle savedInstanceState) { super.onCreate(savedInstanceState); + + // 1. 设置窗口属性 + // 请求无标题栏 requestWindowFeature(Window.FEATURE_NO_TITLE); + // 获取窗口对象 final Window win = getWindow(); + // 添加标志：在锁屏状态下显示 win.addFlags(WindowManager.LayoutParams.FLAG_SHOW_WHEN_LOCKED); + // 如果屏幕是关闭状态，添加更多标志 if (!isScreenOn()) { - win.addFlags(WindowManager.LayoutParams.FLAG_KEEP_SCREEN_ON - | WindowManager.LayoutParams.FLAG_TURN_SCREEN_ON - | WindowManager.LayoutParams.FLAG_ALLOW_LOCK_WHILE_SCREEN_ON - | WindowManager.LayoutParams.FLAG_LAYOUT_INSET_DECOR); + win.addFlags(WindowManager.LayoutParams.FLAG_KEEP_SCREEN_ON // 保持屏幕常亮 + | WindowManager.LayoutParams.FLAG_TURN_SCREEN_ON // 点亮屏幕 + | WindowManager.LayoutParams.FLAG_ALLOW_LOCK_WHILE_SCREEN_ON // 允许锁屏 + | WindowManager.LayoutParams.FLAG_LAYOUT_INSET_DECOR); // 布局装饰 } + // 2. 获取Intent数据 Intent intent = getIntent(); try { + // 从Intent的URI中解析便签ID + // URI格式示例：content://micode_notes/note/123 + // getPathSegments()返回["note", "123"]，取索引1得到"123" mNoteId = Long.valueOf(intent.getData().getPathSegments().get(1)); + + // 通过工具类获取便签摘要 mSnippet = DataUtils.getSnippetById(this.getContentResolver(), mNoteId); + + // 3. 处理摘要显示长度 + // 如果摘要过长，截取前60个字符并添加省略号 mSnippet = mSnippet.length() > SNIPPET_PREW_MAX_LEN ? mSnippet.substring(0, SNIPPET_PREW_MAX_LEN) + getResources().getString(R.string.notelist_string_info) : mSnippet; } catch (IllegalArgumentException e) { + // URI解析或ID转换异常 e.printStackTrace(); - return; + return; // 异常时直接返回，不继续执行 } + // 4. 初始化媒体播放器 mPlayer = new MediaPlayer(); + + // 5. 检查便签是否可见（存在且不在回收站） if (DataUtils.visibleInNoteDatabase(getContentResolver(), mNoteId, Notes.TYPE_NOTE)) { + // 便签存在，显示对话框 showActionDialog(); + // 播放提示音 playAlarmSound(); } else { + // 便签不存在（可能已被删除），直接结束Activity finish(); } } + /** + * 检查屏幕是否亮屏 + * @return true: 屏幕已亮; false: 屏幕关闭 + */ private boolean isScreenOn() { + // 获取电源管理器服务 PowerManager pm = (PowerManager) getSystemService(Context.POWER_SERVICE); + // 判断屏幕是否亮屏（已废弃，但兼容旧版本） return pm.isScreenOn(); } + // ======================= 提示音播放 ======================= + + /** + * 播放闹钟提示音 + * 使用系统默认的闹钟铃声 + */ private void playAlarmSound() { + // 1. 获取系统默认闹钟铃声URI Uri url = RingtoneManager.getActualDefaultRingtoneUri(this, RingtoneManager.TYPE_ALARM); + // 2. 获取静音模式设置 + // 检查哪些音频流受静音模式影响 int silentModeStreams = Settings.System.getInt(getContentResolver(), Settings.System.MODE_RINGER_STREAMS_AFFECTED, 0); + // 3. 设置音频流类型 + // 判断闹钟音频流是否受静音模式影响 if ((silentModeStreams & (1 << AudioManager.STREAM_ALARM)) != 0) { + // 受静音影响，使用系统设置的类型 mPlayer.setAudioStreamType(silentModeStreams); } else { + // 不受静音影响，使用闹钟音频流 mPlayer.setAudioStreamType(AudioManager.STREAM_ALARM); } + + // 4. 设置数据源并播放 try { - mPlayer.setDataSource(this, url); - mPlayer.prepare(); - mPlayer.setLooping(true); - mPlayer.start(); + mPlayer.setDataSource(this, url); // 设置铃声URI + mPlayer.prepare(); // 准备播放 + mPlayer.setLooping(true); // 循环播放 + mPlayer.start(); // 开始播放 } catch (IllegalArgumentException e) { - // TODO Auto-generated catch block + // URI格式错误 e.printStackTrace(); } catch (SecurityException e) { - // TODO Auto-generated catch block + // 权限不足 e.printStackTrace(); } catch (IllegalStateException e) { - // TODO Auto-generated catch block + // 播放器状态错误 e.printStackTrace(); } catch (IOException e) { - // TODO Auto-generated catch block + // IO错误，文件读取失败 e.printStackTrace(); } } + // ======================= 提醒对话框 ======================= + + /** + * 显示操作对话框 + * 对话框内容：应用名称 + 便签摘要 + 操作按钮 + */ private void showActionDialog() { + // 1. 创建对话框构建器 AlertDialog.Builder dialog = new AlertDialog.Builder(this); - dialog.setTitle(R.string.app_name); - dialog.setMessage(mSnippet); + + // 2. 设置对话框内容 + dialog.setTitle(R.string.app_name); // 应用名称作为标题 + dialog.setMessage(mSnippet); // 便签摘要作为内容 + + // 3. 设置按钮 + // 确定按钮 - 关闭提醒 dialog.setPositiveButton(R.string.notealert_ok, this); + + // 如果屏幕已亮，显示"进入"按钮（跳转到便签编辑） if (isScreenOn()) { dialog.setNegativeButton(R.string.notealert_enter, this); } + + // 4. 显示对话框并设置关闭监听 dialog.show().setOnDismissListener(this); } + // ======================= 对话框事件处理 ======================= + + /** + * 对话框按钮点击回调 + * 实现OnClickListener接口 + * @param dialog 被点击的对话框 + * @param which 被点击的按钮标识 + * BUTTON_POSITIVE: 确定按钮 + * BUTTON_NEGATIVE: 进入按钮（仅在屏幕亮时显示） + * BUTTON_NEUTRAL: 中立按钮（未使用） + */ public void onClick(DialogInterface dialog, int which) { switch (which) { case DialogInterface.BUTTON_NEGATIVE: + // "进入"按钮：跳转到便签编辑界面 Intent intent = new Intent(this, NoteEditActivity.class); - intent.setAction(Intent.ACTION_VIEW); - intent.putExtra(Intent.EXTRA_UID, mNoteId); + intent.setAction(Intent.ACTION_VIEW); // 查看动作 + intent.putExtra(Intent.EXTRA_UID, mNoteId); // 传递便签ID startActivity(intent); break; default: + // 其他按钮（确定按钮）不执行额外操作 + // 对话框关闭后会触发onDismiss，自动结束Activity break; } } + /** + * 对话框关闭回调 + * 实现OnDismissListener接口 + * 无论点击哪个按钮，对话框关闭时都会执行 + * @param dialog 被关闭的对话框 + */ public void onDismiss(DialogInterface dialog) { + // 停止播放提示音 stopAlarmSound(); + // 结束Activity finish(); } + // ======================= 资源清理 ======================= + + /** + * 停止播放提示音 + * 释放MediaPlayer资源 + */ private void stopAlarmSound() { if (mPlayer != null) { - mPlayer.stop(); - mPlayer.release(); - mPlayer = null; + mPlayer.stop(); // 停止播放 + mPlayer.release(); // 释放资源 + mPlayer = null; // 置空引用，帮助GC } } -} +} \ No newline at end of file diff --git a/src/notes/ui/AlarmInitReceiver.java b/src/notes/ui/AlarmInitReceiver.java index f221202..76d21b0 100644 --- a/src/notes/ui/AlarmInitReceiver.java +++ b/src/notes/ui/AlarmInitReceiver.java @@ -14,52 +14,130 @@ * limitations under the License. */ +// AlarmInitReceiver.java - 闹钟初始化广播接收器 +// 主要功能：在设备启动后重新注册所有未触发的便签闹钟提醒 package net.micode.notes.ui; -import android.app.AlarmManager; -import android.app.PendingIntent; -import android.content.BroadcastReceiver; -import android.content.ContentUris; -import android.content.Context; -import android.content.Intent; -import android.database.Cursor; - -import net.micode.notes.data.Notes; -import net.micode.notes.data.Notes.NoteColumns; +// ======================= 导入区域 ======================= +// Android闹钟相关 +import android.app.AlarmManager; // 闹钟管理器，用于设置系统闹钟 +import android.app.PendingIntent; // 待定意图，用于延迟执行 +// Android广播相关 +import android.content.BroadcastReceiver; // 广播接收器基类 +import android.content.ContentUris; // URI工具，用于构建带ID的URI +import android.content.Context; // 上下文 +import android.content.Intent; // 意图 +// Android数据库相关 +import android.database.Cursor; // 数据库查询结果游标 +// 应用内部数据模型 +import net.micode.notes.data.Notes; // Notes主类 +import net.micode.notes.data.Notes.NoteColumns; // 便签表列定义 +// ======================= 闹钟初始化广播接收器 ======================= +/** + * AlarmInitReceiver - 闹钟初始化广播接收器 + * 继承自BroadcastReceiver，接收系统启动完成广播 + * 主要功能：设备重启后重新注册所有未来的闹钟提醒 + * + * AndroidManifest.xml中注册： + * + * + * + * + * + */ public class AlarmInitReceiver extends BroadcastReceiver { + // ======================= 数据库查询配置 ======================= + + /** + * 查询投影数组 - 指定从数据库查询哪些字段 + * 优化查询性能，只获取需要的字段 + */ private static final String [] PROJECTION = new String [] { - NoteColumns.ID, - NoteColumns.ALERTED_DATE + NoteColumns.ID, // 0 - 便签ID，用于构建PendingIntent + NoteColumns.ALERTED_DATE // 1 - 提醒时间，用于设置闹钟 }; - private static final int COLUMN_ID = 0; - private static final int COLUMN_ALERTED_DATE = 1; + // 字段索引常量 - 提高代码可读性和维护性 + private static final int COLUMN_ID = 0; // ID字段索引 + private static final int COLUMN_ALERTED_DATE = 1; // 提醒时间字段索引 + + // ======================= 广播接收回调方法 ======================= + /** + * onReceive - 广播接收回调方法 + * 当接收到android.intent.action.BOOT_COMPLETED广播时调用 + * 执行流程： + * 1. 查询所有未来需要提醒的便签 + * 2. 为每个便签重新注册系统闹钟 + * 3. 关闭数据库游标 + * + * @param context 广播接收器的上下文 + * @param intent 接收到的广播意图（包含BOOT_COMPLETED动作） + */ @Override public void onReceive(Context context, Intent intent) { + // 1. 获取当前时间戳，用于查询未来提醒 long currentDate = System.currentTimeMillis(); - Cursor c = context.getContentResolver().query(Notes.CONTENT_NOTE_URI, - PROJECTION, + + // 2. 查询数据库，获取所有未来需要提醒的便签 + // 查询条件：提醒时间 > 当前时间 且 类型为普通便签 + Cursor c = context.getContentResolver().query( + Notes.CONTENT_NOTE_URI, // 便签表内容URI + PROJECTION, // 查询字段：ID和提醒时间 NoteColumns.ALERTED_DATE + ">? AND " + NoteColumns.TYPE + "=" + Notes.TYPE_NOTE, - new String[] { String.valueOf(currentDate) }, - null); + new String[] { String.valueOf(currentDate) }, // 查询参数：当前时间 + null); // 排序方式（null表示默认） + // 3. 检查查询结果是否有效 if (c != null) { + // 4. 遍历查询结果，为每个便签设置闹钟 if (c.moveToFirst()) { do { + // 4.1 获取便签的提醒时间 long alertDate = c.getLong(COLUMN_ALERTED_DATE); + + // 4.2 创建AlarmReceiver的Intent + // AlarmReceiver是实际处理闹钟触发的广播接收器 Intent sender = new Intent(context, AlarmReceiver.class); - sender.setData(ContentUris.withAppendedId(Notes.CONTENT_NOTE_URI, c.getLong(COLUMN_ID))); - PendingIntent pendingIntent = PendingIntent.getBroadcast(context, 0, sender, 0); - AlarmManager alermManager = (AlarmManager) context + + // 4.3 设置Intent的数据URI，包含便签ID + // URI格式：content://micode_notes/note/{noteId} + sender.setData(ContentUris.withAppendedId( + Notes.CONTENT_NOTE_URI, + c.getLong(COLUMN_ID) + )); + + // 4.4 创建PendingIntent + // 参数说明： + // - context: 上下文 + // - requestCode: 请求码（0表示默认） + // - intent: 要执行的Intent + // - flags: 标志位（0表示默认） + PendingIntent pendingIntent = PendingIntent.getBroadcast( + context, + 0, + sender, + 0 + ); + + // 4.5 获取系统闹钟管理器 + AlarmManager alarmManager = (AlarmManager) context .getSystemService(Context.ALARM_SERVICE); - alermManager.set(AlarmManager.RTC_WAKEUP, alertDate, pendingIntent); - } while (c.moveToNext()); + + // 4.6 设置系统闹钟 + // 参数说明： + // - AlarmManager.RTC_WAKEUP: 使用实时时钟，触发时唤醒设备 + // - alertDate: 触发时间（毫秒时间戳） + // - pendingIntent: 触发时执行的PendingIntent + alarmManager.set(AlarmManager.RTC_WAKEUP, alertDate, pendingIntent); + + } while (c.moveToNext()); // 继续处理下一个便签 } + // 5. 关闭游标，释放数据库资源 c.close(); } } -} +} \ No newline at end of file diff --git a/src/notes/ui/AlarmReceiver.java b/src/notes/ui/AlarmReceiver.java index 54e503b..944c9af 100644 --- a/src/notes/ui/AlarmReceiver.java +++ b/src/notes/ui/AlarmReceiver.java @@ -14,17 +14,64 @@ * limitations under the License. */ +// AlarmReceiver.java - 闹钟触发广播接收器 +// 主要功能：接收系统闹钟触发广播，启动闹钟提醒Activity package net.micode.notes.ui; -import android.content.BroadcastReceiver; -import android.content.Context; -import android.content.Intent; +// ======================= 导入区域 ======================= +// Android广播相关 +import android.content.BroadcastReceiver; // 广播接收器基类 +import android.content.Context; // 上下文 +import android.content.Intent; // 意图，用于启动Activity +// ======================= 闹钟触发广播接收器 ======================= +/** + * AlarmReceiver - 闹钟触发广播接收器 + * 继承自BroadcastReceiver，接收系统闹钟触发的广播 + * 主要功能：将系统闹钟广播转换为启动AlarmAlertActivity + * + * AndroidManifest.xml中注册： + * + * + * 独立进程运行，确保即使主进程被杀死也能接收闹钟 + */ public class AlarmReceiver extends BroadcastReceiver { + + /** + * onReceive - 广播接收回调方法 + * 当系统闹钟触发时被调用 + * 执行流程： + * 1. 修改Intent的目标类为AlarmAlertActivity + * 2. 添加NEW_TASK标志 + * 3. 启动闹钟提醒Activity + * + * 工作流程： + * 系统闹钟触发 → AlarmReceiver接收 → 启动AlarmAlertActivity → 显示提醒 + * + * @param context 广播接收器的上下文 + * @param intent 接收到的广播意图，包含以下信息： + * - Data URI: content://micode_notes/note/{noteId} (来自AlarmInitReceiver的设置) + * - 可能包含其他闹钟相关数据 + */ @Override public void onReceive(Context context, Intent intent) { + // 1. 修改Intent的目标Activity类 + // 原始Intent来自AlarmInitReceiver设置的PendingIntent + // 这里将目标类改为AlarmAlertActivity intent.setClass(context, AlarmAlertActivity.class); + + // 2. 添加NEW_TASK标志 + // 原因：从广播接收器启动Activity必须在独立任务栈中 + // FLAG_ACTIVITY_NEW_TASK作用： + // - 创建新的任务栈 + // - 允许从非Activity上下文（BroadcastReceiver）启动Activity + // - 避免与现有Activity的任务栈冲突 intent.addFlags(Intent.FLAG_ACTIVITY_NEW_TASK); + + // 3. 启动闹钟提醒Activity + // 启动后，AlarmAlertActivity将显示全屏提醒对话框 context.startActivity(intent); } -} +} \ No newline at end of file diff --git a/src/notes/ui/DateTimePicker.java b/src/notes/ui/DateTimePicker.java index 496b0cd..9418f55 100644 --- a/src/notes/ui/DateTimePicker.java +++ b/src/notes/ui/DateTimePicker.java @@ -14,212 +14,366 @@ * limitations under the License. */ +// DateTimePicker.java - 日期时间选择器自定义控件 +// 主要功能：提供便签闹钟设置所需的日期和时间选择界面 package net.micode.notes.ui; -import java.text.DateFormatSymbols; -import java.util.Calendar; - -import net.micode.notes.R; - - -import android.content.Context; -import android.text.format.DateFormat; -import android.view.View; -import android.widget.FrameLayout; -import android.widget.NumberPicker; - +// ======================= 导入区域 ======================= +// Java日期时间相关 +import java.text.DateFormatSymbols; // 日期格式符号，用于获取AM/PM字符串 +import java.util.Calendar; // 日历类，用于日期时间计算 + +// 应用内部资源 +import net.micode.notes.R; // 资源文件R类 + +// Android相关 +import android.content.Context; // 上下文 +import android.text.format.DateFormat; // 日期格式化工具 +import android.view.View; // 视图基类 +import android.widget.FrameLayout; // 帧布局容器 +import android.widget.NumberPicker; // 数字选择器控件 + +// ======================= 日期时间选择器控件 ======================= +/** + * DateTimePicker - 自定义日期时间选择器 + * 继承自FrameLayout，包含多个NumberPicker控件 + * 功能：日期（近7天）、小时、分钟、AM/PM选择 + * 支持12小时制和24小时制两种显示模式 + */ public class DateTimePicker extends FrameLayout { + // ======================= 常量定义 ======================= + + /** 默认启用状态 - 控件初始化时的默认可用状态 */ private static final boolean DEFAULT_ENABLE_STATE = true; + /** 半天的小时数 - 12小时制使用 */ private static final int HOURS_IN_HALF_DAY = 12; + /** 全天的小时数 - 24小时制使用 */ private static final int HOURS_IN_ALL_DAY = 24; + /** 一周的天数 - 日期选择器显示的天数范围 */ private static final int DAYS_IN_ALL_WEEK = 7; - private static final int DATE_SPINNER_MIN_VAL = 0; - private static final int DATE_SPINNER_MAX_VAL = DAYS_IN_ALL_WEEK - 1; - private static final int HOUR_SPINNER_MIN_VAL_24_HOUR_VIEW = 0; - private static final int HOUR_SPINNER_MAX_VAL_24_HOUR_VIEW = 23; - private static final int HOUR_SPINNER_MIN_VAL_12_HOUR_VIEW = 1; - private static final int HOUR_SPINNER_MAX_VAL_12_HOUR_VIEW = 12; - private static final int MINUT_SPINNER_MIN_VAL = 0; - private static final int MINUT_SPINNER_MAX_VAL = 59; - private static final int AMPM_SPINNER_MIN_VAL = 0; - private static final int AMPM_SPINNER_MAX_VAL = 1; + // 日期选择器范围常量 + private static final int DATE_SPINNER_MIN_VAL = 0; // 日期选择器最小值 + private static final int DATE_SPINNER_MAX_VAL = DAYS_IN_ALL_WEEK - 1; // 日期选择器最大值 + + // 24小时制小时选择器范围常量 + private static final int HOUR_SPINNER_MIN_VAL_24_HOUR_VIEW = 0; // 24小时制最小值 + private static final int HOUR_SPINNER_MAX_VAL_24_HOUR_VIEW = 23; // 24小时制最大值 + + // 12小时制小时选择器范围常量 + private static final int HOUR_SPINNER_MIN_VAL_12_HOUR_VIEW = 1; // 12小时制最小值 + private static final int HOUR_SPINNER_MAX_VAL_12_HOUR_VIEW = 12; // 12小时制最大值 + + // 分钟选择器范围常量 + private static final int MINUT_SPINNER_MIN_VAL = 0; // 分钟最小值 + private static final int MINUT_SPINNER_MAX_VAL = 59; // 分钟最大值 + + // AM/PM选择器范围常量 + private static final int AMPM_SPINNER_MIN_VAL = 0; // AM索引 + private static final int AMPM_SPINNER_MAX_VAL = 1; // PM索引 + + // ======================= 控件成员变量 ======================= + + /** 日期选择器 - 显示近7天的日期 */ private final NumberPicker mDateSpinner; + /** 小时选择器 - 显示小时（12/24小时制） */ private final NumberPicker mHourSpinner; + /** 分钟选择器 - 显示分钟 */ private final NumberPicker mMinuteSpinner; + /** AM/PM选择器 - 显示上午/下午（12小时制时显示） */ private final NumberPicker mAmPmSpinner; + + /** 当前日期时间 - Calendar对象保存当前选择的时间 */ private Calendar mDate; + /** 日期显示值数组 - 存储近7天的格式化字符串 */ private String[] mDateDisplayValues = new String[DAYS_IN_ALL_WEEK]; - private boolean mIsAm; + // ======================= 状态标志 ======================= + /** AM/PM标志 - true: 上午; false: 下午 */ + private boolean mIsAm; + /** 24小时制标志 - true: 24小时制; false: 12小时制 */ private boolean mIs24HourView; - + /** 启用状态标志 - 控件是否可用 */ private boolean mIsEnabled = DEFAULT_ENABLE_STATE; - + /** 初始化标志 - 防止初始化时触发回调 */ private boolean mInitialising; + // ======================= 回调监听器 ======================= + + /** 日期时间变化监听器 - 当选择的时间发生变化时回调 */ private OnDateTimeChangedListener mOnDateTimeChangedListener; - private NumberPicker.OnValueChangeListener mOnDateChangedListener = new NumberPicker.OnValueChangeListener() { - @Override - public void onValueChange(NumberPicker picker, int oldVal, int newVal) { - mDate.add(Calendar.DAY_OF_YEAR, newVal - oldVal); - updateDateControl(); - onDateTimeChanged(); - } - }; - - private NumberPicker.OnValueChangeListener mOnHourChangedListener = new NumberPicker.OnValueChangeListener() { - @Override - public void onValueChange(NumberPicker picker, int oldVal, int newVal) { - boolean isDateChanged = false; - Calendar cal = Calendar.getInstance(); - if (!mIs24HourView) { - if (!mIsAm && oldVal == HOURS_IN_HALF_DAY - 1 && newVal == HOURS_IN_HALF_DAY) { - cal.setTimeInMillis(mDate.getTimeInMillis()); - cal.add(Calendar.DAY_OF_YEAR, 1); - isDateChanged = true; - } else if (mIsAm && oldVal == HOURS_IN_HALF_DAY && newVal == HOURS_IN_HALF_DAY - 1) { - cal.setTimeInMillis(mDate.getTimeInMillis()); - cal.add(Calendar.DAY_OF_YEAR, -1); - isDateChanged = true; + // ======================= 日期选择器值变化监听器 ======================= + + /** + * 日期选择器值变化监听器 + * 当用户滚动日期选择器时触发 + */ + private NumberPicker.OnValueChangeListener mOnDateChangedListener = + new NumberPicker.OnValueChangeListener() { + @Override + public void onValueChange(NumberPicker picker, int oldVal, int newVal) { + // 计算日期变化量（新值-旧值），并更新Calendar + mDate.add(Calendar.DAY_OF_YEAR, newVal - oldVal); + // 更新日期控件显示 + updateDateControl(); + // 触发日期时间变化回调 + onDateTimeChanged(); } - if (oldVal == HOURS_IN_HALF_DAY - 1 && newVal == HOURS_IN_HALF_DAY || - oldVal == HOURS_IN_HALF_DAY && newVal == HOURS_IN_HALF_DAY - 1) { - mIsAm = !mIsAm; - updateAmPmControl(); + }; + + // ======================= 小时选择器值变化监听器 ======================= + + /** + * 小时选择器值变化监听器 + * 处理小时变化时的特殊逻辑（跨天、AM/PM切换） + */ + private NumberPicker.OnValueChangeListener mOnHourChangedListener = + new NumberPicker.OnValueChangeListener() { + @Override + public void onValueChange(NumberPicker picker, int oldVal, int newVal) { + boolean isDateChanged = false; // 日期是否变化标志 + Calendar cal = Calendar.getInstance(); // 临时Calendar用于计算 + + if (!mIs24HourView) { + // ===== 12小时制处理逻辑 ===== + // 情况1：PM 11点 -> PM 12点，需要加1天 + if (!mIsAm && oldVal == HOURS_IN_HALF_DAY - 1 && newVal == HOURS_IN_HALF_DAY) { + cal.setTimeInMillis(mDate.getTimeInMillis()); + cal.add(Calendar.DAY_OF_YEAR, 1); + isDateChanged = true; + } + // 情况2：AM 12点 -> AM 11点，需要减1天 + else if (mIsAm && oldVal == HOURS_IN_HALF_DAY && newVal == HOURS_IN_HALF_DAY - 1) { + cal.setTimeInMillis(mDate.getTimeInMillis()); + cal.add(Calendar.DAY_OF_YEAR, -1); + isDateChanged = true; + } + + // 处理AM/PM切换（12点前后切换时） + if (oldVal == HOURS_IN_HALF_DAY - 1 && newVal == HOURS_IN_HALF_DAY || + oldVal == HOURS_IN_HALF_DAY && newVal == HOURS_IN_HALF_DAY - 1) { + mIsAm = !mIsAm; // 切换AM/PM标志 + updateAmPmControl(); // 更新AM/PM控件 + } + } else { + // ===== 24小时制处理逻辑 ===== + // 情况1：23点 -> 0点，需要加1天 + if (oldVal == HOURS_IN_ALL_DAY - 1 && newVal == 0) { + cal.setTimeInMillis(mDate.getTimeInMillis()); + cal.add(Calendar.DAY_OF_YEAR, 1); + isDateChanged = true; + } + // 情况2：0点 -> 23点，需要减1天 + else if (oldVal == 0 && newVal == HOURS_IN_ALL_DAY - 1) { + cal.setTimeInMillis(mDate.getTimeInMillis()); + cal.add(Calendar.DAY_OF_YEAR, -1); + isDateChanged = true; + } + } + + // 计算实际的小时值（12小时制需要转换） + int newHour = mHourSpinner.getValue() % HOURS_IN_HALF_DAY + (mIsAm ? 0 : HOURS_IN_HALF_DAY); + mDate.set(Calendar.HOUR_OF_DAY, newHour); + + // 触发回调 + onDateTimeChanged(); + + // 如果日期发生变化，更新年月日 + if (isDateChanged) { + setCurrentYear(cal.get(Calendar.YEAR)); + setCurrentMonth(cal.get(Calendar.MONTH)); + setCurrentDay(cal.get(Calendar.DAY_OF_MONTH)); + } } - } else { - if (oldVal == HOURS_IN_ALL_DAY - 1 && newVal == 0) { - cal.setTimeInMillis(mDate.getTimeInMillis()); - cal.add(Calendar.DAY_OF_YEAR, 1); - isDateChanged = true; - } else if (oldVal == 0 && newVal == HOURS_IN_ALL_DAY - 1) { - cal.setTimeInMillis(mDate.getTimeInMillis()); - cal.add(Calendar.DAY_OF_YEAR, -1); - isDateChanged = true; + }; + + // ======================= 分钟选择器值变化监听器 ======================= + + /** + * 分钟选择器值变化监听器 + * 处理分钟滚动时的特殊逻辑（59分到0分，0分到59分） + */ + private NumberPicker.OnValueChangeListener mOnMinuteChangedListener = + new NumberPicker.OnValueChangeListener() { + @Override + public void onValueChange(NumberPicker picker, int oldVal, int newVal) { + int minValue = mMinuteSpinner.getMinValue(); // 分钟最小值（0） + int maxValue = mMinuteSpinner.getMaxValue(); // 分钟最大值（59） + int offset = 0; // 小时偏移量 + + // 情况1：59分 -> 0分，小时加1 + if (oldVal == maxValue && newVal == minValue) { + offset += 1; + } + // 情况2：0分 -> 59分，小时减1 + else if (oldVal == minValue && newVal == maxValue) { + offset -= 1; + } + + // 如果需要调整小时 + if (offset != 0) { + mDate.add(Calendar.HOUR_OF_DAY, offset); // 调整小时 + mHourSpinner.setValue(getCurrentHour()); // 更新小时选择器 + updateDateControl(); // 更新日期控件 + + // 更新AM/PM状态 + int newHour = getCurrentHourOfDay(); + if (newHour >= HOURS_IN_HALF_DAY) { + mIsAm = false; + updateAmPmControl(); + } else { + mIsAm = true; + updateAmPmControl(); + } + } + + // 设置新的分钟值 + mDate.set(Calendar.MINUTE, newVal); + onDateTimeChanged(); // 触发回调 } - } - int newHour = mHourSpinner.getValue() % HOURS_IN_HALF_DAY + (mIsAm ? 0 : HOURS_IN_HALF_DAY); - mDate.set(Calendar.HOUR_OF_DAY, newHour); - onDateTimeChanged(); - if (isDateChanged) { - setCurrentYear(cal.get(Calendar.YEAR)); - setCurrentMonth(cal.get(Calendar.MONTH)); - setCurrentDay(cal.get(Calendar.DAY_OF_MONTH)); - } - } - }; - - private NumberPicker.OnValueChangeListener mOnMinuteChangedListener = new NumberPicker.OnValueChangeListener() { - @Override - public void onValueChange(NumberPicker picker, int oldVal, int newVal) { - int minValue = mMinuteSpinner.getMinValue(); - int maxValue = mMinuteSpinner.getMaxValue(); - int offset = 0; - if (oldVal == maxValue && newVal == minValue) { - offset += 1; - } else if (oldVal == minValue && newVal == maxValue) { - offset -= 1; - } - if (offset != 0) { - mDate.add(Calendar.HOUR_OF_DAY, offset); - mHourSpinner.setValue(getCurrentHour()); - updateDateControl(); - int newHour = getCurrentHourOfDay(); - if (newHour >= HOURS_IN_HALF_DAY) { - mIsAm = false; - updateAmPmControl(); - } else { - mIsAm = true; - updateAmPmControl(); + }; + + // ======================= AM/PM选择器值变化监听器 ======================= + + /** + * AM/PM选择器值变化监听器 + * 处理上午/下午切换时的逻辑 + */ + private NumberPicker.OnValueChangeListener mOnAmPmChangedListener = + new NumberPicker.OnValueChangeListener() { + @Override + public void onValueChange(NumberPicker picker, int oldVal, int newVal) { + mIsAm = !mIsAm; // 切换AM/PM标志 + + // 根据AM/PM调整小时 + if (mIsAm) { + mDate.add(Calendar.HOUR_OF_DAY, -HOURS_IN_HALF_DAY); // PM转AM，减12小时 + } else { + mDate.add(Calendar.HOUR_OF_DAY, HOURS_IN_HALF_DAY); // AM转PM，加12小时 + } + + updateAmPmControl(); // 更新AM/PM控件 + onDateTimeChanged(); // 触发回调 } - } - mDate.set(Calendar.MINUTE, newVal); - onDateTimeChanged(); - } - }; - - private NumberPicker.OnValueChangeListener mOnAmPmChangedListener = new NumberPicker.OnValueChangeListener() { - @Override - public void onValueChange(NumberPicker picker, int oldVal, int newVal) { - mIsAm = !mIsAm; - if (mIsAm) { - mDate.add(Calendar.HOUR_OF_DAY, -HOURS_IN_HALF_DAY); - } else { - mDate.add(Calendar.HOUR_OF_DAY, HOURS_IN_HALF_DAY); - } - updateAmPmControl(); - onDateTimeChanged(); - } - }; + }; + // ======================= 回调接口定义 ======================= + + /** + * OnDateTimeChangedListener - 日期时间变化监听器接口 + * 当用户修改日期时间时回调 + */ public interface OnDateTimeChangedListener { + /** + * 日期时间变化回调方法 + * @param view 触发变化的DateTimePicker控件 + * @param year 年 + * @param month 月（0-11） + * @param dayOfMonth 日（1-31） + * @param hourOfDay 小时（0-23） + * @param minute 分钟（0-59） + */ void onDateTimeChanged(DateTimePicker view, int year, int month, - int dayOfMonth, int hourOfDay, int minute); + int dayOfMonth, int hourOfDay, int minute); } + // ======================= 构造函数 ======================= + + /** + * 构造函数1 - 使用当前时间 + * @param context 上下文 + */ public DateTimePicker(Context context) { - this(context, System.currentTimeMillis()); + this(context, System.currentTimeMillis()); // 调用构造函数2 } + /** + * 构造函数2 - 指定时间戳 + * @param context 上下文 + * @param date 时间戳（毫秒） + */ public DateTimePicker(Context context, long date) { - this(context, date, DateFormat.is24HourFormat(context)); + this(context, date, DateFormat.is24HourFormat(context)); // 调用构造函数3 } + /** + * 构造函数3 - 完整参数 + * @param context 上下文 + * @param date 时间戳（毫秒） + * @param is24HourView 是否24小时制 + */ public DateTimePicker(Context context, long date, boolean is24HourView) { super(context); - mDate = Calendar.getInstance(); - mInitialising = true; - mIsAm = getCurrentHourOfDay() >= HOURS_IN_HALF_DAY; + + // 1. 初始化成员变量 + mDate = Calendar.getInstance(); // 创建Calendar实例 + mInitialising = true; // 标记为初始化中 + mIsAm = getCurrentHourOfDay() >= HOURS_IN_HALF_DAY; // 根据当前时间判断AM/PM + + // 2. 加载布局文件 inflate(context, R.layout.datetime_picker, this); + // 3. 初始化日期选择器 mDateSpinner = (NumberPicker) findViewById(R.id.date); mDateSpinner.setMinValue(DATE_SPINNER_MIN_VAL); mDateSpinner.setMaxValue(DATE_SPINNER_MAX_VAL); mDateSpinner.setOnValueChangedListener(mOnDateChangedListener); + // 4. 初始化小时选择器 mHourSpinner = (NumberPicker) findViewById(R.id.hour); mHourSpinner.setOnValueChangedListener(mOnHourChangedListener); + + // 5. 初始化分钟选择器 mMinuteSpinner = (NumberPicker) findViewById(R.id.minute); mMinuteSpinner.setMinValue(MINUT_SPINNER_MIN_VAL); mMinuteSpinner.setMaxValue(MINUT_SPINNER_MAX_VAL); - mMinuteSpinner.setOnLongPressUpdateInterval(100); + mMinuteSpinner.setOnLongPressUpdateInterval(100); // 长按滚动间隔100ms mMinuteSpinner.setOnValueChangedListener(mOnMinuteChangedListener); - String[] stringsForAmPm = new DateFormatSymbols().getAmPmStrings(); + // 6. 初始化AM/PM选择器 + String[] stringsForAmPm = new DateFormatSymbols().getAmPmStrings(); // 获取AM/PM本地化字符串 mAmPmSpinner = (NumberPicker) findViewById(R.id.amPm); mAmPmSpinner.setMinValue(AMPM_SPINNER_MIN_VAL); mAmPmSpinner.setMaxValue(AMPM_SPINNER_MAX_VAL); - mAmPmSpinner.setDisplayedValues(stringsForAmPm); + mAmPmSpinner.setDisplayedValues(stringsForAmPm); // 设置显示值 mAmPmSpinner.setOnValueChangedListener(mOnAmPmChangedListener); - // update controls to initial state - updateDateControl(); - updateHourControl(); - updateAmPmControl(); + // 7. 更新控件初始状态 + updateDateControl(); // 更新日期显示 + updateHourControl(); // 更新小时范围 + updateAmPmControl(); // 更新AM/PM显示 + // 8. 设置24小时制模式 set24HourView(is24HourView); - // set to current time + // 9. 设置当前时间 setCurrentDate(date); + // 10. 设置启用状态 setEnabled(isEnabled()); - // set the content descriptions + // 11. 初始化完成 mInitialising = false; } + // ======================= 控件状态管理 ======================= + + /** + * 设置控件启用状态 + * @param enabled true: 启用; false: 禁用 + */ @Override public void setEnabled(boolean enabled) { if (mIsEnabled == enabled) { - return; + return; // 状态未变化，直接返回 } super.setEnabled(enabled); + // 设置所有子控件的启用状态 mDateSpinner.setEnabled(enabled); mMinuteSpinner.setEnabled(enabled); mHourSpinner.setEnabled(enabled); @@ -227,43 +381,47 @@ public class DateTimePicker extends FrameLayout { mIsEnabled = enabled; } + /** + * 获取控件启用状态 + * @return true: 启用; false: 禁用 + */ @Override public boolean isEnabled() { return mIsEnabled; } + // ======================= 获取当前日期时间 ======================= + /** - * Get the current date in millis - * - * @return the current date in millis + * 获取当前日期的时间戳 + * @return 时间戳（毫秒） */ public long getCurrentDateInTimeMillis() { return mDate.getTimeInMillis(); } /** - * Set the current date - * - * @param date The current date in millis + * 设置当前日期（时间戳版本） + * @param date 时间戳（毫秒） */ public void setCurrentDate(long date) { Calendar cal = Calendar.getInstance(); cal.setTimeInMillis(date); - setCurrentDate(cal.get(Calendar.YEAR), cal.get(Calendar.MONTH), cal.get(Calendar.DAY_OF_MONTH), - cal.get(Calendar.HOUR_OF_DAY), cal.get(Calendar.MINUTE)); + setCurrentDate(cal.get(Calendar.YEAR), cal.get(Calendar.MONTH), + cal.get(Calendar.DAY_OF_MONTH), cal.get(Calendar.HOUR_OF_DAY), + cal.get(Calendar.MINUTE)); } /** - * Set the current date - * - * @param year The current year - * @param month The current month - * @param dayOfMonth The current dayOfMonth - * @param hourOfDay The current hourOfDay - * @param minute The current minute + * 设置当前日期（详细参数版本） + * @param year 年 + * @param month 月（0-11） + * @param dayOfMonth 日（1-31） + * @param hourOfDay 小时（0-23） + * @param minute 分钟（0-59） */ public void setCurrentDate(int year, int month, - int dayOfMonth, int hourOfDay, int minute) { + int dayOfMonth, int hourOfDay, int minute) { setCurrentYear(year); setCurrentMonth(month); setCurrentDay(dayOfMonth); @@ -271,42 +429,40 @@ public class DateTimePicker extends FrameLayout { setCurrentMinute(minute); } + // ======================= 年、月、日操作方法 ======================= + /** - * Get current year - * - * @return The current year + * 获取当前年 + * @return 年 */ public int getCurrentYear() { return mDate.get(Calendar.YEAR); } /** - * Set current year - * - * @param year The current year + * 设置当前年 + * @param year 年 */ public void setCurrentYear(int year) { if (!mInitialising && year == getCurrentYear()) { - return; + return; // 初始化时或值未变化时不触发回调 } mDate.set(Calendar.YEAR, year); - updateDateControl(); - onDateTimeChanged(); + updateDateControl(); // 更新日期显示 + onDateTimeChanged(); // 触发回调 } /** - * Get current month in the year - * - * @return The current month in the year + * 获取当前月 + * @return 月（0-11） */ public int getCurrentMonth() { return mDate.get(Calendar.MONTH); } /** - * Set current month in the year - * - * @param month The month in the year + * 设置当前月 + * @param month 月（0-11） */ public void setCurrentMonth(int month) { if (!mInitialising && month == getCurrentMonth()) { @@ -318,18 +474,16 @@ public class DateTimePicker extends FrameLayout { } /** - * Get current day of the month - * - * @return The day of the month + * 获取当前日 + * @return 日（1-31） */ public int getCurrentDay() { return mDate.get(Calendar.DAY_OF_MONTH); } /** - * Set current day of the month - * - * @param dayOfMonth The day of the month + * 设置当前日 + * @param dayOfMonth 日（1-31） */ public void setCurrentDay(int dayOfMonth) { if (!mInitialising && dayOfMonth == getCurrentDay()) { @@ -340,124 +494,158 @@ public class DateTimePicker extends FrameLayout { onDateTimeChanged(); } + // ======================= 小时操作方法 ======================= + /** - * Get current hour in 24 hour mode, in the range (0~23) - * @return The current hour in 24 hour mode + * 获取当前小时（24小时制） + * @return 小时（0-23） */ public int getCurrentHourOfDay() { return mDate.get(Calendar.HOUR_OF_DAY); } + /** + * 获取当前小时（根据12/24小时制转换） + * @return 小时（12小时制：1-12；24小时制：0-23） + */ private int getCurrentHour() { if (mIs24HourView){ - return getCurrentHourOfDay(); + return getCurrentHourOfDay(); // 24小时制直接返回 } else { int hour = getCurrentHourOfDay(); if (hour > HOURS_IN_HALF_DAY) { - return hour - HOURS_IN_HALF_DAY; + return hour - HOURS_IN_HALF_DAY; // PM：13-23转换为1-11 } else { - return hour == 0 ? HOURS_IN_HALF_DAY : hour; + return hour == 0 ? HOURS_IN_HALF_DAY : hour; // AM：0点转为12点 } } } /** - * Set current hour in 24 hour mode, in the range (0~23) - * - * @param hourOfDay + * 设置当前小时（24小时制） + * @param hourOfDay 小时（0-23） */ public void setCurrentHour(int hourOfDay) { if (!mInitialising && hourOfDay == getCurrentHourOfDay()) { return; } mDate.set(Calendar.HOUR_OF_DAY, hourOfDay); + + // 12小时制时需要额外处理AM/PM if (!mIs24HourView) { if (hourOfDay >= HOURS_IN_HALF_DAY) { - mIsAm = false; + mIsAm = false; // PM if (hourOfDay > HOURS_IN_HALF_DAY) { - hourOfDay -= HOURS_IN_HALF_DAY; + hourOfDay -= HOURS_IN_HALF_DAY; // 13-23转换为1-11 } } else { - mIsAm = true; + mIsAm = true; // AM if (hourOfDay == 0) { - hourOfDay = HOURS_IN_HALF_DAY; + hourOfDay = HOURS_IN_HALF_DAY; // 0点转为12点 } } - updateAmPmControl(); + updateAmPmControl(); // 更新AM/PM控件 } - mHourSpinner.setValue(hourOfDay); - onDateTimeChanged(); + mHourSpinner.setValue(hourOfDay); // 设置小时选择器值 + onDateTimeChanged(); // 触发回调 } + // ======================= 分钟操作方法 ======================= + /** - * Get currentMinute - * - * @return The Current Minute + * 获取当前分钟 + * @return 分钟（0-59） */ public int getCurrentMinute() { return mDate.get(Calendar.MINUTE); } /** - * Set current minute + * 设置当前分钟 + * @param minute 分钟（0-59） */ public void setCurrentMinute(int minute) { if (!mInitialising && minute == getCurrentMinute()) { return; } - mMinuteSpinner.setValue(minute); + mMinuteSpinner.setValue(minute); // 设置分钟选择器 mDate.set(Calendar.MINUTE, minute); onDateTimeChanged(); } + // ======================= 24小时制管理 ======================= + /** - * @return true if this is in 24 hour view else false. + * 判断是否为24小时制 + * @return true: 24小时制; false: 12小时制 */ public boolean is24HourView () { return mIs24HourView; } /** - * Set whether in 24 hour or AM/PM mode. - * - * @param is24HourView True for 24 hour mode. False for AM/PM mode. + * 设置24小时制模式 + * @param is24HourView true: 24小时制; false: 12小时制 */ public void set24HourView(boolean is24HourView) { if (mIs24HourView == is24HourView) { - return; + return; // 模式未变化 } mIs24HourView = is24HourView; + + // 显示/隐藏AM/PM选择器 mAmPmSpinner.setVisibility(is24HourView ? View.GONE : View.VISIBLE); + + // 获取当前小时并更新控件 int hour = getCurrentHourOfDay(); - updateHourControl(); - setCurrentHour(hour); - updateAmPmControl(); + updateHourControl(); // 更新小时选择器范围 + setCurrentHour(hour); // 重新设置小时 + updateAmPmControl(); // 更新AM/PM状态 } + // ======================= 控件更新方法 ======================= + + /** + * 更新日期控件显示 + * 计算并显示当前日期前后3天的日期 + */ private void updateDateControl() { Calendar cal = Calendar.getInstance(); cal.setTimeInMillis(mDate.getTimeInMillis()); + // 从当前日期向前推4天（-3-1 = -4） cal.add(Calendar.DAY_OF_YEAR, -DAYS_IN_ALL_WEEK / 2 - 1); - mDateSpinner.setDisplayedValues(null); + + mDateSpinner.setDisplayedValues(null); // 清空显示值 + + // 生成7天的日期显示字符串 for (int i = 0; i < DAYS_IN_ALL_WEEK; ++i) { cal.add(Calendar.DAY_OF_YEAR, 1); mDateDisplayValues[i] = (String) DateFormat.format("MM.dd EEEE", cal); } - mDateSpinner.setDisplayedValues(mDateDisplayValues); - mDateSpinner.setValue(DAYS_IN_ALL_WEEK / 2); - mDateSpinner.invalidate(); + + mDateSpinner.setDisplayedValues(mDateDisplayValues); // 设置显示值 + mDateSpinner.setValue(DAYS_IN_ALL_WEEK / 2); // 设置当前为中间位置 + mDateSpinner.invalidate(); // 重绘控件 } + /** + * 更新AM/PM控件 + * 根据24小时制标志显示/隐藏，根据AM/PM标志设置值 + */ private void updateAmPmControl() { if (mIs24HourView) { - mAmPmSpinner.setVisibility(View.GONE); + mAmPmSpinner.setVisibility(View.GONE); // 24小时制隐藏 } else { - int index = mIsAm ? Calendar.AM : Calendar.PM; - mAmPmSpinner.setValue(index); - mAmPmSpinner.setVisibility(View.VISIBLE); + int index = mIsAm ? Calendar.AM : Calendar.PM; // AM=0, PM=1 + mAmPmSpinner.setValue(index); // 设置AM/PM选择器值 + mAmPmSpinner.setVisibility(View.VISIBLE); // 12小时制显示 } } + /** + * 更新小时控件范围 + * 根据12/24小时制设置不同的数值范围 + */ private void updateHourControl() { if (mIs24HourView) { mHourSpinner.setMinValue(HOUR_SPINNER_MIN_VAL_24_HOUR_VIEW); @@ -468,18 +656,25 @@ public class DateTimePicker extends FrameLayout { } } + // ======================= 回调管理 ======================= + /** - * Set the callback that indicates the 'Set' button has been pressed. - * @param callback the callback, if null will do nothing + * 设置日期时间变化监听器 + * @param callback 监听器实例 */ public void setOnDateTimeChangedListener(OnDateTimeChangedListener callback) { mOnDateTimeChangedListener = callback; } + /** + * 触发日期时间变化回调 + * 当日期时间发生变化时调用 + */ private void onDateTimeChanged() { if (mOnDateTimeChangedListener != null) { mOnDateTimeChangedListener.onDateTimeChanged(this, getCurrentYear(), - getCurrentMonth(), getCurrentDay(), getCurrentHourOfDay(), getCurrentMinute()); + getCurrentMonth(), getCurrentDay(), getCurrentHourOfDay(), + getCurrentMinute()); } } -} +} \ No newline at end of file diff --git a/src/notes/ui/DateTimePickerDialog.java b/src/notes/ui/DateTimePickerDialog.java index 2c47ba4..11f7236 100644 --- a/src/notes/ui/DateTimePickerDialog.java +++ b/src/notes/ui/DateTimePickerDialog.java @@ -14,77 +14,189 @@ * limitations under the License. */ +// DateTimePickerDialog.java - 日期时间选择对话框 +// 主要功能：封装DateTimePicker控件，提供完整的日期时间选择对话框界面 package net.micode.notes.ui; -import java.util.Calendar; +// ======================= 导入区域 ======================= +// Java日期时间 +import java.util.Calendar; // 日历类，用于日期时间计算 -import net.micode.notes.R; -import net.micode.notes.ui.DateTimePicker; -import net.micode.notes.ui.DateTimePicker.OnDateTimeChangedListener; +// 应用内部资源 +import net.micode.notes.R; // 资源文件R类 +// 应用内部组件 +import net.micode.notes.ui.DateTimePicker; // 日期时间选择器控件 +import net.micode.notes.ui.DateTimePicker.OnDateTimeChangedListener; // 日期时间变化监听器 -import android.app.AlertDialog; -import android.content.Context; -import android.content.DialogInterface; -import android.content.DialogInterface.OnClickListener; -import android.text.format.DateFormat; -import android.text.format.DateUtils; +// Android对话框相关 +import android.app.AlertDialog; // 警告对话框基类 +import android.content.Context; // 上下文 +import android.content.DialogInterface; // 对话框接口 +import android.content.DialogInterface.OnClickListener; // 对话框点击监听器 +// Android日期时间相关 +import android.text.format.DateFormat; // 日期格式化工具 +import android.text.format.DateUtils; // 日期工具类 +// ======================= 日期时间选择对话框 ======================= +/** + * DateTimePickerDialog - 日期时间选择对话框 + * 继承自AlertDialog，包含DateTimePicker控件 + * 功能：提供日期时间选择界面，包含确定/取消按钮 + * 实现接口：OnClickListener（处理确定按钮点击） + */ public class DateTimePickerDialog extends AlertDialog implements OnClickListener { + // ======================= 成员变量 ======================= + + /** 当前选择的日期时间 - Calendar对象存储用户选择的时间 */ private Calendar mDate = Calendar.getInstance(); + + /** 24小时制标志 - true: 24小时制; false: 12小时制 */ private boolean mIs24HourView; + + /** 日期时间设置回调接口 - 当用户点击确定时回调 */ private OnDateTimeSetListener mOnDateTimeSetListener; + + /** 日期时间选择器控件 - 核心选择组件 */ private DateTimePicker mDateTimePicker; + // ======================= 回调接口定义 ======================= + + /** + * OnDateTimeSetListener - 日期时间设置监听器接口 + * 当用户完成日期时间选择并点击确定按钮时回调 + */ public interface OnDateTimeSetListener { + /** + * 日期时间设置回调方法 + * @param dialog 触发回调的对话框实例 + * @param date 用户选择的日期时间（时间戳，毫秒） + */ void OnDateTimeSet(AlertDialog dialog, long date); } + // ======================= 构造函数 ======================= + + /** + * 构造函数 + * 初始化日期时间选择对话框 + * @param context 上下文 + * @param date 初始日期时间（时间戳，毫秒） + */ public DateTimePickerDialog(Context context, long date) { super(context); + + // 1. 创建日期时间选择器控件 mDateTimePicker = new DateTimePicker(context); + + // 2. 将选择器控件设置为对话框的内容视图 setView(mDateTimePicker); + + // 3. 设置日期时间变化监听器 mDateTimePicker.setOnDateTimeChangedListener(new OnDateTimeChangedListener() { + /** + * 日期时间变化回调 + * 当用户在DateTimePicker上修改日期时间时触发 + * @param view 触发变化的DateTimePicker控件 + * @param year 年 + * @param month 月（0-11） + * @param dayOfMonth 日（1-31） + * @param hourOfDay 小时（0-23） + * @param minute 分钟（0-59） + */ public void onDateTimeChanged(DateTimePicker view, int year, int month, - int dayOfMonth, int hourOfDay, int minute) { + int dayOfMonth, int hourOfDay, int minute) { + // 更新内部Calendar对象 mDate.set(Calendar.YEAR, year); mDate.set(Calendar.MONTH, month); mDate.set(Calendar.DAY_OF_MONTH, dayOfMonth); mDate.set(Calendar.HOUR_OF_DAY, hourOfDay); mDate.set(Calendar.MINUTE, minute); + + // 更新对话框标题显示 updateTitle(mDate.getTimeInMillis()); } }); - mDate.setTimeInMillis(date); - mDate.set(Calendar.SECOND, 0); + + // 4. 设置初始日期时间 + mDate.setTimeInMillis(date); // 设置时间戳 + mDate.set(Calendar.SECOND, 0); // 秒数设为0（只精确到分钟） + + // 5. 更新日期时间选择器控件的当前值 mDateTimePicker.setCurrentDate(mDate.getTimeInMillis()); + + // 6. 设置对话框按钮 + // 确定按钮 - 点击后触发回调 setButton(context.getString(R.string.datetime_dialog_ok), this); + // 取消按钮 - 点击后直接关闭对话框 setButton2(context.getString(R.string.datetime_dialog_cancel), (OnClickListener)null); + + // 7. 设置24小时制模式（根据系统设置） set24HourView(DateFormat.is24HourFormat(this.getContext())); + + // 8. 更新对话框标题显示 updateTitle(mDate.getTimeInMillis()); } + // ======================= 24小时制设置 ======================= + + /** + * 设置24小时制显示模式 + * @param is24HourView true: 24小时制; false: 12小时制 + */ public void set24HourView(boolean is24HourView) { mIs24HourView = is24HourView; } + // ======================= 回调监听器设置 ======================= + + /** + * 设置日期时间设置监听器 + * @param callBack 监听器实例 + */ public void setOnDateTimeSetListener(OnDateTimeSetListener callBack) { mOnDateTimeSetListener = callBack; } + // ======================= 对话框标题更新 ======================= + + /** + * 更新对话框标题 + * 根据当前选择的日期时间格式化显示 + * @param date 日期时间（时间戳，毫秒） + */ private void updateTitle(long date) { + // 设置日期时间显示格式标志 int flag = - DateUtils.FORMAT_SHOW_YEAR | - DateUtils.FORMAT_SHOW_DATE | - DateUtils.FORMAT_SHOW_TIME; + DateUtils.FORMAT_SHOW_YEAR | // 显示年份 + DateUtils.FORMAT_SHOW_DATE | // 显示日期 + DateUtils.FORMAT_SHOW_TIME; // 显示时间 + + // 根据24小时制标志添加相应格式 flag |= mIs24HourView ? DateUtils.FORMAT_24HOUR : DateUtils.FORMAT_24HOUR; + // 注意：这里代码有bug，应该是 FORMAT_24HOUR 或 FORMAT_12HOUR + + // 格式化日期时间并设置为对话框标题 setTitle(DateUtils.formatDateTime(this.getContext(), date, flag)); } + // ======================= 按钮点击处理 ======================= + + /** + * 对话框按钮点击回调 + * 实现OnClickListener接口 + * 当用户点击确定按钮时触发 + * @param arg0 被点击的对话框 + * @param arg1 被点击的按钮标识 + * DialogInterface.BUTTON_POSITIVE: 确定按钮 + * DialogInterface.BUTTON_NEGATIVE: 取消按钮 + * DialogInterface.BUTTON_NEUTRAL: 中立按钮 + */ public void onClick(DialogInterface arg0, int arg1) { + // 只有确定按钮会触发此回调 if (mOnDateTimeSetListener != null) { + // 触发日期时间设置回调 mOnDateTimeSetListener.OnDateTimeSet(this, mDate.getTimeInMillis()); } } - } \ No newline at end of file diff --git a/src/notes/ui/DropdownMenu.java b/src/notes/ui/DropdownMenu.java index 613dc74..bf1a78e 100644 --- a/src/notes/ui/DropdownMenu.java +++ b/src/notes/ui/DropdownMenu.java @@ -14,48 +14,159 @@ * limitations under the License. */ +// DropdownMenu.java - 下拉菜单包装类 +// 主要功能：将Button和PopupMenu组合封装，提供简洁的下拉菜单实现 package net.micode.notes.ui; -import android.content.Context; -import android.view.Menu; -import android.view.MenuItem; -import android.view.View; -import android.view.View.OnClickListener; -import android.widget.Button; -import android.widget.PopupMenu; -import android.widget.PopupMenu.OnMenuItemClickListener; +// ======================= 导入区域 ======================= +// Android上下文 +import android.content.Context; // 上下文 +// Android菜单相关 +import android.view.Menu; // 菜单接口 +import android.view.MenuItem; // 菜单项 +// Android视图相关 +import android.view.View; // 视图基类 +import android.view.View.OnClickListener; // 点击监听器 +// Android控件 +import android.widget.Button; // 按钮控件 +import android.widget.PopupMenu; // 弹出菜单控件 +import android.widget.PopupMenu.OnMenuItemClickListener; // 弹出菜单项点击监听器 -import net.micode.notes.R; +// 应用内部资源 +import net.micode.notes.R; // 资源文件R类 +// ======================= 下拉菜单包装类 ======================= +/** + * DropdownMenu - 下拉菜单包装类 + * 功能：将Button控件与PopupMenu组合，创建下拉菜单效果 + * 使用方式：将Button转换为下拉菜单按钮，点击显示菜单 + * 设计模式：外观模式（Facade），简化PopupMenu的使用 + */ public class DropdownMenu { + + // ======================= 成员变量 ======================= + + /** 按钮控件 - 显示为下拉菜单的触发器按钮 */ private Button mButton; + + /** 弹出菜单 - 实际的PopupMenu控件，包含菜单项 */ private PopupMenu mPopupMenu; + + /** 菜单对象 - 对应PopupMenu中的菜单，用于查找菜单项 */ private Menu mMenu; + // ======================= 构造函数 ======================= + + /** + * 构造函数 + * 初始化下拉菜单，将普通Button转换为下拉菜单按钮 + * + * 工作流程： + * 1. 保存Button引用 + * 2. 设置Button背景为下拉箭头图标 + * 3. 创建PopupMenu并关联到Button + * 4. 获取Menu对象 + * 5. 加载菜单布局 + * 6. 设置Button点击事件显示菜单 + * + * @param context 上下文，用于创建PopupMenu + * @param button 按钮控件，将转换为下拉菜单触发器 + * @param menuId 菜单资源ID，对应res/menu目录下的XML文件 + * + * 示例： + * new DropdownMenu(context, button, R.menu.note_operation_menu); + */ public DropdownMenu(Context context, Button button, int menuId) { + // 1. 保存Button引用 mButton = button; + + // 2. 设置Button背景为下拉箭头图标 + // R.drawable.dropdown_icon: 下拉箭头图标 + // 使Button看起来像下拉菜单按钮 mButton.setBackgroundResource(R.drawable.dropdown_icon); + + // 3. 创建PopupMenu并关联到Button + // 第二个参数是锚点视图，菜单会显示在Button下方 mPopupMenu = new PopupMenu(context, mButton); + + // 4. 获取PopupMenu的Menu对象 mMenu = mPopupMenu.getMenu(); + + // 5. 加载菜单布局文件 + // 从XML资源文件加载菜单项到Menu对象 mPopupMenu.getMenuInflater().inflate(menuId, mMenu); + + // 6. 设置Button点击事件 mButton.setOnClickListener(new OnClickListener() { + /** + * Button点击事件处理 + * 点击Button时显示弹出菜单 + * @param v 被点击的Button视图 + */ public void onClick(View v) { - mPopupMenu.show(); + mPopupMenu.show(); // 显示弹出菜单 } }); } + // ======================= 菜单项点击监听器设置 ======================= + + /** + * 设置下拉菜单项点击监听器 + * 当用户点击菜单项时触发 + * + * @param listener 菜单项点击监听器 + * 实现OnMenuItemClickListener接口 + * + * 使用示例： + * dropdownMenu.setOnDropdownMenuItemClickListener(new OnMenuItemClickListener() { + * @Override + * public boolean onMenuItemClick(MenuItem item) { + * // 处理菜单项点击 + * return true; + * } + * }); + */ public void setOnDropdownMenuItemClickListener(OnMenuItemClickListener listener) { + // 安全检查：确保PopupMenu已创建 if (mPopupMenu != null) { mPopupMenu.setOnMenuItemClickListener(listener); } } + // ======================= 菜单项查找 ======================= + + /** + * 根据ID查找菜单项 + * 用于动态修改菜单项属性（如启用状态、标题、图标等） + * + * @param id 菜单项资源ID + * @return 找到的MenuItem对象，未找到返回null + * + * 使用示例： + * MenuItem item = dropdownMenu.findItem(R.id.menu_delete); + * if (item != null) { + * item.setEnabled(false); // 禁用删除菜单项 + * } + */ public MenuItem findItem(int id) { return mMenu.findItem(id); } + // ======================= 按钮标题设置 ======================= + + /** + * 设置按钮标题文本 + * 用于动态更新下拉按钮显示的文字 + * + * @param title 按钮标题文本 + * + * 使用示例： + * dropdownMenu.setTitle("操作菜单"); + * 或 + * dropdownMenu.setTitle(getString(R.string.menu_title)); + */ public void setTitle(CharSequence title) { mButton.setText(title); } -} +} \ No newline at end of file diff --git a/src/notes/ui/FoldersListAdapter.java b/src/notes/ui/FoldersListAdapter.java index 96b77da..c80f77f 100644 --- a/src/notes/ui/FoldersListAdapter.java +++ b/src/notes/ui/FoldersListAdapter.java @@ -14,67 +14,170 @@ * limitations under the License. */ +// FoldersListAdapter.java - 文件夹列表适配器 +// 主要功能：将数据库中的文件夹数据适配到ListView显示 package net.micode.notes.ui; -import android.content.Context; -import android.database.Cursor; -import android.view.View; -import android.view.ViewGroup; -import android.widget.CursorAdapter; -import android.widget.LinearLayout; -import android.widget.TextView; - -import net.micode.notes.R; -import net.micode.notes.data.Notes; -import net.micode.notes.data.Notes.NoteColumns; +// ======================= 导入区域 ======================= +// Android基础 +import android.content.Context; // 上下文 +// Android数据库 +import android.database.Cursor; // 数据库查询结果游标 +// Android视图 +import android.view.View; // 视图基类 +import android.view.ViewGroup; // 视图容器 +// Android适配器 +import android.widget.CursorAdapter; // 游标适配器基类 +// Android布局 +import android.widget.LinearLayout; // 线性布局 +// Android控件 +import android.widget.TextView; // 文本视图 +// 应用内部资源 +import net.micode.notes.R; // 资源文件R类 +// 应用数据模型 +import net.micode.notes.data.Notes; // Notes主类 +import net.micode.notes.data.Notes.NoteColumns; // 便签表列定义 +// ======================= 文件夹列表适配器 ======================= +/** + * FoldersListAdapter - 文件夹列表适配器 + * 继承自CursorAdapter，用于在ListView中显示文件夹列表 + * 功能：从数据库查询文件夹数据，绑定到列表项视图 + * 使用场景：便签移动对话框、文件夹选择界面 + */ public class FoldersListAdapter extends CursorAdapter { + + // ======================= 数据库查询配置 ======================= + + /** + * 查询投影数组 - 指定从数据库查询哪些字段 + * 优化查询，只获取必要的数据 + */ public static final String [] PROJECTION = { - NoteColumns.ID, - NoteColumns.SNIPPET + NoteColumns.ID, // 0 - 文件夹ID + NoteColumns.SNIPPET // 1 - 文件夹名称（存储在SNIPPET字段中） }; - public static final int ID_COLUMN = 0; - public static final int NAME_COLUMN = 1; + // 字段索引常量 - 提高代码可读性 + public static final int ID_COLUMN = 0; // ID字段索引 + public static final int NAME_COLUMN = 1; // 名称字段索引 + // ======================= 构造函数 ======================= + + /** + * 构造函数 + * 调用父类CursorAdapter的构造函数 + * @param context 上下文 + * @param c 数据库游标，包含文件夹数据 + */ public FoldersListAdapter(Context context, Cursor c) { super(context, c); - // TODO Auto-generated constructor stub + // TODO: 可在此处添加额外初始化代码 } + // ======================= 适配器核心方法 ======================= + + /** + * 创建新视图 + * 当ListView需要新的列表项视图时调用 + * @param context 上下文 + * @param cursor 当前位置的数据库游标 + * @param parent 父视图容器（ListView） + * @return 新创建的列表项视图 + */ @Override public View newView(Context context, Cursor cursor, ViewGroup parent) { + // 创建并返回FolderListItem对象 return new FolderListItem(context); } + /** + * 绑定数据到视图 + * 将指定位置的数据库数据绑定到列表项视图 + * @param view 要绑定数据的视图 + * @param context 上下文 + * @param cursor 当前位置的数据库游标 + */ @Override public void bindView(View view, Context context, Cursor cursor) { + // 安全检查：确保视图是FolderListItem类型 if (view instanceof FolderListItem) { - String folderName = (cursor.getLong(ID_COLUMN) == Notes.ID_ROOT_FOLDER) ? context - .getString(R.string.menu_move_parent_folder) : cursor.getString(NAME_COLUMN); + // 获取文件夹名称 + String folderName = null; + + // 特殊处理：如果是根文件夹（ID_ROOT_FOLDER），使用预设名称 + if (cursor.getLong(ID_COLUMN) == Notes.ID_ROOT_FOLDER) { + // 根文件夹显示为"主文件夹" + folderName = context.getString(R.string.menu_move_parent_folder); + } else { + // 普通文件夹使用数据库中的名称 + folderName = cursor.getString(NAME_COLUMN); + } + + // 调用FolderListItem的bind方法设置名称 ((FolderListItem) view).bind(folderName); } } + // ======================= 辅助方法 ======================= + + /** + * 根据位置获取文件夹名称 + * 不依赖视图，直接从适配器数据中获取 + * 用于需要获取名称但不显示视图的场景 + * + * @param context 上下文，用于获取根文件夹的本地化名称 + * @param position 列表中的位置 + * @return 文件夹名称 + */ public String getFolderName(Context context, int position) { + // 获取指定位置的Cursor对象 Cursor cursor = (Cursor) getItem(position); - return (cursor.getLong(ID_COLUMN) == Notes.ID_ROOT_FOLDER) ? context - .getString(R.string.menu_move_parent_folder) : cursor.getString(NAME_COLUMN); + + // 与bindView中相同的逻辑处理文件夹名称 + if (cursor.getLong(ID_COLUMN) == Notes.ID_ROOT_FOLDER) { + return context.getString(R.string.menu_move_parent_folder); + } else { + return cursor.getString(NAME_COLUMN); + } } + // ======================= 内部类：文件夹列表项视图 ======================= + + /** + * FolderListItem - 文件夹列表项内部类 + * 继承自LinearLayout，表示单个文件夹项的视图 + * 职责：管理列表项布局和控件 + */ private class FolderListItem extends LinearLayout { + + /** 文件夹名称文本视图 */ private TextView mName; + /** + * 构造函数 + * 初始化列表项视图 + * @param context 上下文 + */ public FolderListItem(Context context) { super(context); + // 1. 加载布局文件 + // R.layout.folder_list_item: 列表项布局 + // 第三个参数true: 将布局添加到当前视图 inflate(context, R.layout.folder_list_item, this); + + // 2. 查找并保存TextView引用 mName = (TextView) findViewById(R.id.tv_folder_name); } + /** + * 绑定数据 + * 设置文件夹名称到TextView + * @param name 文件夹名称 + */ public void bind(String name) { mName.setText(name); } } - -} +} \ No newline at end of file diff --git a/src/notes/ui/NoteEditActivity.java b/src/notes/ui/NoteEditActivity.java index 6d15bf6..0f28da1 100644 --- a/src/notes/ui/NoteEditActivity.java +++ b/src/notes/ui/NoteEditActivity.java @@ -14,76 +14,112 @@ * limitations under the License. */ +// NoteEditActivity.java - 便签编辑Activity +// 主要功能：提供便签的创建、编辑、查看、设置等完整功能 package net.micode.notes.ui; -import android.app.Activity; -import android.app.AlarmManager; -import android.app.AlertDialog; -import android.app.PendingIntent; -import android.app.SearchManager; -import android.appwidget.AppWidgetManager; -import android.content.ContentUris; -import android.content.Context; -import android.content.DialogInterface; -import android.content.Intent; -import android.content.SharedPreferences; -import android.graphics.Paint; -import android.os.Bundle; -import android.preference.PreferenceManager; -import android.text.Spannable; -import android.text.SpannableString; -import android.text.TextUtils; -import android.text.format.DateUtils; -import android.text.style.BackgroundColorSpan; -import android.util.Log; -import android.view.LayoutInflater; -import android.view.Menu; -import android.view.MenuItem; -import android.view.MotionEvent; -import android.view.View; -import android.view.View.OnClickListener; -import android.view.WindowManager; -import android.widget.CheckBox; -import android.widget.CompoundButton; -import android.widget.CompoundButton.OnCheckedChangeListener; -import android.widget.EditText; -import android.widget.ImageView; -import android.widget.LinearLayout; -import android.widget.TextView; -import android.widget.Toast; - -import net.micode.notes.R; -import net.micode.notes.data.Notes; -import net.micode.notes.data.Notes.TextNote; -import net.micode.notes.model.WorkingNote; -import net.micode.notes.model.WorkingNote.NoteSettingChangedListener; -import net.micode.notes.tool.DataUtils; -import net.micode.notes.tool.ResourceParser; -import net.micode.notes.tool.ResourceParser.TextAppearanceResources; -import net.micode.notes.ui.DateTimePickerDialog.OnDateTimeSetListener; -import net.micode.notes.ui.NoteEditText.OnTextViewChangeListener; -import net.micode.notes.widget.NoteWidgetProvider_2x; -import net.micode.notes.widget.NoteWidgetProvider_4x; - -import java.util.HashMap; -import java.util.HashSet; -import java.util.Map; -import java.util.regex.Matcher; -import java.util.regex.Pattern; - - +// ======================= 导入区域 ======================= +// Android基础 +import android.app.Activity; // Activity基类 +import android.app.AlarmManager; // 闹钟管理器 +import android.app.AlertDialog; // 警告对话框 +import android.app.PendingIntent; // 待定意图 +import android.app.SearchManager; // 搜索管理器 +import android.appwidget.AppWidgetManager; // 应用小部件管理器 +import android.content.ContentUris; // URI工具 +import android.content.Context; // 上下文 +import android.content.DialogInterface; // 对话框接口 +import android.content.Intent; // 意图 +import android.content.SharedPreferences; // 偏好设置 +import android.graphics.Paint; // 画笔，用于文本样式 +import android.os.Bundle; // 状态保存 +import android.preference.PreferenceManager; // 偏好设置管理器 +// Android文本处理 +import android.text.Spannable; // 可设置样式的文本 +import android.text.SpannableString; // 可设置样式的字符串 +import android.text.TextUtils; // 文本工具 +import android.text.format.DateUtils; // 日期工具 +import android.text.style.BackgroundColorSpan; // 背景色样式 +import android.util.Log; // 日志工具 +// Android视图 +import android.view.LayoutInflater; // 布局加载器 +import android.view.Menu; // 菜单 +import android.view.MenuItem; // 菜单项 +import android.view.MotionEvent; // 触摸事件 +import android.view.View; // 视图基类 +import android.view.View.OnClickListener; // 点击监听器 +import android.view.WindowManager; // 窗口管理器 +// Android控件 +import android.widget.CheckBox; // 复选框 +import android.widget.CompoundButton; // 复合按钮 +import android.widget.CompoundButton.OnCheckedChangeListener; // 复选框状态变化监听 +import android.widget.EditText; // 编辑框 +import android.widget.ImageView; // 图片视图 +import android.widget.LinearLayout; // 线性布局 +import android.widget.TextView; // 文本视图 +import android.widget.Toast; // 提示信息 + +// 应用内部资源 +import net.micode.notes.R; // 资源文件R类 +// 应用数据模型 +import net.micode.notes.data.Notes; // Notes主类 +import net.micode.notes.data.Notes.TextNote; // 文本便签常量 +// 应用业务模型 +import net.micode.notes.model.WorkingNote; // 工作便签模型 +import net.micode.notes.model.WorkingNote.NoteSettingChangedListener; // 便签设置变化监听 +// 应用工具 +import net.micode.notes.tool.DataUtils; // 数据工具 +import net.micode.notes.tool.ResourceParser; // 资源解析器 +import net.micode.notes.tool.ResourceParser.TextAppearanceResources; // 文本外观资源 +// 应用对话框 +import net.micode.notes.ui.DateTimePickerDialog.OnDateTimeSetListener; // 日期时间设置监听 +// 应用自定义控件 +import net.micode.notes.ui.NoteEditText.OnTextViewChangeListener; // 文本变化监听 +// 应用小部件 +import net.micode.notes.widget.NoteWidgetProvider_2x; // 2x小部件 +import net.micode.notes.widget.NoteWidgetProvider_4x; // 4x小部件 + +// Java集合 +import java.util.HashMap; // 哈希映射 +import java.util.HashSet; // 哈希集合 +import java.util.Map; // 映射接口 +// Java正则表达式 +import java.util.regex.Matcher; // 正则匹配器 +import java.util.regex.Pattern; // 正则模式 + +// ======================= 便签编辑Activity ======================= +/** + * NoteEditActivity - 便签编辑Activity + * 继承自Activity，实现多个监听器接口 + * 功能：便签的完整编辑功能，包括文本编辑、样式设置、提醒设置、分享等 + * 实现接口： + * OnClickListener: 处理视图点击 + * NoteSettingChangedListener: 监听便签设置变化 + * OnTextViewChangeListener: 监听文本编辑变化 + */ public class NoteEditActivity extends Activity implements OnClickListener, NoteSettingChangedListener, OnTextViewChangeListener { - private class HeadViewHolder { - public TextView tvModified; - - public ImageView ivAlertIcon; - public TextView tvAlertDate; + // ======================= 头部视图持有者内部类 ======================= - public ImageView ibSetBgColor; + /** + * HeadViewHolder - 头部视图持有者 + * 视图持有者模式，缓存头部控件引用 + */ + private class HeadViewHolder { + public TextView tvModified; // 修改时间文本 + public ImageView ivAlertIcon; // 提醒图标 + public TextView tvAlertDate; // 提醒日期文本 + public ImageView ibSetBgColor; // 设置背景颜色按钮 } + // ======================= 背景颜色选择器映射 ======================= + + /** + * 背景颜色选择器按钮映射 + * 键：按钮ID，值：颜色常量索引 + * 用于将按钮点击映射到颜色选择 + */ private static final Map sBgSelectorBtnsMap = new HashMap(); static { sBgSelectorBtnsMap.put(R.id.iv_bg_yellow, ResourceParser.YELLOW); @@ -93,6 +129,11 @@ public class NoteEditActivity extends Activity implements OnClickListener, sBgSelectorBtnsMap.put(R.id.iv_bg_white, ResourceParser.WHITE); } + /** + * 背景颜色选择器选中状态映射 + * 键：颜色常量索引，值：选中状态视图ID + * 用于显示当前选中的颜色 + */ private static final Map sBgSelectorSelectionMap = new HashMap(); static { sBgSelectorSelectionMap.put(ResourceParser.YELLOW, R.id.iv_bg_yellow_select); @@ -102,6 +143,12 @@ public class NoteEditActivity extends Activity implements OnClickListener, sBgSelectorSelectionMap.put(ResourceParser.WHITE, R.id.iv_bg_white_select); } + // ======================= 字体大小选择器映射 ======================= + + /** + * 字体大小选择器按钮映射 + * 键：布局容器ID，值：字体大小常量索引 + */ private static final Map sFontSizeBtnsMap = new HashMap(); static { sFontSizeBtnsMap.put(R.id.ll_font_large, ResourceParser.TEXT_LARGE); @@ -110,6 +157,10 @@ public class NoteEditActivity extends Activity implements OnClickListener, sFontSizeBtnsMap.put(R.id.ll_font_super, ResourceParser.TEXT_SUPER); } + /** + * 字体大小选择器选中状态映射 + * 键：字体大小常量索引，值：选中状态视图ID + */ private static final Map sFontSelectorSelectionMap = new HashMap(); static { sFontSelectorSelectionMap.put(ResourceParser.TEXT_LARGE, R.id.iv_large_select); @@ -118,59 +169,74 @@ public class NoteEditActivity extends Activity implements OnClickListener, sFontSelectorSelectionMap.put(ResourceParser.TEXT_SUPER, R.id.iv_super_select); } - private static final String TAG = "NoteEditActivity"; - - private HeadViewHolder mNoteHeaderHolder; - - private View mHeadViewPanel; - - private View mNoteBgColorSelector; - - private View mFontSizeSelector; + // ======================= 常量定义 ======================= - private EditText mNoteEditor; + private static final String TAG = "NoteEditActivity"; // 日志标签 - private View mNoteEditorPanel; + // 视图成员变量 + private HeadViewHolder mNoteHeaderHolder; // 头部视图持有者 + private View mHeadViewPanel; // 头部面板 + private View mNoteBgColorSelector; // 背景颜色选择器 + private View mFontSizeSelector; // 字体大小选择器 + private EditText mNoteEditor; // 便签编辑器 + private View mNoteEditorPanel; // 编辑器面板 + private LinearLayout mEditTextList; // 列表模式编辑容器 - private WorkingNote mWorkingNote; + // 业务模型 + private WorkingNote mWorkingNote; // 工作便签模型 - private SharedPreferences mSharedPrefs; - private int mFontSizeId; + // 偏好设置 + private SharedPreferences mSharedPrefs; // 偏好设置 + private int mFontSizeId; // 当前字体大小ID + private static final String PREFERENCE_FONT_SIZE = "pref_font_size"; // 字体大小偏好键 - private static final String PREFERENCE_FONT_SIZE = "pref_font_size"; + // 快捷方式相关 + private static final int SHORTCUT_ICON_TITLE_MAX_LEN = 10; // 快捷方式标题最大长度 - private static final int SHORTCUT_ICON_TITLE_MAX_LEN = 10; + // 清单模式常量 + public static final String TAG_CHECKED = String.valueOf('\u221A'); // 已勾选符号 √ + public static final String TAG_UNCHECKED = String.valueOf('\u25A1'); // 未勾选符号 □ - public static final String TAG_CHECKED = String.valueOf('\u221A'); - public static final String TAG_UNCHECKED = String.valueOf('\u25A1'); + // 搜索高亮相关 + private String mUserQuery; // 用户搜索关键词 + private Pattern mPattern; // 正则模式，用于高亮搜索 - private LinearLayout mEditTextList; - - private String mUserQuery; - private Pattern mPattern; + // ======================= 生命周期方法 ======================= + /** + * onCreate - Activity创建 + * 初始化Activity状态和资源 + * @param savedInstanceState 保存的状态 + */ @Override protected void onCreate(Bundle savedInstanceState) { super.onCreate(savedInstanceState); + // 设置布局 this.setContentView(R.layout.note_edit); + // 初始化Activity状态 if (savedInstanceState == null && !initActivityState(getIntent())) { + // 初始化失败，结束Activity finish(); return; } + // 初始化资源 initResources(); } /** - * Current activity may be killed when the memory is low. Once it is killed, for another time - * user load this activity, we should restore the former state + * 恢复实例状态 + * 当Activity被系统杀死后恢复时调用 + * @param savedInstanceState 保存的状态 */ @Override protected void onRestoreInstanceState(Bundle savedInstanceState) { super.onRestoreInstanceState(savedInstanceState); + // 从保存的状态中恢复便签ID if (savedInstanceState != null && savedInstanceState.containsKey(Intent.EXTRA_UID)) { Intent intent = new Intent(Intent.ACTION_VIEW); intent.putExtra(Intent.EXTRA_UID, savedInstanceState.getLong(Intent.EXTRA_UID)); + // 重新初始化Activity状态 if (!initActivityState(intent)) { finish(); return; @@ -179,31 +245,36 @@ public class NoteEditActivity extends Activity implements OnClickListener, } } + /** + * 初始化Activity状态 + * 根据Intent判断是查看、编辑还是创建便签 + * @param intent 启动Activity的Intent + * @return true: 初始化成功; false: 初始化失败 + */ private boolean initActivityState(Intent intent) { - /** - * If the user specified the {@link Intent#ACTION_VIEW} but not provided with id, - * then jump to the NotesListActivity - */ - mWorkingNote = null; + mWorkingNote = null; // 重置工作便签 + + // 处理查看便签的ACTION_VIEW if (TextUtils.equals(Intent.ACTION_VIEW, intent.getAction())) { long noteId = intent.getLongExtra(Intent.EXTRA_UID, 0); - mUserQuery = ""; + mUserQuery = ""; // 初始化搜索关键词 - /** - * Starting from the searched result - */ + // 处理来自搜索的结果 if (intent.hasExtra(SearchManager.EXTRA_DATA_KEY)) { noteId = Long.parseLong(intent.getStringExtra(SearchManager.EXTRA_DATA_KEY)); mUserQuery = intent.getStringExtra(SearchManager.USER_QUERY); } + // 检查便签是否存在 if (!DataUtils.visibleInNoteDatabase(getContentResolver(), noteId, Notes.TYPE_NOTE)) { + // 便签不存在，跳转到列表 Intent jump = new Intent(this, NotesListActivity.class); startActivity(jump); showToast(R.string.error_note_not_exist); finish(); return false; } else { + // 加载便签 mWorkingNote = WorkingNote.load(this, noteId); if (mWorkingNote == null) { Log.e(TAG, "load note failed with note id" + noteId); @@ -211,11 +282,14 @@ public class NoteEditActivity extends Activity implements OnClickListener, return false; } } + // 查看模式：隐藏软键盘 getWindow().setSoftInputMode( WindowManager.LayoutParams.SOFT_INPUT_STATE_HIDDEN | WindowManager.LayoutParams.SOFT_INPUT_ADJUST_RESIZE); - } else if(TextUtils.equals(Intent.ACTION_INSERT_OR_EDIT, intent.getAction())) { - // New note + } + // 处理创建/编辑便签的ACTION_INSERT_OR_EDIT + else if(TextUtils.equals(Intent.ACTION_INSERT_OR_EDIT, intent.getAction())) { + // 从Intent获取参数 long folderId = intent.getLongExtra(Notes.INTENT_EXTRA_FOLDER_ID, 0); int widgetId = intent.getIntExtra(Notes.INTENT_EXTRA_WIDGET_ID, AppWidgetManager.INVALID_APPWIDGET_ID); @@ -224,7 +298,7 @@ public class NoteEditActivity extends Activity implements OnClickListener, int bgResId = intent.getIntExtra(Notes.INTENT_EXTRA_BACKGROUND_ID, ResourceParser.getDefaultBgId(this)); - // Parse call-record note + // 解析通话记录便签 String phoneNumber = intent.getStringExtra(Intent.EXTRA_PHONE_NUMBER); long callDate = intent.getLongExtra(Notes.INTENT_EXTRA_CALL_DATE, 0); if (callDate != 0 && phoneNumber != null) { @@ -232,6 +306,7 @@ public class NoteEditActivity extends Activity implements OnClickListener, Log.w(TAG, "The call record number is null"); } long noteId = 0; + // 尝试根据电话号码和时间查找已存在的通话记录 if ((noteId = DataUtils.getNoteIdByPhoneNumberAndCallDate(getContentResolver(), phoneNumber, callDate)) > 0) { mWorkingNote = WorkingNote.load(this, noteId); @@ -241,91 +316,121 @@ public class NoteEditActivity extends Activity implements OnClickListener, return false; } } else { + // 创建新的通话记录便签 mWorkingNote = WorkingNote.createEmptyNote(this, folderId, widgetId, widgetType, bgResId); mWorkingNote.convertToCallNote(phoneNumber, callDate); } } else { + // 创建普通便签 mWorkingNote = WorkingNote.createEmptyNote(this, folderId, widgetId, widgetType, bgResId); } - + // 编辑模式：显示软键盘 getWindow().setSoftInputMode( WindowManager.LayoutParams.SOFT_INPUT_ADJUST_RESIZE | WindowManager.LayoutParams.SOFT_INPUT_STATE_VISIBLE); } else { + // 不支持的Action Log.e(TAG, "Intent not specified action, should not support"); finish(); return false; } + // 设置便签变化监听器 mWorkingNote.setOnSettingStatusChangedListener(this); return true; } + /** + * onResume - Activity恢复可见 + * 初始化便签屏幕显示 + */ @Override protected void onResume() { super.onResume(); initNoteScreen(); } + /** + * 初始化便签屏幕 + * 更新所有UI控件显示当前便签状态 + */ private void initNoteScreen() { + // 设置字体大小 mNoteEditor.setTextAppearance(this, TextAppearanceResources .getTexAppearanceResource(mFontSizeId)); + + // 根据模式显示内容 if (mWorkingNote.getCheckListMode() == TextNote.MODE_CHECK_LIST) { + // 清单模式 switchToListMode(mWorkingNote.getContent()); } else { + // 普通模式，高亮搜索关键词 mNoteEditor.setText(getHighlightQueryResult(mWorkingNote.getContent(), mUserQuery)); mNoteEditor.setSelection(mNoteEditor.getText().length()); } + + // 隐藏所有背景选择器的选中标记 for (Integer id : sBgSelectorSelectionMap.keySet()) { findViewById(sBgSelectorSelectionMap.get(id)).setVisibility(View.GONE); } + + // 设置背景 mHeadViewPanel.setBackgroundResource(mWorkingNote.getTitleBgResId()); mNoteEditorPanel.setBackgroundResource(mWorkingNote.getBgColorResId()); + // 设置修改时间 mNoteHeaderHolder.tvModified.setText(DateUtils.formatDateTime(this, mWorkingNote.getModifiedDate(), DateUtils.FORMAT_SHOW_DATE | DateUtils.FORMAT_NUMERIC_DATE | DateUtils.FORMAT_SHOW_TIME | DateUtils.FORMAT_SHOW_YEAR)); - /** - * TODO: Add the menu for setting alert. Currently disable it because the DateTimePicker - * is not ready - */ + // 显示提醒信息 showAlertHeader(); } + /** + * 显示提醒头部 + * 根据便签是否有提醒设置显示相应控件 + */ private void showAlertHeader() { if (mWorkingNote.hasClockAlert()) { long time = System.currentTimeMillis(); if (time > mWorkingNote.getAlertDate()) { + // 提醒已过期 mNoteHeaderHolder.tvAlertDate.setText(R.string.note_alert_expired); } else { + // 显示相对时间 mNoteHeaderHolder.tvAlertDate.setText(DateUtils.getRelativeTimeSpanString( mWorkingNote.getAlertDate(), time, DateUtils.MINUTE_IN_MILLIS)); } mNoteHeaderHolder.tvAlertDate.setVisibility(View.VISIBLE); mNoteHeaderHolder.ivAlertIcon.setVisibility(View.VISIBLE); } else { + // 无提醒，隐藏控件 mNoteHeaderHolder.tvAlertDate.setVisibility(View.GONE); mNoteHeaderHolder.ivAlertIcon.setVisibility(View.GONE); }; } + /** + * onNewIntent - 处理新的Intent + * 当Activity已存在时被再次启动 + */ @Override protected void onNewIntent(Intent intent) { super.onNewIntent(intent); initActivityState(intent); } + /** + * 保存实例状态 + * 保存便签ID，以便恢复 + */ @Override protected void onSaveInstanceState(Bundle outState) { super.onSaveInstanceState(outState); - /** - * For new note without note id, we should firstly save it to - * generate a id. If the editing note is not worth saving, there - * is no id which is equivalent to create new note - */ + // 如果便签不在数据库中，先保存 if (!mWorkingNote.existInDatabase()) { saveNote(); } @@ -333,14 +438,22 @@ public class NoteEditActivity extends Activity implements OnClickListener, Log.d(TAG, "Save working note id: " + mWorkingNote.getNoteId() + " onSaveInstanceState"); } + // ======================= 触摸事件处理 ======================= + + /** + * 分发触摸事件 + * 处理点击选择器外部时关闭选择器 + */ @Override public boolean dispatchTouchEvent(MotionEvent ev) { + // 点击背景选择器外部时关闭 if (mNoteBgColorSelector.getVisibility() == View.VISIBLE && !inRangeOfView(mNoteBgColorSelector, ev)) { mNoteBgColorSelector.setVisibility(View.GONE); return true; } + // 点击字体选择器外部时关闭 if (mFontSizeSelector.getVisibility() == View.VISIBLE && !inRangeOfView(mFontSizeSelector, ev)) { mFontSizeSelector.setVisibility(View.GONE); @@ -349,6 +462,9 @@ public class NoteEditActivity extends Activity implements OnClickListener, return super.dispatchTouchEvent(ev); } + /** + * 判断触摸点是否在视图范围内 + */ private boolean inRangeOfView(View view, MotionEvent ev) { int []location = new int[2]; view.getLocationOnScreen(location); @@ -358,12 +474,19 @@ public class NoteEditActivity extends Activity implements OnClickListener, || ev.getX() > (x + view.getWidth()) || ev.getY() < y || ev.getY() > (y + view.getHeight())) { - return false; - } + return false; + } return true; } + // ======================= 资源初始化 ======================= + + /** + * 初始化资源 + * 查找所有视图引用并设置监听器 + */ private void initResources() { + // 头部视图 mHeadViewPanel = findViewById(R.id.note_title); mNoteHeaderHolder = new HeadViewHolder(); mNoteHeaderHolder.tvModified = (TextView) findViewById(R.id.tv_modified_date); @@ -371,32 +494,44 @@ public class NoteEditActivity extends Activity implements OnClickListener, mNoteHeaderHolder.tvAlertDate = (TextView) findViewById(R.id.tv_alert_date); mNoteHeaderHolder.ibSetBgColor = (ImageView) findViewById(R.id.btn_set_bg_color); mNoteHeaderHolder.ibSetBgColor.setOnClickListener(this); + + // 编辑视图 mNoteEditor = (EditText) findViewById(R.id.note_edit_view); mNoteEditorPanel = findViewById(R.id.sv_note_edit); + + // 背景选择器 mNoteBgColorSelector = findViewById(R.id.note_bg_color_selector); for (int id : sBgSelectorBtnsMap.keySet()) { ImageView iv = (ImageView) findViewById(id); iv.setOnClickListener(this); } + // 字体选择器 mFontSizeSelector = findViewById(R.id.font_size_selector); for (int id : sFontSizeBtnsMap.keySet()) { View view = findViewById(id); view.setOnClickListener(this); }; + + // 偏好设置 mSharedPrefs = PreferenceManager.getDefaultSharedPreferences(this); mFontSizeId = mSharedPrefs.getInt(PREFERENCE_FONT_SIZE, ResourceParser.BG_DEFAULT_FONT_SIZE); - /** - * 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} - */ + + // 修复字体大小ID可能越界的bug if(mFontSizeId >= TextAppearanceResources.getResourcesSize()) { mFontSizeId = ResourceParser.BG_DEFAULT_FONT_SIZE; } + + // 列表模式容器 mEditTextList = (LinearLayout) findViewById(R.id.note_edit_list); } + // ======================= 生命周期暂停 ======================= + + /** + * onPause - Activity暂停 + * 保存便签数据 + */ @Override protected void onPause() { super.onPause(); @@ -406,6 +541,12 @@ public class NoteEditActivity extends Activity implements OnClickListener, clearSettingState(); } + // ======================= 小部件更新 ======================= + + /** + * 更新小部件 + * 根据便签关联的小部件类型发送更新广播 + */ private void updateWidget() { Intent intent = new Intent(AppWidgetManager.ACTION_APPWIDGET_UPDATE); if (mWorkingNote.getWidgetType() == Notes.TYPE_WIDGET_2X) { @@ -418,29 +559,46 @@ public class NoteEditActivity extends Activity implements OnClickListener, } intent.putExtra(AppWidgetManager.EXTRA_APPWIDGET_IDS, new int[] { - mWorkingNote.getWidgetId() + mWorkingNote.getWidgetId() }); sendBroadcast(intent); setResult(RESULT_OK, intent); } + // ======================= 点击事件处理 ======================= + + /** + * onClick - 视图点击处理 + * 实现OnClickListener接口 + */ public void onClick(View v) { int id = v.getId(); + // 背景颜色设置按钮 if (id == R.id.btn_set_bg_color) { mNoteBgColorSelector.setVisibility(View.VISIBLE); findViewById(sBgSelectorSelectionMap.get(mWorkingNote.getBgColorId())).setVisibility( - - View.VISIBLE); - } else if (sBgSelectorBtnsMap.containsKey(id)) { + View.VISIBLE); + } + // 背景颜色选择 + else if (sBgSelectorBtnsMap.containsKey(id)) { + // 隐藏之前的选中状态 findViewById(sBgSelectorSelectionMap.get(mWorkingNote.getBgColorId())).setVisibility( View.GONE); + // 设置新颜色 mWorkingNote.setBgColorId(sBgSelectorBtnsMap.get(id)); mNoteBgColorSelector.setVisibility(View.GONE); - } else if (sFontSizeBtnsMap.containsKey(id)) { + } + // 字体大小选择 + else if (sFontSizeBtnsMap.containsKey(id)) { + // 隐藏之前的选中状态 findViewById(sFontSelectorSelectionMap.get(mFontSizeId)).setVisibility(View.GONE); + // 设置新字体大小 mFontSizeId = sFontSizeBtnsMap.get(id); mSharedPrefs.edit().putInt(PREFERENCE_FONT_SIZE, mFontSizeId).commit(); findViewById(sFontSelectorSelectionMap.get(mFontSizeId)).setVisibility(View.VISIBLE); + + // 根据当前模式更新文本外观 if (mWorkingNote.getCheckListMode() == TextNote.MODE_CHECK_LIST) { getWorkingText(); switchToListMode(mWorkingNote.getContent()); @@ -452,6 +610,12 @@ public class NoteEditActivity extends Activity implements OnClickListener, } } + // ======================= 返回键处理 ======================= + + /** + * 返回键处理 + * 先保存便签再退出 + */ @Override public void onBackPressed() { if(clearSettingState()) { @@ -462,6 +626,11 @@ public class NoteEditActivity extends Activity implements OnClickListener, super.onBackPressed(); } + /** + * 清除设置状态 + * 关闭打开的选择器 + * @return true: 有关闭的选择器; false: 无选择器打开 + */ private boolean clearSettingState() { if (mNoteBgColorSelector.getVisibility() == View.VISIBLE) { mNoteBgColorSelector.setVisibility(View.GONE); @@ -473,13 +642,27 @@ public class NoteEditActivity extends Activity implements OnClickListener, return false; } + // ======================= 便签设置变化回调 ======================= + + /** + * 背景颜色变化回调 + * 实现NoteSettingChangedListener接口 + */ public void onBackgroundColorChanged() { + // 显示新的选中状态 findViewById(sBgSelectorSelectionMap.get(mWorkingNote.getBgColorId())).setVisibility( View.VISIBLE); + // 更新视图背景 mNoteEditorPanel.setBackgroundResource(mWorkingNote.getBgColorResId()); mHeadViewPanel.setBackgroundResource(mWorkingNote.getTitleBgResId()); } + // ======================= 菜单处理 ======================= + + /** + * 准备选项菜单 + * 根据便签状态动态更新菜单 + */ @Override public boolean onPrepareOptionsMenu(Menu menu) { if (isFinishing()) { @@ -487,16 +670,22 @@ public class NoteEditActivity extends Activity implements OnClickListener, } clearSettingState(); menu.clear(); + + // 根据文件夹类型加载不同菜单 if (mWorkingNote.getFolderId() == Notes.ID_CALL_RECORD_FOLDER) { getMenuInflater().inflate(R.menu.call_note_edit, menu); } else { getMenuInflater().inflate(R.menu.note_edit, menu); } + + // 更新清单模式菜单项文本 if (mWorkingNote.getCheckListMode() == TextNote.MODE_CHECK_LIST) { menu.findItem(R.id.menu_list_mode).setTitle(R.string.menu_normal_mode); } else { menu.findItem(R.id.menu_list_mode).setTitle(R.string.menu_list_mode); } + + // 根据提醒状态显示/隐藏菜单项 if (mWorkingNote.hasClockAlert()) { menu.findItem(R.id.menu_alert).setVisible(false); } else { @@ -505,6 +694,9 @@ public class NoteEditActivity extends Activity implements OnClickListener, return true; } + /** + * 选项菜单项选择 + */ @Override public boolean onOptionsItemSelected(MenuItem item) { int itemId = item.getItemId(); // 获取菜单ID并缓存 @@ -547,19 +739,25 @@ public class NoteEditActivity extends Activity implements OnClickListener, return true; } + // ======================= 提醒设置 ======================= + + /** + * 设置提醒 + * 显示日期时间选择对话框 + */ private void setReminder() { DateTimePickerDialog d = new DateTimePickerDialog(this, System.currentTimeMillis()); d.setOnDateTimeSetListener(new OnDateTimeSetListener() { public void OnDateTimeSet(AlertDialog dialog, long date) { - mWorkingNote.setAlertDate(date , true); + mWorkingNote.setAlertDate(date, true); } }); d.show(); } /** - * Share note to apps that support {@link Intent#ACTION_SEND} action - * and {@text/plain} type + * 分享便签 + * 通过系统分享功能分享文本 */ private void sendTo(Context context, String info) { Intent intent = new Intent(Intent.ACTION_SEND); @@ -568,11 +766,14 @@ public class NoteEditActivity extends Activity implements OnClickListener, context.startActivity(intent); } + /** + * 创建新便签 + */ private void createNewNote() { - // Firstly, save current editing notes + // 先保存当前便签 saveNote(); - // For safety, start a new NoteEditActivity + // 启动新的编辑Activity finish(); Intent intent = new Intent(this, NoteEditActivity.class); intent.setAction(Intent.ACTION_INSERT_OR_EDIT); @@ -580,6 +781,9 @@ public class NoteEditActivity extends Activity implements OnClickListener, startActivity(intent); } + /** + * 删除当前便签 + */ private void deleteCurrentNote() { if (mWorkingNote.existInDatabase()) { HashSet ids = new HashSet(); @@ -589,6 +793,7 @@ public class NoteEditActivity extends Activity implements OnClickListener, } else { Log.d(TAG, "Wrong note id, should not happen"); } + // 根据同步模式选择删除或移动到回收站 if (!isSyncMode()) { if (!DataUtils.batchDeleteNotes(getContentResolver(), ids)) { Log.e(TAG, "Delete Note error"); @@ -602,19 +807,26 @@ public class NoteEditActivity extends Activity implements OnClickListener, mWorkingNote.markDeleted(true); } + /** + * 判断是否为同步模式 + */ private boolean isSyncMode() { return NotesPreferenceActivity.getSyncAccountName(this).trim().length() > 0; } + // ======================= 提醒变化回调 ======================= + + /** + * 闹钟提醒变化回调 + * 实现NoteSettingChangedListener接口 + */ public void onClockAlertChanged(long date, boolean set) { - /** - * User could set clock to an unsaved note, so before setting the - * alert clock, we should save the note first - */ + // 如果便签未保存，先保存 if (!mWorkingNote.existInDatabase()) { saveNote(); } if (mWorkingNote.getNoteId() > 0) { + // 设置或取消系统闹钟 Intent intent = new Intent(this, AlarmReceiver.class); intent.setData(ContentUris.withAppendedId(Notes.CONTENT_NOTE_URI, mWorkingNote.getNoteId())); PendingIntent pendingIntent = PendingIntent.getBroadcast(this, 0, intent, 0); @@ -626,31 +838,38 @@ public class NoteEditActivity extends Activity implements OnClickListener, alarmManager.set(AlarmManager.RTC_WAKEUP, date, pendingIntent); } } else { - /** - * There is the condition that user has input nothing (the note is - * not worthy saving), we have no note id, remind the user that he - * should input something - */ + // 便签为空，无法设置提醒 Log.e(TAG, "Clock alert setting error"); showToast(R.string.error_note_empty_for_clock); } } + /** + * 小部件变化回调 + */ public void onWidgetChanged() { updateWidget(); } + // ======================= 文本编辑变化回调 ======================= + + /** + * 文本编辑删除回调 + * 实现OnTextViewChangeListener接口 + */ public void onEditTextDelete(int index, String text) { int childCount = mEditTextList.getChildCount(); if (childCount == 1) { - return; + return; // 只有一个项时不删除 } + // 更新后续项的索引 for (int i = index + 1; i < childCount; i++) { ((NoteEditText) mEditTextList.getChildAt(i).findViewById(R.id.et_edit_text)) .setIndex(i - 1); } + // 移除视图 mEditTextList.removeViewAt(index); NoteEditText edit = null; if(index == 0) { @@ -660,16 +879,18 @@ public class NoteEditActivity extends Activity implements OnClickListener, edit = (NoteEditText) mEditTextList.getChildAt(index - 1).findViewById( R.id.et_edit_text); } + // 将删除的文本追加到前一项 int length = edit.length(); edit.append(text); edit.requestFocus(); edit.setSelection(length); } + /** + * 文本编辑回车回调 + * 创建新的列表项 + */ public void onEditTextEnter(int index, String text) { - /** - * Should not happen, check for debug - */ if(index > mEditTextList.getChildCount()) { Log.e(TAG, "Index out of mEditTextList boundrary, should not happen"); } @@ -679,12 +900,19 @@ public class NoteEditActivity extends Activity implements OnClickListener, NoteEditText edit = (NoteEditText) view.findViewById(R.id.et_edit_text); edit.requestFocus(); edit.setSelection(0); + // 更新后续项的索引 for (int i = index + 1; i < mEditTextList.getChildCount(); i++) { ((NoteEditText) mEditTextList.getChildAt(i).findViewById(R.id.et_edit_text)) .setIndex(i); } } + // ======================= 清单模式切换 ======================= + + /** + * 切换到清单模式 + * 将文本分割为多个列表项 + */ private void switchToListMode(String text) { mEditTextList.removeAllViews(); String[] items = text.split("\n"); @@ -695,13 +923,21 @@ public class NoteEditActivity extends Activity implements OnClickListener, index++; } } + // 添加一个空项用于输入 mEditTextList.addView(getListItem("", index)); mEditTextList.getChildAt(index).findViewById(R.id.et_edit_text).requestFocus(); + // 切换视图显示 mNoteEditor.setVisibility(View.GONE); mEditTextList.setVisibility(View.VISIBLE); } + // ======================= 搜索高亮 ======================= + + /** + * 获取高亮的搜索结果 + * 高亮显示搜索关键词 + */ private Spannable getHighlightQueryResult(String fullText, String userQuery) { SpannableString spannable = new SpannableString(fullText == null ? "" : fullText); if (!TextUtils.isEmpty(userQuery)) { @@ -709,6 +945,7 @@ public class NoteEditActivity extends Activity implements OnClickListener, Matcher m = mPattern.matcher(fullText); int start = 0; while (m.find(start)) { + // 设置高亮背景色 spannable.setSpan( new BackgroundColorSpan(this.getResources().getColor( R.color.user_query_highlight)), m.start(), m.end(), @@ -719,6 +956,9 @@ public class NoteEditActivity extends Activity implements OnClickListener, return spannable; } + /** + * 获取列表项视图 + */ private View getListItem(String item, int index) { View view = LayoutInflater.from(this).inflate(R.layout.note_edit_list_item, null); final NoteEditText edit = (NoteEditText) view.findViewById(R.id.et_edit_text); @@ -726,6 +966,7 @@ public class NoteEditActivity extends Activity implements OnClickListener, CheckBox cb = ((CheckBox) view.findViewById(R.id.cb_edit_item)); cb.setOnCheckedChangeListener(new OnCheckedChangeListener() { public void onCheckedChanged(CompoundButton buttonView, boolean isChecked) { + // 根据勾选状态设置删除线 if (isChecked) { edit.setPaintFlags(edit.getPaintFlags() | Paint.STRIKE_THRU_TEXT_FLAG); } else { @@ -734,6 +975,7 @@ public class NoteEditActivity extends Activity implements OnClickListener, } }); + // 解析清单标记 if (item.startsWith(TAG_CHECKED)) { cb.setChecked(true); edit.setPaintFlags(edit.getPaintFlags() | Paint.STRIKE_THRU_TEXT_FLAG); @@ -750,6 +992,10 @@ public class NoteEditActivity extends Activity implements OnClickListener, return view; } + /** + * 文本变化回调 + * 根据是否有文本显示/隐藏复选框 + */ public void onTextChange(int index, boolean hasText) { if (index >= mEditTextList.getChildCount()) { Log.e(TAG, "Wrong index, should not happen"); @@ -762,10 +1008,17 @@ public class NoteEditActivity extends Activity implements OnClickListener, } } + // ======================= 清单模式变化回调 ======================= + + /** + * 清单模式变化回调 + */ public void onCheckListModeChanged(int oldMode, int newMode) { if (newMode == TextNote.MODE_CHECK_LIST) { + // 切换到清单模式 switchToListMode(mNoteEditor.getText().toString()); } else { + // 切换到普通模式 if (!getWorkingText()) { mWorkingNote.setWorkingText(mWorkingNote.getContent().replace(TAG_UNCHECKED + " ", "")); @@ -776,9 +1029,17 @@ public class NoteEditActivity extends Activity implements OnClickListener, } } + // ======================= 获取工作文本 ======================= + + /** + * 获取工作文本 + * 从当前UI获取文本内容保存到模型 + * @return 是否包含已勾选项 + */ private boolean getWorkingText() { boolean hasChecked = false; if (mWorkingNote.getCheckListMode() == TextNote.MODE_CHECK_LIST) { + // 清单模式：拼接所有项 StringBuilder sb = new StringBuilder(); for (int i = 0; i < mEditTextList.getChildCount(); i++) { View view = mEditTextList.getChildAt(i); @@ -794,33 +1055,35 @@ public class NoteEditActivity extends Activity implements OnClickListener, } mWorkingNote.setWorkingText(sb.toString()); } else { + // 普通模式 mWorkingNote.setWorkingText(mNoteEditor.getText().toString()); } return hasChecked; } + // ======================= 保存便签 ======================= + + /** + * 保存便签 + * @return true: 保存成功; false: 保存失败 + */ private boolean saveNote() { getWorkingText(); boolean saved = mWorkingNote.saveNote(); if (saved) { - /** - * There are two modes from List view to edit view, open one note, - * create/edit a node. Opening node requires to the original - * position in the list when back from edit view, while creating a - * new node requires to the top of the list. This code - * {@link #RESULT_OK} is used to identify the create/edit state - */ setResult(RESULT_OK); } return saved; } + // ======================= 发送到桌面 ======================= + + /** + * 发送到桌面 + * 创建桌面快捷方式 + */ private void sendToDesktop() { - /** - * Before send message to home, we should make sure that current - * editing note is exists in databases. So, for new note, firstly - * save it - */ + // 确保便签已保存 if (!mWorkingNote.existInDatabase()) { saveNote(); } @@ -840,16 +1103,14 @@ public class NoteEditActivity extends Activity implements OnClickListener, showToast(R.string.info_note_enter_desktop); sendBroadcast(sender); } else { - /** - * There is the condition that user has input nothing (the note is - * not worthy saving), we have no note id, remind the user that he - * should input something - */ Log.e(TAG, "Send to desktop error"); showToast(R.string.error_note_empty_for_send_to_desktop); } } + /** + * 创建快捷方式图标标题 + */ private String makeShortcutIconTitle(String content) { content = content.replace(TAG_CHECKED, ""); content = content.replace(TAG_UNCHECKED, ""); @@ -857,6 +1118,11 @@ public class NoteEditActivity extends Activity implements OnClickListener, SHORTCUT_ICON_TITLE_MAX_LEN) : content; } + // ======================= 工具方法 ======================= + + /** + * 显示Toast提示 + */ private void showToast(int resId) { showToast(resId, Toast.LENGTH_SHORT); } @@ -864,4 +1130,4 @@ public class NoteEditActivity extends Activity implements OnClickListener, private void showToast(int resId, int duration) { Toast.makeText(this, resId, duration).show(); } -} +} \ No newline at end of file diff --git a/src/notes/ui/NoteEditText.java b/src/notes/ui/NoteEditText.java index 2afe2a8..d07dbe2 100644 --- a/src/notes/ui/NoteEditText.java +++ b/src/notes/ui/NoteEditText.java @@ -14,106 +14,188 @@ * limitations under the License. */ +// NoteEditText.java - 自定义便签编辑文本控件 +// 主要功能：扩展EditText，支持清单模式的特殊按键处理、超链接识别和上下文菜单 package net.micode.notes.ui; -import android.content.Context; -import android.graphics.Rect; -import android.text.Layout; -import android.text.Selection; -import android.text.Spanned; -import android.text.TextUtils; -import android.text.style.URLSpan; -import android.util.AttributeSet; -import android.util.Log; -import android.view.ContextMenu; -import android.view.KeyEvent; -import android.view.MenuItem; -import android.view.MenuItem.OnMenuItemClickListener; -import android.view.MotionEvent; -import android.widget.EditText; - -import net.micode.notes.R; - -import java.util.HashMap; -import java.util.Map; +// ======================= 导入区域 ======================= +// Android基础 +import android.content.Context; // 上下文 +import android.graphics.Rect; // 矩形区域 +// Android文本处理 +import android.text.Layout; // 文本布局 +import android.text.Selection; // 文本选择 +import android.text.Spanned; // 可设置样式的文本 +import android.text.TextUtils; // 文本工具 +import android.text.style.URLSpan; // URL超链接样式 +import android.util.AttributeSet; // 属性集 +import android.util.Log; // 日志工具 +// Android菜单 +import android.view.ContextMenu; // 上下文菜单 +import android.view.KeyEvent; // 按键事件 +import android.view.MenuItem; // 菜单项 +import android.view.MenuItem.OnMenuItemClickListener; // 菜单项点击监听 +import android.view.MotionEvent; // 触摸事件 +// Android控件 +import android.widget.EditText; // 编辑文本控件基类 +// 应用内部资源 +import net.micode.notes.R; // 资源文件R类 + +// Java集合 +import java.util.HashMap; // 哈希映射 +import java.util.Map; // 映射接口 + +// ======================= 便签编辑文本控件 ======================= +/** + * NoteEditText - 自定义便签编辑文本控件 + * 继承自EditText，增强功能用于便签的清单模式编辑 + * 核心功能： + * 1. 清单模式按键处理（回车新增项，删除删除项） + * 2. 超链接识别和上下文菜单 + * 3. 焦点变化通知 + * 4. 触摸精确定位 + */ public class NoteEditText extends EditText { - private static final String TAG = "NoteEditText"; + + // ======================= 常量定义 ======================= + + private static final String TAG = "NoteEditText"; // 日志标签 + + /** 当前项索引 - 在清单模式中标识第几个列表项 */ private int mIndex; + + /** 删除前的选择起始位置 - 用于判断是否在开头删除 */ private int mSelectionStartBeforeDelete; - private static final String SCHEME_TEL = "tel:" ; - private static final String SCHEME_HTTP = "http:" ; - private static final String SCHEME_EMAIL = "mailto:" ; + // 超链接协议常量 + private static final String SCHEME_TEL = "tel:"; // 电话协议 + private static final String SCHEME_HTTP = "http:"; // HTTP协议 + private static final String SCHEME_EMAIL = "mailto:"; // 邮件协议 + /** + * 协议动作资源映射 + * 键：协议前缀，值：对应的菜单文本资源ID + * 用于为不同类型的超链接显示不同的上下文菜单 + */ private static final Map sSchemaActionResMap = new HashMap(); static { - sSchemaActionResMap.put(SCHEME_TEL, R.string.note_link_tel); - sSchemaActionResMap.put(SCHEME_HTTP, R.string.note_link_web); - sSchemaActionResMap.put(SCHEME_EMAIL, R.string.note_link_email); + sSchemaActionResMap.put(SCHEME_TEL, R.string.note_link_tel); // 电话链接 + sSchemaActionResMap.put(SCHEME_HTTP, R.string.note_link_web); // 网页链接 + sSchemaActionResMap.put(SCHEME_EMAIL, R.string.note_link_email); // 邮件链接 } + // ======================= 文本变化监听器接口 ======================= + /** - * Call by the {@link NoteEditActivity} to delete or add edit text + * OnTextViewChangeListener - 文本视图变化监听器接口 + * 由NoteEditActivity实现，处理清单模式的特殊按键行为 */ public interface OnTextViewChangeListener { /** - * Delete current edit text when {@link KeyEvent#KEYCODE_DEL} happens - * and the text is null + * 删除当前编辑文本 + * 当在文本开头按下删除键且文本为空时调用 + * @param index 当前项的索引 + * @param text 当前文本内容 */ void onEditTextDelete(int index, String text); /** - * Add edit text after current edit text when {@link KeyEvent#KEYCODE_ENTER} - * happen + * 添加新的编辑文本 + * 当按下回车键时调用 + * @param index 新项的索引 + * @param text 要添加到新项的文本（当前光标后的内容） */ void onEditTextEnter(int index, String text); /** - * Hide or show item option when text change + * 文本变化通知 + * 用于显示/隐藏列表项的操作控件 + * @param index 当前项的索引 + * @param hasText 是否有文本内容 */ void onTextChange(int index, boolean hasText); } + /** 文本变化监听器实例 */ private OnTextViewChangeListener mOnTextViewChangeListener; + // ======================= 构造函数 ======================= + + /** + * 构造函数1 - 简化版本 + * @param context 上下文 + */ public NoteEditText(Context context) { super(context, null); - mIndex = 0; + mIndex = 0; // 默认索引为0 } + /** + * 构造函数2 - 完整属性 + * @param context 上下文 + * @param attrs 属性集 + */ + public NoteEditText(Context context, AttributeSet attrs) { + super(context, attrs, android.R.attr.editTextStyle); + } + + /** + * 构造函数3 - 包含样式 + * @param context 上下文 + * @param attrs 属性集 + * @param defStyle 默认样式 + */ + public NoteEditText(Context context, AttributeSet attrs, int defStyle) { + super(context, attrs, defStyle); + // TODO: 可在此处添加额外初始化代码 + } + + // ======================= 设置方法 ======================= + + /** + * 设置项索引 + * 在清单模式中标识当前是第几个列表项 + * @param index 索引值 + */ public void setIndex(int index) { mIndex = index; } + /** + * 设置文本变化监听器 + * @param listener 监听器实例 + */ public void setOnTextViewChangeListener(OnTextViewChangeListener listener) { mOnTextViewChangeListener = listener; } - public NoteEditText(Context context, AttributeSet attrs) { - super(context, attrs, android.R.attr.editTextStyle); - } - - public NoteEditText(Context context, AttributeSet attrs, int defStyle) { - super(context, attrs, defStyle); - // TODO Auto-generated constructor stub - } + // ======================= 触摸事件处理 ======================= + /** + * 触摸事件处理 + * 重写以实现精确的触摸位置选择 + * @param event 触摸事件 + * @return true: 已处理; false: 未处理 + */ @Override public boolean onTouchEvent(MotionEvent event) { switch (event.getAction()) { case MotionEvent.ACTION_DOWN: - + // 计算触摸点在文本中的精确位置 int x = (int) event.getX(); int y = (int) event.getY(); - x -= getTotalPaddingLeft(); + x -= getTotalPaddingLeft(); // 减去内边距 y -= getTotalPaddingTop(); - x += getScrollX(); + x += getScrollX(); // 加上滚动偏移 y += getScrollY(); + // 获取布局并计算字符偏移 Layout layout = getLayout(); int line = layout.getLineForVertical(y); int off = layout.getOffsetForHorizontal(line, x); + + // 设置选择位置 Selection.setSelection(getText(), off); break; } @@ -121,15 +203,26 @@ public class NoteEditText extends EditText { return super.onTouchEvent(event); } + // ======================= 按键按下事件 ======================= + + /** + * 按键按下事件处理 + * 拦截特殊按键进行预处理 + * @param keyCode 按键代码 + * @param event 按键事件 + * @return true: 已处理; false: 未处理 + */ @Override public boolean onKeyDown(int keyCode, KeyEvent event) { switch (keyCode) { case KeyEvent.KEYCODE_ENTER: + // 拦截回车键，在onKeyUp中处理 if (mOnTextViewChangeListener != null) { - return false; + return false; // 返回false让系统继续处理 } break; case KeyEvent.KEYCODE_DEL: + // 记录删除前的选择位置 mSelectionStartBeforeDelete = getSelectionStart(); break; default: @@ -138,24 +231,39 @@ public class NoteEditText extends EditText { return super.onKeyDown(keyCode, event); } + // ======================= 按键抬起事件 ======================= + + /** + * 按键抬起事件处理 + * 处理清单模式的特殊按键逻辑 + * @param keyCode 按键代码 + * @param event 按键事件 + * @return true: 已处理; false: 未处理 + */ @Override public boolean onKeyUp(int keyCode, KeyEvent event) { switch(keyCode) { case KeyEvent.KEYCODE_DEL: + // 删除键处理 if (mOnTextViewChangeListener != null) { + // 条件：在文本开头删除 且 不是第一项 if (0 == mSelectionStartBeforeDelete && mIndex != 0) { + // 触发删除回调 mOnTextViewChangeListener.onEditTextDelete(mIndex, getText().toString()); - return true; + return true; // 已处理 } } else { Log.d(TAG, "OnTextViewChangeListener was not seted"); } break; case KeyEvent.KEYCODE_ENTER: + // 回车键处理 if (mOnTextViewChangeListener != null) { int selectionStart = getSelectionStart(); + // 分割文本：光标前保留，光标后移到新项 String text = getText().subSequence(selectionStart, length()).toString(); setText(getText().subSequence(0, selectionStart)); + // 触发新增回调 mOnTextViewChangeListener.onEditTextEnter(mIndex + 1, text); } else { Log.d(TAG, "OnTextViewChangeListener was not seted"); @@ -167,30 +275,54 @@ public class NoteEditText extends EditText { return super.onKeyUp(keyCode, event); } + // ======================= 焦点变化处理 ======================= + + /** + * 焦点变化处理 + * 当焦点变化时通知监听器文本状态 + * @param focused 是否获得焦点 + * @param direction 焦点方向 + * @param previouslyFocusedRect 之前获得焦点的矩形区域 + */ @Override protected void onFocusChanged(boolean focused, int direction, Rect previouslyFocusedRect) { if (mOnTextViewChangeListener != null) { + // 失去焦点且文本为空时，通知隐藏操作控件 if (!focused && TextUtils.isEmpty(getText())) { mOnTextViewChangeListener.onTextChange(mIndex, false); } else { + // 其他情况通知显示操作控件 mOnTextViewChangeListener.onTextChange(mIndex, true); } } super.onFocusChanged(focused, direction, previouslyFocusedRect); } + // ======================= 上下文菜单创建 ======================= + + /** + * 创建上下文菜单 + * 检测选中的文本是否包含超链接，并为不同类型的链接创建对应的菜单项 + * @param menu 上下文菜单 + */ @Override protected void onCreateContextMenu(ContextMenu menu) { + // 检查文本是否包含样式（可能包含超链接） if (getText() instanceof Spanned) { int selStart = getSelectionStart(); int selEnd = getSelectionEnd(); + // 计算选择范围 int min = Math.min(selStart, selEnd); int max = Math.max(selStart, selEnd); + // 获取选择范围内的超链接 final URLSpan[] urls = ((Spanned) getText()).getSpans(min, max, URLSpan.class); + + // 只处理单个超链接的情况 if (urls.length == 1) { int defaultResId = 0; + // 根据URL协议确定菜单文本 for(String schema: sSchemaActionResMap.keySet()) { if(urls[0].getURL().indexOf(schema) >= 0) { defaultResId = sSchemaActionResMap.get(schema); @@ -198,14 +330,16 @@ public class NoteEditText extends EditText { } } + // 未知协议使用默认文本 if (defaultResId == 0) { defaultResId = R.string.note_link_other; } + // 添加菜单项 menu.add(0, 0, 0, defaultResId).setOnMenuItemClickListener( new OnMenuItemClickListener() { public boolean onMenuItemClick(MenuItem item) { - // goto a new intent + // 触发超链接点击 urls[0].onClick(NoteEditText.this); return true; } @@ -214,4 +348,4 @@ public class NoteEditText extends EditText { } super.onCreateContextMenu(menu); } -} +} \ No newline at end of file diff --git a/src/notes/ui/NoteItemData.java b/src/notes/ui/NoteItemData.java index 0f5a878..2b970e5 100644 --- a/src/notes/ui/NoteItemData.java +++ b/src/notes/ui/NoteItemData.java @@ -14,69 +14,111 @@ * limitations under the License. */ +// NoteItemData.java - 便签项数据模型类 +// 主要功能：封装便签列表项的数据，提供便捷的访问方法和位置判断逻辑 package net.micode.notes.ui; -import android.content.Context; -import android.database.Cursor; -import android.text.TextUtils; - -import net.micode.notes.data.Contact; -import net.micode.notes.data.Notes; -import net.micode.notes.data.Notes.NoteColumns; -import net.micode.notes.tool.DataUtils; +// ======================= 导入区域 ======================= +// Android基础 +import android.content.Context; // 上下文 +import android.database.Cursor; // 数据库查询结果游标 +import android.text.TextUtils; // 文本工具 + +// 应用内部工具 +import net.micode.notes.data.Contact; // 联系人工具类 +import net.micode.notes.data.Notes; // Notes主类 +import net.micode.notes.data.Notes.NoteColumns; // 便签表列定义 +import net.micode.notes.tool.DataUtils; // 数据工具 + +// ======================= 便签项数据模型 ======================= +/** + * NoteItemData - 便签项数据模型类 + * 功能：从数据库Cursor解析便签数据，封装为对象模型 + * 用途：在便签列表适配器中表示单个便签项的数据 + * 特点：包含位置判断逻辑，用于列表项背景选择 + */ +public class NoteItemData { + // ======================= 数据库查询配置 ======================= -public class NoteItemData { + /** + * 查询投影数组 - 指定从数据库查询哪些字段 + * 包含便签表的所有重要字段 + */ static final String [] PROJECTION = new String [] { - NoteColumns.ID, - NoteColumns.ALERTED_DATE, - NoteColumns.BG_COLOR_ID, - NoteColumns.CREATED_DATE, - NoteColumns.HAS_ATTACHMENT, - NoteColumns.MODIFIED_DATE, - NoteColumns.NOTES_COUNT, - NoteColumns.PARENT_ID, - NoteColumns.SNIPPET, - NoteColumns.TYPE, - NoteColumns.WIDGET_ID, - NoteColumns.WIDGET_TYPE, + NoteColumns.ID, // 0 - 便签ID + NoteColumns.ALERTED_DATE, // 1 - 提醒时间 + NoteColumns.BG_COLOR_ID, // 2 - 背景颜色ID + NoteColumns.CREATED_DATE, // 3 - 创建时间 + NoteColumns.HAS_ATTACHMENT, // 4 - 是否有附件 + NoteColumns.MODIFIED_DATE, // 5 - 修改时间 + NoteColumns.NOTES_COUNT, // 6 - 包含的便签数（文件夹用） + NoteColumns.PARENT_ID, // 7 - 父文件夹ID + NoteColumns.SNIPPET, // 8 - 便签摘要 + NoteColumns.TYPE, // 9 - 便签类型 + NoteColumns.WIDGET_ID, // 10 - 小部件ID + NoteColumns.WIDGET_TYPE, // 11 - 小部件类型 }; - private static final int ID_COLUMN = 0; - private static final int ALERTED_DATE_COLUMN = 1; - private static final int BG_COLOR_ID_COLUMN = 2; - private static final int CREATED_DATE_COLUMN = 3; - private static final int HAS_ATTACHMENT_COLUMN = 4; - private static final int MODIFIED_DATE_COLUMN = 5; - private static final int NOTES_COUNT_COLUMN = 6; - private static final int PARENT_ID_COLUMN = 7; - private static final int SNIPPET_COLUMN = 8; - private static final int TYPE_COLUMN = 9; - private static final int WIDGET_ID_COLUMN = 10; - private static final int WIDGET_TYPE_COLUMN = 11; - - private long mId; - private long mAlertDate; - private int mBgColorId; - private long mCreatedDate; - private boolean mHasAttachment; - private long mModifiedDate; - private int mNotesCount; - private long mParentId; - private String mSnippet; - private int mType; - private int mWidgetId; - private int mWidgetType; - private String mName; - private String mPhoneNumber; - - private boolean mIsLastItem; - private boolean mIsFirstItem; - private boolean mIsOnlyOneItem; - private boolean mIsOneNoteFollowingFolder; - private boolean mIsMultiNotesFollowingFolder; - + // ======================= 字段索引常量 ======================= + + // 使用常量而非魔法数字，提高代码可读性 + private static final int ID_COLUMN = 0; // ID字段索引 + private static final int ALERTED_DATE_COLUMN = 1; // 提醒时间字段索引 + private static final int BG_COLOR_ID_COLUMN = 2; // 背景颜色字段索引 + private static final int CREATED_DATE_COLUMN = 3; // 创建时间字段索引 + private static final int HAS_ATTACHMENT_COLUMN = 4; // 附件字段索引 + private static final int MODIFIED_DATE_COLUMN = 5; // 修改时间字段索引 + private static final int NOTES_COUNT_COLUMN = 6; // 便签数字段索引 + private static final int PARENT_ID_COLUMN = 7; // 父ID字段索引 + private static final int SNIPPET_COLUMN = 8; // 摘要字段索引 + private static final int TYPE_COLUMN = 9; // 类型字段索引 + private static final int WIDGET_ID_COLUMN = 10; // 小部件ID字段索引 + private static final int WIDGET_TYPE_COLUMN = 11; // 小部件类型字段索引 + + // ======================= 数据成员 ======================= + + // 基本数据字段 + private long mId; // 便签ID + private long mAlertDate; // 提醒时间戳 + private int mBgColorId; // 背景颜色索引 + private long mCreatedDate; // 创建时间戳 + private boolean mHasAttachment; // 是否有附件 + private long mModifiedDate; // 修改时间戳 + private int mNotesCount; // 包含的便签数（文件夹） + private long mParentId; // 父文件夹ID + private String mSnippet; // 便签摘要 + private int mType; // 便签类型 + private int mWidgetId; // 小部件ID + private int mWidgetType; // 小部件类型 + + // 通话记录相关 + private String mName; // 联系人姓名 + private String mPhoneNumber; // 电话号码 + + // 位置状态标志 + private boolean mIsLastItem; // 是否是列表最后一项 + private boolean mIsFirstItem; // 是否是列表第一项 + private boolean mIsOnlyOneItem; // 是否是唯一一项 + private boolean mIsOneNoteFollowingFolder; // 是否是文件夹后的唯一便签 + private boolean mIsMultiNotesFollowingFolder; // 是否是文件夹后的多个便签之一 + + // ======================= 构造函数 ======================= + + /** + * 构造函数 + * 从Cursor解析数据并初始化对象 + * 执行流程： + * 1. 从Cursor读取所有字段 + * 2. 清理清单标记 + * 3. 处理通话记录 + * 4. 检查位置状态 + * + * @param context 上下文，用于联系人查询 + * @param cursor 数据库游标，必须包含PROJECTION指定的字段 + */ public NoteItemData(Context context, Cursor cursor) { + // 1. 读取基本字段 mId = cursor.getLong(ID_COLUMN); mAlertDate = cursor.getLong(ALERTED_DATE_COLUMN); mBgColorId = cursor.getInt(BG_COLOR_ID_COLUMN); @@ -86,47 +128,80 @@ public class NoteItemData { mNotesCount = cursor.getInt(NOTES_COUNT_COLUMN); mParentId = cursor.getLong(PARENT_ID_COLUMN); mSnippet = cursor.getString(SNIPPET_COLUMN); - mSnippet = mSnippet.replace(NoteEditActivity.TAG_CHECKED, "").replace( - NoteEditActivity.TAG_UNCHECKED, ""); mType = cursor.getInt(TYPE_COLUMN); mWidgetId = cursor.getInt(WIDGET_ID_COLUMN); mWidgetType = cursor.getInt(WIDGET_TYPE_COLUMN); - mPhoneNumber = ""; + // 2. 清理摘要中的清单标记 + // 移除已勾选(√)和未勾选(□)标记，只显示纯文本 + mSnippet = mSnippet.replace(NoteEditActivity.TAG_CHECKED, "").replace( + NoteEditActivity.TAG_UNCHECKED, ""); + + // 3. 处理通话记录 + mPhoneNumber = ""; // 初始化电话号码 if (mParentId == Notes.ID_CALL_RECORD_FOLDER) { + // 从通话记录文件夹中获取电话号码 mPhoneNumber = DataUtils.getCallNumberByNoteId(context.getContentResolver(), mId); if (!TextUtils.isEmpty(mPhoneNumber)) { + // 根据电话号码查询联系人姓名 mName = Contact.getContact(context, mPhoneNumber); if (mName == null) { + // 未找到联系人，使用电话号码作为显示名称 mName = mPhoneNumber; } } } + // 确保名称不为null if (mName == null) { mName = ""; } + + // 4. 检查位置状态 checkPostion(cursor); } + // ======================= 位置检查方法 ======================= + + /** + * 检查便签在列表中的位置状态 + * 用于确定列表项应使用的背景样式 + * 位置判断逻辑： + * 1. 基本位置：首项、末项、唯一项 + * 2. 文件夹后位置：文件夹后的第一个便签、多个便签 + * + * @param cursor 数据库游标，用于位置判断 + */ private void checkPostion(Cursor cursor) { - mIsLastItem = cursor.isLast() ? true : false; - mIsFirstItem = cursor.isFirst() ? true : false; - mIsOnlyOneItem = (cursor.getCount() == 1); + // 1. 基本位置判断 + mIsLastItem = cursor.isLast() ? true : false; // 是否是最后一项 + mIsFirstItem = cursor.isFirst() ? true : false; // 是否是第一项 + mIsOnlyOneItem = (cursor.getCount() == 1); // 是否是唯一一项 + + // 初始化文件夹后位置标志 mIsMultiNotesFollowingFolder = false; mIsOneNoteFollowingFolder = false; + // 2. 判断是否是文件夹后的便签 + // 条件：当前是便签类型 且 不是第一项 if (mType == Notes.TYPE_NOTE && !mIsFirstItem) { - int position = cursor.getPosition(); + int position = cursor.getPosition(); // 获取当前游标位置 + + // 向前移动游标检查前一项 if (cursor.moveToPrevious()) { + // 判断前一项是否是文件夹或系统文件夹 if (cursor.getInt(TYPE_COLUMN) == Notes.TYPE_FOLDER || cursor.getInt(TYPE_COLUMN) == Notes.TYPE_SYSTEM) { + // 判断后面是否还有更多项 if (cursor.getCount() > (position + 1)) { + // 文件夹后有多个便签 mIsMultiNotesFollowingFolder = true; } else { + // 文件夹后只有一个便签 mIsOneNoteFollowingFolder = true; } } + // 移动回原位置 if (!cursor.moveToNext()) { throw new IllegalStateException("cursor move to previous but can't move back"); } @@ -134,91 +209,199 @@ public class NoteItemData { } } + // ======================= 位置状态获取方法 ======================= + + /** + * 是否是文件夹后的唯一便签 + * 用于选择列表项背景：list_{color}_single + * @return true: 是文件夹后的唯一便签 + */ public boolean isOneFollowingFolder() { return mIsOneNoteFollowingFolder; } + /** + * 是否是文件夹后的多个便签之一 + * 用于选择列表项背景：list_{color}_middle + * @return true: 是文件夹后的多个便签之一 + */ public boolean isMultiFollowingFolder() { return mIsMultiNotesFollowingFolder; } + /** + * 是否是列表最后一项 + * 用于选择列表项背景：list_{color}_down + * @return true: 是最后一项 + */ public boolean isLast() { return mIsLastItem; } + /** + * 获取通话记录联系人姓名 + * 用于通话记录便签的显示 + * @return 联系人姓名，无联系人时返回电话号码 + */ public String getCallName() { return mName; } + /** + * 是否是列表第一项 + * 用于选择列表项背景：list_{color}_up + * @return true: 是第一项 + */ public boolean isFirst() { return mIsFirstItem; } + /** + * 是否是列表唯一项 + * 用于选择列表项背景：list_{color}_single + * @return true: 是唯一项 + */ public boolean isSingle() { return mIsOnlyOneItem; } + // ======================= 基本属性获取方法 ======================= + + /** + * 获取便签ID + * @return 便签ID + */ public long getId() { return mId; } + /** + * 获取提醒时间 + * @return 提醒时间戳，0表示无提醒 + */ public long getAlertDate() { return mAlertDate; } + /** + * 获取创建时间 + * @return 创建时间戳 + */ public long getCreatedDate() { return mCreatedDate; } + /** + * 是否包含附件 + * @return true: 包含附件 + */ public boolean hasAttachment() { return mHasAttachment; } + /** + * 获取修改时间 + * @return 修改时间戳 + */ public long getModifiedDate() { return mModifiedDate; } + /** + * 获取背景颜色ID + * @return 背景颜色索引 + */ public int getBgColorId() { return mBgColorId; } + /** + * 获取父文件夹ID + * @return 父文件夹ID + */ public long getParentId() { return mParentId; } + /** + * 获取包含的便签数 + * 仅对文件夹类型有效 + * @return 便签数量 + */ public int getNotesCount() { return mNotesCount; } + /** + * 获取文件夹ID（同getParentId） + * 用于语义化访问 + * @return 文件夹ID + */ public long getFolderId () { return mParentId; } + /** + * 获取便签类型 + * @return 类型常量：TYPE_NOTE, TYPE_FOLDER, TYPE_SYSTEM + */ public int getType() { return mType; } + /** + * 获取小部件类型 + * @return 小部件类型：TYPE_WIDGET_INVALIDE, TYPE_WIDGET_2X, TYPE_WIDGET_4X + */ public int getWidgetType() { return mWidgetType; } + /** + * 获取小部件ID + * @return 小部件ID + */ public int getWidgetId() { return mWidgetId; } + /** + * 获取便签摘要 + * 已清理清单标记 + * @return 便签摘要文本 + */ public String getSnippet() { return mSnippet; } + // ======================= 状态判断方法 ======================= + + /** + * 是否有提醒设置 + * @return true: 设置了提醒 + */ public boolean hasAlert() { return (mAlertDate > 0); } + /** + * 是否是通话记录 + * 判断条件：在通话记录文件夹中 且 有电话号码 + * @return true: 是通话记录 + */ public boolean isCallRecord() { return (mParentId == Notes.ID_CALL_RECORD_FOLDER && !TextUtils.isEmpty(mPhoneNumber)); } + // ======================= 静态工具方法 ======================= + + /** + * 从Cursor获取便签类型 + * 静态方法，无需创建对象 + * @param cursor 数据库游标 + * @return 便签类型 + */ public static int getNoteType(Cursor cursor) { return cursor.getInt(TYPE_COLUMN); } -} +} \ No newline at end of file diff --git a/src/notes/ui/NotesListActivity.java b/src/notes/ui/NotesListActivity.java index 25d374e..0081235 100644 --- a/src/notes/ui/NotesListActivity.java +++ b/src/notes/ui/NotesListActivity.java @@ -14,141 +14,220 @@ * limitations under the License. */ +// NotesListActivity.java - 便签列表主Activity +// 主要功能：显示便签和文件夹列表，提供便签管理、搜索、同步、导出等核心功能 package net.micode.notes.ui; -import android.app.Activity; -import android.app.AlertDialog; -import android.app.Dialog; -import android.appwidget.AppWidgetManager; -import android.content.AsyncQueryHandler; -import android.content.ContentResolver; -import android.content.ContentValues; -import android.content.Context; -import android.content.DialogInterface; -import android.content.Intent; -import android.content.SharedPreferences; -import android.database.Cursor; -import android.os.AsyncTask; -import android.os.Bundle; -import android.preference.PreferenceManager; -import android.text.Editable; -import android.text.TextUtils; -import android.text.TextWatcher; -import android.util.Log; -import android.view.ActionMode; -import android.view.ContextMenu; -import android.view.ContextMenu.ContextMenuInfo; -import android.view.Display; -import android.view.HapticFeedbackConstants; -import android.view.LayoutInflater; -import android.view.Menu; -import android.view.MenuItem; -import android.view.MenuItem.OnMenuItemClickListener; -import android.view.MotionEvent; -import android.view.View; -import android.view.View.OnClickListener; -import android.view.View.OnCreateContextMenuListener; -import android.view.View.OnTouchListener; -import android.view.inputmethod.InputMethodManager; -import android.widget.AdapterView; -import android.widget.AdapterView.OnItemClickListener; -import android.widget.AdapterView.OnItemLongClickListener; -import android.widget.Button; -import android.widget.EditText; -import android.widget.ListView; -import android.widget.PopupMenu; -import android.widget.TextView; -import android.widget.Toast; - -import net.micode.notes.R; -import net.micode.notes.data.Notes; -import net.micode.notes.data.Notes.NoteColumns; -import net.micode.notes.gtask.remote.GTaskSyncService; -import net.micode.notes.model.WorkingNote; -import net.micode.notes.tool.BackupUtils; -import net.micode.notes.tool.DataUtils; -import net.micode.notes.tool.ResourceParser; -import net.micode.notes.ui.NotesListAdapter.AppWidgetAttribute; -import net.micode.notes.widget.NoteWidgetProvider_2x; -import net.micode.notes.widget.NoteWidgetProvider_4x; - -import java.io.BufferedReader; -import java.io.IOException; -import java.io.InputStream; -import java.io.InputStreamReader; -import java.util.HashSet; - +// ======================= 导入区域 ======================= +// Android基础 +import android.app.Activity; // Activity基类 +import android.app.AlertDialog; // 警告对话框 +import android.app.Dialog; // 对话框 +import android.appwidget.AppWidgetManager; // 应用小部件管理器 +import android.content.AsyncQueryHandler; // 异步查询处理器 +import android.content.ContentResolver; // 内容解析器 +import android.content.ContentValues; // 内容值 +import android.content.Context; // 上下文 +import android.content.DialogInterface; // 对话框接口 +import android.content.Intent; // 意图 +import android.content.SharedPreferences; // 偏好设置 +import android.database.Cursor; // 数据库查询结果游标 +import android.os.AsyncTask; // 异步任务 +import android.os.Bundle; // 状态保存 +import android.preference.PreferenceManager; // 偏好设置管理器 +// Android文本处理 +import android.text.Editable; // 可编辑文本 +import android.text.TextUtils; // 文本工具 +import android.text.TextWatcher; // 文本监听器 +import android.util.Log; // 日志工具 +// Android视图 +import android.view.ActionMode; // 操作模式（多选模式） +import android.view.ContextMenu; // 上下文菜单 +import android.view.ContextMenu.ContextMenuInfo; // 上下文菜单信息 +import android.view.Display; // 显示信息 +import android.view.HapticFeedbackConstants; // 触觉反馈常量 +import android.view.LayoutInflater; // 布局加载器 +import android.view.Menu; // 菜单 +import android.view.MenuItem; // 菜单项 +import android.view.MenuItem.OnMenuItemClickListener; // 菜单项点击监听 +import android.view.MotionEvent; // 触摸事件 +import android.view.View; // 视图基类 +import android.view.View.OnClickListener; // 点击监听器 +import android.view.View.OnCreateContextMenuListener; // 上下文菜单创建监听 +import android.view.View.OnTouchListener; // 触摸监听器 +import android.view.inputmethod.InputMethodManager; // 输入法管理器 +// Android控件 +import android.widget.AdapterView; // 适配器视图 +import android.widget.AdapterView.OnItemClickListener; // 列表项点击监听 +import android.widget.AdapterView.OnItemLongClickListener; // 列表项长按监听 +import android.widget.Button; // 按钮 +import android.widget.EditText; // 编辑框 +import android.widget.ListView; // 列表视图 +import android.widget.PopupMenu; // 弹出菜单 +import android.widget.TextView; // 文本视图 +import android.widget.Toast; // 提示信息 + +// 应用内部资源 +import net.micode.notes.R; // 资源文件R类 +// 应用数据模型 +import net.micode.notes.data.Notes; // Notes主类 +import net.micode.notes.data.Notes.NoteColumns; // 便签表列定义 +// 应用同步服务 +import net.micode.notes.gtask.remote.GTaskSyncService; // Google任务同步服务 +// 应用业务模型 +import net.micode.notes.model.WorkingNote; // 工作便签模型 +// 应用工具 +import net.micode.notes.tool.BackupUtils; // 备份工具 +import net.micode.notes.tool.DataUtils; // 数据工具 +import net.micode.notes.tool.ResourceParser; // 资源解析器 +// 应用适配器 +import net.micode.notes.ui.NotesListAdapter.AppWidgetAttribute; // 小部件属性 +// 应用小部件 +import net.micode.notes.widget.NoteWidgetProvider_2x; // 2x小部件 +import net.micode.notes.widget.NoteWidgetProvider_4x; // 4x小部件 + +// Java IO +import java.io.BufferedReader; // 缓冲读取器 +import java.io.IOException; // IO异常 +import java.io.InputStream; // 输入流 +import java.io.InputStreamReader; // 输入流读取器 +// Java集合 +import java.util.HashSet; // 哈希集合 + +// ======================= 便签列表主Activity ======================= +/** + * NotesListActivity - 便签列表主Activity + * 继承自Activity，实现OnClickListener和OnItemLongClickListener + * 功能：应用的主界面，显示便签/文件夹列表，提供所有核心管理功能 + * 实现接口： + * OnClickListener: 处理按钮点击 + * OnItemLongClickListener: 处理列表项长按 + */ public class NotesListActivity extends Activity implements OnClickListener, OnItemLongClickListener { + + // ======================= 异步查询令牌常量 ======================= + + /** 文件夹便签列表查询令牌 - 查询指定文件夹下的便签 */ private static final int FOLDER_NOTE_LIST_QUERY_TOKEN = 0; + /** 文件夹列表查询令牌 - 查询所有文件夹（用于移动操作） */ private static final int FOLDER_LIST_QUERY_TOKEN = 1; - private static final int MENU_FOLDER_DELETE = 0; + // ======================= 上下文菜单项ID常量 ======================= - private static final int MENU_FOLDER_VIEW = 1; + private static final int MENU_FOLDER_DELETE = 0; // 删除文件夹 + private static final int MENU_FOLDER_VIEW = 1; // 查看文件夹 + private static final int MENU_FOLDER_CHANGE_NAME = 2; // 重命名文件夹 - private static final int MENU_FOLDER_CHANGE_NAME = 2; + // ======================= 偏好设置常量 ======================= + /** 应用介绍偏好键 - 标记是否已显示应用介绍 */ private static final String PREFERENCE_ADD_INTRODUCTION = "net.micode.notes.introduction"; + // ======================= 列表编辑状态枚举 ======================= + + /** + * ListEditState - 列表编辑状态枚举 + * 表示当前列表显示的内容类型 + */ private enum ListEditState { - NOTE_LIST, SUB_FOLDER, CALL_RECORD_FOLDER + NOTE_LIST, // 根目录便签列表 + SUB_FOLDER, // 子文件夹 + CALL_RECORD_FOLDER // 通话记录文件夹 }; + /** 当前列表状态 */ private ListEditState mState; + // ======================= 成员变量 ======================= + + /** 异步查询处理器 - 处理数据库异步查询 */ private BackgroundQueryHandler mBackgroundQueryHandler; + /** 便签列表适配器 - 管理列表数据显示 */ private NotesListAdapter mNotesListAdapter; + /** 便签列表视图 - 显示便签/文件夹列表 */ private ListView mNotesListView; + /** 新建便签按钮 */ private Button mAddNewNote; + /** 触摸事件分发标志 - 用于处理透明区域的触摸事件 */ private boolean mDispatch; + /** 触摸起始Y坐标 */ private int mOriginY; + /** 分发触摸事件Y坐标 */ private int mDispatchY; + /** 标题栏文本 - 显示当前文件夹名称 */ private TextView mTitleBar; + /** 当前文件夹ID - 表示当前显示的文件夹 */ private long mCurrentFolderId; + /** 内容解析器 - 用于访问ContentProvider */ private ContentResolver mContentResolver; + /** 多选模式回调 - 处理多选操作 */ private ModeCallback mModeCallBack; + /** 日志标签 */ private static final String TAG = "NotesListActivity"; + /** 列表视图滚动速率常量 */ public static final int NOTES_LISTVIEW_SCROLL_RATE = 30; + /** 当前焦点便签数据项 - 用于上下文菜单和长按操作 */ private NoteItemData mFocusNoteDataItem; + // ======================= 数据库查询条件常量 ======================= + + /** 普通文件夹查询条件 - 查询指定父文件夹下的便签 */ private static final String NORMAL_SELECTION = NoteColumns.PARENT_ID + "=?"; + /** 根文件夹查询条件 - 查询根目录下的便签和通话记录文件夹（如果有便签） */ private static final String ROOT_FOLDER_SELECTION = "(" + NoteColumns.TYPE + "<>" + Notes.TYPE_SYSTEM + " AND " + NoteColumns.PARENT_ID + "=?)" + " OR (" + NoteColumns.ID + "=" + Notes.ID_CALL_RECORD_FOLDER + " AND " + NoteColumns.NOTES_COUNT + ">0)"; + // ======================= 请求码常量 ======================= + + /** 打开便签请求码 */ private final static int REQUEST_CODE_OPEN_NODE = 102; + /** 新建便签请求码 */ private final static int REQUEST_CODE_NEW_NODE = 103; + // ======================= 生命周期方法 ======================= + + /** + * onCreate - Activity创建 + * 初始化界面和资源 + * @param savedInstanceState 保存的状态 + */ @Override protected void onCreate(Bundle savedInstanceState) { super.onCreate(savedInstanceState); + // 设置布局 setContentView(R.layout.note_list); + // 初始化资源 initResources(); /** - * Insert an introduction when user firstly use this application + * 用户首次使用应用时插入介绍便签 */ setAppInfoFromRawRes(); } + /** + * onActivityResult - 处理子Activity返回结果 + */ @Override protected void onActivityResult(int requestCode, int resultCode, Intent data) { + // 如果从便签编辑返回成功，刷新列表 if (resultCode == RESULT_OK && (requestCode == REQUEST_CODE_OPEN_NODE || requestCode == REQUEST_CODE_NEW_NODE)) { mNotesListAdapter.changeCursor(null); @@ -157,12 +236,20 @@ public class NotesListActivity extends Activity implements OnClickListener, OnIt } } + // ======================= 应用介绍初始化 ======================= + + /** + * 从Raw资源设置应用介绍 + * 首次启动时从R.raw.introduction读取介绍文本并创建便签 + */ private void setAppInfoFromRawRes() { SharedPreferences sp = PreferenceManager.getDefaultSharedPreferences(this); + // 检查是否已添加过介绍 if (!sp.getBoolean(PREFERENCE_ADD_INTRODUCTION, false)) { StringBuilder sb = new StringBuilder(); InputStream in = null; try { + // 读取Raw资源文件 in = getResources().openRawResource(R.raw.introduction); if (in != null) { InputStreamReader isr = new InputStreamReader(in); @@ -184,17 +271,18 @@ public class NotesListActivity extends Activity implements OnClickListener, OnIt try { in.close(); } catch (IOException e) { - // TODO Auto-generated catch block e.printStackTrace(); } } } + // 创建介绍便签 WorkingNote note = WorkingNote.createEmptyNote(this, Notes.ID_ROOT_FOLDER, AppWidgetManager.INVALID_APPWIDGET_ID, Notes.TYPE_WIDGET_INVALIDE, ResourceParser.RED); note.setWorkingText(sb.toString()); if (note.saveNote()) { + // 标记已添加介绍 sp.edit().putBoolean(PREFERENCE_ADD_INTRODUCTION, true).commit(); } else { Log.e(TAG, "Save introduction note error"); @@ -203,17 +291,28 @@ public class NotesListActivity extends Activity implements OnClickListener, OnIt } } + /** + * onStart - Activity开始 + * 开始异步查询便签列表 + */ @Override protected void onStart() { super.onStart(); startAsyncNotesListQuery(); } + // ======================= 资源初始化 ======================= + + /** + * 初始化资源 + * 查找视图引用，设置监听器 + */ private void initResources() { mContentResolver = this.getContentResolver(); mBackgroundQueryHandler = new BackgroundQueryHandler(this.getContentResolver()); - mCurrentFolderId = Notes.ID_ROOT_FOLDER; + mCurrentFolderId = Notes.ID_ROOT_FOLDER; // 默认为根文件夹 mNotesListView = (ListView) findViewById(R.id.notes_list); + // 添加列表脚部视图 mNotesListView.addFooterView(LayoutInflater.from(this).inflate(R.layout.note_list_footer, null), null, false); mNotesListView.setOnItemClickListener(new OnListItemClickListener()); @@ -227,19 +326,31 @@ public class NotesListActivity extends Activity implements OnClickListener, OnIt mDispatchY = 0; mOriginY = 0; mTitleBar = (TextView) findViewById(R.id.tv_title_bar); - mState = ListEditState.NOTE_LIST; - mModeCallBack = new ModeCallback(); + mState = ListEditState.NOTE_LIST; // 初始状态为便签列表 + mModeCallBack = new ModeCallback(); // 创建多选模式回调 } + // ======================= 多选模式回调类 ======================= + + /** + * ModeCallback - 多选模式回调类 + * 实现ListView.MultiChoiceModeListener接口 + * 处理便签多选操作 + */ private class ModeCallback implements ListView.MultiChoiceModeListener, OnMenuItemClickListener { - private DropdownMenu mDropDownMenu; - private ActionMode mActionMode; - private MenuItem mMoveMenu; + private DropdownMenu mDropDownMenu; // 下拉菜单 + private ActionMode mActionMode; // 当前操作模式 + private MenuItem mMoveMenu; // 移动菜单项 + /** + * 创建操作模式 + * 初始化多选菜单 + */ public boolean onCreateActionMode(ActionMode mode, Menu menu) { getMenuInflater().inflate(R.menu.note_list_options, menu); menu.findItem(R.id.delete).setOnMenuItemClickListener(this); mMoveMenu = menu.findItem(R.id.move); + // 根据条件显示/隐藏移动菜单 if (mFocusNoteDataItem.getParentId() == Notes.ID_CALL_RECORD_FOLDER || DataUtils.getUserFolderCount(mContentResolver) == 0) { mMoveMenu.setVisible(false); @@ -248,10 +359,11 @@ public class NotesListActivity extends Activity implements OnClickListener, OnIt mMoveMenu.setOnMenuItemClickListener(this); } mActionMode = mode; - mNotesListAdapter.setChoiceMode(true); - mNotesListView.setLongClickable(false); - mAddNewNote.setVisibility(View.GONE); + mNotesListAdapter.setChoiceMode(true); // 进入选择模式 + mNotesListView.setLongClickable(false); // 禁用长按 + mAddNewNote.setVisibility(View.GONE); // 隐藏新建按钮 + // 设置自定义视图（包含下拉菜单） View customView = LayoutInflater.from(NotesListActivity.this).inflate( R.layout.note_list_dropdown_menu, null); mode.setCustomView(customView); @@ -260,18 +372,22 @@ public class NotesListActivity extends Activity implements OnClickListener, OnIt R.menu.note_list_dropdown); mDropDownMenu.setOnDropdownMenuItemClickListener(new PopupMenu.OnMenuItemClickListener(){ public boolean onMenuItemClick(MenuItem item) { + // 全选/取消全选 mNotesListAdapter.selectAll(!mNotesListAdapter.isAllSelected()); updateMenu(); return true; } - }); return true; } + /** + * 更新菜单显示 + * 更新选中数量和全选状态 + */ private void updateMenu() { int selectedCount = mNotesListAdapter.getSelectedCount(); - // Update dropdown menu + // 更新下拉菜单标题 String format = getResources().getString(R.string.menu_select_title, selectedCount); mDropDownMenu.setTitle(format); MenuItem item = mDropDownMenu.findItem(R.id.action_select_all); @@ -286,32 +402,50 @@ public class NotesListActivity extends Activity implements OnClickListener, OnIt } } + /** + * 准备操作模式 + */ public boolean onPrepareActionMode(ActionMode mode, Menu menu) { - // TODO Auto-generated method stub return false; } + /** + * 操作项点击 + */ public boolean onActionItemClicked(ActionMode mode, MenuItem item) { - // TODO Auto-generated method stub return false; } + /** + * 销毁操作模式 + * 恢复列表正常状态 + */ public void onDestroyActionMode(ActionMode mode) { - mNotesListAdapter.setChoiceMode(false); - mNotesListView.setLongClickable(true); - mAddNewNote.setVisibility(View.VISIBLE); + mNotesListAdapter.setChoiceMode(false); // 退出选择模式 + mNotesListView.setLongClickable(true); // 启用长按 + mAddNewNote.setVisibility(View.VISIBLE); // 显示新建按钮 } + /** + * 结束操作模式 + */ public void finishActionMode() { mActionMode.finish(); } + /** + * 项选中状态变化 + * 更新菜单显示 + */ public void onItemCheckedStateChanged(ActionMode mode, int position, long id, boolean checked) { mNotesListAdapter.setCheckedItem(position, checked); updateMenu(); } + /** + * 菜单项点击处理 + */ public boolean onMenuItemClick(MenuItem item) { if (mNotesListAdapter.getSelectedCount() == 0) { Toast.makeText(NotesListActivity.this, getString(R.string.menu_select_none), @@ -321,6 +455,7 @@ public class NotesListActivity extends Activity implements OnClickListener, OnIt int itemId = item.getItemId(); if (itemId == R.id.delete) { + // 显示删除确认对话框 AlertDialog.Builder builder = new AlertDialog.Builder(NotesListActivity.this); builder.setTitle(getString(R.string.alert_title_delete)); builder.setIcon(android.R.drawable.ic_dialog_alert); @@ -336,6 +471,7 @@ public class NotesListActivity extends Activity implements OnClickListener, OnIt builder.setNegativeButton(android.R.string.cancel, null); builder.show(); } else if (itemId == R.id.move) { + // 查询目标文件夹 startQueryDestinationFolders(); } else { return false; @@ -344,6 +480,12 @@ public class NotesListActivity extends Activity implements OnClickListener, OnIt } } + // ======================= 新建便签按钮触摸监听 ======================= + + /** + * NewNoteOnTouchListener - 新建便签按钮触摸监听 + * 处理透明区域的触摸事件分发 + */ private class NewNoteOnTouchListener implements OnTouchListener { public boolean onTouch(View v, MotionEvent event) { @@ -355,20 +497,19 @@ public class NotesListActivity extends Activity implements OnClickListener, OnIt int start = screenHeight - newNoteViewHeight; int eventY = start + (int) event.getY(); /** - * Minus TitleBar's height + * 减去标题栏高度 + * 在子文件夹状态下，需要调整坐标 */ if (mState == ListEditState.SUB_FOLDER) { eventY -= mTitleBar.getHeight(); start -= mTitleBar.getHeight(); } /** - * HACKME:When click the transparent part of "New Note" button, dispatch - * the event to the list view behind this button. The transparent part of - * "New Note" button could be expressed by formula y=-0.12x+94（Unit:pixel） - * and the line top of the button. The coordinate based on left of the "New - * Note" button. The 94 represents maximum height of the transparent part. - * Notice that, if the background of the button changes, the formula should - * also change. This is very bad, just for the UI designer's strong requirement. + * HACKME: 当点击"新建便签"按钮的透明部分时，将事件分发到底层的列表视图 + * 透明部分由公式 y=-0.12x+94（像素单位）和按钮顶部线表示 + * 坐标基于"新建便签"按钮的左侧 + * 94表示透明部分的最大高度 + * 注意：如果按钮背景改变，公式也应改变 */ if (event.getY() < (event.getX() * (-0.12) + 94)) { View view = mNotesListView.getChildAt(mNotesListView.getChildCount() - 1 @@ -403,9 +544,13 @@ public class NotesListActivity extends Activity implements OnClickListener, OnIt } return false; } + } - }; + // ======================= 异步查询处理 ======================= + /** + * 开始异步便签列表查询 + */ private void startAsyncNotesListQuery() { String selection = (mCurrentFolderId == Notes.ID_ROOT_FOLDER) ? ROOT_FOLDER_SELECTION : NORMAL_SELECTION; @@ -415,6 +560,10 @@ public class NotesListActivity extends Activity implements OnClickListener, OnIt }, NoteColumns.TYPE + " DESC," + NoteColumns.MODIFIED_DATE + " DESC"); } + /** + * BackgroundQueryHandler - 异步查询处理器 + * 继承自AsyncQueryHandler + */ private final class BackgroundQueryHandler extends AsyncQueryHandler { public BackgroundQueryHandler(ContentResolver contentResolver) { super(contentResolver); @@ -424,9 +573,11 @@ public class NotesListActivity extends Activity implements OnClickListener, OnIt protected void onQueryComplete(int token, Object cookie, Cursor cursor) { switch (token) { case FOLDER_NOTE_LIST_QUERY_TOKEN: + // 更新便签列表适配器 mNotesListAdapter.changeCursor(cursor); break; case FOLDER_LIST_QUERY_TOKEN: + // 显示文件夹列表菜单 if (cursor != null && cursor.getCount() > 0) { showFolderListMenu(cursor); } else { @@ -439,13 +590,20 @@ public class NotesListActivity extends Activity implements OnClickListener, OnIt } } + // ======================= 文件夹列表菜单 ======================= + + /** + * 显示文件夹列表菜单 + * 用于移动便签到其他文件夹 + * @param cursor 文件夹数据游标 + */ private void showFolderListMenu(Cursor cursor) { AlertDialog.Builder builder = new AlertDialog.Builder(NotesListActivity.this); builder.setTitle(R.string.menu_title_select_folder); final FoldersListAdapter adapter = new FoldersListAdapter(this, cursor); builder.setAdapter(adapter, new DialogInterface.OnClickListener() { - public void onClick(DialogInterface dialog, int which) { + // 批量移动便签到选中文件夹 DataUtils.batchMoveToFolder(mContentResolver, mNotesListAdapter.getSelectedItemIds(), adapter.getItemId(which)); Toast.makeText( @@ -460,6 +618,11 @@ public class NotesListActivity extends Activity implements OnClickListener, OnIt builder.show(); } + // ======================= 新建便签 ======================= + + /** + * 创建新便签 + */ private void createNewNote() { Intent intent = new Intent(this, NoteEditActivity.class); intent.setAction(Intent.ACTION_INSERT_OR_EDIT); @@ -467,20 +630,26 @@ public class NotesListActivity extends Activity implements OnClickListener, OnIt this.startActivityForResult(intent, REQUEST_CODE_NEW_NODE); } + // ======================= 批量删除 ======================= + + /** + * 批量删除选中的便签 + */ private void batchDelete() { new AsyncTask>() { protected HashSet doInBackground(Void... unused) { + // 获取选中便签关联的小部件 HashSet widgets = mNotesListAdapter.getSelectedWidget(); if (!isSyncMode()) { - // if not synced, delete notes directly + // 非同步模式：直接删除 if (DataUtils.batchDeleteNotes(mContentResolver, mNotesListAdapter .getSelectedItemIds())) { + // 删除成功 } else { Log.e(TAG, "Delete notes error, should not happens"); } } else { - // in sync mode, we'll move the deleted note into the trash - // folder + // 同步模式：移动到回收站 if (!DataUtils.batchMoveToFolder(mContentResolver, mNotesListAdapter .getSelectedItemIds(), Notes.ID_TRASH_FOLER)) { Log.e(TAG, "Move notes to trash folder error, should not happens"); @@ -491,6 +660,7 @@ public class NotesListActivity extends Activity implements OnClickListener, OnIt @Override protected void onPostExecute(HashSet widgets) { + // 更新关联的小部件 if (widgets != null) { for (AppWidgetAttribute widget : widgets) { if (widget.widgetId != AppWidgetManager.INVALID_APPWIDGET_ID @@ -504,6 +674,12 @@ public class NotesListActivity extends Activity implements OnClickListener, OnIt }.execute(); } + // ======================= 删除文件夹 ======================= + + /** + * 删除文件夹 + * @param folderId 文件夹ID + */ private void deleteFolder(long folderId) { if (folderId == Notes.ID_ROOT_FOLDER) { Log.e(TAG, "Wrong folder id, should not happen " + folderId); @@ -512,15 +688,17 @@ public class NotesListActivity extends Activity implements OnClickListener, OnIt HashSet ids = new HashSet(); ids.add(folderId); + // 获取文件夹关联的小部件 HashSet widgets = DataUtils.getFolderNoteWidget(mContentResolver, folderId); if (!isSyncMode()) { - // if not synced, delete folder directly + // 非同步模式：直接删除 DataUtils.batchDeleteNotes(mContentResolver, ids); } else { - // in sync mode, we'll move the deleted folder into the trash folder + // 同步模式：移动到回收站 DataUtils.batchMoveToFolder(mContentResolver, ids, Notes.ID_TRASH_FOLER); } + // 更新小部件 if (widgets != null) { for (AppWidgetAttribute widget : widgets) { if (widget.widgetId != AppWidgetManager.INVALID_APPWIDGET_ID @@ -531,6 +709,12 @@ public class NotesListActivity extends Activity implements OnClickListener, OnIt } } + // ======================= 打开便签 ======================= + + /** + * 打开便签 + * @param data 便签数据 + */ private void openNode(NoteItemData data) { Intent intent = new Intent(this, NoteEditActivity.class); intent.setAction(Intent.ACTION_VIEW); @@ -538,15 +722,22 @@ public class NotesListActivity extends Activity implements OnClickListener, OnIt this.startActivityForResult(intent, REQUEST_CODE_OPEN_NODE); } + // ======================= 打开文件夹 ======================= + + /** + * 打开文件夹 + * @param data 文件夹数据 + */ private void openFolder(NoteItemData data) { mCurrentFolderId = data.getId(); - startAsyncNotesListQuery(); + startAsyncNotesListQuery(); // 查询文件夹内容 if (data.getId() == Notes.ID_CALL_RECORD_FOLDER) { mState = ListEditState.CALL_RECORD_FOLDER; - mAddNewNote.setVisibility(View.GONE); + mAddNewNote.setVisibility(View.GONE); // 通话记录文件夹不显示新建按钮 } else { mState = ListEditState.SUB_FOLDER; } + // 设置标题 if (data.getId() == Notes.ID_CALL_RECORD_FOLDER) { mTitleBar.setText(R.string.call_record_folder_name); } else { @@ -555,6 +746,12 @@ public class NotesListActivity extends Activity implements OnClickListener, OnIt mTitleBar.setVisibility(View.VISIBLE); } + // ======================= 点击事件处理 ======================= + + /** + * onClick - 视图点击处理 + * 实现OnClickListener接口 + */ public void onClick(View v) { int viewId = v.getId(); if (viewId == R.id.btn_new_note) { @@ -562,6 +759,11 @@ public class NotesListActivity extends Activity implements OnClickListener, OnIt } } + // ======================= 输入法控制 ======================= + + /** + * 显示软键盘 + */ private void showSoftInput() { InputMethodManager inputMethodManager = (InputMethodManager) getSystemService(Context.INPUT_METHOD_SERVICE); if (inputMethodManager != null) { @@ -569,17 +771,27 @@ public class NotesListActivity extends Activity implements OnClickListener, OnIt } } + /** + * 隐藏软键盘 + */ private void hideSoftInput(View view) { InputMethodManager inputMethodManager = (InputMethodManager) getSystemService(Context.INPUT_METHOD_SERVICE); inputMethodManager.hideSoftInputFromWindow(view.getWindowToken(), 0); } + // ======================= 创建/修改文件夹对话框 ======================= + + /** + * 显示创建或修改文件夹对话框 + * @param create true: 创建文件夹; false: 修改文件夹名称 + */ private void showCreateOrModifyFolderDialog(final boolean create) { final AlertDialog.Builder builder = new AlertDialog.Builder(this); View view = LayoutInflater.from(this).inflate(R.layout.dialog_edit_text, null); final EditText etName = (EditText) view.findViewById(R.id.et_foler_name); - showSoftInput(); + showSoftInput(); // 显示软键盘 if (!create) { + // 修改文件夹名称 if (mFocusNoteDataItem != null) { etName.setText(mFocusNoteDataItem.getSnippet()); builder.setTitle(getString(R.string.menu_folder_change_name)); @@ -588,6 +800,7 @@ public class NotesListActivity extends Activity implements OnClickListener, OnIt return; } } else { + // 创建新文件夹 etName.setText(""); builder.setTitle(this.getString(R.string.menu_create_folder)); } @@ -605,6 +818,7 @@ public class NotesListActivity extends Activity implements OnClickListener, OnIt public void onClick(View v) { hideSoftInput(etName); String name = etName.getText().toString(); + // 检查文件夹名称是否已存在 if (DataUtils.checkVisibleFolderName(mContentResolver, name)) { Toast.makeText(NotesListActivity.this, getString(R.string.folder_exist, name), Toast.LENGTH_LONG).show(); @@ -612,6 +826,7 @@ public class NotesListActivity extends Activity implements OnClickListener, OnIt return; } if (!create) { + // 修改文件夹名称 if (!TextUtils.isEmpty(name)) { ContentValues values = new ContentValues(); values.put(NoteColumns.SNIPPET, name); @@ -623,6 +838,7 @@ public class NotesListActivity extends Activity implements OnClickListener, OnIt }); } } else if (!TextUtils.isEmpty(name)) { + // 创建新文件夹 ContentValues values = new ContentValues(); values.put(NoteColumns.SNIPPET, name); values.put(NoteColumns.TYPE, Notes.TYPE_FOLDER); @@ -632,16 +848,15 @@ public class NotesListActivity extends Activity implements OnClickListener, OnIt } }); + // 初始状态：名称为空时禁用确定按钮 if (TextUtils.isEmpty(etName.getText())) { positive.setEnabled(false); } /** - * When the name edit text is null, disable the positive button + * 当名称编辑文本为空时，禁用确定按钮 */ etName.addTextChangedListener(new TextWatcher() { public void beforeTextChanged(CharSequence s, int start, int count, int after) { - // TODO Auto-generated method stub - } public void onTextChanged(CharSequence s, int start, int before, int count) { @@ -653,22 +868,28 @@ public class NotesListActivity extends Activity implements OnClickListener, OnIt } public void afterTextChanged(Editable s) { - // TODO Auto-generated method stub - } }); } + // ======================= 返回键处理 ======================= + + /** + * 返回键处理 + * 根据当前状态返回上一级 + */ @Override public void onBackPressed() { switch (mState) { case SUB_FOLDER: + // 子文件夹返回根目录 mCurrentFolderId = Notes.ID_ROOT_FOLDER; mState = ListEditState.NOTE_LIST; startAsyncNotesListQuery(); mTitleBar.setVisibility(View.GONE); break; case CALL_RECORD_FOLDER: + // 通话记录文件夹返回根目录 mCurrentFolderId = Notes.ID_ROOT_FOLDER; mState = ListEditState.NOTE_LIST; mAddNewNote.setVisibility(View.VISIBLE); @@ -676,6 +897,7 @@ public class NotesListActivity extends Activity implements OnClickListener, OnIt startAsyncNotesListQuery(); break; case NOTE_LIST: + // 根目录直接退出Activity super.onBackPressed(); break; default: @@ -683,6 +905,13 @@ public class NotesListActivity extends Activity implements OnClickListener, OnIt } } + // ======================= 更新小部件 ======================= + + /** + * 更新小部件 + * @param appWidgetId 小部件ID + * @param appWidgetType 小部件类型 + */ private void updateWidget(int appWidgetId, int appWidgetType) { Intent intent = new Intent(AppWidgetManager.ACTION_APPWIDGET_UPDATE); if (appWidgetType == Notes.TYPE_WIDGET_2X) { @@ -702,6 +931,11 @@ public class NotesListActivity extends Activity implements OnClickListener, OnIt setResult(RESULT_OK, intent); } + // ======================= 文件夹上下文菜单监听 ======================= + + /** + * 文件夹上下文菜单创建监听器 + */ private final OnCreateContextMenuListener mFolderOnCreateContextMenuListener = new OnCreateContextMenuListener() { public void onCreateContextMenu(ContextMenu menu, View v, ContextMenuInfo menuInfo) { if (mFocusNoteDataItem != null) { @@ -713,6 +947,9 @@ public class NotesListActivity extends Activity implements OnClickListener, OnIt } }; + /** + * 上下文菜单关闭 + */ @Override public void onContextMenuClosed(Menu menu) { if (mNotesListView != null) { @@ -721,6 +958,9 @@ public class NotesListActivity extends Activity implements OnClickListener, OnIt super.onContextMenuClosed(menu); } + /** + * 上下文菜单项选择 + */ @Override public boolean onContextItemSelected(MenuItem item) { if (mFocusNoteDataItem == null) { @@ -749,12 +989,18 @@ public class NotesListActivity extends Activity implements OnClickListener, OnIt return true; } + // ======================= 选项菜单处理 ======================= + + /** + * 准备选项菜单 + * 根据当前状态加载不同的菜单 + */ @Override public boolean onPrepareOptionsMenu(Menu menu) { menu.clear(); if (mState == ListEditState.NOTE_LIST) { getMenuInflater().inflate(R.menu.note_list, menu); - // set sync or sync_cancel + // 根据同步状态设置菜单文本 menu.findItem(R.id.menu_sync).setTitle( GTaskSyncService.isSyncing() ? R.string.menu_sync_cancel : R.string.menu_sync); } else if (mState == ListEditState.SUB_FOLDER) { @@ -767,6 +1013,9 @@ public class NotesListActivity extends Activity implements OnClickListener, OnIt return true; } + /** + * 选项菜单项选择 + */ @Override public boolean onOptionsItemSelected(MenuItem item) { int itemId = item.getItemId(); @@ -794,16 +1043,25 @@ public class NotesListActivity extends Activity implements OnClickListener, OnIt return true; } + // ======================= 搜索请求 ======================= + + /** + * 搜索请求 + */ @Override public boolean onSearchRequested() { startSearch(null, false, null /* appData */, false); return true; } + // ======================= 导出便签到文本 ======================= + + /** + * 导出便签到文本文件 + */ private void exportNoteToText() { final BackupUtils backup = BackupUtils.getInstance(NotesListActivity.this); new AsyncTask() { - @Override protected Integer doInBackground(Void... unused) { return backup.exportToText(); @@ -812,6 +1070,7 @@ public class NotesListActivity extends Activity implements OnClickListener, OnIt @Override protected void onPostExecute(Integer result) { if (result == BackupUtils.STATE_SD_CARD_UNMOUONTED) { + // SD卡未挂载 AlertDialog.Builder builder = new AlertDialog.Builder(NotesListActivity.this); builder.setTitle(NotesListActivity.this .getString(R.string.failed_sdcard_export)); @@ -820,6 +1079,7 @@ public class NotesListActivity extends Activity implements OnClickListener, OnIt builder.setPositiveButton(android.R.string.ok, null); builder.show(); } else if (result == BackupUtils.STATE_SUCCESS) { + // 导出成功 AlertDialog.Builder builder = new AlertDialog.Builder(NotesListActivity.this); builder.setTitle(NotesListActivity.this .getString(R.string.success_sdcard_export)); @@ -829,6 +1089,7 @@ public class NotesListActivity extends Activity implements OnClickListener, OnIt builder.setPositiveButton(android.R.string.ok, null); builder.show(); } else if (result == BackupUtils.STATE_SYSTEM_ERROR) { + // 系统错误 AlertDialog.Builder builder = new AlertDialog.Builder(NotesListActivity.this); builder.setTitle(NotesListActivity.this .getString(R.string.failed_sdcard_export)); @@ -838,25 +1099,40 @@ public class NotesListActivity extends Activity implements OnClickListener, OnIt builder.show(); } } - }.execute(); } + // ======================= 同步模式判断 ======================= + + /** + * 判断是否为同步模式 + * @return true: 已设置同步账户; false: 未设置 + */ private boolean isSyncMode() { return NotesPreferenceActivity.getSyncAccountName(this).trim().length() > 0; } + // ======================= 启动设置Activity ======================= + + /** + * 启动设置Activity + */ private void startPreferenceActivity() { Activity from = getParent() != null ? getParent() : this; Intent intent = new Intent(from, NotesPreferenceActivity.class); from.startActivityIfNeeded(intent, -1); } - private class OnListItemClickListener implements OnItemClickListener { + // ======================= 列表项点击监听 ======================= + /** + * OnListItemClickListener - 列表项点击监听 + */ + private class OnListItemClickListener implements OnItemClickListener { public void onItemClick(AdapterView parent, View view, int position, long id) { if (view instanceof NotesListItem) { NoteItemData item = ((NotesListItem) view).getItemData(); + // 如果在选择模式中 if (mNotesListAdapter.isInChoiceMode()) { if (item.getType() == Notes.TYPE_NOTE) { position = position - mNotesListView.getHeaderViewsCount(); @@ -866,6 +1142,7 @@ public class NotesListActivity extends Activity implements OnClickListener, OnIt return; } + // 根据状态处理点击 switch (mState) { case NOTE_LIST: if (item.getType() == Notes.TYPE_FOLDER @@ -890,9 +1167,14 @@ public class NotesListActivity extends Activity implements OnClickListener, OnIt } } } - } + // ======================= 查询目标文件夹 ======================= + + /** + * 开始查询目标文件夹 + * 用于移动操作 + */ private void startQueryDestinationFolders() { String selection = NoteColumns.TYPE + "=? AND " + NoteColumns.PARENT_ID + "<>? AND " + NoteColumns.ID + "<>?"; selection = (mState == ListEditState.NOTE_LIST) ? selection: @@ -911,9 +1193,16 @@ public class NotesListActivity extends Activity implements OnClickListener, OnIt NoteColumns.MODIFIED_DATE + " DESC"); } + // ======================= 列表项长按监听 ======================= + + /** + * onItemLongClick - 列表项长按处理 + * 实现OnItemLongClickListener接口 + */ public boolean onItemLongClick(AdapterView parent, View view, int position, long id) { if (view instanceof NotesListItem) { mFocusNoteDataItem = ((NotesListItem) view).getItemData(); + // 便签长按：启动多选模式 if (mFocusNoteDataItem.getType() == Notes.TYPE_NOTE && !mNotesListAdapter.isInChoiceMode()) { if (mNotesListView.startActionMode(mModeCallBack) != null) { mModeCallBack.onItemCheckedStateChanged(null, position, id, true); @@ -922,6 +1211,7 @@ public class NotesListActivity extends Activity implements OnClickListener, OnIt Log.e(TAG, "startActionMode fails"); } } else if (mFocusNoteDataItem.getType() == Notes.TYPE_FOLDER) { + // 文件夹长按：显示上下文菜单 mNotesListView.setOnCreateContextMenuListener(mFolderOnCreateContextMenuListener); } } diff --git a/src/notes/ui/NotesListAdapter.java b/src/notes/ui/NotesListAdapter.java index 51c9cb9..f9e6342 100644 --- a/src/notes/ui/NotesListAdapter.java +++ b/src/notes/ui/NotesListAdapter.java @@ -14,74 +14,159 @@ * limitations under the License. */ +// NotesListAdapter.java - 便签列表适配器 +// 主要功能：为便签列表提供数据适配，支持多选模式和选中状态管理 package net.micode.notes.ui; -import android.content.Context; -import android.database.Cursor; -import android.util.Log; -import android.view.View; -import android.view.ViewGroup; -import android.widget.CursorAdapter; +// ======================= 导入区域 ======================= +// Android基础 +import android.content.Context; // 上下文 +import android.database.Cursor; // 数据库查询结果游标 +import android.util.Log; // 日志工具 +// Android视图 +import android.view.View; // 视图基类 +import android.view.ViewGroup; // 视图容器 +// Android适配器 +import android.widget.CursorAdapter; // 游标适配器基类 -import net.micode.notes.data.Notes; - -import java.util.Collection; -import java.util.HashMap; -import java.util.HashSet; -import java.util.Iterator; +// 应用数据模型 +import net.micode.notes.data.Notes; // Notes主类 +// Java集合 +import java.util.Collection; // 集合接口 +import java.util.HashMap; // 哈希映射 +import java.util.HashSet; // 哈希集合 +import java.util.Iterator; // 迭代器 +// ======================= 便签列表适配器 ======================= +/** + * NotesListAdapter - 便签列表适配器 + * 继承自CursorAdapter，用于在ListView中显示便签和文件夹列表 + * 核心功能： + * 1. 便签列表数据绑定 + * 2. 多选模式支持 + * 3. 选中状态管理 + * 4. 小部件关联管理 + */ public class NotesListAdapter extends CursorAdapter { - private static final String TAG = "NotesListAdapter"; + + // ======================= 常量定义 ======================= + + private static final String TAG = "NotesListAdapter"; // 日志标签 + + // ======================= 成员变量 ======================= + + /** 上下文 */ private Context mContext; + + /** 选中索引映射 - 存储列表位置与选中状态的映射 */ private HashMap mSelectedIndex; + + /** 便签总数 - 不包括文件夹，用于全选判断 */ private int mNotesCount; + + /** 选择模式标志 - true: 多选模式; false: 普通模式 */ private boolean mChoiceMode; + // ======================= 小部件属性内部类 ======================= + + /** + * AppWidgetAttribute - 应用小部件属性内部类 + * 用于存储便签关联的小部件信息 + */ public static class AppWidgetAttribute { - public int widgetId; - public int widgetType; + public int widgetId; // 小部件ID + public int widgetType; // 小部件类型 }; + // ======================= 构造函数 ======================= + + /** + * 构造函数 + * 初始化适配器 + * @param context 上下文 + */ public NotesListAdapter(Context context) { - super(context, null); + super(context, null); // 初始游标为null mSelectedIndex = new HashMap(); mContext = context; - mNotesCount = 0; + mNotesCount = 0; // 初始便签数为0 } + // ======================= 适配器核心方法 ======================= + + /** + * 创建新视图 + * 当ListView需要新的列表项视图时调用 + * @param context 上下文 + * @param cursor 当前位置的数据库游标 + * @param parent 父视图容器（ListView） + * @return 新创建的NotesListItem视图 + */ @Override public View newView(Context context, Cursor cursor, ViewGroup parent) { return new NotesListItem(context); } + /** + * 绑定数据到视图 + * 将指定位置的数据库数据绑定到列表项视图 + * @param view 要绑定数据的视图 + * @param context 上下文 + * @param cursor 当前位置的数据库游标 + */ @Override public void bindView(View view, Context context, Cursor cursor) { if (view instanceof NotesListItem) { + // 创建便签数据项 NoteItemData itemData = new NoteItemData(context, cursor); + // 绑定数据到列表项 ((NotesListItem) view).bind(context, itemData, mChoiceMode, isSelectedItem(cursor.getPosition())); } } + // ======================= 选择模式管理 ======================= + + /** + * 设置项选中状态 + * 在多选模式下标记或取消标记项 + * @param position 列表位置 + * @param checked 选中状态（true: 选中; false: 取消选中） + */ public void setCheckedItem(final int position, final boolean checked) { mSelectedIndex.put(position, checked); - notifyDataSetChanged(); + notifyDataSetChanged(); // 通知视图更新 } + /** + * 是否在选择模式中 + * @return true: 在多选模式中; false: 在普通模式中 + */ public boolean isInChoiceMode() { return mChoiceMode; } + /** + * 设置选择模式 + * 进入或退出多选模式 + * @param mode 模式标志（true: 进入多选模式; false: 退出多选模式） + */ public void setChoiceMode(boolean mode) { - mSelectedIndex.clear(); + mSelectedIndex.clear(); // 清除所有选中状态 mChoiceMode = mode; } + /** + * 全选/取消全选 + * 选择或取消选择所有便签（不包括文件夹） + * @param checked 全选状态（true: 全选; false: 取消全选） + */ public void selectAll(boolean checked) { Cursor cursor = getCursor(); for (int i = 0; i < getCount(); i++) { if (cursor.moveToPosition(i)) { + // 只选择便签类型，不选择文件夹 if (NoteItemData.getNoteType(cursor) == Notes.TYPE_NOTE) { setCheckedItem(i, checked); } @@ -89,11 +174,19 @@ public class NotesListAdapter extends CursorAdapter { } } + // ======================= 选中项ID获取 ======================= + + /** + * 获取选中项的ID集合 + * 用于批量操作（删除、移动等） + * @return 选中项的ID集合 + */ public HashSet getSelectedItemIds() { HashSet itemSet = new HashSet(); for (Integer position : mSelectedIndex.keySet()) { if (mSelectedIndex.get(position) == true) { Long id = getItemId(position); + // 安全检查：排除根文件夹 if (id == Notes.ID_ROOT_FOLDER) { Log.d(TAG, "Wrong item id, should not happen"); } else { @@ -101,10 +194,16 @@ public class NotesListAdapter extends CursorAdapter { } } } - return itemSet; } + // ======================= 选中项小部件获取 ======================= + + /** + * 获取选中项的小部件属性集合 + * 用于批量操作后更新关联的小部件 + * @return 小部件属性集合 + */ public HashSet getSelectedWidget() { HashSet itemSet = new HashSet(); for (Integer position : mSelectedIndex.keySet()) { @@ -117,7 +216,8 @@ public class NotesListAdapter extends CursorAdapter { widget.widgetType = item.getWidgetType(); itemSet.add(widget); /** - * Don't close cursor here, only the adapter could close it + * 注意：不要在此处关闭游标 + * 只有适配器可以关闭游标 */ } else { Log.e(TAG, "Invalid cursor"); @@ -128,6 +228,12 @@ public class NotesListAdapter extends CursorAdapter { return itemSet; } + // ======================= 选中计数 ======================= + + /** + * 获取选中项数量 + * @return 选中项的数量 + */ public int getSelectedCount() { Collection values = mSelectedIndex.values(); if (null == values) { @@ -143,11 +249,21 @@ public class NotesListAdapter extends CursorAdapter { return count; } + /** + * 是否全选 + * 判断所有便签是否都被选中 + * @return true: 所有便签都被选中; false: 有便签未选中 + */ public boolean isAllSelected() { int checkedCount = getSelectedCount(); return (checkedCount != 0 && checkedCount == mNotesCount); } + /** + * 判断指定位置项是否被选中 + * @param position 列表位置 + * @return true: 被选中; false: 未选中 + */ public boolean isSelectedItem(final int position) { if (null == mSelectedIndex.get(position)) { return false; @@ -155,23 +271,41 @@ public class NotesListAdapter extends CursorAdapter { return mSelectedIndex.get(position); } + // ======================= 数据变化处理 ======================= + + /** + * 内容变化回调 + * 当数据变化时重新计算便签数量 + */ @Override protected void onContentChanged() { super.onContentChanged(); - calcNotesCount(); + calcNotesCount(); // 重新计算便签数 } + /** + * 切换游标 + * 切换数据源时重新计算便签数量 + * @param cursor 新游标 + */ @Override public void changeCursor(Cursor cursor) { super.changeCursor(cursor); - calcNotesCount(); + calcNotesCount(); // 重新计算便签数 } + // ======================= 便签数量计算 ======================= + + /** + * 计算便签数量 + * 遍历游标，统计TYPE_NOTE类型的数量 + */ private void calcNotesCount() { - mNotesCount = 0; + mNotesCount = 0; // 重置计数 for (int i = 0; i < getCount(); i++) { Cursor c = (Cursor) getItem(i); if (c != null) { + // 只统计便签类型，不统计文件夹 if (NoteItemData.getNoteType(c) == Notes.TYPE_NOTE) { mNotesCount++; } @@ -181,4 +315,4 @@ public class NotesListAdapter extends CursorAdapter { } } } -} +} \ No newline at end of file diff --git a/src/notes/ui/NotesListItem.java b/src/notes/ui/NotesListItem.java index 1221e80..342f1f5 100644 --- a/src/notes/ui/NotesListItem.java +++ b/src/notes/ui/NotesListItem.java @@ -14,33 +14,75 @@ * limitations under the License. */ +// NotesListItem.java - 便签列表项自定义视图 +// 主要功能：显示便签或文件夹列表项的完整视图，包括图标、文本、时间等 package net.micode.notes.ui; -import android.content.Context; -import android.text.format.DateUtils; -import android.view.View; -import android.widget.CheckBox; -import android.widget.ImageView; -import android.widget.LinearLayout; -import android.widget.TextView; - -import net.micode.notes.R; -import net.micode.notes.data.Notes; -import net.micode.notes.tool.DataUtils; -import net.micode.notes.tool.ResourceParser.NoteItemBgResources; +// ======================= 导入区域 ======================= +// Android基础 +import android.content.Context; // 上下文 +import android.text.format.DateUtils; // 日期工具，用于相对时间显示 +// Android视图 +import android.view.View; // 视图基类 +// Android控件 +import android.widget.CheckBox; // 复选框 +import android.widget.ImageView; // 图片视图 +import android.widget.LinearLayout; // 线性布局容器 +import android.widget.TextView; // 文本视图 +// 应用内部资源 +import net.micode.notes.R; // 资源文件R类 +// 应用数据模型 +import net.micode.notes.data.Notes; // Notes主类 +// 应用工具 +import net.micode.notes.tool.DataUtils; // 数据工具 +// 应用资源解析 +import net.micode.notes.tool.ResourceParser.NoteItemBgResources; // 列表项背景资源 +// ======================= 便签列表项视图 ======================= +/** + * NotesListItem - 便签列表项自定义视图 + * 继承自LinearLayout，表示便签列表中的单个项 + * 功能：显示便签/文件夹的完整信息，包括标题、时间、图标、背景等 + * 职责：数据绑定、视图更新、背景选择 + */ public class NotesListItem extends LinearLayout { + + // ======================= 成员变量 ======================= + + /** 提醒图标 - 显示便签是否有提醒 */ private ImageView mAlert; + + /** 标题文本 - 显示便签摘要或文件夹名称 */ private TextView mTitle; + + /** 时间文本 - 显示修改时间（相对时间） */ private TextView mTime; + + /** 联系人姓名文本 - 通话记录专用，显示联系人姓名 */ private TextView mCallName; + + /** 便签数据项 - 当前项绑定的数据 */ private NoteItemData mItemData; + + /** 复选框 - 多选模式下显示，用于选择操作 */ private CheckBox mCheckBox; + // ======================= 构造函数 ======================= + + /** + * 构造函数 + * 初始化列表项视图，加载布局并查找子视图 + * @param context 上下文 + */ public NotesListItem(Context context) { super(context); + // 1. 加载布局文件 + // R.layout.note_item: 列表项布局 + // 第三个参数true: 将布局添加到当前LinearLayout inflate(context, R.layout.note_item, this); + + // 2. 查找并保存子视图引用 mAlert = (ImageView) findViewById(R.id.iv_alert_icon); mTitle = (TextView) findViewById(R.id.tv_title); mTime = (TextView) findViewById(R.id.tv_time); @@ -48,75 +90,178 @@ public class NotesListItem extends LinearLayout { mCheckBox = (CheckBox) findViewById(android.R.id.checkbox); } + // ======================= 数据绑定方法 ======================= + + /** + * 绑定数据到视图 + * 根据便签数据类型和状态更新所有UI元素 + * 绑定流程： + * 1. 处理选择模式复选框 + * 2. 根据便签类型设置不同显示 + * 3. 更新标题、时间、图标 + * 4. 设置合适的背景 + * + * @param context 上下文，用于获取资源和字符串 + * @param data 便签数据项 + * @param choiceMode 是否在选择模式中 + * @param checked 该项是否被选中 + */ public void bind(Context context, NoteItemData data, boolean choiceMode, boolean checked) { + // 1. 处理选择模式复选框 if (choiceMode && data.getType() == Notes.TYPE_NOTE) { + // 选择模式且是便签类型：显示复选框 mCheckBox.setVisibility(View.VISIBLE); mCheckBox.setChecked(checked); } else { + // 非选择模式或非便签类型：隐藏复选框 mCheckBox.setVisibility(View.GONE); } + // 保存数据引用 mItemData = data; + + // 2. 根据便签类型设置不同显示 if (data.getId() == Notes.ID_CALL_RECORD_FOLDER) { - mCallName.setVisibility(View.GONE); - mAlert.setVisibility(View.VISIBLE); - mTitle.setTextAppearance(context, R.style.TextAppearancePrimaryItem); - mTitle.setText(context.getString(R.string.call_record_folder_name) - + context.getString(R.string.format_folder_files_count, data.getNotesCount())); - mAlert.setImageResource(R.drawable.call_record); + // 情况1：通话记录文件夹 + bindCallRecordFolder(context, data); } else if (data.getParentId() == Notes.ID_CALL_RECORD_FOLDER) { - mCallName.setVisibility(View.VISIBLE); - mCallName.setText(data.getCallName()); - mTitle.setTextAppearance(context,R.style.TextAppearanceSecondaryItem); + // 情况2：通话记录文件夹中的便签 + bindCallRecordNote(context, data); + } else { + // 情况3：普通文件夹或便签 + bindNormalItem(context, data); + } + + // 3. 更新时间显示（所有类型都显示） + mTime.setText(DateUtils.getRelativeTimeSpanString(data.getModifiedDate())); + + // 4. 设置背景 + setBackground(data); + } + + // ======================= 通话记录文件夹绑定 ======================= + + /** + * 绑定通话记录文件夹 + * 特殊显示：文件夹图标 + 便签数量 + * @param context 上下文 + * @param data 文件夹数据 + */ + private void bindCallRecordFolder(Context context, NoteItemData data) { + // 隐藏联系人姓名 + mCallName.setVisibility(View.GONE); + // 显示提醒图标（文件夹图标） + mAlert.setVisibility(View.VISIBLE); + // 设置主标题样式 + mTitle.setTextAppearance(context, R.style.TextAppearancePrimaryItem); + // 设置标题文本：文件夹名称 + 文件数量 + mTitle.setText(context.getString(R.string.call_record_folder_name) + + context.getString(R.string.format_folder_files_count, data.getNotesCount())); + // 设置文件夹图标 + mAlert.setImageResource(R.drawable.call_record); + } + + // ======================= 通话记录便签绑定 ======================= + + /** + * 绑定通话记录便签 + * 特殊显示：联系人姓名 + 提醒图标 + * @param context 上下文 + * @param data 便签数据 + */ + private void bindCallRecordNote(Context context, NoteItemData data) { + // 显示联系人姓名 + mCallName.setVisibility(View.VISIBLE); + mCallName.setText(data.getCallName()); + // 设置副标题样式 + mTitle.setTextAppearance(context,R.style.TextAppearanceSecondaryItem); + // 设置标题文本（格式化摘要） + mTitle.setText(DataUtils.getFormattedSnippet(data.getSnippet())); + // 根据是否有提醒设置图标 + if (data.hasAlert()) { + mAlert.setImageResource(R.drawable.clock); + mAlert.setVisibility(View.VISIBLE); + } else { + mAlert.setVisibility(View.GONE); + } + } + + // ======================= 普通项绑定 ======================= + + /** + * 绑定普通文件夹或便签 + * 通用显示逻辑 + * @param context 上下文 + * @param data 便签/文件夹数据 + */ + private void bindNormalItem(Context context, NoteItemData data) { + // 隐藏联系人姓名 + mCallName.setVisibility(View.GONE); + // 设置主标题样式 + mTitle.setTextAppearance(context, R.style.TextAppearancePrimaryItem); + + if (data.getType() == Notes.TYPE_FOLDER) { + // 文件夹：显示名称 + 文件数量 + mTitle.setText(data.getSnippet() + + context.getString(R.string.format_folder_files_count, + data.getNotesCount())); + mAlert.setVisibility(View.GONE); // 文件夹不显示提醒图标 + } else { + // 普通便签：显示格式化摘要 mTitle.setText(DataUtils.getFormattedSnippet(data.getSnippet())); + // 根据是否有提醒设置图标 if (data.hasAlert()) { mAlert.setImageResource(R.drawable.clock); mAlert.setVisibility(View.VISIBLE); } else { mAlert.setVisibility(View.GONE); } - } else { - mCallName.setVisibility(View.GONE); - mTitle.setTextAppearance(context, R.style.TextAppearancePrimaryItem); - - if (data.getType() == Notes.TYPE_FOLDER) { - mTitle.setText(data.getSnippet() - + context.getString(R.string.format_folder_files_count, - data.getNotesCount())); - mAlert.setVisibility(View.GONE); - } else { - mTitle.setText(DataUtils.getFormattedSnippet(data.getSnippet())); - if (data.hasAlert()) { - mAlert.setImageResource(R.drawable.clock); - mAlert.setVisibility(View.VISIBLE); - } else { - mAlert.setVisibility(View.GONE); - } - } } - mTime.setText(DateUtils.getRelativeTimeSpanString(data.getModifiedDate())); - - setBackground(data); } + // ======================= 背景设置 ======================= + + /** + * 设置列表项背景 + * 根据便签类型和位置选择不同的背景图片 + * 背景选择规则： + * 1. 便签：根据位置选择不同背景（首项、中间项、末项、单独项） + * 2. 文件夹：统一使用文件夹背景 + * + * @param data 便签数据项 + */ private void setBackground(NoteItemData data) { - int id = data.getBgColorId(); + int id = data.getBgColorId(); // 获取背景颜色ID + if (data.getType() == Notes.TYPE_NOTE) { + // 便签类型：根据位置选择背景 if (data.isSingle() || data.isOneFollowingFolder()) { + // 单独项或文件夹后的唯一便签：单独项背景 setBackgroundResource(NoteItemBgResources.getNoteBgSingleRes(id)); } else if (data.isLast()) { + // 最后一项：底部圆角背景 setBackgroundResource(NoteItemBgResources.getNoteBgLastRes(id)); } else if (data.isFirst() || data.isMultiFollowingFolder()) { + // 第一项或文件夹后的多个便签之一：顶部圆角背景 setBackgroundResource(NoteItemBgResources.getNoteBgFirstRes(id)); } else { + // 中间项：普通直角背景 setBackgroundResource(NoteItemBgResources.getNoteBgNormalRes(id)); } } else { + // 文件夹类型：统一使用文件夹背景 setBackgroundResource(NoteItemBgResources.getFolderBgRes()); } } + // ======================= 数据获取方法 ======================= + + /** + * 获取便签数据项 + * 用于获取当前视图绑定的数据 + * @return 便签数据项 + */ public NoteItemData getItemData() { return mItemData; } -} +} \ No newline at end of file diff --git a/src/notes/ui/NotesPreferenceActivity.java b/src/notes/ui/NotesPreferenceActivity.java index 07c5f7e..8be7b04 100644 --- a/src/notes/ui/NotesPreferenceActivity.java +++ b/src/notes/ui/NotesPreferenceActivity.java @@ -14,88 +14,138 @@ * limitations under the License. */ +// NotesPreferenceActivity.java - 便签设置Activity +// 主要功能：管理应用的偏好设置，特别是Google Tasks同步账户管理 package net.micode.notes.ui; -import android.accounts.Account; -import android.accounts.AccountManager; -import android.app.ActionBar; -import android.app.AlertDialog; -import android.content.BroadcastReceiver; -import android.content.ContentValues; -import android.content.Context; -import android.content.DialogInterface; -import android.content.Intent; -import android.content.IntentFilter; -import android.content.SharedPreferences; -import android.os.Bundle; -import android.preference.Preference; -import android.preference.Preference.OnPreferenceClickListener; -import android.preference.PreferenceActivity; -import android.preference.PreferenceCategory; -import android.text.TextUtils; -import android.text.format.DateFormat; -import android.view.LayoutInflater; -import android.view.Menu; -import android.view.MenuItem; -import android.view.View; -import android.widget.Button; -import android.widget.TextView; -import android.widget.Toast; - -import net.micode.notes.R; -import net.micode.notes.data.Notes; -import net.micode.notes.data.Notes.NoteColumns; -import net.micode.notes.gtask.remote.GTaskSyncService; +// ======================= 导入区域 ======================= +// Android账户管理 +import android.accounts.Account; // 账户对象 +import android.accounts.AccountManager; // 账户管理器 +// Android界面 +import android.app.ActionBar; // 操作栏 +import android.app.AlertDialog; // 警告对话框 +// Android广播 +import android.content.BroadcastReceiver; // 广播接收器 +// Android数据 +import android.content.ContentValues; // 内容值 +// Android基础 +import android.content.Context; // 上下文 +import android.content.DialogInterface; // 对话框接口 +import android.content.Intent; // 意图 +import android.content.IntentFilter; // 意图过滤器 +import android.content.SharedPreferences; // 偏好设置 +import android.os.Bundle; // 状态保存 +// Android偏好设置 +import android.preference.Preference; // 偏好设置项 +import android.preference.Preference.OnPreferenceClickListener; // 偏好设置点击监听 +import android.preference.PreferenceActivity; // 偏好设置Activity基类 +import android.preference.PreferenceCategory; // 偏好设置分类 +// Android工具 +import android.text.TextUtils; // 文本工具 +import android.text.format.DateFormat; // 日期格式化 +// Android视图 +import android.view.LayoutInflater; // 布局加载器 +import android.view.Menu; // 菜单 +import android.view.MenuItem; // 菜单项 +import android.view.View; // 视图基类 +// Android控件 +import android.widget.Button; // 按钮 +import android.widget.TextView; // 文本视图 +import android.widget.Toast; // 提示信息 + +// 应用内部资源 +import net.micode.notes.R; // 资源文件R类 +// 应用数据模型 +import net.micode.notes.data.Notes; // Notes主类 +import net.micode.notes.data.Notes.NoteColumns; // 便签表列定义 +// 应用同步服务 +import net.micode.notes.gtask.remote.GTaskSyncService; // Google任务同步服务 + +// ======================= 便签设置Activity ======================= +/** + * NotesPreferenceActivity - 便签设置Activity + * 继承自PreferenceActivity，管理应用的所有偏好设置 + * 核心功能：Google Tasks同步账户管理、同步控制、设置管理 + */ +public class NotesPreferenceActivity extends PreferenceActivity { + // ======================= 偏好设置常量 ======================= -public class NotesPreferenceActivity extends PreferenceActivity { + /** 偏好设置文件名 */ public static final String PREFERENCE_NAME = "notes_preferences"; + /** 同步账户名称偏好键 - 存储当前设置的同步账户名 */ public static final String PREFERENCE_SYNC_ACCOUNT_NAME = "pref_key_account_name"; + /** 最后同步时间偏好键 - 存储上次成功同步的时间戳 */ public static final String PREFERENCE_LAST_SYNC_TIME = "pref_last_sync_time"; + /** 背景颜色随机显示偏好键 - 控制是否随机显示背景颜色 */ public static final String PREFERENCE_SET_BG_COLOR_KEY = "pref_key_bg_random_appear"; + /** 同步账户偏好键 - 用于XML中定义账户设置分类 */ private static final String PREFERENCE_SYNC_ACCOUNT_KEY = "pref_sync_account_key"; + /** 权限过滤器键 - 用于添加账户时过滤账户类型 */ private static final String AUTHORITIES_FILTER_KEY = "authorities"; + // ======================= 成员变量 ======================= + + /** 账户设置分类 - 显示账户相关设置 */ private PreferenceCategory mAccountCategory; + /** Google Tasks同步广播接收器 - 监听同步状态变化 */ private GTaskReceiver mReceiver; + /** 原始账户列表 - 用于检测新添加的账户 */ private Account[] mOriAccounts; + /** 是否添加了新账户标志 - 标记用户是否添加了新账户 */ private boolean mHasAddedAccount; + // ======================= 生命周期方法 ======================= + + /** + * onCreate - Activity创建 + * 初始化设置界面 + * @param icicle 保存的状态 + */ @Override protected void onCreate(Bundle icicle) { super.onCreate(icicle); - /* using the app icon for navigation */ + /* 使用应用图标作为导航按钮 */ getActionBar().setDisplayHomeAsUpEnabled(true); + // 从XML加载偏好设置 addPreferencesFromResource(R.xml.preferences); + // 获取账户设置分类 mAccountCategory = (PreferenceCategory) findPreference(PREFERENCE_SYNC_ACCOUNT_KEY); + // 创建并注册同步广播接收器 mReceiver = new GTaskReceiver(); IntentFilter filter = new IntentFilter(); filter.addAction(GTaskSyncService.GTASK_SERVICE_BROADCAST_NAME); registerReceiver(mReceiver, filter); - mOriAccounts = null; + mOriAccounts = null; // 初始化原始账户列表 + // 添加设置界面头部 View header = LayoutInflater.from(this).inflate(R.layout.settings_header, null); getListView().addHeaderView(header, null, true); } + /** + * onResume - Activity恢复可见 + * 检测新添加的账户并自动设置 + */ @Override protected void onResume() { super.onResume(); - // need to set sync account automatically if user has added a new - // account + // 如果用户添加了新账户，需要自动设置为同步账户 if (mHasAddedAccount) { Account[] accounts = getGoogleAccounts(); + // 比较新旧账户数量，检测新账户 if (mOriAccounts != null && accounts.length > mOriAccounts.length) { for (Account accountNew : accounts) { boolean found = false; @@ -106,6 +156,7 @@ public class NotesPreferenceActivity extends PreferenceActivity { } } if (!found) { + // 找到新账户，设置为同步账户 setSyncAccount(accountNew.name); break; } @@ -113,9 +164,13 @@ public class NotesPreferenceActivity extends PreferenceActivity { } } - refreshUI(); + refreshUI(); // 刷新界面 } + /** + * onDestroy - Activity销毁 + * 注销广播接收器 + */ @Override protected void onDestroy() { if (mReceiver != null) { @@ -124,9 +179,16 @@ public class NotesPreferenceActivity extends PreferenceActivity { super.onDestroy(); } + // ======================= 账户偏好设置加载 ======================= + + /** + * 加载账户偏好设置 + * 动态创建账户设置项 + */ private void loadAccountPreference() { - mAccountCategory.removeAll(); + mAccountCategory.removeAll(); // 清空现有设置项 + // 创建账户设置项 Preference accountPref = new Preference(this); final String defaultAccount = getSyncAccountName(this); accountPref.setTitle(getString(R.string.preferences_account_title)); @@ -135,16 +197,16 @@ public class NotesPreferenceActivity extends PreferenceActivity { public boolean onPreferenceClick(Preference preference) { if (!GTaskSyncService.isSyncing()) { if (TextUtils.isEmpty(defaultAccount)) { - // the first time to set account + // 首次设置账户：显示选择账户对话框 showSelectAccountAlertDialog(); } else { - // if the account has already been set, we need to promp - // user about the risk + // 已设置账户：显示更改账户确认对话框 showChangeAccountConfirmAlertDialog(); } } else { + // 同步进行中，不能更改账户 Toast.makeText(NotesPreferenceActivity.this, - R.string.preferences_toast_cannot_change_account, Toast.LENGTH_SHORT) + R.string.preferences_toast_cannot_change_account, Toast.LENGTH_SHORT) .show(); } return true; @@ -154,12 +216,19 @@ public class NotesPreferenceActivity extends PreferenceActivity { mAccountCategory.addPreference(accountPref); } + // ======================= 同步按钮加载 ======================= + + /** + * 加载同步按钮 + * 根据同步状态设置按钮文本和点击事件 + */ private void loadSyncButton() { Button syncButton = (Button) findViewById(R.id.preference_sync_button); TextView lastSyncTimeView = (TextView) findViewById(R.id.prefenerece_sync_status_textview); - // set button state + // 设置按钮状态 if (GTaskSyncService.isSyncing()) { + // 同步中：显示取消按钮 syncButton.setText(getString(R.string.preferences_button_sync_cancel)); syncButton.setOnClickListener(new View.OnClickListener() { public void onClick(View v) { @@ -167,6 +236,7 @@ public class NotesPreferenceActivity extends PreferenceActivity { } }); } else { + // 未同步：显示立即同步按钮 syncButton.setText(getString(R.string.preferences_button_sync_immediately)); syncButton.setOnClickListener(new View.OnClickListener() { public void onClick(View v) { @@ -174,13 +244,16 @@ public class NotesPreferenceActivity extends PreferenceActivity { } }); } + // 有账户时启用按钮，无账户时禁用 syncButton.setEnabled(!TextUtils.isEmpty(getSyncAccountName(this))); - // set last sync time + // 设置最后同步时间 if (GTaskSyncService.isSyncing()) { + // 同步中：显示同步进度 lastSyncTimeView.setText(GTaskSyncService.getProgressString()); lastSyncTimeView.setVisibility(View.VISIBLE); } else { + // 未同步：显示最后同步时间 long lastSyncTime = getLastSyncTime(this); if (lastSyncTime != 0) { lastSyncTimeView.setText(getString(R.string.preferences_last_sync_time, @@ -188,19 +261,33 @@ public class NotesPreferenceActivity extends PreferenceActivity { lastSyncTime))); lastSyncTimeView.setVisibility(View.VISIBLE); } else { + // 从未同步：隐藏时间显示 lastSyncTimeView.setVisibility(View.GONE); } } } + // ======================= 界面刷新 ======================= + + /** + * 刷新界面 + * 重新加载账户设置和同步按钮 + */ private void refreshUI() { loadAccountPreference(); loadSyncButton(); } + // ======================= 选择账户对话框 ======================= + + /** + * 显示选择账户对话框 + * 首次设置账户时调用 + */ private void showSelectAccountAlertDialog() { AlertDialog.Builder dialogBuilder = new AlertDialog.Builder(this); + // 自定义标题视图 View titleView = LayoutInflater.from(this).inflate(R.layout.account_dialog_title, null); TextView titleTextView = (TextView) titleView.findViewById(R.id.account_dialog_title); titleTextView.setText(getString(R.string.preferences_dialog_select_account_title)); @@ -208,45 +295,57 @@ public class NotesPreferenceActivity extends PreferenceActivity { subtitleTextView.setText(getString(R.string.preferences_dialog_select_account_tips)); dialogBuilder.setCustomTitle(titleView); - dialogBuilder.setPositiveButton(null, null); + dialogBuilder.setPositiveButton(null, null); // 不显示确定按钮 + // 获取Google账户列表 Account[] accounts = getGoogleAccounts(); String defAccount = getSyncAccountName(this); + // 保存原始账户列表，用于检测新账户 mOriAccounts = accounts; mHasAddedAccount = false; if (accounts.length > 0) { + // 创建账户列表项 CharSequence[] items = new CharSequence[accounts.length]; - final CharSequence[] itemMapping = items; - int checkedItem = -1; + final CharSequence[] itemMapping = items; // 用于内部类访问 + int checkedItem = -1; // 默认未选中 + + // 填充账户列表 int index = 0; for (Account account : accounts) { if (TextUtils.equals(account.name, defAccount)) { - checkedItem = index; + checkedItem = index; // 选中已设置的账户 } items[index++] = account.name; } + + // 设置单选列表 dialogBuilder.setSingleChoiceItems(items, checkedItem, new DialogInterface.OnClickListener() { public void onClick(DialogInterface dialog, int which) { + // 选择账户 setSyncAccount(itemMapping[which].toString()); dialog.dismiss(); - refreshUI(); + refreshUI(); // 刷新界面 } }); } + // 添加"添加账户"视图 View addAccountView = LayoutInflater.from(this).inflate(R.layout.add_account_text, null); dialogBuilder.setView(addAccountView); + // 显示对话框 final AlertDialog dialog = dialogBuilder.show(); addAccountView.setOnClickListener(new View.OnClickListener() { public void onClick(View v) { - mHasAddedAccount = true; + mHasAddedAccount = true; // 标记为添加账户 + // 启动系统添加账户界面 Intent intent = new Intent("android.settings.ADD_ACCOUNT_SETTINGS"); + // 只显示Gmail账户类型 intent.putExtra(AUTHORITIES_FILTER_KEY, new String[] { - "gmail-ls" + "gmail-ls" }); startActivityForResult(intent, -1); dialog.dismiss(); @@ -254,42 +353,69 @@ public class NotesPreferenceActivity extends PreferenceActivity { }); } + // ======================= 更改账户确认对话框 ======================= + + /** + * 显示更改账户确认对话框 + * 已设置账户时点击账户项调用 + */ private void showChangeAccountConfirmAlertDialog() { AlertDialog.Builder dialogBuilder = new AlertDialog.Builder(this); + // 自定义标题视图 View titleView = LayoutInflater.from(this).inflate(R.layout.account_dialog_title, null); TextView titleTextView = (TextView) titleView.findViewById(R.id.account_dialog_title); + // 标题包含当前账户名 titleTextView.setText(getString(R.string.preferences_dialog_change_account_title, getSyncAccountName(this))); TextView subtitleTextView = (TextView) titleView.findViewById(R.id.account_dialog_subtitle); subtitleTextView.setText(getString(R.string.preferences_dialog_change_account_warn_msg)); dialogBuilder.setCustomTitle(titleView); + // 设置菜单项 CharSequence[] menuItemArray = new CharSequence[] { - getString(R.string.preferences_menu_change_account), - getString(R.string.preferences_menu_remove_account), - getString(R.string.preferences_menu_cancel) + getString(R.string.preferences_menu_change_account), // 更改账户 + getString(R.string.preferences_menu_remove_account), // 移除账户 + getString(R.string.preferences_menu_cancel) // 取消 }; dialogBuilder.setItems(menuItemArray, new DialogInterface.OnClickListener() { public void onClick(DialogInterface dialog, int which) { if (which == 0) { + // 更改账户：显示选择账户对话框 showSelectAccountAlertDialog(); } else if (which == 1) { + // 移除账户：清除账户设置 removeSyncAccount(); refreshUI(); } + // 取消：不执行任何操作 } }); dialogBuilder.show(); } + // ======================= 获取Google账户 ======================= + + /** + * 获取设备上的Google账户 + * @return Google账户数组 + */ private Account[] getGoogleAccounts() { AccountManager accountManager = AccountManager.get(this); + // 获取类型为"com.google"的账户（Google账户） return accountManager.getAccountsByType("com.google"); } + // ======================= 设置同步账户 ======================= + + /** + * 设置同步账户 + * 保存账户名到偏好设置，并清理同步相关数据 + * @param account 账户名 + */ private void setSyncAccount(String account) { if (!getSyncAccountName(this).equals(account)) { + // 保存到偏好设置 SharedPreferences settings = getSharedPreferences(PREFERENCE_NAME, Context.MODE_PRIVATE); SharedPreferences.Editor editor = settings.edit(); if (account != null) { @@ -299,53 +425,76 @@ public class NotesPreferenceActivity extends PreferenceActivity { } editor.commit(); - // clean up last sync time + // 清理最后同步时间 setLastSyncTime(this, 0); - // clean up local gtask related info + // 清理本地同步相关数据（在后台线程执行） new Thread(new Runnable() { public void run() { ContentValues values = new ContentValues(); - values.put(NoteColumns.GTASK_ID, ""); - values.put(NoteColumns.SYNC_ID, 0); + values.put(NoteColumns.GTASK_ID, ""); // 清空GTASK ID + values.put(NoteColumns.SYNC_ID, 0); // 清空同步ID getContentResolver().update(Notes.CONTENT_NOTE_URI, values, null, null); } }).start(); + // 显示成功提示 Toast.makeText(NotesPreferenceActivity.this, getString(R.string.preferences_toast_success_set_accout, account), Toast.LENGTH_SHORT).show(); } } + // ======================= 移除同步账户 ======================= + + /** + * 移除同步账户 + * 清除账户设置和同步数据 + */ private void removeSyncAccount() { SharedPreferences settings = getSharedPreferences(PREFERENCE_NAME, Context.MODE_PRIVATE); SharedPreferences.Editor editor = settings.edit(); + // 移除账户名 if (settings.contains(PREFERENCE_SYNC_ACCOUNT_NAME)) { editor.remove(PREFERENCE_SYNC_ACCOUNT_NAME); } + // 移除最后同步时间 if (settings.contains(PREFERENCE_LAST_SYNC_TIME)) { editor.remove(PREFERENCE_LAST_SYNC_TIME); } editor.commit(); - // clean up local gtask related info + // 清理本地同步相关数据（在后台线程执行） new Thread(new Runnable() { public void run() { ContentValues values = new ContentValues(); - values.put(NoteColumns.GTASK_ID, ""); - values.put(NoteColumns.SYNC_ID, 0); + values.put(NoteColumns.GTASK_ID, ""); // 清空GTASK ID + values.put(NoteColumns.SYNC_ID, 0); // 清空同步ID getContentResolver().update(Notes.CONTENT_NOTE_URI, values, null, null); } }).start(); } + // ======================= 静态工具方法 ======================= + + /** + * 获取同步账户名 + * 静态方法，供其他类调用 + * @param context 上下文 + * @return 同步账户名，无账户时返回空字符串 + */ public static String getSyncAccountName(Context context) { SharedPreferences settings = context.getSharedPreferences(PREFERENCE_NAME, Context.MODE_PRIVATE); return settings.getString(PREFERENCE_SYNC_ACCOUNT_NAME, ""); } + /** + * 设置最后同步时间 + * 静态方法，供其他类调用 + * @param context 上下文 + * @param time 最后同步时间戳 + */ public static void setLastSyncTime(Context context, long time) { SharedPreferences settings = context.getSharedPreferences(PREFERENCE_NAME, Context.MODE_PRIVATE); @@ -354,29 +503,52 @@ public class NotesPreferenceActivity extends PreferenceActivity { editor.commit(); } + /** + * 获取最后同步时间 + * 静态方法，供其他类调用 + * @param context 上下文 + * @return 最后同步时间戳，从未同步返回0 + */ public static long getLastSyncTime(Context context) { SharedPreferences settings = context.getSharedPreferences(PREFERENCE_NAME, Context.MODE_PRIVATE); return settings.getLong(PREFERENCE_LAST_SYNC_TIME, 0); } - private class GTaskReceiver extends BroadcastReceiver { + // ======================= 同步广播接收器 ======================= + /** + * GTaskReceiver - Google Tasks同步广播接收器 + * 监听同步状态变化 + */ + private class GTaskReceiver extends BroadcastReceiver { + /** + * 接收广播 + * 处理同步状态变化 + */ @Override public void onReceive(Context context, Intent intent) { - refreshUI(); + refreshUI(); // 刷新界面 + + // 如果正在同步，更新进度信息 if (intent.getBooleanExtra(GTaskSyncService.GTASK_SERVICE_BROADCAST_IS_SYNCING, false)) { TextView syncStatus = (TextView) findViewById(R.id.prefenerece_sync_status_textview); syncStatus.setText(intent .getStringExtra(GTaskSyncService.GTASK_SERVICE_BROADCAST_PROGRESS_MSG)); } - } } + // ======================= 菜单项处理 ======================= + + /** + * 选项菜单项选择处理 + * 处理返回按钮点击 + */ public boolean onOptionsItemSelected(MenuItem item) { switch (item.getItemId()) { case android.R.id.home: + // 返回按钮：回到主界面 Intent intent = new Intent(this, NotesListActivity.class); intent.addFlags(Intent.FLAG_ACTIVITY_CLEAR_TOP); startActivity(intent); @@ -385,4 +557,4 @@ public class NotesPreferenceActivity extends PreferenceActivity { return false; } } -} +} \ No newline at end of file diff --git a/src/notes/widget/NoteWidgetProvider.java b/src/notes/widget/NoteWidgetProvider.java index ec6f819..6078cd3 100644 --- a/src/notes/widget/NoteWidgetProvider.java +++ b/src/notes/widget/NoteWidgetProvider.java @@ -14,119 +14,244 @@ * limitations under the License. */ +// NoteWidgetProvider.java - 便签小部件提供者抽象基类 +// 主要功能：为便签小部件提供基础实现，包括数据加载、视图更新、点击处理 package net.micode.notes.widget; -import android.app.PendingIntent; -import android.appwidget.AppWidgetManager; -import android.appwidget.AppWidgetProvider; -import android.content.ContentValues; -import android.content.Context; -import android.content.Intent; -import android.database.Cursor; -import android.util.Log; -import android.widget.RemoteViews; - -import net.micode.notes.R; -import net.micode.notes.data.Notes; -import net.micode.notes.data.Notes.NoteColumns; -import net.micode.notes.tool.ResourceParser; -import net.micode.notes.ui.NoteEditActivity; -import net.micode.notes.ui.NotesListActivity; +// ======================= 导入区域 ======================= +// Android小部件 +import android.app.PendingIntent; // 待定意图 +import android.appwidget.AppWidgetManager; // 小部件管理器 +import android.appwidget.AppWidgetProvider; // 小部件提供者基类 +// Android数据 +import android.content.ContentValues; // 内容值 +import android.content.Context; // 上下文 +import android.content.Intent; // 意图 +import android.database.Cursor; // 数据库查询结果游标 +import android.util.Log; // 日志工具 +// Android小部件视图 +import android.widget.RemoteViews; // 远程视图 + +// 应用内部资源 +import net.micode.notes.R; // 资源文件R类 +// 应用数据模型 +import net.micode.notes.data.Notes; // Notes主类 +import net.micode.notes.data.Notes.NoteColumns; // 便签表列定义 +// 应用资源解析 +import net.micode.notes.tool.ResourceParser; // 资源解析器 +// 应用界面 +import net.micode.notes.ui.NoteEditActivity; // 便签编辑Activity +import net.micode.notes.ui.NotesListActivity; // 便签列表Activity + +// ======================= 便签小部件提供者抽象基类 ======================= +/** + * NoteWidgetProvider - 便签小部件提供者抽象基类 + * 继承自AppWidgetProvider，为便签小部件提供通用基础功能 + * 抽象类，具体小部件类型（2x、4x）需要实现抽象方法 + * 核心功能： + * 1. 小部件数据加载和显示 + * 2. 小部件点击事件处理 + * 3. 小部件删除时数据清理 + * 4. 隐私模式支持 + */ public abstract class NoteWidgetProvider extends AppWidgetProvider { + + // ======================= 数据库查询配置 ======================= + + /** + * 查询投影数组 - 指定从数据库查询哪些字段 + * 包含小部件显示所需的最小字段集 + */ public static final String [] PROJECTION = new String [] { - NoteColumns.ID, - NoteColumns.BG_COLOR_ID, - NoteColumns.SNIPPET + NoteColumns.ID, // 0 - 便签ID + NoteColumns.BG_COLOR_ID, // 1 - 背景颜色ID + NoteColumns.SNIPPET // 2 - 便签摘要 }; - public static final int COLUMN_ID = 0; - public static final int COLUMN_BG_COLOR_ID = 1; - public static final int COLUMN_SNIPPET = 2; + // ======================= 字段索引常量 ======================= + + public static final int COLUMN_ID = 0; // ID字段索引 + public static final int COLUMN_BG_COLOR_ID = 1; // 背景颜色字段索引 + public static final int COLUMN_SNIPPET = 2; // 摘要字段索引 + + // ======================= 常量定义 ======================= - private static final String TAG = "NoteWidgetProvider"; + private static final String TAG = "NoteWidgetProvider"; // 日志标签 + // ======================= 小部件生命周期方法 ======================= + + /** + * 小部件删除回调 + * 当用户从小部件列表中删除小部件时调用 + * 功能：清理数据库中与该小部件关联的便签的小部件ID + * + * @param context 上下文 + * @param appWidgetIds 被删除的小部件ID数组 + */ @Override public void onDeleted(Context context, int[] appWidgetIds) { + // 创建内容值，用于更新数据库 ContentValues values = new ContentValues(); + // 将小部件ID设置为无效值 values.put(NoteColumns.WIDGET_ID, AppWidgetManager.INVALID_APPWIDGET_ID); + + // 遍历所有被删除的小部件 for (int i = 0; i < appWidgetIds.length; i++) { + // 更新数据库，清理关联的小部件ID context.getContentResolver().update(Notes.CONTENT_NOTE_URI, values, - NoteColumns.WIDGET_ID + "=?", + NoteColumns.WIDGET_ID + "=?", // 条件：小部件ID匹配 new String[] { String.valueOf(appWidgetIds[i])}); } } + // ======================= 小部件信息查询 ======================= + + /** + * 获取便签小部件信息 + * 根据小部件ID查询关联的便签信息 + * 注意：排除回收站中的便签 + * + * @param context 上下文 + * @param widgetId 小部件ID + * @return 便签信息游标，包含ID、背景颜色、摘要 + */ private Cursor getNoteWidgetInfo(Context context, int widgetId) { return context.getContentResolver().query(Notes.CONTENT_NOTE_URI, PROJECTION, + // 条件：小部件ID匹配 且 不在回收站中 NoteColumns.WIDGET_ID + "=? AND " + NoteColumns.PARENT_ID + "<>?", new String[] { String.valueOf(widgetId), String.valueOf(Notes.ID_TRASH_FOLER) }, null); } + // ======================= 小部件更新方法 ======================= + + /** + * 更新小部件（公开方法） + * 默认使用非隐私模式更新 + * + * @param context 上下文 + * @param appWidgetManager 小部件管理器 + * @param appWidgetIds 要更新的小部件ID数组 + */ protected void update(Context context, AppWidgetManager appWidgetManager, int[] appWidgetIds) { - update(context, appWidgetManager, appWidgetIds, false); + update(context, appWidgetManager, appWidgetIds, false); // 默认非隐私模式 } + /** + * 更新小部件（私有方法） + * 实际执行小部件更新逻辑 + * 更新流程： + * 1. 查询便签信息 + * 2. 构建远程视图 + * 3. 设置点击意图 + * 4. 更新小部件 + * + * @param context 上下文 + * @param appWidgetManager 小部件管理器 + * @param appWidgetIds 要更新的小部件ID数组 + * @param privacyMode 是否处于隐私模式 + * true: 隐私模式，显示"浏览中"文本 + * false: 正常模式，显示便签内容 + */ private void update(Context context, AppWidgetManager appWidgetManager, int[] appWidgetIds, - boolean privacyMode) { + boolean privacyMode) { + // 遍历所有要更新的小部件 for (int i = 0; i < appWidgetIds.length; i++) { if (appWidgetIds[i] != AppWidgetManager.INVALID_APPWIDGET_ID) { - int bgId = ResourceParser.getDefaultBgId(context); - String snippet = ""; + int bgId = ResourceParser.getDefaultBgId(context); // 默认背景颜色 + String snippet = ""; // 便签摘要 + + // 构建点击意图 Intent intent = new Intent(context, NoteEditActivity.class); intent.setFlags(Intent.FLAG_ACTIVITY_SINGLE_TOP); intent.putExtra(Notes.INTENT_EXTRA_WIDGET_ID, appWidgetIds[i]); intent.putExtra(Notes.INTENT_EXTRA_WIDGET_TYPE, getWidgetType()); + // 查询小部件关联的便签信息 Cursor c = getNoteWidgetInfo(context, appWidgetIds[i]); if (c != null && c.moveToFirst()) { + // 安全检查：确保没有多个便签关联到同一小部件 if (c.getCount() > 1) { Log.e(TAG, "Multiple message with same widget id:" + appWidgetIds[i]); c.close(); - return; + return; // 数据异常，直接返回 } + // 从游标获取数据 snippet = c.getString(COLUMN_SNIPPET); bgId = c.getInt(COLUMN_BG_COLOR_ID); - intent.putExtra(Intent.EXTRA_UID, c.getLong(COLUMN_ID)); - intent.setAction(Intent.ACTION_VIEW); + intent.putExtra(Intent.EXTRA_UID, c.getLong(COLUMN_ID)); // 便签ID + intent.setAction(Intent.ACTION_VIEW); // 查看模式 } else { + // 无关联便签：显示默认文本 snippet = context.getResources().getString(R.string.widget_havenot_content); - intent.setAction(Intent.ACTION_INSERT_OR_EDIT); + intent.setAction(Intent.ACTION_INSERT_OR_EDIT); // 创建/编辑模式 } + // 关闭游标 if (c != null) { c.close(); } + // 创建远程视图 RemoteViews rv = new RemoteViews(context.getPackageName(), getLayoutId()); + // 设置背景图片 rv.setImageViewResource(R.id.widget_bg_image, getBgResourceId(bgId)); intent.putExtra(Notes.INTENT_EXTRA_BACKGROUND_ID, bgId); + /** - * Generate the pending intent to start host for the widget + * 生成待定意图，用于启动小部件对应的Activity */ PendingIntent pendingIntent = null; if (privacyMode) { + // 隐私模式：显示"浏览中"文本，点击进入列表 rv.setTextViewText(R.id.widget_text, context.getString(R.string.widget_under_visit_mode)); pendingIntent = PendingIntent.getActivity(context, appWidgetIds[i], new Intent( context, NotesListActivity.class), PendingIntent.FLAG_UPDATE_CURRENT); } else { + // 正常模式：显示便签内容，点击编辑便签 rv.setTextViewText(R.id.widget_text, snippet); pendingIntent = PendingIntent.getActivity(context, appWidgetIds[i], intent, PendingIntent.FLAG_UPDATE_CURRENT); } + // 设置点击事件 rv.setOnClickPendingIntent(R.id.widget_text, pendingIntent); + // 更新小部件 appWidgetManager.updateAppWidget(appWidgetIds[i], rv); } } } + // ======================= 抽象方法 ======================= + + /** + * 获取背景资源ID + * 将背景颜色ID映射到实际的Drawable资源ID + * 抽象方法，由具体子类实现 + * + * @param bgId 背景颜色ID + * @return Drawable资源ID + */ protected abstract int getBgResourceId(int bgId); + /** + * 获取布局ID + * 返回小部件使用的布局资源ID + * 抽象方法，由具体子类实现 + * + * @return 布局资源ID + */ protected abstract int getLayoutId(); + /** + * 获取小部件类型 + * 返回小部件的类型常量 + * 抽象方法，由具体子类实现 + * + * @return 小部件类型：TYPE_WIDGET_2X 或 TYPE_WIDGET_4X + */ protected abstract int getWidgetType(); -} +} \ No newline at end of file diff --git a/src/notes/widget/NoteWidgetProvider_2x.java b/src/notes/widget/NoteWidgetProvider_2x.java index adcb2f7..1e9c16a 100644 --- a/src/notes/widget/NoteWidgetProvider_2x.java +++ b/src/notes/widget/NoteWidgetProvider_2x.java @@ -14,34 +14,86 @@ * limitations under the License. */ +// NoteWidgetProvider_2x.java - 2x2便签小部件提供者 +// 主要功能：实现2x2尺寸便签小部件的具体逻辑 package net.micode.notes.widget; -import android.appwidget.AppWidgetManager; -import android.content.Context; - -import net.micode.notes.R; -import net.micode.notes.data.Notes; -import net.micode.notes.tool.ResourceParser; +// ======================= 导入区域 ======================= +// Android小部件 +import android.appwidget.AppWidgetManager; // 小部件管理器 +// Android基础 +import android.content.Context; // 上下文 +// 应用内部资源 +import net.micode.notes.R; // 资源文件R类 +// 应用数据模型 +import net.micode.notes.data.Notes; // Notes主类 +// 应用资源解析 +import net.micode.notes.tool.ResourceParser; // 资源解析器 +// ======================= 2x2便签小部件提供者 ======================= +/** + * NoteWidgetProvider_2x - 2x2便签小部件提供者 + * 继承自NoteWidgetProvider抽象基类 + * 功能：实现2x2尺寸便签小部件的具体逻辑 + * 尺寸：2x2单元格（通常为2行2列） + * 布局：widget_2x.xml + */ public class NoteWidgetProvider_2x extends NoteWidgetProvider { + + // ======================= 小部件生命周期方法 ======================= + + /** + * 小部件更新回调 + * 当小部件需要更新时调用，包括创建、定时更新、配置变更等 + * 实现：调用父类的update()方法 + * + * @param context 上下文 + * @param appWidgetManager 小部件管理器 + * @param appWidgetIds 需要更新的小部件ID数组 + */ @Override public void onUpdate(Context context, AppWidgetManager appWidgetManager, int[] appWidgetIds) { + // 调用父类的update()方法执行通用更新逻辑 super.update(context, appWidgetManager, appWidgetIds); } + // ======================= 抽象方法实现 ======================= + + /** + * 获取布局ID + * 返回2x2小部件使用的布局资源ID + * 布局文件：R.layout.widget_2x + * + * @return 2x2小部件布局资源ID + */ @Override protected int getLayoutId() { return R.layout.widget_2x; } + /** + * 获取背景资源ID + * 将背景颜色ID映射到2x2小部件的实际Drawable资源ID + * 通过ResourceParser.WidgetBgResources获取对应资源 + * + * @param bgId 背景颜色ID + * @return 2x2小部件背景Drawable资源ID + */ @Override protected int getBgResourceId(int bgId) { return ResourceParser.WidgetBgResources.getWidget2xBgResource(bgId); } + /** + * 获取小部件类型 + * 返回2x2小部件的类型常量 + * 类型常量定义在Notes类中 + * + * @return 小部件类型：Notes.TYPE_WIDGET_2X + */ @Override protected int getWidgetType() { return Notes.TYPE_WIDGET_2X; } -} +} \ No newline at end of file diff --git a/src/notes/widget/NoteWidgetProvider_4x.java b/src/notes/widget/NoteWidgetProvider_4x.java index c12a02e..783c952 100644 --- a/src/notes/widget/NoteWidgetProvider_4x.java +++ b/src/notes/widget/NoteWidgetProvider_4x.java @@ -14,33 +14,91 @@ * limitations under the License. */ +// NoteWidgetProvider_4x.java - 4x4便签小部件提供者 +// 主要功能：实现4x4尺寸便签小部件的具体逻辑 package net.micode.notes.widget; -import android.appwidget.AppWidgetManager; -import android.content.Context; - -import net.micode.notes.R; -import net.micode.notes.data.Notes; -import net.micode.notes.tool.ResourceParser; +// ======================= 导入区域 ======================= +// Android小部件 +import android.appwidget.AppWidgetManager; // 小部件管理器 +// Android基础 +import android.content.Context; // 上下文 +// 应用内部资源 +import net.micode.notes.R; // 资源文件R类 +// 应用数据模型 +import net.micode.notes.data.Notes; // Notes主类 +// 应用资源解析 +import net.micode.notes.tool.ResourceParser; // 资源解析器 +// ======================= 4x4便签小部件提供者 ======================= +/** + * NoteWidgetProvider_4x - 4x4便签小部件提供者 + * 继承自NoteWidgetProvider抽象基类 + * 功能：实现4x4尺寸便签小部件的具体逻辑 + * 尺寸：4x4单元格（通常为4行4列） + * 布局：widget_4x.xml + * 特点：更大显示面积，可显示更多便签内容 + */ public class NoteWidgetProvider_4x extends NoteWidgetProvider { + + // ======================= 小部件生命周期方法 ======================= + + /** + * 小部件更新回调 + * 当小部件需要更新时调用，包括创建、定时更新、配置变更等 + * 实现：调用父类的update()方法 + * 与2x版本逻辑完全相同，复用父类通用更新逻辑 + * + * @param context 上下文 + * @param appWidgetManager 小部件管理器 + * @param appWidgetIds 需要更新的小部件ID数组 + */ @Override public void onUpdate(Context context, AppWidgetManager appWidgetManager, int[] appWidgetIds) { + // 调用父类的update()方法执行通用更新逻辑 super.update(context, appWidgetManager, appWidgetIds); } + // ======================= 抽象方法实现 ======================= + + /** + * 获取布局ID + * 返回4x4小部件使用的布局资源ID + * 布局文件：R.layout.widget_4x + * 布局特点：更大的显示区域，适合显示更多文本内容 + * + * @return 4x4小部件布局资源ID + */ + @Override protected int getLayoutId() { return R.layout.widget_4x; } + /** + * 获取背景资源ID + * 将背景颜色ID映射到4x4小部件的实际Drawable资源ID + * 通过ResourceParser.WidgetBgResources获取对应资源 + * 注意：使用4x专用的背景资源，适配4x4尺寸 + * + * @param bgId 背景颜色ID + * @return 4x4小部件背景Drawable资源ID + */ @Override protected int getBgResourceId(int bgId) { return ResourceParser.WidgetBgResources.getWidget4xBgResource(bgId); } + /** + * 获取小部件类型 + * 返回4x4小部件的类型常量 + * 类型常量定义在Notes类中 + * 用于数据库记录和业务逻辑区分 + * + * @return 小部件类型：Notes.TYPE_WIDGET_4X + */ @Override protected int getWidgetType() { return Notes.TYPE_WIDGET_4X; } -} +} \ No newline at end of file