diff --git a/doc/小米便签开源代码的泛读报告.docx b/doc/小米便签开源代码的泛读报告.docx new file mode 100644 index 0000000..dfd1e4c Binary files /dev/null and b/doc/小米便签开源代码的泛读报告.docx differ diff --git a/doc/模块注释负责人.txt b/doc/模块注释负责人.txt new file mode 100644 index 0000000..d5fa52a --- /dev/null +++ b/doc/模块注释负责人.txt @@ -0,0 +1,6 @@ +成员 负责模块 +郭德宁 data and model +高源 ui +陈鹤林 gtask +段逸群 tool and widget + diff --git a/model/新增功能uml图.vsdx b/model/新增功能uml图.vsdx new file mode 100644 index 0000000..e957016 Binary files /dev/null and b/model/新增功能uml图.vsdx differ diff --git a/model/新建 Microsoft Visio Drawing.vsdx b/model/新建 Microsoft Visio Drawing.vsdx deleted file mode 100644 index e69de29..0000000 diff --git a/other/新建 Microsoft Publisher Document.pub b/other/新建 Microsoft Publisher Document.pub new file mode 100644 index 0000000..56b6e97 Binary files /dev/null and b/other/新建 Microsoft Publisher Document.pub differ diff --git a/other/新建 Microsoft Word 文档.docx b/other/新建 Microsoft Word 文档.docx deleted file mode 100644 index e69de29..0000000 diff --git a/src/data/Contact.java b/src/data/Contact.java index 94b6b45..e49331c 100644 --- a/src/data/Contact.java +++ b/src/data/Contact.java @@ -25,61 +25,50 @@ import android.util.Log; import java.util.HashMap; -<<<<<<< HEAD -<<<<<<< HEAD:app/src/main/java/net/micode/notes/data/Contact.java -public class Contact { - private static HashMap sContactCache;//建立哈希表 - private static final String TAG = "Contact";//设置TAG值为'联系' -======= -public class Contact {//连接类 - private static HashMap sContactCache;//建立哈希表 - private static final String TAG = "Contact";//设置TAG的值为'连接' ->>>>>>> 0444a65d4e44c509f57ad301a5a2b59200d62177:src/data/Contact.java -======= -public class Contact { //连接类 - private static HashMap sContactCache; //定义连接哈希表 - private static final String TAG = "Contact"; //设置TAG的值为'连接' ->>>>>>> b12b9a8449498593360310c554053628b31cc8c9 +public class Contact { // 定义连接类 + private static HashMap sContactCache; // 定义连接哈希表 + private static final String TAG = "Contact"; // 设置TAG的值为'连接' private static final String CALLER_ID_SELECTION = "PHONE_NUMBERS_EQUAL(" + Phone.NUMBER - + ",?) AND " + Data.MIMETYPE + "='" + Phone.CONTENT_ITEM_TYPE + "'" - + " AND " + Data.RAW_CONTACT_ID + " IN " + + ",?) AND " + Data.MIMETYPE + "='" + Phone.CONTENT_ITEM_TYPE + "'" + + " AND " + Data.RAW_CONTACT_ID + " IN " + "(SELECT raw_contact_id " + " FROM phone_lookup" - + " WHERE min_match = '+')"; //SQL语句 + + " WHERE min_match = '+')"; // SQL语句 - public static String getContact(Context context, String phoneNumber) { //获取连接 - if(sContactCache == null) { - sContactCache = new HashMap(); //连接哈希表为空时创建连接哈希表 + public static String getContact(Context context, String phoneNumber) { // 获取连接 + if (sContactCache == null) { + sContactCache = new HashMap(); // 连接哈希表为空时创建连接哈希表 } - if(sContactCache.containsKey(phoneNumber)) { - return sContactCache.get(phoneNumber); //连接哈希表存在电话号码时获取值 + 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, //通话记录uri - new String [] { Phone.DISPLAY_NAME }, + PhoneNumberUtils.toCallerIDMinMatch(phoneNumber)); // 将电话号码进行函数处理并代替'+'符号 + + Cursor cursor = context.getContentResolver().query( // 用于查询的结果集 + Data.CONTENT_URI, // 通话记录uri + 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); //缓存电话号码与联系人名字 + try { // 有结果时 + String name = cursor.getString(0); // 获取联系人名字 + sContactCache.put(phoneNumber, name); // 缓存电话号码与联系人名字 return name; } catch (IndexOutOfBoundsException e) { - Log.e(TAG, " Cursor get string error " + e.toString()); //日志记录信息 + Log.e(TAG, " Cursor get string error " + e.toString()); // 日志记录信息 return null; } finally { - cursor.close(); //关闭结果集 + cursor.close(); // 关闭结果集 } } else { - Log.d(TAG, "No contact matched with number:" + phoneNumber); //日志记录信息 - return null; //没找到，返回NULL + Log.d(TAG, "No contact matched with number:" + phoneNumber); // 日志记录信息 + return null; // 没找到，返回NULL } } } diff --git a/src/data/Notes.java b/src/data/Notes.java index 922c017..c99c394 100644 --- a/src/data/Notes.java +++ b/src/data/Notes.java @@ -17,263 +17,345 @@ package net.micode.notes.data; import android.net.Uri; -public class Notes { //定义类，为模块的其他类提供变量定义 - public static final String AUTHORITY = "micode_notes"; //设置AUTHORITY - public static final String TAG = "Notes"; //设置TAG - 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 - */ - 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; - - 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"; - public static final String INTENT_EXTRA_WIDGET_TYPE = "net.micode.notes.widget_type"; - 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; - - public static class DataConstants { //获取记录 - public static final String NOTE = TextNote.CONTENT_ITEM_TYPE; - public static final String CALL_NOTE = CallNote.CONTENT_ITEM_TYPE; - } - - /** - * Uri to query all notes and folders - */ - public static final Uri CONTENT_NOTE_URI = Uri.parse("content://" + AUTHORITY + "/note");//查询所有笔记与文件的uri - - /** - * Uri to query data - */ - public static final Uri CONTENT_DATA_URI = Uri.parse("content://" + AUTHORITY + "/data");//查询数据的uri - - 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)

- */ - public static final String PARENT_ID = "parent_id"; //父文件夹的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)

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

Type: INTEGER (long)

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

Type: INTEGER (long)

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

Type: INTEGER

- */ - 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)

- */ - public static final String SYNC_ID = "sync_id"; //最后一次同步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

- */ - public static final String ORIGIN_PARENT_ID = "origin_parent_id"; //移动文件时文件的前父类文件夹 - - /** - * The gtask id - *

Type : TEXT

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

Type : INTEGER (long)

- */ - public static final String VERSION = "version"; //版本名称 - } - - 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

- */ - public static final String MIME_TYPE = "mime_type"; +public class Notes { // 定义类，给模块的其他类提供变量定义 + public static final String AUTHORITY = "micode_notes"; // 设置AUTHORITY + public static final String TAG = "Notes"; // 设置TAG + public static final int TYPE_NOTE = 0; + public static final int TYPE_FOLDER = 1; + public static final int TYPE_SYSTEM = 2; /** - * The reference id to note that this data belongs to - *

Type: INTEGER (long)

+ * 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 */ - public static final String NOTE_ID = "note_id"; //便签名称 + 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; - /** - * Created data for note or folder - *

Type: INTEGER (long)

- */ - public static final String CREATED_DATE = "created_date"; //创建文件夹或者便签的名称 + 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"; + public static final String INTENT_EXTRA_WIDGET_TYPE = "net.micode.notes.widget_type"; + 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"; - /** - * 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"; //便签内容数据 + public static final String INTENT_EXTRA_LOCK = "net.micode.notes.lock";// 设置锁 + public static final int TYPE_WIDGET_INVALIDE = -1; + public static final int TYPE_WIDGET_2X = 0; + public static final int TYPE_WIDGET_4X = 1; - /** - * Generic data column, the meaning is {@link #MIMETYPE} specific, used for - * integer data type - *

Type: INTEGER

- */ - public static final String DATA1 = "data1"; //不同类型的通用数据列，用于可能的存储与查找 + public static class DataConstants { // 获取记录 + public static final String NOTE = TextNote.CONTENT_ITEM_TYPE; // 获取便签 + public static final String CALL_NOTE = CallNote.CONTENT_ITEM_TYPE; // 获取通话记录 + } /** - * Generic data column, the meaning is {@link #MIMETYPE} specific, used for - * integer data type - *

Type: INTEGER

+ * Uri to query all notes and folders */ - public static final String DATA2 = "data2"; + public static final Uri CONTENT_NOTE_URI = Uri.parse("content://" + AUTHORITY + "/note");// 查询所有笔记与文件的uri /** - * Generic data column, the meaning is {@link #MIMETYPE} specific, used for - * TEXT data type - *

Type: TEXT

+ * Uri to query data */ - 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"; - } - - 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; //列表检查模式 - - public static final String CONTENT_TYPE = "vnd.android.cursor.dir/text_note"; - - public static final String CONTENT_ITEM_TYPE = "vnd.android.cursor.item/text_note"; - - public static final Uri CONTENT_URI = Uri.parse("content://" + AUTHORITY + "/text_note");//访问数据表uri - } - - 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; //呼叫号码 - - public static final String CONTENT_TYPE = "vnd.android.cursor.dir/call_note"; - - public static final String CONTENT_ITEM_TYPE = "vnd.android.cursor.item/call_note"; + public static final Uri CONTENT_DATA_URI = Uri.parse("content://" + AUTHORITY + "/data");// 查询数据的uri + + 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) + *

+ */ + public static final String PARENT_ID = "parent_id"; // 父文件夹的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) + *

+ */ + public static final String WIDGET_ID = "widget_id"; // 便签的widget的id + + /** + * Note's widget type + *

+ * Type: INTEGER (long) + *

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

+ * Type: INTEGER (long) + *

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

+ * Type: INTEGER + *

+ */ + 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) + *

+ */ + public static final String SYNC_ID = "sync_id"; // 最后一次同步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 + *

+ */ + public static final String ORIGIN_PARENT_ID = "origin_parent_id"; // 移动文件时文件的前父类文件夹 + + /** + * The gtask id + *

+ * Type : TEXT + *

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

+ * Type : INTEGER (long) + *

+ */ + public static final String VERSION = "version"; // 版本名称 + + /* + * The lock status + *

+ * Type : INTEGER (long) + *

+ */ + public static final String LOCKED = "locked"; // 锁定状态 **** + + /* + * The picture + *

+ * Type : BLOB + *

+ */ + public static final String PICTURE = "picture"; // 图片**** + + } + + 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 + *

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

+ * Type: INTEGER (long) + *

