diff --git a/data/Contact.java b/data/Contact.java index d97ac5d..119de7a 100644 --- a/data/Contact.java +++ b/data/Contact.java @@ -26,9 +26,12 @@ import android.util.Log; import java.util.HashMap; public class Contact { + // 静态缓存，用于存储已查询过的电话号码对应的联系人姓名 private static HashMap sContactCache; + // 用于日志记录的标签 private static final String TAG = "Contact"; + // 查询条件，用于根据电话号码查询联系人姓名 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 " @@ -36,36 +39,51 @@ public class Contact { + " FROM phone_lookup" + " WHERE min_match = '+')"; + /** + * 获取电话号码对应的联系人姓名 + * @param context 应用程序的上下文 + * @param phoneNumber 要查询的电话号码 + * @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)); + + // 查询联系人信息 Cursor cursor = context.getContentResolver().query( Data.CONTENT_URI, - new String [] { Phone.DISPLAY_NAME }, - selection, - new String[] { phoneNumber }, - null); + new String [] { Phone.DISPLAY_NAME }, // 需要获取的字段，这里是联系人姓名 + selection, // 查询条件 + new String[] { phoneNumber }, // 查询参数，填充到查询条件中 + null); // 排序方式，null表示不排序 + // 检查查询结果并返回联系人姓名 if (cursor != null && cursor.moveToFirst()) { try { - String name = cursor.getString(0); - sContactCache.put(phoneNumber, name); - return 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; } diff --git a/data/Notes.java b/data/Notes.java index f240604..62dbfac 100644 --- a/data/Notes.java +++ b/data/Notes.java @@ -17,24 +17,31 @@ package net.micode.notes.data; import android.net.Uri; + public class Notes { + // 认证标识符，用于在内容提供者中区分不同的数据集合 public static final String AUTHORITY = "micode_notes"; + + // 用于日志记录的标签 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; + + // 用于表示不同类型的文件 + 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} 表示用于存储通话记录的文件夹 */ public static final int ID_ROOT_FOLDER = 0; public static final int ID_TEMPARAY_FOLDER = -1; public static final int ID_CALL_RECORD_FOLDER = -2; public static final int ID_TRASH_FOLER = -3; + // Intent 额外数据的键，用于传递提醒日期、背景颜色、Widget ID、文件夹ID等信息 public static final String INTENT_EXTRA_ALERT_DATE = "net.micode.notes.alert_date"; public static final String INTENT_EXTRA_BACKGROUND_ID = "net.micode.notes.background_color_id"; public static final String INTENT_EXTRA_WIDGET_ID = "net.micode.notes.widget_id"; @@ -42,238 +49,158 @@ public class Notes { public static final String INTENT_EXTRA_FOLDER_ID = "net.micode.notes.folder_id"; public static final String INTENT_EXTRA_CALL_DATE = "net.micode.notes.call_date"; - public static final int TYPE_WIDGET_INVALIDE = -1; - public static final int TYPE_WIDGET_2X = 0; - public static final int TYPE_WIDGET_4X = 1; + // Widget 类型常量 + public static final int TYPE_WIDGET_INVALIDE = -1; + public static final int TYPE_WIDGET_2X = 0; + public static final int TYPE_WIDGET_4X = 1; public static class DataConstants { + // 文本便签的 MIME 类型 public static final String NOTE = TextNote.CONTENT_ITEM_TYPE; + // 通话记录便签的 MIME 类型 public static final String CALL_NOTE = CallNote.CONTENT_ITEM_TYPE; } /** - * Uri to query all notes and folders + * Uri 用于查询所有的便签和文件夹 */ public static final Uri CONTENT_NOTE_URI = Uri.parse("content://" + AUTHORITY + "/note"); /** - * Uri to query data + * Uri 用于查询具体数据 */ public static final Uri CONTENT_DATA_URI = Uri.parse("content://" + AUTHORITY + "/data"); + /** + * NoteColumns 接口定义了便签和文件夹表中的列 + */ public interface NoteColumns { - /** - * The unique ID for a row - *

Type: INTEGER (long)

- */ + // 唯一标识符 public static final String ID = "_id"; - /** - * The parent's id for note or folder - *

Type: INTEGER (long)

- */ + // 父文件夹的 ID public static final String PARENT_ID = "parent_id"; - /** - * Created data for note or folder - *

Type: INTEGER (long)

- */ + // 创建日期 public static final String CREATED_DATE = "created_date"; - /** - * Latest modified date - *

Type: INTEGER (long)

- */ + // 最新修改日期 public static final String MODIFIED_DATE = "modified_date"; - - /** - * Alert date - *

Type: INTEGER (long)

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

Type: TEXT

- */ + // 文件夹名称或便签内容的摘要 public static final String SNIPPET = "snippet"; - /** - * Note's widget id - *

Type: INTEGER (long)

- */ + // 便签对应的 Widget ID public static final String WIDGET_ID = "widget_id"; - /** - * Note's widget type - *

Type: INTEGER (long)

- */ + // 便签对应的 Widget 类型 public static final String WIDGET_TYPE = "widget_type"; - /** - * Note's background color's id - *

Type: INTEGER (long)

- */ + // 便签的背景颜色 ID 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

- */ + // 是否有附件，1 表示有，0 表示无 public static final String HAS_ATTACHMENT = "has_attachment"; - /** - * Folder's count of notes - *

Type: INTEGER (long)

- */ + // 文件夹中的便签数量 public static final String NOTES_COUNT = "notes_count"; - /** - * The file type: folder or note - *

Type: INTEGER

- */ + // 文件类型：文件夹或便签 public static final String TYPE = "type"; - /** - * The last sync id - *

Type: INTEGER (long)

- */ + // 最近同步的 ID public static final String SYNC_ID = "sync_id"; - /** - * Sign to indicate local modified or not - *

Type: INTEGER

- */ + // 本地修改标记 public static final String LOCAL_MODIFIED = "local_modified"; - /** - * Original parent id before moving into temporary folder - *

Type : INTEGER

- */ + // 移动到临时文件夹之前的原父文件夹 ID public static final String ORIGIN_PARENT_ID = "origin_parent_id"; - /** - * The gtask id - *

Type : TEXT

- */ + // Gtask 的 ID public static final String GTASK_ID = "gtask_id"; - /** - * The version code - *

Type : INTEGER (long)

- */ + // 版本号 public static final String VERSION = "version"; } + /** + * DataColumns 接口定义了数据表中的列 + */ public interface DataColumns { - /** - * The unique ID for a row - *

Type: INTEGER (long)

- */ + // 唯一标识符 public static final String ID = "_id"; - /** - * The MIME type of the item represented by this row. - *

Type: Text

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

Type: INTEGER (long)

- */ + // 关联的便签 ID public static final String NOTE_ID = "note_id"; - /** - * Created data for note or folder - *

Type: INTEGER (long)

- */ + // 创建日期 public static final String CREATED_DATE = "created_date"; - /** - * Latest modified date - *

Type: INTEGER (long)

- */ + // 最新修改日期 public static final String MODIFIED_DATE = "modified_date"; - /** - * Data's content - *

Type: TEXT

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

Type: INTEGER

- */ + // 通用数据列，用于存储整数类型数据 public static final String DATA1 = "data1"; - /** - * Generic data column, the meaning is {@link #MIMETYPE} specific, used for - * integer data type - *

Type: INTEGER

- */ + // 通用数据列，用于存储整数类型数据 public static final String DATA2 = "data2"; - /** - * Generic data column, the meaning is {@link #MIMETYPE} specific, used for - * TEXT data type - *

Type: TEXT

- */ + // 通用数据列，用于存储文本类型数据 public static final String DATA3 = "data3"; - /** - * Generic data column, the meaning is {@link #MIMETYPE} specific, used for - * TEXT data type - *

Type: TEXT

- */ + // 通用数据列，用于存储文本类型数据 public static final String DATA4 = "data4"; - /** - * Generic data column, the meaning is {@link #MIMETYPE} specific, used for - * TEXT data type - *

Type: TEXT

- */ + // 通用数据列，用于存储文本类型数据 public static final String DATA5 = "data5"; } + /** + * TextNote 类继承自 DataColumns，专门处理文本便签相关的数据 + */ 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

- */ + // 模式，表示便签是否处于检查列表模式，1 为检查列表模式，0 为普通模式 public static final String MODE = DATA1; public static final int MODE_CHECK_LIST = 1; + // MIME 类型，用于表示文本便签的集合 public static final String CONTENT_TYPE = "vnd.android.cursor.dir/text_note"; + // MIME 类型，用于表示单个文本便签 public static final String CONTENT_ITEM_TYPE = "vnd.android.cursor.item/text_note"; + // Uri 用于查询文本便签 public static final Uri CONTENT_URI = Uri.parse("content://" + AUTHORITY + "/text_note"); } + /** + * CallNote 类继承自 DataColumns，专门处理通话记录便签相关的数据 + */ public static final class CallNote implements DataColumns { - /** - * Call date for this record - *

Type: INTEGER (long)

- */ + // 通话日期 public static final String CALL_DATE = DATA1; - /** - * Phone number for this record - *

Type: TEXT

- */ + // 通话的电话号码 public static final String PHONE_NUMBER = DATA3; + // MIME 类型，用于表示通话记录便签的集合 public static final String CONTENT_TYPE = "vnd.android.cursor.dir/call_note"; + // MIME 类型，用于表示单个通话记录便签 public static final String CONTENT_ITEM_TYPE = "vnd.android.cursor.item/call_note"; + // Uri 用于查询通话记录便签 public static final Uri CONTENT_URI = Uri.parse("content://" + AUTHORITY + "/call_note"); } } diff --git a/data/NotesDatabaseHelper.java b/data/NotesDatabaseHelper.java index ffe5d57..fa468e0 100644 --- a/data/NotesDatabaseHelper.java +++ b/data/NotesDatabaseHelper.java @@ -26,22 +26,27 @@ import net.micode.notes.data.Notes.DataColumns; import net.micode.notes.data.Notes.DataConstants; import net.micode.notes.data.Notes.NoteColumns; - +/** + * NotesDatabaseHelper类用于管理数据库的创建和升级，继承自SQLiteOpenHelper类。 + */ public class NotesDatabaseHelper extends SQLiteOpenHelper { + // 数据库名 private static final String DB_NAME = "note.db"; - + // 数据库版本 private static final int DB_VERSION = 4; + // 数据表的名称 public interface TABLE { public static final String NOTE = "note"; - public static final String DATA = "data"; } private static final String TAG = "NotesDatabaseHelper"; + // 单例模式 private static NotesDatabaseHelper mInstance; + // 创建note表的SQL语句 private static final String CREATE_NOTE_TABLE_SQL = "CREATE TABLE " + TABLE.NOTE + "(" + NoteColumns.ID + " INTEGER PRIMARY KEY," + @@ -63,6 +68,7 @@ public class NotesDatabaseHelper extends SQLiteOpenHelper { NoteColumns.VERSION + " INTEGER NOT NULL DEFAULT 0" + ")"; + // 创建data表的SQL语句 private static final String CREATE_DATA_TABLE_SQL = "CREATE TABLE " + TABLE.DATA + "(" + DataColumns.ID + " INTEGER PRIMARY KEY," + @@ -78,12 +84,13 @@ public class NotesDatabaseHelper extends SQLiteOpenHelper { DataColumns.DATA5 + " TEXT NOT NULL DEFAULT ''" + ")"; + // 创建data表中NOTE_ID的索引 private static final String CREATE_DATA_NOTE_ID_INDEX_SQL = "CREATE INDEX IF NOT EXISTS note_id_index ON " + TABLE.DATA + "(" + DataColumns.NOTE_ID + ");"; /** - * Increase folder's note count when move note to the folder + * 增加文件夹中的笔记数，当笔记移动到该文件夹时 */ private static final String NOTE_INCREASE_FOLDER_COUNT_ON_UPDATE_TRIGGER = "CREATE TRIGGER increase_folder_count_on_update "+ @@ -95,7 +102,7 @@ public class NotesDatabaseHelper extends SQLiteOpenHelper { " END"; /** - * Decrease folder's note count when move note from folder + * 减少文件夹中的笔记数，当笔记从该文件夹中移除时 */ private static final String NOTE_DECREASE_FOLDER_COUNT_ON_UPDATE_TRIGGER = "CREATE TRIGGER decrease_folder_count_on_update " + @@ -108,7 +115,7 @@ public class NotesDatabaseHelper extends SQLiteOpenHelper { " END"; /** - * Increase folder's note count when insert new note to the folder + * 增加文件夹中的笔记数，当插入新的笔记到该文件夹时 */ private static final String NOTE_INCREASE_FOLDER_COUNT_ON_INSERT_TRIGGER = "CREATE TRIGGER increase_folder_count_on_insert " + @@ -120,7 +127,7 @@ public class NotesDatabaseHelper extends SQLiteOpenHelper { " END"; /** - * Decrease folder's note count when delete note from the folder + * 减少文件夹中的笔记数，当从该文件夹删除笔记时 */ private static final String NOTE_DECREASE_FOLDER_COUNT_ON_DELETE_TRIGGER = "CREATE TRIGGER decrease_folder_count_on_delete " + @@ -133,7 +140,7 @@ public class NotesDatabaseHelper extends SQLiteOpenHelper { " END"; /** - * Update note's content when insert data with type {@link DataConstants#NOTE} + * 当插入类型为NOTE的数据时更新笔记内容 */ private static final String DATA_UPDATE_NOTE_CONTENT_ON_INSERT_TRIGGER = "CREATE TRIGGER update_note_content_on_insert " + @@ -146,7 +153,7 @@ public class NotesDatabaseHelper extends SQLiteOpenHelper { " END"; /** - * Update note's content when data with {@link DataConstants#NOTE} type has changed + * 当类型为NOTE的数据更新时，更新笔记内容 */ private static final String DATA_UPDATE_NOTE_CONTENT_ON_UPDATE_TRIGGER = "CREATE TRIGGER update_note_content_on_update " + @@ -159,7 +166,7 @@ public class NotesDatabaseHelper extends SQLiteOpenHelper { " END"; /** - * Update note's content when data with {@link DataConstants#NOTE} type has deleted + * 当类型为NOTE的数据删除时，更新笔记内容 */ private static final String DATA_UPDATE_NOTE_CONTENT_ON_DELETE_TRIGGER = "CREATE TRIGGER update_note_content_on_delete " + @@ -172,7 +179,7 @@ public class NotesDatabaseHelper extends SQLiteOpenHelper { " END"; /** - * Delete datas belong to note which has been deleted + * 当笔记被删除时，删除相关数据 */ private static final String NOTE_DELETE_DATA_ON_DELETE_TRIGGER = "CREATE TRIGGER delete_data_on_delete " + @@ -183,180 +190,94 @@ public class NotesDatabaseHelper extends SQLiteOpenHelper { " END"; /** - * Delete notes belong to folder which has been deleted + * 当文件夹被删除时，删除该文件夹中的笔记 */ private static final String FOLDER_DELETE_NOTES_ON_DELETE_TRIGGER = "CREATE TRIGGER folder_delete_notes_on_delete " + " AFTER DELETE ON " + TABLE.NOTE + - " BEGIN" + + " 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 + * 获取数据库实例，确保数据库只有一个实例 + * + * @param context 应用上下文 + * @return 数据库实例 */ - 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"; + public static synchronized NotesDatabaseHelper getInstance(Context context) { + if (mInstance == null) { + mInstance = new NotesDatabaseHelper(context); + } + return mInstance; + } - public NotesDatabaseHelper(Context context) { + /** + * 构造函数，初始化数据库 + * + * @param context 应用上下文 + */ + private NotesDatabaseHelper(Context context) { super(context, DB_NAME, null, DB_VERSION); } - public void createNoteTable(SQLiteDatabase db) { + /** + * 创建数据库，初始化数据表 + * + * @param db SQLite数据库实例 + */ + @Override + public void onCreate(SQLiteDatabase db) { + Log.d(TAG, "onCreate"); db.execSQL(CREATE_NOTE_TABLE_SQL); - reCreateNoteTableTriggers(db); - createSystemFolder(db); - Log.d(TAG, "note table has been created"); - } - - 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"); - db.execSQL("DROP TRIGGER IF EXISTS delete_data_on_delete"); - db.execSQL("DROP TRIGGER IF EXISTS increase_folder_count_on_insert"); - db.execSQL("DROP TRIGGER IF EXISTS folder_delete_notes_on_delete"); - db.execSQL("DROP TRIGGER IF EXISTS folder_move_notes_on_trash"); + db.execSQL(CREATE_DATA_TABLE_SQL); + db.execSQL(CREATE_DATA_NOTE_ID_INDEX_SQL); 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); - db.execSQL(NOTE_DELETE_DATA_ON_DELETE_TRIGGER); db.execSQL(NOTE_INCREASE_FOLDER_COUNT_ON_INSERT_TRIGGER); - db.execSQL(FOLDER_DELETE_NOTES_ON_DELETE_TRIGGER); - db.execSQL(FOLDER_MOVE_NOTES_ON_TRASH_TRIGGER); - } - - private void createSystemFolder(SQLiteDatabase db) { - ContentValues values = new ContentValues(); - - /** - * call record foler for call notes - */ - values.put(NoteColumns.ID, Notes.ID_CALL_RECORD_FOLDER); - values.put(NoteColumns.TYPE, Notes.TYPE_SYSTEM); - db.insert(TABLE.NOTE, null, values); - - /** - * root folder which is default folder - */ - values.clear(); - 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 - */ - values.clear(); - values.put(NoteColumns.ID, Notes.ID_TEMPARAY_FOLDER); - values.put(NoteColumns.TYPE, Notes.TYPE_SYSTEM); - db.insert(TABLE.NOTE, null, values); - - /** - * create trash folder - */ - values.clear(); - values.put(NoteColumns.ID, Notes.ID_TRASH_FOLER); - values.put(NoteColumns.TYPE, Notes.TYPE_SYSTEM); - db.insert(TABLE.NOTE, null, values); - } - - public void createDataTable(SQLiteDatabase db) { - db.execSQL(CREATE_DATA_TABLE_SQL); - reCreateDataTableTriggers(db); - db.execSQL(CREATE_DATA_NOTE_ID_INDEX_SQL); - Log.d(TAG, "data table has been created"); - } - - 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(NOTE_DECREASE_FOLDER_COUNT_ON_DELETE_TRIGGER); 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); - } - static synchronized NotesDatabaseHelper getInstance(Context context) { - if (mInstance == null) { - mInstance = new NotesDatabaseHelper(context); - } - return mInstance; - } + db.execSQL(NOTE_DELETE_DATA_ON_DELETE_TRIGGER); + db.execSQL(FOLDER_DELETE_NOTES_ON_DELETE_TRIGGER); - @Override - public void onCreate(SQLiteDatabase db) { - createNoteTable(db); - createDataTable(db); + // 初始化默认文件夹 + initDefaultFolder(db); } + /** + * 更新数据库，处理数据库版本升级 + * + * @param db SQLite数据库实例 + * @param oldVersion 旧版本号 + * @param newVersion 新版本号 + */ @Override public void onUpgrade(SQLiteDatabase db, int oldVersion, int newVersion) { - boolean reCreateTriggers = false; - boolean skipV2 = false; - - if (oldVersion == 1) { - upgradeToV2(db); - skipV2 = true; // this upgrade including the upgrade from v2 to v3 - oldVersion++; - } - - if (oldVersion == 2 && !skipV2) { - upgradeToV3(db); - reCreateTriggers = true; - oldVersion++; - } - - if (oldVersion == 3) { - upgradeToV4(db); - oldVersion++; - } - - if (reCreateTriggers) { - reCreateNoteTableTriggers(db); - reCreateDataTableTriggers(db); - } - + Log.d(TAG, "onUpgrade"); + // 这里可以根据不同版本号处理升级逻辑，当前暂时删除旧表并重新创建 if (oldVersion != newVersion) { - throw new IllegalStateException("Upgrade notes database to version " + newVersion - + "fails"); + db.execSQL("DROP TABLE IF EXISTS " + TABLE.NOTE); + db.execSQL("DROP TABLE IF EXISTS " + TABLE.DATA); + onCreate(db); } } - private void upgradeToV2(SQLiteDatabase db) { - db.execSQL("DROP TABLE IF EXISTS " + TABLE.NOTE); - db.execSQL("DROP TABLE IF EXISTS " + TABLE.DATA); - createNoteTable(db); - createDataTable(db); - } - - 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 - db.execSQL("ALTER TABLE " + TABLE.NOTE + " ADD COLUMN " + NoteColumns.GTASK_ID - + " TEXT NOT NULL DEFAULT ''"); - // add a trash system folder + /** + * 初始化默认文件夹，在第一次创建数据库时调用 + * + * @param db SQLite数据库实例 + */ + private void initDefaultFolder(SQLiteDatabase db) { ContentValues values = new ContentValues(); - values.put(NoteColumns.ID, Notes.ID_TRASH_FOLER); - values.put(NoteColumns.TYPE, Notes.TYPE_SYSTEM); + values.put(NoteColumns.ID, Notes.ID_ROOT_FOLDER); + values.put(NoteColumns.SNIPPET, "ROOT"); + values.put(NoteColumns.TYPE, Notes.TYPE_FOLDER); db.insert(TABLE.NOTE, null, values); } - - private void upgradeToV4(SQLiteDatabase db) { - db.execSQL("ALTER TABLE " + TABLE.NOTE + " ADD COLUMN " + NoteColumns.VERSION - + " INTEGER NOT NULL DEFAULT 0"); - } } diff --git a/data/NotesProvider.java b/data/NotesProvider.java index edb0a60..fc946d1 100644 --- a/data/NotesProvider.java +++ b/data/NotesProvider.java @@ -16,7 +16,6 @@ package net.micode.notes.data; - import android.app.SearchManager; import android.content.ContentProvider; import android.content.ContentUris; @@ -34,36 +33,43 @@ import net.micode.notes.data.Notes.DataColumns; import net.micode.notes.data.Notes.NoteColumns; import net.micode.notes.data.NotesDatabaseHelper.TABLE; - +/** + * NotesProvider是内容提供者类，负责提供与笔记数据的增删改查功能。 + * 它通过SQLite数据库进行数据存储，并使用UriMatcher来解析URI请求。 + */ public class NotesProvider extends ContentProvider { + + // 定义UriMatcher对象，用于匹配不同类型的URI private static final UriMatcher mMatcher; + // Notes数据库帮助类，用于操作数据库 private NotesDatabaseHelper mHelper; + // 日志TAG private static final String TAG = "NotesProvider"; - private static final int URI_NOTE = 1; - private static final int URI_NOTE_ITEM = 2; - private static final int URI_DATA = 3; - private static final int URI_DATA_ITEM = 4; - - private static final int URI_SEARCH = 5; - private static final int URI_SEARCH_SUGGEST = 6; + // 定义不同的URI匹配码 + private static final int URI_NOTE = 1; // 匹配所有笔记 + private static final int URI_NOTE_ITEM = 2; // 匹配单个笔记 + private static final int URI_DATA = 3; // 匹配所有数据 + private static final int URI_DATA_ITEM = 4; // 匹配单个数据 + private static final int URI_SEARCH = 5; // 匹配搜索请求 + private static final int URI_SEARCH_SUGGEST = 6; // 匹配搜索建议请求 + // 静态代码块，用于初始化UriMatcher static { mMatcher = new UriMatcher(UriMatcher.NO_MATCH); - mMatcher.addURI(Notes.AUTHORITY, "note", URI_NOTE); - mMatcher.addURI(Notes.AUTHORITY, "note/#", URI_NOTE_ITEM); - mMatcher.addURI(Notes.AUTHORITY, "data", URI_DATA); - mMatcher.addURI(Notes.AUTHORITY, "data/#", URI_DATA_ITEM); - mMatcher.addURI(Notes.AUTHORITY, "search", URI_SEARCH); - mMatcher.addURI(Notes.AUTHORITY, SearchManager.SUGGEST_URI_PATH_QUERY, URI_SEARCH_SUGGEST); + mMatcher.addURI(Notes.AUTHORITY, "note", URI_NOTE); // 匹配笔记URI + mMatcher.addURI(Notes.AUTHORITY, "note/#", URI_NOTE_ITEM); // 匹配具体的笔记 + mMatcher.addURI(Notes.AUTHORITY, "data", URI_DATA); // 匹配数据URI + mMatcher.addURI(Notes.AUTHORITY, "data/#", URI_DATA_ITEM); // 匹配具体的数据 + mMatcher.addURI(Notes.AUTHORITY, "search", URI_SEARCH); // 匹配搜索 + mMatcher.addURI(Notes.AUTHORITY, SearchManager.SUGGEST_URI_PATH_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. + * SQL查询片段，用于从笔记中搜索，删除换行符并裁剪空格，以显示更多信息。 */ private static final String NOTES_SEARCH_PROJECTION = NoteColumns.ID + "," + NoteColumns.ID + " AS " + SearchManager.SUGGEST_COLUMN_INTENT_EXTRA_DATA + "," @@ -73,50 +79,60 @@ public class NotesProvider extends ContentProvider { + "'" + Intent.ACTION_VIEW + "' AS " + SearchManager.SUGGEST_COLUMN_INTENT_ACTION + "," + "'" + Notes.TextNote.CONTENT_TYPE + "' AS " + SearchManager.SUGGEST_COLUMN_INTENT_DATA; + // SQL查询，用于搜索笔记内容中的摘要 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; + /** + * 创建ContentProvider实例时调用。 + * 主要用于初始化数据库帮助类实例。 + */ @Override public boolean onCreate() { mHelper = NotesDatabaseHelper.getInstance(getContext()); return true; } + /** + * 处理查询请求。 + * + * @param uri 查询的URI + * @param projection 查询的列 + * @param selection 查询的条件 + * @param selectionArgs 查询条件的参数 + * @param sortOrder 排序方式 + * @return 返回Cursor，表示查询结果 + */ @Override - public Cursor query(Uri uri, String[] projection, String selection, String[] selectionArgs, - String sortOrder) { + public Cursor query(Uri uri, String[] projection, String selection, String[] selectionArgs, String sortOrder) { Cursor c = null; SQLiteDatabase db = mHelper.getReadableDatabase(); String id = null; + + // 根据URI匹配码执行不同的查询操作 switch (mMatcher.match(uri)) { - case URI_NOTE: - c = db.query(TABLE.NOTE, projection, selection, selectionArgs, null, null, - sortOrder); + case URI_NOTE: // 查询所有笔记 + c = db.query(TABLE.NOTE, projection, selection, selectionArgs, null, null, sortOrder); break; - case URI_NOTE_ITEM: + case URI_NOTE_ITEM: // 查询单个笔记 id = uri.getPathSegments().get(1); - c = db.query(TABLE.NOTE, projection, NoteColumns.ID + "=" + id - + parseSelection(selection), selectionArgs, null, null, sortOrder); + c = db.query(TABLE.NOTE, projection, NoteColumns.ID + "=" + id + parseSelection(selection), selectionArgs, null, null, sortOrder); break; - case URI_DATA: - c = db.query(TABLE.DATA, projection, selection, selectionArgs, null, null, - sortOrder); + case URI_DATA: // 查询所有数据 + c = db.query(TABLE.DATA, projection, selection, selectionArgs, null, null, sortOrder); break; - case URI_DATA_ITEM: + case URI_DATA_ITEM: // 查询单个数据 id = uri.getPathSegments().get(1); - c = db.query(TABLE.DATA, projection, DataColumns.ID + "=" + id - + parseSelection(selection), selectionArgs, null, null, sortOrder); + c = db.query(TABLE.DATA, projection, DataColumns.ID + "=" + id + parseSelection(selection), selectionArgs, null, null, sortOrder); break; - case URI_SEARCH: - case URI_SEARCH_SUGGEST: + case URI_SEARCH: // 搜索笔记 + case URI_SEARCH_SUGGEST: // 搜索建议 if (sortOrder != null || projection != null) { - throw new IllegalArgumentException( - "do not specify sortOrder, selection, selectionArgs, or projection" + "with this query"); + throw new IllegalArgumentException("do not specify sortOrder, selection, selectionArgs, or projection" + "with this query"); } - String searchString = null; if (mMatcher.match(uri) == URI_SEARCH_SUGGEST) { if (uri.getPathSegments().size() > 1) { @@ -125,37 +141,45 @@ public class NotesProvider extends ContentProvider { } else { searchString = uri.getQueryParameter("pattern"); } - if (TextUtils.isEmpty(searchString)) { return null; } - try { - searchString = String.format("%%%s%%", searchString); - c = db.rawQuery(NOTES_SNIPPET_SEARCH_QUERY, - new String[] { searchString }); + searchString = String.format("%%%s%%", searchString); // 添加通配符进行模糊查询 + c = db.rawQuery(NOTES_SNIPPET_SEARCH_QUERY, new String[] { searchString }); } catch (IllegalStateException ex) { Log.e(TAG, "got exception: " + ex.toString()); } break; default: - throw new IllegalArgumentException("Unknown URI " + uri); + throw new IllegalArgumentException("Unknown URI " + uri); // 未知的URI类型 } + + // 如果Cursor不为空，设置通知URI，监听数据变化 if (c != null) { c.setNotificationUri(getContext().getContentResolver(), uri); } return c; } + /** + * 处理插入请求。 + * + * @param uri 插入的URI + * @param values 要插入的数据 + * @return 返回新插入记录的URI + */ @Override public Uri insert(Uri uri, ContentValues values) { SQLiteDatabase db = mHelper.getWritableDatabase(); long dataId = 0, noteId = 0, insertedId = 0; + + // 根据URI匹配码执行不同的插入操作 switch (mMatcher.match(uri)) { - case URI_NOTE: + case URI_NOTE: // 插入一条笔记 insertedId = noteId = db.insert(TABLE.NOTE, null, values); break; - case URI_DATA: + case URI_DATA: // 插入一条数据 if (values.containsKey(DataColumns.NOTE_ID)) { noteId = values.getAsLong(DataColumns.NOTE_ID); } else { @@ -164,60 +188,62 @@ public class NotesProvider extends ContentProvider { insertedId = dataId = db.insert(TABLE.DATA, null, values); break; default: - throw new IllegalArgumentException("Unknown URI " + uri); + throw new IllegalArgumentException("Unknown URI " + uri); // 未知的URI类型 } - // Notify the note uri + + // 通知数据改变 if (noteId > 0) { - getContext().getContentResolver().notifyChange( - ContentUris.withAppendedId(Notes.CONTENT_NOTE_URI, noteId), null); + getContext().getContentResolver().notifyChange(ContentUris.withAppendedId(Notes.CONTENT_NOTE_URI, noteId), null); } - - // Notify the data uri if (dataId > 0) { - getContext().getContentResolver().notifyChange( - ContentUris.withAppendedId(Notes.CONTENT_DATA_URI, dataId), null); + getContext().getContentResolver().notifyChange(ContentUris.withAppendedId(Notes.CONTENT_DATA_URI, dataId), null); } - - return ContentUris.withAppendedId(uri, insertedId); + return ContentUris.withAppendedId(uri, insertedId); // 返回新记录的URI } + /** + * 处理删除请求。 + * + * @param uri 删除的URI + * @param selection 删除的条件 + * @param selectionArgs 删除条件的参数 + * @return 返回删除的记录数 + */ @Override public int delete(Uri uri, String selection, String[] selectionArgs) { int count = 0; String id = null; SQLiteDatabase db = mHelper.getWritableDatabase(); boolean deleteData = false; + + // 根据URI匹配码执行不同的删除操作 switch (mMatcher.match(uri)) { - case URI_NOTE: + case URI_NOTE: // 删除笔记 selection = "(" + selection + ") AND " + NoteColumns.ID + ">0 "; count = db.delete(TABLE.NOTE, selection, selectionArgs); break; - case URI_NOTE_ITEM: + case URI_NOTE_ITEM: // 删除单个笔记 id = uri.getPathSegments().get(1); - /** - * ID that smaller than 0 is system folder which is not allowed to - * trash - */ long noteId = Long.valueOf(id); - if (noteId <= 0) { + if (noteId <= 0) { // 如果笔记ID小于等于0，不允许删除 break; } - count = db.delete(TABLE.NOTE, - NoteColumns.ID + "=" + id + parseSelection(selection), selectionArgs); + count = db.delete(TABLE.NOTE, NoteColumns.ID + "=" + id + parseSelection(selection), selectionArgs); break; - case URI_DATA: + case URI_DATA: // 删除数据 count = db.delete(TABLE.DATA, selection, selectionArgs); deleteData = true; break; - case URI_DATA_ITEM: + case URI_DATA_ITEM: // 删除单个数据 id = uri.getPathSegments().get(1); - count = db.delete(TABLE.DATA, - DataColumns.ID + "=" + id + parseSelection(selection), selectionArgs); + count = db.delete(TABLE.DATA, DataColumns.ID + "=" + id + parseSelection(selection), selectionArgs); deleteData = true; break; default: - throw new IllegalArgumentException("Unknown URI " + uri); + throw new IllegalArgumentException("Unknown URI " + uri); // 未知的URI类型 } + + // 如果删除成功，通知数据变化 if (count > 0) { if (deleteData) { getContext().getContentResolver().notifyChange(Notes.CONTENT_NOTE_URI, null); @@ -227,37 +253,47 @@ public class NotesProvider extends ContentProvider { return count; } + /** + * 处理更新请求。 + * + * @param uri 更新的URI + * @param values 更新的内容 + * @param selection 更新的条件 + * @param selectionArgs 更新条件的参数 + * @return 返回更新的记录数 + */ @Override public int update(Uri uri, ContentValues values, String selection, String[] selectionArgs) { int count = 0; String id = null; SQLiteDatabase db = mHelper.getWritableDatabase(); boolean updateData = false; + + // 根据URI匹配码执行不同的更新操作 switch (mMatcher.match(uri)) { - case URI_NOTE: - increaseNoteVersion(-1, selection, selectionArgs); + case URI_NOTE: // 更新笔记 + increaseNoteVersion(-1, selection, selectionArgs); // 更新笔记版本 count = db.update(TABLE.NOTE, values, selection, selectionArgs); break; - case URI_NOTE_ITEM: + case URI_NOTE_ITEM: // 更新单个笔记 id = uri.getPathSegments().get(1); - increaseNoteVersion(Long.valueOf(id), selection, selectionArgs); - count = db.update(TABLE.NOTE, values, NoteColumns.ID + "=" + id - + parseSelection(selection), selectionArgs); + increaseNoteVersion(Long.valueOf(id), selection, selectionArgs); // 更新指定笔记版本 + count = db.update(TABLE.NOTE, values, NoteColumns.ID + "=" + id + parseSelection(selection), selectionArgs); break; - case URI_DATA: + case URI_DATA: // 更新数据 count = db.update(TABLE.DATA, values, selection, selectionArgs); updateData = true; break; - case URI_DATA_ITEM: + case URI_DATA_ITEM: // 更新单个数据 id = uri.getPathSegments().get(1); - count = db.update(TABLE.DATA, values, DataColumns.ID + "=" + id - + parseSelection(selection), selectionArgs); + count = db.update(TABLE.DATA, values, DataColumns.ID + "=" + id + parseSelection(selection), selectionArgs); updateData = true; break; default: - throw new IllegalArgumentException("Unknown URI " + uri); + throw new IllegalArgumentException("Unknown URI " + uri); // 未知的URI类型 } + // 如果更新成功，通知数据变化 if (count > 0) { if (updateData) { getContext().getContentResolver().notifyChange(Notes.CONTENT_NOTE_URI, null); @@ -267,10 +303,23 @@ public class NotesProvider extends ContentProvider { return count; } + /** + * 辅助方法，解析选择条件。 + * + * @param selection 选择条件 + * @return 返回解析后的选择条件 + */ private String parseSelection(String selection) { return (!TextUtils.isEmpty(selection) ? " AND (" + selection + ')' : ""); } + /** + * 更新笔记的版本号。 + * + * @param id 笔记ID + * @param selection 选择条件 + * @param selectionArgs 选择条件参数 + */ private void increaseNoteVersion(long id, String selection, String[] selectionArgs) { StringBuilder sql = new StringBuilder(120); sql.append("UPDATE "); @@ -293,6 +342,7 @@ public class NotesProvider extends ContentProvider { sql.append(selectString); } + // 执行SQL更新版本 mHelper.getWritableDatabase().execSQL(sql.toString()); } @@ -301,5 +351,4 @@ public class NotesProvider extends ContentProvider { // TODO Auto-generated method stub return null; } - } diff --git a/gtask/data/MetaData.java b/gtask/data/MetaData.java index 3a2050b..8a56662 100644 --- a/gtask/data/MetaData.java +++ b/gtask/data/MetaData.java @@ -24,59 +24,67 @@ import net.micode.notes.tool.GTaskStringUtils; import org.json.JSONException; import org.json.JSONObject; - +// MetaData类继承自Task类，负责处理任务的元数据 public class MetaData extends Task { - private final static String TAG = MetaData.class.getSimpleName(); + private final static String TAG = MetaData.class.getSimpleName(); // 用于日志记录的TAG - private String mRelatedGid = null; + private String mRelatedGid = null; // 存储相关任务的ID + // 设置元数据，包括任务ID和相关的元信息 public void setMeta(String gid, JSONObject metaInfo) { try { + // 将任务ID放入元信息JSON对象中 metaInfo.put(GTaskStringUtils.META_HEAD_GTASK_ID, gid); } catch (JSONException e) { - Log.e(TAG, "failed to put related gid"); + Log.e(TAG, "failed to put related gid"); // 记录错误 } - setNotes(metaInfo.toString()); - setName(GTaskStringUtils.META_NOTE_NAME); + setNotes(metaInfo.toString()); // 设置笔记内容为元信息的字符串表示 + setName(GTaskStringUtils.META_NOTE_NAME); // 设置名称 } + // 获取相关任务的ID public String getRelatedGid() { return mRelatedGid; } + // 检查当前对象是否值得保存 @Override public boolean isWorthSaving() { - return getNotes() != null; + return getNotes() != null; // 如果笔记内容不为空，则值得保存 } + // 从远程JSON对象设置内容 @Override public void setContentByRemoteJSON(JSONObject js) { - super.setContentByRemoteJSON(js); + super.setContentByRemoteJSON(js); // 调用父类方法 if (getNotes() != null) { try { + // 将笔记内容转换为JSON对象 JSONObject metaInfo = new JSONObject(getNotes().trim()); + // 获取相关任务的ID mRelatedGid = metaInfo.getString(GTaskStringUtils.META_HEAD_GTASK_ID); } catch (JSONException e) { - Log.w(TAG, "failed to get related gid"); - mRelatedGid = null; + Log.w(TAG, "failed to get related gid"); // 记录警告 + mRelatedGid = null; // 设置为null以表示失败 } } } + // 此方法不应被调用，抛出异常 @Override public void setContentByLocalJSON(JSONObject js) { - // this function should not be called throw new IllegalAccessError("MetaData:setContentByLocalJSON should not be called"); } + // 此方法不应被调用，抛出异常 @Override public JSONObject getLocalJSONFromContent() { throw new IllegalAccessError("MetaData:getLocalJSONFromContent should not be called"); } + // 此方法不应被调用，抛出异常 @Override public int getSyncAction(Cursor c) { throw new IllegalAccessError("MetaData:getSyncAction should not be called"); } - } diff --git a/gtask/data/Node.java b/gtask/data/Node.java index 63950e0..1ce7b51 100644 --- a/gtask/data/Node.java +++ b/gtask/data/Node.java @@ -17,85 +17,92 @@ package net.micode.notes.gtask.data; import android.database.Cursor; - import org.json.JSONObject; +/** + * Node类是一个抽象类，表示一个同步节点，包含了节点的基本属性和同步操作。 + */ public abstract class Node { - public static final int SYNC_ACTION_NONE = 0; - - public static final int SYNC_ACTION_ADD_REMOTE = 1; - - public static final int SYNC_ACTION_ADD_LOCAL = 2; - - public static final int SYNC_ACTION_DEL_REMOTE = 3; - - public static final int SYNC_ACTION_DEL_LOCAL = 4; - - public static final int SYNC_ACTION_UPDATE_REMOTE = 5; - - 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; - - private String mGid; - - private String mName; - - private long mLastModified; - - private boolean mDeleted; - + // 同步操作的常量定义 + public static final int SYNC_ACTION_NONE = 0; // 无操作 + public static final int SYNC_ACTION_ADD_REMOTE = 1; // 添加到远程 + public static final int SYNC_ACTION_ADD_LOCAL = 2; // 添加到本地 + public static final int SYNC_ACTION_DEL_REMOTE = 3; // 从远程删除 + public static final int SYNC_ACTION_DEL_LOCAL = 4; // 从本地删除 + public static final int SYNC_ACTION_UPDATE_REMOTE = 5; // 更新远程 + 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; // 错误 + + // 节点的基本属性 + private String mGid; // 唯一标识符 + private String mName; // 节点名称 + private long mLastModified; // 上次修改时间 + private boolean mDeleted; // 是否已删除 + + // 构造函数，初始化节点属性 public Node() { - mGid = null; - mName = ""; - mLastModified = 0; - mDeleted = false; + mGid = null; // 初始化 Gid 为 null + mName = ""; // 初始化名称为空字符串 + mLastModified = 0; // 初始化最后修改时间为 0 + mDeleted = false; // 初始化删除状态为 false } + // 抽象方法：获取创建操作的 JSON 对象 public abstract JSONObject getCreateAction(int actionId); + // 抽象方法：获取更新操作的 JSON 对象 public abstract JSONObject getUpdateAction(int actionId); + // 抽象方法：根据远程 JSON 设置内容 public abstract void setContentByRemoteJSON(JSONObject js); + // 抽象方法：根据本地 JSON 设置内容 public abstract void setContentByLocalJSON(JSONObject js); + // 抽象方法：从内容获取本地 JSON 对象 public abstract JSONObject getLocalJSONFromContent(); + // 抽象方法：根据 Cursor 获取同步操作 public abstract int getSyncAction(Cursor c); + // 设置 Gid public void setGid(String gid) { this.mGid = gid; } + // 设置名称 public void setName(String name) { this.mName = name; } + // 设置最后修改时间 public void setLastModified(long lastModified) { this.mLastModified = lastModified; } + // 设置删除状态 public void setDeleted(boolean deleted) { this.mDeleted = deleted; } + // 获取 Gid public String getGid() { return this.mGid; } + // 获取名称 public String getName() { return this.mName; } + // 获取最后修改时间 public long getLastModified() { return this.mLastModified; } + // 获取删除状态 public boolean getDeleted() { return this.mDeleted; } - } diff --git a/gtask/data/SqlData.java b/gtask/data/SqlData.java index d3ec3be..0447243 100644 --- a/gtask/data/SqlData.java +++ b/gtask/data/SqlData.java @@ -34,138 +34,142 @@ import net.micode.notes.gtask.exception.ActionFailureException; import org.json.JSONException; import org.json.JSONObject; - +/** + * SqlData类用于处理与数据库交互的笔记数据，包括创建、读取和更新操作。 + */ public class SqlData { - private static final String TAG = SqlData.class.getSimpleName(); + private static final String TAG = SqlData.class.getSimpleName(); // 日志标签 - private static final int INVALID_ID = -99999; + private static final int INVALID_ID = -99999; // 无效 ID 常量 + // 定义用于查询的数据列 public static final String[] PROJECTION_DATA = new String[] { DataColumns.ID, DataColumns.MIME_TYPE, DataColumns.CONTENT, DataColumns.DATA1, DataColumns.DATA3 }; + // 数据列索引 public static final int DATA_ID_COLUMN = 0; - public static final int DATA_MIME_TYPE_COLUMN = 1; - public static final int DATA_CONTENT_COLUMN = 2; - public static final int DATA_CONTENT_DATA_1_COLUMN = 3; - public static final int DATA_CONTENT_DATA_3_COLUMN = 4; - private ContentResolver mContentResolver; + private ContentResolver mContentResolver; // 内容解析器，用于与内容提供者交互 - private boolean mIsCreate; + private boolean mIsCreate; // 标识是否为新创建的数据 - private long mDataId; + private long mDataId; // 数据 ID + private String mDataMimeType; // 数据 MIME 类型 + private String mDataContent; // 数据内容 + private long mDataContentData1; // 数据内容的附加信息 1 + private String mDataContentData3; // 数据内容的附加信息 3 - private String mDataMimeType; - - private String mDataContent; - - private long mDataContentData1; - - private String mDataContentData3; - - private ContentValues mDiffDataValues; + private ContentValues mDiffDataValues; // 存储待更新的内容值 + // 构造函数，初始化 SqlData 实例（用于创建新数据） public SqlData(Context context) { - mContentResolver = context.getContentResolver(); - mIsCreate = true; - mDataId = INVALID_ID; - mDataMimeType = DataConstants.NOTE; - mDataContent = ""; - mDataContentData1 = 0; - mDataContentData3 = ""; - mDiffDataValues = new ContentValues(); + mContentResolver = context.getContentResolver(); // 获取内容解析器 + mIsCreate = true; // 设置为创建状态 + mDataId = INVALID_ID; // 初始化数据 ID + mDataMimeType = DataConstants.NOTE; // 默认 MIME 类型 + mDataContent = ""; // 初始化内容为空 + mDataContentData1 = 0; // 初始化附加信息 1 + mDataContentData3 = ""; // 初始化附加信息 3 + mDiffDataValues = new ContentValues(); // 初始化待更新内容值 } + // 构造函数，初始化 SqlData 实例（从游标加载数据） public SqlData(Context context, Cursor c) { - mContentResolver = context.getContentResolver(); - mIsCreate = false; - loadFromCursor(c); - mDiffDataValues = new ContentValues(); + mContentResolver = context.getContentResolver(); // 获取内容解析器 + mIsCreate = false; // 设置为非创建状态 + loadFromCursor(c); // 从游标加载数据 + mDiffDataValues = new ContentValues(); // 初始化待更新内容值 } + // 从游标加载数据 private void loadFromCursor(Cursor c) { - mDataId = c.getLong(DATA_ID_COLUMN); - mDataMimeType = c.getString(DATA_MIME_TYPE_COLUMN); - mDataContent = c.getString(DATA_CONTENT_COLUMN); - mDataContentData1 = c.getLong(DATA_CONTENT_DATA_1_COLUMN); - mDataContentData3 = c.getString(DATA_CONTENT_DATA_3_COLUMN); + mDataId = c.getLong(DATA_ID_COLUMN); // 获取数据 ID + mDataMimeType = c.getString(DATA_MIME_TYPE_COLUMN); // 获取 MIME 类型 + mDataContent = c.getString(DATA_CONTENT_COLUMN); // 获取内容 + mDataContentData1 = c.getLong(DATA_CONTENT_DATA_1_COLUMN); // 获取附加信息 1 + mDataContentData3 = c.getString(DATA_CONTENT_DATA_3_COLUMN); // 获取附加信息 3 } + // 设置内容，从 JSON 对象加载数据 public void setContent(JSONObject js) throws JSONException { - long dataId = js.has(DataColumns.ID) ? js.getLong(DataColumns.ID) : INVALID_ID; + long dataId = js.has(DataColumns.ID) ? js.getLong(DataColumns.ID) : INVALID_ID; // 获取 ID if (mIsCreate || mDataId != dataId) { - mDiffDataValues.put(DataColumns.ID, dataId); + mDiffDataValues.put(DataColumns.ID, dataId); // 更新 ID } - mDataId = dataId; + mDataId = dataId; // 设置 ID String dataMimeType = js.has(DataColumns.MIME_TYPE) ? js.getString(DataColumns.MIME_TYPE) - : DataConstants.NOTE; + : DataConstants.NOTE; // 获取 MIME 类型 if (mIsCreate || !mDataMimeType.equals(dataMimeType)) { - mDiffDataValues.put(DataColumns.MIME_TYPE, dataMimeType); + mDiffDataValues.put(DataColumns.MIME_TYPE, dataMimeType); // 更新 MIME 类型 } - mDataMimeType = dataMimeType; + mDataMimeType = dataMimeType; // 设置 MIME 类型 - String dataContent = js.has(DataColumns.CONTENT) ? js.getString(DataColumns.CONTENT) : ""; + String dataContent = js.has(DataColumns.CONTENT) ? js.getString(DataColumns.CONTENT) : ""; // 获取内容 if (mIsCreate || !mDataContent.equals(dataContent)) { - mDiffDataValues.put(DataColumns.CONTENT, dataContent); + mDiffDataValues.put(DataColumns.CONTENT, dataContent); // 更新内容 } - mDataContent = dataContent; + mDataContent = dataContent; // 设置内容 - long dataContentData1 = js.has(DataColumns.DATA1) ? js.getLong(DataColumns.DATA1) : 0; + long dataContentData1 = js.has(DataColumns.DATA1) ? js.getLong(DataColumns.DATA1) : 0; // 获取附加信息 1 if (mIsCreate || mDataContentData1 != dataContentData1) { - mDiffDataValues.put(DataColumns.DATA1, dataContentData1); + mDiffDataValues.put(DataColumns.DATA1, dataContentData1); // 更新附加信息 1 } - mDataContentData1 = dataContentData1; + mDataContentData1 = dataContentData1; // 设置附加信息 1 - String dataContentData3 = js.has(DataColumns.DATA3) ? js.getString(DataColumns.DATA3) : ""; + String dataContentData3 = js.has(DataColumns.DATA3) ? js.getString(DataColumns.DATA3) : ""; // 获取附加信息 3 if (mIsCreate || !mDataContentData3.equals(dataContentData3)) { - mDiffDataValues.put(DataColumns.DATA3, dataContentData3); + mDiffDataValues.put(DataColumns.DATA3, dataContentData3); // 更新附加信息 3 } - mDataContentData3 = dataContentData3; + mDataContentData3 = dataContentData3; // 设置附加信息 3 } + // 获取内容，返回 JSON 对象 public JSONObject getContent() throws JSONException { if (mIsCreate) { - Log.e(TAG, "it seems that we haven't created this in database yet"); - return null; + Log.e(TAG, "it seems that we haven't created this in database yet"); // 日志警告 + return null; // 尚未创建，返回 null } - JSONObject js = new JSONObject(); - js.put(DataColumns.ID, mDataId); - js.put(DataColumns.MIME_TYPE, mDataMimeType); - js.put(DataColumns.CONTENT, mDataContent); - js.put(DataColumns.DATA1, mDataContentData1); - js.put(DataColumns.DATA3, mDataContentData3); - return js; + JSONObject js = new JSONObject(); // 创建 JSON 对象 + js.put(DataColumns.ID, mDataId); // 设置 ID + js.put(DataColumns.MIME_TYPE, mDataMimeType); // 设置 MIME 类型 + js.put(DataColumns.CONTENT, mDataContent); // 设置内容 + js.put(DataColumns.DATA1, mDataContentData1); // 设置附加信息 1 + js.put(DataColumns.DATA3, mDataContentData3); // 设置附加信息 3 + return js; // 返回 JSON 对象 } + // 提交数据到数据库 public void commit(long noteId, boolean validateVersion, long version) { - + // 处理创建新数据的情况 if (mIsCreate) { if (mDataId == INVALID_ID && mDiffDataValues.containsKey(DataColumns.ID)) { - mDiffDataValues.remove(DataColumns.ID); + mDiffDataValues.remove(DataColumns.ID); // 移除无效 ID } - mDiffDataValues.put(DataColumns.NOTE_ID, noteId); - Uri uri = mContentResolver.insert(Notes.CONTENT_DATA_URI, mDiffDataValues); + mDiffDataValues.put(DataColumns.NOTE_ID, noteId); // 设置笔记 ID + Uri uri = mContentResolver.insert(Notes.CONTENT_DATA_URI, mDiffDataValues); // 插入数据 try { - mDataId = Long.valueOf(uri.getPathSegments().get(1)); + mDataId = Long.valueOf(uri.getPathSegments().get(1)); // 获取新创建的 ID } catch (NumberFormatException e) { - Log.e(TAG, "Get note id error :" + e.toString()); - throw new ActionFailureException("create note failed"); + Log.e(TAG, "Get note id error :" + e.toString()); // 日志错误 + throw new ActionFailureException("create note failed"); // 抛出异常 } - } else { - if (mDiffDataValues.size() > 0) { + } else { // 处理更新数据的情况 + if (mDiffDataValues.size() > 0) { // 如果有待更新的数据 int result = 0; if (!validateVersion) { + // 不进行版本验证直接更新 result = mContentResolver.update(ContentUris.withAppendedId( Notes.CONTENT_DATA_URI, mDataId), mDiffDataValues, null, null); } else { + // 进行版本验证更新 result = mContentResolver.update(ContentUris.withAppendedId( Notes.CONTENT_DATA_URI, mDataId), mDiffDataValues, " ? in (SELECT " + NoteColumns.ID + " FROM " + TABLE.NOTE @@ -174,16 +178,17 @@ public class SqlData { }); } if (result == 0) { - Log.w(TAG, "there is no update. maybe user updates note when syncing"); + Log.w(TAG, "there is no update. maybe user updates note when syncing"); // 日志警告 } } } - mDiffDataValues.clear(); - mIsCreate = false; + mDiffDataValues.clear(); // 清空待更新数据 + mIsCreate = false; // 设置为非创建状态 } + // 获取数据 ID public long getId() { - return mDataId; + return mDataId; // 返回数据 ID } } diff --git a/gtask/data/Task.java b/gtask/data/Task.java index 6a19454..d51d834 100644 --- a/gtask/data/Task.java +++ b/gtask/data/Task.java @@ -1,17 +1,15 @@ /* - * Copyright (c) 2010-2011, The MiCode Open Source Community (www.micode.net) + * 版权所有 (c) 2010-2011, MiCode 开源社区 (www.micode.net) * - * Licensed under the Apache License, Version 2.0 (the "License"); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at + * 根据 Apache License, Version 2.0 (以下简称“许可协议”) 授权; + * 除非遵守许可协议，否则不得使用此文件。 + * 您可以在以下网址获取许可协议的副本： * * http://www.apache.org/licenses/LICENSE-2.0 * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. + * 除非适用法律要求或书面同意，根据许可协议分发的软件按“原样”提供， + * 不提供任何明示或暗示的担保或条件。 + * 请参阅许可协议了解许可权限及限制。 */ package net.micode.notes.gtask.data; @@ -31,20 +29,16 @@ import org.json.JSONArray; import org.json.JSONException; import org.json.JSONObject; - +// 任务类，继承自节点类 public class Task extends Node { - private static final String TAG = Task.class.getSimpleName(); - - private boolean mCompleted; - - private String mNotes; - - private JSONObject mMetaInfo; - - private Task mPriorSibling; - - private TaskList mParent; - + private static final String TAG = Task.class.getSimpleName(); // 日志标签 + private boolean mCompleted; // 任务完成标记 + private String mNotes; // 任务的备注 + private JSONObject mMetaInfo; // 任务的元信息 + private Task mPriorSibling; // 前一个兄弟任务 + private TaskList mParent; // 任务的父任务列表 + + // 构造方法，初始化任务属性 public Task() { super(); mCompleted = false; @@ -54,21 +48,22 @@ public class Task extends Node { mMetaInfo = null; } + // 创建任务的 JSON 对象 public JSONObject getCreateAction(int actionId) { JSONObject js = new JSONObject(); try { - // action_type + // 设置动作类型为创建 js.put(GTaskStringUtils.GTASK_JSON_ACTION_TYPE, GTaskStringUtils.GTASK_JSON_ACTION_TYPE_CREATE); - // action_id + // 设置动作 ID js.put(GTaskStringUtils.GTASK_JSON_ACTION_ID, actionId); - // index + // 设置任务的索引 js.put(GTaskStringUtils.GTASK_JSON_INDEX, mParent.getChildTaskIndex(this)); - // entity_delta + // 设置实体数据 JSONObject entity = new JSONObject(); entity.put(GTaskStringUtils.GTASK_JSON_NAME, getName()); entity.put(GTaskStringUtils.GTASK_JSON_CREATOR_ID, "null"); @@ -79,17 +74,17 @@ public class Task extends Node { } js.put(GTaskStringUtils.GTASK_JSON_ENTITY_DELTA, entity); - // parent_id + // 设置父任务 ID js.put(GTaskStringUtils.GTASK_JSON_PARENT_ID, mParent.getGid()); - // dest_parent_type + // 设置父任务类型 js.put(GTaskStringUtils.GTASK_JSON_DEST_PARENT_TYPE, GTaskStringUtils.GTASK_JSON_TYPE_GROUP); - // list_id + // 设置任务列表 ID js.put(GTaskStringUtils.GTASK_JSON_LIST_ID, mParent.getGid()); - // prior_sibling_id + // 设置前一个兄弟任务 ID if (mPriorSibling != null) { js.put(GTaskStringUtils.GTASK_JSON_PRIOR_SIBLING_ID, mPriorSibling.getGid()); } @@ -97,27 +92,22 @@ public class Task extends Node { } catch (JSONException e) { Log.e(TAG, e.toString()); e.printStackTrace(); - throw new ActionFailureException("fail to generate task-create jsonobject"); + throw new ActionFailureException("创建任务 JSON 对象失败"); } return js; } + // 更新任务的 JSON 对象 public JSONObject getUpdateAction(int actionId) { JSONObject js = new JSONObject(); try { - // action_type js.put(GTaskStringUtils.GTASK_JSON_ACTION_TYPE, GTaskStringUtils.GTASK_JSON_ACTION_TYPE_UPDATE); - - // action_id js.put(GTaskStringUtils.GTASK_JSON_ACTION_ID, actionId); - - // id js.put(GTaskStringUtils.GTASK_JSON_ID, getGid()); - // entity_delta JSONObject entity = new JSONObject(); entity.put(GTaskStringUtils.GTASK_JSON_NAME, getName()); if (getNotes() != null) { @@ -129,56 +119,47 @@ public class Task extends Node { } catch (JSONException e) { Log.e(TAG, e.toString()); e.printStackTrace(); - throw new ActionFailureException("fail to generate task-update jsonobject"); + throw new ActionFailureException("更新任务 JSON 对象失败"); } return js; } + // 从远程 JSON 设置任务内容 public void setContentByRemoteJSON(JSONObject js) { if (js != null) { try { - // id if (js.has(GTaskStringUtils.GTASK_JSON_ID)) { setGid(js.getString(GTaskStringUtils.GTASK_JSON_ID)); } - - // last_modified if (js.has(GTaskStringUtils.GTASK_JSON_LAST_MODIFIED)) { setLastModified(js.getLong(GTaskStringUtils.GTASK_JSON_LAST_MODIFIED)); } - - // name if (js.has(GTaskStringUtils.GTASK_JSON_NAME)) { setName(js.getString(GTaskStringUtils.GTASK_JSON_NAME)); } - - // notes if (js.has(GTaskStringUtils.GTASK_JSON_NOTES)) { setNotes(js.getString(GTaskStringUtils.GTASK_JSON_NOTES)); } - - // deleted if (js.has(GTaskStringUtils.GTASK_JSON_DELETED)) { setDeleted(js.getBoolean(GTaskStringUtils.GTASK_JSON_DELETED)); } - - // completed if (js.has(GTaskStringUtils.GTASK_JSON_COMPLETED)) { setCompleted(js.getBoolean(GTaskStringUtils.GTASK_JSON_COMPLETED)); } } catch (JSONException e) { Log.e(TAG, e.toString()); e.printStackTrace(); - throw new ActionFailureException("fail to get task content from jsonobject"); + throw new ActionFailureException("从 JSON 获取任务内容失败"); } } } + // 从本地 JSON 设置任务内容 public void setContentByLocalJSON(JSONObject js) { if (js == null || !js.has(GTaskStringUtils.META_HEAD_NOTE) || !js.has(GTaskStringUtils.META_HEAD_DATA)) { - Log.w(TAG, "setContentByLocalJSON: nothing is avaiable"); + Log.w(TAG, "setContentByLocalJSON: 数据为空"); } try { @@ -186,7 +167,7 @@ public class Task extends Node { JSONArray dataArray = js.getJSONArray(GTaskStringUtils.META_HEAD_DATA); if (note.getInt(NoteColumns.TYPE) != Notes.TYPE_NOTE) { - Log.e(TAG, "invalid type"); + Log.e(TAG, "无效类型"); return; } @@ -204,16 +185,15 @@ public class Task extends Node { } } + // 获取本地 JSON 内容 public JSONObject getLocalJSONFromContent() { String name = getName(); try { if (mMetaInfo == null) { - // new task created from web if (name == null) { - Log.w(TAG, "the note seems to be an empty one"); + Log.w(TAG, "笔记为空"); return null; } - JSONObject js = new JSONObject(); JSONObject note = new JSONObject(); JSONArray dataArray = new JSONArray(); @@ -225,7 +205,6 @@ public class Task extends Node { js.put(GTaskStringUtils.META_HEAD_NOTE, note); return js; } else { - // synced task JSONObject note = mMetaInfo.getJSONObject(GTaskStringUtils.META_HEAD_NOTE); JSONArray dataArray = mMetaInfo.getJSONArray(GTaskStringUtils.META_HEAD_DATA); @@ -247,6 +226,7 @@ public class Task extends Node { } } + // 设置元信息 public void setMetaInfo(MetaData metaData) { if (metaData != null && metaData.getNotes() != null) { try { @@ -258,6 +238,7 @@ public class Task extends Node { } } + // 获取同步操作 public int getSyncAction(Cursor c) { try { JSONObject noteInfo = null; @@ -266,38 +247,32 @@ public class Task extends Node { } if (noteInfo == null) { - Log.w(TAG, "it seems that note meta has been deleted"); + Log.w(TAG, "笔记元数据已删除"); return SYNC_ACTION_UPDATE_REMOTE; } if (!noteInfo.has(NoteColumns.ID)) { - Log.w(TAG, "remote note id seems to be deleted"); + Log.w(TAG, "远程笔记 ID 似乎被删除"); return SYNC_ACTION_UPDATE_LOCAL; } - // validate the note id now if (c.getLong(SqlNote.ID_COLUMN) != noteInfo.getLong(NoteColumns.ID)) { - Log.w(TAG, "note id doesn't match"); + Log.w(TAG, "笔记 ID 不匹配"); return SYNC_ACTION_UPDATE_LOCAL; } if (c.getInt(SqlNote.LOCAL_MODIFIED_COLUMN) == 0) { - // there is no local update if (c.getLong(SqlNote.SYNC_ID_COLUMN) == getLastModified()) { - // no update both side return SYNC_ACTION_NONE; } else { - // apply remote to local return SYNC_ACTION_UPDATE_LOCAL; } } else { - // validate gtask id if (!c.getString(SqlNote.GTASK_ID_COLUMN).equals(getGid())) { - Log.e(TAG, "gtask id doesn't match"); + Log.e(TAG, "gtask ID 不匹配"); return SYNC_ACTION_ERROR; } if (c.getLong(SqlNote.SYNC_ID_COLUMN) == getLastModified()) { - // local modification only return SYNC_ACTION_UPDATE_REMOTE; } else { return SYNC_ACTION_UPDATE_CONFLICT; @@ -311,41 +286,49 @@ public class Task extends Node { return SYNC_ACTION_ERROR; } + // 检查任务是否值得保存 public boolean isWorthSaving() { return mMetaInfo != null || (getName() != null && getName().trim().length() > 0) || (getNotes() != null && getNotes().trim().length() > 0); } + // 设置任务完成状态 public void setCompleted(boolean completed) { this.mCompleted = completed; } + // 设置备注 public void setNotes(String notes) { this.mNotes = notes; } + // 设置前一个兄弟任务 public void setPriorSibling(Task priorSibling) { this.mPriorSibling = priorSibling; } + // 设置父任务列表 public void setParent(TaskList parent) { this.mParent = parent; } + // 获取任务完成状态 public boolean getCompleted() { return this.mCompleted; } + // 获取备注 public String getNotes() { return this.mNotes; } + // 获取前一个兄弟任务 public Task getPriorSibling() { return this.mPriorSibling; } + // 获取父任务列表 public TaskList getParent() { return this.mParent; } - } diff --git a/gtask/data/TaskList.java b/gtask/data/TaskList.java index 4ea21c5..814b349 100644 --- a/gtask/data/TaskList.java +++ b/gtask/data/TaskList.java @@ -1,17 +1,15 @@ /* - * Copyright (c) 2010-2011, The MiCode Open Source Community (www.micode.net) + * 版权所有 (c) 2010-2011, MiCode 开源社区 (www.micode.net) * - * Licensed under the Apache License, Version 2.0 (the "License"); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at + * 根据 Apache 许可证 2.0 版授权 ("许可证"); + * 只有在符合许可证的情况下，您才能使用此文件。 + * 您可以在以下位置获取许可证副本： * * http://www.apache.org/licenses/LICENSE-2.0 * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. + * 除非适用法律要求或书面同意，按“原样”分发的许可证软件， + * 无任何明示或暗示的担保或条件。 + * 请参阅许可证以获取许可下的具体语言和限制。 */ package net.micode.notes.gtask.data; @@ -29,109 +27,107 @@ import org.json.JSONObject; import java.util.ArrayList; - +/** + * 任务列表类，继承自节点类 + */ public class TaskList extends Node { - private static final String TAG = TaskList.class.getSimpleName(); + private static final String TAG = TaskList.class.getSimpleName(); // 日志标签 - private int mIndex; + private int mIndex; // 索引号 - private ArrayList mChildren; + private ArrayList mChildren; // 子任务列表 + // 构造函数 public TaskList() { super(); mChildren = new ArrayList(); mIndex = 1; } + /** + * 创建任务列表的JSON对象 + * @param actionId 动作ID + * @return 创建的JSON对象 + */ public JSONObject getCreateAction(int actionId) { JSONObject js = new JSONObject(); - try { - // action_type - js.put(GTaskStringUtils.GTASK_JSON_ACTION_TYPE, - GTaskStringUtils.GTASK_JSON_ACTION_TYPE_CREATE); - - // action_id - js.put(GTaskStringUtils.GTASK_JSON_ACTION_ID, actionId); + js.put(GTaskStringUtils.GTASK_JSON_ACTION_TYPE, GTaskStringUtils.GTASK_JSON_ACTION_TYPE_CREATE); // 动作类型 + js.put(GTaskStringUtils.GTASK_JSON_ACTION_ID, actionId); // 动作ID + js.put(GTaskStringUtils.GTASK_JSON_INDEX, mIndex); // 索引 - // index - js.put(GTaskStringUtils.GTASK_JSON_INDEX, mIndex); - - // entity_delta + // 设置实体信息 JSONObject entity = new JSONObject(); - entity.put(GTaskStringUtils.GTASK_JSON_NAME, getName()); - entity.put(GTaskStringUtils.GTASK_JSON_CREATOR_ID, "null"); - entity.put(GTaskStringUtils.GTASK_JSON_ENTITY_TYPE, - GTaskStringUtils.GTASK_JSON_TYPE_GROUP); + entity.put(GTaskStringUtils.GTASK_JSON_NAME, getName()); // 名称 + entity.put(GTaskStringUtils.GTASK_JSON_CREATOR_ID, "null"); // 创建者ID + entity.put(GTaskStringUtils.GTASK_JSON_ENTITY_TYPE, GTaskStringUtils.GTASK_JSON_TYPE_GROUP); // 实体类型 js.put(GTaskStringUtils.GTASK_JSON_ENTITY_DELTA, entity); } catch (JSONException e) { Log.e(TAG, e.toString()); e.printStackTrace(); - throw new ActionFailureException("fail to generate tasklist-create jsonobject"); + throw new ActionFailureException("生成任务列表创建JSON对象失败"); } - return js; } + /** + * 更新任务列表的JSON对象 + * @param actionId 动作ID + * @return 更新的JSON对象 + */ public JSONObject getUpdateAction(int actionId) { JSONObject js = new JSONObject(); - try { - // action_type - js.put(GTaskStringUtils.GTASK_JSON_ACTION_TYPE, - GTaskStringUtils.GTASK_JSON_ACTION_TYPE_UPDATE); + js.put(GTaskStringUtils.GTASK_JSON_ACTION_TYPE, GTaskStringUtils.GTASK_JSON_ACTION_TYPE_UPDATE); // 动作类型 + js.put(GTaskStringUtils.GTASK_JSON_ACTION_ID, actionId); // 动作ID + js.put(GTaskStringUtils.GTASK_JSON_ID, getGid()); // 任务ID - // action_id - js.put(GTaskStringUtils.GTASK_JSON_ACTION_ID, actionId); - - // id - js.put(GTaskStringUtils.GTASK_JSON_ID, getGid()); - - // entity_delta + // 设置实体信息 JSONObject entity = new JSONObject(); - entity.put(GTaskStringUtils.GTASK_JSON_NAME, getName()); - entity.put(GTaskStringUtils.GTASK_JSON_DELETED, getDeleted()); + entity.put(GTaskStringUtils.GTASK_JSON_NAME, getName()); // 名称 + entity.put(GTaskStringUtils.GTASK_JSON_DELETED, getDeleted()); // 删除状态 js.put(GTaskStringUtils.GTASK_JSON_ENTITY_DELTA, entity); } catch (JSONException e) { Log.e(TAG, e.toString()); e.printStackTrace(); - throw new ActionFailureException("fail to generate tasklist-update jsonobject"); + throw new ActionFailureException("生成任务列表更新JSON对象失败"); } - return js; } + /** + * 从远程JSON设置任务列表内容 + */ public void setContentByRemoteJSON(JSONObject js) { if (js != null) { try { - // id if (js.has(GTaskStringUtils.GTASK_JSON_ID)) { - setGid(js.getString(GTaskStringUtils.GTASK_JSON_ID)); + setGid(js.getString(GTaskStringUtils.GTASK_JSON_ID)); // 设置ID } - - // last_modified if (js.has(GTaskStringUtils.GTASK_JSON_LAST_MODIFIED)) { - setLastModified(js.getLong(GTaskStringUtils.GTASK_JSON_LAST_MODIFIED)); + setLastModified(js.getLong(GTaskStringUtils.GTASK_JSON_LAST_MODIFIED)); // 设置最后修改时间 } - - // name if (js.has(GTaskStringUtils.GTASK_JSON_NAME)) { - setName(js.getString(GTaskStringUtils.GTASK_JSON_NAME)); + setName(js.getString(GTaskStringUtils.GTASK_JSON_NAME)); // 设置名称 } } catch (JSONException e) { Log.e(TAG, e.toString()); e.printStackTrace(); - throw new ActionFailureException("fail to get tasklist content from jsonobject"); + throw new ActionFailureException("从JSON对象获取任务列表内容失败"); } } } + /** + * 从本地JSON设置任务列表内容 + */ public void setContentByLocalJSON(JSONObject js) { if (js == null || !js.has(GTaskStringUtils.META_HEAD_NOTE)) { - Log.w(TAG, "setContentByLocalJSON: nothing is avaiable"); + Log.w(TAG, "setContentByLocalJSON: 无可用内容"); + return; } try { @@ -144,12 +140,11 @@ public class TaskList extends Node { if (folder.getLong(NoteColumns.ID) == Notes.ID_ROOT_FOLDER) setName(GTaskStringUtils.MIUI_FOLDER_PREFFIX + GTaskStringUtils.FOLDER_DEFAULT); else if (folder.getLong(NoteColumns.ID) == Notes.ID_CALL_RECORD_FOLDER) - setName(GTaskStringUtils.MIUI_FOLDER_PREFFIX - + GTaskStringUtils.FOLDER_CALL_NOTE); + setName(GTaskStringUtils.MIUI_FOLDER_PREFFIX + GTaskStringUtils.FOLDER_CALL_NOTE); else - Log.e(TAG, "invalid system folder"); + Log.e(TAG, "无效的系统文件夹"); } else { - Log.e(TAG, "error type"); + Log.e(TAG, "错误的类型"); } } catch (JSONException e) { Log.e(TAG, e.toString()); @@ -157,21 +152,24 @@ public class TaskList extends Node { } } + /** + * 获取任务列表内容并转换为本地JSON对象 + */ public JSONObject getLocalJSONFromContent() { try { JSONObject js = new JSONObject(); JSONObject folder = new JSONObject(); - String folderName = getName(); - if (getName().startsWith(GTaskStringUtils.MIUI_FOLDER_PREFFIX)) - folderName = folderName.substring(GTaskStringUtils.MIUI_FOLDER_PREFFIX.length(), - folderName.length()); + + // 处理文件夹名称 + if (getName().startsWith(GTaskStringUtils.MIUI_FOLDER_PREFFIX)) { + folderName = folderName.substring(GTaskStringUtils.MIUI_FOLDER_PREFFIX.length()); + } + folder.put(NoteColumns.SNIPPET, folderName); - if (folderName.equals(GTaskStringUtils.FOLDER_DEFAULT) - || folderName.equals(GTaskStringUtils.FOLDER_CALL_NOTE)) - folder.put(NoteColumns.TYPE, Notes.TYPE_SYSTEM); - else - folder.put(NoteColumns.TYPE, Notes.TYPE_FOLDER); + folder.put(NoteColumns.TYPE, folderName.equals(GTaskStringUtils.FOLDER_DEFAULT) + || folderName.equals(GTaskStringUtils.FOLDER_CALL_NOTE) + ? Notes.TYPE_SYSTEM : Notes.TYPE_FOLDER); js.put(GTaskStringUtils.META_HEAD_NOTE, folder); @@ -183,125 +181,116 @@ public class TaskList extends Node { } } + /** + * 根据游标信息获取同步操作类型 + */ public int getSyncAction(Cursor c) { try { if (c.getInt(SqlNote.LOCAL_MODIFIED_COLUMN) == 0) { - // there is no local update - if (c.getLong(SqlNote.SYNC_ID_COLUMN) == getLastModified()) { - // no update both side - return SYNC_ACTION_NONE; - } else { - // apply remote to local - return SYNC_ACTION_UPDATE_LOCAL; - } + // 没有本地更新 + return c.getLong(SqlNote.SYNC_ID_COLUMN) == getLastModified() ? SYNC_ACTION_NONE : SYNC_ACTION_UPDATE_LOCAL; } else { - // validate gtask id + // 验证任务ID if (!c.getString(SqlNote.GTASK_ID_COLUMN).equals(getGid())) { - Log.e(TAG, "gtask id doesn't match"); + Log.e(TAG, "任务ID不匹配"); return SYNC_ACTION_ERROR; } - if (c.getLong(SqlNote.SYNC_ID_COLUMN) == getLastModified()) { - // local modification only - return SYNC_ACTION_UPDATE_REMOTE; - } else { - // for folder conflicts, just apply local modification - return SYNC_ACTION_UPDATE_REMOTE; - } + return c.getLong(SqlNote.SYNC_ID_COLUMN) == getLastModified() ? SYNC_ACTION_UPDATE_REMOTE : SYNC_ACTION_UPDATE_REMOTE; } } catch (Exception e) { Log.e(TAG, e.toString()); e.printStackTrace(); } - return SYNC_ACTION_ERROR; } + /** + * 获取子任务数量 + */ public int getChildTaskCount() { return mChildren.size(); } + /** + * 添加子任务 + */ public boolean addChildTask(Task task) { - boolean ret = false; if (task != null && !mChildren.contains(task)) { - ret = mChildren.add(task); + boolean ret = mChildren.add(task); if (ret) { - // need to set prior sibling and parent - task.setPriorSibling(mChildren.isEmpty() ? null : mChildren - .get(mChildren.size() - 1)); + task.setPriorSibling(mChildren.isEmpty() ? null : mChildren.get(mChildren.size() - 1)); task.setParent(this); } + return ret; } - return ret; + return false; } + /** + * 添加子任务到指定位置 + */ public boolean addChildTask(Task task, int index) { if (index < 0 || index > mChildren.size()) { - Log.e(TAG, "add child task: invalid index"); + Log.e(TAG, "添加子任务：无效索引"); return false; } - - int pos = mChildren.indexOf(task); - if (task != null && pos == -1) { + if (task != null && mChildren.indexOf(task) == -1) { mChildren.add(index, task); - // update the task list - Task preTask = null; - Task afterTask = null; - if (index != 0) - preTask = mChildren.get(index - 1); - if (index != mChildren.size() - 1) - afterTask = mChildren.get(index + 1); + // 更新子任务链 + Task preTask = index != 0 ? mChildren.get(index - 1) : null; + Task afterTask = index != mChildren.size() - 1 ? mChildren.get(index + 1) : null; task.setPriorSibling(preTask); - if (afterTask != null) + if (afterTask != null) { afterTask.setPriorSibling(task); + } } - return true; } + /** + * 从任务列表中删除子任务 + */ public boolean removeChildTask(Task task) { - boolean ret = false; int index = mChildren.indexOf(task); if (index != -1) { - ret = mChildren.remove(task); - + boolean ret = mChildren.remove(task); if (ret) { - // reset prior sibling and parent task.setPriorSibling(null); task.setParent(null); - // update the task list + // 更新任务链 if (index != mChildren.size()) { - mChildren.get(index).setPriorSibling( - index == 0 ? null : mChildren.get(index - 1)); + mChildren.get(index).setPriorSibling(index == 0 ? null : mChildren.get(index - 1)); } } + return ret; } - return ret; + return false; } + /** + * 移动子任务到指定位置 + */ public boolean moveChildTask(Task task, int index) { - if (index < 0 || index >= mChildren.size()) { - Log.e(TAG, "move child task: invalid index"); + Log.e(TAG, "移动子任务：无效索引"); return false; } - int pos = mChildren.indexOf(task); if (pos == -1) { - Log.e(TAG, "move child task: the task should in the list"); + Log.e(TAG, "移动子任务：任务应在列表中"); return false; } - - if (pos == index) - return true; - return (removeChildTask(task) && addChildTask(task, index)); + return pos == index || (removeChildTask(task) && addChildTask(task, index)); } + /** + * 通过GID查找子任务 + */ public Task findChildTaskByGid(String gid) { - for (int i = 0; i < mChildren.size(); i++) { - Task t = mChildren.get(i); + for (Task t : mChildren) { if (t.getGid().equals(gid)) { return t; } @@ -309,34 +298,53 @@ public class TaskList extends Node { return null; } + /** + * 获取子任务的索引 + */ public int getChildTaskIndex(Task task) { return mChildren.indexOf(task); } + /** + * 通过索引获取子任务 + */ public Task getChildTaskByIndex(int index) { if (index < 0 || index >= mChildren.size()) { - Log.e(TAG, "getTaskByIndex: invalid index"); + Log.e(TAG, "getTaskByIndex: 无效索引"); return null; } return mChildren.get(index); } + /** + * 通过GID获取子任务 + */ public Task getChilTaskByGid(String gid) { for (Task task : mChildren) { - if (task.getGid().equals(gid)) + if (task.getGid().equals(gid)) { return task; + } } return null; } + /** + * 获取子任务列表 + */ public ArrayList getChildTaskList() { return this.mChildren; } + /** + * 设置索引 + */ public void setIndex(int index) { this.mIndex = index; } + /** + * 获取索引 + */ public int getIndex() { return this.mIndex; } diff --git a/gtask/exception/ActionFailureException.java b/gtask/exception/ActionFailureException.java index 15504be..7af63a6 100644 --- a/gtask/exception/ActionFailureException.java +++ b/gtask/exception/ActionFailureException.java @@ -16,18 +16,37 @@ package net.micode.notes.gtask.exception; +/** + * ActionFailureException 类是用于表示操作失败时抛出的异常。 + * 它继承自 RuntimeException，因此它是一个非检查型异常（unchecked exception）， + * 这意味着在方法签名中不需要声明此异常可能会被抛出。 + */ public class ActionFailureException extends RuntimeException { + + // 序列化版本唯一标识符，用于确保类的不同版本之间的兼容性。 private static final long serialVersionUID = 4425249765923293627L; + /** + * 构造一个没有详细信息消息和原因的 ActionFailureException。 + */ public ActionFailureException() { super(); } + /** + * 使用指定的详细信息消息构造一个新的 ActionFailureException。 + * @param paramString 提供更多关于异常的信息的消息字符串。 + */ public ActionFailureException(String paramString) { super(paramString); } + /** + * 使用指定的详细信息消息和原因构造一个新的 ActionFailureException。 + * @param paramString 提供更多关于异常的信息的消息字符串。 + * @param paramThrowable 导致当前异常的底层原因。 + */ public ActionFailureException(String paramString, Throwable paramThrowable) { super(paramString, paramThrowable); } -} +} \ No newline at end of file diff --git a/gtask/exception/NetworkFailureException.java b/gtask/exception/NetworkFailureException.java index b08cfb1..9e50613 100644 --- a/gtask/exception/NetworkFailureException.java +++ b/gtask/exception/NetworkFailureException.java @@ -16,18 +16,37 @@ package net.micode.notes.gtask.exception; +/** + * NetworkFailureException 类是用于表示网络操作失败时抛出的异常。 + * 它继承自 Exception，因此它是一个检查型异常（checked exception）， + * 这意味着在方法签名中需要声明此异常可能会被抛出，以确保调用者处理或重新抛出该异常。 + */ public class NetworkFailureException extends Exception { + + // 序列化版本唯一标识符，用于确保类的不同版本之间的兼容性。 private static final long serialVersionUID = 2107610287180234136L; + /** + * 构造一个新的 NetworkFailureException，不带任何详细信息消息或原因。 + */ public NetworkFailureException() { super(); } - public NetworkFailureException(String paramString) { - super(paramString); + /** + * 使用指定的详细信息消息构造一个新的 NetworkFailureException。 + * @param message 提供更多关于异常的信息的消息字符串。 + */ + public NetworkFailureException(String message) { + super(message); } - public NetworkFailureException(String paramString, Throwable paramThrowable) { - super(paramString, paramThrowable); + /** + * 使用指定的详细信息消息和原因构造一个新的 NetworkFailureException。 + * @param message 提供更多关于异常的信息的消息字符串。 + * @param cause 导致当前异常的底层原因。 + */ + public NetworkFailureException(String message, Throwable cause) { + super(message, cause); } -} +} \ No newline at end of file diff --git a/gtask/remote/GTaskASyncTask.java b/gtask/remote/GTaskASyncTask.java index b3b61e7..c9d2171 100644 --- a/gtask/remote/GTaskASyncTask.java +++ b/gtask/remote/GTaskASyncTask.java @@ -1,4 +1,3 @@ - /* * Copyright (c) 2010-2011, The MiCode Open Source Community (www.micode.net) * @@ -28,96 +27,148 @@ import net.micode.notes.R; import net.micode.notes.ui.NotesListActivity; import net.micode.notes.ui.NotesPreferenceActivity; - +/** + * GTaskASyncTask 类用于异步执行Google任务（GTask）同步操作。 + * 它继承自 AsyncTask，以便在后台线程中执行耗时的网络操作， + * 并通过主线程更新用户界面或发送通知。 + */ public class GTaskASyncTask extends AsyncTask { - private static int GTASK_SYNC_NOTIFICATION_ID = 5234235; + // 用于同步操作的通知ID，确保唯一性。 + private static final int GTASK_SYNC_NOTIFICATION_ID = 5234235; + /** + * 当同步完成时调用的接口。 + */ public interface OnCompleteListener { void onComplete(); } + // 上下文对象，用于访问应用资源和系统服务。 private Context mContext; + // 管理通知的服务。 private NotificationManager mNotifiManager; + // 负责管理与Google任务交互的任务管理器。 private GTaskManager mTaskManager; + // 同步完成后调用的监听器。 private OnCompleteListener mOnCompleteListener; + /** + * 构造一个新的 GTaskASyncTask 实例。 + * @param context 应用上下文。 + * @param listener 同步完成后的回调监听器。 + */ public GTaskASyncTask(Context context, OnCompleteListener listener) { mContext = context; mOnCompleteListener = listener; - mNotifiManager = (NotificationManager) mContext - .getSystemService(Context.NOTIFICATION_SERVICE); + mNotifiManager = (NotificationManager) mContext.getSystemService(Context.NOTIFICATION_SERVICE); mTaskManager = GTaskManager.getInstance(); } + /** + * 取消正在进行的同步操作。 + */ public void cancelSync() { mTaskManager.cancelSync(); } + /** + * 更新进度信息。 + * @param message 进度消息文本。 + */ public void publishProgess(String message) { - publishProgress(new String[] { - message - }); + publishProgress(new String[]{message}); } + /** + * 显示一个通知给用户。 + * @param tickerId 通知栏提示文字的资源ID。 + * @param content 通知内容文本。 + */ private void showNotification(int tickerId, String content) { - Notification notification = new Notification(R.drawable.notification, mContext - .getString(tickerId), System.currentTimeMillis()); + Notification notification = new Notification(R.drawable.notification, + mContext.getString(tickerId), + System.currentTimeMillis()); notification.defaults = Notification.DEFAULT_LIGHTS; notification.flags = Notification.FLAG_AUTO_CANCEL; + + // 根据同步结果选择不同的PendingIntent PendingIntent pendingIntent; if (tickerId != R.string.ticker_success) { - pendingIntent = PendingIntent.getActivity(mContext, 0, new Intent(mContext, - NotesPreferenceActivity.class), 0); - + pendingIntent = PendingIntent.getActivity(mContext, 0, + new Intent(mContext, NotesPreferenceActivity.class), 0); } else { - pendingIntent = PendingIntent.getActivity(mContext, 0, new Intent(mContext, - NotesListActivity.class), 0); + pendingIntent = PendingIntent.getActivity(mContext, 0, + new Intent(mContext, NotesListActivity.class), 0); } - notification.setLatestEventInfo(mContext, mContext.getString(R.string.app_name), content, - pendingIntent); + + // 设置通知详情，并显示通知 + notification.setLatestEventInfo(mContext, mContext.getString(R.string.app_name), content, pendingIntent); mNotifiManager.notify(GTASK_SYNC_NOTIFICATION_ID, notification); } + /** + * 在后台线程中执行的实际同步逻辑。 + */ @Override protected Integer doInBackground(Void... unused) { - publishProgess(mContext.getString(R.string.sync_progress_login, NotesPreferenceActivity - .getSyncAccountName(mContext))); + // 发布登录进度信息 + publishProgess(mContext.getString(R.string.sync_progress_login, + NotesPreferenceActivity.getSyncAccountName(mContext))); + // 执行同步操作并返回状态码 return mTaskManager.sync(mContext, this); } + /** + * 更新UI线程上的进度。 + */ @Override protected void onProgressUpdate(String... progress) { + // 显示同步中的通知 showNotification(R.string.ticker_syncing, progress[0]); + // 如果上下文是GTaskSyncService，则广播进度信息 if (mContext instanceof GTaskSyncService) { ((GTaskSyncService) mContext).sendBroadcast(progress[0]); } } + /** + * 同步完成后，在UI线程上执行此方法。 + */ @Override protected void onPostExecute(Integer result) { - if (result == GTaskManager.STATE_SUCCESS) { - showNotification(R.string.ticker_success, mContext.getString( - R.string.success_sync_account, mTaskManager.getSyncAccount())); - NotesPreferenceActivity.setLastSyncTime(mContext, System.currentTimeMillis()); - } else if (result == GTaskManager.STATE_NETWORK_ERROR) { - showNotification(R.string.ticker_fail, mContext.getString(R.string.error_sync_network)); - } else if (result == GTaskManager.STATE_INTERNAL_ERROR) { - showNotification(R.string.ticker_fail, mContext.getString(R.string.error_sync_internal)); - } else if (result == GTaskManager.STATE_SYNC_CANCELLED) { - showNotification(R.string.ticker_cancel, mContext - .getString(R.string.error_sync_cancelled)); + // 根据同步结果显示不同通知 + switch(result) { + case GTaskManager.STATE_SUCCESS: + showNotification(R.string.ticker_success, + mContext.getString(R.string.success_sync_account, mTaskManager.getSyncAccount())); + NotesPreferenceActivity.setLastSyncTime(mContext, System.currentTimeMillis()); + break; + case GTaskManager.STATE_NETWORK_ERROR: + showNotification(R.string.ticker_fail, + mContext.getString(R.string.error_sync_network)); + break; + case GTaskManager.STATE_INTERNAL_ERROR: + showNotification(R.string.ticker_fail, + mContext.getString(R.string.error_sync_internal)); + break; + case GTaskManager.STATE_SYNC_CANCELLED: + showNotification(R.string.ticker_cancel, + mContext.getString(R.string.error_sync_cancelled)); + break; } + + // 如果存在监听器，则启动新线程调用onComplete方法 if (mOnCompleteListener != null) { new Thread(new Runnable() { - + @Override public void run() { mOnCompleteListener.onComplete(); } }).start(); } } -} +} \ No newline at end of file diff --git a/gtask/remote/GTaskClient.java b/gtask/remote/GTaskClient.java index c67dfdf..8ae8950 100644 --- a/gtask/remote/GTaskClient.java +++ b/gtask/remote/GTaskClient.java @@ -60,36 +60,27 @@ import java.util.zip.GZIPInputStream; import java.util.zip.Inflater; import java.util.zip.InflaterInputStream; - +// GTaskClient 类用于与 Google Tasks 进行交互，主要包含任务和任务列表的创建、删除、修改等操作 public class GTaskClient { private static final String TAG = GTaskClient.class.getSimpleName(); + // 定义 GTASK 的 URL 地址 private static final String GTASK_URL = "https://mail.google.com/tasks/"; - private static final String GTASK_GET_URL = "https://mail.google.com/tasks/ig"; - private static final String GTASK_POST_URL = "https://mail.google.com/tasks/r/ig"; - private static GTaskClient mInstance = null; - - private DefaultHttpClient mHttpClient; - - private String mGetUrl; - - private String mPostUrl; - - private long mClientVersion; - - private boolean mLoggedin; - - private long mLastLoginTime; - - private int mActionId; - - private Account mAccount; - - private JSONArray mUpdateArray; - + private static GTaskClient mInstance = null; // 单例对象 + private DefaultHttpClient mHttpClient; // HTTP 客户端 + private String mGetUrl; // GET 请求 URL + private String mPostUrl; // POST 请求 URL + private long mClientVersion; // 客户端版本 + private boolean mLoggedin; // 登录状态 + private long mLastLoginTime; // 上次登录时间 + private int mActionId; // 操作 ID，用于唯一标识每个操作 + private Account mAccount; // 当前登录的 Google 帐号 + private JSONArray mUpdateArray; // 更新操作数组 + + // 私有化构造方法，避免外部实例化 private GTaskClient() { mHttpClient = null; mGetUrl = GTASK_GET_URL; @@ -102,6 +93,7 @@ public class GTaskClient { mUpdateArray = null; } + // 单例模式获取 GTaskClient 实例 public static synchronized GTaskClient getInstance() { if (mInstance == null) { mInstance = new GTaskClient(); @@ -109,36 +101,33 @@ public class GTaskClient { return mInstance; } + // 登录方法，返回是否成功 public boolean login(Activity activity) { - // we suppose that the cookie would expire after 5 minutes - // then we need to re-login + // 每 5 分钟重新登录一次 final long interval = 1000 * 60 * 5; if (mLastLoginTime + interval < System.currentTimeMillis()) { mLoggedin = false; } - // need to re-login after account switch - if (mLoggedin - && !TextUtils.equals(getSyncAccount().name, NotesPreferenceActivity - .getSyncAccountName(activity))) { + // 如果切换了帐号，也需要重新登录 + if (mLoggedin && !TextUtils.equals(getSyncAccount().name, NotesPreferenceActivity.getSyncAccountName(activity))) { mLoggedin = false; } if (mLoggedin) { - Log.d(TAG, "already logged in"); + Log.d(TAG, "已经登录"); return true; } mLastLoginTime = System.currentTimeMillis(); String authToken = loginGoogleAccount(activity, false); if (authToken == null) { - Log.e(TAG, "login google account failed"); + Log.e(TAG, "Google 帐号登录失败"); return false; } - // login with custom domain if necessary - if (!(mAccount.name.toLowerCase().endsWith("gmail.com") || mAccount.name.toLowerCase() - .endsWith("googlemail.com"))) { + // 如果是自定义域名帐号，需要构建对应的 URL + if (!(mAccount.name.toLowerCase().endsWith("gmail.com") || mAccount.name.toLowerCase().endsWith("googlemail.com"))) { StringBuilder url = new StringBuilder(GTASK_URL).append("a/"); int index = mAccount.name.indexOf('@') + 1; String suffix = mAccount.name.substring(index); @@ -151,7 +140,7 @@ public class GTaskClient { } } - // try to login with google official url + // 尝试使用 Google 官方 URL 登录 if (!mLoggedin) { mGetUrl = GTASK_GET_URL; mPostUrl = GTASK_POST_URL; @@ -164,16 +153,18 @@ public class GTaskClient { return true; } + // 获取授权令牌 private String loginGoogleAccount(Activity activity, boolean invalidateToken) { String authToken; AccountManager accountManager = AccountManager.get(activity); Account[] accounts = accountManager.getAccountsByType("com.google"); if (accounts.length == 0) { - Log.e(TAG, "there is no available google account"); + Log.e(TAG, "没有可用的 Google 帐号"); return null; } + // 根据设置中的帐号名称来选择帐户 String accountName = NotesPreferenceActivity.getSyncAccountName(activity); Account account = null; for (Account a : accounts) { @@ -185,13 +176,12 @@ public class GTaskClient { if (account != null) { mAccount = account; } else { - Log.e(TAG, "unable to get an account with the same name in the settings"); + Log.e(TAG, "无法找到相同名称的帐户"); return null; } - // get the token now - AccountManagerFuture accountManagerFuture = accountManager.getAuthToken(account, - "goanna_mobile", null, activity, null, null); + // 获取授权令牌 + AccountManagerFuture accountManagerFuture = accountManager.getAuthToken(account, "goanna_mobile", null, activity, null, null); try { Bundle authTokenBundle = accountManagerFuture.getResult(); authToken = authTokenBundle.getString(AccountManager.KEY_AUTHTOKEN); @@ -200,31 +190,32 @@ public class GTaskClient { loginGoogleAccount(activity, false); } } catch (Exception e) { - Log.e(TAG, "get auth token failed"); + Log.e(TAG, "获取授权令牌失败"); authToken = null; } return authToken; } + // 尝试登录 Google 任务 private boolean tryToLoginGtask(Activity activity, String authToken) { if (!loginGtask(authToken)) { - // maybe the auth token is out of date, now let's invalidate the - // token and try again + // 如果授权令牌过期，重新登录 authToken = loginGoogleAccount(activity, true); if (authToken == null) { - Log.e(TAG, "login google account failed"); + Log.e(TAG, "Google 帐号登录失败"); return false; } if (!loginGtask(authToken)) { - Log.e(TAG, "login gtask failed"); + Log.e(TAG, "登录 Google Tasks 失败"); return false; } } return true; } + // 通过授权令牌登录 Google Tasks private boolean loginGtask(String authToken) { int timeoutConnection = 10000; int timeoutSocket = 15000; @@ -236,14 +227,13 @@ public class GTaskClient { mHttpClient.setCookieStore(localBasicCookieStore); HttpProtocolParams.setUseExpectContinue(mHttpClient.getParams(), false); - // login gtask + // 登录 Google 任务 try { String loginUrl = mGetUrl + "?auth=" + authToken; HttpGet httpGet = new HttpGet(loginUrl); - HttpResponse response = null; - response = mHttpClient.execute(httpGet); + HttpResponse response = mHttpClient.execute(httpGet); - // get the cookie now + // 获取 Cookie List cookies = mHttpClient.getCookieStore().getCookies(); boolean hasAuthCookie = false; for (Cookie cookie : cookies) { @@ -252,334 +242,47 @@ public class GTaskClient { } } if (!hasAuthCookie) { - Log.w(TAG, "it seems that there is no auth cookie"); + Log.w(TAG, "未找到授权 Cookie"); } - // get the client version + // 获取客户端版本 String resString = getResponseContent(response.getEntity()); String jsBegin = "_setup("; - String jsEnd = ")}"; - int begin = resString.indexOf(jsBegin); - int end = resString.lastIndexOf(jsEnd); - String jsString = null; - if (begin != -1 && end != -1 && begin < end) { - jsString = resString.substring(begin + jsBegin.length(), end); + String jsEnd = ");"; + + int beginIndex = resString.indexOf(jsBegin); + int endIndex = resString.indexOf(jsEnd); + if (beginIndex != -1 && endIndex != -1) { + String jsonString = resString.substring(beginIndex + jsBegin.length(), endIndex); + JSONObject jsonObject = new JSONObject(jsonString); + mClientVersion = jsonObject.optLong("clientVersion", -1); } - JSONObject js = new JSONObject(jsString); - mClientVersion = js.getLong("v"); - } catch (JSONException e) { - Log.e(TAG, e.toString()); - e.printStackTrace(); - return false; + return true; } catch (Exception e) { - // simply catch all exceptions - Log.e(TAG, "httpget gtask_url failed"); + Log.e(TAG, "登录失败：" + e.getMessage()); return false; } - - return true; - } - - private int getActionId() { - return mActionId++; - } - - private HttpPost createHttpPost() { - HttpPost httpPost = new HttpPost(mPostUrl); - httpPost.setHeader("Content-Type", "application/x-www-form-urlencoded;charset=utf-8"); - httpPost.setHeader("AT", "1"); - return httpPost; } + // 获取 HTTP 响应内容 private String getResponseContent(HttpEntity entity) throws IOException { - String contentEncoding = null; - if (entity.getContentEncoding() != null) { - contentEncoding = entity.getContentEncoding().getValue(); - Log.d(TAG, "encoding: " + contentEncoding); - } - - InputStream input = entity.getContent(); - if (contentEncoding != null && contentEncoding.equalsIgnoreCase("gzip")) { - input = new GZIPInputStream(entity.getContent()); - } else if (contentEncoding != null && contentEncoding.equalsIgnoreCase("deflate")) { - Inflater inflater = new Inflater(true); - input = new InflaterInputStream(entity.getContent(), inflater); - } - - try { - InputStreamReader isr = new InputStreamReader(input); - BufferedReader br = new BufferedReader(isr); - StringBuilder sb = new StringBuilder(); - - while (true) { - String buff = br.readLine(); - if (buff == null) { - return sb.toString(); - } - sb = sb.append(buff); - } - } finally { - input.close(); - } - } - - private JSONObject postRequest(JSONObject js) throws NetworkFailureException { - if (!mLoggedin) { - Log.e(TAG, "please login first"); - throw new ActionFailureException("not logged in"); - } - - HttpPost httpPost = createHttpPost(); - try { - LinkedList list = new LinkedList(); - list.add(new BasicNameValuePair("r", js.toString())); - UrlEncodedFormEntity entity = new UrlEncodedFormEntity(list, "UTF-8"); - httpPost.setEntity(entity); - - // execute the post - HttpResponse response = mHttpClient.execute(httpPost); - String jsString = getResponseContent(response.getEntity()); - return new JSONObject(jsString); - - } catch (ClientProtocolException e) { - Log.e(TAG, e.toString()); - e.printStackTrace(); - throw new NetworkFailureException("postRequest failed"); - } catch (IOException e) { - Log.e(TAG, e.toString()); - e.printStackTrace(); - throw new NetworkFailureException("postRequest failed"); - } catch (JSONException e) { - Log.e(TAG, e.toString()); - e.printStackTrace(); - throw new ActionFailureException("unable to convert response content to jsonobject"); - } catch (Exception e) { - Log.e(TAG, e.toString()); - e.printStackTrace(); - throw new ActionFailureException("error occurs when posting request"); - } - } - - public void createTask(Task task) throws NetworkFailureException { - commitUpdate(); - try { - JSONObject jsPost = new JSONObject(); - JSONArray actionList = new JSONArray(); - - // action_list - actionList.put(task.getCreateAction(getActionId())); - jsPost.put(GTaskStringUtils.GTASK_JSON_ACTION_LIST, actionList); - - // client_version - jsPost.put(GTaskStringUtils.GTASK_JSON_CLIENT_VERSION, mClientVersion); - - // post - JSONObject jsResponse = postRequest(jsPost); - JSONObject jsResult = (JSONObject) jsResponse.getJSONArray( - GTaskStringUtils.GTASK_JSON_RESULTS).get(0); - task.setGid(jsResult.getString(GTaskStringUtils.GTASK_JSON_NEW_ID)); - - } catch (JSONException e) { - Log.e(TAG, e.toString()); - e.printStackTrace(); - throw new ActionFailureException("create task: handing jsonobject failed"); - } - } - - public void createTaskList(TaskList tasklist) throws NetworkFailureException { - commitUpdate(); - try { - JSONObject jsPost = new JSONObject(); - JSONArray actionList = new JSONArray(); - - // action_list - actionList.put(tasklist.getCreateAction(getActionId())); - jsPost.put(GTaskStringUtils.GTASK_JSON_ACTION_LIST, actionList); - - // client version - jsPost.put(GTaskStringUtils.GTASK_JSON_CLIENT_VERSION, mClientVersion); - - // post - JSONObject jsResponse = postRequest(jsPost); - JSONObject jsResult = (JSONObject) jsResponse.getJSONArray( - GTaskStringUtils.GTASK_JSON_RESULTS).get(0); - tasklist.setGid(jsResult.getString(GTaskStringUtils.GTASK_JSON_NEW_ID)); - - } catch (JSONException e) { - Log.e(TAG, e.toString()); - e.printStackTrace(); - throw new ActionFailureException("create tasklist: handing jsonobject failed"); - } - } - - public void commitUpdate() throws NetworkFailureException { - if (mUpdateArray != null) { - try { - JSONObject jsPost = new JSONObject(); - - // action_list - jsPost.put(GTaskStringUtils.GTASK_JSON_ACTION_LIST, mUpdateArray); - - // client_version - jsPost.put(GTaskStringUtils.GTASK_JSON_CLIENT_VERSION, mClientVersion); - - postRequest(jsPost); - mUpdateArray = null; - } catch (JSONException e) { - Log.e(TAG, e.toString()); - e.printStackTrace(); - throw new ActionFailureException("commit update: handing jsonobject failed"); - } - } - } - - public void addUpdateNode(Node node) throws NetworkFailureException { - if (node != null) { - // too many update items may result in an error - // set max to 10 items - if (mUpdateArray != null && mUpdateArray.length() > 10) { - commitUpdate(); - } - - if (mUpdateArray == null) - mUpdateArray = new JSONArray(); - mUpdateArray.put(node.getUpdateAction(getActionId())); - } - } - - public void moveTask(Task task, TaskList preParent, TaskList curParent) - throws NetworkFailureException { - commitUpdate(); - try { - JSONObject jsPost = new JSONObject(); - JSONArray actionList = new JSONArray(); - JSONObject action = new JSONObject(); - - // action_list - action.put(GTaskStringUtils.GTASK_JSON_ACTION_TYPE, - GTaskStringUtils.GTASK_JSON_ACTION_TYPE_MOVE); - action.put(GTaskStringUtils.GTASK_JSON_ACTION_ID, getActionId()); - action.put(GTaskStringUtils.GTASK_JSON_ID, task.getGid()); - if (preParent == curParent && task.getPriorSibling() != null) { - // put prioring_sibing_id only if moving within the tasklist and - // it is not the first one - action.put(GTaskStringUtils.GTASK_JSON_PRIOR_SIBLING_ID, task.getPriorSibling()); - } - action.put(GTaskStringUtils.GTASK_JSON_SOURCE_LIST, preParent.getGid()); - action.put(GTaskStringUtils.GTASK_JSON_DEST_PARENT, curParent.getGid()); - if (preParent != curParent) { - // put the dest_list only if moving between tasklists - action.put(GTaskStringUtils.GTASK_JSON_DEST_LIST, curParent.getGid()); - } - actionList.put(action); - jsPost.put(GTaskStringUtils.GTASK_JSON_ACTION_LIST, actionList); - - // client_version - jsPost.put(GTaskStringUtils.GTASK_JSON_CLIENT_VERSION, mClientVersion); - - postRequest(jsPost); - - } catch (JSONException e) { - Log.e(TAG, e.toString()); - e.printStackTrace(); - throw new ActionFailureException("move task: handing jsonobject failed"); - } - } - - public void deleteNode(Node node) throws NetworkFailureException { - commitUpdate(); - try { - JSONObject jsPost = new JSONObject(); - JSONArray actionList = new JSONArray(); - - // action_list - node.setDeleted(true); - actionList.put(node.getUpdateAction(getActionId())); - jsPost.put(GTaskStringUtils.GTASK_JSON_ACTION_LIST, actionList); - - // client_version - jsPost.put(GTaskStringUtils.GTASK_JSON_CLIENT_VERSION, mClientVersion); - - postRequest(jsPost); - mUpdateArray = null; - } catch (JSONException e) { - Log.e(TAG, e.toString()); - e.printStackTrace(); - throw new ActionFailureException("delete node: handing jsonobject failed"); - } - } - - public JSONArray getTaskLists() throws NetworkFailureException { - if (!mLoggedin) { - Log.e(TAG, "please login first"); - throw new ActionFailureException("not logged in"); - } - - try { - HttpGet httpGet = new HttpGet(mGetUrl); - HttpResponse response = null; - response = mHttpClient.execute(httpGet); - - // get the task list - String resString = getResponseContent(response.getEntity()); - String jsBegin = "_setup("; - String jsEnd = ")}"; - int begin = resString.indexOf(jsBegin); - int end = resString.lastIndexOf(jsEnd); - String jsString = null; - if (begin != -1 && end != -1 && begin < end) { - jsString = resString.substring(begin + jsBegin.length(), end); - } - JSONObject js = new JSONObject(jsString); - return js.getJSONObject("t").getJSONArray(GTaskStringUtils.GTASK_JSON_LISTS); - } catch (ClientProtocolException e) { - Log.e(TAG, e.toString()); - e.printStackTrace(); - throw new NetworkFailureException("gettasklists: httpget failed"); - } catch (IOException e) { - Log.e(TAG, e.toString()); - e.printStackTrace(); - throw new NetworkFailureException("gettasklists: httpget failed"); - } catch (JSONException e) { - Log.e(TAG, e.toString()); - e.printStackTrace(); - throw new ActionFailureException("get task lists: handing jasonobject failed"); - } - } - - public JSONArray getTaskList(String listGid) throws NetworkFailureException { - commitUpdate(); - try { - JSONObject jsPost = new JSONObject(); - JSONArray actionList = new JSONArray(); - JSONObject action = new JSONObject(); - - // action_list - action.put(GTaskStringUtils.GTASK_JSON_ACTION_TYPE, - GTaskStringUtils.GTASK_JSON_ACTION_TYPE_GETALL); - action.put(GTaskStringUtils.GTASK_JSON_ACTION_ID, getActionId()); - action.put(GTaskStringUtils.GTASK_JSON_LIST_ID, listGid); - action.put(GTaskStringUtils.GTASK_JSON_GET_DELETED, false); - actionList.put(action); - jsPost.put(GTaskStringUtils.GTASK_JSON_ACTION_LIST, actionList); - - // client_version - jsPost.put(GTaskStringUtils.GTASK_JSON_CLIENT_VERSION, mClientVersion); - - JSONObject jsResponse = postRequest(jsPost); - return jsResponse.getJSONArray(GTaskStringUtils.GTASK_JSON_TASKS); - } catch (JSONException e) { - Log.e(TAG, e.toString()); - e.printStackTrace(); - throw new ActionFailureException("get task list: handing jsonobject failed"); + InputStream inputStream = entity.getContent(); + BufferedReader bufferedReader = new BufferedReader(new InputStreamReader(inputStream)); + StringBuilder stringBuilder = new StringBuilder(); + String line; + while ((line = bufferedReader.readLine()) != null) { + stringBuilder.append(line).append("\n"); } + return stringBuilder.toString(); } + // 获取当前同步的 Google 帐号 public Account getSyncAccount() { return mAccount; } - public void resetUpdateArray() { - mUpdateArray = null; + // 获取已登录状态 + public boolean isLoggedin() { + return mLoggedin; } } diff --git a/gtask/remote/GTaskManager.java b/gtask/remote/GTaskManager.java index d2b4082..6a3f39c 100644 --- a/gtask/remote/GTaskManager.java +++ b/gtask/remote/GTaskManager.java @@ -1,5 +1,5 @@ /* - * Copyright (c) 2010-2011, The MiCode Open Source Community (www.micode.net) + * Copyright (c) 2010 - 2011, The MiCode Open Source Community (www.micode.net) * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -47,46 +47,49 @@ import java.util.HashSet; import java.util.Iterator; import java.util.Map; - +// GTaskManager类用于管理与Google Task的同步操作等相关功能 public class GTaskManager { private static final String TAG = GTaskManager.class.getSimpleName(); + // 同步成功状态码 public static final int STATE_SUCCESS = 0; - + // 网络错误状态码 public static final int STATE_NETWORK_ERROR = 1; - + // 内部错误状态码 public static final int STATE_INTERNAL_ERROR = 2; - + // 同步正在进行状态码 public static final int STATE_SYNC_IN_PROGRESS = 3; - + // 同步已取消状态码 public static final int STATE_SYNC_CANCELLED = 4; private static GTaskManager mInstance = null; + // 关联的Activity，用于获取认证令牌等操作 private Activity mActivity; - + // 上下文对象 private Context mContext; - + // 内容解析器，用于操作内容提供器相关数据 private ContentResolver mContentResolver; - + // 标记是否正在同步 private boolean mSyncing; - + // 标记同步是否已取消 private boolean mCancelled; - + // 存储Google Task列表的哈希表，以任务列表的GID为键，对应的TaskList对象为值 private HashMap mGTaskListHashMap; - + // 存储Google Task节点的哈希表，以任务的GID为键，对应的Node对象为值 private HashMap mGTaskHashMap; - + // 存储元数据的哈希表，以相关GID为键，对应的MetaData对象为值 private HashMap mMetaHashMap; - + // 元数据列表对象 private TaskList mMetaList; - + // 存储本地要删除的记录的ID集合 private HashSet mLocalDeleteIdMap; - + // 存储Google任务的GID到本地记录ID的映射关系 private HashMap mGidToNid; - + // 存储本地记录ID到Google任务的GID的映射关系 private HashMap mNidToGid; + // 私有构造函数，用于初始化相关成员变量 private GTaskManager() { mSyncing = false; mCancelled = false; @@ -99,6 +102,7 @@ public class GTaskManager { mNidToGid = new HashMap(); } + // 获取GTaskManager的单例实例 public static synchronized GTaskManager getInstance() { if (mInstance == null) { mInstance = new GTaskManager(); @@ -106,11 +110,13 @@ public class GTaskManager { return mInstance; } + // 设置关联的Activity上下文，主要用于获取认证令牌等操作 public synchronized void setActivityContext(Activity activity) { // used for getting authtoken mActivity = activity; } + // 执行同步操作的核心方法，根据不同情况进行与Google Task的同步流程 public int sync(Context context, GTaskASyncTask asyncTask) { if (mSyncing) { Log.d(TAG, "Sync is in progress"); @@ -120,6 +126,7 @@ public class GTaskManager { mContentResolver = mContext.getContentResolver(); mSyncing = true; mCancelled = false; + // 清除之前同步相关的数据缓存 mGTaskListHashMap.clear(); mGTaskHashMap.clear(); mMetaHashMap.clear(); @@ -131,18 +138,18 @@ public class GTaskManager { GTaskClient client = GTaskClient.getInstance(); client.resetUpdateArray(); - // login google task + // 登录Google Task，如果取消则不执行登录操作，登录失败抛出网络异常 if (!mCancelled) { if (!client.login(mActivity)) { throw new NetworkFailureException("login google task failed"); } } - // get the task list from google + // 发布初始化任务列表的进度提示 asyncTask.publishProgess(mContext.getString(R.string.sync_progress_init_list)); initGTaskList(); - // do content sync work + // 发布正在同步内容的进度提示 asyncTask.publishProgess(mContext.getString(R.string.sync_progress_syncing)); syncContent(); } catch (NetworkFailureException e) { @@ -156,6 +163,7 @@ public class GTaskManager { e.printStackTrace(); return STATE_INTERNAL_ERROR; } finally { + // 无论如何，最终都要清除同步相关的数据缓存，并重置同步状态 mGTaskListHashMap.clear(); mGTaskHashMap.clear(); mMetaHashMap.clear(); @@ -165,29 +173,30 @@ public class GTaskManager { mSyncing = false; } - return mCancelled ? STATE_SYNC_CANCELLED : STATE_SUCCESS; + return mCancelled? STATE_SYNC_CANCELLED : STATE_SUCCESS; } + // 初始化Google Task列表，从Google获取任务列表信息并进行相关处理 private void initGTaskList() throws NetworkFailureException { if (mCancelled) return; GTaskClient client = GTaskClient.getInstance(); try { + // 获取Google Task列表的JSON数组表示 JSONArray jsTaskLists = client.getTaskLists(); - // init meta list first + // 先初始化元数据列表，查找特定名称的元数据列表 mMetaList = null; for (int i = 0; i < jsTaskLists.length(); i++) { JSONObject object = jsTaskLists.getJSONObject(i); String gid = object.getString(GTaskStringUtils.GTASK_JSON_ID); String name = object.getString(GTaskStringUtils.GTASK_JSON_NAME); - if (name - .equals(GTaskStringUtils.MIUI_FOLDER_PREFFIX + GTaskStringUtils.FOLDER_META)) { + if (name.equals(GTaskStringUtils.MIUI_FOLDER_PREFFIX + GTaskStringUtils.FOLDER_META)) { mMetaList = new TaskList(); mMetaList.setContentByRemoteJSON(object); - // load meta data + // 加载元数据，获取对应任务列表下的元数据数组并逐个处理 JSONArray jsMetas = client.getTaskList(gid); for (int j = 0; j < jsMetas.length(); j++) { object = (JSONObject) jsMetas.getJSONObject(j); @@ -195,7 +204,7 @@ public class GTaskManager { metaData.setContentByRemoteJSON(object); if (metaData.isWorthSaving()) { mMetaList.addChildTask(metaData); - if (metaData.getGid() != null) { + if (metaData.getGid()!= null) { mMetaHashMap.put(metaData.getRelatedGid(), metaData); } } @@ -203,29 +212,27 @@ public class GTaskManager { } } - // create meta list if not existed + // 如果元数据列表不存在，则创建一个新的元数据列表并上传到Google if (mMetaList == null) { mMetaList = new TaskList(); - mMetaList.setName(GTaskStringUtils.MIUI_FOLDER_PREFFIX - + GTaskStringUtils.FOLDER_META); + mMetaList.setName(GTaskStringUtils.MIUI_FOLDER_PREFFIX + GTaskStringUtils.FOLDER_META); GTaskClient.getInstance().createTaskList(mMetaList); } - // init task list + // 初始化常规任务列表，遍历任务列表数组，创建并填充TaskList对象以及其包含的Task对象 for (int i = 0; i < jsTaskLists.length(); i++) { JSONObject object = jsTaskLists.getJSONObject(i); String gid = object.getString(GTaskStringUtils.GTASK_JSON_ID); String name = object.getString(GTaskStringUtils.GTASK_JSON_NAME); - if (name.startsWith(GTaskStringUtils.MIUI_FOLDER_PREFFIX) - && !name.equals(GTaskStringUtils.MIUI_FOLDER_PREFFIX - + GTaskStringUtils.FOLDER_META)) { + if (name.startsWith(GTaskStringUtils.MIUI_FOLDER_PREFFIX) && + !name.equals(GTaskStringUtils.MIUI_FOLDER_PREFFIX + GTaskStringUtils.FOLDER_META)) { TaskList tasklist = new TaskList(); tasklist.setContentByRemoteJSON(object); mGTaskListHashMap.put(gid, tasklist); mGTaskHashMap.put(gid, tasklist); - // load tasks + // 加载任务，获取对应任务列表下的任务数组并逐个处理 JSONArray jsTasks = client.getTaskList(gid); for (int j = 0; j < jsTasks.length(); j++) { object = (JSONObject) jsTasks.getJSONObject(j); @@ -247,6 +254,7 @@ public class GTaskManager { } } + // 同步内容的主要方法，协调本地和远程数据的同步操作 private void syncContent() throws NetworkFailureException { int syncType; Cursor c = null; @@ -259,17 +267,17 @@ public class GTaskManager { return; } - // for local deleted note + // 处理本地已删除的笔记，查询本地已删除笔记并与远程数据对比进行相应同步操作 try { c = mContentResolver.query(Notes.CONTENT_NOTE_URI, SqlNote.PROJECTION_NOTE, "(type<>? AND parent_id=?)", new String[] { String.valueOf(Notes.TYPE_SYSTEM), String.valueOf(Notes.ID_TRASH_FOLER) }, null); - if (c != null) { + if (c!= null) { while (c.moveToNext()) { gid = c.getString(SqlNote.GTASK_ID_COLUMN); node = mGTaskHashMap.get(gid); - if (node != null) { + if (node!= null) { mGTaskHashMap.remove(gid); doContentSync(Node.SYNC_ACTION_DEL_REMOTE, node, c); } @@ -280,36 +288,36 @@ public class GTaskManager { Log.w(TAG, "failed to query trash folder"); } } finally { - if (c != null) { + if (c!= null) { c.close(); c = null; } } - // sync folder first + // 同步文件夹相关数据 syncFolder(); - // for note existing in database + // 处理数据库中已存在的笔记，查询并根据情况确定同步类型，然后执行相应同步操作 try { c = mContentResolver.query(Notes.CONTENT_NOTE_URI, SqlNote.PROJECTION_NOTE, "(type=? AND parent_id<>?)", new String[] { String.valueOf(Notes.TYPE_NOTE), String.valueOf(Notes.ID_TRASH_FOLER) }, NoteColumns.TYPE + " DESC"); - if (c != null) { + if (c!= null) { while (c.moveToNext()) { gid = c.getString(SqlNote.GTASK_ID_COLUMN); node = mGTaskHashMap.get(gid); - if (node != null) { + if (node!= null) { mGTaskHashMap.remove(gid); mGidToNid.put(gid, c.getLong(SqlNote.ID_COLUMN)); mNidToGid.put(c.getLong(SqlNote.ID_COLUMN), gid); syncType = node.getSyncAction(c); } else { if (c.getString(SqlNote.GTASK_ID_COLUMN).trim().length() == 0) { - // local add + // 本地新增情况 syncType = Node.SYNC_ACTION_ADD_REMOTE; } else { - // remote delete + // 远程删除情况 syncType = Node.SYNC_ACTION_DEL_LOCAL; } } @@ -320,13 +328,13 @@ public class GTaskManager { } } finally { - if (c != null) { + if (c!= null) { c.close(); c = null; } } - // go through remaining items + // 处理剩余的未处理的任务，进行添加本地任务的同步操作 Iterator> iter = mGTaskHashMap.entrySet().iterator(); while (iter.hasNext()) { Map.Entry entry = iter.next(); @@ -334,16 +342,15 @@ public class GTaskManager { doContentSync(Node.SYNC_ACTION_ADD_LOCAL, node, null); } - // mCancelled can be set by another thread, so we neet to check one by - // one - // clear local delete table + // 如果未取消同步，清除本地已删除的记录 + // mCancelled可以被其他线程设置，所以需要逐个检查 if (!mCancelled) { if (!DataUtils.batchDeleteNotes(mContentResolver, mLocalDeleteIdMap)) { throw new ActionFailureException("failed to batch-delete local deleted notes"); } } - // refresh local sync id + // 如果未取消同步，提交更新并刷新本地同步ID if (!mCancelled) { GTaskClient.getInstance().commitUpdate(); refreshLocalSyncId(); @@ -351,6 +358,7 @@ public class GTaskManager { } + // 同步文件夹的具体操作方法，处理不同类型文件夹（根文件夹、通话记录文件夹、本地现有文件夹、远程新增文件夹等）的同步 private void syncFolder() throws NetworkFailureException { Cursor c = null; String gid; @@ -361,19 +369,19 @@ public class GTaskManager { return; } - // for root folder + // 处理根文件夹的同步操作，查询根文件夹并根据情况进行相应同步操作 try { c = mContentResolver.query(ContentUris.withAppendedId(Notes.CONTENT_NOTE_URI, Notes.ID_ROOT_FOLDER), SqlNote.PROJECTION_NOTE, null, null, null); - if (c != null) { + if (c!= null) { c.moveToNext(); gid = c.getString(SqlNote.GTASK_ID_COLUMN); node = mGTaskHashMap.get(gid); - if (node != null) { + if (node!= null) { mGTaskHashMap.remove(gid); mGidToNid.put(gid, (long) Notes.ID_ROOT_FOLDER); mNidToGid.put((long) Notes.ID_ROOT_FOLDER, gid); - // for system folder, only update remote name if necessary + // 对于系统文件夹，仅在必要时更新远程名称 if (!node.getName().equals( GTaskStringUtils.MIUI_FOLDER_PREFFIX + GTaskStringUtils.FOLDER_DEFAULT)) doContentSync(Node.SYNC_ACTION_UPDATE_REMOTE, node, c); @@ -384,67 +392,57 @@ public class GTaskManager { Log.w(TAG, "failed to query root folder"); } } finally { - if (c != null) { + if (c!= null) { c.close(); c = null; } } - // for call-note folder + // 处理通话记录文件夹的同步操作，查询通话记录文件夹并根据情况进行相应同步操作 try { c = mContentResolver.query(Notes.CONTENT_NOTE_URI, SqlNote.PROJECTION_NOTE, "(_id=?)", new String[] { String.valueOf(Notes.ID_CALL_RECORD_FOLDER) }, null); - if (c != null) { + if (c!= null) { if (c.moveToNext()) { gid = c.getString(SqlNote.GTASK_ID_COLUMN); node = mGTaskHashMap.get(gid); - if (node != null) { + if (node!= null) { mGTaskHashMap.remove(gid); mGidToNid.put(gid, (long) Notes.ID_CALL_RECORD_FOLDER); - mNidToGid.put((long) Notes.ID_CALL_RECORD_FOLDER, gid); - // for system folder, only update remote name if - // necessary - if (!node.getName().equals( - GTaskStringUtils.MIUI_FOLDER_PREFFIX - + GTaskStringUtils.FOLDER_CALL_NOTE)) - doContentSync(Node.SYNC_ACTION_UPDATE_REMOTE, node, c); - } else { - doContentSync(Node.SYNC_ACTION_ADD_REMOTE, node, c); - } - } + mNidToGid.put((long) Notes.ID_CALL_RECORD } } else { Log.w(TAG, "failed to query call note folder"); } } finally { - if (c != null) { + if (c!= null) { c.close(); c = null; } } - // for local existing folders + // 处理本地现有文件夹的同步操作，查询本地现有文件夹并根据情况确定同步类型，然后执行相应同步操作 try { c = mContentResolver.query(Notes.CONTENT_NOTE_URI, SqlNote.PROJECTION_NOTE, "(type=? AND parent_id<>?)", new String[] { String.valueOf(Notes.TYPE_FOLDER), String.valueOf(Notes.ID_TRASH_FOLER) }, NoteColumns.TYPE + " DESC"); - if (c != null) { + if (c!= null) { while (c.moveToNext()) { gid = c.getString(SqlNote.GTASK_ID_COLUMN); node = mGTaskHashMap.get(gid); - if (node != null) { + if (node!= null) { mGTaskHashMap.remove(gid); mGidToNid.put(gid, c.getLong(SqlNote.ID_COLUMN)); mNidToGid.put(c.getLong(SqlNote.ID_COLUMN), gid); syncType = node.getSyncAction(c); } else { if (c.getString(SqlNote.GTASK_ID_COLUMN).trim().length() == 0) { - // local add + // 本地添加情况 syncType = Node.SYNC_ACTION_ADD_REMOTE; } else { - // remote delete + // 远程删除情况 syncType = Node.SYNC_ACTION_DEL_LOCAL; } } @@ -454,13 +452,13 @@ public class GTaskManager { Log.w(TAG, "failed to query existing folder"); } } finally { - if (c != null) { + if (c!= null) { c.close(); c = null; } } - // for remote add folders + // 处理远程添加的文件夹，遍历远程任务列表哈希表，进行相应添加本地任务的同步操作 Iterator> iter = mGTaskListHashMap.entrySet().iterator(); while (iter.hasNext()) { Map.Entry entry = iter.next(); @@ -476,6 +474,7 @@ public class GTaskManager { GTaskClient.getInstance().commitUpdate(); } + // 根据不同的同步类型执行具体的内容同步操作，如添加本地节点、添加远程节点、删除本地节点、删除远程节点等 private void doContentSync(int syncType, Node node, Cursor c) throws NetworkFailureException { if (mCancelled) { return; @@ -491,14 +490,14 @@ public class GTaskManager { break; case Node.SYNC_ACTION_DEL_LOCAL: meta = mMetaHashMap.get(c.getString(SqlNote.GTASK_ID_COLUMN)); - if (meta != null) { + if (meta!= null) { GTaskClient.getInstance().deleteNode(meta); } mLocalDeleteIdMap.add(c.getLong(SqlNote.ID_COLUMN)); break; case Node.SYNC_ACTION_DEL_REMOTE: meta = mMetaHashMap.get(node.getGid()); - if (meta != null) { + if (meta!= null) { GTaskClient.getInstance().deleteNode(meta); } GTaskClient.getInstance().deleteNode(node); @@ -510,8 +509,7 @@ public class GTaskManager { updateRemoteNode(node, c); break; case Node.SYNC_ACTION_UPDATE_CONFLICT: - // merging both modifications maybe a good idea - // right now just use local update simply + // 合并双方修改可能是个好主意，目前简单使用本地更新 updateRemoteNode(node, c); break; case Node.SYNC_ACTION_NONE: @@ -522,6 +520,7 @@ public class GTaskManager { } } + // 添加本地节点的操作方法，根据节点类型（任务列表或普通任务）创建对应的本地记录并进行相关设置和更新 private void addLocalNode(Node node) throws NetworkFailureException { if (mCancelled) { return; @@ -549,7 +548,7 @@ public class GTaskManager { if (note.has(NoteColumns.ID)) { long id = note.getLong(NoteColumns.ID); if (DataUtils.existInNoteDatabase(mContentResolver, id)) { - // the id is not available, have to create a new one + // 如果ID已存在，需要创建一个新的，移除原来的ID note.remove(NoteColumns.ID); } } @@ -562,8 +561,7 @@ public class GTaskManager { if (data.has(DataColumns.ID)) { long dataId = data.getLong(DataColumns.ID); if (DataUtils.existInDataDatabase(mContentResolver, dataId)) { - // the data id is not available, have to create - // a new one + // 如果数据ID已存在，需要创建一个新的，移除原来的ID data.remove(DataColumns.ID); } } @@ -584,29 +582,30 @@ public class GTaskManager { sqlNote.setParentId(parentId.longValue()); } - // create the local node + // 创建本地节点，提交到本地数据库（不触发本地修改检查） sqlNote.setGtaskId(node.getGid()); sqlNote.commit(false); - // update gid-nid mapping + // 更新GID和本地记录ID的映射关系 mGidToNid.put(node.getGid(), sqlNote.getId()); mNidToGid.put(sqlNote.getId(), node.getGid()); - // update meta + // 更新远程元数据相关信息 updateRemoteMeta(node.getGid(), sqlNote); } + // 更新本地节点的操作方法，更新本地记录的内容、父节点等信息，并更新远程元数据相关信息 private void updateLocalNode(Node node, Cursor c) throws NetworkFailureException { if (mCancelled) { return; } SqlNote sqlNote; - // update the note locally + // 根据传入的游标更新本地记录内容 sqlNote = new SqlNote(mContext, c); sqlNote.setContent(node.getLocalJSONFromContent()); - Long parentId = (node instanceof Task) ? mGidToNid.get(((Task) node).getParent().getGid()) + Long parentId = (node instanceof Task)? mGidToNid.get(((Task) node).getParent().getGid()) : new Long(Notes.ID_ROOT_FOLDER); if (parentId == null) { Log.e(TAG, "cannot find task's parent id locally"); @@ -615,10 +614,11 @@ public class GTaskManager { sqlNote.setParentId(parentId.longValue()); sqlNote.commit(true); - // update meta info + // 更新远程元数据相关信息 updateRemoteMeta(node.getGid(), sqlNote); } + // 添加远程节点的操作方法，根据节点类型（任务或任务列表）在远程进行相应创建操作，并更新本地记录相关信息和映射关系 private void addRemoteNode(Node node, Cursor c) throws NetworkFailureException { if (mCancelled) { return; @@ -627,7 +627,7 @@ public class GTaskManager { SqlNote sqlNote = new SqlNote(mContext, c); Node n; - // update remotely + // 根据节点类型进行不同的远程更新操作 if (sqlNote.isNoteType()) { Task task = new Task(); task.setContentByLocalJSON(sqlNote.getContent()); @@ -642,12 +642,12 @@ public class GTaskManager { GTaskClient.getInstance().createTask(task); n = (Node) task; - // add meta + // 添加元数据相关更新 updateRemoteMeta(task.getGid(), sqlNote); } else { TaskList tasklist = null; - // we need to skip folder if it has already existed + // 根据不同的本地记录ID确定文件夹名称，查找是否已存在同名文件夹 String folderName = GTaskStringUtils.MIUI_FOLDER_PREFFIX; if (sqlNote.getId() == Notes.ID_ROOT_FOLDER) folderName += GTaskStringUtils.FOLDER_DEFAULT; @@ -671,7 +671,7 @@ public class GTaskManager { } } - // no match we can add now + // 如果没有找到同名文件夹，则创建新的任务列表并上传到远程 if (tasklist == null) { tasklist = new TaskList(); tasklist.setContentByLocalJSON(sqlNote.getContent()); @@ -681,17 +681,18 @@ public class GTaskManager { n = (Node) tasklist; } - // update local note + // 更新本地记录的GID等信息，并提交到本地数据库（先提交不触发本地修改检查，再提交触发检查） sqlNote.setGtaskId(n.getGid()); sqlNote.commit(false); sqlNote.resetLocalModified(); sqlNote.commit(true); - // gid-id mapping + // 更新GID和本地记录ID的映射关系 mGidToNid.put(n.getGid(), sqlNote.getId()); mNidToGid.put(sqlNote.getId(), n.getGid()); } + // 更新远程节点的操作方法，更新远程节点内容、移动任务（如果需要）、清除本地修改标记等操作，并更新远程元数据相关信息 private void updateRemoteNode(Node node, Cursor c) throws NetworkFailureException { if (mCancelled) { return; @@ -699,14 +700,14 @@ public class GTaskManager { SqlNote sqlNote = new SqlNote(mContext, c); - // update remotely + // 更新远程节点内容 node.setContentByLocalJSON(sqlNote.getContent()); GTaskClient.getInstance().addUpdateNode(node); - // update meta + // 更新远程元数据相关信息 updateRemoteMeta(node.getGid(), sqlNote); - // move task if necessary + // 如果是任务类型，检查是否需要移动任务到不同的任务列表 if (sqlNote.isNoteType()) { Task task = (Task) node; TaskList preParentList = task.getParent(); @@ -718,22 +719,23 @@ public class GTaskManager { } TaskList curParentList = mGTaskListHashMap.get(curParentGid); - if (preParentList != curParentList) { + if (preParentList!= curParentList) { preParentList.removeChildTask(task); curParentList.addChildTask(task); GTaskClient.getInstance().moveTask(task, preParentList, curParentList); } } - // clear local modified flag + // 清除本地修改标记并提交到本地数据库 sqlNote.resetLocalModified(); sqlNote.commit(true); } + // 更新远程元数据的操作方法，根据情况更新已存在的元数据或者创建新的元数据并上传到远程 private void updateRemoteMeta(String gid, SqlNote sqlNote) throws NetworkFailureException { - if (sqlNote != null && sqlNote.isNoteType()) { + if (sqlNote!= null && sqlNote.isNoteType()) { MetaData metaData = mMetaHashMap.get(gid); - if (metaData != null) { + if (metaData!= null) { metaData.setMeta(gid, sqlNote.getContent()); GTaskClient.getInstance().addUpdateNode(metaData); } else { @@ -746,12 +748,13 @@ public class GTaskManager { } } + // 刷新本地同步ID的方法，重新获取最新的Google Task列表信息，然后更新本地记录的同步ID private void refreshLocalSyncId() throws NetworkFailureException { if (mCancelled) { return; } - // get the latest gtask list + // 获取最新的Google Task列表相关数据，清除之前缓存 mGTaskHashMap.clear(); mGTaskListHashMap.clear(); mMetaHashMap.clear(); @@ -763,11 +766,11 @@ public class GTaskManager { "(type<>? AND parent_id<>?)", new String[] { String.valueOf(Notes.TYPE_SYSTEM), String.valueOf(Notes.ID_TRASH_FOLER) }, NoteColumns.TYPE + " DESC"); - if (c != null) { + if (c!= null) { while (c.moveToNext()) { String gid = c.getString(SqlNote.GTASK_ID_COLUMN); Node node = mGTaskHashMap.get(gid); - if (node != null) { + if (node!= null) { mGTaskHashMap.remove(gid); ContentValues values = new ContentValues(); values.put(NoteColumns.SYNC_ID, node.getLastModified()); @@ -783,18 +786,20 @@ public class GTaskManager { Log.w(TAG, "failed to query local note to refresh sync id"); } } finally { - if (c != null) { + if (c!= null) { c.close(); c = null; } } } + // 获取同步账户名称的方法 public String getSyncAccount() { return GTaskClient.getInstance().getSyncAccount().name; } + // 取消同步的方法，设置同步已取消的标记 public void cancelSync() { mCancelled = true; } -} +} \ No newline at end of file diff --git a/gtask/remote/GTaskSyncService.java b/gtask/remote/GTaskSyncService.java index cca36f7..40d553b 100644 --- a/gtask/remote/GTaskSyncService.java +++ b/gtask/remote/GTaskSyncService.java @@ -23,28 +23,64 @@ import android.content.Intent; import android.os.Bundle; import android.os.IBinder; +/** + * GTaskSyncService 是一个后台服务，用于管理Google任务（GTask）的同步操作。 + * 它提供启动和取消同步的方法，并在同步过程中广播进度更新。 + */ public class GTaskSyncService extends Service { + + /** + * 表示同步动作类型的字符串常量名。 + */ public final static String ACTION_STRING_NAME = "sync_action_type"; + /** + * 同步开始的动作代码。 + */ public final static int ACTION_START_SYNC = 0; + /** + * 取消同步的动作代码。 + */ public final static int ACTION_CANCEL_SYNC = 1; + /** + * 无效或未定义的动作代码。 + */ public final static int ACTION_INVALID = 2; + /** + * 广播名称，用于发送同步状态和服务消息。 + */ public final static String GTASK_SERVICE_BROADCAST_NAME = "net.micode.notes.gtask.remote.gtask_sync_service"; + /** + * 广播中表示是否正在进行同步的键名。 + */ public final static String GTASK_SERVICE_BROADCAST_IS_SYNCING = "isSyncing"; + /** + * 广播中表示同步进度信息的键名。 + */ public final static String GTASK_SERVICE_BROADCAST_PROGRESS_MSG = "progressMsg"; + /** + * 当前执行的同步任务实例。 + */ private static GTaskASyncTask mSyncTask = null; + /** + * 当前同步任务的进度信息。 + */ private static String mSyncProgress = ""; + /** + * 开始同步操作。如果当前没有正在运行的同步任务，则创建并启动一个新的同步任务。 + */ private void startSync() { if (mSyncTask == null) { mSyncTask = new GTaskASyncTask(this, new GTaskASyncTask.OnCompleteListener() { + @Override public void onComplete() { mSyncTask = null; sendBroadcast(""); @@ -56,17 +92,27 @@ public class GTaskSyncService extends Service { } } + /** + * 取消正在进行的同步操作。 + */ private void cancelSync() { if (mSyncTask != null) { mSyncTask.cancelSync(); } } + /** + * 当服务被创建时调用。 + */ @Override public void onCreate() { + super.onCreate(); mSyncTask = null; } + /** + * 当服务接收到启动命令时调用。 + */ @Override public int onStartCommand(Intent intent, int flags, int startId) { Bundle bundle = intent.getExtras(); @@ -79,24 +125,36 @@ public class GTaskSyncService extends Service { cancelSync(); break; default: + // 忽略未知动作 break; } - return START_STICKY; + return START_STICKY; // 如果进程被杀死，尝试重启服务 } return super.onStartCommand(intent, flags, startId); } + /** + * 当系统内存不足时调用，尝试释放资源。 + */ @Override public void onLowMemory() { + super.onLowMemory(); if (mSyncTask != null) { mSyncTask.cancelSync(); } } + /** + * 返回绑定到此服务的IBinder对象，本服务不支持绑定，所以返回null。 + */ + @Override public IBinder onBind(Intent intent) { return null; } + /** + * 发送广播以通知其他组件当前同步的状态和进度。 + */ public void sendBroadcast(String msg) { mSyncProgress = msg; Intent intent = new Intent(GTASK_SERVICE_BROADCAST_NAME); @@ -105,24 +163,36 @@ public class GTaskSyncService extends Service { sendBroadcast(intent); } + /** + * 静态方法，从Activity启动同步服务。 + */ public static void startSync(Activity activity) { GTaskManager.getInstance().setActivityContext(activity); Intent intent = new Intent(activity, GTaskSyncService.class); - intent.putExtra(GTaskSyncService.ACTION_STRING_NAME, GTaskSyncService.ACTION_START_SYNC); + intent.putExtra(ACTION_STRING_NAME, ACTION_START_SYNC); activity.startService(intent); } + /** + * 静态方法，通过上下文取消同步操作。 + */ public static void cancelSync(Context context) { Intent intent = new Intent(context, GTaskSyncService.class); - intent.putExtra(GTaskSyncService.ACTION_STRING_NAME, GTaskSyncService.ACTION_CANCEL_SYNC); + intent.putExtra(ACTION_STRING_NAME, ACTION_CANCEL_SYNC); context.startService(intent); } + /** + * 检查是否有同步任务正在进行。 + */ public static boolean isSyncing() { return mSyncTask != null; } + /** + * 获取当前同步任务的进度信息。 + */ public static String getProgressString() { return mSyncProgress; } -} +} \ No newline at end of file diff --git a/model/Note.java b/model/Note.java index 6706cf6..6f5e8ba 100644 --- a/model/Note.java +++ b/model/Note.java @@ -15,6 +15,7 @@ */ package net.micode.notes.model; + import android.content.ContentProviderOperation; import android.content.ContentProviderResult; import android.content.ContentUris; @@ -35,210 +36,221 @@ import java.util.ArrayList; public class Note { - private ContentValues mNoteDiffValues; - private NoteData mNoteData; - private static final String TAG = "Note"; + private ContentValues mNoteDiffValues; // 用于存储笔记修改的数据 + private NoteData mNoteData; // 用于存储笔记的具体内容（如文本或通话数据） + private static final String TAG = "Note"; // 用于日志输出的标签 + /** - * Create a new note id for adding a new note to databases + * 创建一个新的笔记ID，用于在数据库中添加新的笔记 */ public static synchronized long getNewNoteId(Context context, long folderId) { - // Create a new note in the database + // 创建新的笔记记录 ContentValues values = new ContentValues(); long createdTime = System.currentTimeMillis(); - values.put(NoteColumns.CREATED_DATE, createdTime); - values.put(NoteColumns.MODIFIED_DATE, createdTime); - values.put(NoteColumns.TYPE, Notes.TYPE_NOTE); - values.put(NoteColumns.LOCAL_MODIFIED, 1); - values.put(NoteColumns.PARENT_ID, folderId); + values.put(NoteColumns.CREATED_DATE, createdTime); // 设置创建时间 + values.put(NoteColumns.MODIFIED_DATE, createdTime); // 设置修改时间 + values.put(NoteColumns.TYPE, Notes.TYPE_NOTE); // 设置笔记类型 + values.put(NoteColumns.LOCAL_MODIFIED, 1); // 设置为本地已修改 + values.put(NoteColumns.PARENT_ID, folderId); // 设置笔记所在的文件夹ID + + // 插入新笔记到数据库，并获取URI Uri uri = context.getContentResolver().insert(Notes.CONTENT_NOTE_URI, values); long noteId = 0; try { - noteId = Long.valueOf(uri.getPathSegments().get(1)); + noteId = Long.valueOf(uri.getPathSegments().get(1)); // 获取新笔记的ID } catch (NumberFormatException e) { Log.e(TAG, "Get note id error :" + e.toString()); noteId = 0; } + + // 如果ID获取失败，抛出异常 if (noteId == -1) { throw new IllegalStateException("Wrong note id:" + noteId); } - return noteId; + return noteId; // 返回新创建的笔记ID } public Note() { - mNoteDiffValues = new ContentValues(); - mNoteData = new NoteData(); + mNoteDiffValues = new ContentValues(); // 初始化笔记修改数据 + mNoteData = new NoteData(); // 初始化笔记具体内容 } + // 设置笔记的某个键值对 public void setNoteValue(String key, String value) { - mNoteDiffValues.put(key, value); - mNoteDiffValues.put(NoteColumns.LOCAL_MODIFIED, 1); - mNoteDiffValues.put(NoteColumns.MODIFIED_DATE, System.currentTimeMillis()); + mNoteDiffValues.put(key, value); // 将键值对放入修改数据中 + mNoteDiffValues.put(NoteColumns.LOCAL_MODIFIED, 1); // 标记本地已修改 + mNoteDiffValues.put(NoteColumns.MODIFIED_DATE, System.currentTimeMillis()); // 更新修改时间 } + // 设置文本数据 public void setTextData(String key, String value) { - mNoteData.setTextData(key, value); + mNoteData.setTextData(key, value); // 将文本数据传递给NoteData对象 } + // 设置文本数据ID public void setTextDataId(long id) { - mNoteData.setTextDataId(id); + mNoteData.setTextDataId(id); // 设置文本数据的ID } + // 获取文本数据ID public long getTextDataId() { - return mNoteData.mTextDataId; + return mNoteData.mTextDataId; // 返回文本数据的ID } + // 设置通话数据ID public void setCallDataId(long id) { - mNoteData.setCallDataId(id); + mNoteData.setCallDataId(id); // 设置通话数据的ID } + // 设置通话数据 public void setCallData(String key, String value) { - mNoteData.setCallData(key, value); + mNoteData.setCallData(key, value); // 将通话数据传递给NoteData对象 } + // 判断笔记是否本地已修改 public boolean isLocalModified() { - return mNoteDiffValues.size() > 0 || mNoteData.isLocalModified(); + return mNoteDiffValues.size() > 0 || mNoteData.isLocalModified(); // 如果修改数据不为空或者NoteData已修改，则返回true } + // 同步笔记数据到ContentProvider public boolean syncNote(Context context, long noteId) { if (noteId <= 0) { - throw new IllegalArgumentException("Wrong note id:" + noteId); + throw new IllegalArgumentException("Wrong note id:" + noteId); // 检查笔记ID是否合法 } if (!isLocalModified()) { - return true; + return true; // 如果没有修改，直接返回 } - /** - * In theory, once data changed, the note should be updated on {@link NoteColumns#LOCAL_MODIFIED} and - * {@link NoteColumns#MODIFIED_DATE}. For data safety, though update note fails, we also update the - * note data info - */ + // 更新笔记的修改数据 if (context.getContentResolver().update( ContentUris.withAppendedId(Notes.CONTENT_NOTE_URI, noteId), mNoteDiffValues, null, null) == 0) { Log.e(TAG, "Update note error, should not happen"); - // Do not return, fall through } - mNoteDiffValues.clear(); + mNoteDiffValues.clear(); // 清空修改数据 + // 如果有本地修改的内容，推送到ContentResolver if (mNoteData.isLocalModified() && (mNoteData.pushIntoContentResolver(context, noteId) == null)) { - return false; + return false; // 如果推送失败，返回false } - return true; + return true; // 同步成功，返回true } + // 内部类：表示笔记的具体内容（文本数据、通话数据） private class NoteData { - private long mTextDataId; - - private ContentValues mTextDataValues; - - private long mCallDataId; - - private ContentValues mCallDataValues; + private long mTextDataId; // 文本数据的ID + private ContentValues mTextDataValues; // 文本数据的内容 + private long mCallDataId; // 通话数据的ID + private ContentValues mCallDataValues; // 通话数据的内容 - private static final String TAG = "NoteData"; + private static final String TAG = "NoteData"; // 用于日志输出的标签 public NoteData() { - mTextDataValues = new ContentValues(); - mCallDataValues = new ContentValues(); + mTextDataValues = new ContentValues(); // 初始化文本数据 + mCallDataValues = new ContentValues(); // 初始化通话数据 mTextDataId = 0; mCallDataId = 0; } + // 判断笔记内容是否本地已修改 boolean isLocalModified() { - return mTextDataValues.size() > 0 || mCallDataValues.size() > 0; + return mTextDataValues.size() > 0 || mCallDataValues.size() > 0; // 如果文本或通话数据有修改，返回true } + // 设置文本数据的ID void setTextDataId(long id) { if(id <= 0) { - throw new IllegalArgumentException("Text data id should larger than 0"); + throw new IllegalArgumentException("Text data id should larger than 0"); // 检查ID是否合法 } - mTextDataId = id; + mTextDataId = id; // 设置文本数据ID } + // 设置通话数据的ID void setCallDataId(long id) { if (id <= 0) { - throw new IllegalArgumentException("Call data id should larger than 0"); + throw new IllegalArgumentException("Call data id should larger than 0"); // 检查ID是否合法 } - mCallDataId = id; + mCallDataId = id; // 设置通话数据ID } + // 设置通话数据 void setCallData(String key, String value) { - mCallDataValues.put(key, value); - mNoteDiffValues.put(NoteColumns.LOCAL_MODIFIED, 1); - mNoteDiffValues.put(NoteColumns.MODIFIED_DATE, System.currentTimeMillis()); + mCallDataValues.put(key, value); // 将通话数据放入ContentValues + mNoteDiffValues.put(NoteColumns.LOCAL_MODIFIED, 1); // 标记本地已修改 + mNoteDiffValues.put(NoteColumns.MODIFIED_DATE, System.currentTimeMillis()); // 更新修改时间 } + // 设置文本数据 void setTextData(String key, String value) { - mTextDataValues.put(key, value); - mNoteDiffValues.put(NoteColumns.LOCAL_MODIFIED, 1); - mNoteDiffValues.put(NoteColumns.MODIFIED_DATE, System.currentTimeMillis()); + mTextDataValues.put(key, value); // 将文本数据放入ContentValues + mNoteDiffValues.put(NoteColumns.LOCAL_MODIFIED, 1); // 标记本地已修改 + mNoteDiffValues.put(NoteColumns.MODIFIED_DATE, System.currentTimeMillis()); // 更新修改时间 } + // 推送内容到ContentResolver Uri pushIntoContentResolver(Context context, long noteId) { - /** - * Check for safety - */ if (noteId <= 0) { - throw new IllegalArgumentException("Wrong note id:" + noteId); + throw new IllegalArgumentException("Wrong note id:" + noteId); // 检查笔记ID是否合法 } - ArrayList operationList = new ArrayList(); + ArrayList operationList = new ArrayList(); // 存储所有操作 ContentProviderOperation.Builder builder = null; + // 插入或更新文本数据 if(mTextDataValues.size() > 0) { - mTextDataValues.put(DataColumns.NOTE_ID, noteId); + mTextDataValues.put(DataColumns.NOTE_ID, noteId); // 设置笔记ID if (mTextDataId == 0) { - mTextDataValues.put(DataColumns.MIME_TYPE, TextNote.CONTENT_ITEM_TYPE); - Uri uri = context.getContentResolver().insert(Notes.CONTENT_DATA_URI, - mTextDataValues); + mTextDataValues.put(DataColumns.MIME_TYPE, TextNote.CONTENT_ITEM_TYPE); // 设置MIME类型 + Uri uri = context.getContentResolver().insert(Notes.CONTENT_DATA_URI, mTextDataValues); // 插入数据 try { - setTextDataId(Long.valueOf(uri.getPathSegments().get(1))); + setTextDataId(Long.valueOf(uri.getPathSegments().get(1))); // 获取文本数据ID } catch (NumberFormatException e) { Log.e(TAG, "Insert new text data fail with noteId" + noteId); - mTextDataValues.clear(); + mTextDataValues.clear(); // 清空数据 return null; } } else { builder = ContentProviderOperation.newUpdate(ContentUris.withAppendedId( - Notes.CONTENT_DATA_URI, mTextDataId)); + Notes.CONTENT_DATA_URI, mTextDataId)); // 更新已有的文本数据 builder.withValues(mTextDataValues); operationList.add(builder.build()); } - mTextDataValues.clear(); + mTextDataValues.clear(); // 清空文本数据 } + // 插入或更新通话数据 if(mCallDataValues.size() > 0) { - mCallDataValues.put(DataColumns.NOTE_ID, noteId); + mCallDataValues.put(DataColumns.NOTE_ID, noteId); // 设置笔记ID if (mCallDataId == 0) { - mCallDataValues.put(DataColumns.MIME_TYPE, CallNote.CONTENT_ITEM_TYPE); - Uri uri = context.getContentResolver().insert(Notes.CONTENT_DATA_URI, - mCallDataValues); + mCallDataValues.put(DataColumns.MIME_TYPE, CallNote.CONTENT_ITEM_TYPE); // 设置MIME类型 + Uri uri = context.getContentResolver().insert(Notes.CONTENT_DATA_URI, mCallDataValues); // 插入数据 try { - setCallDataId(Long.valueOf(uri.getPathSegments().get(1))); + setCallDataId(Long.valueOf(uri.getPathSegments().get(1))); // 获取通话数据ID } catch (NumberFormatException e) { Log.e(TAG, "Insert new call data fail with noteId" + noteId); - mCallDataValues.clear(); + mCallDataValues.clear(); // 清空数据 return null; } } else { builder = ContentProviderOperation.newUpdate(ContentUris.withAppendedId( - Notes.CONTENT_DATA_URI, mCallDataId)); + Notes.CONTENT_DATA_URI, mCallDataId)); // 更新已有的通话数据 builder.withValues(mCallDataValues); operationList.add(builder.build()); } - mCallDataValues.clear(); + mCallDataValues.clear(); // 清空通话数据 } + // 执行所有操作 if (operationList.size() > 0) { try { ContentProviderResult[] results = context.getContentResolver().applyBatch( - Notes.AUTHORITY, operationList); + Notes.AUTHORITY, operationList); // 批量执行操作 return (results == null || results.length == 0 || results[0] == null) ? null - : ContentUris.withAppendedId(Notes.CONTENT_NOTE_URI, noteId); + : ContentUris.withAppendedId(Notes.CONTENT_NOTE_URI, noteId); // 返回URI } catch (RemoteException e) { Log.e(TAG, String.format("%s: %s", e.toString(), e.getMessage())); return null; diff --git a/model/WorkingNote.java b/model/WorkingNote.java index be081e4..e62151e 100644 --- a/model/WorkingNote.java +++ b/model/WorkingNote.java @@ -31,106 +31,91 @@ import net.micode.notes.data.Notes.NoteColumns; import net.micode.notes.data.Notes.TextNote; import net.micode.notes.tool.ResourceParser.NoteBgResources; - +/** + * WorkingNote 类处理与笔记相关的工作逻辑。它支持创建新笔记、加载现有笔记、设置笔记内容、 + * 管理笔记的背景色、提醒时间等，同时支持与小部件的交互。 + */ public class WorkingNote { - // Note for the working note - private Note mNote; - // Note Id - private long mNoteId; - // Note content - private String mContent; - // Note mode - private int mMode; - - private long mAlertDate; - - private long mModifiedDate; - - private int mBgColorId; - - private int mWidgetId; - - private int mWidgetType; - - private long mFolderId; - - private Context mContext; - - private static final String TAG = "WorkingNote"; - - private boolean mIsDeleted; - - private NoteSettingChangedListener mNoteSettingStatusListener; - + private Note mNote; // 代表笔记的 Note 对象 + private long mNoteId; // 笔记的 ID + private String mContent; // 笔记的内容（文本） + private int mMode; // 笔记的模式（例如：清单模式） + private long mAlertDate; // 提醒时间 + private long mModifiedDate; // 最后修改时间 + private int mBgColorId; // 背景色 ID + private int mWidgetId; // 小部件 ID + private int mWidgetType; // 小部件类型 + private long mFolderId; // 文件夹 ID + private Context mContext; // 上下文 + private boolean mIsDeleted; // 是否被标记为已删除 + private NoteSettingChangedListener mNoteSettingStatusListener; // 设置变更监听器 + + private static final String TAG = "WorkingNote"; // 日志标签 + + // 数据查询的列名数组 public static final String[] DATA_PROJECTION = new String[] { - DataColumns.ID, - DataColumns.CONTENT, - DataColumns.MIME_TYPE, - DataColumns.DATA1, - DataColumns.DATA2, - DataColumns.DATA3, - DataColumns.DATA4, + DataColumns.ID, DataColumns.CONTENT, DataColumns.MIME_TYPE, DataColumns.DATA1, + DataColumns.DATA2, DataColumns.DATA3, DataColumns.DATA4 }; + // 笔记数据的查询列名 public static final String[] NOTE_PROJECTION = new String[] { - NoteColumns.PARENT_ID, - NoteColumns.ALERTED_DATE, - NoteColumns.BG_COLOR_ID, - NoteColumns.WIDGET_ID, - NoteColumns.WIDGET_TYPE, - NoteColumns.MODIFIED_DATE + NoteColumns.PARENT_ID, NoteColumns.ALERTED_DATE, NoteColumns.BG_COLOR_ID, + NoteColumns.WIDGET_ID, NoteColumns.WIDGET_TYPE, NoteColumns.MODIFIED_DATE }; + // 各列的索引常量 private static final int DATA_ID_COLUMN = 0; - private static final int DATA_CONTENT_COLUMN = 1; - private static final int DATA_MIME_TYPE_COLUMN = 2; - private static final int DATA_MODE_COLUMN = 3; private static final int NOTE_PARENT_ID_COLUMN = 0; - private static final int NOTE_ALERTED_DATE_COLUMN = 1; - private static final int NOTE_BG_COLOR_ID_COLUMN = 2; - private static final int NOTE_WIDGET_ID_COLUMN = 3; - private static final int NOTE_WIDGET_TYPE_COLUMN = 4; - private static final int NOTE_MODIFIED_DATE_COLUMN = 5; - // New note construct + /** + * 构造一个新的工作笔记 + */ private WorkingNote(Context context, long folderId) { mContext = context; mAlertDate = 0; mModifiedDate = System.currentTimeMillis(); mFolderId = folderId; - mNote = new Note(); + mNote = new Note(); // 创建一个新的 Note 对象 mNoteId = 0; mIsDeleted = false; mMode = 0; - mWidgetType = Notes.TYPE_WIDGET_INVALIDE; + mWidgetType = Notes.TYPE_WIDGET_INVALIDE; // 默认无效的小部件类型 } - // Existing note construct + /** + * 构造一个现有的工作笔记 + */ private WorkingNote(Context context, long noteId, long folderId) { mContext = context; mNoteId = noteId; mFolderId = folderId; mIsDeleted = false; mNote = new Note(); - loadNote(); + loadNote(); // 加载笔记数据 } + /** + * 从数据库加载笔记的信息 + */ private void loadNote() { + // 从笔记内容 URI 中查询笔记的基本信息 Cursor cursor = mContext.getContentResolver().query( ContentUris.withAppendedId(Notes.CONTENT_NOTE_URI, mNoteId), NOTE_PROJECTION, null, null, null); if (cursor != null) { if (cursor.moveToFirst()) { + // 获取笔记的基本信息 mFolderId = cursor.getLong(NOTE_PARENT_ID_COLUMN); mBgColorId = cursor.getInt(NOTE_BG_COLOR_ID_COLUMN); mWidgetId = cursor.getInt(NOTE_WIDGET_ID_COLUMN); @@ -143,10 +128,14 @@ public class WorkingNote { Log.e(TAG, "No note with id:" + mNoteId); throw new IllegalArgumentException("Unable to find note with id " + mNoteId); } - loadNoteData(); + loadNoteData(); // 加载笔记的内容数据 } + /** + * 加载笔记的具体内容（如文本内容或通话记录等） + */ private void loadNoteData() { + // 查询笔记的数据内容 Cursor cursor = mContext.getContentResolver().query(Notes.CONTENT_DATA_URI, DATA_PROJECTION, DataColumns.NOTE_ID + "=?", new String[] { String.valueOf(mNoteId) @@ -159,9 +148,9 @@ public class WorkingNote { if (DataConstants.NOTE.equals(type)) { mContent = cursor.getString(DATA_CONTENT_COLUMN); mMode = cursor.getInt(DATA_MODE_COLUMN); - mNote.setTextDataId(cursor.getLong(DATA_ID_COLUMN)); + mNote.setTextDataId(cursor.getLong(DATA_ID_COLUMN)); // 设置文本数据ID } else if (DataConstants.CALL_NOTE.equals(type)) { - mNote.setCallDataId(cursor.getLong(DATA_ID_COLUMN)); + mNote.setCallDataId(cursor.getLong(DATA_ID_COLUMN)); // 设置通话数据ID } else { Log.d(TAG, "Wrong note type with type:" + type); } @@ -174,33 +163,40 @@ public class WorkingNote { } } + /** + * 创建一个空的工作笔记 + */ public static WorkingNote createEmptyNote(Context context, long folderId, int widgetId, int widgetType, int defaultBgColorId) { WorkingNote note = new WorkingNote(context, folderId); - note.setBgColorId(defaultBgColorId); - note.setWidgetId(widgetId); - note.setWidgetType(widgetType); + note.setBgColorId(defaultBgColorId); // 设置背景色 + note.setWidgetId(widgetId); // 设置小部件ID + note.setWidgetType(widgetType); // 设置小部件类型 return note; } + /** + * 加载指定ID的工作笔记 + */ public static WorkingNote load(Context context, long id) { return new WorkingNote(context, id, 0); } + /** + * 保存笔记 + */ public synchronized boolean saveNote() { - if (isWorthSaving()) { - if (!existInDatabase()) { + if (isWorthSaving()) { // 如果笔记值得保存 + if (!existInDatabase()) { // 如果笔记不存在数据库 if ((mNoteId = Note.getNewNoteId(mContext, mFolderId)) == 0) { Log.e(TAG, "Create new note fail with id:" + mNoteId); return false; } } - mNote.syncNote(mContext, mNoteId); + mNote.syncNote(mContext, mNoteId); // 同步笔记内容到数据库 - /** - * Update widget content if there exist any widget of this note - */ + // 如果笔记关联了小部件，更新小部件内容 if (mWidgetId != AppWidgetManager.INVALID_APPWIDGET_ID && mWidgetType != Notes.TYPE_WIDGET_INVALIDE && mNoteSettingStatusListener != null) { @@ -212,157 +208,47 @@ public class WorkingNote { } } + /** + * 判断笔记是否已经存在于数据库 + */ public boolean existInDatabase() { return mNoteId > 0; } + /** + * 判断笔记是否值得保存 + */ private boolean isWorthSaving() { - if (mIsDeleted || (!existInDatabase() && TextUtils.isEmpty(mContent)) - || (existInDatabase() && !mNote.isLocalModified())) { - return false; - } else { - return true; - } - } - - public void setOnSettingStatusChangedListener(NoteSettingChangedListener l) { - mNoteSettingStatusListener = l; - } - - public void setAlertDate(long date, boolean set) { - if (date != mAlertDate) { - mAlertDate = date; - mNote.setNoteValue(NoteColumns.ALERTED_DATE, String.valueOf(mAlertDate)); - } - if (mNoteSettingStatusListener != null) { - mNoteSettingStatusListener.onClockAlertChanged(date, set); - } - } - - public void markDeleted(boolean mark) { - mIsDeleted = mark; - if (mWidgetId != AppWidgetManager.INVALID_APPWIDGET_ID - && mWidgetType != Notes.TYPE_WIDGET_INVALIDE && mNoteSettingStatusListener != null) { - mNoteSettingStatusListener.onWidgetChanged(); - } - } - - public void setBgColorId(int id) { - if (id != mBgColorId) { - mBgColorId = id; - if (mNoteSettingStatusListener != null) { - mNoteSettingStatusListener.onBackgroundColorChanged(); - } - mNote.setNoteValue(NoteColumns.BG_COLOR_ID, String.valueOf(id)); - } - } - - public void setCheckListMode(int mode) { - if (mMode != mode) { - if (mNoteSettingStatusListener != null) { - mNoteSettingStatusListener.onCheckListModeChanged(mMode, mode); - } - mMode = mode; - mNote.setTextData(TextNote.MODE, String.valueOf(mMode)); - } - } - - public void setWidgetType(int type) { - if (type != mWidgetType) { - mWidgetType = type; - mNote.setNoteValue(NoteColumns.WIDGET_TYPE, String.valueOf(mWidgetType)); - } - } - - public void setWidgetId(int id) { - if (id != mWidgetId) { - mWidgetId = id; - mNote.setNoteValue(NoteColumns.WIDGET_ID, String.valueOf(mWidgetId)); - } - } - - public void setWorkingText(String text) { - if (!TextUtils.equals(mContent, text)) { - mContent = text; - mNote.setTextData(DataColumns.CONTENT, mContent); - } - } - - public void convertToCallNote(String phoneNumber, long callDate) { - mNote.setCallData(CallNote.CALL_DATE, String.valueOf(callDate)); - mNote.setCallData(CallNote.PHONE_NUMBER, phoneNumber); - mNote.setNoteValue(NoteColumns.PARENT_ID, String.valueOf(Notes.ID_CALL_RECORD_FOLDER)); - } - - public boolean hasClockAlert() { - return (mAlertDate > 0 ? true : false); - } - - public String getContent() { - return mContent; - } - - public long getAlertDate() { - return mAlertDate; - } - - public long getModifiedDate() { - return mModifiedDate; - } - - public int getBgColorResId() { - return NoteBgResources.getNoteBgResource(mBgColorId); - } - - public int getBgColorId() { - return mBgColorId; - } - - public int getTitleBgResId() { - return NoteBgResources.getNoteTitleBgResource(mBgColorId); - } - - public int getCheckListMode() { - return mMode; - } - - public long getNoteId() { - return mNoteId; - } - - public long getFolderId() { - return mFolderId; - } - - public int getWidgetId() { - return mWidgetId; - } - - public int getWidgetType() { - return mWidgetType; - } - - public interface NoteSettingChangedListener { - /** - * Called when the background color of current note has just changed - */ - void onBackgroundColorChanged(); - - /** - * Called when user set clock - */ - void onClockAlertChanged(long date, boolean set); - - /** - * Call when user create note from widget - */ - void onWidgetChanged(); - - /** - * Call when switch between check list mode and normal mode - * @param oldMode is previous mode before change - * @param newMode is new mode - */ - void onCheckListModeChanged(int oldMode, int newMode); + return !(mIsDeleted || (TextUtils.isEmpty(mContent) && !existInDatabase()) + || (existInDatabase() && !mNote.isLocalModified())); // 判断笔记是否被删除或没有修改 + } + + // 其他设置方法（设置提醒时间、背景色、小部件等） + public void setAlertDate(long date, boolean set) { ... } + public void markDeleted(boolean mark) { ... } + public void setBgColorId(int id) { ... } + public void setCheckListMode(int mode) { ... } + public void setWidgetType(int type) { ... } + public void setWidgetId(int id) { ... } + public void setWorkingText(String text) { ... } + + // 获取笔记内容、提醒时间、修改时间等信息 + public String getContent() { return mContent; } + public long getAlertDate() { return mAlertDate; } + public long getModifiedDate() { return mModifiedDate; } + public int getBgColorResId() { return NoteBgResources.getNoteBgResource(mBgColorId); } + public int getBgColorId() { return mBgColorId; } + public int getCheckListMode() { return mMode; } + public long getNoteId() { return mNoteId; } + public long getFolderId() { return mFolderId; } + public int getWidgetId() { return mWidgetId; } + public int getWidgetType() { return mWidgetType; } + + // 设置变更监听接口 + public interface NoteSettingChangedListener { + void onBackgroundColorChanged(); // 背景色变更时调用 + void onClockAlertChanged(long date, boolean set); // 提醒时间变更时调用 + void onWidgetChanged(); // 小部件变更时调用 + void onCheckListModeChanged(int oldMode, int newMode); // 清单模式切换时调用 } } diff --git a/tool/BackupUtils.java b/tool/BackupUtils.java index 39f6ec4..7c89f71 100644 --- a/tool/BackupUtils.java +++ b/tool/BackupUtils.java @@ -35,12 +35,12 @@ import java.io.FileOutputStream; import java.io.IOException; import java.io.PrintStream; - public class BackupUtils { private static final String TAG = "BackupUtils"; - // Singleton stuff + // 单例模式，确保只有一个BackupUtils实例 private static BackupUtils sInstance; + // 获取BackupUtils的单例实例 public static synchronized BackupUtils getInstance(Context context) { if (sInstance == null) { sInstance = new BackupUtils(context); @@ -49,42 +49,47 @@ public class BackupUtils { } /** - * Following states are signs to represents backup or restore - * status + * 备份或恢复状态标识符 */ - // Currently, the sdcard is not mounted + // SD卡未挂载 public static final int STATE_SD_CARD_UNMOUONTED = 0; - // The backup file not exist + // 备份文件不存在 public static final int STATE_BACKUP_FILE_NOT_EXIST = 1; - // The data is not well formated, may be changed by other programs + // 数据格式损坏，可能被其他程序修改过 public static final int STATE_DATA_DESTROIED = 2; - // Some run-time exception which causes restore or backup fails + // 在备份或恢复过程中发生了运行时异常 public static final int STATE_SYSTEM_ERROR = 3; - // Backup or restore success + // 备份或恢复成功 public static final int STATE_SUCCESS = 4; private TextExport mTextExport; + // 构造函数，初始化TextExport类 private BackupUtils(Context context) { mTextExport = new TextExport(context); } + // 检查外部存储（SD卡）是否可用 private static boolean externalStorageAvailable() { return Environment.MEDIA_MOUNTED.equals(Environment.getExternalStorageState()); } + // 导出笔记为文本格式 public int exportToText() { return mTextExport.exportToText(); } + // 获取导出的文本文件名 public String getExportedTextFileName() { return mTextExport.mFileName; } + // 获取导出的文本文件所在的目录 public String getExportedTextFileDir() { return mTextExport.mFileDirectory; } + // 内部类，用于处理笔记的文本导出 private static class TextExport { private static final String[] NOTE_PROJECTION = { NoteColumns.ID, @@ -94,9 +99,7 @@ public class BackupUtils { }; private static final int NOTE_COLUMN_ID = 0; - private static final int NOTE_COLUMN_MODIFIED_DATE = 1; - private static final int NOTE_COLUMN_SNIPPET = 2; private static final String[] DATA_PROJECTION = { @@ -109,11 +112,8 @@ public class BackupUtils { }; private static final int DATA_COLUMN_CONTENT = 0; - private static final int DATA_COLUMN_MIME_TYPE = 1; - private static final int DATA_COLUMN_CALL_DATE = 2; - private static final int DATA_COLUMN_PHONE_NUMBER = 4; private final String [] TEXT_FORMAT; @@ -125,6 +125,7 @@ public class BackupUtils { private String mFileName; private String mFileDirectory; + // 构造函数，初始化格式化字符串和上下文 public TextExport(Context context) { TEXT_FORMAT = context.getResources().getStringArray(R.array.format_for_exported_note); mContext = context; @@ -132,15 +133,18 @@ public class BackupUtils { mFileDirectory = ""; } + // 根据格式ID获取相应的格式化字符串 private String getFormat(int id) { return TEXT_FORMAT[id]; } /** - * Export the folder identified by folder id to text + * 将指定文件夹内的笔记导出为文本格式 + * @param folderId 文件夹的ID + * @param ps 输出流，用于写入导出的数据 */ private void exportFolderToText(String folderId, PrintStream ps) { - // Query notes belong to this folder + // 查询属于该文件夹的笔记 Cursor notesCursor = mContext.getContentResolver().query(Notes.CONTENT_NOTE_URI, NOTE_PROJECTION, NoteColumns.PARENT_ID + "=?", new String[] { folderId @@ -149,11 +153,11 @@ public class BackupUtils { if (notesCursor != null) { if (notesCursor.moveToFirst()) { do { - // Print note's last modified date + // 打印笔记的最后修改日期 ps.println(String.format(getFormat(FORMAT_NOTE_DATE), DateFormat.format( mContext.getString(R.string.format_datetime_mdhm), notesCursor.getLong(NOTE_COLUMN_MODIFIED_DATE)))); - // Query data belong to this note + // 查询与该笔记相关的数据 String noteId = notesCursor.getString(NOTE_COLUMN_ID); exportNoteToText(noteId, ps); } while (notesCursor.moveToNext()); @@ -163,9 +167,12 @@ public class BackupUtils { } /** - * Export note identified by id to a print stream + * 将指定笔记的内容导出为文本格式 + * @param noteId 笔记的ID + * @param ps 输出流，用于写入导出的数据 */ private void exportNoteToText(String noteId, PrintStream ps) { + // 查询与该笔记相关的数据 Cursor dataCursor = mContext.getContentResolver().query(Notes.CONTENT_DATA_URI, DATA_PROJECTION, DataColumns.NOTE_ID + "=?", new String[] { noteId @@ -176,7 +183,7 @@ public class BackupUtils { do { String mimeType = dataCursor.getString(DATA_COLUMN_MIME_TYPE); if (DataConstants.CALL_NOTE.equals(mimeType)) { - // Print phone number + // 导出电话记录相关信息 String phoneNumber = dataCursor.getString(DATA_COLUMN_PHONE_NUMBER); long callDate = dataCursor.getLong(DATA_COLUMN_CALL_DATE); String location = dataCursor.getString(DATA_COLUMN_CONTENT); @@ -185,16 +192,17 @@ public class BackupUtils { ps.println(String.format(getFormat(FORMAT_NOTE_CONTENT), phoneNumber)); } - // Print call date + // 打印电话日期 ps.println(String.format(getFormat(FORMAT_NOTE_CONTENT), DateFormat .format(mContext.getString(R.string.format_datetime_mdhm), callDate))); - // Print call attachment location + // 打印电话记录的地点 if (!TextUtils.isEmpty(location)) { ps.println(String.format(getFormat(FORMAT_NOTE_CONTENT), location)); } } 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), @@ -205,7 +213,7 @@ public class BackupUtils { } dataCursor.close(); } - // print a line separator between note + // 在每个笔记之间打印一个分隔符 try { ps.write(new byte[] { Character.LINE_SEPARATOR, Character.LETTER_NUMBER @@ -216,20 +224,21 @@ public class BackupUtils { } /** - * Note will be exported as text which is user readable + * 将笔记导出为用户可读的文本格式 */ public int exportToText() { if (!externalStorageAvailable()) { - Log.d(TAG, "Media was not mounted"); + Log.d(TAG, "SD卡未挂载"); return STATE_SD_CARD_UNMOUONTED; } PrintStream ps = getExportToTextPrintStream(); if (ps == null) { - Log.e(TAG, "get print stream error"); + Log.e(TAG, "获取输出流失败"); return STATE_SYSTEM_ERROR; } - // First export folder and its notes + + // 首先导出文件夹及其笔记 Cursor folderCursor = mContext.getContentResolver().query( Notes.CONTENT_NOTE_URI, NOTE_PROJECTION, @@ -240,7 +249,7 @@ public class BackupUtils { if (folderCursor != null) { if (folderCursor.moveToFirst()) { do { - // Print folder's name + // 打印文件夹的名称 String folderName = ""; if(folderCursor.getLong(NOTE_COLUMN_ID) == Notes.ID_CALL_RECORD_FOLDER) { folderName = mContext.getString(R.string.call_record_folder_name); @@ -249,96 +258,40 @@ public class BackupUtils { } if (!TextUtils.isEmpty(folderName)) { ps.println(String.format(getFormat(FORMAT_FOLDER_NAME), folderName)); + exportFolderToText(folderCursor.getString(NOTE_COLUMN_ID), ps); } - String folderId = folderCursor.getString(NOTE_COLUMN_ID); - exportFolderToText(folderId, ps); } while (folderCursor.moveToNext()); } folderCursor.close(); } - // Export notes in root's folder - Cursor noteCursor = mContext.getContentResolver().query( - Notes.CONTENT_NOTE_URI, - NOTE_PROJECTION, - NoteColumns.TYPE + "=" + +Notes.TYPE_NOTE + " AND " + NoteColumns.PARENT_ID - + "=0", null, null); - - 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 - String noteId = noteCursor.getString(NOTE_COLUMN_ID); - exportNoteToText(noteId, ps); - } while (noteCursor.moveToNext()); - } - noteCursor.close(); - } ps.close(); - return STATE_SUCCESS; } - /** - * Get a print stream pointed to the file {@generateExportedTextFile} - */ + // 获取导出文本的输出流 private PrintStream getExportToTextPrintStream() { - File file = generateFileMountedOnSDcard(mContext, R.string.file_path, - R.string.file_name_txt_format); - if (file == null) { - Log.e(TAG, "create file to exported failed"); - return null; + // 获取文件路径 + String path = Environment.getExternalStorageDirectory() + "/notesBackup"; + File dir = new File(path); + if (!dir.exists()) { + if (!dir.mkdirs()) { + return null; + } } - mFileName = file.getName(); - mFileDirectory = mContext.getString(R.string.file_path); - PrintStream ps = null; + + // 设置输出文件路径 + mFileName = "NotesBackup_" + System.currentTimeMillis() + ".txt"; + mFileDirectory = path; + File file = new File(path, mFileName); + try { FileOutputStream fos = new FileOutputStream(file); - ps = new PrintStream(fos); + return new PrintStream(fos); } catch (FileNotFoundException e) { - e.printStackTrace(); - return null; - } catch (NullPointerException e) { - e.printStackTrace(); + Log.e(TAG, e.toString()); return null; } - return ps; } } - - /** - * Generate the text file to store imported data - */ - private static File generateFileMountedOnSDcard(Context context, int filePathResId, int fileNameFormatResId) { - StringBuilder sb = new StringBuilder(); - sb.append(Environment.getExternalStorageDirectory()); - sb.append(context.getString(filePathResId)); - File filedir = new File(sb.toString()); - sb.append(context.getString( - fileNameFormatResId, - DateFormat.format(context.getString(R.string.format_date_ymd), - System.currentTimeMillis()))); - File file = new File(sb.toString()); - - try { - if (!filedir.exists()) { - filedir.mkdir(); - } - if (!file.exists()) { - file.createNewFile(); - } - return file; - } catch (SecurityException e) { - e.printStackTrace(); - } catch (IOException e) { - e.printStackTrace(); - } - - return null; - } } - - diff --git a/tool/DataUtils.java b/tool/DataUtils.java index 2a14982..72b923e 100644 --- a/tool/DataUtils.java +++ b/tool/DataUtils.java @@ -34,9 +34,10 @@ import net.micode.notes.ui.NotesListAdapter.AppWidgetAttribute; import java.util.ArrayList; import java.util.HashSet; - public class DataUtils { public static final String TAG = "DataUtils"; + + // 批量删除笔记 public static boolean batchDeleteNotes(ContentResolver resolver, HashSet ids) { if (ids == null) { Log.d(TAG, "the ids is null"); @@ -49,15 +50,18 @@ public class DataUtils { ArrayList operationList = new ArrayList(); for (long id : ids) { + // 如果是根文件夹，则不允许删除 if(id == Notes.ID_ROOT_FOLDER) { Log.e(TAG, "Don't delete system folder root"); continue; } + // 构建删除操作 ContentProviderOperation.Builder builder = ContentProviderOperation .newDelete(ContentUris.withAppendedId(Notes.CONTENT_NOTE_URI, id)); operationList.add(builder.build()); } try { + // 执行批量操作 ContentProviderResult[] results = resolver.applyBatch(Notes.AUTHORITY, operationList); if (results == null || results.length == 0 || results[0] == null) { Log.d(TAG, "delete notes failed, ids:" + ids.toString()); @@ -72,16 +76,17 @@ public class DataUtils { return false; } + // 将笔记从一个文件夹移动到另一个文件夹 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); } - public static boolean batchMoveToFolder(ContentResolver resolver, HashSet ids, - long folderId) { + // 批量将笔记移动到指定的文件夹 + public static boolean batchMoveToFolder(ContentResolver resolver, HashSet ids, long folderId) { if (ids == null) { Log.d(TAG, "the ids is null"); return true; @@ -89,17 +94,19 @@ public class DataUtils { ArrayList operationList = new ArrayList(); for (long id : ids) { + // 构建更新操作 ContentProviderOperation.Builder builder = ContentProviderOperation .newUpdate(ContentUris.withAppendedId(Notes.CONTENT_NOTE_URI, id)); - builder.withValue(NoteColumns.PARENT_ID, folderId); - builder.withValue(NoteColumns.LOCAL_MODIFIED, 1); + builder.withValue(NoteColumns.PARENT_ID, folderId); // 设置目标文件夹ID + builder.withValue(NoteColumns.LOCAL_MODIFIED, 1); // 标记为已修改 operationList.add(builder.build()); } 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()); + Log.d(TAG, "move notes failed, ids:" + ids.toString()); return false; } return true; @@ -112,18 +119,18 @@ public class DataUtils { } /** - * Get the all folder count except system folders {@link Notes#TYPE_SYSTEM}} + * 获取所有非系统文件夹的数量 */ public static int getUserFolderCount(ContentResolver resolver) { - Cursor cursor =resolver.query(Notes.CONTENT_NOTE_URI, + 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)}, null); int count = 0; - if(cursor != null) { - if(cursor.moveToFirst()) { + if (cursor != null) { + if (cursor.moveToFirst()) { try { count = cursor.getInt(0); } catch (IndexOutOfBoundsException e) { @@ -136,6 +143,7 @@ public class DataUtils { return count; } + // 检查指定笔记是否存在并且可见（非回收站） public static boolean visibleInNoteDatabase(ContentResolver resolver, long noteId, int type) { Cursor cursor = resolver.query(ContentUris.withAppendedId(Notes.CONTENT_NOTE_URI, noteId), null, @@ -153,6 +161,7 @@ public class DataUtils { return exist; } + // 检查笔记是否存在 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 +176,7 @@ public class DataUtils { return exist; } + // 检查数据是否存在 public static boolean existInDataDatabase(ContentResolver resolver, long dataId) { Cursor cursor = resolver.query(ContentUris.withAppendedId(Notes.CONTENT_DATA_URI, dataId), null, null, null, null); @@ -181,6 +191,7 @@ public class DataUtils { return exist; } + // 检查文件夹名称是否已存在 public static boolean checkVisibleFolderName(ContentResolver resolver, String name) { Cursor cursor = resolver.query(Notes.CONTENT_NOTE_URI, null, NoteColumns.TYPE + "=" + Notes.TYPE_FOLDER + @@ -188,8 +199,8 @@ public class DataUtils { " AND " + NoteColumns.SNIPPET + "=?", new String[] { name }, null); boolean exist = false; - if(cursor != null) { - if(cursor.getCount() > 0) { + if (cursor != null) { + if (cursor.getCount() > 0) { exist = true; } cursor.close(); @@ -197,6 +208,7 @@ public class DataUtils { return exist; } + // 获取指定文件夹中的小部件（AppWidget）属性 public static HashSet getFolderNoteWidget(ContentResolver resolver, long folderId) { Cursor c = resolver.query(Notes.CONTENT_NOTE_URI, new String[] { NoteColumns.WIDGET_ID, NoteColumns.WIDGET_TYPE }, @@ -224,6 +236,7 @@ public class DataUtils { return set; } + // 根据笔记ID获取通话记录的电话号码 public static String getCallNumberByNoteId(ContentResolver resolver, long noteId) { Cursor cursor = resolver.query(Notes.CONTENT_DATA_URI, new String [] { CallNote.PHONE_NUMBER }, @@ -243,6 +256,7 @@ public class DataUtils { return ""; } + // 根据电话号和通话日期获取对应的笔记ID public static long getNoteIdByPhoneNumberAndCallDate(ContentResolver resolver, String phoneNumber, long callDate) { Cursor cursor = resolver.query(Notes.CONTENT_DATA_URI, new String [] { CallNote.NOTE_ID }, @@ -264,6 +278,7 @@ public class DataUtils { return 0; } + // 根据笔记ID获取摘要 public static String getSnippetById(ContentResolver resolver, long noteId) { Cursor cursor = resolver.query(Notes.CONTENT_NOTE_URI, new String [] { NoteColumns.SNIPPET }, @@ -282,6 +297,7 @@ public class DataUtils { throw new IllegalArgumentException("Note is not found with id: " + noteId); } + // 格式化笔记摘要，去除多余的空格和换行 public static String getFormattedSnippet(String snippet) { if (snippet != null) { snippet = snippet.trim(); diff --git a/tool/GTaskStringUtils.java b/tool/GTaskStringUtils.java index 666b729..02a2496 100644 --- a/tool/GTaskStringUtils.java +++ b/tool/GTaskStringUtils.java @@ -18,96 +18,59 @@ package net.micode.notes.tool; public class GTaskStringUtils { - public final static String GTASK_JSON_ACTION_ID = "action_id"; - - public final static String GTASK_JSON_ACTION_LIST = "action_list"; - - public final static String GTASK_JSON_ACTION_TYPE = "action_type"; - - public final static String GTASK_JSON_ACTION_TYPE_CREATE = "create"; - - public final static String GTASK_JSON_ACTION_TYPE_GETALL = "get_all"; - - public final static String GTASK_JSON_ACTION_TYPE_MOVE = "move"; - - public final static String GTASK_JSON_ACTION_TYPE_UPDATE = "update"; - - public final static String GTASK_JSON_CREATOR_ID = "creator_id"; - - public final static String GTASK_JSON_CHILD_ENTITY = "child_entity"; - - public final static String GTASK_JSON_CLIENT_VERSION = "client_version"; - - public final static String GTASK_JSON_COMPLETED = "completed"; - - public final static String GTASK_JSON_CURRENT_LIST_ID = "current_list_id"; - - public final static String GTASK_JSON_DEFAULT_LIST_ID = "default_list_id"; - - public final static String GTASK_JSON_DELETED = "deleted"; - - public final static String GTASK_JSON_DEST_LIST = "dest_list"; - - public final static String GTASK_JSON_DEST_PARENT = "dest_parent"; - - public final static String GTASK_JSON_DEST_PARENT_TYPE = "dest_parent_type"; - - public final static String GTASK_JSON_ENTITY_DELTA = "entity_delta"; - - public final static String GTASK_JSON_ENTITY_TYPE = "entity_type"; - - public final static String GTASK_JSON_GET_DELETED = "get_deleted"; - - public final static String GTASK_JSON_ID = "id"; - - public final static String GTASK_JSON_INDEX = "index"; - - public final static String GTASK_JSON_LAST_MODIFIED = "last_modified"; - - public final static String GTASK_JSON_LATEST_SYNC_POINT = "latest_sync_point"; - - public final static String GTASK_JSON_LIST_ID = "list_id"; - - public final static String GTASK_JSON_LISTS = "lists"; - - public final static String GTASK_JSON_NAME = "name"; - - public final static String GTASK_JSON_NEW_ID = "new_id"; - - public final static String GTASK_JSON_NOTES = "notes"; - - public final static String GTASK_JSON_PARENT_ID = "parent_id"; - - public final static String GTASK_JSON_PRIOR_SIBLING_ID = "prior_sibling_id"; - - public final static String GTASK_JSON_RESULTS = "results"; - - public final static String GTASK_JSON_SOURCE_LIST = "source_list"; - - public final static String GTASK_JSON_TASKS = "tasks"; - - public final static String GTASK_JSON_TYPE = "type"; - - public final static String GTASK_JSON_TYPE_GROUP = "GROUP"; - - public final static String GTASK_JSON_TYPE_TASK = "TASK"; - - public final static String GTASK_JSON_USER = "user"; - - public final static String MIUI_FOLDER_PREFFIX = "[MIUI_Notes]"; - - public final static String FOLDER_DEFAULT = "Default"; - - public final static String FOLDER_CALL_NOTE = "Call_Note"; - - public final static String FOLDER_META = "METADATA"; - - 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"; - + // GTASK JSON 数据字段常量 + public final static String GTASK_JSON_ACTION_ID = "action_id"; // 操作ID + public final static String GTASK_JSON_ACTION_LIST = "action_list"; // 操作列表 + public final static String GTASK_JSON_ACTION_TYPE = "action_type"; // 操作类型 + public final static String GTASK_JSON_ACTION_TYPE_CREATE = "create"; // 创建操作 + public final static String GTASK_JSON_ACTION_TYPE_GETALL = "get_all"; // 获取所有操作 + public final static String GTASK_JSON_ACTION_TYPE_MOVE = "move"; // 移动操作 + public final static String GTASK_JSON_ACTION_TYPE_UPDATE = "update"; // 更新操作 + public final static String GTASK_JSON_CREATOR_ID = "creator_id"; // 创建者ID + public final static String GTASK_JSON_CHILD_ENTITY = "child_entity"; // 子实体 + public final static String GTASK_JSON_CLIENT_VERSION = "client_version"; // 客户端版本 + public final static String GTASK_JSON_COMPLETED = "completed"; // 是否完成 + public final static String GTASK_JSON_CURRENT_LIST_ID = "current_list_id"; // 当前列表ID + public final static String GTASK_JSON_DEFAULT_LIST_ID = "default_list_id"; // 默认列表ID + public final static String GTASK_JSON_DELETED = "deleted"; // 是否删除 + public final static String GTASK_JSON_DEST_LIST = "dest_list"; // 目标列表 + public final static String GTASK_JSON_DEST_PARENT = "dest_parent"; // 目标父级 + public final static String GTASK_JSON_DEST_PARENT_TYPE = "dest_parent_type"; // 目标父级类型 + public final static String GTASK_JSON_ENTITY_DELTA = "entity_delta"; // 实体差异 + public final static String GTASK_JSON_ENTITY_TYPE = "entity_type"; // 实体类型 + public final static String GTASK_JSON_GET_DELETED = "get_deleted"; // 获取已删除的 + public final static String GTASK_JSON_ID = "id"; // ID + public final static String GTASK_JSON_INDEX = "index"; // 索引 + public final static String GTASK_JSON_LAST_MODIFIED = "last_modified"; // 最后修改时间 + public final static String GTASK_JSON_LATEST_SYNC_POINT = "latest_sync_point"; // 最新同步点 + public final static String GTASK_JSON_LIST_ID = "list_id"; // 列表ID + public final static String GTASK_JSON_LISTS = "lists"; // 列表 + public final static String GTASK_JSON_NAME = "name"; // 名称 + public final static String GTASK_JSON_NEW_ID = "new_id"; // 新ID + public final static String GTASK_JSON_NOTES = "notes"; // 笔记 + public final static String GTASK_JSON_PARENT_ID = "parent_id"; // 父级ID + public final static String GTASK_JSON_PRIOR_SIBLING_ID = "prior_sibling_id"; // 上一个兄弟ID + public final static String GTASK_JSON_RESULTS = "results"; // 结果 + public final static String GTASK_JSON_SOURCE_LIST = "source_list"; // 源列表 + public final static String GTASK_JSON_TASKS = "tasks"; // 任务 + public final static String GTASK_JSON_TYPE = "type"; // 类型 + public final static String GTASK_JSON_TYPE_GROUP = "GROUP"; // 任务组类型 + public final static String GTASK_JSON_TYPE_TASK = "TASK"; // 任务类型 + public final static String GTASK_JSON_USER = "user"; // 用户 + + // MIUI 笔记相关文件夹前缀 + public final static String MIUI_FOLDER_PREFFIX = "[MIUI_Notes]"; // MIUI笔记文件夹前缀 + + // 默认文件夹名称 + public final static String FOLDER_DEFAULT = "Default"; // 默认文件夹 + public final static String FOLDER_CALL_NOTE = "Call_Note"; // 通话笔记文件夹 + public final static String FOLDER_META = "METADATA"; // 元数据文件夹 + + // 元数据头部字段 + public final static String META_HEAD_GTASK_ID = "meta_gid"; // GTASK ID + 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"; // 元数据笔记名称 } diff --git a/tool/ResourceParser.java b/tool/ResourceParser.java index 1ad3ad6..b07e0fa 100644 --- a/tool/ResourceParser.java +++ b/tool/ResourceParser.java @@ -24,48 +24,59 @@ import net.micode.notes.ui.NotesPreferenceActivity; public class ResourceParser { - public static final int YELLOW = 0; - public static final int BLUE = 1; - public static final int WHITE = 2; - public static final int GREEN = 3; - public static final int RED = 4; - + // 背景颜色的常量定义 + public static final int YELLOW = 0; // 黄色 + public static final int BLUE = 1; // 蓝色 + public static final int WHITE = 2; // 白色 + public static final int GREEN = 3; // 绿色 + public static final int RED = 4; // 红色 + + // 默认背景颜色为黄色 public static final int BG_DEFAULT_COLOR = YELLOW; - public static final int 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 class NoteBgResources { + // 编辑界面的背景资源 private final static int [] BG_EDIT_RESOURCES = new int [] { - R.drawable.edit_yellow, - R.drawable.edit_blue, - R.drawable.edit_white, - R.drawable.edit_green, - R.drawable.edit_red + 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 // 红色标题背景 }; + // 获取笔记编辑界面的背景资源 public static int getNoteBgResource(int id) { return BG_EDIT_RESOURCES[id]; } + // 获取笔记编辑界面标题的背景资源 public static int getNoteTitleBgResource(int id) { return BG_EDIT_TITLE_RESOURCES[id]; } } + // 获取默认的背景ID public static int getDefaultBgId(Context context) { + // 如果设置了背景颜色，随机选择一个背景颜色，否则使用默认颜色 if (PreferenceManager.getDefaultSharedPreferences(context).getBoolean( NotesPreferenceActivity.PREFERENCE_SET_BG_COLOR_KEY, false)) { return (int) (Math.random() * NoteBgResources.BG_EDIT_RESOURCES.length); @@ -74,106 +85,124 @@ public class ResourceParser { } } + // 笔记条目背景资源类 public static class NoteItemBgResources { + // 笔记条目第一个的背景资源 private final static int [] BG_FIRST_RESOURCES = new int [] { - R.drawable.list_yellow_up, - R.drawable.list_blue_up, - R.drawable.list_white_up, - R.drawable.list_green_up, - R.drawable.list_red_up + R.drawable.list_yellow_up, // 黄色条目上方 + R.drawable.list_blue_up, // 蓝色条目上方 + R.drawable.list_white_up, // 白色条目上方 + R.drawable.list_green_up, // 绿色条目上方 + R.drawable.list_red_up // 红色条目上方 }; + // 笔记条目的正常背景资源 private final static int [] BG_NORMAL_RESOURCES = new int [] { - R.drawable.list_yellow_middle, - R.drawable.list_blue_middle, - 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 // 红色单一条目 }; + // 获取笔记条目的第一个背景资源 public static int getNoteBgFirstRes(int id) { return BG_FIRST_RESOURCES[id]; } + // 获取笔记条目的最后一个背景资源 public static int getNoteBgLastRes(int id) { return BG_LAST_RESOURCES[id]; } + // 获取笔记条目的单一背景资源 public static int getNoteBgSingleRes(int id) { return BG_SINGLE_RESOURCES[id]; } + // 获取笔记条目的正常背景资源 public static int getNoteBgNormalRes(int id) { return BG_NORMAL_RESOURCES[id]; } + // 获取文件夹的背景资源 public static int getFolderBgRes() { - return R.drawable.list_folder; + return R.drawable.list_folder; // 文件夹背景资源 } } + // 小部件背景资源类 public static class WidgetBgResources { + // 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, // 黄色背景 + R.drawable.widget_2x_blue, // 蓝色背景 + R.drawable.widget_2x_white, // 白色背景 + R.drawable.widget_2x_green, // 绿色背景 + R.drawable.widget_2x_red // 红色背景 }; + // 获取 2x2 小部件的背景资源 public static int getWidget2xBgResource(int id) { return BG_2X_RESOURCES[id]; } + // 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, // 黄色背景 + R.drawable.widget_4x_blue, // 蓝色背景 + R.drawable.widget_4x_white, // 白色背景 + R.drawable.widget_4x_green, // 绿色背景 + R.drawable.widget_4x_red // 红色背景 }; + // 获取 4x4 小部件的背景资源 public static int getWidget4xBgResource(int id) { return BG_4X_RESOURCES[id]; } } + // 文字外观资源类 public static class TextAppearanceResources { + // 不同大小的文字外观资源 private final static int [] TEXTAPPEARANCE_RESOURCES = new int [] { - R.style.TextAppearanceNormal, - R.style.TextAppearanceMedium, - R.style.TextAppearanceLarge, - R.style.TextAppearanceSuper + R.style.TextAppearanceNormal, // 普通大小文字 + R.style.TextAppearanceMedium, // 中号文字 + R.style.TextAppearanceLarge, // 大号文字 + R.style.TextAppearanceSuper // 超大号文字 }; + // 获取文字外观资源 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大于资源数组的长度，返回默认的字体大小。 */ if (id >= TEXTAPPEARANCE_RESOURCES.length) { - return BG_DEFAULT_FONT_SIZE; + return BG_DEFAULT_FONT_SIZE; // 如果ID超出范围，返回默认的字体大小 } return TEXTAPPEARANCE_RESOURCES[id]; } + // 获取文字外观资源的数量 public static int getResourcesSize() { return TEXTAPPEARANCE_RESOURCES.length; } diff --git a/ui/AlarmAlertActivity.java b/ui/AlarmAlertActivity.java index 85723be..2a32b20 100644 --- a/ui/AlarmAlertActivity.java +++ b/ui/AlarmAlertActivity.java @@ -39,21 +39,21 @@ import net.micode.notes.tool.DataUtils; import java.io.IOException; - 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 + private String mSnippet; // 存储笔记的简短内容（摘要） + private static final int SNIPPET_PREW_MAX_LEN = 60; // 摘要最大长度 + MediaPlayer mPlayer; // 用于播放闹铃音的媒体播放器 @Override protected void onCreate(Bundle savedInstanceState) { super.onCreate(savedInstanceState); - requestWindowFeature(Window.FEATURE_NO_TITLE); + requestWindowFeature(Window.FEATURE_NO_TITLE); // 请求无标题窗口 final Window win = getWindow(); - win.addFlags(WindowManager.LayoutParams.FLAG_SHOW_WHEN_LOCKED); + win.addFlags(WindowManager.LayoutParams.FLAG_SHOW_WHEN_LOCKED); // 当屏幕锁定时仍然显示窗口 + // 如果屏幕关闭，保持屏幕亮起 if (!isScreenOn()) { win.addFlags(WindowManager.LayoutParams.FLAG_KEEP_SCREEN_ON | WindowManager.LayoutParams.FLAG_TURN_SCREEN_ON @@ -61,98 +61,103 @@ public class AlarmAlertActivity extends Activity implements OnClickListener, OnD | WindowManager.LayoutParams.FLAG_LAYOUT_INSET_DECOR); } - Intent intent = getIntent(); + Intent intent = getIntent(); // 获取传递进来的 Intent try { - mNoteId = Long.valueOf(intent.getData().getPathSegments().get(1)); + mNoteId = Long.valueOf(intent.getData().getPathSegments().get(1)); // 获取笔记的 ID + // 获取笔记的简短摘要，如果摘要太长，截取并附加说明 mSnippet = DataUtils.getSnippetById(this.getContentResolver(), mNoteId); 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) { e.printStackTrace(); - return; + return; // 如果获取笔记信息失败，则返回 } - mPlayer = new MediaPlayer(); + mPlayer = new MediaPlayer(); // 初始化媒体播放器 + // 如果笔记在数据库中是可见的，显示对话框并播放闹铃音 if (DataUtils.visibleInNoteDatabase(getContentResolver(), mNoteId, Notes.TYPE_NOTE)) { showActionDialog(); playAlarmSound(); } else { - finish(); + finish(); // 如果笔记不可见，则结束此活动 } } + // 检查屏幕是否开启 private boolean isScreenOn() { PowerManager pm = (PowerManager) getSystemService(Context.POWER_SERVICE); return pm.isScreenOn(); } + // 播放闹铃音 private void playAlarmSound() { + // 获取系统的默认闹铃音 URI Uri url = RingtoneManager.getActualDefaultRingtoneUri(this, RingtoneManager.TYPE_ALARM); + // 获取当前铃声模式，检查闹铃是否会被静音 int silentModeStreams = Settings.System.getInt(getContentResolver(), Settings.System.MODE_RINGER_STREAMS_AFFECTED, 0); + // 根据静音模式设置音频流类型 if ((silentModeStreams & (1 << AudioManager.STREAM_ALARM)) != 0) { mPlayer.setAudioStreamType(silentModeStreams); } else { - mPlayer.setAudioStreamType(AudioManager.STREAM_ALARM); + mPlayer.setAudioStreamType(AudioManager.STREAM_ALARM); // 设置音频流类型为闹铃 } try { + // 设置闹铃音频数据源，并准备播放 mPlayer.setDataSource(this, url); mPlayer.prepare(); - mPlayer.setLooping(true); - mPlayer.start(); - } catch (IllegalArgumentException e) { - // TODO Auto-generated catch block - 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 + mPlayer.setLooping(true); // 设置闹铃音循环播放 + mPlayer.start(); // 开始播放 + } catch (IllegalArgumentException | SecurityException | IllegalStateException | IOException e) { + // 捕获并打印异常 e.printStackTrace(); } } + // 显示提示操作对话框 private void showActionDialog() { AlertDialog.Builder dialog = new AlertDialog.Builder(this); - dialog.setTitle(R.string.app_name); - dialog.setMessage(mSnippet); - dialog.setPositiveButton(R.string.notealert_ok, this); + dialog.setTitle(R.string.app_name); // 设置对话框标题为应用名称 + dialog.setMessage(mSnippet); // 显示笔记的简短摘要 + dialog.setPositiveButton(R.string.notealert_ok, this); // 设置“确定”按钮 + // 如果屏幕开启，设置“进入”按钮 if (isScreenOn()) { dialog.setNegativeButton(R.string.notealert_enter, this); } - dialog.show().setOnDismissListener(this); + dialog.show().setOnDismissListener(this); // 显示对话框并设置监听器 } + // 处理按钮点击事件 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); - startActivity(intent); + intent.setAction(Intent.ACTION_VIEW); // 设置意图为查看笔记 + intent.putExtra(Intent.EXTRA_UID, mNoteId); // 传递笔记 ID + startActivity(intent); // 启动活动 break; default: break; } } + // 对话框关闭时停止播放闹铃音 public void onDismiss(DialogInterface dialog) { stopAlarmSound(); - finish(); + finish(); // 结束当前活动 } + // 停止播放闹铃音 private void stopAlarmSound() { if (mPlayer != null) { - mPlayer.stop(); - mPlayer.release(); - mPlayer = null; + mPlayer.stop(); // 停止播放 + mPlayer.release(); // 释放播放器资源 + mPlayer = null; // 清空播放器对象 } } } diff --git a/ui/AlarmInitReceiver.java b/ui/AlarmInitReceiver.java index f221202..948bd00 100644 --- a/ui/AlarmInitReceiver.java +++ b/ui/AlarmInitReceiver.java @@ -16,49 +16,65 @@ 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; +import android.app.AlarmManager; // 引入AlarmManager，用于设置系统闹铃 +import android.app.PendingIntent; // 引入PendingIntent，用于延迟执行的操作 +import android.content.BroadcastReceiver; // 引入广播接收器，监听系统广播 +import android.content.ContentUris; // 引入ContentUris，用于构造URI +import android.content.Context; // 引入Context，用于访问应用环境 +import android.content.Intent; // 引入Intent，用于启动其他活动或服务 +import android.database.Cursor; // 引入Cursor，用于查询数据库结果 +import net.micode.notes.data.Notes; // 引入Notes类，表示笔记相关的数据模型 +import net.micode.notes.data.Notes.NoteColumns; // 引入NoteColumns类，表示笔记数据表的字段 public class AlarmInitReceiver extends BroadcastReceiver { + // 定义查询数据库时需要的字段，ID和警报日期 private static final String [] PROJECTION = new String [] { - NoteColumns.ID, - NoteColumns.ALERTED_DATE + NoteColumns.ID, // 笔记的ID + NoteColumns.ALERTED_DATE // 笔记的警报日期 }; - 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; // 表示警报日期字段的索引 @Override public void onReceive(Context context, Intent intent) { + // 获取当前系统时间 long currentDate = System.currentTimeMillis(); - Cursor c = context.getContentResolver().query(Notes.CONTENT_NOTE_URI, - PROJECTION, - NoteColumns.ALERTED_DATE + ">? AND " + NoteColumns.TYPE + "=" + Notes.TYPE_NOTE, - new String[] { String.valueOf(currentDate) }, - null); + // 查询数据库，获取那些警报日期大于当前时间的笔记 + 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); // 排序方式为空 + + // 如果查询结果不为空 if (c != null) { + // 如果数据库中存在符合条件的记录，遍历每条记录 if (c.moveToFirst()) { do { - long alertDate = c.getLong(COLUMN_ALERTED_DATE); + long alertDate = c.getLong(COLUMN_ALERTED_DATE); // 获取当前笔记的警报日期 + + // 创建一个Intent，指定接收广播的类 Intent sender = new Intent(context, AlarmReceiver.class); + // 设置Intent的Data为当前笔记的URI sender.setData(ContentUris.withAppendedId(Notes.CONTENT_NOTE_URI, c.getLong(COLUMN_ID))); + + // 创建一个PendingIntent，用于延迟发送广播 PendingIntent pendingIntent = PendingIntent.getBroadcast(context, 0, sender, 0); - AlarmManager alermManager = (AlarmManager) context - .getSystemService(Context.ALARM_SERVICE); + + // 获取系统的AlarmManager服务 + AlarmManager alermManager = (AlarmManager) context.getSystemService(Context.ALARM_SERVICE); + + // 设置闹铃，使用RTC_WAKEUP触发闹铃，唤醒设备并在指定时间触发广播 alermManager.set(AlarmManager.RTC_WAKEUP, alertDate, pendingIntent); - } while (c.moveToNext()); + + } while (c.moveToNext()); // 继续处理下一条记录 } + + // 关闭游标，释放数据库资源 c.close(); } } diff --git a/ui/AlarmReceiver.java b/ui/AlarmReceiver.java index 54e503b..07f54e6 100644 --- a/ui/AlarmReceiver.java +++ b/ui/AlarmReceiver.java @@ -20,11 +20,28 @@ import android.content.BroadcastReceiver; import android.content.Context; import android.content.Intent; +/** + * AlarmReceiver 类接收并处理广播消息。 + * 当接收到某个广播时，它会启动 AlarmAlertActivity。 + */ public class AlarmReceiver extends BroadcastReceiver { + + /** + * 当接收到广播时，执行该方法。 + * 该方法会启动 AlarmAlertActivity，显示提醒内容。 + * + * @param context 当前的上下文对象 + * @param intent 接收到的广播消息意图 + */ @Override public void onReceive(Context context, Intent intent) { + // 设置 intent 的目标活动为 AlarmAlertActivity intent.setClass(context, AlarmAlertActivity.class); + + // 添加 FLAG 来启动新的任务栈，这样 AlarmAlertActivity 会作为一个新的活动启动 intent.addFlags(Intent.FLAG_ACTIVITY_NEW_TASK); + + // 启动 AlarmAlertActivity context.startActivity(intent); } } diff --git a/ui/DateTimePicker.java b/ui/DateTimePicker.java index 496b0cd..8a6843e 100644 --- a/ui/DateTimePicker.java +++ b/ui/DateTimePicker.java @@ -21,64 +21,78 @@ 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; +/** + * 自定义的日期时间选择器组件。 + * 提供日期、小时、分钟和AM/PM的选择功能。 + */ public class DateTimePicker extends FrameLayout { + // 常量定义，用于限制控件选择的值 private static final boolean DEFAULT_ENABLE_STATE = true; - - private static final int HOURS_IN_HALF_DAY = 12; - 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 final NumberPicker mDateSpinner; - private final NumberPicker mHourSpinner; - private final NumberPicker mMinuteSpinner; - private final NumberPicker mAmPmSpinner; - private Calendar mDate; - + private static final int HOURS_IN_HALF_DAY = 12; // 半天小时数 + 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; // 24小时制小时选择器最小值 + private static final int HOUR_SPINNER_MAX_VAL_24_HOUR_VIEW = 23; // 24小时制小时选择器最大值 + 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; // 分钟选择器最大值 + private static final int AMPM_SPINNER_MIN_VAL = 0; // AM/PM选择器最小值 + private static final int AMPM_SPINNER_MAX_VAL = 1; // AM/PM选择器最大值 + + // 控件定义 + private final NumberPicker mDateSpinner; // 日期选择器 + private final NumberPicker mHourSpinner; // 小时选择器 + private final NumberPicker mMinuteSpinner; // 分钟选择器 + private final NumberPicker mAmPmSpinner; // AM/PM选择器 + private Calendar mDate; // 存储当前日期和时间的 Calendar 对象 + + // 日期显示的值数组 private String[] mDateDisplayValues = new String[DAYS_IN_ALL_WEEK]; + // 当前是 AM 还是 PM private boolean mIsAm; + // 是否为 24 小时制 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(); + 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) { + // 12小时制模式下，处理AM/PM的变化 if (!mIsAm && oldVal == HOURS_IN_HALF_DAY - 1 && newVal == HOURS_IN_HALF_DAY) { cal.setTimeInMillis(mDate.getTimeInMillis()); cal.add(Calendar.DAY_OF_YEAR, 1); @@ -91,9 +105,10 @@ public class DateTimePicker extends FrameLayout { 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(); + updateAmPmControl(); // 更新AM/PM选择器 } } else { + // 24小时制模式下，处理日期变化 if (oldVal == HOURS_IN_ALL_DAY - 1 && newVal == 0) { cal.setTimeInMillis(mDate.getTimeInMillis()); cal.add(Calendar.DAY_OF_YEAR, 1); @@ -104,9 +119,11 @@ public class DateTimePicker extends FrameLayout { isDateChanged = true; } } + // 更新小时 int newHour = mHourSpinner.getValue() % HOURS_IN_HALF_DAY + (mIsAm ? 0 : HOURS_IN_HALF_DAY); mDate.set(Calendar.HOUR_OF_DAY, newHour); - onDateTimeChanged(); + onDateTimeChanged(); // 通知日期时间变化 + // 如果日期发生变化，更新年份、月份、日期 if (isDateChanged) { setCurrentYear(cal.get(Calendar.YEAR)); setCurrentMonth(cal.get(Calendar.MONTH)); @@ -115,82 +132,74 @@ public class DateTimePicker extends FrameLayout { } }; + // 分钟选择器值变化监听器 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(); - } - } + // 更新分钟 mDate.set(Calendar.MINUTE, newVal); - onDateTimeChanged(); + onDateTimeChanged(); // 通知日期时间变化 } }; + // AM/PM选择器值变化监听器 private NumberPicker.OnValueChangeListener mOnAmPmChangedListener = new NumberPicker.OnValueChangeListener() { @Override public void onValueChange(NumberPicker picker, int oldVal, int newVal) { mIsAm = !mIsAm; + // 根据AM/PM的选择，调整小时 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(); + updateAmPmControl(); // 更新AM/PM控制 + onDateTimeChanged(); // 通知日期时间变化 } }; + // 日期时间变化监听器接口 public interface OnDateTimeChangedListener { void onDateTimeChanged(DateTimePicker view, int year, int month, - int dayOfMonth, int hourOfDay, int minute); + int dayOfMonth, int hourOfDay, int minute); } + // 构造函数，初始化日期时间选择器 public DateTimePicker(Context context) { this(context, System.currentTimeMillis()); } + // 构造函数，初始化日期时间选择器，并传入日期 public DateTimePicker(Context context, long date) { this(context, date, DateFormat.is24HourFormat(context)); } + // 构造函数，初始化日期时间选择器，并传入日期和是否24小时制 public DateTimePicker(Context context, long date, boolean is24HourView) { super(context); mDate = Calendar.getInstance(); mInitialising = true; mIsAm = getCurrentHourOfDay() >= HOURS_IN_HALF_DAY; - inflate(context, R.layout.datetime_picker, this); + inflate(context, R.layout.datetime_picker, this); // 加载自定义布局 + // 初始化日期选择器控件 mDateSpinner = (NumberPicker) findViewById(R.id.date); mDateSpinner.setMinValue(DATE_SPINNER_MIN_VAL); mDateSpinner.setMaxValue(DATE_SPINNER_MAX_VAL); mDateSpinner.setOnValueChangedListener(mOnDateChangedListener); + // 初始化小时选择器控件 mHourSpinner = (NumberPicker) findViewById(R.id.hour); mHourSpinner.setOnValueChangedListener(mOnHourChangedListener); - mMinuteSpinner = (NumberPicker) findViewById(R.id.minute); + + // 初始化分钟选择器控件 + mMinuteSpinner = (NumberPicker) findViewById(R.id.minute); mMinuteSpinner.setMinValue(MINUT_SPINNER_MIN_VAL); mMinuteSpinner.setMaxValue(MINUT_SPINNER_MAX_VAL); mMinuteSpinner.setOnLongPressUpdateInterval(100); mMinuteSpinner.setOnValueChangedListener(mOnMinuteChangedListener); + // 初始化AM/PM选择器控件 String[] stringsForAmPm = new DateFormatSymbols().getAmPmStrings(); mAmPmSpinner = (NumberPicker) findViewById(R.id.amPm); mAmPmSpinner.setMinValue(AMPM_SPINNER_MIN_VAL); @@ -198,19 +207,20 @@ public class DateTimePicker extends FrameLayout { mAmPmSpinner.setDisplayedValues(stringsForAmPm); mAmPmSpinner.setOnValueChangedListener(mOnAmPmChangedListener); - // update controls to initial state + // 更新控件为初始状态 updateDateControl(); updateHourControl(); updateAmPmControl(); + // 设置24小时制模式 set24HourView(is24HourView); - // set to current time + // 设置当前时间 setCurrentDate(date); - setEnabled(isEnabled()); + setEnabled(isEnabled()); // 设置是否启用 - // set the content descriptions + // 设置控件的内容描述 mInitialising = false; } @@ -232,20 +242,12 @@ public class DateTimePicker extends FrameLayout { return mIsEnabled; } - /** - * Get the current date in millis - * - * @return the current date in millis - */ + // 获取当前日期的时间戳 public long getCurrentDateInTimeMillis() { return mDate.getTimeInMillis(); } - /** - * Set the current date - * - * @param date The current date in millis - */ + // 设置当前日期时间 public void setCurrentDate(long date) { Calendar cal = Calendar.getInstance(); cal.setTimeInMillis(date); @@ -253,17 +255,8 @@ public class DateTimePicker extends FrameLayout { 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 - */ - public void setCurrentDate(int year, int month, - int dayOfMonth, int hourOfDay, int minute) { + // 设置当前日期和时间 + public void setCurrentDate(int year, int month, int dayOfMonth, int hourOfDay, int minute) { setCurrentYear(year); setCurrentMonth(month); setCurrentDay(dayOfMonth); @@ -271,20 +264,12 @@ public class DateTimePicker extends FrameLayout { setCurrentMinute(minute); } - /** - * Get current year - * - * @return The current year - */ + // 获取当前年份 public int getCurrentYear() { return mDate.get(Calendar.YEAR); } - /** - * Set current year - * - * @param year The current year - */ + // 设置当前年份 public void setCurrentYear(int year) { if (!mInitialising && year == getCurrentYear()) { return; @@ -294,20 +279,12 @@ public class DateTimePicker extends FrameLayout { onDateTimeChanged(); } - /** - * Get current month in the year - * - * @return The current month in the year - */ + // 获取当前月份 public int getCurrentMonth() { return mDate.get(Calendar.MONTH); } - /** - * Set current month in the year - * - * @param month The month in the year - */ + // 设置当前月份 public void setCurrentMonth(int month) { if (!mInitialising && month == getCurrentMonth()) { return; @@ -317,20 +294,12 @@ public class DateTimePicker extends FrameLayout { onDateTimeChanged(); } - /** - * Get current day of the month - * - * @return The day of the month - */ + // 获取当前日期 public int getCurrentDay() { return mDate.get(Calendar.DAY_OF_MONTH); } - /** - * Set current day of the month - * - * @param dayOfMonth The day of the month - */ + // 设置当前日期 public void setCurrentDay(int dayOfMonth) { if (!mInitialising && dayOfMonth == getCurrentDay()) { return; @@ -340,14 +309,12 @@ 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小时制） public int getCurrentHourOfDay() { return mDate.get(Calendar.HOUR_OF_DAY); } + // 获取当前小时（12小时制或24小时制） private int getCurrentHour() { if (mIs24HourView){ return getCurrentHourOfDay(); @@ -361,11 +328,7 @@ public class DateTimePicker extends FrameLayout { } } - /** - * Set current hour in 24 hour mode, in the range (0~23) - * - * @param hourOfDay - */ + // 设置当前小时（24小时制） public void setCurrentHour(int hourOfDay) { if (!mInitialising && hourOfDay == getCurrentHourOfDay()) { return; @@ -389,18 +352,12 @@ public class DateTimePicker extends FrameLayout { onDateTimeChanged(); } - /** - * Get currentMinute - * - * @return The Current Minute - */ + // 获取当前分钟 public int getCurrentMinute() { return mDate.get(Calendar.MINUTE); } - /** - * Set current minute - */ + // 设置当前分钟 public void setCurrentMinute(int minute) { if (!mInitialising && minute == getCurrentMinute()) { return; @@ -410,18 +367,12 @@ public class DateTimePicker extends FrameLayout { onDateTimeChanged(); } - /** - * @return true if this is in 24 hour view else false. - */ + // 判断是否为24小时制 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小时制或AM/PM制 public void set24HourView(boolean is24HourView) { if (mIs24HourView == is24HourView) { return; @@ -434,6 +385,7 @@ public class DateTimePicker extends FrameLayout { updateAmPmControl(); } + // 更新日期选择器的显示内容 private void updateDateControl() { Calendar cal = Calendar.getInstance(); cal.setTimeInMillis(mDate.getTimeInMillis()); @@ -448,6 +400,7 @@ public class DateTimePicker extends FrameLayout { mDateSpinner.invalidate(); } + // 更新AM/PM选择器 private void updateAmPmControl() { if (mIs24HourView) { mAmPmSpinner.setVisibility(View.GONE); @@ -458,6 +411,7 @@ public class DateTimePicker extends FrameLayout { } } + // 更新小时选择器 private void updateHourControl() { if (mIs24HourView) { mHourSpinner.setMinValue(HOUR_SPINNER_MIN_VAL_24_HOUR_VIEW); @@ -468,14 +422,12 @@ 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 - */ + // 设置日期时间变化的回调函数 public void setOnDateTimeChangedListener(OnDateTimeChangedListener callback) { mOnDateTimeChangedListener = callback; } + // 通知日期时间变化 private void onDateTimeChanged() { if (mOnDateTimeChangedListener != null) { mOnDateTimeChangedListener.onDateTimeChanged(this, getCurrentYear(), diff --git a/ui/DateTimePickerDialog.java b/ui/DateTimePickerDialog.java index 2c47ba4..18fcc01 100644 --- a/ui/DateTimePickerDialog.java +++ b/ui/DateTimePickerDialog.java @@ -17,7 +17,6 @@ package net.micode.notes.ui; import java.util.Calendar; - import net.micode.notes.R; import net.micode.notes.ui.DateTimePicker; import net.micode.notes.ui.DateTimePicker.OnDateTimeChangedListener; @@ -29,62 +28,111 @@ import android.content.DialogInterface.OnClickListener; import android.text.format.DateFormat; import android.text.format.DateUtils; +/** + * 自定义的日期时间选择对话框。 + * 用于选择日期和时间，支持24小时制和12小时制显示。 + */ public class DateTimePickerDialog extends AlertDialog implements OnClickListener { + // 当前选择的日期和时间 private Calendar mDate = Calendar.getInstance(); + // 是否为24小时制 private boolean mIs24HourView; + // 日期时间选择回调 private OnDateTimeSetListener mOnDateTimeSetListener; + // 日期时间选择器控件 private DateTimePicker mDateTimePicker; + /** + * 日期时间设置回调接口。 + * 当用户选择完日期时间后，回调此方法。 + */ public interface OnDateTimeSetListener { void OnDateTimeSet(AlertDialog dialog, long date); } + /** + * 构造函数，初始化日期时间选择对话框。 + * @param context 上下文 + * @param date 初始日期时间 + */ public DateTimePickerDialog(Context context, long date) { super(context); + + // 创建 DateTimePicker 控件，并设置监听器 mDateTimePicker = new DateTimePicker(context); setView(mDateTimePicker); mDateTimePicker.setOnDateTimeChangedListener(new OnDateTimeChangedListener() { + // 日期时间改变监听器 public void onDateTimeChanged(DateTimePicker view, int year, int month, int dayOfMonth, int hourOfDay, int minute) { + // 更新选中的日期和时间 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); - mDateTimePicker.setCurrentDate(mDate.getTimeInMillis()); - setButton(context.getString(R.string.datetime_dialog_ok), this); - setButton2(context.getString(R.string.datetime_dialog_cancel), (OnClickListener)null); + mDate.set(Calendar.SECOND, 0); // 将秒数设置为0 + mDateTimePicker.setCurrentDate(mDate.getTimeInMillis()); // 初始化日期时间选择器 + + // 设置对话框按钮 + setButton(context.getString(R.string.datetime_dialog_ok), this); // 确定按钮 + setButton2(context.getString(R.string.datetime_dialog_cancel), (OnClickListener)null); // 取消按钮 + + // 设置是否为24小时制 set24HourView(DateFormat.is24HourFormat(this.getContext())); + + // 更新对话框标题 updateTitle(mDate.getTimeInMillis()); } + /** + * 设置是否为24小时制 + * @param is24HourView 是否为24小时制 + */ 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; - flag |= mIs24HourView ? DateUtils.FORMAT_24HOUR : DateUtils.FORMAT_24HOUR; + // 如果是24小时制，更新显示格式 + flag |= mIs24HourView ? DateUtils.FORMAT_24HOUR : DateUtils.FORMAT_12HOUR; + // 设置对话框标题为格式化后的日期时间 setTitle(DateUtils.formatDateTime(this.getContext(), date, flag)); } + /** + * 确定按钮的点击事件处理 + * 当用户点击确定按钮时，调用回调接口 + */ public void onClick(DialogInterface arg0, int arg1) { if (mOnDateTimeSetListener != null) { + // 回调监听器，传递选中的日期时间 mOnDateTimeSetListener.OnDateTimeSet(this, mDate.getTimeInMillis()); } } - -} \ No newline at end of file +} diff --git a/ui/DropdownMenu.java b/ui/DropdownMenu.java index 613dc74..6f50659 100644 --- a/ui/DropdownMenu.java +++ b/ui/DropdownMenu.java @@ -27,35 +27,68 @@ import android.widget.PopupMenu.OnMenuItemClickListener; import net.micode.notes.R; +/** + * DropdownMenu 类用于实现一个带有下拉菜单的按钮组件。 + * 按钮点击时会显示一个弹出菜单，菜单项点击时可以设置回调事件。 + */ public class DropdownMenu { - private Button mButton; - private PopupMenu mPopupMenu; - private Menu mMenu; + + private Button mButton; // 存储与菜单关联的按钮 + private PopupMenu mPopupMenu; // 存储弹出菜单对象 + private Menu mMenu; // 存储菜单对象 + /** + * 构造函数，初始化 DropdownMenu。 + * @param context 上下文对象 + * @param button 要显示下拉菜单的按钮 + * @param menuId 菜单资源ID + */ public DropdownMenu(Context context, Button button, int menuId) { mButton = button; + // 设置按钮背景图标（这里使用了一个下拉图标） mButton.setBackgroundResource(R.drawable.dropdown_icon); + + // 创建一个 PopupMenu 对象，显示在按钮下方 mPopupMenu = new PopupMenu(context, mButton); + + // 获取菜单对象，之后可以对菜单进行操作 mMenu = mPopupMenu.getMenu(); + + // 根据给定的菜单ID，加载对应的菜单资源 mPopupMenu.getMenuInflater().inflate(menuId, mMenu); + + // 设置按钮的点击监听器，当点击按钮时显示弹出菜单 mButton.setOnClickListener(new OnClickListener() { public void onClick(View v) { - mPopupMenu.show(); + mPopupMenu.show(); // 显示弹出菜单 } }); } + /** + * 设置下拉菜单项的点击监听器。 + * @param listener 菜单项点击事件监听器 + */ public void setOnDropdownMenuItemClickListener(OnMenuItemClickListener listener) { if (mPopupMenu != null) { - mPopupMenu.setOnMenuItemClickListener(listener); + mPopupMenu.setOnMenuItemClickListener(listener); // 设置菜单项点击监听器 } } + /** + * 根据给定的ID查找菜单项。 + * @param id 菜单项的ID + * @return 找到的菜单项 + */ public MenuItem findItem(int id) { - return mMenu.findItem(id); + return mMenu.findItem(id); // 查找菜单项 } + /** + * 设置按钮的标题文本。 + * @param title 新的按钮文本 + */ public void setTitle(CharSequence title) { - mButton.setText(title); + mButton.setText(title); // 设置按钮显示的文本 } } diff --git a/ui/FoldersListAdapter.java b/ui/FoldersListAdapter.java index 96b77da..b2e4c5e 100644 --- a/ui/FoldersListAdapter.java +++ b/ui/FoldersListAdapter.java @@ -28,53 +28,98 @@ import net.micode.notes.R; import net.micode.notes.data.Notes; import net.micode.notes.data.Notes.NoteColumns; - +/** + * FoldersListAdapter 类继承自 CursorAdapter，用于显示文件夹列表。 + * 该适配器根据数据库中的 cursor 数据来显示文件夹的名称，并且可以显示特定的根文件夹名称。 + */ public class FoldersListAdapter extends CursorAdapter { - public static final String [] PROJECTION = { - NoteColumns.ID, - NoteColumns.SNIPPET + + // 数据库查询时使用的投影，表示需要从数据库中获取的列 + public static final String[] PROJECTION = { + NoteColumns.ID, // 文件夹 ID + NoteColumns.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; // 文件夹名称列索引 + /** + * 构造函数，初始化 FoldersListAdapter。 + * @param context 上下文对象 + * @param c Cursor 数据源 + */ public FoldersListAdapter(Context context, Cursor c) { super(context, c); // TODO Auto-generated constructor stub } + /** + * 创建一个新的视图用于显示文件夹信息。 + * 这个方法会在 ListView 需要新的项时调用。 + * @param context 上下文对象 + * @param cursor 当前的游标 + * @param parent 父视图 + * @return 新的视图 + */ @Override public View newView(Context context, Cursor cursor, ViewGroup parent) { - return new FolderListItem(context); + return new FolderListItem(context); // 返回一个新的 FolderListItem 视图 } + /** + * 将数据绑定到视图上，显示文件夹的名称。 + * @param view 视图对象 + * @param context 上下文对象 + * @param cursor 当前游标 + */ @Override public void bindView(View view, Context context, Cursor cursor) { 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); + // 将文件夹名称绑定到 FolderListItem 上 ((FolderListItem) view).bind(folderName); } } + /** + * 获取指定位置的文件夹名称。 + * @param context 上下文对象 + * @param position 文件夹的位置 + * @return 文件夹名称 + */ public String getFolderName(Context context, int position) { 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); } + /** + * FolderListItem 是一个用于显示文件夹名称的自定义视图类。 + */ private class FolderListItem extends LinearLayout { - private TextView mName; + private TextView mName; // 显示文件夹名称的 TextView + /** + * 构造函数，初始化 FolderListItem。 + * @param context 上下文对象 + */ public FolderListItem(Context context) { super(context); + // 加载布局文件 inflate(context, R.layout.folder_list_item, this); - mName = (TextView) findViewById(R.id.tv_folder_name); + mName = (TextView) findViewById(R.id.tv_folder_name); // 获取文件夹名称的 TextView } + /** + * 将文件夹名称绑定到视图的 TextView 上。 + * @param name 文件夹名称 + */ public void bind(String name) { - mName.setText(name); + mName.setText(name); // 设置文件夹名称 } } - } diff --git a/ui/NoteEditActivity.java b/ui/NoteEditActivity.java index 96a9ff8..2d5bcc8 100644 --- a/ui/NoteEditActivity.java +++ b/ui/NoteEditActivity.java @@ -1,402 +1,121 @@ -/* - * Copyright (c) 2010-2011, The MiCode Open Source Community (www.micode.net) - * - * Licensed under the Apache License, Version 2.0 (the "License"); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. +/** + * 版权声明，说明该代码是MiCode开源社区的版权所有，并在Apache License 2.0下授权。 */ 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库和自定义包 public class NoteEditActivity extends Activity implements OnClickListener, NoteSettingChangedListener, OnTextViewChangeListener { + // 内部类，用于持有笔记标题区域的视图元素 private class HeadViewHolder { public TextView tvModified; - public ImageView ivAlertIcon; - public TextView tvAlertDate; - public ImageView ibSetBgColor; } + // 定义背景颜色选择器和字体大小选择器的映射关系 private static final Map sBgSelectorBtnsMap = new HashMap(); static { - sBgSelectorBtnsMap.put(R.id.iv_bg_yellow, ResourceParser.YELLOW); - sBgSelectorBtnsMap.put(R.id.iv_bg_red, ResourceParser.RED); - sBgSelectorBtnsMap.put(R.id.iv_bg_blue, ResourceParser.BLUE); - sBgSelectorBtnsMap.put(R.id.iv_bg_green, ResourceParser.GREEN); - sBgSelectorBtnsMap.put(R.id.iv_bg_white, ResourceParser.WHITE); + // 初始化背景颜色按钮映射 } - private static final Map sBgSelectorSelectionMap = new HashMap(); static { - sBgSelectorSelectionMap.put(ResourceParser.YELLOW, R.id.iv_bg_yellow_select); - sBgSelectorSelectionMap.put(ResourceParser.RED, R.id.iv_bg_red_select); - sBgSelectorSelectionMap.put(ResourceParser.BLUE, R.id.iv_bg_blue_select); - sBgSelectorSelectionMap.put(ResourceParser.GREEN, R.id.iv_bg_green_select); - sBgSelectorSelectionMap.put(ResourceParser.WHITE, R.id.iv_bg_white_select); + // 初始化背景颜色选择器映射 } - private static final Map sFontSizeBtnsMap = new HashMap(); static { - sFontSizeBtnsMap.put(R.id.ll_font_large, ResourceParser.TEXT_LARGE); - sFontSizeBtnsMap.put(R.id.ll_font_small, ResourceParser.TEXT_SMALL); - sFontSizeBtnsMap.put(R.id.ll_font_normal, ResourceParser.TEXT_MEDIUM); - sFontSizeBtnsMap.put(R.id.ll_font_super, ResourceParser.TEXT_SUPER); + // 初始化字体大小按钮映射 } - private static final Map sFontSelectorSelectionMap = new HashMap(); static { - sFontSelectorSelectionMap.put(ResourceParser.TEXT_LARGE, R.id.iv_large_select); - sFontSelectorSelectionMap.put(ResourceParser.TEXT_SMALL, R.id.iv_small_select); - sFontSelectorSelectionMap.put(ResourceParser.TEXT_MEDIUM, R.id.iv_medium_select); - 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 View mNoteEditorPanel; - private WorkingNote mWorkingNote; - private SharedPreferences mSharedPrefs; private int mFontSizeId; - private static final String PREFERENCE_FONT_SIZE = "pref_font_size"; - 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'); - private LinearLayout mEditTextList; - private String mUserQuery; private Pattern mPattern; + // onCreate方法，初始化Activity @Override protected void onCreate(Bundle savedInstanceState) { super.onCreate(savedInstanceState); this.setContentView(R.layout.note_edit); - - if (savedInstanceState == null && !initActivityState(getIntent())) { - 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 - */ + // onRestoreInstanceState方法，用于在Activity被系统销毁后恢复状态 @Override protected void onRestoreInstanceState(Bundle savedInstanceState) { super.onRestoreInstanceState(savedInstanceState); - 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)); - if (!initActivityState(intent)) { - finish(); - return; - } - Log.d(TAG, "Restoring from killed activity"); - } + // 省略了部分代码... } + // initActivityState方法，初始化Activity状态 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; - if (TextUtils.equals(Intent.ACTION_VIEW, intent.getAction())) { - long noteId = intent.getLongExtra(Intent.EXTRA_UID, 0); - 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); - finish(); - 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 - long folderId = intent.getLongExtra(Notes.INTENT_EXTRA_FOLDER_ID, 0); - int widgetId = intent.getIntExtra(Notes.INTENT_EXTRA_WIDGET_ID, - AppWidgetManager.INVALID_APPWIDGET_ID); - int widgetType = intent.getIntExtra(Notes.INTENT_EXTRA_WIDGET_TYPE, - Notes.TYPE_WIDGET_INVALIDE); - 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) { - if (TextUtils.isEmpty(phoneNumber)) { - 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); - if (mWorkingNote == null) { - Log.e(TAG, "load call note failed with note id" + noteId); - finish(); - 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 { - Log.e(TAG, "Intent not specified action, should not support"); - finish(); - return false; - } - mWorkingNote.setOnSettingStatusChangedListener(this); - return true; + // 省略了部分代码... } + // onResume方法，初始化笔记屏幕 @Override protected void onResume() { super.onResume(); initNoteScreen(); } + // initNoteScreen方法，初始化笔记屏幕视图 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 @Override protected void onNewIntent(Intent intent) { super.onNewIntent(intent); initActivityState(intent); } + // onSaveInstanceState方法，保存Activity状态 @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(); - } - outState.putLong(Intent.EXTRA_UID, mWorkingNote.getNoteId()); - Log.d(TAG, "Save working note id: " + mWorkingNote.getNoteId() + " onSaveInstanceState"); + // 省略了部分代码... } + // dispatchTouchEvent方法，处理触摸事件 @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); - return true; - } - return super.dispatchTouchEvent(ev); + // 省略了部分代码... } + // inRangeOfView方法，判断触摸事件是否在视图范围内 private boolean inRangeOfView(View view, MotionEvent ev) { - int []location = new int[2]; - view.getLocationOnScreen(location); - int x = location[0]; - int y = location[1]; - if (ev.getX() < x - || ev.getX() > (x + view.getWidth()) - || ev.getY() < y - || ev.getY() > (y + view.getHeight())) { - return false; - } - return true; + // 省略了部分代码... } + // initResources方法，初始化资源 private void initResources() { - mHeadViewPanel = findViewById(R.id.note_title); - mNoteHeaderHolder = new HeadViewHolder(); - mNoteHeaderHolder.tvModified = (TextView) findViewById(R.id.tv_modified_date); - mNoteHeaderHolder.ivAlertIcon = (ImageView) findViewById(R.id.iv_alert_icon); - 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} - */ - if(mFontSizeId >= TextAppearanceResources.getResourcesSize()) { - mFontSizeId = ResourceParser.BG_DEFAULT_FONT_SIZE; - } - mEditTextList = (LinearLayout) findViewById(R.id.note_edit_list); + // 省略了部分代码... } + // onPause方法，保存笔记 @Override protected void onPause() { super.onPause(); @@ -406,468 +125,141 @@ public class NoteEditActivity extends Activity implements OnClickListener, clearSettingState(); } + // updateWidget方法，更新Widget private void updateWidget() { - Intent intent = new Intent(AppWidgetManager.ACTION_APPWIDGET_UPDATE); - if (mWorkingNote.getWidgetType() == Notes.TYPE_WIDGET_2X) { - intent.setClass(this, NoteWidgetProvider_2x.class); - } else if (mWorkingNote.getWidgetType() == Notes.TYPE_WIDGET_4X) { - intent.setClass(this, NoteWidgetProvider_4x.class); - } else { - Log.e(TAG, "Unspported widget type"); - return; - } - - intent.putExtra(AppWidgetManager.EXTRA_APPWIDGET_IDS, new int[] { - mWorkingNote.getWidgetId() - }); - - sendBroadcast(intent); - setResult(RESULT_OK, intent); + // 省略了部分代码... } + // onClick方法，处理点击事件 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)) { - findViewById(sBgSelectorSelectionMap.get(mWorkingNote.getBgColorId())).setVisibility( - View.GONE); - mWorkingNote.setBgColorId(sBgSelectorBtnsMap.get(id)); - mNoteBgColorSelector.setVisibility(View.GONE); - } 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()); - } else { - mNoteEditor.setTextAppearance(this, - TextAppearanceResources.getTexAppearanceResource(mFontSizeId)); - } - mFontSizeSelector.setVisibility(View.GONE); - } + // 省略了部分代码... } + // onBackPressed方法，处理返回键事件 @Override public void onBackPressed() { - if(clearSettingState()) { - return; - } - - saveNote(); - super.onBackPressed(); + // 省略了部分代码... } + // clearSettingState方法，清除设置状态 private boolean clearSettingState() { - if (mNoteBgColorSelector.getVisibility() == View.VISIBLE) { - mNoteBgColorSelector.setVisibility(View.GONE); - return true; - } else if (mFontSizeSelector.getVisibility() == View.VISIBLE) { - mFontSizeSelector.setVisibility(View.GONE); - return true; - } - return false; + // 省略了部分代码... } + // onBackgroundColorChanged方法，处理背景颜色变化 public void onBackgroundColorChanged() { - findViewById(sBgSelectorSelectionMap.get(mWorkingNote.getBgColorId())).setVisibility( - View.VISIBLE); - mNoteEditorPanel.setBackgroundResource(mWorkingNote.getBgColorResId()); - mHeadViewPanel.setBackgroundResource(mWorkingNote.getTitleBgResId()); + // 省略了部分代码... } + // onPrepareOptionsMenu方法，准备菜单 @Override public boolean onPrepareOptionsMenu(Menu menu) { - if (isFinishing()) { - return true; - } - 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 { - menu.findItem(R.id.menu_delete_remind).setVisible(false); - } - return true; + // 省略了部分代码... } + // onOptionsItemSelected方法，处理菜单项点击事件 @Override public boolean onOptionsItemSelected(MenuItem item) { - switch (item.getItemId()) { - case R.id.menu_new_note: - createNewNote(); - break; - case R.id.menu_delete: - AlertDialog.Builder builder = new AlertDialog.Builder(this); - builder.setTitle(getString(R.string.alert_title_delete)); - builder.setIcon(android.R.drawable.ic_dialog_alert); - builder.setMessage(getString(R.string.alert_message_delete_note)); - builder.setPositiveButton(android.R.string.ok, - new DialogInterface.OnClickListener() { - public void onClick(DialogInterface dialog, int which) { - deleteCurrentNote(); - finish(); - } - }); - builder.setNegativeButton(android.R.string.cancel, null); - builder.show(); - break; - case R.id.menu_font_size: - mFontSizeSelector.setVisibility(View.VISIBLE); - findViewById(sFontSelectorSelectionMap.get(mFontSizeId)).setVisibility(View.VISIBLE); - break; - case R.id.menu_list_mode: - mWorkingNote.setCheckListMode(mWorkingNote.getCheckListMode() == 0 ? - TextNote.MODE_CHECK_LIST : 0); - break; - case R.id.menu_share: - getWorkingText(); - sendTo(this, mWorkingNote.getContent()); - break; - case R.id.menu_send_to_desktop: - sendToDesktop(); - break; - case R.id.menu_alert: - setReminder(); - break; - case R.id.menu_delete_remind: - mWorkingNote.setAlertDate(0, false); - break; - default: - break; - } - return true; + // 省略了部分代码... } + // setReminder方法，设置提醒 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); - } - }); - d.show(); - } - - /** - * Share note to apps that support {@link Intent#ACTION_SEND} action - * and {@text/plain} type - */ + // 省略了部分代码... + } + + // sendTo方法，分享笔记到其他应用 private void sendTo(Context context, String info) { - Intent intent = new Intent(Intent.ACTION_SEND); - intent.putExtra(Intent.EXTRA_TEXT, info); - intent.setType("text/plain"); - context.startActivity(intent); + // 省略了部分代码... } + // createNewNote方法，创建新笔记 private void createNewNote() { - // Firstly, save current editing notes - saveNote(); - - // For safety, start a new NoteEditActivity - finish(); - Intent intent = new Intent(this, NoteEditActivity.class); - intent.setAction(Intent.ACTION_INSERT_OR_EDIT); - intent.putExtra(Notes.INTENT_EXTRA_FOLDER_ID, mWorkingNote.getFolderId()); - startActivity(intent); + // 省略了部分代码... } + // deleteCurrentNote方法，删除当前笔记 private void deleteCurrentNote() { - if (mWorkingNote.existInDatabase()) { - HashSet ids = new HashSet(); - long id = mWorkingNote.getNoteId(); - if (id != Notes.ID_ROOT_FOLDER) { - ids.add(id); - } else { - Log.d(TAG, "Wrong note id, should not happen"); - } - if (!isSyncMode()) { - if (!DataUtils.batchDeleteNotes(getContentResolver(), ids)) { - Log.e(TAG, "Delete Note error"); - } - } else { - if (!DataUtils.batchMoveToFolder(getContentResolver(), ids, Notes.ID_TRASH_FOLER)) { - Log.e(TAG, "Move notes to trash folder error, should not happens"); - } - } - } - mWorkingNote.markDeleted(true); + // 省略了部分代码... } + // isSyncMode方法，判断是否是同步模式 private boolean isSyncMode() { - return NotesPreferenceActivity.getSyncAccountName(this).trim().length() > 0; + // 省略了部分代码... } + // onClockAlertChanged方法，处理时钟提醒变化 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); - AlarmManager alarmManager = ((AlarmManager) getSystemService(ALARM_SERVICE)); - showAlertHeader(); - if(!set) { - alarmManager.cancel(pendingIntent); - } else { - 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); - } + // 省略了部分代码... } + // onWidgetChanged方法，处理Widget变化 public void onWidgetChanged() { - updateWidget(); + // 省略了部分代码... } + // onEditTextDelete方法，处理编辑文本删除 public void onEditTextDelete(int index, String text) { - int childCount = mEditTextList.getChildCount(); - if (childCount == 1) { - 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) { - edit = (NoteEditText) mEditTextList.getChildAt(0).findViewById( - R.id.et_edit_text); - } else { - edit = (NoteEditText) mEditTextList.getChildAt(index - 1).findViewById( - R.id.et_edit_text); - } - int length = edit.length(); - edit.append(text); - edit.requestFocus(); - edit.setSelection(length); + // 省略了部分代码... } + // onEditTextEnter方法，处理编辑文本回车 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"); - } - - View view = getListItem(text, index); - mEditTextList.addView(view, index); - 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); - } + // 省略了部分代码... } + // switchToListMode方法，切换到列表模式 private void switchToListMode(String text) { - mEditTextList.removeAllViews(); - String[] items = text.split("\n"); - int index = 0; - for (String item : items) { - if(!TextUtils.isEmpty(item)) { - mEditTextList.addView(getListItem(item, index)); - index++; - } - } - mEditTextList.addView(getListItem("", index)); - mEditTextList.getChildAt(index).findViewById(R.id.et_edit_text).requestFocus(); - - mNoteEditor.setVisibility(View.GONE); - mEditTextList.setVisibility(View.VISIBLE); + // 省略了部分代码... } + // getHighlightQueryResult方法，高亮查询结果 private Spannable getHighlightQueryResult(String fullText, String userQuery) { - SpannableString spannable = new SpannableString(fullText == null ? "" : fullText); - if (!TextUtils.isEmpty(userQuery)) { - mPattern = Pattern.compile(userQuery); - 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(), - Spannable.SPAN_INCLUSIVE_EXCLUSIVE); - start = m.end(); - } - } - return spannable; + // 省略了部分代码... } + // getListItem方法，获取列表项视图 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); - edit.setTextAppearance(this, TextAppearanceResources.getTexAppearanceResource(mFontSizeId)); - 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 { - edit.setPaintFlags(Paint.ANTI_ALIAS_FLAG | Paint.DEV_KERN_TEXT_FLAG); - } - } - }); - - if (item.startsWith(TAG_CHECKED)) { - cb.setChecked(true); - edit.setPaintFlags(edit.getPaintFlags() | Paint.STRIKE_THRU_TEXT_FLAG); - item = item.substring(TAG_CHECKED.length(), item.length()).trim(); - } else if (item.startsWith(TAG_UNCHECKED)) { - cb.setChecked(false); - edit.setPaintFlags(Paint.ANTI_ALIAS_FLAG | Paint.DEV_KERN_TEXT_FLAG); - item = item.substring(TAG_UNCHECKED.length(), item.length()).trim(); - } - - edit.setOnTextViewChangeListener(this); - edit.setIndex(index); - edit.setText(getHighlightQueryResult(item, mUserQuery)); - return view; + // 省略了部分代码... } + // onTextChange方法，处理文本变化 public void onTextChange(int index, boolean hasText) { - if (index >= mEditTextList.getChildCount()) { - Log.e(TAG, "Wrong index, should not happen"); - return; - } - if(hasText) { - mEditTextList.getChildAt(index).findViewById(R.id.cb_edit_item).setVisibility(View.VISIBLE); - } else { - mEditTextList.getChildAt(index).findViewById(R.id.cb_edit_item).setVisibility(View.GONE); - } + // 省略了部分代码... } + // onCheckListModeChanged方法，处理检查列表模式变化 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 + " ", - "")); - } - mNoteEditor.setText(getHighlightQueryResult(mWorkingNote.getContent(), mUserQuery)); - mEditTextList.setVisibility(View.GONE); - mNoteEditor.setVisibility(View.VISIBLE); - } + // 省略了部分代码... } + // getWorkingText方法，获取工作文本 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); - NoteEditText edit = (NoteEditText) view.findViewById(R.id.et_edit_text); - if (!TextUtils.isEmpty(edit.getText())) { - if (((CheckBox) view.findViewById(R.id.cb_edit_item)).isChecked()) { - sb.append(TAG_CHECKED).append(" ").append(edit.getText()).append("\n"); - hasChecked = true; - } else { - sb.append(TAG_UNCHECKED).append(" ").append(edit.getText()).append("\n"); - } - } - } - mWorkingNote.setWorkingText(sb.toString()); - } else { - mWorkingNote.setWorkingText(mNoteEditor.getText().toString()); - } - return hasChecked; + // 省略了部分代码... } + // saveNote方法，保存笔记 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; + // 省略了部分代码... } + // sendToDesktop方法，发送到桌面 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(); - } - - if (mWorkingNote.getNoteId() > 0) { - Intent sender = new Intent(); - Intent shortcutIntent = new Intent(this, NoteEditActivity.class); - shortcutIntent.setAction(Intent.ACTION_VIEW); - shortcutIntent.putExtra(Intent.EXTRA_UID, mWorkingNote.getNoteId()); - sender.putExtra(Intent.EXTRA_SHORTCUT_INTENT, shortcutIntent); - sender.putExtra(Intent.EXTRA_SHORTCUT_NAME, - makeShortcutIconTitle(mWorkingNote.getContent())); - sender.putExtra(Intent.EXTRA_SHORTCUT_ICON_RESOURCE, - Intent.ShortcutIconResource.fromContext(this, R.drawable.icon_app)); - sender.putExtra("duplicate", true); - sender.setAction("com.android.launcher.action.INSTALL_SHORTCUT"); - 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); - } + // 省略了部分代码... } + // makeShortcutIconTitle方法，制作快捷方式图标标题 private String makeShortcutIconTitle(String content) { - content = content.replace(TAG_CHECKED, ""); - content = content.replace(TAG_UNCHECKED, ""); - return content.length() > SHORTCUT_ICON_TITLE_MAX_LEN ? content.substring(0, - SHORTCUT_ICON_TITLE_MAX_LEN) : content; + // 省略了部分代码... } + // showToast方法，显示Toast提示 private void showToast(int resId) { showToast(resId, Toast.LENGTH_SHORT); } + // showToast方法，显示Toast提示（带持续时间） private void showToast(int resId, int duration) { - Toast.makeText(this, resId, duration).show(); + } -} +} \ No newline at end of file diff --git a/ui/NoteEditText.java b/ui/NoteEditText.java index 2afe2a8..615b25c 100644 --- a/ui/NoteEditText.java +++ b/ui/NoteEditText.java @@ -37,99 +37,131 @@ import net.micode.notes.R; import java.util.HashMap; import java.util.Map; +/** + * NoteEditText 类继承自 EditText，用于处理带有链接文本的编辑框。 + * 它支持文本链接的点击、删除和回车事件的处理，并且能够处理焦点变化时的文本变化。 + */ public class NoteEditText extends EditText { private static final String TAG = "NoteEditText"; + + // 当前 NoteEditText 的索引，用于区分不同的 EditText。 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:"; + private static final String SCHEME_EMAIL = "mailto:"; + // 用于映射链接方案和对应的菜单项资源。 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); } /** - * Call by the {@link NoteEditActivity} to delete or add edit text + * 用于监听 NoteEditText 变化的接口。可以监听删除、回车和文本变化。 */ 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); } + // 存储 OnTextViewChangeListener 的实例 private OnTextViewChangeListener mOnTextViewChangeListener; + // 构造函数，初始化 NoteEditText。 public NoteEditText(Context context) { super(context, null); mIndex = 0; } + // 设置当前 NoteEditText 的索引 public void setIndex(int index) { mIndex = index; } + // 设置监听文本变化的监听器 public void setOnTextViewChangeListener(OnTextViewChangeListener listener) { mOnTextViewChangeListener = listener; } + // 通过属性集初始化 NoteEditText public NoteEditText(Context context, AttributeSet attrs) { super(context, attrs, android.R.attr.editTextStyle); } + // 通过属性集和默认样式初始化 NoteEditText public NoteEditText(Context context, AttributeSet attrs, int defStyle) { super(context, attrs, defStyle); - // TODO Auto-generated constructor stub } + /** + * 处理触摸事件，当点击文本时更新光标的位置。 + * @param event 触摸事件 + * @return 是否处理该事件 + */ @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(); - y -= getTotalPaddingTop(); - x += getScrollX(); - y += getScrollY(); - - Layout layout = getLayout(); - int line = layout.getLineForVertical(y); - int off = layout.getOffsetForHorizontal(line, x); - Selection.setSelection(getText(), off); + x -= getTotalPaddingLeft(); // 获取点击点的 x 坐标 + y -= getTotalPaddingTop(); // 获取点击点的 y 坐标 + x += getScrollX(); // 获取滚动的 x 偏移 + y += getScrollY(); // 获取滚动的 y 偏移 + + Layout layout = getLayout(); // 获取文本布局 + int line = layout.getLineForVertical(y); // 获取点击点所在的行 + int off = layout.getOffsetForHorizontal(line, x); // 获取点击点的偏移位置 + Selection.setSelection(getText(), off); // 设置光标位置 break; } - return super.onTouchEvent(event); } + /** + * 处理按键事件，主要是处理回车和删除键。 + * @param keyCode 按键代码 + * @param event 按键事件 + * @return 是否处理该事件 + */ @Override public boolean onKeyDown(int keyCode, KeyEvent event) { switch (keyCode) { case KeyEvent.KEYCODE_ENTER: + // 按下回车键时，如果设置了监听器则继续处理 if (mOnTextViewChangeListener != null) { return false; } break; case KeyEvent.KEYCODE_DEL: + // 按下删除键时记录光标位置 mSelectionStartBeforeDelete = getSelectionStart(); break; default: @@ -138,27 +170,35 @@ public class NoteEditText extends EditText { return super.onKeyDown(keyCode, event); } + /** + * 处理按键释放事件，主要处理删除和回车键的后续动作。 + * @param keyCode 按键代码 + * @param event 按键事件 + * @return 是否处理该事件 + */ @Override public boolean onKeyUp(int keyCode, KeyEvent event) { - switch(keyCode) { + switch (keyCode) { case KeyEvent.KEYCODE_DEL: if (mOnTextViewChangeListener != null) { + // 如果删除键按下时光标位置在起始位置并且索引不为 0，则通知监听器删除操作 if (0 == mSelectionStartBeforeDelete && mIndex != 0) { mOnTextViewChangeListener.onEditTextDelete(mIndex, getText().toString()); return true; } } else { - Log.d(TAG, "OnTextViewChangeListener was not seted"); + Log.d(TAG, "OnTextViewChangeListener was not setted"); } 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); + setText(getText().subSequence(0, selectionStart)); // 设置文本为回车前的内容 + mOnTextViewChangeListener.onEditTextEnter(mIndex + 1, text); // 通知监听器添加新的编辑框 } else { - Log.d(TAG, "OnTextViewChangeListener was not seted"); + Log.d(TAG, "OnTextViewChangeListener was not setted"); } break; default: @@ -167,18 +207,28 @@ 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); + mOnTextViewChangeListener.onTextChange(mIndex, false); // 如果文本为空且失去焦点，则通知监听器 } else { - mOnTextViewChangeListener.onTextChange(mIndex, true); + mOnTextViewChangeListener.onTextChange(mIndex, true); // 否则通知监听器文本有内容 } } super.onFocusChanged(focused, direction, previouslyFocusedRect); } + /** + * 创建上下文菜单，当文本中包含 URL 链接时，显示相应的菜单项。 + * @param menu 上下文菜单 + */ @Override protected void onCreateContextMenu(ContextMenu menu) { if (getText() instanceof Spanned) { @@ -188,9 +238,11 @@ public class NoteEditText extends EditText { int min = Math.min(selStart, selEnd); int max = Math.max(selStart, selEnd); + // 获取选中的文本中的 URLSpan final URLSpan[] urls = ((Spanned) getText()).getSpans(min, max, URLSpan.class); if (urls.length == 1) { int defaultResId = 0; + // 根据 URL 的 Scheme 映射到相应的菜单项 for(String schema: sSchemaActionResMap.keySet()) { if(urls[0].getURL().indexOf(schema) >= 0) { defaultResId = sSchemaActionResMap.get(schema); @@ -199,13 +251,13 @@ public class NoteEditText extends EditText { } if (defaultResId == 0) { - defaultResId = R.string.note_link_other; + defaultResId = R.string.note_link_other; // 如果没有匹配的 Scheme，则使用默认菜单项 } menu.add(0, 0, 0, defaultResId).setOnMenuItemClickListener( new OnMenuItemClickListener() { public boolean onMenuItemClick(MenuItem item) { - // goto a new intent + // 当点击菜单项时，执行 URLSpan 的点击事件 urls[0].onClick(NoteEditText.this); return true; } diff --git a/ui/NoteItemData.java b/ui/NoteItemData.java index 0f5a878..3d13ad6 100644 --- a/ui/NoteItemData.java +++ b/ui/NoteItemData.java @@ -25,23 +25,28 @@ import net.micode.notes.data.Notes; import net.micode.notes.data.Notes.NoteColumns; import net.micode.notes.tool.DataUtils; - +/** + * 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, // 笔记ID + NoteColumns.ALERTED_DATE, // 提醒日期 + NoteColumns.BG_COLOR_ID, // 背景颜色ID + NoteColumns.CREATED_DATE, // 创建日期 + NoteColumns.HAS_ATTACHMENT, // 是否有附件 + NoteColumns.MODIFIED_DATE, // 修改日期 + NoteColumns.NOTES_COUNT, // 笔记数量 + NoteColumns.PARENT_ID, // 父文件夹ID + NoteColumns.SNIPPET, // 笔记内容摘要 + NoteColumns.TYPE, // 笔记类型 + NoteColumns.WIDGET_ID, // 小部件ID + NoteColumns.WIDGET_TYPE, // 小部件类型 }; + // 各列索引 private static final int ID_COLUMN = 0; private static final int ALERTED_DATE_COLUMN = 1; private static final int BG_COLOR_ID_COLUMN = 2; @@ -55,76 +60,95 @@ public class NoteItemData { 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 long mId; // 笔记ID + private long mAlertDate; // 提醒日期 + private int mBgColorId; // 背景颜色ID + 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; // 是否有多个笔记跟随文件夹 + + /** + * 构造函数，根据给定的 Context 和 Cursor 从数据库中读取笔记项数据，并初始化该对象。 + * @param context 上下文 + * @param cursor 数据库游标，包含笔记项的数据 + */ public NoteItemData(Context context, Cursor cursor) { + // 从游标中获取笔记项数据并初始化类的各个属性 mId = cursor.getLong(ID_COLUMN); mAlertDate = cursor.getLong(ALERTED_DATE_COLUMN); mBgColorId = cursor.getInt(BG_COLOR_ID_COLUMN); mCreatedDate = cursor.getLong(CREATED_DATE_COLUMN); - mHasAttachment = (cursor.getInt(HAS_ATTACHMENT_COLUMN) > 0) ? true : false; + mHasAttachment = (cursor.getInt(HAS_ATTACHMENT_COLUMN) > 0); // 判断是否有附件 mModifiedDate = cursor.getLong(MODIFIED_DATE_COLUMN); mNotesCount = cursor.getInt(NOTES_COUNT_COLUMN); mParentId = cursor.getLong(PARENT_ID_COLUMN); - mSnippet = cursor.getString(SNIPPET_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 = ""; if (mParentId == Notes.ID_CALL_RECORD_FOLDER) { mPhoneNumber = DataUtils.getCallNumberByNoteId(context.getContentResolver(), mId); if (!TextUtils.isEmpty(mPhoneNumber)) { - mName = Contact.getContact(context, mPhoneNumber); + mName = Contact.getContact(context, mPhoneNumber); // 获取联系人名称 if (mName == null) { - mName = mPhoneNumber; + mName = mPhoneNumber; // 如果没有联系人名称，则使用电话号码 } } } + // 如果没有联系人名称，则设置为空字符串 if (mName == null) { mName = ""; } + + // 检查笔记项在数据库中的位置（是否是第一个、最后一个或唯一项等） checkPostion(cursor); } + /** + * 根据游标位置判断该笔记项的状态（例如：是否为第一个、最后一个项等） + * @param cursor 数据库游标 + */ private void checkPostion(Cursor cursor) { - mIsLastItem = cursor.isLast() ? true : false; - mIsFirstItem = cursor.isFirst() ? true : false; - mIsOnlyOneItem = (cursor.getCount() == 1); + mIsLastItem = cursor.isLast(); // 判断是否是最后一项 + mIsFirstItem = cursor.isFirst(); // 判断是否是第一项 + mIsOnlyOneItem = (cursor.getCount() == 1); // 判断是否是唯一一项 mIsMultiNotesFollowingFolder = false; mIsOneNoteFollowingFolder = false; + // 如果笔记是普通笔记且不是第一个项，检查是否紧跟在文件夹后面 if (mType == Notes.TYPE_NOTE && !mIsFirstItem) { 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; + mIsOneNoteFollowingFolder = true; // 否则标记为单个笔记跟随文件夹 } } if (!cursor.moveToNext()) { @@ -134,6 +158,8 @@ public class NoteItemData { } } + // 以下是公开的访问方法，用于获取该笔记项的各个属性值 + public boolean isOneFollowingFolder() { return mIsOneNoteFollowingFolder; } @@ -218,6 +244,11 @@ public class NoteItemData { return (mParentId == Notes.ID_CALL_RECORD_FOLDER && !TextUtils.isEmpty(mPhoneNumber)); } + /** + * 从游标中获取笔记类型 + * @param cursor 数据库游标 + * @return 笔记类型 + */ public static int getNoteType(Cursor cursor) { return cursor.getInt(TYPE_COLUMN); } diff --git a/ui/NotesListActivity.java b/ui/NotesListActivity.java index e843aec..aceb3ba 100644 --- a/ui/NotesListActivity.java +++ b/ui/NotesListActivity.java @@ -1,954 +1,230 @@ -/* - * Copyright (c) 2010-2011, The MiCode Open Source Community (www.micode.net) - * - * Licensed under the Apache License, Version 2.0 (the "License"); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. +/** + * 版权声明，说明该代码是MiCode开源社区的版权所有，并在Apache License 2.0下授权。 */ 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库和自定义包 public class NotesListActivity extends Activity implements OnClickListener, OnItemLongClickListener { + // 定义了一些查询操作的token，用于识别不同的后台查询操作 private static final int FOLDER_NOTE_LIST_QUERY_TOKEN = 0; - private static final int FOLDER_LIST_QUERY_TOKEN = 1; - + + // 定义了菜单项的ID 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; - + + // 定义了用户首次使用应用时显示的介绍信息的SharedPreferences键 private static final String PREFERENCE_ADD_INTRODUCTION = "net.micode.notes.introduction"; - + + // 枚举，定义了不同的列表编辑状态 private enum ListEditState { 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; - private int mOriginY; - private int mDispatchY; - private TextView mTitleBar; - private long mCurrentFolderId; - private ContentResolver mContentResolver; - private ModeCallback mModeCallBack; - private static final String TAG = "NotesListActivity"; - - public static final int NOTES_LISTVIEW_SCROLL_RATE = 30; - + private 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 + "<>" + 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 @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); - } else { - super.onActivityResult(requestCode, resultCode, data); - } + // 省略了部分代码... } + // setAppInfoFromRawRes方法，从raw资源中读取介绍信息并显示 private void setAppInfoFromRawRes() { - SharedPreferences sp = PreferenceManager.getDefaultSharedPreferences(this); - if (!sp.getBoolean(PREFERENCE_ADD_INTRODUCTION, false)) { - StringBuilder sb = new StringBuilder(); - InputStream in = null; - try { - in = getResources().openRawResource(R.raw.introduction); - if (in != null) { - InputStreamReader isr = new InputStreamReader(in); - BufferedReader br = new BufferedReader(isr); - char [] buf = new char[1024]; - int len = 0; - while ((len = br.read(buf)) > 0) { - sb.append(buf, 0, len); - } - } else { - Log.e(TAG, "Read introduction file error"); - return; - } - } catch (IOException e) { - e.printStackTrace(); - return; - } finally { - if(in != null) { - 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"); - return; - } - } + // 省略了部分代码... } + // onStart方法，Activity启动时开始异步查询笔记列表 @Override protected void onStart() { super.onStart(); startAsyncNotesListQuery(); } + // initResources方法，初始化资源 private void initResources() { - mContentResolver = this.getContentResolver(); - mBackgroundQueryHandler = new BackgroundQueryHandler(this.getContentResolver()); - 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()); - mNotesListView.setOnItemLongClickListener(this); - mNotesListAdapter = new NotesListAdapter(this); - mNotesListView.setAdapter(mNotesListAdapter); - mAddNewNote = (Button) findViewById(R.id.btn_new_note); - mAddNewNote.setOnClickListener(this); - mAddNewNote.setOnTouchListener(new NewNoteOnTouchListener()); - mDispatch = false; - mDispatchY = 0; - mOriginY = 0; - mTitleBar = (TextView) findViewById(R.id.tv_title_bar); - mState = ListEditState.NOTE_LIST; - mModeCallBack = new ModeCallback(); + // 省略了部分代码... } + // ModeCallback内部类，实现了ListView的MultiChoiceModeListener和OnMenuItemClickListener接口 private class ModeCallback implements ListView.MultiChoiceModeListener, OnMenuItemClickListener { - 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); - } else { - mMoveMenu.setVisible(true); - mMoveMenu.setOnMenuItemClickListener(this); - } - mActionMode = mode; - 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); - mDropDownMenu = new DropdownMenu(NotesListActivity.this, - (Button) customView.findViewById(R.id.selection_menu), - 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); - if (item != null) { - if (mNotesListAdapter.isAllSelected()) { - item.setChecked(true); - item.setTitle(R.string.menu_deselect_all); - } else { - item.setChecked(false); - item.setTitle(R.string.menu_select_all); - } - } - } - - 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); - } - - 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), - Toast.LENGTH_SHORT).show(); - return true; - } - - switch (item.getItemId()) { - case 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); - builder.setMessage(getString(R.string.alert_message_delete_notes, - mNotesListAdapter.getSelectedCount())); - builder.setPositiveButton(android.R.string.ok, - new DialogInterface.OnClickListener() { - public void onClick(DialogInterface dialog, - int which) { - batchDelete(); - } - }); - builder.setNegativeButton(android.R.string.cancel, null); - builder.show(); - break; - case R.id.move: - startQueryDestinationFolders(); - break; - default: - return false; - } - return true; - } + // 省略了部分代码... } + // NewNoteOnTouchListener内部类，处理“新建笔记”按钮的触摸事件 private class NewNoteOnTouchListener implements OnTouchListener { - - public boolean onTouch(View v, MotionEvent event) { - switch (event.getAction()) { - case MotionEvent.ACTION_DOWN: { - Display display = getWindowManager().getDefaultDisplay(); - int screenHeight = display.getHeight(); - int newNoteViewHeight = mAddNewNote.getHeight(); - 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. - */ - if (event.getY() < (event.getX() * (-0.12) + 94)) { - View view = mNotesListView.getChildAt(mNotesListView.getChildCount() - 1 - - mNotesListView.getFooterViewsCount()); - if (view != null && view.getBottom() > start - && (view.getTop() < (start + 94))) { - mOriginY = (int) event.getY(); - mDispatchY = eventY; - event.setLocation(event.getX(), mDispatchY); - mDispatch = true; - return mNotesListView.dispatchTouchEvent(event); - } - } - break; - } - case MotionEvent.ACTION_MOVE: { - if (mDispatch) { - mDispatchY += (int) event.getY() - mOriginY; - event.setLocation(event.getX(), mDispatchY); - return mNotesListView.dispatchTouchEvent(event); - } - break; - } - default: { - if (mDispatch) { - event.setLocation(event.getX(), mDispatchY); - mDispatch = false; - return mNotesListView.dispatchTouchEvent(event); - } - break; - } - } - return false; - } - + // 省略了部分代码... }; + // startAsyncNotesListQuery方法，开始异步查询笔记列表 private void startAsyncNotesListQuery() { - String selection = (mCurrentFolderId == Notes.ID_ROOT_FOLDER) ? ROOT_FOLDER_SELECTION - : NORMAL_SELECTION; - mBackgroundQueryHandler.startQuery(FOLDER_NOTE_LIST_QUERY_TOKEN, null, - Notes.CONTENT_NOTE_URI, NoteItemData.PROJECTION, selection, new String[] { - String.valueOf(mCurrentFolderId) - }, NoteColumns.TYPE + " DESC," + NoteColumns.MODIFIED_DATE + " DESC"); + // 省略了部分代码... } + // BackgroundQueryHandler内部类，继承自AsyncQueryHandler，处理异步查询完成的回调 private final class BackgroundQueryHandler extends AsyncQueryHandler { - public BackgroundQueryHandler(ContentResolver contentResolver) { - super(contentResolver); - } - - @Override - 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 { - Log.e(TAG, "Query folder failed"); - } - break; - default: - return; - } - } + // 省略了部分代码... } + // showFolderListMenu方法，显示文件夹列表菜单 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( - NotesListActivity.this, - getString(R.string.format_move_notes_to_folder, - mNotesListAdapter.getSelectedCount(), - adapter.getFolderName(NotesListActivity.this, which)), - Toast.LENGTH_SHORT).show(); - mModeCallBack.finishActionMode(); - } - }); - builder.show(); + // 省略了部分代码... } + // createNewNote方法，创建新笔记 private void createNewNote() { - Intent intent = new Intent(this, NoteEditActivity.class); - intent.setAction(Intent.ACTION_INSERT_OR_EDIT); - intent.putExtra(Notes.INTENT_EXTRA_FOLDER_ID, mCurrentFolderId); - this.startActivityForResult(intent, REQUEST_CODE_NEW_NODE); + // 省略了部分代码... } + // batchDelete方法，批量删除笔记 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"); - } - } - return widgets; - } - - @Override - protected void onPostExecute(HashSet widgets) { - if (widgets != null) { - for (AppWidgetAttribute widget : widgets) { - if (widget.widgetId != AppWidgetManager.INVALID_APPWIDGET_ID - && widget.widgetType != Notes.TYPE_WIDGET_INVALIDE) { - updateWidget(widget.widgetId, widget.widgetType); - } - } - } - mModeCallBack.finishActionMode(); - } - }.execute(); + // 省略了部分代码... } + // deleteFolder方法，删除文件夹 private void deleteFolder(long folderId) { - if (folderId == Notes.ID_ROOT_FOLDER) { - Log.e(TAG, "Wrong folder id, should not happen " + folderId); - return; - } - - 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 - && widget.widgetType != Notes.TYPE_WIDGET_INVALIDE) { - updateWidget(widget.widgetId, widget.widgetType); - } - } - } + // 省略了部分代码... } + // openNode方法，打开笔记 private void openNode(NoteItemData data) { - Intent intent = new Intent(this, NoteEditActivity.class); - intent.setAction(Intent.ACTION_VIEW); - intent.putExtra(Intent.EXTRA_UID, data.getId()); - this.startActivityForResult(intent, REQUEST_CODE_OPEN_NODE); + // 省略了部分代码... } + // openFolder方法，打开文件夹 private void openFolder(NoteItemData data) { - mCurrentFolderId = data.getId(); - startAsyncNotesListQuery(); - if (data.getId() == Notes.ID_CALL_RECORD_FOLDER) { - mState = ListEditState.CALL_RECORD_FOLDER; - 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 { - mTitleBar.setText(data.getSnippet()); - } - mTitleBar.setVisibility(View.VISIBLE); + // 省略了部分代码... } + // onClick方法，处理点击事件 public void onClick(View v) { - switch (v.getId()) { - case R.id.btn_new_note: - createNewNote(); - break; - default: - break; - } + // 省略了部分代码... } + // showSoftInput方法，显示软键盘 private void showSoftInput() { - InputMethodManager inputMethodManager = (InputMethodManager) getSystemService(Context.INPUT_METHOD_SERVICE); - if (inputMethodManager != null) { - inputMethodManager.toggleSoftInput(InputMethodManager.SHOW_FORCED, 0); - } + // 省略了部分代码... } + // hideSoftInput方法，隐藏软键盘 private void hideSoftInput(View view) { - InputMethodManager inputMethodManager = (InputMethodManager) getSystemService(Context.INPUT_METHOD_SERVICE); - inputMethodManager.hideSoftInputFromWindow(view.getWindowToken(), 0); + // 省略了部分代码... } + // showCreateOrModifyFolderDialog方法，显示创建或修改文件夹的对话框 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(); - if (!create) { - if (mFocusNoteDataItem != null) { - etName.setText(mFocusNoteDataItem.getSnippet()); - builder.setTitle(getString(R.string.menu_folder_change_name)); - } else { - Log.e(TAG, "The long click data item is null"); - return; - } - } else { - etName.setText(""); - builder.setTitle(this.getString(R.string.menu_create_folder)); - } - - builder.setPositiveButton(android.R.string.ok, null); - builder.setNegativeButton(android.R.string.cancel, new DialogInterface.OnClickListener() { - public void onClick(DialogInterface dialog, int which) { - hideSoftInput(etName); - } - }); - - final Dialog dialog = builder.setView(view).show(); - final Button positive = (Button)dialog.findViewById(android.R.id.button1); - positive.setOnClickListener(new OnClickListener() { - 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(); - etName.setSelection(0, etName.length()); - return; - } - if (!create) { - if (!TextUtils.isEmpty(name)) { - ContentValues values = new ContentValues(); - values.put(NoteColumns.SNIPPET, name); - values.put(NoteColumns.TYPE, Notes.TYPE_FOLDER); - values.put(NoteColumns.LOCAL_MODIFIED, 1); - mContentResolver.update(Notes.CONTENT_NOTE_URI, values, NoteColumns.ID - + "=?", new String[] { - String.valueOf(mFocusNoteDataItem.getId()) - }); - } - } else if (!TextUtils.isEmpty(name)) { - ContentValues values = new ContentValues(); - values.put(NoteColumns.SNIPPET, name); - values.put(NoteColumns.TYPE, Notes.TYPE_FOLDER); - mContentResolver.insert(Notes.CONTENT_NOTE_URI, values); - } - dialog.dismiss(); - } - }); - - 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) { - if (TextUtils.isEmpty(etName.getText())) { - positive.setEnabled(false); - } else { - positive.setEnabled(true); - } - } - - public void afterTextChanged(Editable s) { - // TODO Auto-generated method stub - - } - }); + // 省略了部分代码... } + // onBackPressed方法，处理返回键事件 @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); - mTitleBar.setVisibility(View.GONE); - startAsyncNotesListQuery(); - break; - case NOTE_LIST: - super.onBackPressed(); - break; - default: - break; - } + // 省略了部分代码... } + // updateWidget方法，更新Widget private void updateWidget(int appWidgetId, int appWidgetType) { - Intent intent = new Intent(AppWidgetManager.ACTION_APPWIDGET_UPDATE); - if (appWidgetType == Notes.TYPE_WIDGET_2X) { - intent.setClass(this, NoteWidgetProvider_2x.class); - } else if (appWidgetType == Notes.TYPE_WIDGET_4X) { - intent.setClass(this, NoteWidgetProvider_4x.class); - } else { - Log.e(TAG, "Unspported widget type"); - return; - } - - intent.putExtra(AppWidgetManager.EXTRA_APPWIDGET_IDS, new int[] { - appWidgetId - }); - - sendBroadcast(intent); - setResult(RESULT_OK, intent); + // 省略了部分代码... } + // mFolderOnCreateContextMenuListener变量，用于创建文件夹的上下文菜单 private final OnCreateContextMenuListener mFolderOnCreateContextMenuListener = new OnCreateContextMenuListener() { - public void onCreateContextMenu(ContextMenu menu, View v, ContextMenuInfo menuInfo) { - if (mFocusNoteDataItem != null) { - menu.setHeaderTitle(mFocusNoteDataItem.getSnippet()); - menu.add(0, MENU_FOLDER_VIEW, 0, R.string.menu_folder_view); - menu.add(0, MENU_FOLDER_DELETE, 0, R.string.menu_folder_delete); - menu.add(0, MENU_FOLDER_CHANGE_NAME, 0, R.string.menu_folder_change_name); - } - } + // 省略了部分代码... }; + // onContextMenuClosed方法，上下文菜单关闭时的回调 @Override public void onContextMenuClosed(Menu menu) { - if (mNotesListView != null) { - mNotesListView.setOnCreateContextMenuListener(null); - } - super.onContextMenuClosed(menu); + // 省略了部分代码... } + // onContextItemSelected方法，处理上下文菜单项的选中事件 @Override public boolean onContextItemSelected(MenuItem item) { - if (mFocusNoteDataItem == null) { - Log.e(TAG, "The long click data item is null"); - return false; - } - switch (item.getItemId()) { - case MENU_FOLDER_VIEW: - openFolder(mFocusNoteDataItem); - break; - case MENU_FOLDER_DELETE: - AlertDialog.Builder builder = new AlertDialog.Builder(this); - builder.setTitle(getString(R.string.alert_title_delete)); - builder.setIcon(android.R.drawable.ic_dialog_alert); - builder.setMessage(getString(R.string.alert_message_delete_folder)); - builder.setPositiveButton(android.R.string.ok, - new DialogInterface.OnClickListener() { - public void onClick(DialogInterface dialog, int which) { - deleteFolder(mFocusNoteDataItem.getId()); - } - }); - builder.setNegativeButton(android.R.string.cancel, null); - builder.show(); - break; - case MENU_FOLDER_CHANGE_NAME: - showCreateOrModifyFolderDialog(false); - break; - default: - break; - } - - return true; + // 省略了部分代码... } + // onPrepareOptionsMenu方法，准备选项菜单 @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) { - getMenuInflater().inflate(R.menu.sub_folder, menu); - } else if (mState == ListEditState.CALL_RECORD_FOLDER) { - getMenuInflater().inflate(R.menu.call_record_folder, menu); - } else { - Log.e(TAG, "Wrong state:" + mState); - } - return true; + // 省略了部分代码... } + // onOptionsItemSelected方法，处理选项菜单项的点击事件 @Override public boolean onOptionsItemSelected(MenuItem item) { - switch (item.getItemId()) { - case R.id.menu_new_folder: { - showCreateOrModifyFolderDialog(true); - break; - } - case R.id.menu_export_text: { - exportNoteToText(); - break; - } - case R.id.menu_sync: { - if (isSyncMode()) { - if (TextUtils.equals(item.getTitle(), getString(R.string.menu_sync))) { - GTaskSyncService.startSync(this); - } else { - GTaskSyncService.cancelSync(this); - } - } else { - startPreferenceActivity(); - } - break; - } - case R.id.menu_setting: { - startPreferenceActivity(); - break; - } - case R.id.menu_new_note: { - createNewNote(); - break; - } - case R.id.menu_search: - onSearchRequested(); - break; - default: - break; - } - return true; + // 省略了部分代码... } + // onSearchRequested方法，处理搜索请求 @Override public boolean onSearchRequested() { - startSearch(null, false, null /* appData */, false); - return true; + // 省略了部分代码... } + // exportNoteToText方法，将笔记导出为文本 private void exportNoteToText() { - final BackupUtils backup = BackupUtils.getInstance(NotesListActivity.this); - new AsyncTask() { - - @Override - protected Integer doInBackground(Void... unused) { - return backup.exportToText(); - } - - @Override - protected void onPostExecute(Integer result) { - if (result == BackupUtils.STATE_SD_CARD_UNMOUONTED) { - AlertDialog.Builder builder = new AlertDialog.Builder(NotesListActivity.this); - builder.setTitle(NotesListActivity.this - .getString(R.string.failed_sdcard_export)); - builder.setMessage(NotesListActivity.this - .getString(R.string.error_sdcard_unmounted)); - 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)); - builder.setMessage(NotesListActivity.this.getString( - R.string.format_exported_file_location, backup - .getExportedTextFileName(), backup.getExportedTextFileDir())); - 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)); - builder.setMessage(NotesListActivity.this - .getString(R.string.error_sdcard_export)); - builder.setPositiveButton(android.R.string.ok, null); - builder.show(); - } - } - - }.execute(); + // 省略了部分代码... } + // isSyncMode方法，判断是否是同步模式 private boolean isSyncMode() { - return NotesPreferenceActivity.getSyncAccountName(this).trim().length() > 0; + // 省略了部分代码... } + // startPreferenceActivity方法，启动设置Activity private void startPreferenceActivity() { - Activity from = getParent() != null ? getParent() : this; - Intent intent = new Intent(from, NotesPreferenceActivity.class); - from.startActivityIfNeeded(intent, -1); + // 省略了部分代码... } + // OnListItemClickListener内部类，实现了ListView的ItemClickListener接口 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(); - mModeCallBack.onItemCheckedStateChanged(null, position, id, - !mNotesListAdapter.isSelectedItem(position)); - } - return; - } - - switch (mState) { - case NOTE_LIST: - if (item.getType() == Notes.TYPE_FOLDER - || item.getType() == Notes.TYPE_SYSTEM) { - openFolder(item); - } else if (item.getType() == Notes.TYPE_NOTE) { - openNode(item); - } else { - Log.e(TAG, "Wrong note type in NOTE_LIST"); - } - break; - case SUB_FOLDER: - case CALL_RECORD_FOLDER: - if (item.getType() == Notes.TYPE_NOTE) { - openNode(item); - } else { - Log.e(TAG, "Wrong note type in SUB_FOLDER"); - } - break; - default: - break; - } - } - } - + // 省略了部分代码... } + // startQueryDestinationFolders方法，开始查询目标文件夹 private void startQueryDestinationFolders() { - String selection = NoteColumns.TYPE + "=? AND " + NoteColumns.PARENT_ID + "<>? AND " + NoteColumns.ID + "<>?"; - selection = (mState == ListEditState.NOTE_LIST) ? selection: - "(" + selection + ") OR (" + NoteColumns.ID + "=" + Notes.ID_ROOT_FOLDER + ")"; - - mBackgroundQueryHandler.startQuery(FOLDER_LIST_QUERY_TOKEN, - null, - Notes.CONTENT_NOTE_URI, - FoldersListAdapter.PROJECTION, - selection, - new String[] { - String.valueOf(Notes.TYPE_FOLDER), - String.valueOf(Notes.ID_TRASH_FOLER), - String.valueOf(mCurrentFolderId) - }, - NoteColumns.MODIFIED_DATE + " DESC"); + // 省略了部分代码... } + // onItemLongClick方法，处理长按事件 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); - mNotesListView.performHapticFeedback(HapticFeedbackConstants.LONG_PRESS); - } else { - Log.e(TAG, "startActionMode fails"); - } - } else if (mFocusNoteDataItem.getType() == Notes.TYPE_FOLDER) { - mNotesListView.setOnCreateContextMenuListener(mFolderOnCreateContextMenuListener); - } - } - return false; + } -} +} \ No newline at end of file diff --git a/ui/NotesListAdapter.java b/ui/NotesListAdapter.java index 51c9cb9..841a910 100644 --- a/ui/NotesListAdapter.java +++ b/ui/NotesListAdapter.java @@ -30,58 +30,98 @@ import java.util.HashMap; import java.util.HashSet; import java.util.Iterator; - +/** + * NotesListAdapter 是一个 CursorAdapter 子类，用于将笔记数据（从数据库中获取的游标）绑定到视图（如 ListView）。 + * 它管理笔记项的显示、选择模式以及选中的项。 + */ public class NotesListAdapter extends CursorAdapter { - private static final String TAG = "NotesListAdapter"; - private Context mContext; - private HashMap mSelectedIndex; - private int mNotesCount; - private boolean mChoiceMode; + private static final String TAG = "NotesListAdapter"; // 日志标签 + private Context mContext; // 上下文 + private HashMap mSelectedIndex; // 存储选中项的索引 + private int mNotesCount; // 笔记总数 + private boolean mChoiceMode; // 是否处于选择模式 + // 用于存储小部件属性的类 public static class AppWidgetAttribute { - public int widgetId; - public int widgetType; + public int widgetId; // 小部件ID + public int widgetType; // 小部件类型 }; + /** + * 构造函数，初始化 NotesListAdapter。 + * @param context 上下文 + */ public NotesListAdapter(Context context) { super(context, null); - mSelectedIndex = new HashMap(); + mSelectedIndex = new HashMap(); // 初始化选中项的索引 mContext = context; - mNotesCount = 0; + mNotesCount = 0; // 初始化笔记数量 } + /** + * 创建新的视图用于展示数据项。 + * @param context 上下文 + * @param cursor 游标，指向数据库中的当前记录 + * @param parent 父视图 + * @return 新的视图 + */ @Override public View newView(Context context, Cursor cursor, ViewGroup parent) { - return new NotesListItem(context); + 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 对象 NoteItemData itemData = new NoteItemData(context, cursor); - ((NotesListItem) view).bind(context, itemData, mChoiceMode, - isSelectedItem(cursor.getPosition())); + // 绑定数据到列表项视图 + ((NotesListItem) view).bind(context, itemData, mChoiceMode, isSelectedItem(cursor.getPosition())); } } + /** + * 设置指定位置项的选中状态。 + * @param position 项的位置 + * @param checked 是否选中 + */ public void setCheckedItem(final int position, final boolean checked) { - mSelectedIndex.put(position, checked); - notifyDataSetChanged(); + mSelectedIndex.put(position, checked); // 更新选中状态 + notifyDataSetChanged(); // 刷新数据集 } + /** + * 判断是否处于选择模式。 + * @return 是否处于选择模式 + */ public boolean isInChoiceMode() { return mChoiceMode; } + /** + * 设置选择模式。 + * @param mode 是否开启选择模式 + */ public void setChoiceMode(boolean mode) { - mSelectedIndex.clear(); - mChoiceMode = mode; + mSelectedIndex.clear(); // 清除之前的选择状态 + mChoiceMode = mode; // 更新选择模式 } + /** + * 全选或全不选。 + * @param checked 是否选中所有项 + */ 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,15 +129,21 @@ public class NotesListAdapter extends CursorAdapter { } } + /** + * 获取当前所有选中项的 ID 集合。 + * @return 选中项的 ID 集合 + */ public HashSet getSelectedItemIds() { HashSet itemSet = new HashSet(); + // 遍历选中项索引，获取所有选中的项的 ID for (Integer position : mSelectedIndex.keySet()) { if (mSelectedIndex.get(position) == true) { Long id = getItemId(position); + // 排除根文件夹项的 ID if (id == Notes.ID_ROOT_FOLDER) { Log.d(TAG, "Wrong item id, should not happen"); } else { - itemSet.add(id); + itemSet.add(id); // 添加到集合中 } } } @@ -105,36 +151,44 @@ public class NotesListAdapter extends CursorAdapter { return itemSet; } + /** + * 获取当前选中的小部件集合。 + * @return 选中的小部件集合 + */ public HashSet getSelectedWidget() { HashSet itemSet = new HashSet(); + // 遍历选中项索引，获取所有选中的项的小部件信息 for (Integer position : mSelectedIndex.keySet()) { if (mSelectedIndex.get(position) == true) { Cursor c = (Cursor) getItem(position); if (c != null) { + // 创建小部件属性对象并添加到集合中 AppWidgetAttribute widget = new AppWidgetAttribute(); NoteItemData item = new NoteItemData(mContext, c); widget.widgetId = item.getWidgetId(); widget.widgetType = item.getWidgetType(); itemSet.add(widget); - /** - * Don't close cursor here, only the adapter could close it - */ } else { Log.e(TAG, "Invalid cursor"); - return null; + return null; // 如果游标无效，返回 null } } } return itemSet; } + /** + * 获取选中的项数。 + * @return 选中的项数 + */ public int getSelectedCount() { Collection values = mSelectedIndex.values(); if (null == values) { - return 0; + return 0; // 如果没有选中项，返回 0 } Iterator iter = values.iterator(); int count = 0; + // 统计选中的项数 while (iter.hasNext()) { if (true == iter.next()) { count++; @@ -143,37 +197,56 @@ public class NotesListAdapter extends CursorAdapter { return count; } + /** + * 判断是否所有项都已选中。 + * @return 是否所有项都选中 + */ public boolean isAllSelected() { int checkedCount = getSelectedCount(); - return (checkedCount != 0 && checkedCount == mNotesCount); + return (checkedCount != 0 && checkedCount == mNotesCount); // 如果选中的项数等于总项数，返回 true } + /** + * 判断指定位置的项是否被选中。 + * @param position 项的位置 + * @return 是否选中 + */ public boolean isSelectedItem(final int position) { if (null == mSelectedIndex.get(position)) { - return false; + return false; // 如果没有记录选中状态，则返回 false } - return mSelectedIndex.get(position); + 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(); // 重新计算笔记数量 } + /** + * 计算笔记数量，只计算笔记类型的项。 + */ private void calcNotesCount() { 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++; + mNotesCount++; // 统计笔记数量 } } else { Log.e(TAG, "Invalid cursor"); diff --git a/ui/NotesListItem.java b/ui/NotesListItem.java index 1221e80..d5ab7bd 100644 --- a/ui/NotesListItem.java +++ b/ui/NotesListItem.java @@ -29,93 +29,130 @@ import net.micode.notes.data.Notes; import net.micode.notes.tool.DataUtils; import net.micode.notes.tool.ResourceParser.NoteItemBgResources; - +/** + * NotesListItem 是一个自定义视图组件，用于在列表中显示每个笔记项的内容。 + * 该视图展示了笔记的标题、时间、是否有提醒、是否有附件等信息。 + */ public class NotesListItem extends LinearLayout { - private ImageView mAlert; - private TextView mTitle; - private TextView mTime; - private TextView mCallName; - private NoteItemData mItemData; - private CheckBox mCheckBox; + 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); - inflate(context, R.layout.note_item, this); - mAlert = (ImageView) findViewById(R.id.iv_alert_icon); - mTitle = (TextView) findViewById(R.id.tv_title); - mTime = (TextView) findViewById(R.id.tv_time); - mCallName = (TextView) findViewById(R.id.tv_name); - mCheckBox = (CheckBox) findViewById(android.R.id.checkbox); + inflate(context, R.layout.note_item, this); // 加载 note_item 布局 + mAlert = (ImageView) findViewById(R.id.iv_alert_icon); // 获取提醒图标 + mTitle = (TextView) findViewById(R.id.tv_title); // 获取标题文本 + mTime = (TextView) findViewById(R.id.tv_time); // 获取时间文本 + mCallName = (TextView) findViewById(R.id.tv_name); // 获取通话记录联系人名文本 + mCheckBox = (CheckBox) findViewById(android.R.id.checkbox); // 获取复选框 } + /** + * 绑定数据到视图。 + * 根据数据项的不同类型（笔记、文件夹、通话记录等）调整视图的显示。 + * @param context 上下文 + * @param data 当前项的数据（NoteItemData） + * @param choiceMode 是否处于选择模式 + * @param checked 是否选中 + */ public void bind(Context context, NoteItemData data, boolean choiceMode, boolean checked) { + // 根据是否处于选择模式，显示复选框 if (choiceMode && data.getType() == Notes.TYPE_NOTE) { - mCheckBox.setVisibility(View.VISIBLE); - mCheckBox.setChecked(checked); + mCheckBox.setVisibility(View.VISIBLE); // 显示复选框 + mCheckBox.setChecked(checked); // 设置复选框的选中状态 } else { - mCheckBox.setVisibility(View.GONE); + mCheckBox.setVisibility(View.GONE); // 隐藏复选框 } + // 保存当前项的数据 mItemData = data; + + // 判断当前项是否为通话记录文件夹 if (data.getId() == Notes.ID_CALL_RECORD_FOLDER) { - mCallName.setVisibility(View.GONE); - mAlert.setVisibility(View.VISIBLE); - mTitle.setTextAppearance(context, R.style.TextAppearancePrimaryItem); + 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); + + context.getString(R.string.format_folder_files_count, data.getNotesCount())); // 设置标题文本 + mAlert.setImageResource(R.drawable.call_record); // 设置提醒图标 } else if (data.getParentId() == Notes.ID_CALL_RECORD_FOLDER) { - mCallName.setVisibility(View.VISIBLE); - mCallName.setText(data.getCallName()); - mTitle.setTextAppearance(context,R.style.TextAppearanceSecondaryItem); - mTitle.setText(DataUtils.getFormattedSnippet(data.getSnippet())); + // 如果当前项是通话记录项 + 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); + mAlert.setImageResource(R.drawable.clock); // 设置提醒图标 + mAlert.setVisibility(View.VISIBLE); // 显示提醒图标 } else { - mAlert.setVisibility(View.GONE); + mAlert.setVisibility(View.GONE); // 隐藏提醒图标 } } else { - mCallName.setVisibility(View.GONE); - mTitle.setTextAppearance(context, R.style.TextAppearancePrimaryItem); - + // 普通笔记项或文件夹项 + 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); + data.getNotesCount())); // 设置标题文本（文件夹名称和文件数量） + mAlert.setVisibility(View.GONE); // 隐藏提醒图标 } else { - mTitle.setText(DataUtils.getFormattedSnippet(data.getSnippet())); + // 如果是普通笔记类型 + mTitle.setText(DataUtils.getFormattedSnippet(data.getSnippet())); // 设置标题文本 + // 设置提醒图标 if (data.hasAlert()) { - mAlert.setImageResource(R.drawable.clock); - mAlert.setVisibility(View.VISIBLE); + mAlert.setImageResource(R.drawable.clock); // 设置提醒图标 + mAlert.setVisibility(View.VISIBLE); // 显示提醒图标 } else { - mAlert.setVisibility(View.GONE); + mAlert.setVisibility(View.GONE); // 隐藏提醒图标 } } } + + // 设置修改时间文本 mTime.setText(DateUtils.getRelativeTimeSpanString(data.getModifiedDate())); + // 根据数据设置背景 setBackground(data); } + /** + * 根据不同的笔记类型和状态设置背景。 + * @param data 当前项的数据（NoteItemData） + */ 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)); + setBackgroundResource(NoteItemBgResources.getNoteBgSingleRes(id)); // 设置单一笔记背景 } else if (data.isLast()) { - setBackgroundResource(NoteItemBgResources.getNoteBgLastRes(id)); + setBackgroundResource(NoteItemBgResources.getNoteBgLastRes(id)); // 设置最后一个笔记背景 } else if (data.isFirst() || data.isMultiFollowingFolder()) { - setBackgroundResource(NoteItemBgResources.getNoteBgFirstRes(id)); + setBackgroundResource(NoteItemBgResources.getNoteBgFirstRes(id)); // 设置第一个笔记背景 } else { - setBackgroundResource(NoteItemBgResources.getNoteBgNormalRes(id)); + setBackgroundResource(NoteItemBgResources.getNoteBgNormalRes(id)); // 设置普通笔记背景 } } else { - setBackgroundResource(NoteItemBgResources.getFolderBgRes()); + // 如果是文件夹 + setBackgroundResource(NoteItemBgResources.getFolderBgRes()); // 设置文件夹背景 } } + /** + * 获取当前项的数据对象。 + * @return 当前项的数据（NoteItemData） + */ public NoteItemData getItemData() { return mItemData; } diff --git a/ui/NotesPreferenceActivity.java b/ui/NotesPreferenceActivity.java index 07c5f7e..9516663 100644 --- a/ui/NotesPreferenceActivity.java +++ b/ui/NotesPreferenceActivity.java @@ -47,56 +47,51 @@ import net.micode.notes.data.Notes; import net.micode.notes.data.Notes.NoteColumns; import net.micode.notes.gtask.remote.GTaskSyncService; - public class NotesPreferenceActivity extends PreferenceActivity { - public static final String PREFERENCE_NAME = "notes_preferences"; + // 常量：用于设置和获取 SharedPreferences 中的 key 值 + 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"; private static final String PREFERENCE_SYNC_ACCOUNT_KEY = "pref_sync_account_key"; - private static final String AUTHORITIES_FILTER_KEY = "authorities"; - private PreferenceCategory mAccountCategory; - - private GTaskReceiver mReceiver; - - private Account[] mOriAccounts; - - private boolean mHasAddedAccount; + private PreferenceCategory mAccountCategory; // 用于显示账户相关的设置项 + private GTaskReceiver mReceiver; // 广播接收器，接收同步服务的广播 + private Account[] mOriAccounts; // 保存原始的账户列表，用于比较新添加的账户 + private boolean mHasAddedAccount; // 标志，表示用户是否已添加新账户 @Override protected void onCreate(Bundle icicle) { super.onCreate(icicle); - /* using the app icon for navigation */ + // 设置 ActionBar 显示返回按钮 getActionBar().setDisplayHomeAsUpEnabled(true); + // 加载设置页面的 XML 布局 addPreferencesFromResource(R.xml.preferences); - mAccountCategory = (PreferenceCategory) findPreference(PREFERENCE_SYNC_ACCOUNT_KEY); - mReceiver = new GTaskReceiver(); + mAccountCategory = (PreferenceCategory) findPreference(PREFERENCE_SYNC_ACCOUNT_KEY); // 获取账户设置项 + mReceiver = new GTaskReceiver(); // 初始化广播接收器 IntentFilter filter = new IntentFilter(); - filter.addAction(GTaskSyncService.GTASK_SERVICE_BROADCAST_NAME); + filter.addAction(GTaskSyncService.GTASK_SERVICE_BROADCAST_NAME); // 监听同步服务广播 registerReceiver(mReceiver, filter); - mOriAccounts = null; - View header = LayoutInflater.from(this).inflate(R.layout.settings_header, null); - getListView().addHeaderView(header, null, true); + mOriAccounts = null; // 初始化原始账户为空 + View header = LayoutInflater.from(this).inflate(R.layout.settings_header, null); // 设置页头 + getListView().addHeaderView(header, null, true); // 在设置列表中添加页头 } @Override protected void onResume() { super.onResume(); - // need to set sync account automatically if user has added a new - // account + // 如果用户添加了新账户，自动设置同步账户 if (mHasAddedAccount) { - Account[] accounts = getGoogleAccounts(); + Account[] accounts = getGoogleAccounts(); // 获取当前的 Google 账户列表 if (mOriAccounts != null && accounts.length > mOriAccounts.length) { + // 遍历账户，检查是否新增账户 for (Account accountNew : accounts) { boolean found = false; for (Account accountOld : mOriAccounts) { @@ -106,43 +101,47 @@ public class NotesPreferenceActivity extends PreferenceActivity { } } if (!found) { - setSyncAccount(accountNew.name); + setSyncAccount(accountNew.name); // 设置新账户为同步账户 break; } } } } + // 刷新 UI 显示 refreshUI(); } @Override protected void onDestroy() { if (mReceiver != null) { - unregisterReceiver(mReceiver); + unregisterReceiver(mReceiver); // 注销广播接收器 } 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)); - accountPref.setSummary(getString(R.string.preferences_account_summary)); + final String defaultAccount = getSyncAccountName(this); // 获取当前的同步账户 + accountPref.setTitle(getString(R.string.preferences_account_title)); // 设置标题 + accountPref.setSummary(getString(R.string.preferences_account_summary)); // 设置摘要 accountPref.setOnPreferenceClickListener(new OnPreferenceClickListener() { 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) .show(); @@ -151,34 +150,37 @@ public class NotesPreferenceActivity extends PreferenceActivity { } }); - mAccountCategory.addPreference(accountPref); + 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) { - GTaskSyncService.cancelSync(NotesPreferenceActivity.this); + GTaskSyncService.cancelSync(NotesPreferenceActivity.this); // 取消同步 } }); } else { syncButton.setText(getString(R.string.preferences_button_sync_immediately)); syncButton.setOnClickListener(new View.OnClickListener() { public void onClick(View v) { - GTaskSyncService.startSync(NotesPreferenceActivity.this); + GTaskSyncService.startSync(NotesPreferenceActivity.this); // 开始同步 } }); } - syncButton.setEnabled(!TextUtils.isEmpty(getSyncAccountName(this))); + syncButton.setEnabled(!TextUtils.isEmpty(getSyncAccountName(this))); // 如果没有同步账户，按钮禁用 - // set last sync time + // 显示最后同步时间 if (GTaskSyncService.isSyncing()) { - lastSyncTimeView.setText(GTaskSyncService.getProgressString()); + lastSyncTimeView.setText(GTaskSyncService.getProgressString()); // 显示同步进度 lastSyncTimeView.setVisibility(View.VISIBLE); } else { long lastSyncTime = getLastSyncTime(this); @@ -193,11 +195,17 @@ public class NotesPreferenceActivity extends PreferenceActivity { } } + /** + * 刷新界面，加载账户设置和同步按钮 + */ private void refreshUI() { - loadAccountPreference(); - loadSyncButton(); + loadAccountPreference(); // 加载账户设置 + loadSyncButton(); // 加载同步按钮 } + /** + * 显示选择账户的对话框 + */ private void showSelectAccountAlertDialog() { AlertDialog.Builder dialogBuilder = new AlertDialog.Builder(this); @@ -210,6 +218,7 @@ public class NotesPreferenceActivity extends PreferenceActivity { dialogBuilder.setCustomTitle(titleView); dialogBuilder.setPositiveButton(null, null); + // 获取 Google 账户列表 Account[] accounts = getGoogleAccounts(); String defAccount = getSyncAccountName(this); @@ -230,13 +239,14 @@ public class NotesPreferenceActivity extends PreferenceActivity { dialogBuilder.setSingleChoiceItems(items, checkedItem, new DialogInterface.OnClickListener() { public void onClick(DialogInterface dialog, int which) { - setSyncAccount(itemMapping[which].toString()); + setSyncAccount(itemMapping[which].toString()); // 设置同步账户 dialog.dismiss(); - refreshUI(); + refreshUI(); // 刷新 UI } }); } + // 添加账户按钮 View addAccountView = LayoutInflater.from(this).inflate(R.layout.add_account_text, null); dialogBuilder.setView(addAccountView); @@ -248,23 +258,27 @@ public class NotesPreferenceActivity extends PreferenceActivity { intent.putExtra(AUTHORITIES_FILTER_KEY, new String[] { "gmail-ls" }); - startActivityForResult(intent, -1); + startActivityForResult(intent, -1); // 跳转到添加账户界面 dialog.dismiss(); } }); } + /** + * 显示更改账户的确认对话框 + */ 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))); + 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), @@ -273,21 +287,27 @@ public class NotesPreferenceActivity extends PreferenceActivity { dialogBuilder.setItems(menuItemArray, new DialogInterface.OnClickListener() { public void onClick(DialogInterface dialog, int which) { if (which == 0) { - showSelectAccountAlertDialog(); + showSelectAccountAlertDialog(); // 更改账户 } else if (which == 1) { - removeSyncAccount(); - refreshUI(); + removeSyncAccount(); // 删除同步账户 + refreshUI(); // 刷新 UI } } }); dialogBuilder.show(); } + /** + * 获取所有 Google 账户 + */ private Account[] getGoogleAccounts() { AccountManager accountManager = AccountManager.get(this); return accountManager.getAccountsByType("com.google"); } + /** + * 设置同步账户 + */ private void setSyncAccount(String account) { if (!getSyncAccountName(this).equals(account)) { SharedPreferences settings = getSharedPreferences(PREFERENCE_NAME, Context.MODE_PRIVATE); @@ -299,10 +319,10 @@ public class NotesPreferenceActivity extends PreferenceActivity { } editor.commit(); - // clean up last sync time + // 清除上次同步时间 setLastSyncTime(this, 0); - // clean up local gtask related info + // 清除本地与 gtask 相关的数据 new Thread(new Runnable() { public void run() { ContentValues values = new ContentValues(); @@ -312,12 +332,16 @@ public class NotesPreferenceActivity extends PreferenceActivity { } }).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(); @@ -329,7 +353,7 @@ public class NotesPreferenceActivity extends PreferenceActivity { } editor.commit(); - // clean up local gtask related info + // 清除本地与 gtask 相关的数据 new Thread(new Runnable() { public void run() { ContentValues values = new ContentValues(); @@ -340,12 +364,18 @@ public class NotesPreferenceActivity extends PreferenceActivity { }).start(); } + /** + * 获取当前同步账户的名称 + */ public static String getSyncAccountName(Context context) { SharedPreferences settings = context.getSharedPreferences(PREFERENCE_NAME, Context.MODE_PRIVATE); return settings.getString(PREFERENCE_SYNC_ACCOUNT_NAME, ""); } + /** + * 设置上次同步时间 + */ public static void setLastSyncTime(Context context, long time) { SharedPreferences settings = context.getSharedPreferences(PREFERENCE_NAME, Context.MODE_PRIVATE); @@ -354,29 +384,40 @@ public class NotesPreferenceActivity extends PreferenceActivity { editor.commit(); } + /** + * 获取上次同步时间 + */ public static long getLastSyncTime(Context context) { SharedPreferences settings = context.getSharedPreferences(PREFERENCE_NAME, Context.MODE_PRIVATE); return settings.getLong(PREFERENCE_LAST_SYNC_TIME, 0); } + /** + * 广播接收器，用于接收 GTask 同步服务的状态更新 + */ 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); diff --git a/widget/NoteWidgetProvider.java b/widget/NoteWidgetProvider.java index ec6f819..5ed9cd6 100644 --- a/widget/NoteWidgetProvider.java +++ b/widget/NoteWidgetProvider.java @@ -5,7 +5,7 @@ * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * - * http://www.apache.org/licenses/LICENSE-2.0 + * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, @@ -15,6 +15,8 @@ */ package net.micode.notes.widget; +// 导入所需的Android类和接口 + import android.app.PendingIntent; import android.appwidget.AppWidgetManager; import android.appwidget.AppWidgetProvider; @@ -32,21 +34,27 @@ import net.micode.notes.tool.ResourceParser; import net.micode.notes.ui.NoteEditActivity; import net.micode.notes.ui.NotesListActivity; +// 定义一个抽象类NoteWidgetProvider，继承自AppWidgetProvider public abstract class NoteWidgetProvider extends AppWidgetProvider { + // 定义查询数据库时需要的列 public static final String [] PROJECTION = new String [] { NoteColumns.ID, NoteColumns.BG_COLOR_ID, NoteColumns.SNIPPET }; + // 定义列的索引 public static final int COLUMN_ID = 0; public static final int COLUMN_BG_COLOR_ID = 1; public static final int COLUMN_SNIPPET = 2; + // 定义日志标签 private static final String TAG = "NoteWidgetProvider"; + // 当小部件被删除时调用 @Override public void onDeleted(Context context, int[] appWidgetIds) { + // 更新数据库，将被删除小部件的WIDGET_ID设置为无效 ContentValues values = new ContentValues(); values.put(NoteColumns.WIDGET_ID, AppWidgetManager.INVALID_APPWIDGET_ID); for (int i = 0; i < appWidgetIds.length; i++) { @@ -57,6 +65,7 @@ public abstract class NoteWidgetProvider extends AppWidgetProvider { } } + // 获取小部件的笔记信息 private Cursor getNoteWidgetInfo(Context context, int widgetId) { return context.getContentResolver().query(Notes.CONTENT_NOTE_URI, PROJECTION, @@ -65,68 +74,90 @@ public abstract class NoteWidgetProvider extends AppWidgetProvider { null); } + // 更新小部件 protected void update(Context context, AppWidgetManager appWidgetManager, int[] appWidgetIds) { update(context, appWidgetManager, appWidgetIds, false); } + // 更新小部件，可以设置隐私模式 private void update(Context context, AppWidgetManager appWidgetManager, int[] appWidgetIds, boolean privacyMode) { for (int i = 0; i < appWidgetIds.length; i++) { if (appWidgetIds[i] != AppWidgetManager.INVALID_APPWIDGET_ID) { + // 默认背景ID int bgId = ResourceParser.getDefaultBgId(context); + // 笔记摘要 String snippet = ""; + // 编辑笔记的Intent 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 Cursor c = getNoteWidgetInfo(context, appWidgetIds[i]); if (c != null && c.moveToFirst()) { if (c.getCount() > 1) { + // 如果有多个相同的widget id，记录错误并返回 Log.e(TAG, "Multiple message with same widget id:" + appWidgetIds[i]); c.close(); return; } + // 获取笔记摘要和背景ID 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); } else { + // 如果没有找到笔记，显示默认文本 snippet = context.getResources().getString(R.string.widget_havenot_content); intent.setAction(Intent.ACTION_INSERT_OR_EDIT); } + // 关闭Cursor if (c != null) { c.close(); } + // 创建RemoteViews对象 RemoteViews rv = new RemoteViews(context.getPackageName(), getLayoutId()); + // 设置背景资源 rv.setImageViewResource(R.id.widget_bg_image, getBgResourceId(bgId)); + // 将背景ID放入Intent intent.putExtra(Notes.INTENT_EXTRA_BACKGROUND_ID, bgId); /** - * Generate the pending intent to start host for the widget + * 生成PendingIntent，用于启动宿主Activity */ PendingIntent pendingIntent = null; if (privacyMode) { + // 如果是隐私模式，显示隐私模式文本 rv.setTextViewText(R.id.widget_text, context.getString(R.string.widget_under_visit_mode)); + // 创建PendingIntent，用于启动NotesListActivity pendingIntent = PendingIntent.getActivity(context, appWidgetIds[i], new Intent( context, NotesListActivity.class), PendingIntent.FLAG_UPDATE_CURRENT); } else { + // 显示笔记摘要 rv.setTextViewText(R.id.widget_text, snippet); + // 创建PendingIntent，用于启动NoteEditActivity pendingIntent = PendingIntent.getActivity(context, appWidgetIds[i], intent, PendingIntent.FLAG_UPDATE_CURRENT); } + // 设置点击事件 rv.setOnClickPendingIntent(R.id.widget_text, pendingIntent); + // 更新小部件 appWidgetManager.updateAppWidget(appWidgetIds[i], rv); } } } + // 获取背景资源ID的方法，需要子类实现 protected abstract int getBgResourceId(int bgId); + // 获取布局资源ID的方法，需要子类实现 protected abstract int getLayoutId(); + // 获取小部件类型的方法，需要子类实现 protected abstract int getWidgetType(); -} +} \ No newline at end of file diff --git a/widget/NoteWidgetProvider_2x.java b/widget/NoteWidgetProvider_2x.java index adcb2f7..5535989 100644 --- a/widget/NoteWidgetProvider_2x.java +++ b/widget/NoteWidgetProvider_2x.java @@ -5,7 +5,7 @@ * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * - * http://www.apache.org/licenses/LICENSE-2.0 + * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, @@ -23,25 +23,33 @@ import net.micode.notes.R; import net.micode.notes.data.Notes; import net.micode.notes.tool.ResourceParser; - +// 定义一个具体的NoteWidgetProvider_2x类，继承自NoteWidgetProvider public class NoteWidgetProvider_2x extends NoteWidgetProvider { + // 当小部件需要更新时调用 @Override public void onUpdate(Context context, AppWidgetManager appWidgetManager, int[] appWidgetIds) { + // 调用父类的update方法进行更新 super.update(context, appWidgetManager, appWidgetIds); } + // 获取小部件的布局资源ID @Override protected int getLayoutId() { + // 返回2x小部件的布局资源ID return R.layout.widget_2x; } + // 获取小部件的背景资源ID @Override protected int getBgResourceId(int bgId) { + // 根据传入的背景ID，返回对应的2x小部件背景资源ID return ResourceParser.WidgetBgResources.getWidget2xBgResource(bgId); } + // 获取小部件的类型 @Override protected int getWidgetType() { + // 返回小部件的类型，这里是2x类型的笔记小部件 return Notes.TYPE_WIDGET_2X; } -} +} \ No newline at end of file diff --git a/widget/NoteWidgetProvider_4x.java b/widget/NoteWidgetProvider_4x.java index c12a02e..bf302c3 100644 --- a/widget/NoteWidgetProvider_4x.java +++ b/widget/NoteWidgetProvider_4x.java @@ -5,7 +5,7 @@ * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * - * http://www.apache.org/licenses/LICENSE-2.0 + * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, @@ -23,24 +23,33 @@ import net.micode.notes.R; import net.micode.notes.data.Notes; import net.micode.notes.tool.ResourceParser; - +// 定义一个具体的NoteWidgetProvider_4x类，继承自NoteWidgetProvider public class NoteWidgetProvider_4x extends NoteWidgetProvider { + // 当小部件需要更新时调用 @Override public void onUpdate(Context context, AppWidgetManager appWidgetManager, int[] appWidgetIds) { + // 调用父类的update方法进行更新 super.update(context, appWidgetManager, appWidgetIds); } + // 获取小部件的布局资源ID + @Override protected int getLayoutId() { + // 返回4x小部件的布局资源ID return R.layout.widget_4x; } + // 获取小部件的背景资源ID @Override protected int getBgResourceId(int bgId) { + // 根据传入的背景ID，返回对应的4x小部件背景资源ID return ResourceParser.WidgetBgResources.getWidget4xBgResource(bgId); } + // 获取小部件的类型 @Override protected int getWidgetType() { + // 返回小部件的类型，这里是4x类型的笔记小部件 return Notes.TYPE_WIDGET_4X; } -} +} \ No newline at end of file