+ */ + 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"; + } + + 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; // 列表检查模式 + + public static final String CONTENT_TYPE = "vnd.android.cursor.dir/text_note";// 访问数据表类型, + + public static final String CONTENT_ITEM_TYPE = "vnd.android.cursor.item/text_note";// 访问数据表类型 + + public static final Uri CONTENT_URI = Uri.parse("content://" + AUTHORITY + "/text_note");// 访问数据表uri + } + + public static final class CallNote implements DataColumns { // 定义电话记录数据列, implements是实现接口 + /** + * 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; // 呼叫号码 + + public static final String CONTENT_TYPE = "vnd.android.cursor.dir/call_note";// 访问电话记录类型 + + public static final String CONTENT_ITEM_TYPE = "vnd.android.cursor.item/call_note";// 访问电话记录类型 + + public static final Uri CONTENT_URI = Uri.parse("content://" + AUTHORITY + "/call_note");// 访问电话记录uri + } - public static final Uri CONTENT_URI = Uri.parse("content://" + AUTHORITY + "/call_note");//访问电话记录uri - } } diff --git a/src/data/NotesDatabaseHelper.java b/src/data/NotesDatabaseHelper.java index 57805ab..41c711f 100644 --- a/src/data/NotesDatabaseHelper.java +++ b/src/data/NotesDatabaseHelper.java @@ -26,198 +26,201 @@ import net.micode.notes.data.Notes.DataColumns; import net.micode.notes.data.Notes.DataConstants; import net.micode.notes.data.Notes.NoteColumns; - //引入Notes中接口 -public class NotesDatabaseHelper extends SQLiteOpenHelper { //该类为便签SQL表的定义以及操作，便于进行文件夹与便签的各种操作，例如添加或删除的行为 - private static final String DB_NAME = "note.db"; //数据库名称 +//引入Notes中接口 +public class NotesDatabaseHelper extends SQLiteOpenHelper { // 该类为便签SQL表的定义以及操作，易于进行文件夹与便签的各种操作，例如添加或删除的行为 + private static final String DB_NAME = "note.db"; // 数据库名称 - private static final int DB_VERSION = 4; //数据库版本 + private static final int DB_VERSION = 4; // 数据库版本 - public interface TABLE { //定义一个数据库表接口 - public static final String NOTE = "note"; //便签名 + public interface TABLE { // 定义一个数据库表接口 + public static final String NOTE = "note"; // 便签名 - public static final String DATA = "data"; //便签数据 + public static final String DATA = "data"; // 便签数据 } - private static final String TAG = "NotesDatabaseHelper"; //日志类型 - - private static NotesDatabaseHelper mInstance; //创建NotesDatabaseHelper类对象 - - private static final String CREATE_NOTE_TABLE_SQL = //SQL语句，创建便签表，包含ID、最后修改日期、背景颜色、便签数等在Notes类中的内容 - "CREATE TABLE " + TABLE.NOTE + "(" + - NoteColumns.ID + " INTEGER PRIMARY KEY," + - NoteColumns.PARENT_ID + " INTEGER NOT NULL DEFAULT 0," + - NoteColumns.ALERTED_DATE + " INTEGER NOT NULL DEFAULT 0," + - NoteColumns.BG_COLOR_ID + " INTEGER NOT NULL DEFAULT 0," + - NoteColumns.CREATED_DATE + " INTEGER NOT NULL DEFAULT (strftime('%s','now') * 1000)," + - NoteColumns.HAS_ATTACHMENT + " INTEGER NOT NULL DEFAULT 0," + - NoteColumns.MODIFIED_DATE + " INTEGER NOT NULL DEFAULT (strftime('%s','now') * 1000)," + - NoteColumns.NOTES_COUNT + " INTEGER NOT NULL DEFAULT 0," + - NoteColumns.SNIPPET + " TEXT NOT NULL DEFAULT ''," + - NoteColumns.TYPE + " INTEGER NOT NULL DEFAULT 0," + - NoteColumns.WIDGET_ID + " INTEGER NOT NULL DEFAULT 0," + - NoteColumns.WIDGET_TYPE + " INTEGER NOT NULL DEFAULT -1," + - NoteColumns.SYNC_ID + " INTEGER NOT NULL DEFAULT 0," + - NoteColumns.LOCAL_MODIFIED + " INTEGER NOT NULL DEFAULT 0," + - NoteColumns.ORIGIN_PARENT_ID + " INTEGER NOT NULL DEFAULT 0," + - NoteColumns.GTASK_ID + " TEXT NOT NULL DEFAULT ''," + - NoteColumns.VERSION + " INTEGER NOT NULL DEFAULT 0" + - ")"; - - private static final String CREATE_DATA_TABLE_SQL = //创建数据表的SQL语句 - "CREATE TABLE " + TABLE.DATA + "(" + - DataColumns.ID + " INTEGER PRIMARY KEY," + - DataColumns.MIME_TYPE + " TEXT NOT NULL," + - DataColumns.NOTE_ID + " INTEGER NOT NULL DEFAULT 0," + - NoteColumns.CREATED_DATE + " INTEGER NOT NULL DEFAULT (strftime('%s','now') * 1000)," + - NoteColumns.MODIFIED_DATE + " INTEGER NOT NULL DEFAULT (strftime('%s','now') * 1000)," + - DataColumns.CONTENT + " TEXT NOT NULL DEFAULT ''," + - DataColumns.DATA1 + " INTEGER," + - DataColumns.DATA2 + " INTEGER," + - DataColumns.DATA3 + " TEXT NOT NULL DEFAULT ''," + - DataColumns.DATA4 + " TEXT NOT NULL DEFAULT ''," + - DataColumns.DATA5 + " TEXT NOT NULL DEFAULT ''" + - ")"; - - private static final String CREATE_DATA_NOTE_ID_INDEX_SQL = - "CREATE INDEX IF NOT EXISTS note_id_index ON " + - TABLE.DATA + "(" + DataColumns.NOTE_ID + ");"; //创建查询操作表索引，用于查找 + private static final String TAG = "NotesDatabaseHelper"; // 日志类型 + + private static NotesDatabaseHelper mInstance; // 创建NotesDatabaseHelper类对象 + + private static final String CREATE_NOTE_TABLE_SQL = // SQL语句，创建便签表，包含ID、父ID、提醒日期、背景颜色ID、创建日期、是否有附件、修改日期、便签数、便签内容、便签类型、便签小部件ID、便签小部件类型、同步ID、本地修改时间、原始ID、便签的同步状态、版本号 + "CREATE TABLE " + TABLE.NOTE + "(" + + NoteColumns.ID + " INTEGER PRIMARY KEY," + + NoteColumns.PARENT_ID + " INTEGER NOT NULL DEFAULT 0," + + NoteColumns.ALERTED_DATE + " INTEGER NOT NULL DEFAULT 0," + + NoteColumns.BG_COLOR_ID + " INTEGER NOT NULL DEFAULT 0," + + NoteColumns.CREATED_DATE + " INTEGER NOT NULL DEFAULT (strftime('%s','now') * 1000)," + + NoteColumns.HAS_ATTACHMENT + " INTEGER NOT NULL DEFAULT 0," + + NoteColumns.MODIFIED_DATE + " INTEGER NOT NULL DEFAULT (strftime('%s','now') * 1000)," + + NoteColumns.NOTES_COUNT + " INTEGER NOT NULL DEFAULT 0," + + NoteColumns.SNIPPET + " TEXT NOT NULL DEFAULT ''," + + NoteColumns.TYPE + " INTEGER NOT NULL DEFAULT 0," + + NoteColumns.WIDGET_ID + " INTEGER NOT NULL DEFAULT 0," + + NoteColumns.WIDGET_TYPE + " INTEGER NOT NULL DEFAULT -1," + + NoteColumns.SYNC_ID + " INTEGER NOT NULL DEFAULT 0," + + NoteColumns.LOCAL_MODIFIED + " INTEGER NOT NULL DEFAULT 0," + + NoteColumns.ORIGIN_PARENT_ID + " INTEGER NOT NULL DEFAULT 0," + + NoteColumns.GTASK_ID + " TEXT NOT NULL DEFAULT ''," + + NoteColumns.VERSION + " INTEGER NOT NULL DEFAULT 0" + + + NoteColumns.LOCKED + " INTEGER NOT NULL DEFAULT 0" + + NoteColumns.PICTURE_URI + " TEXT NOT NULL DEFAULT ''," + + + ")"; + + private static final String CREATE_DATA_TABLE_SQL = // 创建数据表的SQL语句 + "CREATE TABLE " + TABLE.DATA + "(" + + DataColumns.ID + " INTEGER PRIMARY KEY," + + DataColumns.MIME_TYPE + " TEXT NOT NULL," + + DataColumns.NOTE_ID + " INTEGER NOT NULL DEFAULT 0," + + NoteColumns.CREATED_DATE + " INTEGER NOT NULL DEFAULT (strftime('%s','now') * 1000)," + + NoteColumns.MODIFIED_DATE + " INTEGER NOT NULL DEFAULT (strftime('%s','now') * 1000)," + + DataColumns.CONTENT + " TEXT NOT NULL DEFAULT ''," + + DataColumns.DATA1 + " INTEGER," + + DataColumns.DATA2 + " INTEGER," + + DataColumns.DATA3 + " TEXT NOT NULL DEFAULT ''," + + DataColumns.DATA4 + " TEXT NOT NULL DEFAULT ''," + + DataColumns.DATA5 + " TEXT NOT NULL DEFAULT ''" + + ")"; + + 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 "+ - " AFTER UPDATE OF " + NoteColumns.PARENT_ID + " ON " + TABLE.NOTE + - " BEGIN " + - " UPDATE " + TABLE.NOTE + - " SET " + NoteColumns.NOTES_COUNT + "=" + NoteColumns.NOTES_COUNT + " + 1" + - " WHERE " + NoteColumns.ID + "=new." + NoteColumns.PARENT_ID + ";" + - " END"; //创建触发器，方便进行操作，当移动便签时统计新的父文件夹内便签数量 + private static final String NOTE_INCREASE_FOLDER_COUNT_ON_UPDATE_TRIGGER = "CREATE TRIGGER increase_folder_count_on_update " + + + " AFTER UPDATE OF " + NoteColumns.PARENT_ID + " ON " + TABLE.NOTE + + " BEGIN " + + " UPDATE " + TABLE.NOTE + + " SET " + NoteColumns.NOTES_COUNT + "=" + NoteColumns.NOTES_COUNT + " + 1" + + " WHERE " + NoteColumns.ID + "=new." + NoteColumns.PARENT_ID + ";" + + " END"; // 创建触发器，方便进行操作，当移动便签时统计新的父文件夹内便签数量 /** * 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 " + - " AFTER UPDATE OF " + NoteColumns.PARENT_ID + " ON " + TABLE.NOTE + - " BEGIN " + - " UPDATE " + TABLE.NOTE + - " SET " + NoteColumns.NOTES_COUNT + "=" + NoteColumns.NOTES_COUNT + "-1" + - " WHERE " + NoteColumns.ID + "=old." + NoteColumns.PARENT_ID + - " AND " + NoteColumns.NOTES_COUNT + ">0" + ";" + - " END"; //与上一个方法作用相反，统计旧的父文件夹便签数量 + private static final String NOTE_DECREASE_FOLDER_COUNT_ON_UPDATE_TRIGGER = "CREATE TRIGGER decrease_folder_count_on_update " + + + " AFTER UPDATE OF " + NoteColumns.PARENT_ID + " ON " + TABLE.NOTE + + " BEGIN " + + " UPDATE " + TABLE.NOTE + + " SET " + NoteColumns.NOTES_COUNT + "=" + NoteColumns.NOTES_COUNT + "-1" + + " WHERE " + NoteColumns.ID + "=old." + NoteColumns.PARENT_ID + + " AND " + NoteColumns.NOTES_COUNT + ">0" + ";" + + " END"; // 与上一个方法作用相反，统计旧的父文件夹便签数量 /** * 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 " + - " AFTER INSERT ON " + TABLE.NOTE + - " BEGIN " + - " UPDATE " + TABLE.NOTE + - " SET " + NoteColumns.NOTES_COUNT + "=" + NoteColumns.NOTES_COUNT + " + 1" + - " WHERE " + NoteColumns.ID + "=new." + NoteColumns.PARENT_ID + ";" + - " END"; //创建便签时增加统计数量 + private static final String NOTE_INCREASE_FOLDER_COUNT_ON_INSERT_TRIGGER = "CREATE TRIGGER increase_folder_count_on_insert " + + + " AFTER INSERT ON " + TABLE.NOTE + + " BEGIN " + + " UPDATE " + TABLE.NOTE + + " SET " + NoteColumns.NOTES_COUNT + "=" + NoteColumns.NOTES_COUNT + " + 1" + + " WHERE " + NoteColumns.ID + "=new." + NoteColumns.PARENT_ID + ";" + + " END"; // 创建便签时增加统计数量 /** * 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 " + - " AFTER DELETE ON " + TABLE.NOTE + - " BEGIN " + - " UPDATE " + TABLE.NOTE + - " SET " + NoteColumns.NOTES_COUNT + "=" + NoteColumns.NOTES_COUNT + "-1" + - " WHERE " + NoteColumns.ID + "=old." + NoteColumns.PARENT_ID + - " AND " + NoteColumns.NOTES_COUNT + ">0;" + - " END"; //删除时减少数量 + private static final String NOTE_DECREASE_FOLDER_COUNT_ON_DELETE_TRIGGER = "CREATE TRIGGER decrease_folder_count_on_delete " + + + " AFTER DELETE ON " + TABLE.NOTE + + " BEGIN " + + " UPDATE " + TABLE.NOTE + + " SET " + NoteColumns.NOTES_COUNT + "=" + NoteColumns.NOTES_COUNT + "-1" + + " WHERE " + NoteColumns.ID + "=old." + NoteColumns.PARENT_ID + + " AND " + NoteColumns.NOTES_COUNT + ">0;" + + " END"; // 删除时减少数量 /** * Update note's content when insert data with type {@link DataConstants#NOTE} */ - private static final String DATA_UPDATE_NOTE_CONTENT_ON_INSERT_TRIGGER = - "CREATE TRIGGER update_note_content_on_insert " + - " AFTER INSERT ON " + TABLE.DATA + - " WHEN new." + DataColumns.MIME_TYPE + "='" + DataConstants.NOTE + "'" + - " BEGIN" + - " UPDATE " + TABLE.NOTE + - " SET " + NoteColumns.SNIPPET + "=new." + DataColumns.CONTENT + - " WHERE " + NoteColumns.ID + "=new." + DataColumns.NOTE_ID + ";" + - " END"; //更新便签数据时更改table表内容 + private static final String DATA_UPDATE_NOTE_CONTENT_ON_INSERT_TRIGGER = "CREATE TRIGGER update_note_content_on_insert " + + + " AFTER INSERT ON " + TABLE.DATA + + " WHEN new." + DataColumns.MIME_TYPE + "='" + DataConstants.NOTE + "'" + + " BEGIN" + + " UPDATE " + TABLE.NOTE + + " SET " + NoteColumns.SNIPPET + "=new." + DataColumns.CONTENT + + " WHERE " + NoteColumns.ID + "=new." + DataColumns.NOTE_ID + ";" + + " END"; // 更新便签数据时更改table表内容 /** - * Update note's content when data with {@link DataConstants#NOTE} type has changed + * Update note's content when data with {@link DataConstants#NOTE} type has + * changed */ - private static final String DATA_UPDATE_NOTE_CONTENT_ON_UPDATE_TRIGGER = - "CREATE TRIGGER update_note_content_on_update " + - " AFTER UPDATE ON " + TABLE.DATA + - " WHEN old." + DataColumns.MIME_TYPE + "='" + DataConstants.NOTE + "'" + - " BEGIN" + - " UPDATE " + TABLE.NOTE + - " SET " + NoteColumns.SNIPPET + "=new." + DataColumns.CONTENT + - " WHERE " + NoteColumns.ID + "=new." + DataColumns.NOTE_ID + ";" + - " END"; //改变便签数据时更改table表内容 + private static final String DATA_UPDATE_NOTE_CONTENT_ON_UPDATE_TRIGGER = "CREATE TRIGGER update_note_content_on_update " + + + " AFTER UPDATE ON " + TABLE.DATA + + " WHEN old." + DataColumns.MIME_TYPE + "='" + DataConstants.NOTE + "'" + + " BEGIN" + + " UPDATE " + TABLE.NOTE + + " SET " + NoteColumns.SNIPPET + "=new." + DataColumns.CONTENT + + " WHERE " + NoteColumns.ID + "=new." + DataColumns.NOTE_ID + ";" + + " END"; // 改变便签数据时更改table表内容 /** - * Update note's content when data with {@link DataConstants#NOTE} type has deleted + * Update note's content when data with {@link DataConstants#NOTE} type has + * deleted */ - private static final String DATA_UPDATE_NOTE_CONTENT_ON_DELETE_TRIGGER = - "CREATE TRIGGER update_note_content_on_delete " + - " AFTER delete ON " + TABLE.DATA + - " WHEN old." + DataColumns.MIME_TYPE + "='" + DataConstants.NOTE + "'" + - " BEGIN" + - " UPDATE " + TABLE.NOTE + - " SET " + NoteColumns.SNIPPET + "=''" + - " WHERE " + NoteColumns.ID + "=old." + DataColumns.NOTE_ID + ";" + - " END"; //删除便签数据时改变table表内容 + private static final String DATA_UPDATE_NOTE_CONTENT_ON_DELETE_TRIGGER = "CREATE TRIGGER update_note_content_on_delete " + + + " AFTER delete ON " + TABLE.DATA + + " WHEN old." + DataColumns.MIME_TYPE + "='" + DataConstants.NOTE + "'" + + " BEGIN" + + " UPDATE " + TABLE.NOTE + + " SET " + NoteColumns.SNIPPET + "=''" + + " WHERE " + NoteColumns.ID + "=old." + DataColumns.NOTE_ID + ";" + + " END"; // 删除便签数据时改变table表内容 /** * 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 " + - " AFTER DELETE ON " + TABLE.NOTE + - " BEGIN" + - " DELETE FROM " + TABLE.DATA + - " WHERE " + DataColumns.NOTE_ID + "=old." + NoteColumns.ID + ";" + - " END"; //删除便签时删除便签内容 + private static final String NOTE_DELETE_DATA_ON_DELETE_TRIGGER = "CREATE TRIGGER delete_data_on_delete " + + " AFTER DELETE ON " + TABLE.NOTE + + " BEGIN" + + " DELETE FROM " + TABLE.DATA + + " WHERE " + DataColumns.NOTE_ID + "=old." + NoteColumns.ID + ";" + + " END"; // 删除便签时删除便签内容 /** * 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" + - " DELETE FROM " + TABLE.NOTE + - " WHERE " + NoteColumns.PARENT_ID + "=old." + NoteColumns.ID + ";" + - " END"; //删除文件夹时删除内部的便签 + private static final String FOLDER_DELETE_NOTES_ON_DELETE_TRIGGER = "CREATE TRIGGER folder_delete_notes_on_delete " + + + " AFTER DELETE ON " + TABLE.NOTE + + " BEGIN" + + " DELETE FROM " + TABLE.NOTE + + " WHERE " + NoteColumns.PARENT_ID + "=old." + NoteColumns.ID + ";" + + " END"; // 删除文件夹时删除内部的便签 /** * Move notes belong to folder which has been moved to trash folder */ - 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"; //移动便签的父文件夹时便签也一起更改 + 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 NotesDatabaseHelper(Context context) { super(context, DB_NAME, null, DB_VERSION); - } //创建一个数据库 + } // 创建一个数据库 public void createNoteTable(SQLiteDatabase db) { db.execSQL(CREATE_NOTE_TABLE_SQL); - reCreateNoteTableTriggers(db); //重新创建触发器 - createSystemFolder(db); //创建系统文件夹 - Log.d(TAG, "note table has been created"); //创建一个新的便签表，返回日志 + reCreateNoteTableTriggers(db); // 重新创建触发器 + createSystemFolder(db); // 创建系统文件夹 + Log.d(TAG, "note table has been created"); // 创建一个新的便签表，返回日志 } - private void reCreateNoteTableTriggers(SQLiteDatabase db) { //数据库对象DB + private void reCreateNoteTableTriggers(SQLiteDatabase db) { // 数据库对象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"); @@ -233,17 +236,17 @@ public class NotesDatabaseHelper extends SQLiteOpenHelper { 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); - } //用于执行SQL语句，运行重新创建便签表触发器函数 + } // 用于执行SQL语句，运行重新创建便签表触发器函数 - private void createSystemFolder(SQLiteDatabase db) { //创建系统级文件夹 - ContentValues values = new ContentValues(); //为字典类创建对象 + 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); //为通讯便签创建记录文件夹，并添加键值对 + db.insert(TABLE.NOTE, null, values); // 为通讯便签创建记录文件夹，并添加键值对 /** * root folder which is default folder @@ -251,7 +254,7 @@ public class NotesDatabaseHelper extends SQLiteOpenHelper { values.clear(); values.put(NoteColumns.ID, Notes.ID_ROOT_FOLDER); values.put(NoteColumns.TYPE, Notes.TYPE_SYSTEM); - db.insert(TABLE.NOTE, null, values); //创建根文件夹，是默认的、最终的父文件夹 + db.insert(TABLE.NOTE, null, values); // 创建根文件夹，是默认的、最终的父文件夹 /** * temporary folder which is used for moving note @@ -259,7 +262,7 @@ public class NotesDatabaseHelper extends SQLiteOpenHelper { values.clear(); values.put(NoteColumns.ID, Notes.ID_TEMPARAY_FOLDER); values.put(NoteColumns.TYPE, Notes.TYPE_SYSTEM); - db.insert(TABLE.NOTE, null, values); //为移动中的便签创建的临时文件夹 + db.insert(TABLE.NOTE, null, values); // 为移动中的便签创建的临时文件夹 /** * create trash folder @@ -267,41 +270,41 @@ public class NotesDatabaseHelper extends SQLiteOpenHelper { values.clear(); values.put(NoteColumns.ID, Notes.ID_TRASH_FOLER); values.put(NoteColumns.TYPE, Notes.TYPE_SYSTEM); - db.insert(TABLE.NOTE, null, values); //创建垃圾桶 + db.insert(TABLE.NOTE, null, values); // 创建垃圾桶 } - public void createDataTable(SQLiteDatabase db) { //创建数据表 - db.execSQL(CREATE_DATA_TABLE_SQL); //SQL输入保存的语句 + public void createDataTable(SQLiteDatabase db) { // 创建数据表 + db.execSQL(CREATE_DATA_TABLE_SQL); // SQL输入保存的语句 reCreateDataTableTriggers(db); db.execSQL(CREATE_DATA_NOTE_ID_INDEX_SQL); - Log.d(TAG, "data table has been created"); //日志记录 + Log.d(TAG, "data table has been created"); // 日志记录 } - private void reCreateDataTableTriggers(SQLiteDatabase db) { //为数据表重新创建触发器 + 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("DROP TRIGGER IF EXISTS update_note_content_on_delete"); // 删除触发器 db.execSQL(DATA_UPDATE_NOTE_CONTENT_ON_INSERT_TRIGGER); db.execSQL(DATA_UPDATE_NOTE_CONTENT_ON_UPDATE_TRIGGER); - db.execSQL(DATA_UPDATE_NOTE_CONTENT_ON_DELETE_TRIGGER); //重新创建被删除的触发器 + db.execSQL(DATA_UPDATE_NOTE_CONTENT_ON_DELETE_TRIGGER); // 重新创建被删除的触发器 } - static synchronized NotesDatabaseHelper getInstance(Context context) { + static synchronized NotesDatabaseHelper getInstance(Context context) { // synchronized是同步的意思，同步方法，用于返回NotesDatabaseHelper的对象实例mInstance if (mInstance == null) { mInstance = new NotesDatabaseHelper(context); } return mInstance; - } //静态同步方法，用于返回NotesDatabaseHelper的对象实例mInstance + } // 静态同步方法，用于返回NotesDatabaseHelper的对象实例mInstance - @Override + @Override // 重写方法 public void onCreate(SQLiteDatabase db) { - createNoteTable(db); //创建便签表 - createDataTable(db); //创建数据表 - } //用于初始化表 + createNoteTable(db); // 创建便签表 + createDataTable(db); // 创建数据表 + } // 用于初始化表 @Override - public void onUpgrade(SQLiteDatabase db, int oldVersion, int newVersion) { //用于检查并升级数据库版本 + public void onUpgrade(SQLiteDatabase db, int oldVersion, int newVersion) { // 用于检查并升级数据库版本 boolean reCreateTriggers = false; boolean skipV2 = false; @@ -309,38 +312,38 @@ public class NotesDatabaseHelper extends SQLiteOpenHelper { upgradeToV2(db); skipV2 = true; // this upgrade including the upgrade from v2 to v3 oldVersion++; - } //检测到版本为1，升级版本 + } // 检测到版本为1，升级版本 if (oldVersion == 2 && !skipV2) { upgradeToV3(db); - reCreateTriggers = true; //重建触发器标志 - oldVersion++; //检测到版本为2，升级版本 + reCreateTriggers = true; // 重建触发器标志 + oldVersion++; // 检测到版本为2，升级版本 } if (oldVersion == 3) { upgradeToV4(db); oldVersion++; - } //检测到版本为3，升级版本 + } // 检测到版本为3，升级版本 if (reCreateTriggers) { reCreateNoteTableTriggers(db); reCreateDataTableTriggers(db); - } //进行触发器的重建 + } // 进行触发器的重建 if (oldVersion != newVersion) { throw new IllegalStateException("Upgrade notes database to version " + newVersion - + "fails"); //版本不匹配则抛出异常 + + "fails"); // 版本不匹配则抛出异常 } } - private void upgradeToV2(SQLiteDatabase 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) { + 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"); @@ -349,14 +352,15 @@ public class NotesDatabaseHelper extends SQLiteOpenHelper { db.execSQL("ALTER TABLE " + TABLE.NOTE + " ADD COLUMN " + NoteColumns.GTASK_ID + " TEXT NOT NULL DEFAULT ''"); // add a trash system folder + ContentValues values = new ContentValues(); values.put(NoteColumns.ID, Notes.ID_TRASH_FOLER); values.put(NoteColumns.TYPE, Notes.TYPE_SYSTEM); db.insert(TABLE.NOTE, null, values); - } //删除不用的触发器，并添加不为空的新列，添加键值对 + } // 删除不用的触发器，并添加不为空的新列，添加键值对 private void upgradeToV4(SQLiteDatabase db) { db.execSQL("ALTER TABLE " + TABLE.NOTE + " ADD COLUMN " + NoteColumns.VERSION + " INTEGER NOT NULL DEFAULT 0"); - } //添加新的不为空的列 + } // 添加新的不为空的列 } diff --git a/src/data/NotesProvider.java b/src/data/NotesProvider.java index 9ae1528..798c356 100644 --- a/src/data/NotesProvider.java +++ b/src/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,24 +33,23 @@ import net.micode.notes.data.Notes.DataColumns; import net.micode.notes.data.Notes.NoteColumns; import net.micode.notes.data.NotesDatabaseHelper.TABLE; +public class NotesProvider extends ContentProvider {// uri操作相关类，用于对数据库进行操作 + private static final UriMatcher mMatcher; // UriMatcher类用于分辨数据操作类型，用于匹配不同的uri -public class NotesProvider extends ContentProvider { - private static final UriMatcher mMatcher; //UriMatcher类用于分辨数据表 - - private NotesDatabaseHelper mHelper; //建立NotesDatabaseHelper类对象 + private NotesDatabaseHelper mHelper; // 建立NotesDatabaseHelper类对象，用于数据库操作 - private static final String TAG = "NotesProvider"; //设置类名值 + private static final String TAG = "NotesProvider"; // 设置类名标签，用于调试 - private static final int URI_NOTE = 1; //设置便签uri - private static final int URI_NOTE_ITEM = 2; - private static final int URI_DATA = 3; //设置数据uri - private static final int URI_DATA_ITEM = 4; + private static final int URI_NOTE = 1; // 设置便签uri + private static final int URI_NOTE_ITEM = 2; + private static final int URI_DATA = 3; // 设置数据uri + private static final int URI_DATA_ITEM = 4; - private static final int URI_SEARCH = 5; //设置搜索uri - private static final int URI_SEARCH_SUGGEST = 6; + private static final int URI_SEARCH = 5; // 设置搜索uri + private static final int URI_SEARCH_SUGGEST = 6; static { - mMatcher = new UriMatcher(UriMatcher.NO_MATCH); //进行初始化 + 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); @@ -59,48 +57,49 @@ public class NotesProvider extends ContentProvider { 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); - } //将不同的uri与数值相匹配 + } // 将不同的uri与数值相匹配 /** - * x'0A' represents the '\n' character in sqlite. For title and content in the search result, + * 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. - */ //用0A代表\n，为搜索结果换行 + */ // 用0A代表\n，为搜索结果换行 private static final String NOTES_SEARCH_PROJECTION = NoteColumns.ID + "," - + NoteColumns.ID + " AS " + SearchManager.SUGGEST_COLUMN_INTENT_EXTRA_DATA + "," - + "TRIM(REPLACE(" + NoteColumns.SNIPPET + ", x'0A','')) AS " + SearchManager.SUGGEST_COLUMN_TEXT_1 + "," - + "TRIM(REPLACE(" + NoteColumns.SNIPPET + ", x'0A','')) AS " + SearchManager.SUGGEST_COLUMN_TEXT_2 + "," - + R.drawable.search_result + " AS " + SearchManager.SUGGEST_COLUMN_ICON_1 + "," - + "'" + Intent.ACTION_VIEW + "' AS " + SearchManager.SUGGEST_COLUMN_INTENT_ACTION + "," - + "'" + Notes.TextNote.CONTENT_TYPE + "' AS " + SearchManager.SUGGEST_COLUMN_INTENT_DATA; //... + + NoteColumns.ID + " AS " + SearchManager.SUGGEST_COLUMN_INTENT_EXTRA_DATA + "," + + "TRIM(REPLACE(" + NoteColumns.SNIPPET + ", x'0A','')) AS " + SearchManager.SUGGEST_COLUMN_TEXT_1 + "," + + "TRIM(REPLACE(" + NoteColumns.SNIPPET + ", x'0A','')) AS " + SearchManager.SUGGEST_COLUMN_TEXT_2 + "," + + R.drawable.search_result + " AS " + SearchManager.SUGGEST_COLUMN_ICON_1 + "," + + "'" + Intent.ACTION_VIEW + "' AS " + SearchManager.SUGGEST_COLUMN_INTENT_ACTION + "," + + "'" + Notes.TextNote.CONTENT_TYPE + "' AS " + SearchManager.SUGGEST_COLUMN_INTENT_DATA; // 设置搜索结果的显示方式 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; //检索便签的sql语句，在列表中搜寻。使用Notes类中的接口与变量 + + " FROM " + TABLE.NOTE + + " WHERE " + NoteColumns.SNIPPET + " LIKE ?" + + " AND " + NoteColumns.PARENT_ID + "<>" + Notes.ID_TRASH_FOLER + + " AND " + NoteColumns.TYPE + "=" + Notes.TYPE_NOTE; // 检索便签的sql语句，在列表中搜寻。使用Notes类中的接口与变量 @Override public boolean onCreate() { mHelper = NotesDatabaseHelper.getInstance(getContext()); - return true; //创建NotesDatabaseHelper类并返回成果标识 + return true; // 创建NotesDatabaseHelper类并返回成果标识 } @Override public Cursor query(Uri uri, String[] projection, String selection, String[] selectionArgs, - String sortOrder) { //负责查询数据，接受uri、返回烈、选择、排列方式 - Cursor c = null; //创建空游标，表示数据库操作结果集合 - SQLiteDatabase db = mHelper.getReadableDatabase(); //获取数据库对象 + String sortOrder) { // 负责查询数据，接受uri、返回烈、选择、排列方式 + Cursor c = null; // 创建空游标，表示数据库操作结果集合 + SQLiteDatabase db = mHelper.getReadableDatabase(); // 获取数据库对象 String id = null; - switch (mMatcher.match(uri)) { //确定uri类型 + switch (mMatcher.match(uri)) { // 确定uri类型 case URI_NOTE: c = db.query(TABLE.NOTE, projection, selection, selectionArgs, null, null, - sortOrder); //传参，进行标准查询 + sortOrder); // 传参，进行标准查询 break; case URI_NOTE_ITEM: id = uri.getPathSegments().get(1); c = db.query(TABLE.NOTE, projection, NoteColumns.ID + "=" + id + parseSelection(selection), selectionArgs, null, null, sortOrder); - break; //传参，对id进行查询 + break; // 传参，对id进行查询 case URI_DATA: c = db.query(TABLE.DATA, projection, selection, selectionArgs, null, null, sortOrder); @@ -112,13 +111,13 @@ public class NotesProvider extends ContentProvider { break; case URI_SEARCH: case URI_SEARCH_SUGGEST: - if (sortOrder != null || projection != null) { //检查是否指定排序方式 + if (sortOrder != null || projection != null) { // 检查是否指定排序方式 throw new IllegalArgumentException( "do not specify sortOrder, selection, selectionArgs, or projection" + "with this query"); } String searchString = null; - if (mMatcher.match(uri) == URI_SEARCH_SUGGEST) { //提取uri中搜索模式 + if (mMatcher.match(uri) == URI_SEARCH_SUGGEST) { // 提取uri中搜索模式 if (uri.getPathSegments().size() > 1) { searchString = uri.getPathSegments().get(1); } @@ -133,43 +132,43 @@ public class NotesProvider extends ContentProvider { try { searchString = String.format("%%%s%%", searchString); c = db.rawQuery(NOTES_SNIPPET_SEARCH_QUERY, - new String[] { searchString }); //在Notes表进行搜索 + new String[] { searchString }); // 在Notes表进行搜索 } catch (IllegalStateException ex) { - Log.e(TAG, "got exception: " + ex.toString()); //日志 + Log.e(TAG, "got exception: " + ex.toString()); // 日志 } break; default: - throw new IllegalArgumentException("Unknown URI " + uri); //抛出异常 + throw new IllegalArgumentException("Unknown URI " + uri); // 抛出异常 } if (c != null) { - c.setNotificationUri(getContext().getContentResolver(), uri); //在游标查询的数据变化时进行通知 - } //通知uri是标识查询结果的uri，setNotificationUri方法可注册通知uri，与对象c相关联 + c.setNotificationUri(getContext().getContentResolver(), uri); // 在游标查询的数据变化时进行通知 + } // 通知uri是标识查询结果的uri，setNotificationUri方法可注册通知uri，与对象c相关联 return c; } @Override - public Uri insert(Uri uri, ContentValues values) { //uri表示要插入的uri，values表示要插入的数据 - SQLiteDatabase db = mHelper.getWritableDatabase(); //打开或创建一个数据库 + public Uri insert(Uri uri, ContentValues values) { // uri表示要插入的uri，values表示要插入的数据,返回插入数据的uri + SQLiteDatabase db = mHelper.getWritableDatabase(); // 打开或创建一个数据库 long dataId = 0, noteId = 0, insertedId = 0; - switch (mMatcher.match(uri)) { //匹配uri + switch (mMatcher.match(uri)) { // 匹配uri case URI_NOTE: - insertedId = noteId = db.insert(TABLE.NOTE, null, values); //将数据插入到Notes表中 + insertedId = noteId = db.insert(TABLE.NOTE, null, values); // 将数据插入到Notes表中 break; case URI_DATA: - if (values.containsKey(DataColumns.NOTE_ID)) { //检查values是否含有NOTE_ID内容，返回bool值 - noteId = values.getAsLong(DataColumns.NOTE_ID); //关联noteId + if (values.containsKey(DataColumns.NOTE_ID)) { // 检查values是否含有NOTE_ID内容，返回bool值 + noteId = values.getAsLong(DataColumns.NOTE_ID); // 关联noteId } else { - Log.d(TAG, "Wrong data format without note id:" + values.toString()); //日志记录 + Log.d(TAG, "Wrong data format without note id:" + values.toString()); // 日志记录 } - insertedId = dataId = db.insert(TABLE.DATA, null, values); //数据库插入新行的id返回到两个变量中 + insertedId = dataId = db.insert(TABLE.DATA, null, values); // 数据库插入新行的id返回到两个变量中 break; default: throw new IllegalArgumentException("Unknown URI " + uri); } // Notify the note uri - if (noteId > 0) { //不为零表示插入成功， + if (noteId > 0) { // 不为零表示插入成功， getContext().getContentResolver().notifyChange( - ContentUris.withAppendedId(Notes.CONTENT_NOTE_URI, noteId), null); //通知uri发生变化 + ContentUris.withAppendedId(Notes.CONTENT_NOTE_URI, noteId), null); // 通知uri发生变化 } // Notify the data uri @@ -178,22 +177,23 @@ public class NotesProvider extends ContentProvider { ContentUris.withAppendedId(Notes.CONTENT_DATA_URI, dataId), null); } - return ContentUris.withAppendedId(uri, insertedId); //返回新的uri，表示插入位置 + return ContentUris.withAppendedId(uri, insertedId); // 返回新的uri，表示插入位置 } @Override - public int delete(Uri uri, String selection, String[] selectionArgs) { //表示要删除的uri、SQL中的WHERE与参数 - int count = 0; //表示删除记录数 + public int delete(Uri uri, String selection, String[] selectionArgs) { // 表示要删除的uri、SQL中的WHERE与参数,返回删除的记录数 + int count = 0; // 表示删除记录数 String id = null; - SQLiteDatabase db = mHelper.getWritableDatabase(); //打开数据库 + SQLiteDatabase db = mHelper.getWritableDatabase(); // 打开数据库 boolean deleteData = false; - switch (mMatcher.match(uri)) { //uri匹配 + + switch (mMatcher.match(uri)) { // uri匹配 case URI_NOTE: - selection = "(" + selection + ") AND " + NoteColumns.ID + ">0 "; //设置WHERE - count = db.delete(TABLE.NOTE, selection, selectionArgs); //删除，并计数 + selection = "(" + selection + ") AND " + NoteColumns.ID + ">0 "; // 设置WHERE + count = db.delete(TABLE.NOTE, selection, selectionArgs); // 删除，并计数 break; case URI_NOTE_ITEM: - id = uri.getPathSegments().get(1); //获取id + id = uri.getPathSegments().get(1); // 获取id /** * ID that smaller than 0 is system folder which is not allowed to * trash @@ -204,45 +204,46 @@ public class NotesProvider extends ContentProvider { } count = db.delete(TABLE.NOTE, NoteColumns.ID + "=" + id + parseSelection(selection), selectionArgs); - break; //删除指定id，并计数 + break; // 删除指定id，并计数 case URI_DATA: - count = db.delete(TABLE.DATA, selection, selectionArgs); //删除，并计数 + count = db.delete(TABLE.DATA, selection, selectionArgs); // 删除，并计数 deleteData = true; break; case URI_DATA_ITEM: - id = uri.getPathSegments().get(1); //获取id + id = uri.getPathSegments().get(1); // 获取id count = db.delete(TABLE.DATA, DataColumns.ID + "=" + id + parseSelection(selection), selectionArgs); - deleteData = true; //删除指定id，并计数 + deleteData = true; // 删除指定id，并计数 break; default: - throw new IllegalArgumentException("Unknown URI " + uri); //报错 + throw new IllegalArgumentException("Unknown URI " + uri); // 报错 } - if (count > 0) { //表示有删除操作，通知uri发生变化 + + if (count > 0) { // 表示有删除操作，通知uri发生变化 if (deleteData) { getContext().getContentResolver().notifyChange(Notes.CONTENT_NOTE_URI, null); } getContext().getContentResolver().notifyChange(uri, null); } - return count; //返回删除的记录数 + return count; // 返回删除的记录数 } @Override - public int update(Uri uri, ContentValues values, String selection, String[] selectionArgs) { //表示更新的uri、values为新的列值、where以及参数 - int count = 0; //更新条数 + public int update(Uri uri, ContentValues values, String selection, String[] selectionArgs) { // 表示更新的uri、values为新的列值、where以及参数 + int count = 0; // 更新条数 String id = null; - SQLiteDatabase db = mHelper.getWritableDatabase(); //打开数据库 - boolean updateData = false; //设置数据表更新表示 - switch (mMatcher.match(uri)) { //匹配uri + SQLiteDatabase db = mHelper.getWritableDatabase(); // 打开数据库 + boolean updateData = false; // 设置数据表更新表示 + switch (mMatcher.match(uri)) { // 匹配uri case URI_NOTE: - increaseNoteVersion(-1, selection, selectionArgs); //跟新便签 - count = db.update(TABLE.NOTE, values, selection, selectionArgs); //更新指定表的行，并计数 + increaseNoteVersion(-1, selection, selectionArgs); // 跟新便签 + count = db.update(TABLE.NOTE, values, selection, selectionArgs); // 更新指定表的行，并计数 break; case URI_NOTE_ITEM: - id = uri.getPathSegments().get(1); //提取id + id = uri.getPathSegments().get(1); // 提取id increaseNoteVersion(Long.valueOf(id), selection, selectionArgs); count = db.update(TABLE.NOTE, values, NoteColumns.ID + "=" + id - + parseSelection(selection), selectionArgs); //增加指定的id条件 + + parseSelection(selection), selectionArgs); // 增加指定的id条件 break; case URI_DATA: count = db.update(TABLE.DATA, values, selection, selectionArgs); @@ -255,50 +256,50 @@ public class NotesProvider extends ContentProvider { updateData = true; break; default: - throw new IllegalArgumentException("Unknown URI " + uri); //抛出异常 + throw new IllegalArgumentException("Unknown URI " + uri); // 抛出异常 } if (count > 0) { if (updateData) { - getContext().getContentResolver().notifyChange(Notes.CONTENT_NOTE_URI, null);//通知指定uri数据更改 + getContext().getContentResolver().notifyChange(Notes.CONTENT_NOTE_URI, null);// 通知指定uri数据更改 } - getContext().getContentResolver().notifyChange(uri, null); //通知uri数据更改 + getContext().getContentResolver().notifyChange(uri, null); // 通知uri数据更改 } return count; } - private String parseSelection(String selection) { //检查selection是否为空 - return (!TextUtils.isEmpty(selection) ? " AND (" + selection + ')' : ""); //为空则返回“” + private String parseSelection(String selection) { // 检查selection是否为空 + return (!TextUtils.isEmpty(selection) ? " AND (" + selection + ')' : ""); // 为空则返回“” } - private void increaseNoteVersion(long id, String selection, String[] selectionArgs) { //使用数据库更新便签版本 + private void increaseNoteVersion(long id, String selection, String[] selectionArgs) { // 使用数据库更新便签版本 StringBuilder sql = new StringBuilder(120); sql.append("UPDATE "); sql.append(TABLE.NOTE); sql.append(" SET "); sql.append(NoteColumns.VERSION); - sql.append("=" + NoteColumns.VERSION + "+1 "); //升级便签版本号 + sql.append("=" + NoteColumns.VERSION + "+1 "); // 升级便签版本号 - if (id > 0 || !TextUtils.isEmpty(selection)) { //selection不为空或存在id则增加where条件 + if (id > 0 || !TextUtils.isEmpty(selection)) { // selection不为空或存在id则增加where条件 sql.append(" WHERE "); } if (id > 0) { sql.append(NoteColumns.ID + "=" + String.valueOf(id)); } if (!TextUtils.isEmpty(selection)) { - String selectString = id > 0 ? parseSelection(selection) : selection; //parseSelection将传入的参数中的占位符替换为实际的值 - for (String args : selectionArgs) { // - selectString = selectString.replaceFirst("\\?", args); //replaceFirst选择参数数组中的值替换语句中的占位符 + String selectString = id > 0 ? parseSelection(selection) : selection; // parseSelection将传入的参数中的占位符替换为实际的值 + for (String args : selectionArgs) { // + selectString = selectString.replaceFirst("\\?", args); // replaceFirst选择参数数组中的值替换语句中的占位符 } sql.append(selectString); } - mHelper.getWritableDatabase().execSQL(sql.toString()); //执行SQL语句 + mHelper.getWritableDatabase().execSQL(sql.toString()); // 执行SQL语句 } @Override - public String getType(Uri uri) { //获取指定uri的MIME类型 - // TODO Auto-generated method stub //表示该方法没有实现 + public String getType(Uri uri) { // 获取指定uri的MIME类型 + // TODO Auto-generated method stub //表示该方法没有实现 return null; } } diff --git a/src/model/Note.java b/src/model/Note.java index 6706cf6..4072cf5 100644 --- a/src/model/Note.java +++ b/src/model/Note.java @@ -15,6 +15,7 @@ */ package net.micode.notes.model; + import android.content.ContentProviderOperation; import android.content.ContentProviderResult; import android.content.ContentUris; @@ -33,88 +34,90 @@ import net.micode.notes.data.Notes.TextNote; import java.util.ArrayList; +public class Note {// 便签类 + private ContentValues mNoteDiffValues; // 用于保存便签修改值 + private NoteData mNoteData; // 保存便签的数据 + private static final String TAG = "Note"; // 设置TAG为Note -public class 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 */ - public static synchronized long getNewNoteId(Context context, long folderId) { + public static synchronized long getNewNoteId(Context context, long folderId) { // 为一个新的便签创建id返回数据库 // Create a new note in the database - ContentValues values = new ContentValues(); - long createdTime = System.currentTimeMillis(); + 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); - Uri uri = context.getContentResolver().insert(Notes.CONTENT_NOTE_URI, values); + Uri uri = context.getContentResolver().insert(Notes.CONTENT_NOTE_URI, values); // 将values插入数据库中，并返回uri long noteId = 0; try { - noteId = Long.valueOf(uri.getPathSegments().get(1)); + noteId = Long.valueOf(uri.getPathSegments().get(1)); // 解析uri获取新笔记id } catch (NumberFormatException e) { - Log.e(TAG, "Get note id error :" + e.toString()); + Log.e(TAG, "Get note id error :" + e.toString()); // 解析失败日志 noteId = 0; } if (noteId == -1) { - throw new IllegalStateException("Wrong note id:" + noteId); + throw new IllegalStateException("Wrong note id:" + noteId); // 获取id出错，抛出异常 } return noteId; } 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()); + public void setNoteValue(String key, String value) { // 设置便签的值 + mNoteDiffValues.put(key, value); // key为属性，values为新值 + mNoteDiffValues.put(NoteColumns.LOCAL_MODIFIED, 1); // 本地修改标识为1，标识被修改 + mNoteDiffValues.put(NoteColumns.MODIFIED_DATE, System.currentTimeMillis()); // 表示修改时间，用于服务器时间比较 } public void setTextData(String key, String value) { - mNoteData.setTextData(key, value); - } + mNoteData.setTextData(key, value); // 添加键值对 + } // 设置文本数据 public void setTextDataId(long id) { mNoteData.setTextDataId(id); - } + } // 设置文本数据id public long getTextDataId() { return mNoteData.mTextDataId; - } + } // 获取文本数据id public void setCallDataId(long id) { mNoteData.setCallDataId(id); - } + } // 设置通讯数据id public void setCallData(String key, String value) { mNoteData.setCallData(key, value); - } + } // 设置通讯数据，添加键值对 public boolean isLocalModified() { return mNoteDiffValues.size() > 0 || mNoteData.isLocalModified(); - } + } // 检查是否被修改 - public boolean syncNote(Context context, long noteId) { + public boolean syncNote(Context context, long noteId) { // 用于同步到数据库中 if (noteId <= 0) { - throw new IllegalArgumentException("Wrong note id:" + noteId); + throw new IllegalArgumentException("Wrong note id:" + noteId); // 抛出异常 } - if (!isLocalModified()) { - return true; + if (!isLocalModified()) { // 判断是否修改过 + 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 + * 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( + if (context.getContentResolver().update( // 打包并同步 ContentUris.withAppendedId(Notes.CONTENT_NOTE_URI, noteId), mNoteDiffValues, null, null) == 0) { Log.e(TAG, "Update note error, should not happen"); @@ -124,13 +127,13 @@ public class Note { if (mNoteData.isLocalModified() && (mNoteData.pushIntoContentResolver(context, noteId) == null)) { - return false; + return false; // 表示同步失败 } return true; } - private class NoteData { + private class NoteData { // 私有内部类，用于便签数据管理 private long mTextDataId; private ContentValues mTextDataValues; @@ -141,77 +144,76 @@ public class Note { private static final String TAG = "NoteData"; - public NoteData() { - mTextDataValues = new ContentValues(); - mCallDataValues = new ContentValues(); + public NoteData() { // 构造函数 + mTextDataValues = new ContentValues(); // 保存便签文本 + mCallDataValues = new ContentValues(); // 保存便签通讯记录 mTextDataId = 0; mCallDataId = 0; } boolean isLocalModified() { return mTextDataValues.size() > 0 || mCallDataValues.size() > 0; - } + } // 检查便签是否再本地修改 void setTextDataId(long id) { - if(id <= 0) { + if (id <= 0) { throw new IllegalArgumentException("Text data id should larger than 0"); } mTextDataId = id; - } + } // 设置便签文本标识符 void setCallDataId(long id) { if (id <= 0) { throw new IllegalArgumentException("Call data id should larger than 0"); } mCallDataId = id; - } + } // 设置便签通讯标识符 void setCallData(String key, String value) { mCallDataValues.put(key, value); - mNoteDiffValues.put(NoteColumns.LOCAL_MODIFIED, 1); - mNoteDiffValues.put(NoteColumns.MODIFIED_DATE, System.currentTimeMillis()); - } + mNoteDiffValues.put(NoteColumns.LOCAL_MODIFIED, 1); // 更新修改状态 + mNoteDiffValues.put(NoteColumns.MODIFIED_DATE, System.currentTimeMillis()); // 更新修改日期 + } // 设置文本数据 - void setTextData(String key, String value) { + void setTextData(String key, String value) { // 设置通讯数据 mTextDataValues.put(key, value); mNoteDiffValues.put(NoteColumns.LOCAL_MODIFIED, 1); mNoteDiffValues.put(NoteColumns.MODIFIED_DATE, System.currentTimeMillis()); } - Uri pushIntoContentResolver(Context context, long noteId) { + Uri pushIntoContentResolver(Context context, long noteId) { // 将文本数据与通讯数据添加到context /** * Check for safety */ if (noteId <= 0) { - throw new IllegalArgumentException("Wrong note id:" + noteId); + throw new IllegalArgumentException("Wrong note id:" + noteId); // 抛出异常 } ArrayList operationList = new ArrayList(); ContentProviderOperation.Builder builder = null; - if(mTextDataValues.size() > 0) { - mTextDataValues.put(DataColumns.NOTE_ID, noteId); + if (mTextDataValues.size() > 0) { // 检查文本数据 + mTextDataValues.put(DataColumns.NOTE_ID, noteId); // 将便签id与数据值相关联 if (mTextDataId == 0) { - mTextDataValues.put(DataColumns.MIME_TYPE, TextNote.CONTENT_ITEM_TYPE); + mTextDataValues.put(DataColumns.MIME_TYPE, TextNote.CONTENT_ITEM_TYPE); // 并将键值对添加到mTextDataValues中 Uri uri = context.getContentResolver().insert(Notes.CONTENT_DATA_URI, - mTextDataValues); + mTextDataValues); // 插入新的数据行，保存返回的uri try { setTextDataId(Long.valueOf(uri.getPathSegments().get(1))); } catch (NumberFormatException e) { - Log.e(TAG, "Insert new text data fail with noteId" + noteId); + Log.e(TAG, "Insert new text data fail with noteId" + noteId); // 异常日志 mTextDataValues.clear(); return null; } - } else { + } else { // 表示需要更新现有数据行 builder = ContentProviderOperation.newUpdate(ContentUris.withAppendedId( Notes.CONTENT_DATA_URI, mTextDataId)); builder.withValues(mTextDataValues); operationList.add(builder.build()); } - mTextDataValues.clear(); + mTextDataValues.clear(); // 清空mTextDataValues } - - if(mCallDataValues.size() > 0) { + if (mCallDataValues.size() > 0) { // 检查通讯数据，代码内容功能同上 mCallDataValues.put(DataColumns.NOTE_ID, noteId); if (mCallDataId == 0) { mCallDataValues.put(DataColumns.MIME_TYPE, CallNote.CONTENT_ITEM_TYPE); @@ -233,7 +235,7 @@ public class Note { mCallDataValues.clear(); } - if (operationList.size() > 0) { + if (operationList.size() > 0) { // 检查operationList，对载入的操作进行批量提交 try { ContentProviderResult[] results = context.getContentResolver().applyBatch( Notes.AUTHORITY, operationList); diff --git a/src/model/WorkingNote.java b/src/model/WorkingNote.java index be081e4..58babc5 100644 --- a/src/model/WorkingNote.java +++ b/src/model/WorkingNote.java @@ -31,38 +31,37 @@ import net.micode.notes.data.Notes.NoteColumns; import net.micode.notes.data.Notes.TextNote; import net.micode.notes.tool.ResourceParser.NoteBgResources; - -public class WorkingNote { +public class WorkingNote {// 表示工作便签 // Note for the working note - private Note mNote; + private Note mNote; // 表示工作便签 // Note Id - private long mNoteId; + private long mNoteId; // 便签id // Note content - private String mContent; + private String mContent; // 便签内容 // Note mode - private int mMode; + private int mMode; // 便签模式 - private long mAlertDate; + private long mAlertDate; // 提醒日期 - private long mModifiedDate; + private long mModifiedDate; // 最近修改日期 - private int mBgColorId; + private int mBgColorId; // 背景颜色id - private int mWidgetId; + private int mWidgetId; // 小部件id - private int mWidgetType; + private int mWidgetType; // 小部件类型 - private long mFolderId; + private long mFolderId; // 所在文件夹id - private Context mContext; + private Context mContext; // 表示上下文 - private static final String TAG = "WorkingNote"; + private static final String TAG = "WorkingNote"; // 设置TAG - private boolean mIsDeleted; + private boolean mIsDeleted; // 表示是否被删除 - private NoteSettingChangedListener mNoteSettingStatusListener; + private NoteSettingChangedListener mNoteSettingStatusListener; // 表示便签设置状态 - public static final String[] DATA_PROJECTION = new String[] { + public static final String[] DATA_PROJECTION = new String[] { // 用于指定需要从数据库查询的数据列 DataColumns.ID, DataColumns.CONTENT, DataColumns.MIME_TYPE, @@ -81,28 +80,28 @@ public class WorkingNote { NoteColumns.MODIFIED_DATE }; - private static final int DATA_ID_COLUMN = 0; + private static final int DATA_ID_COLUMN = 0; // 表示查询数据的id列 - private static final int DATA_CONTENT_COLUMN = 1; + private static final int DATA_CONTENT_COLUMN = 1; // 表示查询数据的内容列 - private static final int DATA_MIME_TYPE_COLUMN = 2; + private static final int DATA_MIME_TYPE_COLUMN = 2; // 表示查询数据的MIME类型列 - private static final int DATA_MODE_COLUMN = 3; + private static final int DATA_MODE_COLUMN = 3; // 表示查询数据的模式列 - private static final int NOTE_PARENT_ID_COLUMN = 0; + private static final int NOTE_PARENT_ID_COLUMN = 0; // 表示查询便签的父文件夹id列 - private static final int NOTE_ALERTED_DATE_COLUMN = 1; + private static final int NOTE_ALERTED_DATE_COLUMN = 1; // 表示便签的提醒日期列 - private static final int NOTE_BG_COLOR_ID_COLUMN = 2; + private static final int NOTE_BG_COLOR_ID_COLUMN = 2; // 表示便签的背景颜色id列 - private static final int NOTE_WIDGET_ID_COLUMN = 3; + private static final int NOTE_WIDGET_ID_COLUMN = 3; // 表示便签小组件id列 - private static final int NOTE_WIDGET_TYPE_COLUMN = 4; + private static final int NOTE_WIDGET_TYPE_COLUMN = 4; // 表示便签小组件类型列 - private static final int NOTE_MODIFIED_DATE_COLUMN = 5; + private static final int NOTE_MODIFIED_DATE_COLUMN = 5; // 表示便签最后修改日期列 // New note construct - private WorkingNote(Context context, long folderId) { + private WorkingNote(Context context, long folderId) { // 新建便签的结构 mContext = context; mAlertDate = 0; mModifiedDate = System.currentTimeMillis(); @@ -115,7 +114,7 @@ public class WorkingNote { } // Existing note construct - private WorkingNote(Context context, long noteId, long folderId) { + private WorkingNote(Context context, long noteId, long folderId) { // 存在的的便签结构 mContext = context; mNoteId = noteId; mFolderId = folderId; @@ -124,13 +123,13 @@ public class WorkingNote { loadNote(); } - private void loadNote() { + private void loadNote() { // 查询并加载当前便签的详细信息 Cursor cursor = mContext.getContentResolver().query( ContentUris.withAppendedId(Notes.CONTENT_NOTE_URI, mNoteId), NOTE_PROJECTION, null, - null, null); + null, null); // 返回一个Cursor对象 if (cursor != null) { - if (cursor.moveToFirst()) { + 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); @@ -141,70 +140,70 @@ public class WorkingNote { cursor.close(); } else { Log.e(TAG, "No note with id:" + mNoteId); - throw new IllegalArgumentException("Unable to find note with id " + mNoteId); + throw new IllegalArgumentException("Unable to find note with id " + mNoteId); // 抛出异常，表示未找到指定id的便签 } - loadNoteData(); + loadNoteData(); // 加载便签内容和其他数据 } - private void loadNoteData() { + private void loadNoteData() { // 加载便签内容数据 Cursor cursor = mContext.getContentResolver().query(Notes.CONTENT_DATA_URI, DATA_PROJECTION, - DataColumns.NOTE_ID + "=?", new String[] { - String.valueOf(mNoteId) - }, null); + DataColumns.NOTE_ID + "=?", new String[] { // 获取与便签id相对应的所有数据 + String.valueOf(mNoteId) + }, null); // 遍历Cursor对象所有数据 if (cursor != null) { if (cursor.moveToFirst()) { do { String type = cursor.getString(DATA_MIME_TYPE_COLUMN); - if (DataConstants.NOTE.equals(type)) { + if (DataConstants.NOTE.equals(type)) { // 类型相对应则设置WorkingNote对象成员变量 mContent = cursor.getString(DATA_CONTENT_COLUMN); mMode = cursor.getInt(DATA_MODE_COLUMN); mNote.setTextDataId(cursor.getLong(DATA_ID_COLUMN)); } else if (DataConstants.CALL_NOTE.equals(type)) { - mNote.setCallDataId(cursor.getLong(DATA_ID_COLUMN)); + mNote.setCallDataId(cursor.getLong(DATA_ID_COLUMN)); // 设置为Notes对象的成员变量 } else { - Log.d(TAG, "Wrong note type with type:" + type); + Log.d(TAG, "Wrong note type with type:" + type); // 抛出异常，错误的数据类型 } } while (cursor.moveToNext()); } cursor.close(); } else { Log.e(TAG, "No data with id:" + mNoteId); - throw new IllegalArgumentException("Unable to find note's data with id " + mNoteId); + throw new IllegalArgumentException("Unable to find note's data with id " + mNoteId); // 抛出异常，无查询结果 } } - public static WorkingNote createEmptyNote(Context context, long folderId, int widgetId, - int widgetType, int defaultBgColorId) { - WorkingNote note = new WorkingNote(context, folderId); + public static WorkingNote createEmptyNote(Context context, long folderId, int widgetId, // 上下文对象、文件夹id、组件id、组件类型、默认背景颜色id + int widgetType, int defaultBgColorId) { // 创建空白便签 + WorkingNote note = new WorkingNote(context, folderId); // 用上下文对象、父文件夹id创建WorkingNote note.setBgColorId(defaultBgColorId); note.setWidgetId(widgetId); note.setWidgetType(widgetType); - return note; + return note; // 设置变量并返回 } - public static WorkingNote load(Context context, long id) { + public static WorkingNote load(Context context, long id) { // 用上下文对象和id创建新的WorkingNote对象 return new WorkingNote(context, id, 0); } - public synchronized boolean saveNote() { - if (isWorthSaving()) { - if (!existInDatabase()) { - if ((mNoteId = Note.getNewNoteId(mContext, mFolderId)) == 0) { - Log.e(TAG, "Create new note fail with id:" + mNoteId); + public synchronized boolean saveNote() { // 保存便签 + if (isWorthSaving()) { // 判断是否保存 + if (!existInDatabase()) { // 是否存在与数据库 + if ((mNoteId = Note.getNewNoteId(mContext, mFolderId)) == 0) { // 不存在则获取id + 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 + if (mWidgetId != AppWidgetManager.INVALID_APPWIDGET_ID // 诺该便签与组件关联 && mWidgetType != Notes.TYPE_WIDGET_INVALIDE && mNoteSettingStatusListener != null) { - mNoteSettingStatusListener.onWidgetChanged(); + mNoteSettingStatusListener.onWidgetChanged(); // 更新组件 } return true; } else { @@ -214,155 +213,156 @@ public class WorkingNote { public boolean existInDatabase() { return mNoteId > 0; - } + } // 判断便签是否存在数据库 private boolean isWorthSaving() { - if (mIsDeleted || (!existInDatabase() && TextUtils.isEmpty(mContent)) + 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)); + 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); + mNoteSettingStatusListener.onClockAlertChanged(date, set); // 调用监听器 } } - public void markDeleted(boolean mark) { + public void markDeleted(boolean mark) { // 标记删除标志 mIsDeleted = mark; if (mWidgetId != AppWidgetManager.INVALID_APPWIDGET_ID && mWidgetType != Notes.TYPE_WIDGET_INVALIDE && mNoteSettingStatusListener != null) { - mNoteSettingStatusListener.onWidgetChanged(); + mNoteSettingStatusListener.onWidgetChanged(); // 已删除则更新组件 } } - public void setBgColorId(int id) { - if (id != mBgColorId) { - mBgColorId = id; + public void setBgColorId(int id) { // 设置背景颜色 + if (id != mBgColorId) { // 检查 + mBgColorId = id; // 更新设置 if (mNoteSettingStatusListener != null) { - mNoteSettingStatusListener.onBackgroundColorChanged(); + mNoteSettingStatusListener.onBackgroundColorChanged(); // 通知监听器 } - mNote.setNoteValue(NoteColumns.BG_COLOR_ID, String.valueOf(id)); + mNote.setNoteValue(NoteColumns.BG_COLOR_ID, String.valueOf(id)); // 更新数据库 } } - public void setCheckListMode(int mode) { - if (mMode != mode) { + public void setCheckListMode(int mode) { // 设置便签的检查清单模式 + if (mMode != mode) { // 检查 if (mNoteSettingStatusListener != null) { - mNoteSettingStatusListener.onCheckListModeChanged(mMode, mode); + mNoteSettingStatusListener.onCheckListModeChanged(mMode, mode); // 通知 } mMode = mode; - mNote.setTextData(TextNote.MODE, String.valueOf(mMode)); + mNote.setTextData(TextNote.MODE, String.valueOf(mMode)); // 更新数据库 } } - public void setWidgetType(int type) { + public void setWidgetType(int type) { // 设置组件类型 if (type != mWidgetType) { mWidgetType = type; - mNote.setNoteValue(NoteColumns.WIDGET_TYPE, String.valueOf(mWidgetType)); + mNote.setNoteValue(NoteColumns.WIDGET_TYPE, String.valueOf(mWidgetType)); // 更新数据库 } } - public void setWidgetId(int id) { + public void setWidgetId(int id) { // 设置组件id if (id != mWidgetId) { mWidgetId = id; - mNote.setNoteValue(NoteColumns.WIDGET_ID, String.valueOf(mWidgetId)); + mNote.setNoteValue(NoteColumns.WIDGET_ID, String.valueOf(mWidgetId)); // 更新数据库 } } - public void setWorkingText(String text) { + public void setWorkingText(String text) { // 设置文本 if (!TextUtils.equals(mContent, text)) { mContent = text; - mNote.setTextData(DataColumns.CONTENT, mContent); + mNote.setTextData(DataColumns.CONTENT, mContent); // 更新 } } - public void convertToCallNote(String phoneNumber, long callDate) { + 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)); + mNote.setNoteValue(NoteColumns.PARENT_ID, String.valueOf(Notes.ID_CALL_RECORD_FOLDER)); // 修改父文件夹id为呼叫记录id } 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); - } + } // 获取背景资源id public int getBgColorId() { return mBgColorId; - } + } // 获取背景颜色id public int getTitleBgResId() { return NoteBgResources.getNoteTitleBgResource(mBgColorId); - } + } // 获取标题栏背景颜色资源id public int getCheckListMode() { return mMode; - } + } // 获取检查清单模式 public long getNoteId() { return mNoteId; - } + } // 获取便签id public long getFolderId() { return mFolderId; - } + } // 获取父文件夹id public int getWidgetId() { return mWidgetId; - } + } // 获取组件id public int getWidgetType() { return mWidgetType; - } + } // 获取组件类型 - public interface NoteSettingChangedListener { + public interface NoteSettingChangedListener { // 接口 /** * Called when the background color of current note has just changed */ - void onBackgroundColorChanged(); + void onBackgroundColorChanged(); // 便签背景颜色变化时启动 /** * Called when user set clock */ - void onClockAlertChanged(long date, boolean set); + void onClockAlertChanged(long date, boolean set); // 设置提醒时间时启动 /** * Call when user create note from widget */ - void onWidgetChanged(); + 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); + void onCheckListModeChanged(int oldMode, int newMode); // 清单模式转为笔记模式时启动 } } diff --git a/src/tool/BackupUtils.java b/src/tool/BackupUtils.java index 39f6ec4..93ae8c8 100644 --- a/src/tool/BackupUtils.java +++ b/src/tool/BackupUtils.java @@ -33,8 +33,8 @@ import java.io.File; import java.io.FileNotFoundException; import java.io.FileOutputStream; import java.io.IOException; -import java.io.PrintStream; - +import java.io.PrintStream;////// +//添加包。类。对象等 public class BackupUtils { private static final String TAG = "BackupUtils"; @@ -42,9 +42,9 @@ public class BackupUtils { private static BackupUtils sInstance; public static synchronized BackupUtils getInstance(Context context) { - if (sInstance == null) { + if (sInstance == null) {//如果实例为空则创建新实例 sInstance = new BackupUtils(context); - } + }//返回实例 return sInstance; } @@ -72,19 +72,19 @@ public class BackupUtils { 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, @@ -93,11 +93,11 @@ public class BackupUtils { NoteColumns.TYPE }; - private static final int NOTE_COLUMN_ID = 0; + private static final int NOTE_COLUMN_ID = 0;//查询结果中笔记id所在列的索引 - private static final int NOTE_COLUMN_MODIFIED_DATE = 1; + private static final int NOTE_COLUMN_MODIFIED_DATE = 1;//查询结果中笔记上次修改时间所在的索引 - private static final int NOTE_COLUMN_SNIPPET = 2; + private static final int NOTE_COLUMN_SNIPPET = 2;//查询摘要所在索引 private static final String[] DATA_PROJECTION = { DataColumns.CONTENT, @@ -106,7 +106,7 @@ public class BackupUtils { DataColumns.DATA2, DataColumns.DATA3, DataColumns.DATA4, - }; + };//定义静态不可变数据列 private static final int DATA_COLUMN_CONTENT = 0; @@ -114,24 +114,24 @@ public class BackupUtils { private static final int DATA_COLUMN_CALL_DATE = 2; - private static final int DATA_COLUMN_PHONE_NUMBER = 4; + private static final int DATA_COLUMN_PHONE_NUMBER = 4;//定义以上数据列MIME类，呼叫日期，号码的索引初始值 - private final String [] TEXT_FORMAT; - private static final int FORMAT_FOLDER_NAME = 0; + private final String [] TEXT_FORMAT;//定义带有3个元素字符串数组TEXT_FORMAT + private static final int FORMAT_FOLDER_NAME = 0;//格式化后目录名称FORMAT_FOLDER_NAME= 0 private static final int FORMAT_NOTE_DATE = 1; - private static final int FORMAT_NOTE_CONTENT = 2; + private static final int FORMAT_NOTE_CONTENT = 2;//格式化后的笔记内容索引为2 - private Context mContext; - private String mFileName; - private String mFileDirectory; + private Context mContext;//声名Context类型和字符串类型 + private String mFileName;//文件名称 + private String mFileDirectory;//文件目录路径 public TextExport(Context context) { - TEXT_FORMAT = context.getResources().getStringArray(R.array.format_for_exported_note); + TEXT_FORMAT = context.getResources().getStringArray(R.array.format_for_exported_note);//初始化文件名称变量为控字符串 mContext = context; mFileName = ""; mFileDirectory = ""; - } - + }//初始化文件路径mFileDirectory = ""为空 +//创建TextExport对象 private String getFormat(int id) { return TEXT_FORMAT[id]; } @@ -166,39 +166,39 @@ public class BackupUtils { * Export note identified by id to a print stream */ private void exportNoteToText(String noteId, PrintStream ps) { - Cursor dataCursor = mContext.getContentResolver().query(Notes.CONTENT_DATA_URI, + Cursor dataCursor = mContext.getContentResolver().query(Notes.CONTENT_DATA_URI,//查询CONTENT_DATA_URI对应的数据表 DATA_PROJECTION, DataColumns.NOTE_ID + "=?", new String[] { noteId }, null); - - if (dataCursor != null) { - if (dataCursor.moveToFirst()) { +//使用DataColumns.NOTE_ID是否为？限制查询条件，并查询noted对应的数据行 + if (dataCursor != null) {//若查询不为空，则执行以下代码： + if (dataCursor.moveToFirst()) {//移动游标为第一条记录并循环记录 do { - String mimeType = dataCursor.getString(DATA_COLUMN_MIME_TYPE); + String mimeType = dataCursor.getString(DATA_COLUMN_MIME_TYPE);//获取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); + String location = dataCursor.getString(DATA_COLUMN_CONTENT);//从记录中获取phonenumber和calldate的值并输出号码 - if (!TextUtils.isEmpty(phoneNumber)) { + if (!TextUtils.isEmpty(phoneNumber)) {//若电话号码不为空 ps.println(String.format(getFormat(FORMAT_NOTE_CONTENT), - phoneNumber)); + phoneNumber));//输出电话号码输出到PrintStream实例PS中 } // Print call date ps.println(String.format(getFormat(FORMAT_NOTE_CONTENT), DateFormat .format(mContext.getString(R.string.format_datetime_mdhm), - callDate))); + callDate)));//输出通话日期信息到PrintStream中 // Print call attachment location - if (!TextUtils.isEmpty(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); + }//输出位置信息到PrintStream实例PS中 + } else if (DataConstants.NOTE.equals(mimeType)) {//若数据类型为Note，则执行以下语句 + String content = dataCursor.getString(DATA_COLUMN_CONTENT);//从Cursor中获取信息 if (!TextUtils.isEmpty(content)) { ps.println(String.format(getFormat(FORMAT_NOTE_CONTENT), - content)); + content));//将内容信息格式化输出rintStream实例PS中 } } } while (dataCursor.moveToNext()); @@ -210,74 +210,74 @@ public class BackupUtils { ps.write(new byte[] { Character.LINE_SEPARATOR, Character.LETTER_NUMBER }); - } catch (IOException e) { + } catch (IOException e) {//若出现IO异常，则廖永Log类的e（）方法将异常信息输出日志中 Log.e(TAG, e.toString()); } } - +//使用rintStream实例PS的write（）方法写入字节数组到输出流中，包括换行和字母数字 /** * Note will be exported as text which is user readable */ - public int exportToText() { + public int exportToText() {//定义exportToText()，返回值类型为整型 if (!externalStorageAvailable()) { Log.d(TAG, "Media was not mounted"); return STATE_SD_CARD_UNMOUONTED; } - - PrintStream ps = getExportToTextPrintStream(); +//若外部存储不可用，输出日记信息，返回表示Media was not mounted + PrintStream ps = getExportToTextPrintStream();//获取打印输出 if (ps == null) { Log.e(TAG, "get print stream error"); return STATE_SYSTEM_ERROR; - } + }//若获取不到打印输出，输出get print stream error"，并返回错误 // First export folder and its notes - Cursor folderCursor = mContext.getContentResolver().query( + Cursor folderCursor = mContext.getContentResolver().query(//声名Cursor类的变量folder，存储调查结果 Notes.CONTENT_NOTE_URI, - NOTE_PROJECTION, + NOTE_PROJECTION,//调用getContentResolver()，查询目标为Note表中数据和NOTE_PROJECTION指定列 "(" + NoteColumns.TYPE + "=" + Notes.TYPE_FOLDER + " AND " + NoteColumns.PARENT_ID + "<>" + Notes.ID_TRASH_FOLER + ") OR " + NoteColumns.ID + "=" + Notes.ID_CALL_RECORD_FOLDER, null, null); - - if (folderCursor != null) { +//限定查询条件为文件夹且父类文件夹不是回收站 + if (folderCursor != null) {//判断folder是否为空 if (folderCursor.moveToFirst()) { do { // Print folder's name - String folderName = ""; + String folderName = "";//遍历查询文件夹中所有文件夹记录 if(folderCursor.getLong(NOTE_COLUMN_ID) == Notes.ID_CALL_RECORD_FOLDER) { - folderName = mContext.getString(R.string.call_record_folder_name); - } else { + folderName = mContext.getString(R.string.call_record_folder_name);//若记录对应通话记录文件夹，给folder赋值Notes.ID_CALL_RECORD_FOLDER + } else {//否则folder赋值为记录的摘要字段值 folderName = folderCursor.getString(NOTE_COLUMN_SNIPPET); } if (!TextUtils.isEmpty(folderName)) { ps.println(String.format(getFormat(FORMAT_FOLDER_NAME), folderName)); } - String folderId = folderCursor.getString(NOTE_COLUMN_ID); + String folderId = folderCursor.getString(NOTE_COLUMN_ID);//获取当前记录对应文件夹id并赋值给folder exportFolderToText(folderId, ps); - } while (folderCursor.moveToNext()); + } while (folderCursor.moveToNext());//将当前记录文件夹导出为文本形式，结果写入PS中 } folderCursor.close(); } // Export notes in root's folder - Cursor noteCursor = mContext.getContentResolver().query( - Notes.CONTENT_NOTE_URI, - NOTE_PROJECTION, + Cursor noteCursor = mContext.getContentResolver().query(//通过getContentResolver()获取resolver对象，并调用querty方法查询 + Notes.CONTENT_NOTE_URI,//查询URI + NOTE_PROJECTION,//查询列 NoteColumns.TYPE + "=" + +Notes.TYPE_NOTE + " AND " + NoteColumns.PARENT_ID - + "=0", null, null); + + "=0", null, null);//限制查询类型为Notes.TYPE_NOTE，且父id为0的note记录 if (noteCursor != null) { - if (noteCursor.moveToFirst()) { + 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)))); + 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()); - } + }//或i去当前Note记录的id，吧id对应数据写入输出流中 noteCursor.close(); } - ps.close(); + ps.close();//关闭游标 return STATE_SUCCESS; } @@ -286,21 +286,21 @@ public class BackupUtils { * Get a print stream pointed to the file {@generateExportedTextFile} */ private PrintStream getExportToTextPrintStream() { - File file = generateFileMountedOnSDcard(mContext, R.string.file_path, + File file = generateFileMountedOnSDcard(mContext, R.string.file_path,//使用getExportToTextPrintStream()再sd卡上生成指定名称和路径的文本文件 R.string.file_name_txt_format); if (file == null) { Log.e(TAG, "create file to exported failed"); - return null; + return null;//若生成文件失败，返回null，再logcat输出错误信息 } mFileName = file.getName(); - mFileDirectory = mContext.getString(R.string.file_path); + mFileDirectory = mContext.getString(R.string.file_path);//将成功创建文件保存为FoleNAMe，路径柏村委mFileDiectory PrintStream ps = null; try { FileOutputStream fos = new FileOutputStream(file); - ps = new PrintStream(fos); - } catch (FileNotFoundException e) { + ps = new PrintStream(fos);//创建对象fos，用于写入文件 + } catch (FileNotFoundException e) {//使用fos创建PrintStream对象PS，一边向文件夹写入数据 e.printStackTrace(); - return null; + return null;//若无法找到写入目标文件，再logcat输出错误信息，并返回null } catch (NullPointerException e) { e.printStackTrace(); return null; @@ -314,28 +314,28 @@ public class BackupUtils { */ private static File generateFileMountedOnSDcard(Context context, int filePathResId, int fileNameFormatResId) { StringBuilder sb = new StringBuilder(); - sb.append(Environment.getExternalStorageDirectory()); + sb.append(Environment.getExternalStorageDirectory());//再strtingbuilder中添加SD卡根目录路径 sb.append(context.getString(filePathResId)); - File filedir = new File(sb.toString()); + File filedir = new File(sb.toString());//添加文件路径字符串资源id，并返回file对象表示该目录 sb.append(context.getString( fileNameFormatResId, DateFormat.format(context.getString(R.string.format_date_ymd), - System.currentTimeMillis()))); + System.currentTimeMillis())));//再StringBuilder添加文件名格式字符串资源id，并使用dateFormat替换为当前日期格式化字符串 File file = new File(sb.toString()); - +//返回表示最终创建的文件夹对象 try { if (!filedir.exists()) { filedir.mkdir(); - } + }//判断指定目录是否存在，若不存在创建 if (!file.exists()) { file.createNewFile(); - } - return file; + }//判断指定目录是否存在，若不存在创建 + return file;//返回创建对象 } catch (SecurityException e) { e.printStackTrace(); } catch (IOException e) { e.printStackTrace(); - } + }//如果不能在指定目录下创建新的文件，则抛出IOException异常 return null; } diff --git a/src/tool/DataUtils.java b/src/tool/DataUtils.java index 2a14982..665e0a2 100644 --- a/src/tool/DataUtils.java +++ b/src/tool/DataUtils.java @@ -25,18 +25,18 @@ import android.content.OperationApplicationException; import android.database.Cursor; import android.os.RemoteException; import android.util.Log; - +//导入android 包content、database等 import net.micode.notes.data.Notes; import net.micode.notes.data.Notes.CallNote; import net.micode.notes.data.Notes.NoteColumns; import net.micode.notes.ui.NotesListAdapter.AppWidgetAttribute; - +//导入net-micode包下数据 import java.util.ArrayList; import java.util.HashSet; +//导入JAVA ArrayList和HashSet类 - -public class DataUtils { - public static final String TAG = "DataUtils"; +public class DataUtils {//对DataUtils类进行定义 + public static final String TAG = "DataUtils";//定义静态不可变字TAG符串常量"DataUtils" public static boolean batchDeleteNotes(ContentResolver resolver, HashSet ids) { if (ids == null) { Log.d(TAG, "the ids is null"); @@ -46,69 +46,71 @@ public class DataUtils { Log.d(TAG, "no id is in the hashset"); return true; } - + //定义批量删除笔记。若ids参数为null，输出"the ids is null"并返回true；若ids参数为0，输出"no id is in the hashset"并返回true ArrayList operationList = new ArrayList(); - for (long id : ids) { + //定义操作列表，存储ContentProviderOperation对象 + for (long id : ids) {//遍历id列表 if(id == Notes.ID_ROOT_FOLDER) { Log.e(TAG, "Don't delete system folder root"); continue; - } + }//如果id为系统根目录，打印"不要删除系统根目录"并进行下一次循环 ContentProviderOperation.Builder builder = ContentProviderOperation .newDelete(ContentUris.withAppendedId(Notes.CONTENT_NOTE_URI, id)); - operationList.add(builder.build()); + operationList.add(builder.build());//创造builder对象，删除指定id的ContentProviderOperation } - try { + try {//调用applybatch ContentProviderResult[] results = resolver.applyBatch(Notes.AUTHORITY, operationList); if (results == null || results.length == 0 || results[0] == null) { Log.d(TAG, "delete notes failed, ids:" + ids.toString()); return false; } - return true; + return true;//若返回为空或第一个结果为null，输出删除失败返回false，否则返回true } catch (RemoteException e) { Log.e(TAG, String.format("%s: %s", e.toString(), e.getMessage())); } catch (OperationApplicationException e) { Log.e(TAG, String.format("%s: %s", e.toString(), e.getMessage())); - } + }//若remoteexeption或operationapplicationexception异常，返回false 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); + ContentValues values = new ContentValues();//创建contentValues对象 + values.put(NoteColumns.PARENT_ID, desFolderId);//移动笔记至目标文件夹 + 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) { + long folderId) {//若ids为空，打印log并返回true if (ids == null) { Log.d(TAG, "the ids is null"); return true; } ArrayList operationList = new ArrayList(); - for (long id : ids) { + for (long id : ids) {//遍历笔记id集合 ContentProviderOperation.Builder builder = ContentProviderOperation .newUpdate(ContentUris.withAppendedId(Notes.CONTENT_NOTE_URI, id)); - builder.withValue(NoteColumns.PARENT_ID, folderId); - builder.withValue(NoteColumns.LOCAL_MODIFIED, 1); - operationList.add(builder.build()); + builder.withValue(NoteColumns.PARENT_ID, folderId);//移动笔记至目标文件夹 + 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) { + ContentProviderResult[] results = resolver.applyBatch(Notes.AUTHORITY, operationList);//应用操作列表 + if (results == null || results.length == 0 || results[0] == null) {//如果结果为空或者第一个结果为空，打印log并返回false Log.d(TAG, "delete notes failed, ids:" + ids.toString()); return false; } - return true; - } catch (RemoteException e) { + return true;//true表示操作成功 + } catch (RemoteException e) {//捕获远程异常 Log.e(TAG, String.format("%s: %s", e.toString(), e.getMessage())); - } catch (OperationApplicationException e) { + } catch (OperationApplicationException e) {//捕获操作异常 Log.e(TAG, String.format("%s: %s", e.toString(), e.getMessage())); } - return false; + return false;//false表示操作失败 } /** @@ -134,7 +136,7 @@ public class DataUtils { } } return count; - } + }//检查笔记是否在数据库中可见，若不可见输出"get folder count failed:" public static boolean visibleInNoteDatabase(ContentResolver resolver, long noteId, int type) { Cursor cursor = resolver.query(ContentUris.withAppendedId(Notes.CONTENT_NOTE_URI, noteId), @@ -152,7 +154,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); @@ -166,7 +168,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); @@ -198,6 +200,7 @@ public class DataUtils { } public static HashSet getFolderNoteWidget(ContentResolver resolver, long folderId) { + //查询文件夹中所有小部件id和类型 Cursor c = resolver.query(Notes.CONTENT_NOTE_URI, new String[] { NoteColumns.WIDGET_ID, NoteColumns.WIDGET_TYPE }, NoteColumns.PARENT_ID + "=?", @@ -208,6 +211,7 @@ public class DataUtils { if (c != null) { if (c.moveToFirst()) { set = new HashSet(); + //遍历查询结果，将小部件id和类型存入hashSET中 do { try { AppWidgetAttribute widget = new AppWidgetAttribute(); @@ -220,11 +224,11 @@ public class DataUtils { } while (c.moveToNext()); } c.close(); - } + }//返回文件夹中所有小部件HashSet集合 return set; } - public static String getCallNumberByNoteId(ContentResolver resolver, long noteId) { + public static String getCallNumberByNoteId(ContentResolver resolver, long noteId) {//获取一段笔记的getCallNumberByNoteId Cursor cursor = resolver.query(Notes.CONTENT_DATA_URI, new String [] { CallNote.PHONE_NUMBER }, CallNote.NOTE_ID + "=? AND " + CallNote.MIME_TYPE + "=?", @@ -234,20 +238,21 @@ public class DataUtils { if (cursor != null && cursor.moveToFirst()) { try { return cursor.getString(0); - } catch (IndexOutOfBoundsException e) { - Log.e(TAG, "Get call number fails " + e.toString()); + } catch (IndexOutOfBoundsException e) {//如果查询结果不为空且有数据，则返回该行的电话号码 + Log.e(TAG, "Get call number fails " + e.toString());//如果获取电话号码失败，则打印错误日志 } finally { cursor.close(); - } + } //关闭游标，释放资源 } - return ""; + return "";//如果没有查询结果，则返回空串 } public static long getNoteIdByPhoneNumberAndCallDate(ContentResolver resolver, String phoneNumber, long callDate) { - Cursor cursor = resolver.query(Notes.CONTENT_DATA_URI, - new String [] { CallNote.NOTE_ID }, + //使用ContentResover对象来查询数据，并返回Cursor对象 + Cursor cursor = resolver.query(Notes.CONTENT_DATA_URI,//查询Note id字段 + new String [] { CallNote.NOTE_ID },//通过童话日期，电话号码扽给查询 CallNote.CALL_DATE + "=? AND " + CallNote.MIME_TYPE + "=? AND PHONE_NUMBERS_EQUAL(" - + CallNote.PHONE_NUMBER + ",?)", + + CallNote.PHONE_NUMBER + ",?)",//传入查询参数 new String [] { String.valueOf(callDate), CallNote.CONTENT_ITEM_TYPE, phoneNumber }, null); @@ -264,8 +269,8 @@ public class DataUtils { return 0; } - public static String getSnippetById(ContentResolver resolver, long noteId) { - Cursor cursor = resolver.query(Notes.CONTENT_NOTE_URI, + public static String getSnippetById(ContentResolver resolver, long noteId) {//使用ContentResovler对象查询数据，返回Cursor对象 + Cursor cursor = resolver.query(Notes.CONTENT_NOTE_URI,//查询snippet字段 new String [] { NoteColumns.SNIPPET }, NoteColumns.ID + "=?", new String [] { String.valueOf(noteId)}, @@ -273,14 +278,14 @@ public class DataUtils { if (cursor != null) { String snippet = ""; - if (cursor.moveToFirst()) { + if (cursor.moveToFirst()) {//获取查询结果中第0列的值，即snippet字段值 snippet = cursor.getString(0); } cursor.close(); return snippet; } throw new IllegalArgumentException("Note is not found with id: " + noteId); - } + }//通过noteld获取信息，返回字符串 public static String getFormattedSnippet(String snippet) { if (snippet != null) { diff --git a/src/tool/GTaskStringUtils.java b/src/tool/GTaskStringUtils.java index 666b729..d5dabb0 100644 --- a/src/tool/GTaskStringUtils.java +++ b/src/tool/GTaskStringUtils.java @@ -18,96 +18,96 @@ 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_ID = "action_id";//定义字符串常量，在类的外部直接访问，表示"action_id"的字符串键名 - public final static String GTASK_JSON_ACTION_LIST = "action_list"; + public final static String GTASK_JSON_ACTION_LIST = "action_list";//定义字符串常量，在类的外部直接访问，表示"action_list的字符串键名 - public final static String GTASK_JSON_ACTION_TYPE = "action_type"; + public final static String GTASK_JSON_ACTION_TYPE = "action_type";//定义字符串常量，在类的外部直接访问，表示action_type的字符串键名 - public final static String GTASK_JSON_ACTION_TYPE_CREATE = "create"; + public final static String GTASK_JSON_ACTION_TYPE_CREATE = "create";//定义字符串常量，在类的外部直接访问，表示create的字符串键名 - public final static String GTASK_JSON_ACTION_TYPE_GETALL = "get_all"; + public final static String GTASK_JSON_ACTION_TYPE_GETALL = "get_all";//定义字符串常量，在类的外部直接访问，表示get_all的字符串键名 - public final static String GTASK_JSON_ACTION_TYPE_MOVE = "move"; + public final static String GTASK_JSON_ACTION_TYPE_MOVE = "move";//定义字符串常量，在类的外部直接访问，表示"move的字符串键名 - public final static String GTASK_JSON_ACTION_TYPE_UPDATE = "update"; + public final static String GTASK_JSON_ACTION_TYPE_UPDATE = "update";//定义字符串常量，在类的外部直接访问，表示update的字符串键名 - public final static String GTASK_JSON_CREATOR_ID = "creator_id"; + public final static String GTASK_JSON_CREATOR_ID = "creator_id";//定义字符串常量，在类的外部直接访问，表示creator_id的字符串键名 - public final static String GTASK_JSON_CHILD_ENTITY = "child_entity"; + public final static String GTASK_JSON_CHILD_ENTITY = "child_entity";//定义字符串常量，在类的外部直接访问，表示child_entity的字符串键名 - public final static String GTASK_JSON_CLIENT_VERSION = "client_version"; + public final static String GTASK_JSON_CLIENT_VERSION = "client_version";//定义字符串常量，在类的外部直接访问，表示client_version的字符串键名 - public final static String GTASK_JSON_COMPLETED = "completed"; + public final static String GTASK_JSON_COMPLETED = "completed";//定义字符串常量，在类的外部直接访问，表示completed的字符串键名 public final static String GTASK_JSON_CURRENT_LIST_ID = "current_list_id"; + //定义字符串常量，在类的外部直接访问，表示current_list_id的字符串键名 + public final static String GTASK_JSON_DEFAULT_LIST_ID = "default_list_id";//定义字符串常量，在类的外部直接访问，表示default_list_id的字符串键名 - public final static String GTASK_JSON_DEFAULT_LIST_ID = "default_list_id"; + public final static String GTASK_JSON_DELETED = "deleted";//定义字符串常量，在类的外部直接访问，表示deleted的字符串键名 - public final static String GTASK_JSON_DELETED = "deleted"; + public final static String GTASK_JSON_DEST_LIST = "dest_list";//定义字符串常量，在类的外部直接访问，表示dest_list的字符串键名 - public final static String GTASK_JSON_DEST_LIST = "dest_list"; + public final static String GTASK_JSON_DEST_PARENT = "dest_parent";//定义字符串常量，在类的外部直接访问，表示dest_parent的字符串键名 - public final static String GTASK_JSON_DEST_PARENT = "dest_parent"; + public final static String GTASK_JSON_DEST_PARENT_TYPE = "dest_parent_type";//定义字符串常量，在类的外部直接访问，表示dest_parent_type的字符串键名 - public final static String GTASK_JSON_DEST_PARENT_TYPE = "dest_parent_type"; + public final static String GTASK_JSON_ENTITY_DELTA = "entity_delta";//定义字符串常量，在类的外部直接访问，表示entity_delta的字符串键名 - 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_ENTITY_TYPE = "entity_type";//定义字符串常量，在类的外部直接访问，表示entity_type的字符串键名 public final static String GTASK_JSON_GET_DELETED = "get_deleted"; + //定义字符串常量，在类的外部直接访问，表示get_deleted的字符串键名 + public final static String GTASK_JSON_ID = "id";//定义字符串常量，在类的外部直接访问，表示id的字符串键名 - public final static String GTASK_JSON_ID = "id"; - - public final static String GTASK_JSON_INDEX = "index"; + public final static String GTASK_JSON_INDEX = "index";//定义字符串常量，在类的外部直接访问，表示index的字符串键名 - public final static String GTASK_JSON_LAST_MODIFIED = "last_modified"; + public final static String GTASK_JSON_LAST_MODIFIED = "last_modified";//定义字符串常量，在类的外部直接访问，表示last_modified的字符串键名 - public final static String GTASK_JSON_LATEST_SYNC_POINT = "latest_sync_point"; + public final static String GTASK_JSON_LATEST_SYNC_POINT = "latest_sync_point";//定义字符串常量，在类的外部直接访问，表示latest_sync_point的字符串键名 - public final static String GTASK_JSON_LIST_ID = "list_id"; + public final static String GTASK_JSON_LIST_ID = "list_id";//定义字符串常量，在类的外部直接访问，表示list_id的字符串键名 - public final static String GTASK_JSON_LISTS = "lists"; + public final static String GTASK_JSON_LISTS = "lists";//定义字符串常量，在类的外部直接访问，表示lists的字符串键名 - public final static String GTASK_JSON_NAME = "name"; + public final static String GTASK_JSON_NAME = "name";//定义字符串常量，在类的外部直接访问，表示name的字符串键名 public final static String GTASK_JSON_NEW_ID = "new_id"; + //定义字符串常量，在类的外部直接访问，表示new_id的字符串键名 + public final static String GTASK_JSON_NOTES = "notes";//定义字符串常量，在类的外部直接访问，表示notes的字符串键名 - public final static String GTASK_JSON_NOTES = "notes"; - - public final static String GTASK_JSON_PARENT_ID = "parent_id"; + public final static String GTASK_JSON_PARENT_ID = "parent_id";//定义字符串常量，在类的外部直接访问，表示parent_id的字符串键名 - public final static String GTASK_JSON_PRIOR_SIBLING_ID = "prior_sibling_id"; + public final static String GTASK_JSON_PRIOR_SIBLING_ID = "prior_sibling_id";//定义字符串常量，在类的外部直接访问，表示prior_sibling_id的字符串键名 - public final static String GTASK_JSON_RESULTS = "results"; + public final static String GTASK_JSON_RESULTS = "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_TASKS = "tasks";//定义字符串常量，在类的外部直接访问，表示tasks的字符串键名 - public final static String GTASK_JSON_TYPE = "type"; + public final static String GTASK_JSON_TYPE = "type";//定义字符串常量，在类的外部直接访问，表示type的字符串键名 - public final static String GTASK_JSON_TYPE_GROUP = "GROUP"; + public final static String GTASK_JSON_TYPE_GROUP = "GROUP";//定义字符串常量，在类的外部直接访问，表示GROUP的字符串键名 - public final static String GTASK_JSON_TYPE_TASK = "TASK"; + public final static String GTASK_JSON_TYPE_TASK = "TASK";//定义字符串常量，在类的外部直接访问，表示TASK的字符串键名 - public final static String GTASK_JSON_USER = "user"; + public final static String GTASK_JSON_USER = "user";//定义字符串常量，在类的外部直接访问，表示user的字符串键名 - public final static String MIUI_FOLDER_PREFFIX = "[MIUI_Notes]"; + public final static String MIUI_FOLDER_PREFFIX = "[MIUI_Notes]";//定义字符串常量，在类的外部直接访问，表示MIUI_Notes的字符串键名 - public final static String FOLDER_DEFAULT = "Default"; + public final static String FOLDER_DEFAULT = "Default";//定义字符串常量，在类的外部直接访问，表示Default的字符串键名 - public final static String FOLDER_CALL_NOTE = "Call_Note"; + public final static String FOLDER_CALL_NOTE = "Call_Note";//定义字符串常量，在类的外部直接访问，表示Call_Note的字符串键名 - public final static String FOLDER_META = "METADATA"; + public final static String FOLDER_META = "METADATA";//定义字符串常量，在类的外部直接访问，表示METADATA的字符串键名 - public final static String META_HEAD_GTASK_ID = "meta_gid"; + public final static String META_HEAD_GTASK_ID = "meta_gid";//定义字符串常量，在类的外部直接访问，表示meta_gid的字符串键名 - public final static String META_HEAD_NOTE = "meta_note"; + public final static String META_HEAD_NOTE = "meta_note";//定义字符串常量，在类的外部直接访问，表示meta_note的字符串键名 - public final static String META_HEAD_DATA = "meta_data"; + public final static String META_HEAD_DATA = "meta_data";//定义字符串常量，在类的外部直接访问，表示meta_data的字符串键名 - public final static String META_NOTE_NAME = "[META INFO] DON'T UPDATE AND DELETE"; + public final static String META_NOTE_NAME = "[META INFO] DON'T UPDATE AND DELETE";//定义字符串常量，在类的外部直接访问，表示[META INFO] DON'T UPDATE AND DELETE的字符串键名 } diff --git a/src/tool/ResourceParser.java b/src/tool/ResourceParser.java index 1ad3ad6..86fab8f 100644 --- a/src/tool/ResourceParser.java +++ b/src/tool/ResourceParser.java @@ -22,22 +22,22 @@ import android.preference.PreferenceManager; import net.micode.notes.R; import net.micode.notes.ui.NotesPreferenceActivity; -public class ResourceParser { - - public static final int YELLOW = 0; - public static final int BLUE = 1; - public static final int WHITE = 2; +public class ResourceParser { +//定义常量，用于表示颜色和字体大小 + public static final int YELLOW = 0;//黄色 + public static final int BLUE = 1;//蓝 + public static final int WHITE = 2;//bai public static final int GREEN = 3; public static final int RED = 4; - public static final int BG_DEFAULT_COLOR = YELLOW; + public static final int BG_DEFAULT_COLOR = YELLOW;//默认背景颜色为黄色 - public static final int TEXT_SMALL = 0; - public static final int TEXT_MEDIUM = 1; - public static final int TEXT_LARGE = 2; - public static final int TEXT_SUPER = 3; + public static final int TEXT_SMALL = 0;//字体小号 + public static final int TEXT_MEDIUM = 1;//中 + public static final int TEXT_LARGE = 2;//da + public static final int TEXT_SUPER = 3;//chaoda - public static final int BG_DEFAULT_FONT_SIZE = TEXT_MEDIUM; + public static final int BG_DEFAULT_FONT_SIZE = TEXT_MEDIUM;//默认大小为中 public static class NoteBgResources { private final static int [] BG_EDIT_RESOURCES = new int [] { @@ -46,7 +46,7 @@ public class ResourceParser { R.drawable.edit_white, R.drawable.edit_green, R.drawable.edit_red - }; + };//定义私有静态常量G_EDIT_RESOURCES ，用于储存图片资源id private final static int [] BG_EDIT_TITLE_RESOURCES = new int [] { R.drawable.edit_title_yellow, @@ -54,7 +54,7 @@ public class ResourceParser { R.drawable.edit_title_white, R.drawable.edit_title_green, R.drawable.edit_title_red - }; + };//定义另一个私有静态常量，用于储存笔记编辑页面标题背景资源id public static int getNoteBgResource(int id) { return BG_EDIT_RESOURCES[id]; @@ -63,40 +63,40 @@ public class ResourceParser { public static int getNoteTitleBgResource(int id) { return BG_EDIT_TITLE_RESOURCES[id]; } - } + }//初始化编辑页面标题背景资源id - public static int getDefaultBgId(Context context) { + 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); } else { - return BG_DEFAULT_COLOR; + return BG_DEFAULT_COLOR;//若没有定义，返回默认颜色白色 } } public static class NoteItemBgResources { - private final static int [] BG_FIRST_RESOURCES = new int [] { - R.drawable.list_yellow_up, - R.drawable.list_blue_up, - R.drawable.list_white_up, - R.drawable.list_green_up, - R.drawable.list_red_up + private final static int [] BG_FIRST_RESOURCES = new int [] {//定义final整型数组 BG_FIRST_RESOURCES + R.drawable.list_yellow_up,//黄色背景上边框图案id + R.drawable.list_blue_up,//蓝色背景上边框图案id + R.drawable.list_white_up,//白色背景边框图案id + R.drawable.list_green_up,//绿色背景边框图案id + R.drawable.list_red_up//红色背景边框图案id }; 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,//黄色背景中间边框图案id + R.drawable.list_blue_middle,//蓝色背景中间边框图案id + R.drawable.list_white_middle,//白色背景中间边框图案id + R.drawable.list_green_middle,//绿色背景中间边框图案id + R.drawable.list_red_middle//红色背景中间边框图案id }; 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,//黄色背景中下间边框图案id + R.drawable.list_blue_down,//蓝色背景中下间边框图案id + R.drawable.list_white_down,//白色背景中下间边框图案id + R.drawable.list_green_down,//绿色背景中下间边框图案id + R.drawable.list_red_down,//红色背景中下间边框图案id }; private final static int [] BG_SINGLE_RESOURCES = new int [] { @@ -110,33 +110,30 @@ public class ResourceParser { public static int getNoteBgFirstRes(int id) { return BG_FIRST_RESOURCES[id]; } - +//定义getNoteBgFirstRes方法，用于返回G_FIRST_RESOURCES[id] public static int getNoteBgLastRes(int id) { return BG_LAST_RESOURCES[id]; } - +//定义getNoteBgLastRes方法，用于返回 BG_LAST_RESOURCES[id] public static int getNoteBgSingleRes(int id) { return BG_SINGLE_RESOURCES[id]; } - + //定义getNoteBgSingleRes方法，用于返回BG_SINGLE_RESOURCES[id] public static int getNoteBgNormalRes(int id) { return BG_NORMAL_RESOURCES[id]; } - - public static int getFolderBgRes() { - return R.drawable.list_folder; - } + //定义etNoteBgNormalRes方法，用于返回BG_NORMAL_RESOURCES[id] + public static int getFolderBgRes() {return R.drawable.list_folder;}//定义getFolderBgRes方法，用于返回 R.drawable.list_folder } - public static class WidgetBgResources { + public static class WidgetBgResources {//定义静态内部类WidgetBgResources private final static int [] BG_2X_RESOURCES = new int [] { R.drawable.widget_2x_yellow, R.drawable.widget_2x_blue, R.drawable.widget_2x_white, R.drawable.widget_2x_green, R.drawable.widget_2x_red, - }; - + };// 管理小部件2x2格式不同颜色资源图片 public static int getWidget2xBgResource(int id) { return BG_2X_RESOURCES[id]; } @@ -147,20 +144,20 @@ public class ResourceParser { 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 { + public static class TextAppearanceResources {//定义TextAppearanceResources 静态内部类 private final static int [] TEXTAPPEARANCE_RESOURCES = new int [] { R.style.TextAppearanceNormal, R.style.TextAppearanceMedium, R.style.TextAppearanceLarge, R.style.TextAppearanceSuper - }; + };//分别对应中等，大号，超大的文本外观样式 public static int getTexAppearanceResource(int id) { /** diff --git a/src/ui/AlarmAlertActivity.java b/src/ui/AlarmAlertActivity.java index 85723be..75de484 100644 --- a/src/ui/AlarmAlertActivity.java +++ b/src/ui/AlarmAlertActivity.java @@ -41,30 +41,42 @@ 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; + private long mNoteId; //用于存储笔记Id + private String mSnippet; //用于存储笔记内容摘要 + private static final int SNIPPET_PREW_MAX_LEN = 60;//限制笔记长度 MediaPlayer mPlayer; + + //onCreate() 函数在 Activity 初始化时调用，用于初始化 + //savedInstanceState 该参数用于恢复 Activity 状态。 @Override protected void onCreate(Bundle savedInstanceState) { super.onCreate(savedInstanceState); + + //界面显示：无标题 requestWindowFeature(Window.FEATURE_NO_TITLE); + //获取 Window 对象，添加 FLAG_SHOW_WHEN_LOCKED 标记 final Window win = getWindow(); win.addFlags(WindowManager.LayoutParams.FLAG_SHOW_WHEN_LOCKED); + //如果屏幕没亮，添加一系列 屏幕唤醒标记 if (!isScreenOn()) { - win.addFlags(WindowManager.LayoutParams.FLAG_KEEP_SCREEN_ON - | WindowManager.LayoutParams.FLAG_TURN_SCREEN_ON - | WindowManager.LayoutParams.FLAG_ALLOW_LOCK_WHILE_SCREEN_ON + win.addFlags(WindowManager.LayoutParams.FLAG_KEEP_SCREEN_ON //保持窗口常亮 + | WindowManager.LayoutParams.FLAG_TURN_SCREEN_ON //点亮窗口 + | WindowManager.LayoutParams.FLAG_ALLOW_LOCK_WHILE_SCREEN_ON //允许在窗口点亮时锁屏 | WindowManager.LayoutParams.FLAG_LAYOUT_INSET_DECOR); } + //获取Intent对象 Intent intent = getIntent(); + //从Intent对象中获取笔记的 Id 和内容 try { mNoteId = Long.valueOf(intent.getData().getPathSegments().get(1)); + + //根据便签Id从数据库中获取便签内容 + //getContentResolver() 实现数据共享，实例存储 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) @@ -74,6 +86,7 @@ public class AlarmAlertActivity extends Activity implements OnClickListener, OnD return; } + //创建 MediaPlayer 对象，根据笔记是否存在数据库中来展示操作对话框或者直接退出 mPlayer = new MediaPlayer(); if (DataUtils.visibleInNoteDatabase(getContentResolver(), mNoteId, Notes.TYPE_NOTE)) { showActionDialog(); @@ -83,29 +96,38 @@ public class AlarmAlertActivity extends Activity implements OnClickListener, OnD } } + //用于判断屏幕是否被唤醒（亮着） private boolean isScreenOn() { PowerManager pm = (PowerManager) getSystemService(Context.POWER_SERVICE); return pm.isScreenOn(); } + //用于实现报警铃声的播放 private void playAlarmSound() { + //获取系统默认的铃声 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); } try { - mPlayer.setDataSource(this, url); - mPlayer.prepare(); - mPlayer.setLooping(true); - mPlayer.start(); + mPlayer.setDataSource(this, url); //设置报警铃声 + mPlayer.prepare(); //准备同步 + mPlayer.setLooping(true); //设置循环播放 + mPlayer.start(); //开始播放 } catch (IllegalArgumentException e) { // TODO Auto-generated catch block + + //以下的 e.printStackTrace() 函数功能是抛出异常，还将显示出更深的调用信息 e.printStackTrace(); } catch (SecurityException e) { // TODO Auto-generated catch block @@ -119,32 +141,52 @@ public class AlarmAlertActivity extends Activity implements OnClickListener, OnD } } + + //创建一个对话框，标题为app的名字，内容为mSnippet，确定按钮为notealert_ok， + // 当屏幕开启时，取消按钮为notealert_enter，点击弹出框外部可以隐藏弹出框 private void showActionDialog() { AlertDialog.Builder dialog = new AlertDialog.Builder(this); + //为对话框设置标题 dialog.setTitle(R.string.app_name); + //为对话框设置内容 dialog.setMessage(mSnippet); + //给对话框添加“OK”按钮 dialog.setPositiveButton(R.string.notealert_ok, this); + if (isScreenOn()) { + //给对话框添加“CANCEL”按钮 dialog.setNegativeButton(R.string.notealert_enter, this); } + //给对话框设置监听器 dialog.show().setOnDismissListener(this); } + //当对话框界面内某个按钮被点击时调用以下方法 + // 接收 对话框界面 和 点击的按钮位置which 为参数 public void onClick(DialogInterface dialog, int which) { + //switch语句，根据按钮位置的不同，执行不同的操作 switch (which) { + //当点击点击的是返回按键 case DialogInterface.BUTTON_NEGATIVE: + //将编辑的便签内容传输到特定类中 Intent intent = new Intent(this, NoteEditActivity.class); + //设置操作属性 intent.setAction(Intent.ACTION_VIEW); + //创建一个特定的Note Id传输给便签 intent.putExtra(Intent.EXTRA_UID, mNoteId); + //开始操作 startActivity(intent); break; + //如果是其他按钮被点击则不执行任何操作 default: break; } } public void onDismiss(DialogInterface dialog) { + //终止报警声音 stopAlarmSound(); + //完成动作 finish(); } @@ -152,6 +194,7 @@ public class AlarmAlertActivity extends Activity implements OnClickListener, OnD if (mPlayer != null) { mPlayer.stop(); mPlayer.release(); + //释放 MediaPlayer(媒体播放器)对象 mPlayer = null; } } diff --git a/src/ui/AlarmInitReceiver.java b/src/ui/AlarmInitReceiver.java index f221202..edd2b85 100644 --- a/src/ui/AlarmInitReceiver.java +++ b/src/ui/AlarmInitReceiver.java @@ -28,8 +28,10 @@ import net.micode.notes.data.Notes; import net.micode.notes.data.Notes.NoteColumns; +//定时向用户推送闹钟提醒 public class AlarmInitReceiver extends BroadcastReceiver { + //对数据库的操作，调用笔记Id和时钟时间 private static final String [] PROJECTION = new String [] { NoteColumns.ID, NoteColumns.ALERTED_DATE @@ -38,16 +40,23 @@ public class AlarmInitReceiver extends BroadcastReceiver { private static final int COLUMN_ID = 0; private static final int COLUMN_ALERTED_DATE = 1; + //重写 BroadcastReceiver 的 onReceive 方法 @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); + //当查询结果不为空时 if (c != null) { + // 如果有符合要求的记录，就遍历每一条记录 if (c.moveToFirst()) { do { long alertDate = c.getLong(COLUMN_ALERTED_DATE); diff --git a/src/ui/AlarmReceiver.java b/src/ui/AlarmReceiver.java index 54e503b..1b4d096 100644 --- a/src/ui/AlarmReceiver.java +++ b/src/ui/AlarmReceiver.java @@ -24,6 +24,8 @@ public class AlarmReceiver extends BroadcastReceiver { @Override public void onReceive(Context context, Intent intent) { intent.setClass(context, AlarmAlertActivity.class); + + //为intent对象添加一个标志，表示它将启动一个新的任务栈 intent.addFlags(Intent.FLAG_ACTIVITY_NEW_TASK); context.startActivity(intent); } diff --git a/src/ui/DateTimePicker.java b/src/ui/DateTimePicker.java index 496b0cd..ab88e69 100644 --- a/src/ui/DateTimePicker.java +++ b/src/ui/DateTimePicker.java @@ -30,6 +30,7 @@ import android.widget.NumberPicker; public class DateTimePicker extends FrameLayout { + //初始化控件 private static final boolean DEFAULT_ENABLE_STATE = true; private static final int HOURS_IN_HALF_DAY = 12; @@ -46,11 +47,12 @@ public class DateTimePicker extends FrameLayout { 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 Calendar mDate; //用于操作时间 private String[] mDateDisplayValues = new String[DAYS_IN_ALL_WEEK]; @@ -64,7 +66,20 @@ public class DateTimePicker extends FrameLayout { private OnDateTimeChangedListener mOnDateTimeChangedListener; + /* + 设置时间选择器的监听器， + 包括了日期选择器的监听器 mOnDateChangedListener， + 小时选择器的监听器 mOnHourChangedListener， + 分钟选择器的监听器mOnMinuteChangedListener， + 上午和下午选择器的监听器 mOnAmPmChangedListener + + */ + + + //日期选择器的监听器 private NumberPicker.OnValueChangeListener mOnDateChangedListener = new NumberPicker.OnValueChangeListener() { + + //将目前的日期传给 mDate，updateDateControl是同步操作 @Override public void onValueChange(NumberPicker picker, int oldVal, int newVal) { mDate.add(Calendar.DAY_OF_YEAR, newVal - oldVal); @@ -73,39 +88,58 @@ public class DateTimePicker extends FrameLayout { } }; + //选择器的监听器 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小时制时，晚上11点和12点交替时对日期的更改 if (!mIsAm && oldVal == HOURS_IN_HALF_DAY - 1 && newVal == HOURS_IN_HALF_DAY) { cal.setTimeInMillis(mDate.getTimeInMillis()); cal.add(Calendar.DAY_OF_YEAR, 1); isDateChanged = true; - } else if (mIsAm && oldVal == HOURS_IN_HALF_DAY && newVal == HOURS_IN_HALF_DAY - 1) { + } + + //这里是对于12小时制时，凌晨11点和12点交替时对日期的更改 + else if (mIsAm && oldVal == HOURS_IN_HALF_DAY && newVal == HOURS_IN_HALF_DAY - 1) { cal.setTimeInMillis(mDate.getTimeInMillis()); cal.add(Calendar.DAY_OF_YEAR, -1); isDateChanged = true; } + + //这里是对于12小时制时，中午11点和12点交替时对AM和PM的更改 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(); } } else { + + //这里是对于24小时制时，晚上11点和12点交替时对日期的更改 if (oldVal == HOURS_IN_ALL_DAY - 1 && newVal == 0) { cal.setTimeInMillis(mDate.getTimeInMillis()); cal.add(Calendar.DAY_OF_YEAR, 1); isDateChanged = true; - } else if (oldVal == 0 && newVal == HOURS_IN_ALL_DAY - 1) { + } + + //这里是对于24小时制时，凌晨11点和12点交替时对日期的更改 + else if (oldVal == 0 && newVal == HOURS_IN_ALL_DAY - 1) { cal.setTimeInMillis(mDate.getTimeInMillis()); cal.add(Calendar.DAY_OF_YEAR, -1); isDateChanged = true; } } + + //用数字选择器给 newHour 赋值 int newHour = mHourSpinner.getValue() % HOURS_IN_HALF_DAY + (mIsAm ? 0 : HOURS_IN_HALF_DAY); + + //将新的Hour值传给mDate mDate.set(Calendar.HOUR_OF_DAY, newHour); + onDateTimeChanged(); if (isDateChanged) { setCurrentYear(cal.get(Calendar.YEAR)); @@ -115,12 +149,13 @@ 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; + int offset = 0; //设置一个小时改变的记录数据 if (oldVal == maxValue && newVal == minValue) { offset += 1; } else if (oldVal == minValue && newVal == maxValue) { @@ -144,6 +179,7 @@ public class DateTimePicker extends FrameLayout { } }; + // 上午和下午选择器的监听器 private NumberPicker.OnValueChangeListener mOnAmPmChangedListener = new NumberPicker.OnValueChangeListener() { @Override public void onValueChange(NumberPicker picker, int oldVal, int newVal) { @@ -163,34 +199,43 @@ public class DateTimePicker extends FrameLayout { int dayOfMonth, int hourOfDay, int minute); } + // 通过对数据库的访问，获取当前系统时间 public DateTimePicker(Context context) { this(context, System.currentTimeMillis()); } + // 获得一个天文数字（1970年至今的秒数），需要DateFormat将其变得有意义 public DateTimePicker(Context context, long date) { this(context, date, DateFormat.is24HourFormat(context)); } public DateTimePicker(Context context, long date, boolean is24HourView) { - super(context); + super(context);//获取系统时间 mDate = Calendar.getInstance(); mInitialising = true; mIsAm = getCurrentHourOfDay() >= HOURS_IN_HALF_DAY; + + //在控件中填充R.layout.datetime_picker布局 inflate(context, R.layout.datetime_picker, this); + //获取年月日Spinner，设置最小值和最大值，设置值改变监听 mDateSpinner = (NumberPicker) findViewById(R.id.date); mDateSpinner.setMinValue(DATE_SPINNER_MIN_VAL); mDateSpinner.setMaxValue(DATE_SPINNER_MAX_VAL); mDateSpinner.setOnValueChangedListener(mOnDateChangedListener); + // 获取时Spinner，设置值改变监听 mHourSpinner = (NumberPicker) findViewById(R.id.hour); mHourSpinner.setOnValueChangedListener(mOnHourChangedListener); + + // 获取分Spinner，设置最小值、最大值、长按更新间隔和值改变监听 mMinuteSpinner = (NumberPicker) findViewById(R.id.minute); mMinuteSpinner.setMinValue(MINUT_SPINNER_MIN_VAL); mMinuteSpinner.setMaxValue(MINUT_SPINNER_MAX_VAL); mMinuteSpinner.setOnLongPressUpdateInterval(100); mMinuteSpinner.setOnValueChangedListener(mOnMinuteChangedListener); + // 获取上午/下午Spinner，设置最小值、最大值、显示值和值改变监听 String[] stringsForAmPm = new DateFormatSymbols().getAmPmStrings(); mAmPmSpinner = (NumberPicker) findViewById(R.id.amPm); mAmPmSpinner.setMinValue(AMPM_SPINNER_MIN_VAL); @@ -214,8 +259,12 @@ public class DateTimePicker extends FrameLayout { mInitialising = false; } + // 设置控件及其子控件的可用状态 @Override public void setEnabled(boolean enabled) { + + // 如果mIsEnabled变量与传入的enabled相同，则不进行操作， + // 否则将控件及其子控件的可用状态更新为enabled并更新mIsEnabled变量。 if (mIsEnabled == enabled) { return; } @@ -434,6 +483,7 @@ public class DateTimePicker extends FrameLayout { updateAmPmControl(); } + // 更新日期控件，根据当前日期更新展示的日期列表 private void updateDateControl() { Calendar cal = Calendar.getInstance(); cal.setTimeInMillis(mDate.getTimeInMillis()); @@ -448,6 +498,8 @@ public class DateTimePicker extends FrameLayout { mDateSpinner.invalidate(); } + // 更新上午/下午控件，如果是24小时制，则隐藏此控件； + // 否则根据当前选择的时间更新展示的上午/下午选项 private void updateAmPmControl() { if (mIs24HourView) { mAmPmSpinner.setVisibility(View.GONE); @@ -458,6 +510,7 @@ public class DateTimePicker extends FrameLayout { } } + // 更新小时控件，根据当前选择的时间更新展示的小时选项 private void updateHourControl() { if (mIs24HourView) { mHourSpinner.setMinValue(HOUR_SPINNER_MIN_VAL_24_HOUR_VIEW); diff --git a/src/ui/DateTimePickerDialog.java b/src/ui/DateTimePickerDialog.java index 2c47ba4..be8d4ae 100644 --- a/src/ui/DateTimePickerDialog.java +++ b/src/ui/DateTimePickerDialog.java @@ -31,37 +31,52 @@ import android.text.format.DateUtils; public class DateTimePickerDialog extends AlertDialog implements OnClickListener { - private Calendar mDate = Calendar.getInstance(); + private Calendar mDate = Calendar.getInstance();//便于时间操作 private boolean mIs24HourView; - private OnDateTimeSetListener mOnDateTimeSetListener; - private DateTimePicker mDateTimePicker; + private OnDateTimeSetListener mOnDateTimeSetListener;//时间日期滚动控件 + private DateTimePicker mDateTimePicker;//用于设置或获取日期和时间 public interface OnDateTimeSetListener { + + //在选择日期后返回结果 void OnDateTimeSet(AlertDialog dialog, long date); } public DateTimePickerDialog(Context context, long date) { super(context); mDateTimePicker = new DateTimePicker(context); - setView(mDateTimePicker); + 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); + + mDate.setTimeInMillis(date);// 初始化mDate对象 + mDate.set(Calendar.SECOND, 0);// 将秒数设为0 mDateTimePicker.setCurrentDate(mDate.getTimeInMillis()); + + // 为对话框设置一个确定按钮 setButton(context.getString(R.string.datetime_dialog_ok), this); + + // 为对话框设置一个取消按钮，传入null为点击事件处理器 setButton2(context.getString(R.string.datetime_dialog_cancel), (OnClickListener)null); + + //根据当前的时间的时间格式设置是否使用24小时制显示时间 set24HourView(DateFormat.is24HourFormat(this.getContext())); - updateTitle(mDate.getTimeInMillis()); + updateTitle(mDate.getTimeInMillis());// 更新对话框的标题为初始日期和时间 } public void set24HourView(boolean is24HourView) { @@ -73,15 +88,24 @@ public class DateTimePickerDialog extends AlertDialog implements OnClickListener } private void updateTitle(long date) { + + // 定义一个标识变量，用于根据给定的日期时间更新标题栏的显示 int flag = DateUtils.FORMAT_SHOW_YEAR | DateUtils.FORMAT_SHOW_DATE | DateUtils.FORMAT_SHOW_TIME; + + // 根据用户选择的，决定是否使用24小时制 flag |= mIs24HourView ? DateUtils.FORMAT_24HOUR : DateUtils.FORMAT_24HOUR; + + // 将日期转化为字符串，并设置标题 setTitle(DateUtils.formatDateTime(this.getContext(), date, flag)); } + // 用于处理对话框的点击事件 public void onClick(DialogInterface arg0, int arg1) { + + // 如果有日期时间设置监听器，则传递当前日期时间 if (mOnDateTimeSetListener != null) { mOnDateTimeSetListener.OnDateTimeSet(this, mDate.getTimeInMillis()); } diff --git a/src/ui/DropdownMenu.java b/src/ui/DropdownMenu.java index 613dc74..0cdbfbc 100644 --- a/src/ui/DropdownMenu.java +++ b/src/ui/DropdownMenu.java @@ -28,16 +28,23 @@ import android.widget.PopupMenu.OnMenuItemClickListener; import net.micode.notes.R; public class DropdownMenu { + // 定义一个按钮，用于显示和触发下拉菜单 private Button mButton; + // 定义一个弹出菜单，用于显示菜单项 private PopupMenu mPopupMenu; + // 定义一个菜单类，用于存储菜单项 private Menu mMenu; public DropdownMenu(Context context, Button button, int menuId) { mButton = button; + // 设置背景为下拉图标 mButton.setBackgroundResource(R.drawable.dropdown_icon); + // 初始化弹出菜单，并绑定按钮对象 mPopupMenu = new PopupMenu(context, mButton); + // 获取菜单对象，加载菜单资源 mMenu = mPopupMenu.getMenu(); mPopupMenu.getMenuInflater().inflate(menuId, mMenu); + // 设置点击监听器，点击时弹出菜单 mButton.setOnClickListener(new OnClickListener() { public void onClick(View v) { mPopupMenu.show(); @@ -45,16 +52,20 @@ public class DropdownMenu { }); } + // 用于设置下拉菜单点击监听器 public void setOnDropdownMenuItemClickListener(OnMenuItemClickListener listener) { + // 如果弹出菜单不为空则为其设置监听器 if (mPopupMenu != null) { mPopupMenu.setOnMenuItemClickListener(listener); } } + // 可根据id查找菜单项 public MenuItem findItem(int id) { return mMenu.findItem(id); } + // 用于设置按钮标题 public void setTitle(CharSequence title) { mButton.setText(title); } diff --git a/src/ui/FoldersListAdapter.java b/src/ui/FoldersListAdapter.java index 96b77da..930f65d 100644 --- a/src/ui/FoldersListAdapter.java +++ b/src/ui/FoldersListAdapter.java @@ -29,27 +29,35 @@ import net.micode.notes.data.Notes; import net.micode.notes.data.Notes.NoteColumns; +// 指定每个列表项的布局模板，指定Cursor中的每个字段应该绑定到那些视图上 +// 以文件夹的形式展现给用户 public class FoldersListAdapter extends CursorAdapter { + // 指定查询时返回的列，NoteColumns是一个接口 public static final String [] PROJECTION = { NoteColumns.ID, NoteColumns.SNIPPET }; + // 定义查询文件夹表是返回的列的索引 public static final int ID_COLUMN = 0; public static final int NAME_COLUMN = 1; + // 在列表视图中显示文件夹数据 public FoldersListAdapter(Context context, Cursor c) { super(context, c); // TODO Auto-generated constructor stub } + // 创建一个新视图，并初始化子标签 @Override public View newView(Context context, Cursor cursor, ViewGroup parent) { return new FolderListItem(context); } + // 用于绑定视图和数据 @Override public void bindView(View view, Context context, Cursor cursor) { + // 判断视图对象是否为 FolderListItem 的实例 if (view instanceof FolderListItem) { String folderName = (cursor.getLong(ID_COLUMN) == Notes.ID_ROOT_FOLDER) ? context .getString(R.string.menu_move_parent_folder) : cursor.getString(NAME_COLUMN); @@ -57,21 +65,27 @@ public class FoldersListAdapter extends CursorAdapter { } } + // 获取对应文件夹名称 public String getFolderName(Context context, int position) { Cursor cursor = (Cursor) getItem(position); + // 根据文件夹id获取文件夹的名称 return (cursor.getLong(ID_COLUMN) == Notes.ID_ROOT_FOLDER) ? context .getString(R.string.menu_move_parent_folder) : cursor.getString(NAME_COLUMN); } + // 用于显示文件夹名称 private class FolderListItem extends LinearLayout { private TextView mName; public FolderListItem(Context context) { super(context); + // 将布局文件加载到当前视图 inflate(context, R.layout.folder_list_item, this); + // 将获取到的TextView对象赋值给mName mName = (TextView) findViewById(R.id.tv_folder_name); } + // 将给定的名称设置到mName中 public void bind(String name) { mName.setText(name); } diff --git a/src/ui/NoteEditActivity.java b/src/ui/NoteEditActivity.java index 96a9ff8..689fb1f 100644 --- a/src/ui/NoteEditActivity.java +++ b/src/ui/NoteEditActivity.java @@ -74,16 +74,19 @@ import java.util.regex.Pattern; public class NoteEditActivity extends Activity implements OnClickListener, NoteSettingChangedListener, OnTextViewChangeListener { + // 头部视图空间 private class HeadViewHolder { + // 文本视图，显示修改的日期 public TextView tvModified; - + // 图像视图，显示警告图标 public ImageView ivAlertIcon; - + // 文本视图，显示警告日期 public TextView tvAlertDate; - + // 图像按钮，用于设置背景颜色 public ImageView ibSetBgColor; } + // 用于存储不同背景选择按钮的id和对应颜色 private static final Map sBgSelectorBtnsMap = new HashMap(); static { sBgSelectorBtnsMap.put(R.id.iv_bg_yellow, ResourceParser.YELLOW); @@ -93,6 +96,7 @@ public class NoteEditActivity extends Activity implements OnClickListener, sBgSelectorBtnsMap.put(R.id.iv_bg_white, ResourceParser.WHITE); } + // 用于存储不同颜色值和对应的背景选择器的id private static final Map sBgSelectorSelectionMap = new HashMap(); static { sBgSelectorSelectionMap.put(ResourceParser.YELLOW, R.id.iv_bg_yellow_select); @@ -102,6 +106,7 @@ public class NoteEditActivity extends Activity implements OnClickListener, sBgSelectorSelectionMap.put(ResourceParser.WHITE, R.id.iv_bg_white_select); } + // 用于存储不同字体大小按钮id和对应的字体大小 private static final Map sFontSizeBtnsMap = new HashMap(); static { sFontSizeBtnsMap.put(R.id.ll_font_large, ResourceParser.TEXT_LARGE); @@ -110,6 +115,7 @@ public class NoteEditActivity extends Activity implements OnClickListener, sFontSizeBtnsMap.put(R.id.ll_font_super, ResourceParser.TEXT_SUPER); } + // 用于存储不同字体大小和对应的字体选择器的id private static final Map sFontSelectorSelectionMap = new HashMap(); static { sFontSelectorSelectionMap.put(ResourceParser.TEXT_LARGE, R.id.iv_large_select); @@ -119,45 +125,53 @@ public class NoteEditActivity extends Activity implements OnClickListener, } 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 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; + // 在活动创建时进行一些初始化操作 @Override protected void onCreate(Bundle savedInstanceState) { super.onCreate(savedInstanceState); this.setContentView(R.layout.note_edit); + // 如果传入的参数为空，且调用initActivityState方法传入getIntent方法返回的Intent对象返回false， + // 表示活动状态初始化失败，结束活动 if (savedInstanceState == null && !initActivityState(getIntent())) { finish(); return; } + // 初始化一些资源 initResources(); } @@ -165,20 +179,27 @@ public class NoteEditActivity extends Activity implements OnClickListener, * 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 */ + // 为防止内存不足时程序的终止，在这里有一个保存现场的函数 + // 用于在活动恢复时执行一些操作 @Override protected void onRestoreInstanceState(Bundle savedInstanceState) { super.onRestoreInstanceState(savedInstanceState); if (savedInstanceState != null && savedInstanceState.containsKey(Intent.EXTRA_UID)) { + // 创建一个新的Intent对象，设置其动作为Intent.ACTION_VIEW Intent intent = new Intent(Intent.ACTION_VIEW); + // 将Intent.EXTRA_UID作为额外数据放入intent对象中 intent.putExtra(Intent.EXTRA_UID, savedInstanceState.getLong(Intent.EXTRA_UID)); + // 如果初始化活动失败则结束活动 if (!initActivityState(intent)) { finish(); return; } + // 打印一条调试信息，表示从被杀死的活动中恢复 Log.d(TAG, "Restoring from killed activity"); } } + // 用于返回活动初始化状态 private boolean initActivityState(Intent intent) { /** * If the user specified the {@link Intent#ACTION_VIEW} but not provided with id, @@ -192,25 +213,30 @@ public class NoteEditActivity extends Activity implements OnClickListener, /** * Starting from the searched result */ + // 根据键值查找ID if (intent.hasExtra(SearchManager.EXTRA_DATA_KEY)) { noteId = Long.parseLong(intent.getStringExtra(SearchManager.EXTRA_DATA_KEY)); mUserQuery = intent.getStringExtra(SearchManager.USER_QUERY); } - + // 如果在内容提供者中，noteId对应的笔记不可见或者不是笔记类型 if (!DataUtils.visibleInNoteDatabase(getContentResolver(), noteId, Notes.TYPE_NOTE)) { Intent jump = new Intent(this, NotesListActivity.class); + //程序将跳转到上面声明的intent——jump startActivity(jump); showToast(R.string.error_note_not_exist); finish(); return false; } else { + // 否则向 load函数 传入当前活动和noteId作为参数，返回一个WorkingNote对象 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); @@ -243,6 +269,7 @@ public class NoteEditActivity extends Activity implements OnClickListener, } else { mWorkingNote = WorkingNote.createEmptyNote(this, folderId, widgetId, widgetType, bgResId); + // 将空笔记转换为通话笔记 mWorkingNote.convertToCallNote(phoneNumber, callDate); } } else { @@ -258,6 +285,7 @@ public class NoteEditActivity extends Activity implements OnClickListener, finish(); return false; } + // 设置其设置状态为改变监听器 mWorkingNote.setOnSettingStatusChangedListener(this); return true; } @@ -268,9 +296,12 @@ public class NoteEditActivity extends Activity implements OnClickListener, initNoteScreen(); } + // 用于初始化笔记的界面和功能 private void initNoteScreen() { + // 设置笔记编辑器的文字外观，根据字体大小的id选择合适的资源 mNoteEditor.setTextAppearance(this, TextAppearanceResources .getTexAppearanceResource(mFontSizeId)); + // 设置外观 if (mWorkingNote.getCheckListMode() == TextNote.MODE_CHECK_LIST) { switchToListMode(mWorkingNote.getContent()); } else { @@ -295,18 +326,23 @@ public class NoteEditActivity extends Activity implements OnClickListener, 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); }; @@ -326,6 +362,8 @@ public class NoteEditActivity extends Activity implements OnClickListener, * generate a id. If the editing note is not worth saving, there * is no id which is equivalent to create new note */ + //在创建一个新的标签时，先在数据库中匹配 + //如果不存在，那么先在数据库中存储 if (!mWorkingNote.existInDatabase()) { saveNote(); } @@ -333,27 +371,32 @@ public class NoteEditActivity extends Activity implements OnClickListener, Log.d(TAG, "Save working note id: " + mWorkingNote.getNoteId() + " onSaveInstanceState"); } + //用于分发触摸事件到合适的视图中 @Override public boolean dispatchTouchEvent(MotionEvent ev) { + // 判断当前笔记的颜色选择器在屏幕上是否可见，且在可触控范围内 if (mNoteBgColorSelector.getVisibility() == View.VISIBLE && !inRangeOfView(mNoteBgColorSelector, ev)) { mNoteBgColorSelector.setVisibility(View.GONE); return true; } - + // 判断当前笔记的字体大小选择器是否可见，且在触控范围内 if (mFontSizeSelector.getVisibility() == View.VISIBLE && !inRangeOfView(mFontSizeSelector, ev)) { mFontSizeSelector.setVisibility(View.GONE); return true; } + // 如果两个选择器在屏幕都不可见，则重新分配触发事件 return super.dispatchTouchEvent(ev); } + // 对屏幕触控的坐标进行操作 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 @@ -363,6 +406,7 @@ public class NoteEditActivity extends Activity implements OnClickListener, return true; } + //对标签各项属性内容的初始化 private void initResources() { mHeadViewPanel = findViewById(R.id.note_title); mNoteHeaderHolder = new HeadViewHolder(); @@ -379,6 +423,7 @@ public class NoteEditActivity extends Activity implements OnClickListener, iv.setOnClickListener(this); } + //对字体大小的选择 mFontSizeSelector = findViewById(R.id.font_size_selector); for (int id : sFontSizeBtnsMap.keySet()) { View view = findViewById(id); @@ -400,12 +445,15 @@ public class NoteEditActivity extends Activity implements OnClickListener, @Override protected void onPause() { super.onPause(); + // 尝试保存当前笔记数据，并判断是否保持成功 if(saveNote()) { Log.d(TAG, "Note data was saved with length:" + mWorkingNote.getContent().length()); } + // 清除一些设置状态 clearSettingState(); } + // 与桌面小部件的内容和外观同步 private void updateWidget() { Intent intent = new Intent(AppWidgetManager.ACTION_APPWIDGET_UPDATE); if (mWorkingNote.getWidgetType() == Notes.TYPE_WIDGET_2X) { @@ -425,8 +473,11 @@ public class NoteEditActivity extends Activity implements OnClickListener, setResult(RESULT_OK, intent); } + // 在一个视图被点击时调用 public void onClick(View v) { + // 获取被点击的视图的id int id = v.getId(); + // 如果是背景颜色的按钮，则将背景颜色选择器和当前笔记背景颜色对应的视图设为可见 if (id == R.id.btn_set_bg_color) { mNoteBgColorSelector.setVisibility(View.VISIBLE); findViewById(sBgSelectorSelectionMap.get(mWorkingNote.getBgColorId())).setVisibility( @@ -452,6 +503,7 @@ public class NoteEditActivity extends Activity implements OnClickListener, } } + // 当按下返回键时执行操作 @Override public void onBackPressed() { if(clearSettingState()) { @@ -462,6 +514,7 @@ public class NoteEditActivity extends Activity implements OnClickListener, super.onBackPressed(); } + // 用于清除一些设置状态 private boolean clearSettingState() { if (mNoteBgColorSelector.getVisibility() == View.VISIBLE) { mNoteBgColorSelector.setVisibility(View.GONE); @@ -473,6 +526,7 @@ public class NoteEditActivity extends Activity implements OnClickListener, return false; } + // 在改变背景颜色时执行的操作 public void onBackgroundColorChanged() { findViewById(sBgSelectorSelectionMap.get(mWorkingNote.getBgColorId())).setVisibility( View.VISIBLE); @@ -480,38 +534,53 @@ public class NoteEditActivity extends Activity implements OnClickListener, mHeadViewPanel.setBackgroundResource(mWorkingNote.getTitleBgResId()); } + // 在准备选择菜单执行的操作 @Override public boolean onPrepareOptionsMenu(Menu menu) { + // 判断Activity是否正在结束 if (isFinishing()) { return true; } clearSettingState(); + // 清空菜单所有项目 menu.clear(); + // 判断当前笔记的文件夹id是否是通话记录文件夹的id 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; } + // 当选择菜单中的某个项目被点击调用时的操作 @Override public boolean onOptionsItemSelected(MenuItem item) { + // 根据被点击项目的id，进行不同的处理 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); @@ -527,24 +596,30 @@ public class NoteEditActivity extends Activity implements OnClickListener, 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: + // 将当前笔记的提醒日期设置为0，并更新数据库 mWorkingNote.setAlertDate(0, false); break; default: @@ -553,13 +628,17 @@ public class NoteEditActivity extends Activity implements OnClickListener, return true; } + // 设置闹钟提醒 private void setReminder() { + // 用于显示日期时间选择器对话框 DateTimePickerDialog d = new DateTimePickerDialog(this, System.currentTimeMillis()); d.setOnDateTimeSetListener(new OnDateTimeSetListener() { + // 根据用户选择的日期时间，设置当前笔记的提醒日期，并更新数据库 public void OnDateTimeSet(AlertDialog dialog, long date) { mWorkingNote.setAlertDate(date , true); } }); + // 显示对话框，让用户选择一个日期时间 d.show(); } @@ -567,13 +646,17 @@ public class NoteEditActivity extends Activity implements OnClickListener, * Share note to apps that support {@link Intent#ACTION_SEND} action * and {@text/plain} type */ + // 与其他应用共享文本信息 private void sendTo(Context context, String info) { Intent intent = new Intent(Intent.ACTION_SEND); + // 将要共享的文本信息作为额外数据放入意图中 intent.putExtra(Intent.EXTRA_TEXT, info); intent.setType("text/plain"); + // 启动一个活动，让用户选择一个可以接收这个意图的应用 context.startActivity(intent); } + // 创建一个新便签 private void createNewNote() { // Firstly, save current editing notes saveNote(); @@ -586,15 +669,19 @@ public class NoteEditActivity extends Activity implements OnClickListener, startActivity(intent); } + // 删除当前便签 private void deleteCurrentNote() { + // 如果正在编辑的笔记存有数据 if (mWorkingNote.existInDatabase()) { HashSet ids = new HashSet(); long id = mWorkingNote.getNoteId(); + // 判断是否为根文件夹id 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"); @@ -608,10 +695,12 @@ public class NoteEditActivity extends Activity implements OnClickListener, mWorkingNote.markDeleted(true); } + // 判断是否是同步模式 private boolean isSyncMode() { return NotesPreferenceActivity.getSyncAccountName(this).trim().length() > 0; } + // 笔记闹钟提醒发生变化时调用, set 是是否设置提醒的标志 public void onClockAlertChanged(long date, boolean set) { /** * User could set clock to an unsaved note, so before setting the @@ -620,15 +709,22 @@ public class NoteEditActivity extends Activity implements OnClickListener, if (!mWorkingNote.existInDatabase()) { saveNote(); } + // 大于0,即保存到了数据库中,否则就是未保存到数据库 if (mWorkingNote.getNoteId() > 0) { + // 用于发送一个闹钟接收的广播，将当前笔记的uri作为数据放入意图中 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 { @@ -646,6 +742,7 @@ public class NoteEditActivity extends Activity implements OnClickListener, updateWidget(); } + // 在用户删除某个文本编辑器时，将被删除的文本内容追加到前面或者后面的文本编辑器中，并更新列表的索引值 public void onEditTextDelete(int index, String text) { int childCount = mEditTextList.getChildCount(); if (childCount == 1) { @@ -672,6 +769,10 @@ public class NoteEditActivity extends Activity implements OnClickListener, edit.setSelection(length); } + /* 在用户在某个文本编辑器中按下回车键时，创建一个新的文本编辑器， + * 并将当前的文本内容分割到两个文本编辑器中。 + * 实现在笔记应用中输入多行文本。 + */ public void onEditTextEnter(int index, String text) { /** * Should not happen, check for debug @@ -691,6 +792,7 @@ public class NoteEditActivity extends Activity implements OnClickListener, } } + // 将用户输入的文本转换成多个文本编辑器，以便用户在列表模式下编辑多行文本。 private void switchToListMode(String text) { mEditTextList.removeAllViews(); String[] items = text.split("\n"); @@ -708,6 +810,7 @@ public class NoteEditActivity extends Activity implements OnClickListener, mEditTextList.setVisibility(View.VISIBLE); } + // 将用户输入的搜索关键词在完整文本中高亮显示，以便用户快速定位到相关内容 private Spannable getHighlightQueryResult(String fullText, String userQuery) { SpannableString spannable = new SpannableString(fullText == null ? "" : fullText); if (!TextUtils.isEmpty(userQuery)) { @@ -725,6 +828,7 @@ public class NoteEditActivity extends Activity implements OnClickListener, return spannable; } + // 根据用户输入的文本内容和搜索关键词创建一个带有复选框和高亮效果的文本编辑器视图 private View getListItem(String item, int index) { View view = LayoutInflater.from(this).inflate(R.layout.note_edit_list_item, null); final NoteEditText edit = (NoteEditText) view.findViewById(R.id.et_edit_text); @@ -756,6 +860,7 @@ public class NoteEditActivity extends Activity implements OnClickListener, return view; } + // 根据用户在文本编辑器中输入或删除文本时，动态显示或隐藏复选框。 public void onTextChange(int index, boolean hasText) { if (index >= mEditTextList.getChildCount()) { Log.e(TAG, "Wrong index, should not happen"); @@ -768,6 +873,7 @@ public class NoteEditActivity extends Activity implements OnClickListener, } } + // 根据用户选择的模式，将文本编辑器从普通模式切换到列表模式，或者从列表模式切换到普通模式。 public void onCheckListModeChanged(int oldMode, int newMode) { if (newMode == TextNote.MODE_CHECK_LIST) { switchToListMode(mNoteEditor.getText().toString()); @@ -782,6 +888,7 @@ public class NoteEditActivity extends Activity implements OnClickListener, } } + // 根据笔记的模式，从文本编辑器或者文本编辑器列表中获取文本内容 private boolean getWorkingText() { boolean hasChecked = false; if (mWorkingNote.getCheckListMode() == TextNote.MODE_CHECK_LIST) { @@ -805,6 +912,7 @@ public class NoteEditActivity extends Activity implements OnClickListener, return hasChecked; } + // 用于保存一个笔记应用的文本内容 private boolean saveNote() { getWorkingText(); boolean saved = mWorkingNote.saveNote(); @@ -821,6 +929,7 @@ public class NoteEditActivity extends Activity implements OnClickListener, return saved; } + // 将笔记内容发送到桌面 private void sendToDesktop() { /** * Before send message to home, we should make sure that current @@ -856,6 +965,7 @@ public class NoteEditActivity extends Activity implements OnClickListener, } } + // 用于编辑小图标的标题 private String makeShortcutIconTitle(String content) { content = content.replace(TAG_CHECKED, ""); content = content.replace(TAG_UNCHECKED, ""); @@ -863,10 +973,12 @@ public class NoteEditActivity extends Activity implements OnClickListener, SHORTCUT_ICON_TITLE_MAX_LEN) : content; } + // 显示提示的视图 private void showToast(int resId) { showToast(resId, Toast.LENGTH_SHORT); } + // 持续显示提示视图 private void showToast(int resId, int duration) { Toast.makeText(this, resId, duration).show(); } diff --git a/src/ui/NoteEditText.java b/src/ui/NoteEditText.java index 2afe2a8..1f7235e 100644 --- a/src/ui/NoteEditText.java +++ b/src/ui/NoteEditText.java @@ -37,6 +37,7 @@ import net.micode.notes.R; import java.util.HashMap; import java.util.Map; +// 继承EditText，设置标签设置文本框 public class NoteEditText extends EditText { private static final String TAG = "NoteEditText"; private int mIndex; @@ -46,6 +47,7 @@ public class NoteEditText extends EditText { private static final String SCHEME_HTTP = "http:" ; private static final String SCHEME_EMAIL = "mailto:" ; + // 建立一个字符和整数的hash表，用于链接电话，网站，还有邮箱 private static final Map sSchemaActionResMap = new HashMap(); static { sSchemaActionResMap.put(SCHEME_TEL, R.string.note_link_tel); @@ -56,6 +58,7 @@ public class NoteEditText extends EditText { /** * Call by the {@link NoteEditActivity} to delete or add edit text */ + //在NoteEditActivity中删除或添加文本的操作，可以看做是一个文本是否被变的标记 public interface OnTextViewChangeListener { /** * Delete current edit text when {@link KeyEvent#KEYCODE_DEL} happens @@ -77,19 +80,22 @@ public class NoteEditText extends EditText { private OnTextViewChangeListener mOnTextViewChangeListener; + // 根据context设置文本 public NoteEditText(Context context) { super(context, null); mIndex = 0; } - + // 设置当前光标 public void setIndex(int index) { mIndex = index; } + // 初始化文本修改标记 public void setOnTextViewChangeListener(OnTextViewChangeListener listener) { mOnTextViewChangeListener = listener; } + // 初始化便签 public NoteEditText(Context context, AttributeSet attrs) { super(context, attrs, android.R.attr.editTextStyle); } @@ -99,6 +105,7 @@ public class NoteEditText extends EditText { // TODO Auto-generated constructor stub } + // 根据用户触摸的位置，获取对应的文本偏移量，并设置为选择状态。 @Override public boolean onTouchEvent(MotionEvent event) { switch (event.getAction()) { @@ -121,6 +128,7 @@ public class NoteEditText extends EditText { return super.onTouchEvent(event); } + // 处理用户按下一个键盘按键时会触发 的事件 @Override public boolean onKeyDown(int keyCode, KeyEvent event) { switch (keyCode) { @@ -138,11 +146,14 @@ public class NoteEditText extends EditText { return super.onKeyDown(keyCode, event); } + // 处理用户松开一个键盘按键时会触发 的事件 @Override public boolean onKeyUp(int keyCode, KeyEvent event) { switch(keyCode) { case KeyEvent.KEYCODE_DEL: + // 如果被修改过 if (mOnTextViewChangeListener != null) { + // 如果被修改过且文档不为空 if (0 == mSelectionStartBeforeDelete && mIndex != 0) { mOnTextViewChangeListener.onEditTextDelete(mIndex, getText().toString()); return true; @@ -167,9 +178,11 @@ public class NoteEditText extends EditText { return super.onKeyUp(keyCode, event); } + // 当焦点发生变化时，会自动调用该方法来处理焦点改变的事件 @Override protected void onFocusChanged(boolean focused, int direction, Rect previouslyFocusedRect) { if (mOnTextViewChangeListener != null) { + // 获取到焦点并且文本不为空 if (!focused && TextUtils.isEmpty(getText())) { mOnTextViewChangeListener.onTextChange(mIndex, false); } else { @@ -179,8 +192,10 @@ public class NoteEditText extends EditText { super.onFocusChanged(focused, direction, previouslyFocusedRect); } + // 生成上下文菜单 @Override protected void onCreateContextMenu(ContextMenu menu) { + // 如果有文本存在 if (getText() instanceof Spanned) { int selStart = getSelectionStart(); int selEnd = getSelectionEnd(); @@ -201,7 +216,7 @@ public class NoteEditText extends EditText { if (defaultResId == 0) { defaultResId = R.string.note_link_other; } - + // 建立菜单 menu.add(0, 0, 0, defaultResId).setOnMenuItemClickListener( new OnMenuItemClickListener() { public boolean onMenuItemClick(MenuItem item) { diff --git a/src/ui/NoteItemData.java b/src/ui/NoteItemData.java index 0f5a878..fe94192 100644 --- a/src/ui/NoteItemData.java +++ b/src/ui/NoteItemData.java @@ -26,6 +26,9 @@ import net.micode.notes.data.Notes.NoteColumns; import net.micode.notes.tool.DataUtils; +/*用于存储和操作一个笔记的id、标题、内容、创建时间、 +修改时间、背景颜色、字体大小、模式、文件夹id等信息。 + */ public class NoteItemData { static final String [] PROJECTION = new String [] { NoteColumns.ID, @@ -76,6 +79,7 @@ public class NoteItemData { private boolean mIsOneNoteFollowingFolder; private boolean mIsMultiNotesFollowingFolder; + // 初始化NoteItemData，主要利用光标cursor获取的东西 public NoteItemData(Context context, Cursor cursor) { mId = cursor.getLong(ID_COLUMN); mAlertDate = cursor.getLong(ALERTED_DATE_COLUMN); @@ -109,6 +113,7 @@ public class NoteItemData { checkPostion(cursor); } + // 根据鼠标的位置设置标记和位置 private void checkPostion(Cursor cursor) { mIsLastItem = cursor.isLast() ? true : false; mIsFirstItem = cursor.isFirst() ? true : false; @@ -214,6 +219,7 @@ public class NoteItemData { return (mAlertDate > 0); } + // 判断一个笔记是否是一个通话记录 public boolean isCallRecord() { return (mParentId == Notes.ID_CALL_RECORD_FOLDER && !TextUtils.isEmpty(mPhoneNumber)); } diff --git a/src/ui/NotesListAdapter.java b/src/ui/NotesListAdapter.java index 51c9cb9..af6f2fd 100644 --- a/src/ui/NotesListAdapter.java +++ b/src/ui/NotesListAdapter.java @@ -31,6 +31,7 @@ import java.util.HashSet; import java.util.Iterator; +// 用于创建笔记应用的列表适配器 public class NotesListAdapter extends CursorAdapter { private static final String TAG = "NotesListAdapter"; private Context mContext; @@ -55,6 +56,7 @@ public class NotesListAdapter extends CursorAdapter { return new NotesListItem(context); } + // 用于绑定视图和数据 @Override public void bindView(View view, Context context, Cursor cursor) { if (view instanceof NotesListItem) { @@ -64,20 +66,24 @@ public class NotesListAdapter extends CursorAdapter { } } + // 设置勾选框，并更新视图 public void setCheckedItem(final int position, final boolean checked) { mSelectedIndex.put(position, checked); notifyDataSetChanged(); } + // 判断单选按钮是否勾选 public boolean isInChoiceMode() { return mChoiceMode; } + // 设置单项选项框 public void setChoiceMode(boolean mode) { mSelectedIndex.clear(); mChoiceMode = mode; } + // 根据参数checked，选择或取消选择所有的便签项 public void selectAll(boolean checked) { Cursor cursor = getCursor(); for (int i = 0; i < getCount(); i++) { @@ -89,6 +95,7 @@ public class NotesListAdapter extends CursorAdapter { } } + // 获取所有选中的项的id public HashSet getSelectedItemIds() { HashSet itemSet = new HashSet(); for (Integer position : mSelectedIndex.keySet()) { @@ -105,6 +112,7 @@ public class NotesListAdapter extends CursorAdapter { return itemSet; } + // 获取所有选中的项的小部件属性 public HashSet getSelectedWidget() { HashSet itemSet = new HashSet(); for (Integer position : mSelectedIndex.keySet()) { @@ -128,6 +136,7 @@ public class NotesListAdapter extends CursorAdapter { return itemSet; } + // 获取选中的项的数量，并返回一个整数。 public int getSelectedCount() { Collection values = mSelectedIndex.values(); if (null == values) { @@ -143,11 +152,13 @@ public class NotesListAdapter extends CursorAdapter { return count; } + // 判断是否所有项都被选中 public boolean isAllSelected() { int checkedCount = getSelectedCount(); return (checkedCount != 0 && checkedCount == mNotesCount); } + // 判断是否被选中 public boolean isSelectedItem(final int position) { if (null == mSelectedIndex.get(position)) { return false; @@ -155,18 +166,21 @@ public class NotesListAdapter extends CursorAdapter { return mSelectedIndex.get(position); } + // 内容发生变化时，重新计算便签数量 @Override protected void onContentChanged() { super.onContentChanged(); calcNotesCount(); } + // 光标发生变动时，回调该函数计算便签数量 @Override public void changeCursor(Cursor cursor) { super.changeCursor(cursor); calcNotesCount(); } + // 计算便签数量 private void calcNotesCount() { mNotesCount = 0; for (int i = 0; i < getCount(); i++) { diff --git a/src/ui/NotesListItem.java b/src/ui/NotesListItem.java index 1221e80..dad78e7 100644 --- a/src/ui/NotesListItem.java +++ b/src/ui/NotesListItem.java @@ -30,6 +30,7 @@ import net.micode.notes.tool.DataUtils; import net.micode.notes.tool.ResourceParser.NoteItemBgResources; +//创建便签列表项目选项 public class NotesListItem extends LinearLayout { private ImageView mAlert; private TextView mTitle; @@ -38,6 +39,7 @@ public class NotesListItem extends LinearLayout { private NoteItemData mItemData; private CheckBox mCheckBox; + public NotesListItem(Context context) { super(context); inflate(context, R.layout.note_item, this); @@ -48,15 +50,20 @@ public class NotesListItem extends LinearLayout { mCheckBox = (CheckBox) findViewById(android.R.id.checkbox); } + // 绑定数据和视图 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); } else { mCheckBox.setVisibility(View.GONE); } mItemData = data; + // 根据数据的id和父id，设置不同的标题，时间，图标和呼叫名 if (data.getId() == Notes.ID_CALL_RECORD_FOLDER) { mCallName.setVisibility(View.GONE); mAlert.setVisibility(View.VISIBLE); @@ -99,6 +106,7 @@ public class NotesListItem extends LinearLayout { setBackground(data); } + // 根据传入的数据设置背景颜色 private void setBackground(NoteItemData data) { int id = data.getBgColorId(); if (data.getType() == Notes.TYPE_NOTE) { @@ -116,6 +124,7 @@ public class NotesListItem extends LinearLayout { } } + // 获取视图板顶的数据对象 public NoteItemData getItemData() { return mItemData; } diff --git a/src/ui/NotesPreferenceActivity.java b/src/ui/NotesPreferenceActivity.java index 07c5f7e..5134c10 100644 --- a/src/ui/NotesPreferenceActivity.java +++ b/src/ui/NotesPreferenceActivity.java @@ -69,6 +69,7 @@ public class NotesPreferenceActivity extends PreferenceActivity { private boolean mHasAddedAccount; + // 在活动创建时执行一些初始化操作 @Override protected void onCreate(Bundle icicle) { super.onCreate(icicle); @@ -76,6 +77,7 @@ public class NotesPreferenceActivity extends PreferenceActivity { /* using the app icon for navigation */ getActionBar().setDisplayHomeAsUpEnabled(true); + // 从xml文件中加载活动的偏好设置 addPreferencesFromResource(R.xml.preferences); mAccountCategory = (PreferenceCategory) findPreference(PREFERENCE_SYNC_ACCOUNT_KEY); mReceiver = new GTaskReceiver(); @@ -84,7 +86,9 @@ public class NotesPreferenceActivity extends PreferenceActivity { registerReceiver(mReceiver, filter); mOriAccounts = null; + // 从xml文件中加载了一个视图，并赋值给header这个局部变量 View header = LayoutInflater.from(this).inflate(R.layout.settings_header, null); + // 将这个视图添加到列表的头部 getListView().addHeaderView(header, null, true); } @@ -112,10 +116,11 @@ public class NotesPreferenceActivity extends PreferenceActivity { } } } - + // 刷新用户界面 refreshUI(); } + // 在活动销毁时执行一些清理操作 @Override protected void onDestroy() { if (mReceiver != null) { @@ -124,6 +129,7 @@ public class NotesPreferenceActivity extends PreferenceActivity { super.onDestroy(); } + // 加载账户相关的偏好设置 private void loadAccountPreference() { mAccountCategory.removeAll(); @@ -154,6 +160,7 @@ public class NotesPreferenceActivity extends PreferenceActivity { mAccountCategory.addPreference(accountPref); } + // 加载同步按钮和同步状态的显示 private void loadSyncButton() { Button syncButton = (Button) findViewById(R.id.preference_sync_button); TextView lastSyncTimeView = (TextView) findViewById(R.id.prefenerece_sync_status_textview); @@ -193,29 +200,35 @@ public class NotesPreferenceActivity extends PreferenceActivity { } } + // 刷新界面 private void refreshUI() { loadAccountPreference(); loadSyncButton(); } + // 显示账户选择的对话框并进行账户的设置 private void showSelectAccountAlertDialog() { AlertDialog.Builder dialogBuilder = new AlertDialog.Builder(this); + // 设置标题以及子标题内容 View titleView = LayoutInflater.from(this).inflate(R.layout.account_dialog_title, null); TextView titleTextView = (TextView) titleView.findViewById(R.id.account_dialog_title); titleTextView.setText(getString(R.string.preferences_dialog_select_account_title)); TextView subtitleTextView = (TextView) titleView.findViewById(R.id.account_dialog_subtitle); subtitleTextView.setText(getString(R.string.preferences_dialog_select_account_tips)); + // 设置对话框的自定义标题 dialogBuilder.setCustomTitle(titleView); dialogBuilder.setPositiveButton(null, null); + // 获取同步账户信息 Account[] accounts = getGoogleAccounts(); String defAccount = getSyncAccountName(this); mOriAccounts = accounts; mHasAddedAccount = false; + // 如果账户不为空 if (accounts.length > 0) { CharSequence[] items = new CharSequence[accounts.length]; final CharSequence[] itemMapping = items; @@ -227,8 +240,10 @@ public class NotesPreferenceActivity extends PreferenceActivity { } items[index++] = account.name; } + // 在对话框建立一个单选的复选框 dialogBuilder.setSingleChoiceItems(items, checkedItem, new DialogInterface.OnClickListener() { + //设置点击后执行的事件，包括检录新同步账户和刷新标签界面 public void onClick(DialogInterface dialog, int which) { setSyncAccount(itemMapping[which].toString()); dialog.dismiss(); @@ -254,15 +269,18 @@ public class NotesPreferenceActivity extends PreferenceActivity { }); } + // 显示一个更改账户的确认对话框 private void showChangeAccountConfirmAlertDialog() { AlertDialog.Builder dialogBuilder = new AlertDialog.Builder(this); + // 根据同步修改的账户信息设置标题以及子标题的内容 View titleView = LayoutInflater.from(this).inflate(R.layout.account_dialog_title, null); TextView titleTextView = (TextView) titleView.findViewById(R.id.account_dialog_title); titleTextView.setText(getString(R.string.preferences_dialog_change_account_title, getSyncAccountName(this))); TextView subtitleTextView = (TextView) titleView.findViewById(R.id.account_dialog_subtitle); subtitleTextView.setText(getString(R.string.preferences_dialog_change_account_warn_msg)); + // 设置对话框的自定义标题 dialogBuilder.setCustomTitle(titleView); CharSequence[] menuItemArray = new CharSequence[] { @@ -283,11 +301,13 @@ public class NotesPreferenceActivity extends PreferenceActivity { dialogBuilder.show(); } + // 获取谷歌账户 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); @@ -318,6 +338,7 @@ public class NotesPreferenceActivity extends PreferenceActivity { } } + // 删除同步账户 private void removeSyncAccount() { SharedPreferences settings = getSharedPreferences(PREFERENCE_NAME, Context.MODE_PRIVATE); SharedPreferences.Editor editor = settings.edit(); @@ -340,12 +361,14 @@ 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,12 +377,14 @@ 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); } + // 接收同步状态和信息 private class GTaskReceiver extends BroadcastReceiver { @Override @@ -374,6 +399,7 @@ public class NotesPreferenceActivity extends PreferenceActivity { } } + // 处理菜单选项 public boolean onOptionsItemSelected(MenuItem item) { switch (item.getItemId()) { case android.R.id.home: diff --git a/src/widget/NoteWidgetProvider.java b/src/widget/NoteWidgetProvider.java index ec6f819..4661c89 100644 --- a/src/widget/NoteWidgetProvider.java +++ b/src/widget/NoteWidgetProvider.java @@ -37,33 +37,33 @@ public abstract class NoteWidgetProvider extends AppWidgetProvider { NoteColumns.ID, NoteColumns.BG_COLOR_ID, NoteColumns.SNIPPET - }; + };//定义字符串数组PROJECTION，包含IDB G_COLOR_ID SNIPPET三个元素 public static final int COLUMN_ID = 0; public static final int COLUMN_BG_COLOR_ID = 1; - public static final int COLUMN_SNIPPET = 2; + public static final int COLUMN_SNIPPET = 2;//定义三个元素初始量 private static final String TAG = "NoteWidgetProvider"; @Override - public void onDeleted(Context context, int[] appWidgetIds) { + public void onDeleted(Context context, int[] appWidgetIds) {//创建一个ContentValues对象values存储键值对数据 ContentValues values = new ContentValues(); - values.put(NoteColumns.WIDGET_ID, AppWidgetManager.INVALID_APPWIDGET_ID); + values.put(NoteColumns.WIDGET_ID, AppWidgetManager.INVALID_APPWIDGET_ID);//将无效小部件id存储ContentValues中 for (int i = 0; i < appWidgetIds.length; i++) { context.getContentResolver().update(Notes.CONTENT_NOTE_URI, values, NoteColumns.WIDGET_ID + "=?", - new String[] { String.valueOf(appWidgetIds[i])}); + new String[] { String.valueOf(appWidgetIds[i])});//通过getcontent函数获取程序contentValues对象，用update方法更新 } } private Cursor getNoteWidgetInfo(Context context, int widgetId) { return context.getContentResolver().query(Notes.CONTENT_NOTE_URI, - PROJECTION, + PROJECTION,//获取ContentResovler对象，并用querty方法查询数据· NoteColumns.WIDGET_ID + "=? AND " + NoteColumns.PARENT_ID + "<>?", new String[] { String.valueOf(widgetId), String.valueOf(Notes.ID_TRASH_FOLER) }, null); - } + }//null表示默认排序方式 protected void update(Context context, AppWidgetManager appWidgetManager, int[] appWidgetIds) { update(context, appWidgetManager, appWidgetIds, false); @@ -71,12 +71,12 @@ public abstract class NoteWidgetProvider extends AppWidgetProvider { private void update(Context context, AppWidgetManager appWidgetManager, int[] appWidgetIds, boolean privacyMode) { - for (int i = 0; i < appWidgetIds.length; i++) { + for (int i = 0; i < appWidgetIds.length; i++) {//判断当前小部件id是否合法，若合法才可进行操作 if (appWidgetIds[i] != AppWidgetManager.INVALID_APPWIDGET_ID) { - int bgId = ResourceParser.getDefaultBgId(context); + int bgId = ResourceParser.getDefaultBgId(context);//获取默认背景图片id，并将其作为当前部件的背景 String snippet = ""; Intent intent = new Intent(context, NoteEditActivity.class); - intent.setFlags(Intent.FLAG_ACTIVITY_SINGLE_TOP); + intent.setFlags(Intent.FLAG_ACTIVITY_SINGLE_TOP);//创建internet对象，设置flag标志 intent.putExtra(Notes.INTENT_EXTRA_WIDGET_ID, appWidgetIds[i]); intent.putExtra(Notes.INTENT_EXTRA_WIDGET_TYPE, getWidgetType()); @@ -86,14 +86,14 @@ public abstract class NoteWidgetProvider extends AppWidgetProvider { Log.e(TAG, "Multiple message with same widget id:" + appWidgetIds[i]); c.close(); return; - } + }//判断数据库查询结果c是否为空，若查询结果大于1，则记录日志错误并返回 snippet = c.getString(COLUMN_SNIPPET); bgId = c.getInt(COLUMN_BG_COLOR_ID); intent.putExtra(Intent.EXTRA_UID, c.getLong(COLUMN_ID)); - intent.setAction(Intent.ACTION_VIEW); + intent.setAction(Intent.ACTION_VIEW);//将当前记录id作为extra数据存入启动internet对象中 } else { snippet = context.getResources().getString(R.string.widget_havenot_content); - intent.setAction(Intent.ACTION_INSERT_OR_EDIT); + intent.setAction(Intent.ACTION_INSERT_OR_EDIT);//// 数据库查询结果为空或者未能成功移动到第一条记录时，将片段内容设置为默认字符串 } if (c != null) { @@ -107,16 +107,16 @@ public abstract class NoteWidgetProvider extends AppWidgetProvider { * Generate the pending intent to start host for the widget */ PendingIntent pendingIntent = null; - if (privacyMode) { + if (privacyMode) {// 判断是否处于隐私模式 rv.setTextViewText(R.id.widget_text, context.getString(R.string.widget_under_visit_mode)); pendingIntent = PendingIntent.getActivity(context, appWidgetIds[i], new Intent( - context, NotesListActivity.class), PendingIntent.FLAG_UPDATE_CURRENT); + context, NotesListActivity.class), PendingIntent.FLAG_UPDATE_CURRENT);// 如果是，将小部件文本设置为“访问模式下”，并创建一个PendingIntent，使点击小部件时跳转至NotesListActivity } else { rv.setTextViewText(R.id.widget_text, snippet); pendingIntent = PendingIntent.getActivity(context, appWidgetIds[i], intent, PendingIntent.FLAG_UPDATE_CURRENT); - } + }// 如果不是，将小部件文本设置为片段内容，并创建一个PendingIntent，使点击小部件时跳转至NoteEditActivity rv.setOnClickPendingIntent(R.id.widget_text, pendingIntent); appWidgetManager.updateAppWidget(appWidgetIds[i], rv); @@ -128,5 +128,5 @@ public abstract class NoteWidgetProvider extends AppWidgetProvider { protected abstract int getLayoutId(); - protected abstract int getWidgetType(); + protected abstract int getWidgetType();//获取背景资源id，布局资源id，小部件类型 } diff --git a/src/widget/NoteWidgetProvider_2x.java b/src/widget/NoteWidgetProvider_2x.java index adcb2f7..40dd783 100644 --- a/src/widget/NoteWidgetProvider_2x.java +++ b/src/widget/NoteWidgetProvider_2x.java @@ -28,20 +28,21 @@ public class NoteWidgetProvider_2x extends NoteWidgetProvider { @Override public void onUpdate(Context context, AppWidgetManager appWidgetManager, int[] appWidgetIds) { super.update(context, appWidgetManager, appWidgetIds); - } + }//NoteWidgetProvider_2x是一个继承自NoteWidgetProvider的小部件提供者，用于显示2x大小的便签小部件。 + //调用父类的update方法，更新小部件UI界面 @Override protected int getLayoutId() { return R.layout.widget_2x; - } + }//获取2x大小便签小部件布局资源ID，由子类具体实现 @Override protected int getBgResourceId(int bgId) { return ResourceParser.WidgetBgResources.getWidget2xBgResource(bgId); - } + }//获取2x大小便签小部件背景资源ID，由子类具体实现。 @Override protected int getWidgetType() { return Notes.TYPE_WIDGET_2X; - } + }//获取小部件类型，由子类具体实现，返回值为Notes.TYPE_WIDGET_2X } diff --git a/src/widget/NoteWidgetProvider_4x.java b/src/widget/NoteWidgetProvider_4x.java index c12a02e..6a3b077 100644 --- a/src/widget/NoteWidgetProvider_4x.java +++ b/src/widget/NoteWidgetProvider_4x.java @@ -28,19 +28,20 @@ public class NoteWidgetProvider_4x extends NoteWidgetProvider { @Override public void onUpdate(Context context, AppWidgetManager appWidgetManager, int[] appWidgetIds) { super.update(context, appWidgetManager, appWidgetIds); - } + }//NoteWidgetProvider_4x是一个继承自NoteWidgetProvider的小部件提供者，用于显示4x大小的便签小部件。 + //调用父类的update方法，更新小部件UI界面 protected int getLayoutId() { return R.layout.widget_4x; - } + }//获取4x大小便签小部件布局资源ID，由子类具体实现 @Override protected int getBgResourceId(int bgId) { return ResourceParser.WidgetBgResources.getWidget4xBgResource(bgId); - } + }//获取4x大小便签小部件背景资源ID，由子类具体实现。 @Override protected int getWidgetType() { return Notes.TYPE_WIDGET_4X; - } + }//获取小部件类型，由子类具体实现，返回值为Notes.TYPE_WIDGET_4X }