();
}
-
- if(sContactCache.containsKey(phoneNumber)) {
+ // 查找HashMap中是否已有对应联系人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,
- new String [] { Phone.DISPLAY_NAME },
+ // 修改原先数据库语句Caller_ID_SELECTION，用函数形参phonenumber的后七位电话号码代替"+"
+ String selection = CALLER_ID_SELECTION.replace("+", PhoneNumberUtils.toCallerIDMinMatch(phoneNumber));
+ //从数据库中读取数据，query是查询方法。cursor类是对数据库的操作，获取整行的数据.Ressolver是对联系人内容的读取，其中provider提供了联系人数据
+ Cursor cursor = context.getContentResolver().query(Data.CONTENT_URI,//uri是区别provider的标志
+ new String[]{Phone.DISPLAY_NAME},
+ //该参数告诉provider要返回的内容，这里是要返回联系人的名字
selection,
- new String[] { phoneNumber },
+ //该参数相当于数据库中where条件，筛选只拥有特定电话号码的信息
+ new String[]{phoneNumber},
+ //筛选条件，即参数phonenumber
null);
-
+ //设置查询是否按顺序排列，这里的意思是不按顺序排列
+/**
+ * 判断上面的查询是否查到相关信息，如果查询到将查询到的数据移动到第一行
+ * 如果没有查询到相关信息，就写入日志
+ */
if (cursor != null && cursor.moveToFirst()) {
try {
+ // 获取联系人姓名，写入联系人缓存
String name = cursor.getString(0);
sContactCache.put(phoneNumber, name);
return name;
+ // 异常
} catch (IndexOutOfBoundsException e) {
+ // 将异常信息写入日志
Log.e(TAG, " Cursor get string error " + e.toString());
return null;
} finally {
cursor.close();
}
+ // 未找到相关信息就写入日志
} else {
Log.d(TAG, "No contact matched with number:" + phoneNumber);
return null;
}
}
-}
+}
\ No newline at end of file
diff --git a/src/main/java/net/micode/notes/data/Notes.java b/src/main/java/net/micode/notes/data/Notes.java
index f240604..1103191 100644
--- a/src/main/java/net/micode/notes/data/Notes.java
+++ b/src/main/java/net/micode/notes/data/Notes.java
@@ -13,16 +13,24 @@
* See the License for the specific language governing permissions and
* limitations under the License.
*/
-
+//表示在哪个包，依赖关系
package net.micode.notes.data;
+//uri是统一资源标识符，涉及到安卓权限
import android.net.Uri;
+
+//Notes 类中定义了很多常量，这些常量大多是int型和string型
public class Notes {
- public static final String AUTHORITY = "micode_notes";
+ // 定义了一个权限名，这里是为了符合Uri的格式而定义的
+ public static final
+ String AUTHORITY = "micode_notes";
+ // 设置标签，表示APP的名称是Notes
public static final String TAG = "Notes";
- public static final int TYPE_NOTE = 0;
- public static final int TYPE_FOLDER = 1;
- public static final int TYPE_SYSTEM = 2;
+
+ //以下三个常量对NoteColumns.TYPE的值进行设置时会用到
+ 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
@@ -30,22 +38,38 @@ public class Notes {
* {@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;
+ //垃圾文件夹3
public static final int ID_TRASH_FOLER = -3;
+//定义string字符串
+ 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 =
- 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";
+ "net.micode.notes.widget_id";
+ public static final String INTENT_EXTRA_WIDGET_TYPE =
- public static final int TYPE_WIDGET_INVALIDE = -1;
- public static final int TYPE_WIDGET_2X = 0;
- public static final int TYPE_WIDGET_4X = 1;
+ "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;
+//DataContants类：存放textnotes和callnotes地址
public static class DataConstants {
public static final String NOTE = TextNote.CONTENT_ITEM_TYPE;
public static final String CALL_NOTE = CallNote.CONTENT_ITEM_TYPE;
@@ -54,13 +78,22 @@ public class Notes {
/**
* Uri to query all notes and folders
*/
- public static final Uri CONTENT_NOTE_URI = Uri.parse("content://" + AUTHORITY + "/note");
+//创建URI访问实例parse中的参数分三部分，scheme（访问资源的命名机制），authority（存放资源的主机名），path（资源自身的名称）
+ public static final Uri CONTENT_NOTE_URI = Uri.parse("content://" +
+
+ AUTHORITY + "/note");//定义查询便签和文件夹的指针。
+
+// public static final Uri my_URI = ContentUris.withAppendedId(Notes.CONTENT_NOTE_URI , 10);
/**
* Uri to query data
+ * 系统根据data查询所需的Uri常量
*/
- public static final Uri CONTENT_DATA_URI = Uri.parse("content://" + AUTHORITY + "/data");
+ public static final Uri CONTENT_DATA_URI = Uri.parse("content://" +
+
+ AUTHORITY + "/data");//定义查找数据的指针。
+ // 定义NoteColumns的常量,用于后面创建数据库的表头
public interface NoteColumns {
/**
* The unique ID for a row
@@ -72,17 +105,20 @@ public class Notes {
* The parent's id for note or folder
* Type: INTEGER (long)
*/
+ //父节点的ID
public static final String PARENT_ID = "parent_id";
/**
* Created data for note or folder
* Type: INTEGER (long)
+ * 创建时间
*/
public static final String CREATED_DATE = "created_date";
/**
* Latest modified date
* Type: INTEGER (long)
+ * 提醒时间
*/
public static final String MODIFIED_DATE = "modified_date";
@@ -90,30 +126,35 @@ public class Notes {
/**
* 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)
+ * 小部件ID
*/
public static final String WIDGET_ID = "widget_id";
/**
* Note's widget type
* Type: INTEGER (long)
+ * 小部件类型
*/
public static final String WIDGET_TYPE = "widget_type";
/**
* Note's background color's id
* Type: INTEGER (long)
+ * 背景颜色ID
*/
public static final String BG_COLOR_ID = "bg_color_id";
@@ -121,126 +162,152 @@ public class Notes {
* 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)
+ * 最后一次同步的ID
*/
- public static final String SYNC_ID = "sync_id";
+ public static final String SYNC_ID = "sync_id";//同步
/**
* Sign to indicate local modified or not
* Type: INTEGER
+ * 标识本地是否修改
*/
public static final String LOCAL_MODIFIED = "local_modified";
/**
* Original parent id before moving into temporary folder
* Type : INTEGER
+ * 移动到当前文件夹之前的父文件夹ID
*/
public static final String ORIGIN_PARENT_ID = "origin_parent_id";
/**
* The gtask id
* Type : TEXT
+ * 后台任务ID
*/
public static final String GTASK_ID = "gtask_id";
/**
* The version code
* Type : INTEGER (long)
+ * 版本代号
*/
public static final String VERSION = "version";
- }
+ }//这些常量主要是定义便签的属性的。
+ // 定义DataColumns的常量,用于后面创建数据库的表头
public interface DataColumns {
/**
* The unique ID for a row
* Type: INTEGER (long)
+ * 一行独立的便签ID
*/
public static final String ID = "_id";
/**
* The MIME type of the item represented by this row.
* Type: Text
+ * MIME类型能包含视频、图像、文本、音频、应用程序等数据
*/
public static final String MIME_TYPE = "mime_type";
/**
* The reference id to note that this data belongs to
* Type: INTEGER (long)
+ * 便签ID
*/
public static final String NOTE_ID = "note_id";
/**
* Created data for note or folder
* Type: INTEGER (long)
+ * 创建时间
*/
public static final String CREATED_DATE = "created_date";
/**
* Latest modified date
* Type: INTEGER (long)
+ * 最后的修改日期
*/
public static final String MODIFIED_DATE = "modified_date";
/**
* Data's content
* Type: TEXT
+ * 数据的内容
*/
public static final String CONTENT = "content";
/**
- * Generic data column, the meaning is {@link #MIMETYPE} specific, used for
+ * 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
+ * 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
+ * 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
+ * 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
+ * Generic data column, the meaning is {@link #MIMETYPE} specific,
+ *
+ * used for
* TEXT data type
*
Type: TEXT
*/
public static final String DATA5 = "data5";
- }
+ }//主要是定义存储便签内容数据的
+//文本数据（TextNote）通过关键字implements来实现接口，继承了DataColumns的所有定义常量
public static final class TextNote implements DataColumns {
/**
* Mode to indicate the text in check list mode or not
@@ -250,13 +317,20 @@ public class Notes {
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_TYPE =
- public static final String CONTENT_ITEM_TYPE = "vnd.android.cursor.item/text_note";
+ "vnd.android.cursor.dir/text_note";
- public static final Uri CONTENT_URI = Uri.parse("content://" + AUTHORITY + "/text_note");
- }
+ public static final String CONTENT_ITEM_TYPE =
+ "vnd.android.cursor.item/text_note";
+// 访问该content_provider的URI，parse方法返回的是一个URI类型。通过这个uri可以访问一个网络上或者本地上的资源
+ public static final Uri CONTENT_URI = Uri.parse("content://" +
+
+ AUTHORITY + "/text_note");
+ }
+ //文本内容的数据结构
+//TextNote作为DataColumns的子类，进行扩展，用于记录通话数据的表头
public static final class CallNote implements DataColumns {
/**
* Call date for this record
@@ -270,10 +344,16 @@ public class Notes {
*/
public static final String PHONE_NUMBER = DATA3;
- public static final String CONTENT_TYPE = "vnd.android.cursor.dir/call_note";
+ public static final String CONTENT_TYPE =
- public static final String CONTENT_ITEM_TYPE = "vnd.android.cursor.item/call_note";
+ "vnd.android.cursor.dir/call_note";
- public static final Uri CONTENT_URI = Uri.parse("content://" + AUTHORITY + "/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");
+ }//电话内容的数据结构
+}
\ No newline at end of file
diff --git a/src/main/java/net/micode/notes/data/NotesDatabaseHelper.java b/src/main/java/net/micode/notes/data/NotesDatabaseHelper.java
index ffe5d57..3005427 100644
--- a/src/main/java/net/micode/notes/data/NotesDatabaseHelper.java
+++ b/src/main/java/net/micode/notes/data/NotesDatabaseHelper.java
@@ -13,202 +13,125 @@
* See the License for the specific language governing permissions and
* limitations under the License.
*/
-
+//数据库操作，SQLOpenhelper,对一些note和文件进行数据库的操作。比如删除文件后，将文件里的note也相应删除
package net.micode.notes.data;
+//保存一些数据信息，这些数据可以被数据库操作
import android.content.ContentValues;
+//加载和访问资源
import android.content.Context;
+//主要提供了对应于添加、删除、更新、查询的操作
import android.database.sqlite.SQLiteDatabase;
+//数据库的更新和创建
import android.database.sqlite.SQLiteOpenHelper;
+//安卓日志类接口
import android.util.Log;
-
+//导入Notes.java中的DataColumns, NoteColumns接口，和类DataConstants
import net.micode.notes.data.Notes.DataColumns;
import net.micode.notes.data.Notes.DataConstants;
import net.micode.notes.data.Notes.NoteColumns;
-
+//继承于SQLiteOpenHelper的类NotesDatabaseHelper，用于实现对便签或者 文件的数据库操作，例如删除便签
public class NotesDatabaseHelper extends SQLiteOpenHelper {
private static final String DB_NAME = "note.db";
private static final int DB_VERSION = 4;
public interface TABLE {
+ //接口，分成note和data，在后面的程序里分别使用过
public static final String NOTE = "note";
public static final String DATA = "data";
}
+ //创建一个表格用来储存标签编号
private static final String TAG = "NotesDatabaseHelper";
-
+ //实例化一个NoteDatabaseHelper
private static NotesDatabaseHelper mInstance;
+ /**
+ * 当创建一个新的便签，就产生了各类关于便签的信息，
+ * 比如ID，父便签ID，背景颜色，创建日期等，
+ * 我们需要把这些信息放入数据库，这就是数据库的表头。
+ * 我们在下面定义的涉及操作的字符串，
+ * 全都是为了在之后执行db.execSQL("字符串")。
+ */
+ private static final String CREATE_NOTE_TABLE_SQL = "CREATE TABLE " + TABLE.NOTE + "(" + NoteColumns.ID + " INTEGER PRIMARY KEY," + NoteColumns.PARENT_ID + " INTEGER NOT NULL DEFAULT 0," + NoteColumns.ALERTED_DATE + " INTEGER NOT NULL DEFAULT 0," + NoteColumns.BG_COLOR_ID + " INTEGER NOT NULL DEFAULT 0," + NoteColumns.CREATED_DATE + " INTEGER NOT NULL DEFAULT (strftime('%s','now') * 1000)," + NoteColumns.HAS_ATTACHMENT + " INTEGER NOT NULL DEFAULT 0," + NoteColumns.MODIFIED_DATE + " INTEGER NOT NULL DEFAULT (strftime('%s','now') * 1000)," + NoteColumns.NOTES_COUNT + " INTEGER NOT NULL DEFAULT 0," + NoteColumns.SNIPPET + " TEXT NOT NULL DEFAULT ''," + NoteColumns.TYPE + " INTEGER NOT NULL DEFAULT 0," + NoteColumns.WIDGET_ID + " INTEGER NOT NULL DEFAULT 0," + NoteColumns.WIDGET_TYPE + " INTEGER NOT NULL DEFAULT -1," + NoteColumns.SYNC_ID + " INTEGER NOT NULL DEFAULT 0," + NoteColumns.LOCAL_MODIFIED + " INTEGER NOT NULL DEFAULT 0," + NoteColumns.ORIGIN_PARENT_ID + " INTEGER NOT NULL DEFAULT 0," + NoteColumns.GTASK_ID + " TEXT NOT NULL DEFAULT ''," + NoteColumns.VERSION + " INTEGER NOT NULL DEFAULT 0" + ")";
- private static final String CREATE_NOTE_TABLE_SQL =
- "CREATE TABLE " + TABLE.NOTE + "(" +
- NoteColumns.ID + " INTEGER PRIMARY KEY," +
- NoteColumns.PARENT_ID + " INTEGER NOT NULL DEFAULT 0," +
- NoteColumns.ALERTED_DATE + " INTEGER NOT NULL DEFAULT 0," +
- NoteColumns.BG_COLOR_ID + " INTEGER NOT NULL DEFAULT 0," +
- NoteColumns.CREATED_DATE + " INTEGER NOT NULL DEFAULT (strftime('%s','now') * 1000)," +
- NoteColumns.HAS_ATTACHMENT + " INTEGER NOT NULL DEFAULT 0," +
- NoteColumns.MODIFIED_DATE + " INTEGER NOT NULL DEFAULT (strftime('%s','now') * 1000)," +
- NoteColumns.NOTES_COUNT + " INTEGER NOT NULL DEFAULT 0," +
- NoteColumns.SNIPPET + " TEXT NOT NULL DEFAULT ''," +
- NoteColumns.TYPE + " INTEGER NOT NULL DEFAULT 0," +
- NoteColumns.WIDGET_ID + " INTEGER NOT NULL DEFAULT 0," +
- NoteColumns.WIDGET_TYPE + " INTEGER NOT NULL DEFAULT -1," +
- NoteColumns.SYNC_ID + " INTEGER NOT NULL DEFAULT 0," +
- NoteColumns.LOCAL_MODIFIED + " INTEGER NOT NULL DEFAULT 0," +
- NoteColumns.ORIGIN_PARENT_ID + " INTEGER NOT NULL DEFAULT 0," +
- NoteColumns.GTASK_ID + " TEXT NOT NULL DEFAULT ''," +
- NoteColumns.VERSION + " INTEGER NOT NULL DEFAULT 0" +
- ")";
-
- private static final String CREATE_DATA_TABLE_SQL =
- "CREATE TABLE " + TABLE.DATA + "(" +
- DataColumns.ID + " INTEGER PRIMARY KEY," +
- DataColumns.MIME_TYPE + " TEXT NOT NULL," +
- DataColumns.NOTE_ID + " INTEGER NOT NULL DEFAULT 0," +
- NoteColumns.CREATED_DATE + " INTEGER NOT NULL DEFAULT (strftime('%s','now') * 1000)," +
- NoteColumns.MODIFIED_DATE + " INTEGER NOT NULL DEFAULT (strftime('%s','now') * 1000)," +
- DataColumns.CONTENT + " TEXT NOT NULL DEFAULT ''," +
- DataColumns.DATA1 + " INTEGER," +
- DataColumns.DATA2 + " INTEGER," +
- DataColumns.DATA3 + " TEXT NOT NULL DEFAULT ''," +
- DataColumns.DATA4 + " TEXT NOT NULL DEFAULT ''," +
- DataColumns.DATA5 + " TEXT NOT NULL DEFAULT ''" +
- ")";
-
- 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 CREATE_DATA_TABLE_SQL = "CREATE TABLE " + TABLE.DATA + "(" + DataColumns.ID + " INTEGER PRIMARY KEY," + DataColumns.MIME_TYPE + " TEXT NOT NULL," + DataColumns.NOTE_ID + " INTEGER NOT NULL DEFAULT 0," + NoteColumns.CREATED_DATE + " INTEGER NOT NULL DEFAULT (strftime('%s','now') * 1000)," + NoteColumns.MODIFIED_DATE + " INTEGER NOT NULL DEFAULT (strftime('%s','now') * 1000)," + DataColumns.CONTENT + " TEXT NOT NULL DEFAULT ''," + DataColumns.DATA1 + " INTEGER," + DataColumns.DATA2 + " INTEGER," + DataColumns.DATA3 + " TEXT NOT NULL DEFAULT ''," + DataColumns.DATA4 + " TEXT NOT NULL DEFAULT ''," + DataColumns.DATA5 + " TEXT NOT NULL DEFAULT ''" + ")";
+ //创建索引，名称为note_id_index，在TABLE.DATA表格的DataCloumns.NOTE_ID列
+ private static final String CREATE_DATA_NOTE_ID_INDEX_SQL = "CREATE INDEX IF NOT EXISTS note_id_index ON " + TABLE.DATA + "(" + DataColumns.NOTE_ID + ");";//存储便签编号的一个数据表格
/**
* Increase folder's note count when move note to the folder
+ * 增加文件夹便签数量，当移动一个便签进入该文件夹后，
+ * 之后在db.execSQL(字符串)中用到，
+ * 启动自定义的数据库update触发器，有相关的一系列数据库操作。
*/
- 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
+ * 同上，从文件夹移除便签，文件夹便签数量减1，
+ * 以后在db.execSQL(字符串)中用到，
+ * 启动自定义的数据库updata触发器，附带相关的一系列操作
*/
- 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
+ * 文件夹中创建新便签，文件夹便签数量+1，
+ * 启动自定义的数据库insert触发器，附带相关的一系列操作
*/
- 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
+ * 在文件夹中删除note时，更新文件夹的note数量
*/
- 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}
+ * 当Note插入新的数据时，更新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";
+ 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";
/**
* Update note's content when data with {@link DataConstants#NOTE} type has changed
+ * 构建一条SQL语句，用于实现在note中改变data后，进行当前状态的更新
*/
- private static final String DATA_UPDATE_NOTE_CONTENT_ON_UPDATE_TRIGGER =
- "CREATE TRIGGER update_note_content_on_update " +
- " AFTER UPDATE ON " + TABLE.DATA +
- " WHEN old." + DataColumns.MIME_TYPE + "='" + DataConstants.NOTE + "'" +
- " BEGIN" +
- " UPDATE " + TABLE.NOTE +
- " SET " + NoteColumns.SNIPPET + "=new." + DataColumns.CONTENT +
- " WHERE " + NoteColumns.ID + "=new." + DataColumns.NOTE_ID + ";" +
- " END";
+ 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";
/**
* Update note's content when data with {@link DataConstants#NOTE} type has deleted
+ * 当note的内容被删除时，更新表格
*/
- private static final String DATA_UPDATE_NOTE_CONTENT_ON_DELETE_TRIGGER =
- "CREATE TRIGGER update_note_content_on_delete " +
- " 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";
+ 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";
/**
* 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);
@@ -216,6 +139,7 @@ public class NotesDatabaseHelper extends SQLiteOpenHelper {
createSystemFolder(db);
Log.d(TAG, "note table has been created");
}
+ //创建表格（用来存储标签属性）
private void reCreateNoteTableTriggers(SQLiteDatabase db) {
db.execSQL("DROP TRIGGER IF EXISTS increase_folder_count_on_update");
@@ -234,12 +158,15 @@ public class NotesDatabaseHelper extends SQLiteOpenHelper {
db.execSQL(FOLDER_DELETE_NOTES_ON_DELETE_TRIGGER);
db.execSQL(FOLDER_MOVE_NOTES_ON_TRASH_TRIGGER);
}
+ //execSQL是数据库操作的API，主要是更改行为的SQL语句。
+ //在这里主要是用来重新创建上述定义的表格用的，先删除原来有的数据库的触发器再重新创建新的数据库
private void createSystemFolder(SQLiteDatabase db) {
ContentValues values = new ContentValues();
/**
* call record foler for call notes
+ * 初始化ContenValues实例，然后存入相应的通话记录文件夹类型形成映射，
*/
values.put(NoteColumns.ID, Notes.ID_CALL_RECORD_FOLDER);
values.put(NoteColumns.TYPE, Notes.TYPE_SYSTEM);
@@ -247,6 +174,7 @@ public class NotesDatabaseHelper extends SQLiteOpenHelper {
/**
* root folder which is default folder
+ * 对根文件夹修改，先将values实例的内容清空，然后存入values，再插入对象
*/
values.clear();
values.put(NoteColumns.ID, Notes.ID_ROOT_FOLDER);
@@ -255,6 +183,7 @@ public class NotesDatabaseHelper extends SQLiteOpenHelper {
/**
* temporary folder which is used for moving note
+ * 设置临时文件夹作为文件夹移动的有效目标
*/
values.clear();
values.put(NoteColumns.ID, Notes.ID_TEMPARAY_FOLDER);
@@ -263,19 +192,21 @@ public class NotesDatabaseHelper extends SQLiteOpenHelper {
/**
* create trash folder
+ * 创建垃圾文件夹
*/
values.clear();
values.put(NoteColumns.ID, Notes.ID_TRASH_FOLER);
values.put(NoteColumns.TYPE, Notes.TYPE_SYSTEM);
db.insert(TABLE.NOTE, null, values);
}
+ //创建几个系统文件夹
public void createDataTable(SQLiteDatabase db) {
db.execSQL(CREATE_DATA_TABLE_SQL);
reCreateDataTableTriggers(db);
db.execSQL(CREATE_DATA_NOTE_ID_INDEX_SQL);
Log.d(TAG, "data table has been created");
- }
+ }//创建表格（用来存储标签内容）
private void reCreateDataTableTriggers(SQLiteDatabase db) {
db.execSQL("DROP TRIGGER IF EXISTS update_note_content_on_insert");
@@ -285,7 +216,7 @@ public class NotesDatabaseHelper extends SQLiteOpenHelper {
db.execSQL(DATA_UPDATE_NOTE_CONTENT_ON_INSERT_TRIGGER);
db.execSQL(DATA_UPDATE_NOTE_CONTENT_ON_UPDATE_TRIGGER);
db.execSQL(DATA_UPDATE_NOTE_CONTENT_ON_DELETE_TRIGGER);
- }
+ }//创建用于表格初始化，删除触发器，然后更新触发器
static synchronized NotesDatabaseHelper getInstance(Context context) {
if (mInstance == null) {
@@ -293,45 +224,51 @@ public class NotesDatabaseHelper extends SQLiteOpenHelper {
}
return mInstance;
}
+ //上网查是为解决同一时刻只能有一个线程执行.
+ //在写程序库代码时，有时有一个类需要被所有的其它类使用，
+ //但又要求这个类只能被实例化一次，是个服务类，定义一次，其它类使用同一个这个类的实例
@Override
public void onCreate(SQLiteDatabase db) {
createNoteTable(db);
createDataTable(db);
- }
+ }//实现两个表格（上面创建的两个表格）
@Override
public void onUpgrade(SQLiteDatabase db, int oldVersion, int newVersion) {
+ //是否重建的信号
boolean reCreateTriggers = false;
+ //是否从V2升级到V3
boolean skipV2 = false;
-
+ //判断旧版本是不是V1，如果是就升级版本到V2
if (oldVersion == 1) {
upgradeToV2(db);
skipV2 = true; // this upgrade including the upgrade from v2 to v3
oldVersion++;
}
-
+ //判断旧版本是V2，且未跳过V2版本，就升级版本到V3
if (oldVersion == 2 && !skipV2) {
upgradeToV3(db);
reCreateTriggers = true;
oldVersion++;
}
-
+ //如果旧版本是V3，就升级版本到V4
if (oldVersion == 3) {
upgradeToV4(db);
oldVersion++;
}
-
+ //若重构触发器的值为真，那么，
+ // 要把便签（note）和数据（data）表单的数据库触发器重构，调用以上的定义
if (reCreateTriggers) {
reCreateNoteTableTriggers(db);
reCreateDataTableTriggers(db);
}
-
+ //旧版本与最新版本不一致，抛出异常
if (oldVersion != newVersion) {
- throw new IllegalStateException("Upgrade notes database to version " + newVersion
- + "fails");
+ throw new IllegalStateException("Upgrade notes database to version " + newVersion + "fails");
}
}
+ //数据库版本的更新（数据库内容的更改）
private void upgradeToV2(SQLiteDatabase db) {
db.execSQL("DROP TABLE IF EXISTS " + TABLE.NOTE);
@@ -339,6 +276,7 @@ public class NotesDatabaseHelper extends SQLiteOpenHelper {
createNoteTable(db);
createDataTable(db);
}
+ //更新到V2版本,删除note和data表，然后新建表
private void upgradeToV3(SQLiteDatabase db) {
// drop unused triggers
@@ -346,17 +284,16 @@ public class NotesDatabaseHelper extends SQLiteOpenHelper {
db.execSQL("DROP TRIGGER IF EXISTS update_note_modified_date_on_delete");
db.execSQL("DROP TRIGGER IF EXISTS update_note_modified_date_on_update");
// add a column for gtask id
- db.execSQL("ALTER TABLE " + TABLE.NOTE + " ADD COLUMN " + NoteColumns.GTASK_ID
- + " TEXT NOT NULL DEFAULT ''");
+ 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);
}
+ //更新到V3版本，删除触发器，新增gtask和trash行，然后在表中增添表头
private void upgradeToV4(SQLiteDatabase db) {
- db.execSQL("ALTER TABLE " + TABLE.NOTE + " ADD COLUMN " + NoteColumns.VERSION
- + " INTEGER NOT NULL DEFAULT 0");
- }
-}
+ db.execSQL("ALTER TABLE " + TABLE.NOTE + " ADD COLUMN " + NoteColumns.VERSION + " INTEGER NOT NULL DEFAULT 0");
+ }//更新到V4版本,但是不知道V2、V3、V4是什么意思
+}
\ No newline at end of file
diff --git a/src/main/java/net/micode/notes/data/NotesProvider.java b/src/main/java/net/micode/notes/data/NotesProvider.java
index edb0a60..598c2af 100644
--- a/src/main/java/net/micode/notes/data/NotesProvider.java
+++ b/src/main/java/net/micode/notes/data/NotesProvider.java
@@ -15,7 +15,7 @@
*/
package net.micode.notes.data;
-
+//说明当前文件所在包
import android.app.SearchManager;
import android.content.ContentProvider;
@@ -34,14 +34,21 @@ import net.micode.notes.data.Notes.DataColumns;
import net.micode.notes.data.Notes.NoteColumns;
import net.micode.notes.data.NotesDatabaseHelper.TABLE;
-
+//为存储和获取数据提供接口。可以在不同的应用程序之间共享数据
+//ContentProvider提供的方法
+//query：查询
+//insert：插入
+//update：更新
+//delete：删除
+//getType：得到数据类型
public class NotesProvider extends ContentProvider {
+ // UriMatcher用于匹配Uri
private static final UriMatcher mMatcher;
-
+ //数据库辅助类的实例对象
private NotesDatabaseHelper mHelper;
-
+ //写入日志时的标签名
private static final String TAG = "NotesProvider";
-
+ //Uri资源的ID共6个
private static final int URI_NOTE = 1;
private static final int URI_NOTE_ITEM = 2;
private static final int URI_DATA = 3;
@@ -51,7 +58,9 @@ public class NotesProvider extends ContentProvider {
private static final int URI_SEARCH_SUGGEST = 6;
static {
+ // 创建UriMatcher时，调用UriMatcher(UriMatcher.NO_MATCH)表示不匹配任何路径的返回码
mMatcher = new UriMatcher(UriMatcher.NO_MATCH);
+ // 把需要匹配Uri路径全部给注册上
mMatcher.addURI(Notes.AUTHORITY, "note", URI_NOTE);
mMatcher.addURI(Notes.AUTHORITY, "note/#", URI_NOTE_ITEM);
mMatcher.addURI(Notes.AUTHORITY, "data", URI_DATA);
@@ -65,33 +74,41 @@ public class NotesProvider extends ContentProvider {
* 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.
*/
+ // 声明 字符串NOTES_SEARCH_PROJECTION,作为实参，相当于where语句
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;
+ // 声明NOTES_SNIPPET_SEARCH_QUERY，作用同上
private static String NOTES_SNIPPET_SEARCH_QUERY = "SELECT " + NOTES_SEARCH_PROJECTION
- + " FROM " + TABLE.NOTE
- + " WHERE " + NoteColumns.SNIPPET + " LIKE ?"
- + " AND " + NoteColumns.PARENT_ID + "<>" + Notes.ID_TRASH_FOLER
- + " AND " + NoteColumns.TYPE + "=" + Notes.TYPE_NOTE;
+ + " FROM " + TABLE.NOTE
+ + " WHERE " + NoteColumns.SNIPPET + " LIKE ?"
+ + " AND " + NoteColumns.PARENT_ID + "<>" + Notes.ID_TRASH_FOLER
+ + " AND " + NoteColumns.TYPE + "=" + Notes.TYPE_NOTE;
@Override
+ // Context只有在onCreate()中才被初始化
+ // 对mHelper进行实例化
public boolean onCreate() {
mHelper = NotesDatabaseHelper.getInstance(getContext());
return true;
}
@Override
+ // 查询uri在数据库中对应的位置
public Cursor query(Uri uri, String[] projection, String selection, String[] selectionArgs,
- String sortOrder) {
+ String sortOrder) {
+ //先声明一个游标
Cursor c = null;
+ // 获取可读数据库
SQLiteDatabase db = mHelper.getReadableDatabase();
String id = null;
+ // 匹配查找uri
switch (mMatcher.match(uri)) {
+ // 对于不同的匹配值，在数据库中查找相应的条目
case URI_NOTE:
c = db.query(TABLE.NOTE, projection, selection, selectionArgs, null, null,
sortOrder);
@@ -113,6 +130,7 @@ public class NotesProvider extends ContentProvider {
case URI_SEARCH:
case URI_SEARCH_SUGGEST:
if (sortOrder != null || projection != null) {
+ // 不合法的参数异常
throw new IllegalArgumentException(
"do not specify sortOrder, selection, selectionArgs, or projection" + "with this query");
}
@@ -120,9 +138,12 @@ public class NotesProvider extends ContentProvider {
String searchString = null;
if (mMatcher.match(uri) == URI_SEARCH_SUGGEST) {
if (uri.getPathSegments().size() > 1) {
+ // getPathSegments()方法得到一个String的List，
+ // 在uri.getPathSegments().get(1)为第2个元素
searchString = uri.getPathSegments().get(1);
}
} else {
+ //利用URi的getQueryParameter方法可以获取字符串参数
searchString = uri.getQueryParameter("pattern");
}
@@ -132,29 +153,37 @@ public class NotesProvider extends ContentProvider {
try {
searchString = String.format("%%%s%%", searchString);
+ //通过上文得到的搜索字符串进行格式加工，然后用于下面数据库查询条件
c = db.rawQuery(NOTES_SNIPPET_SEARCH_QUERY,
new String[] { searchString });
} catch (IllegalStateException ex) {
+ //捕捉异常
Log.e(TAG, "got exception: " + ex.toString());
}
break;
default:
+ // 抛出异常
throw new IllegalArgumentException("Unknown URI " + uri);
}
if (c != null) {
+ //若getContentResolver发生变化，就接收通知
c.setNotificationUri(getContext().getContentResolver(), uri);
}
return c;
}
@Override
+ // 插入一个uri
public Uri insert(Uri uri, ContentValues values) {
+ // 获得可写的数据库
SQLiteDatabase db = mHelper.getWritableDatabase();
long dataId = 0, noteId = 0, insertedId = 0;
switch (mMatcher.match(uri)) {
+ // 新增一个条目
case URI_NOTE:
insertedId = noteId = db.insert(TABLE.NOTE, null, values);
break;
+ // 如果存在，查找NOTE_ID
case URI_DATA:
if (values.containsKey(DataColumns.NOTE_ID)) {
noteId = values.getAsLong(DataColumns.NOTE_ID);
@@ -167,29 +196,37 @@ public class NotesProvider extends ContentProvider {
throw new IllegalArgumentException("Unknown URI " + uri);
}
// Notify the note uri
+ // 获的一个content对象，若发生了变化则调用getContentResolver，由notifyChange对监听它的对象进行通知
if (noteId > 0) {
getContext().getContentResolver().notifyChange(
ContentUris.withAppendedId(Notes.CONTENT_NOTE_URI, noteId), null);
}
// Notify the data uri
+ //更新Data ID
if (dataId > 0) {
getContext().getContentResolver().notifyChange(
ContentUris.withAppendedId(Notes.CONTENT_DATA_URI, dataId), null);
}
+ // 返回插入的uri的路径
return ContentUris.withAppendedId(uri, insertedId);
}
@Override
+ // 删除一个uri
public int delete(Uri uri, String selection, String[] selectionArgs) {
+ //Uri代表要操作的数据，Android上可用的每种资源 -包括 图像、视频片段、音频资源等都可以用Uri来表示。
int count = 0;
String id = null;
+ // 获得可写的数据库
SQLiteDatabase db = mHelper.getWritableDatabase();
boolean deleteData = false;
switch (mMatcher.match(uri)) {
case URI_NOTE:
+ //筛选语句如下
selection = "(" + selection + ") AND " + NoteColumns.ID + ">0 ";
+ //删除相应数据
count = db.delete(TABLE.NOTE, selection, selectionArgs);
break;
case URI_NOTE_ITEM:
@@ -199,9 +236,11 @@ public class NotesProvider extends ContentProvider {
* trash
*/
long noteId = Long.valueOf(id);
+ //将ID值转为长整数
if (noteId <= 0) {
break;
}
+ //执行删除操作，三个参数分别为要删除的表，删除筛选条件，
count = db.delete(TABLE.NOTE,
NoteColumns.ID + "=" + id + parseSelection(selection), selectionArgs);
break;
@@ -219,6 +258,7 @@ public class NotesProvider extends ContentProvider {
throw new IllegalArgumentException("Unknown URI " + uri);
}
if (count > 0) {
+ //判断是否进行了删除操作，并对监听了删除操作的其他部分给予提醒
if (deleteData) {
getContext().getContentResolver().notifyChange(Notes.CONTENT_NOTE_URI, null);
}
@@ -228,6 +268,7 @@ public class NotesProvider extends ContentProvider {
}
@Override
+ // 更新一个uri
public int update(Uri uri, ContentValues values, String selection, String[] selectionArgs) {
int count = 0;
String id = null;
@@ -235,6 +276,7 @@ public class NotesProvider extends ContentProvider {
boolean updateData = false;
switch (mMatcher.match(uri)) {
case URI_NOTE:
+ //note版本更新，数据更新，以下各部分一致
increaseNoteVersion(-1, selection, selectionArgs);
count = db.update(TABLE.NOTE, values, selection, selectionArgs);
break;
@@ -255,9 +297,10 @@ public class NotesProvider extends ContentProvider {
updateData = true;
break;
default:
+ //查询异常处理
throw new IllegalArgumentException("Unknown URI " + uri);
}
-
+ //在执行了更新的操作之后，要对监听更新操作的其他部分给予提醒
if (count > 0) {
if (updateData) {
getContext().getContentResolver().notifyChange(Notes.CONTENT_NOTE_URI, null);
@@ -267,10 +310,12 @@ public class NotesProvider extends ContentProvider {
return count;
}
+ // 将字符串解析成规定格式
private String parseSelection(String selection) {
return (!TextUtils.isEmpty(selection) ? " AND (" + selection + ')' : "");
}
+ //增加一个noteVersion
private void increaseNoteVersion(long id, String selection, String[] selectionArgs) {
StringBuilder sql = new StringBuilder(120);
sql.append("UPDATE ");
@@ -293,6 +338,7 @@ public class NotesProvider extends ContentProvider {
sql.append(selectString);
}
+ // execSQL()方法可以执行insert、delete、update和CREATE TABLE之类有更改行为的SQL语句
mHelper.getWritableDatabase().execSQL(sql.toString());
}
@@ -302,4 +348,4 @@ public class NotesProvider extends ContentProvider {
return null;
}
-}
+}
\ No newline at end of file
diff --git a/src/main/java/net/micode/notes/gtask/data/MetaData.java b/src/main/java/net/micode/notes/gtask/data/MetaData.java
index 3a2050b..c5fd1af 100644
--- a/src/main/java/net/micode/notes/gtask/data/MetaData.java
+++ b/src/main/java/net/micode/notes/gtask/data/MetaData.java
@@ -24,59 +24,104 @@ import net.micode.notes.tool.GTaskStringUtils;
import org.json.JSONException;
import org.json.JSONObject;
-
public class MetaData extends Task {
+ /*
+ * 功能描述：得到类的简写名称存入字符串TAG中
+ * 实现过程：调用getSimpleName ()函数
+ */
private final static String TAG = MetaData.class.getSimpleName();
-
private String mRelatedGid = null;
-
- public void setMeta(String gid, JSONObject metaInfo) {
+ /*
+ * 功能描述：设置数据，即生成元数据库
+ * 实现过程：调用JSONObject库函数put ()，Task类中的setNotes ()和setName ()函数
+ * 参数注解：
+ */
+ public void setMeta(String gid, JSONObject metaInfo)
+ {
+ //对函数块进行注释
try {
metaInfo.put(GTaskStringUtils.META_HEAD_GTASK_ID, gid);
+ /*
+ * 将这对键值放入metaInfo这个jsonobject对象中
+ */
} catch (JSONException e) {
Log.e(TAG, "failed to put related gid");
+ /*
+ * 输出错误信息
+ */
}
setNotes(metaInfo.toString());
setName(GTaskStringUtils.META_NOTE_NAME);
}
-
+ /*
+ * 功能描述：获取相关联的Gid
+ */
public String getRelatedGid() {
return mRelatedGid;
}
-
+ /*
+ * 功能描述：判断当前数据是否为空，若为空则返回真即值得保存
+ */
@Override
public boolean isWorthSaving() {
return getNotes() != null;
}
-
+ /*
+ * 功能描述：使用远程json数据对象设置元数据内容实现过程：
+ * 调用父类Task中的setContentByRemoteJSON ()函数，并参数注解：
+ */
@Override
public void setContentByRemoteJSON(JSONObject js) {
super.setContentByRemoteJSON(js);
if (getNotes() != null) {
try {
JSONObject metaInfo = new JSONObject(getNotes().trim());
+ //设置ID
mRelatedGid = metaInfo.getString(GTaskStringUtils.META_HEAD_GTASK_ID);
} catch (JSONException e) {
Log.w(TAG, "failed to get related gid");
+ /*
+ * 输出警告信息
+ */
mRelatedGid = null;
}
}
}
-
+ /*
+ * 功能描述：使用本地json数据对象设置元数据内容，一般不会用到，若用到，则抛出异常
+ * Made By CuiCan
+ */
@Override
public void setContentByLocalJSON(JSONObject js) {
// this function should not be called
throw new IllegalAccessError("MetaData:setContentByLocalJSON should not be called");
+ /*
+ * 传递非法参数异常
+ */
}
-
+ /*
+ * 功能描述：从元数据内容中获取本地json对象，一般不会用到，若用到，则抛出异常
+ * Made By CuiCan
+ */
@Override
public JSONObject getLocalJSONFromContent() {
throw new IllegalAccessError("MetaData:getLocalJSONFromContent should not be called");
+ /*
+ * 传递非法参数异常
+ * Made By Cui Can
+ */
}
-
+ /*
+ * 功能描述：获取同步动作状态，一般不会用到，若用到，则抛出异常
+ * Made By CuiCan
+ */
@Override
public int getSyncAction(Cursor c) {
throw new IllegalAccessError("MetaData:getSyncAction should not be called");
+ /*
+ * 传递非法参数异常
+ * Made By Cui Can
+ */
}
-}
+}
\ No newline at end of file
diff --git a/src/main/java/net/micode/notes/gtask/data/Node.java b/src/main/java/net/micode/notes/gtask/data/Node.java
index 63950e0..6a30665 100644
--- a/src/main/java/net/micode/notes/gtask/data/Node.java
+++ b/src/main/java/net/micode/notes/gtask/data/Node.java
@@ -20,32 +20,37 @@ import android.database.Cursor;
import org.json.JSONObject;
+/**
+ * 应该是同步操作的基础数据类型，定义了相关指示同步操作的常量
+ * 关键字：abstract
+ */
public abstract class Node {
- public static final int SYNC_ACTION_NONE = 0;
+ //定义了各种用于表征同步状态的常量
+ public static final int SYNC_ACTION_NONE = 0;// 本地和云端都无可更新内容（即本地和云端内容一致）
- public static final int SYNC_ACTION_ADD_REMOTE = 1;
+ public static final int SYNC_ACTION_ADD_REMOTE = 1;// 需要在远程云端增加内容
- public static final int SYNC_ACTION_ADD_LOCAL = 2;
+ public static final int SYNC_ACTION_ADD_LOCAL = 2;// 需要在本地增加内容
- public static final int SYNC_ACTION_DEL_REMOTE = 3;
+ public static final int SYNC_ACTION_DEL_REMOTE = 3;// 需要在远程云端删除内容
- public static final int SYNC_ACTION_DEL_LOCAL = 4;
+ public static final int SYNC_ACTION_DEL_LOCAL = 4;// 需要在本地删除内容
- public static final int SYNC_ACTION_UPDATE_REMOTE = 5;
+ public static final int SYNC_ACTION_UPDATE_REMOTE = 5;// 需要将本地内容更新到远程云端
- public static final int SYNC_ACTION_UPDATE_LOCAL = 6;
+ public static final int SYNC_ACTION_UPDATE_LOCAL = 6;// 需要将远程云端内容更新到本地
- public static final int SYNC_ACTION_UPDATE_CONFLICT = 7;
+ public static final int SYNC_ACTION_UPDATE_CONFLICT = 7;// 同步出现冲突
- public static final int SYNC_ACTION_ERROR = 8;
+ public static final int SYNC_ACTION_ERROR = 8;// 同步出现错误
private String mGid;
private String mName;
- private long mLastModified;
+ private long mLastModified;//记录最后一次修改时间
- private boolean mDeleted;
+ private boolean mDeleted;//表征是否被删除
public Node() {
mGid = null;
@@ -55,17 +60,20 @@ public abstract class Node {
}
public abstract JSONObject getCreateAction(int actionId);
-
+ //创建JSONObject对象，创建操作和更新操作，形参是操作号
public abstract JSONObject getUpdateAction(int actionId);
public abstract void setContentByRemoteJSON(JSONObject js);
-
+ //2.都是JSONObject和Curson中的一些操作，主要是创建相应的对象进行远端和本地同步操作
public abstract void setContentByLocalJSON(JSONObject js);
-
+ //声明JSONObject对象抽象类，从目录中获取本地JSON
public abstract JSONObject getLocalJSONFromContent();
-
+ //声明int抽象类，获取同步行为代号
public abstract int getSyncAction(Cursor c);
+
+
+ //将gid赋给mGid，以下均为Node函数参数的输入与赋值
public void setGid(String gid) {
this.mGid = gid;
}
@@ -98,4 +106,4 @@ public abstract class Node {
return this.mDeleted;
}
-}
+}
\ No newline at end of file
diff --git a/src/main/java/net/micode/notes/gtask/data/SqlData.java b/src/main/java/net/micode/notes/gtask/data/SqlData.java
index d3ec3be..37098b6 100644
--- a/src/main/java/net/micode/notes/gtask/data/SqlData.java
+++ b/src/main/java/net/micode/notes/gtask/data/SqlData.java
@@ -34,17 +34,36 @@ import net.micode.notes.gtask.exception.ActionFailureException;
import org.json.JSONException;
import org.json.JSONObject;
+/*
+ * Description：用于支持小米便签最底层的数据库相关操作，和sqlnote的关系上是子集关系，即data是note的子集（节点）。
+ * SqlData其实就是也就是所谓数据中的数据
+ */
public class SqlData {
+ /*
+ * 功能描述：得到类的简写名称存入字符串TAG中
+ * 实现过程：调用getSimpleName ()函数
+ * Made By CuiCan
+ */
private static final String TAG = SqlData.class.getSimpleName();
private static final int INVALID_ID = -99999;
+ //为mDataId置初始值-99999
+
+ /**
+ * 来自Notes类中定义的DataColumn中的一些常量
+ */
+
+ // 集合了interface DataColumns中所有SF常量
public static final String[] PROJECTION_DATA = new String[] {
DataColumns.ID, DataColumns.MIME_TYPE, DataColumns.CONTENT, DataColumns.DATA1,
DataColumns.DATA3
};
+ /**
+ * 以下五个变量作为sql表中5列的编号
+ */
public static final int DATA_ID_COLUMN = 0;
public static final int DATA_MIME_TYPE_COLUMN = 1;
@@ -56,7 +75,7 @@ public class SqlData {
public static final int DATA_CONTENT_DATA_3_COLUMN = 4;
private ContentResolver mContentResolver;
-
+ //判断是否直接用Content生成，是为true，否则为false
private boolean mIsCreate;
private long mDataId;
@@ -71,10 +90,17 @@ public class SqlData {
private ContentValues mDiffDataValues;
+ /*
+ * 功能描述：构造函数，用于初始化数据
+ * 参数注解：mContentResolver用于获取ContentProvider提供的数据
+ * 参数注解： mIsCreate表征当前数据是用哪种方式创建（两种构造函数的参数不同）
+ * 参数注解：
+ * Made By CuiCan
+ */
public SqlData(Context context) {
mContentResolver = context.getContentResolver();
mIsCreate = true;
- mDataId = INVALID_ID;
+ mDataId = INVALID_ID;//mDataId置初始值-99999
mDataMimeType = DataConstants.NOTE;
mDataContent = "";
mDataContentData1 = 0;
@@ -82,6 +108,14 @@ public class SqlData {
mDiffDataValues = new ContentValues();
}
+
+ /*
+ * 功能描述：构造函数，初始化数据
+ * 参数注解：mContentResolver用于获取ContentProvider提供的数据
+ * 参数注解： mIsCreate表征当前数据是用哪种方式创建（两种构造函数的参数不同）
+ * 参数注解：
+ * Made By CuiCan
+ */
public SqlData(Context context, Cursor c) {
mContentResolver = context.getContentResolver();
mIsCreate = false;
@@ -89,6 +123,11 @@ public class SqlData {
mDiffDataValues = new ContentValues();
}
+ /*
+ * 功能描述：从光标处加载数据
+ * 从当前的光标处将五列的数据加载到该类的对象
+ * Made By CuiCan
+ */
private void loadFromCursor(Cursor c) {
mDataId = c.getLong(DATA_ID_COLUMN);
mDataMimeType = c.getString(DATA_MIME_TYPE_COLUMN);
@@ -97,7 +136,14 @@ public class SqlData {
mDataContentData3 = c.getString(DATA_CONTENT_DATA_3_COLUMN);
}
+
+ /*
+ * 功能描述：设置用于共享的数据，并提供异常抛出与处理机制
+ * 参数注解：
+ * Made By CuiCan
+ */
public void setContent(JSONObject js) throws JSONException {
+ //如果传入的JSONObject对象中有DataColumns.ID这一项，则设置，否则设为INVALID_ID，下面部分功能类似
long dataId = js.has(DataColumns.ID) ? js.getLong(DataColumns.ID) : INVALID_ID;
if (mIsCreate || mDataId != dataId) {
mDiffDataValues.put(DataColumns.ID, dataId);
@@ -130,11 +176,18 @@ public class SqlData {
mDataContentData3 = dataContentData3;
}
+
+ /*
+ * 功能描述：获取共享的数据内容，如果使用的是光标方式,就把数据存入JSONObject对象中,并提供异常抛出与处理机制
+ * 参数注解：
+ * Made By CuiCan
+ */
public JSONObject getContent() throws JSONException {
if (mIsCreate) {
Log.e(TAG, "it seems that we haven't created this in database yet");
return null;
}
+ //创建JSONObject对象。并将相关数据放入其中，并返回。
JSONObject js = new JSONObject();
js.put(DataColumns.ID, mDataId);
js.put(DataColumns.MIME_TYPE, mDataMimeType);
@@ -144,8 +197,13 @@ public class SqlData {
return js;
}
+ /*
+ * 功能描述：commit函数用于把当前所做的修改保存到数据库
+ * 参数注解：
+ * Made By CuiCan
+ */
public void commit(long noteId, boolean validateVersion, long version) {
-
+ //判断是用哪种方式设置的初始值，并执行不同操作
if (mIsCreate) {
if (mDataId == INVALID_ID && mDiffDataValues.containsKey(DataColumns.ID)) {
mDiffDataValues.remove(DataColumns.ID);
@@ -153,6 +211,7 @@ public class SqlData {
mDiffDataValues.put(DataColumns.NOTE_ID, noteId);
Uri uri = mContentResolver.insert(Notes.CONTENT_DATA_URI, mDiffDataValues);
+ //判断是否写入成功，try
try {
mDataId = Long.valueOf(uri.getPathSegments().get(1));
} catch (NumberFormatException e) {
@@ -160,14 +219,17 @@ public class SqlData {
throw new ActionFailureException("create note failed");
}
} else {
+ //判断存入mDiffDataValues中是否包含数据
if (mDiffDataValues.size() > 0) {
int result = 0;
+ //如果版本还没确认，则结果记录下的只是data的ID，还有data内容
+ //如果版本已确认，则结果还记录下所在note的Id，以及版本号；
if (!validateVersion) {
result = mContentResolver.update(ContentUris.withAppendedId(
Notes.CONTENT_DATA_URI, mDataId), mDiffDataValues, null, null);
} else {
result = mContentResolver.update(ContentUris.withAppendedId(
- Notes.CONTENT_DATA_URI, mDataId), mDiffDataValues,
+ Notes.CONTENT_DATA_URI, mDataId), mDiffDataValues,
" ? in (SELECT " + NoteColumns.ID + " FROM " + TABLE.NOTE
+ " WHERE " + NoteColumns.VERSION + "=?)", new String[] {
String.valueOf(noteId), String.valueOf(version)
@@ -178,12 +240,18 @@ public class SqlData {
}
}
}
-
+ //回到初始化，表示已更新
mDiffDataValues.clear();
mIsCreate = false;
}
+ /*
+ * 功能描述：获取当前id
+ * 实现过程：
+ * 参数注解：
+ * Made By CuiCan
+ */
public long getId() {
return mDataId;
}
-}
+}
\ No newline at end of file
diff --git a/src/main/java/net/micode/notes/gtask/data/SqlNote.java b/src/main/java/net/micode/notes/gtask/data/SqlNote.java
index 79a4095..c4d2b2d 100644
--- a/src/main/java/net/micode/notes/gtask/data/SqlNote.java
+++ b/src/main/java/net/micode/notes/gtask/data/SqlNote.java
@@ -37,12 +37,21 @@ import org.json.JSONObject;
import java.util.ArrayList;
+/*
+ * Description：用于支持小米便签最底层的数据库相关操作，和sqldata的关系上是父集关系，即note是data的父集。
+ * 和SqlData相比，SqlNote算是真正意义上的数据了。
+ */
public class SqlNote {
+ /*
+ * 功能描述：得到类的简写名称存入字符串TAG中
+ * 实现过程：调用getSimpleName ()函数
+ * Made By CuiCan
+ */
private static final String TAG = SqlNote.class.getSimpleName();
-
+ //将INVALID_ID 初始化为-99999
private static final int INVALID_ID = -99999;
-
+ // 集合了interface NoteColumns中所有SF常量（17个）
public static final String[] PROJECTION_NOTE = new String[] {
NoteColumns.ID, NoteColumns.ALERTED_DATE, NoteColumns.BG_COLOR_ID,
NoteColumns.CREATED_DATE, NoteColumns.HAS_ATTACHMENT, NoteColumns.MODIFIED_DATE,
@@ -52,6 +61,7 @@ public class SqlNote {
NoteColumns.VERSION
};
+ //以下设置17个列的编号
public static final int ID_COLUMN = 0;
public static final int ALERTED_DATE_COLUMN = 1;
@@ -86,6 +96,7 @@ public class SqlNote {
public static final int VERSION_COLUMN = 16;
+ //一下定义了17个内部的变量，其中12个可以由content中获得，5个需要初始化为0或者new
private Context mContext;
private ContentResolver mContentResolver;
@@ -122,6 +133,13 @@ public class SqlNote {
private ArrayList mDataList;
+ /*
+ * 功能描述：构造函数
+ * 参数注解： mIsCreate用于标示构造方式
+ * 参数注解：
+ * Made By CuiCan
+ */
+ //构造函数只有context，对所有的变量进行初始化
public SqlNote(Context context) {
mContext = context;
mContentResolver = context.getContentResolver();
@@ -130,8 +148,10 @@ public class SqlNote {
mAlertDate = 0;
mBgColorId = ResourceParser.getDefaultBgId(context);
mCreatedDate = System.currentTimeMillis();
+ //调用系统函数获得创建时间
mHasAttachment = 0;
mModifiedDate = System.currentTimeMillis();
+ //最后一次修改时间初始化为创建时间
mParentId = 0;
mSnippet = "";
mType = Notes.TYPE_NOTE;
@@ -143,17 +163,33 @@ public class SqlNote {
mDataList = new ArrayList();
}
+
+ /*
+ * 功能描述：构造函数
+ * 参数注解： mIsCreate用于标示构造方式
+ * 参数注解：
+ * Made By CuiCan
+ */
+ //构造函数有context和一个数据库的cursor，多数变量通过cursor指向的一条记录直接进行初始化
public SqlNote(Context context, Cursor c) {
mContext = context;
mContentResolver = context.getContentResolver();
mIsCreate = false;
loadFromCursor(c);
mDataList = new ArrayList();
+ //
if (mType == Notes.TYPE_NOTE)
loadDataContent();
mDiffNoteValues = new ContentValues();
}
+
+ /*
+ * 功能描述：构造函数
+ * 参数注解： mIsCreate用于标示构造方式
+ * 参数注解：
+ * Made By CuiCan
+ */
public SqlNote(Context context, long id) {
mContext = context;
mContentResolver = context.getContentResolver();
@@ -166,16 +202,23 @@ public class SqlNote {
}
+ /*
+ * 功能描述：通过id从光标处加载数据
+ * Made By CuiCan
+ */
private void loadFromCursor(long id) {
Cursor c = null;
try {
c = mContentResolver.query(Notes.CONTENT_NOTE_URI, PROJECTION_NOTE, "(_id=?)",
new String[] {
- String.valueOf(id)
+ String.valueOf(id)
}, null);
+ //通过id获得对应的ContentResolver中的cursor
if (c != null) {
c.moveToNext();
loadFromCursor(c);
+ //然后加载数据进行初始化，这样函数
+ //SqlNote(Context context, long id)与SqlNote(Context context, long id)的实现方式基本相同
} else {
Log.w(TAG, "loadFromCursor: cursor = null");
}
@@ -185,7 +228,12 @@ public class SqlNote {
}
}
+ /*
+ * 功能描述：通过游标从光标处加载数据
+ * Made By CuiCan
+ */
private void loadFromCursor(Cursor c) {
+ //直接从一条记录中获得以下变量的初始值
mId = c.getLong(ID_COLUMN);
mAlertDate = c.getLong(ALERTED_DATE_COLUMN);
mBgColorId = c.getInt(BG_COLOR_ID_COLUMN);
@@ -200,13 +248,18 @@ public class SqlNote {
mVersion = c.getLong(VERSION_COLUMN);
}
+ /*
+ * 功能描述：通过content机制获取共享数据并加载到数据库当前游标处
+ * 参数注解：
+ * Made By CuiCan
+ */
private void loadDataContent() {
Cursor c = null;
mDataList.clear();
try {
c = mContentResolver.query(Notes.CONTENT_DATA_URI, SqlData.PROJECTION_DATA,
"(note_id=?)", new String[] {
- String.valueOf(mId)
+ String.valueOf(mId)
}, null);
if (c != null) {
if (c.getCount() == 0) {
@@ -226,12 +279,20 @@ public class SqlNote {
}
}
+ /*
+ * 功能描述：设置通过content机制用于共享的数据信息
+ * 参数注解：
+ * Made By CuiCan
+ */
public boolean setContent(JSONObject js) {
try {
JSONObject note = js.getJSONObject(GTaskStringUtils.META_HEAD_NOTE);
+ //创建一个JSONObject对象note
+ //不能对系统文件夹进行设置操作
if (note.getInt(NoteColumns.TYPE) == Notes.TYPE_SYSTEM) {
Log.w(TAG, "cannot set system folder");
} else if (note.getInt(NoteColumns.TYPE) == Notes.TYPE_FOLDER) {
+ //文件夹只能更新摘要和类型
// for folder we can only update the snnipet and type
String snippet = note.has(NoteColumns.SNIPPET) ? note
.getString(NoteColumns.SNIPPET) : "";
@@ -247,13 +308,17 @@ public class SqlNote {
}
mType = type;
} else if (note.getInt(NoteColumns.TYPE) == Notes.TYPE_NOTE) {
+ //如果是便签则直接进入，下面一句是获取提示日期
JSONArray dataArray = js.getJSONArray(GTaskStringUtils.META_HEAD_DATA);
+ //获取数据的ID
long id = note.has(NoteColumns.ID) ? note.getLong(NoteColumns.ID) : INVALID_ID;
+ //如果只是通过上下文对note进行数据库操作，或者该ID与原ID不相同
if (mIsCreate || mId != id) {
mDiffNoteValues.put(NoteColumns.ID, id);
}
mId = id;
+ //获取数据的提醒日期
long alertDate = note.has(NoteColumns.ALERTED_DATE) ? note
.getLong(NoteColumns.ALERTED_DATE) : 0;
if (mIsCreate || mAlertDate != alertDate) {
@@ -261,13 +326,14 @@ public class SqlNote {
}
mAlertDate = alertDate;
+ //获取背景颜色ID
int bgColorId = note.has(NoteColumns.BG_COLOR_ID) ? note
.getInt(NoteColumns.BG_COLOR_ID) : ResourceParser.getDefaultBgId(mContext);
if (mIsCreate || mBgColorId != bgColorId) {
mDiffNoteValues.put(NoteColumns.BG_COLOR_ID, bgColorId);
}
mBgColorId = bgColorId;
-
+ //获取创建日期
long createDate = note.has(NoteColumns.CREATED_DATE) ? note
.getLong(NoteColumns.CREATED_DATE) : System.currentTimeMillis();
if (mIsCreate || mCreatedDate != createDate) {
@@ -275,6 +341,7 @@ public class SqlNote {
}
mCreatedDate = createDate;
+ //取数据的有无附件的布尔值
int hasAttachment = note.has(NoteColumns.HAS_ATTACHMENT) ? note
.getInt(NoteColumns.HAS_ATTACHMENT) : 0;
if (mIsCreate || mHasAttachment != hasAttachment) {
@@ -282,6 +349,7 @@ public class SqlNote {
}
mHasAttachment = hasAttachment;
+ //对最近修改日期的操作
long modifiedDate = note.has(NoteColumns.MODIFIED_DATE) ? note
.getLong(NoteColumns.MODIFIED_DATE) : System.currentTimeMillis();
if (mIsCreate || mModifiedDate != modifiedDate) {
@@ -289,6 +357,7 @@ public class SqlNote {
}
mModifiedDate = modifiedDate;
+ //获取数据的父节点ID
long parentId = note.has(NoteColumns.PARENT_ID) ? note
.getLong(NoteColumns.PARENT_ID) : 0;
if (mIsCreate || mParentId != parentId) {
@@ -296,6 +365,7 @@ public class SqlNote {
}
mParentId = parentId;
+ //对摘要操作
String snippet = note.has(NoteColumns.SNIPPET) ? note
.getString(NoteColumns.SNIPPET) : "";
if (mIsCreate || !mSnippet.equals(snippet)) {
@@ -303,6 +373,7 @@ public class SqlNote {
}
mSnippet = snippet;
+ //对类型操作
int type = note.has(NoteColumns.TYPE) ? note.getInt(NoteColumns.TYPE)
: Notes.TYPE_NOTE;
if (mIsCreate || mType != type) {
@@ -310,6 +381,7 @@ public class SqlNote {
}
mType = type;
+ //获取小部件的ID
int widgetId = note.has(NoteColumns.WIDGET_ID) ? note.getInt(NoteColumns.WIDGET_ID)
: AppWidgetManager.INVALID_APPWIDGET_ID;
if (mIsCreate || mWidgetId != widgetId) {
@@ -317,6 +389,7 @@ public class SqlNote {
}
mWidgetId = widgetId;
+ //对小部件的类型操作
int widgetType = note.has(NoteColumns.WIDGET_TYPE) ? note
.getInt(NoteColumns.WIDGET_TYPE) : Notes.TYPE_WIDGET_INVALIDE;
if (mIsCreate || mWidgetType != widgetType) {
@@ -324,6 +397,7 @@ public class SqlNote {
}
mWidgetType = widgetType;
+ //获取数据的原始父文件夹ID
long originParent = note.has(NoteColumns.ORIGIN_PARENT_ID) ? note
.getLong(NoteColumns.ORIGIN_PARENT_ID) : 0;
if (mIsCreate || mOriginParent != originParent) {
@@ -331,6 +405,7 @@ public class SqlNote {
}
mOriginParent = originParent;
+ //遍历 dataArray，查找 id 为 dataId 的数据
for (int i = 0; i < dataArray.length(); i++) {
JSONObject data = dataArray.getJSONObject(i);
SqlData sqlData = null;
@@ -359,6 +434,11 @@ public class SqlNote {
return true;
}
+ /*
+ * 功能描述：获取content机制提供的数据并加载到note中
+ * 参数注解：
+ * Made By CuiCan
+ */
public JSONObject getContent() {
try {
JSONObject js = new JSONObject();
@@ -370,6 +450,7 @@ public class SqlNote {
JSONObject note = new JSONObject();
if (mType == Notes.TYPE_NOTE) {
+ //类型为note时,将13个键值对的值写入note中，然后再设置为js键值对中的一个值
note.put(NoteColumns.ID, mId);
note.put(NoteColumns.ALERTED_DATE, mAlertDate);
note.put(NoteColumns.BG_COLOR_ID, mBgColorId);
@@ -385,14 +466,17 @@ public class SqlNote {
js.put(GTaskStringUtils.META_HEAD_NOTE, note);
JSONArray dataArray = new JSONArray();
+ //将note中的所有数据存进dataarray中
for (SqlData sqlData : mDataList) {
JSONObject data = sqlData.getContent();
if (data != null) {
dataArray.put(data);
}
}
+ //将dataArray存进js中
js.put(GTaskStringUtils.META_HEAD_DATA, dataArray);
} else if (mType == Notes.TYPE_FOLDER || mType == Notes.TYPE_SYSTEM) {
+ //类型为文件夹或者系统文件类型
note.put(NoteColumns.ID, mId);
note.put(NoteColumns.TYPE, mType);
note.put(NoteColumns.SNIPPET, mSnippet);
@@ -407,45 +491,92 @@ public class SqlNote {
return null;
}
+ /*
+ * 功能描述：给当前id设置父id
+ * 参数注解：
+ * Made By CuiCan
+ */
public void setParentId(long id) {
mParentId = id;
mDiffNoteValues.put(NoteColumns.PARENT_ID, id);
}
+ /*
+ * 功能描述：用当前id设置Gtaskid
+ * 参数注解：
+ * Made By CuiCan
+ */
public void setGtaskId(String gid) {
mDiffNoteValues.put(NoteColumns.GTASK_ID, gid);
}
+ /*
+ * 功能描述：给当前id设置同步id
+ * 参数注解：
+ * Made By CuiCan
+ */
public void setSyncId(long syncId) {
mDiffNoteValues.put(NoteColumns.SYNC_ID, syncId);
}
+ /*
+ * 功能描述：初始化本地修改，即撤销所有当前修改
+ * 参数注解：
+ * Made By CuiCan
+ */
public void resetLocalModified() {
mDiffNoteValues.put(NoteColumns.LOCAL_MODIFIED, 0);
}
+ /*
+ * 功能描述：获得当前id
+ * 参数注解：
+ * Made By CuiCan
+ */
public long getId() {
return mId;
}
+ /*
+ * 功能描述：获得当前id的父id
+ * 参数注解：
+ * Made By CuiCan
+ */
public long getParentId() {
return mParentId;
}
+ /*
+ * 功能描述：获取小片段即用于显示的部分便签内容
+ * 参数注解：
+ * Made By CuiCan
+ */
public String getSnippet() {
return mSnippet;
}
+ /*
+ * 功能描述：判断是否为便签类型
+ * 参数注解：
+ * Made By CuiCan
+ */
public boolean isNoteType() {
return mType == Notes.TYPE_NOTE;
}
+ /*
+ * 功能描述：commit函数用于把当前所做的修改保存到数据库
+ * 参数注解：
+ * Made By CuiCan
+ */
public void commit(boolean validateVersion) {
if (mIsCreate) {
+ //如果是第一种构造方式，ID为无效ID且包含该ID，则删除
if (mId == INVALID_ID && mDiffNoteValues.containsKey(NoteColumns.ID)) {
mDiffNoteValues.remove(NoteColumns.ID);
}
+ //插入便签的uri
Uri uri = mContentResolver.insert(Notes.CONTENT_NOTE_URI, mDiffNoteValues);
try {
mId = Long.valueOf(uri.getPathSegments().get(1));
@@ -458,11 +589,14 @@ public class SqlNote {
}
if (mType == Notes.TYPE_NOTE) {
+ //如果类型为便签类型
for (SqlData sqlData : mDataList) {
+ //直接使用sqldata中的实现方法来实现
sqlData.commit(mId, false, -1);
}
}
} else {
+ //如果该便签ID是无效ID，报错：没有这个便签
if (mId <= 0 && mId != Notes.ID_ROOT_FOLDER && mId != Notes.ID_CALL_RECORD_FOLDER) {
Log.e(TAG, "No such note");
throw new IllegalStateException("Try to update note with invalid id");
@@ -471,35 +605,39 @@ public class SqlNote {
mVersion ++;
int result = 0;
if (!validateVersion) {
+ //构造字符串
result = mContentResolver.update(Notes.CONTENT_NOTE_URI, mDiffNoteValues, "("
+ NoteColumns.ID + "=?)", new String[] {
- String.valueOf(mId)
+ String.valueOf(mId)
});
} else {
result = mContentResolver.update(Notes.CONTENT_NOTE_URI, mDiffNoteValues, "("
- + NoteColumns.ID + "=?) AND (" + NoteColumns.VERSION + "<=?)",
+ + NoteColumns.ID + "=?) AND (" + NoteColumns.VERSION + "<=?)",
new String[] {
String.valueOf(mId), String.valueOf(mVersion)
});
}
+ //如果内容解析器没有更新，那么报错：没有更新，或许用户在同步时进行更新
if (result == 0) {
Log.w(TAG, "there is no update. maybe user updates note when syncing");
}
}
if (mType == Notes.TYPE_NOTE) {
+ //如果类型为便签类型，那么就调用SqlData中的方法来写入修改记录
for (SqlData sqlData : mDataList) {
sqlData.commit(mId, validateVersion, mVersion);
}
}
}
- // refresh local info
+ //通过 cursor 从当前 id 处加载数据
loadFromCursor(mId);
if (mType == Notes.TYPE_NOTE)
loadDataContent();
-
+ //清空，回到初始化状态
mDiffNoteValues.clear();
+ //改变数据库构造模式
mIsCreate = false;
}
-}
+}
\ No newline at end of file
diff --git a/src/main/java/net/micode/notes/gtask/data/Task.java b/src/main/java/net/micode/notes/gtask/data/Task.java
index 6a19454..10acf09 100644
--- a/src/main/java/net/micode/notes/gtask/data/Task.java
+++ b/src/main/java/net/micode/notes/gtask/data/Task.java
@@ -30,37 +30,44 @@ import net.micode.notes.tool.GTaskStringUtils;
import org.json.JSONArray;
import org.json.JSONException;
import org.json.JSONObject;
-
-
+//创建Task类（继承父类Node）
public class Task extends Node {
+ //通过getSimpleName（）获得类名
private static final String TAG = Task.class.getSimpleName();
private boolean mCompleted;
+ //是否完成
private String mNotes;
private JSONObject mMetaInfo;
+ //将在实例中存储数据的类型
private Task mPriorSibling;
+ //对应的优先兄弟Task的指针
private TaskList mParent;
+ //所在的任务列表的指针
public Task() {
+ //调用父类的构造方法
super();
mCompleted = false;
mNotes = null;
- mPriorSibling = null;
- mParent = null;
+ mPriorSibling = null;//TaskList中当前Task前面的Task的指针
+ mParent = null;//当前Task所在的TaskList
mMetaInfo = null;
}
public JSONObject getCreateAction(int actionId) {
+ //新建一个 JSONObject 的对象用来存放同步过程中所用到的 task 信息
JSONObject js = new JSONObject();
try {
// action_type
js.put(GTaskStringUtils.GTASK_JSON_ACTION_TYPE,
GTaskStringUtils.GTASK_JSON_ACTION_TYPE_CREATE);
+ //共享数据存入动作类型action_ type,以下同类
// action_id
js.put(GTaskStringUtils.GTASK_JSON_ACTION_ID, actionId);
@@ -68,26 +75,32 @@ public class Task extends Node {
// index
js.put(GTaskStringUtils.GTASK_JSON_INDEX, mParent.getChildTaskIndex(this));
- // entity_delta
+ // 创建实体数据并将name，创建者id，实体类型存入数据
JSONObject entity = new JSONObject();
entity.put(GTaskStringUtils.GTASK_JSON_NAME, getName());
entity.put(GTaskStringUtils.GTASK_JSON_CREATOR_ID, "null");
entity.put(GTaskStringUtils.GTASK_JSON_ENTITY_TYPE,
GTaskStringUtils.GTASK_JSON_TYPE_TASK);
+ //如果存在Note，也将其放入entity
if (getNotes() != null) {
entity.put(GTaskStringUtils.GTASK_JSON_NOTES, getNotes());
}
+ //实体存入js
js.put(GTaskStringUtils.GTASK_JSON_ENTITY_DELTA, entity);
// parent_id
- js.put(GTaskStringUtils.GTASK_JSON_PARENT_ID, mParent.getGid());
+ if (mParent!= null) {
+ js.put(GTaskStringUtils.GTASK_JSON_PARENT_ID, mParent.getGid());
+ }
// dest_parent_type
js.put(GTaskStringUtils.GTASK_JSON_DEST_PARENT_TYPE,
GTaskStringUtils.GTASK_JSON_TYPE_GROUP);
// list_id
- js.put(GTaskStringUtils.GTASK_JSON_LIST_ID, mParent.getGid());
+ if (mParent!= null) {
+ js.put(GTaskStringUtils.GTASK_JSON_LIST_ID, mParent.getGid());
+ }
// prior_sibling_id
if (mPriorSibling != null) {
@@ -95,6 +108,7 @@ public class Task extends Node {
}
} catch (JSONException e) {
+ //异常处理，当create task'失败时
Log.e(TAG, e.toString());
e.printStackTrace();
throw new ActionFailureException("fail to generate task-create jsonobject");
@@ -104,6 +118,7 @@ public class Task extends Node {
}
public JSONObject getUpdateAction(int actionId) {
+ //此函数和上一个getCreatAction（）的功能差不多，一个是creat，一个updata，都是对action进行操作
JSONObject js = new JSONObject();
try {
@@ -136,6 +151,7 @@ public class Task extends Node {
}
public void setContentByRemoteJSON(JSONObject js) {
+ //通过远端的jsonobject获取任务内容,如果有相应的数据，就设置NOTE中的值
if (js != null) {
try {
// id
@@ -176,8 +192,10 @@ public class Task extends Node {
}
public void setContentByLocalJSON(JSONObject js) {
+ ////通过本地的jsonobject获取任务内容,如果有相应的数据，就设置NOTE中的值
if (js == null || !js.has(GTaskStringUtils.META_HEAD_NOTE)
|| !js.has(GTaskStringUtils.META_HEAD_DATA)) {
+ //如果js不存在或者js没有元数据的开头或者js指针没有元数据
Log.w(TAG, "setContentByLocalJSON: nothing is avaiable");
}
@@ -193,6 +211,7 @@ public class Task extends Node {
for (int i = 0; i < dataArray.length(); i++) {
JSONObject data = dataArray.getJSONObject(i);
if (TextUtils.equals(data.getString(DataColumns.MIME_TYPE), DataConstants.NOTE)) {
+ //遍历 dataArray 查找与数据库中DataConstants.NOTE 记录信息一致的 data
setName(data.getString(DataColumns.CONTENT));
break;
}
@@ -205,10 +224,11 @@ public class Task extends Node {
}
public JSONObject getLocalJSONFromContent() {
+ //通过内容更新本地的jsonobject
String name = getName();
try {
if (mMetaInfo == null) {
- // new task created from web
+ //元数据类型信息为空，若名字也为空则新建一个 JSONObject 对象并将其返回
if (name == null) {
Log.w(TAG, "the note seems to be an empty one");
return null;
@@ -225,7 +245,7 @@ public class Task extends Node {
js.put(GTaskStringUtils.META_HEAD_NOTE, note);
return js;
} else {
- // synced task
+ // 否则将元数据同步至数据中
JSONObject note = mMetaInfo.getJSONObject(GTaskStringUtils.META_HEAD_NOTE);
JSONArray dataArray = mMetaInfo.getJSONArray(GTaskStringUtils.META_HEAD_DATA);
@@ -248,6 +268,7 @@ public class Task extends Node {
}
public void setMetaInfo(MetaData metaData) {
+ //设置元数据信息
if (metaData != null && metaData.getNotes() != null) {
try {
mMetaInfo = new JSONObject(metaData.getNotes());
@@ -259,28 +280,32 @@ public class Task extends Node {
}
public int getSyncAction(Cursor c) {
+ // 异常处理，进行同步操作，如果不成功按照对应的情况进行异常信息的反馈，比如远端文档被删除、文档不匹配等等
try {
JSONObject noteInfo = null;
if (mMetaInfo != null && mMetaInfo.has(GTaskStringUtils.META_HEAD_NOTE)) {
+ //元数据信息不为空并且元数据信息还含有“META_HEAD_NOTE”，说明便签存在
noteInfo = mMetaInfo.getJSONObject(GTaskStringUtils.META_HEAD_NOTE);
}
if (noteInfo == null) {
+ //数据未写入时写入日志
Log.w(TAG, "it seems that note meta has been deleted");
return SYNC_ACTION_UPDATE_REMOTE;
}
-
+ //如果没有ID
if (!noteInfo.has(NoteColumns.ID)) {
Log.w(TAG, "remote note id seems to be deleted");
return SYNC_ACTION_UPDATE_LOCAL;
}
- // validate the note id now
+ // 如果是无效ID
if (c.getLong(SqlNote.ID_COLUMN) != noteInfo.getLong(NoteColumns.ID)) {
Log.w(TAG, "note id doesn't match");
return SYNC_ACTION_UPDATE_LOCAL;
}
+ //
if (c.getInt(SqlNote.LOCAL_MODIFIED_COLUMN) == 0) {
// there is no local update
if (c.getLong(SqlNote.SYNC_ID_COLUMN) == getLastModified()) {
@@ -312,6 +337,8 @@ public class Task extends Node {
}
public boolean isWorthSaving() {
+ //判断是否值得存放，即当前数据是否有效，若数据非空 或 名字合法存在且去除空格后的名字长度大于零则返回真值。
+ //其中 trim() 的作用是去除字符串前后的空格：public String trim()返回字符串的副本，忽略前导空白和尾部空白
return mMetaInfo != null || (getName() != null && getName().trim().length() > 0)
|| (getNotes() != null && getNotes().trim().length() > 0);
}
@@ -319,33 +346,41 @@ public class Task extends Node {
public void setCompleted(boolean completed) {
this.mCompleted = completed;
}
+ //设定是否完成的成员变量
public void setNotes(String notes) {
this.mNotes = notes;
}
+ //设定是note成员变量
public void setPriorSibling(Task priorSibling) {
this.mPriorSibling = priorSibling;
}
+ //.设置优先兄弟 task 的优先级
public void setParent(TaskList parent) {
this.mParent = parent;
}
+ //设置父节点列表
public boolean getCompleted() {
return this.mCompleted;
}
+ //获取 task 是否修改完毕的记录
public String getNotes() {
+ //获取成员变量 mNotes 的信息
return this.mNotes;
}
public Task getPriorSibling() {
return this.mPriorSibling;
}
+ //获取优先兄弟 task
public TaskList getParent() {
return this.mParent;
}
+ //获取父节点列表
-}
+}
\ No newline at end of file
diff --git a/src/main/java/net/micode/notes/gtask/data/TaskList.java b/src/main/java/net/micode/notes/gtask/data/TaskList.java
index 4ea21c5..5a7b09a 100644
--- a/src/main/java/net/micode/notes/gtask/data/TaskList.java
+++ b/src/main/java/net/micode/notes/gtask/data/TaskList.java
@@ -29,13 +29,12 @@ import org.json.JSONObject;
import java.util.ArrayList;
-
public class TaskList extends Node {
- private static final String TAG = TaskList.class.getSimpleName();
+ private static final String TAG = TaskList.class.getSimpleName();//tag标记
- private int mIndex;
+ private int mIndex;//当前TaskList的指针
- private ArrayList mChildren;
+ private ArrayList mChildren;//类中主要的保存数据的单元，用来实现一个以Task为元素的ArrayList
public TaskList() {
super();
@@ -43,6 +42,10 @@ public class TaskList extends Node {
mIndex = 1;
}
+ /* (non-Javadoc)
+ * @see net.micode.notes.gtask.data.Node#getCreateAction(int)
+ * 生成并返回一个包含了一定数据的JSONObject实体
+ */
public JSONObject getCreateAction(int actionId) {
JSONObject js = new JSONObject();
@@ -58,7 +61,7 @@ public class TaskList extends Node {
js.put(GTaskStringUtils.GTASK_JSON_INDEX, mIndex);
// entity_delta
- JSONObject entity = new JSONObject();
+ JSONObject entity = new JSONObject();//entity实体
entity.put(GTaskStringUtils.GTASK_JSON_NAME, getName());
entity.put(GTaskStringUtils.GTASK_JSON_CREATOR_ID, "null");
entity.put(GTaskStringUtils.GTASK_JSON_ENTITY_TYPE,
@@ -74,6 +77,10 @@ public class TaskList extends Node {
return js;
}
+ /* (non-Javadoc)
+ * @see net.micode.notes.gtask.data.Node#getUpdateAction(int)
+ * 生成并返回一个包含了一定数据的JSONObject实体
+ */
public JSONObject getUpdateAction(int actionId) {
JSONObject js = new JSONObject();
@@ -216,10 +223,19 @@ public class TaskList extends Node {
return SYNC_ACTION_ERROR;
}
+ /**
+ * @return
+ * 功能：获得TaskList的大小，即mChildren的大小
+ */
public int getChildTaskCount() {
return mChildren.size();
}
+ /**
+ * @param task
+ * @return 返回值为是否成功添加任务。
+ * 功能：在当前任务表末尾添加新的任务。
+ */
public boolean addChildTask(Task task) {
boolean ret = false;
if (task != null && !mChildren.contains(task)) {
@@ -229,11 +245,19 @@ public class TaskList extends Node {
task.setPriorSibling(mChildren.isEmpty() ? null : mChildren
.get(mChildren.size() - 1));
task.setParent(this);
+ //注意：每一次ArrayList的变化都要紧跟相关Task中PriorSibling的更改
+ //，接下来几个函数都有相关操作
}
}
return ret;
}
+ /**
+ * @param task
+ * @param index
+ * @return
+ * 功能：在当前任务表的指定位置添加新的任务。
+ */
public boolean addChildTask(Task task, int index) {
if (index < 0 || index > mChildren.size()) {
Log.e(TAG, "add child task: invalid index");
@@ -260,6 +284,11 @@ public class TaskList extends Node {
return true;
}
+ /**
+ * @param task
+ * @return 返回删除是否成功
+ * 功能：删除TaskList中的一个Task
+ */
public boolean removeChildTask(Task task) {
boolean ret = false;
int index = mChildren.indexOf(task);
@@ -281,6 +310,12 @@ public class TaskList extends Node {
return ret;
}
+ /**
+ * @param task
+ * @param index
+ * @return
+ * 功能：将当前TaskList中含有的某个Task移到index位置
+ */
public boolean moveChildTask(Task task, int index) {
if (index < 0 || index >= mChildren.size()) {
@@ -297,8 +332,14 @@ public class TaskList extends Node {
if (pos == index)
return true;
return (removeChildTask(task) && addChildTask(task, index));
+ //利用已实现好的功能完成当下功能；
}
+ /**
+ * @param gid
+ * @return返回寻找结果
+ * 功能：按gid寻找Task
+ */
public Task findChildTaskByGid(String gid) {
for (int i = 0; i < mChildren.size(); i++) {
Task t = mChildren.get(i);
@@ -309,10 +350,20 @@ public class TaskList extends Node {
return null;
}
+ /**
+ * @param task
+ * @return
+ * 功能：返回指定Task的index
+ */
public int getChildTaskIndex(Task task) {
return mChildren.indexOf(task);
}
+ /**
+ * @param index
+ * @return
+ * 功能：返回指定index的Task
+ */
public Task getChildTaskByIndex(int index) {
if (index < 0 || index >= mChildren.size()) {
Log.e(TAG, "getTaskByIndex: invalid index");
@@ -321,8 +372,13 @@ public class TaskList extends Node {
return mChildren.get(index);
}
+ /**
+ * @param gid
+ * @return
+ * 功能：返回指定gid的Task
+ */
public Task getChilTaskByGid(String gid) {
- for (Task task : mChildren) {
+ for (Task task : mChildren) {//一种常见的ArrayList的遍历方法（四种，见精读笔记）
if (task.getGid().equals(gid))
return task;
}
@@ -340,4 +396,4 @@ public class TaskList extends Node {
public int getIndex() {
return this.mIndex;
}
-}
+}
\ No newline at end of file
diff --git a/src/main/java/net/micode/notes/gtask/exception/ActionFailureException.java b/src/main/java/net/micode/notes/gtask/exception/ActionFailureException.java
index 15504be..5e775b2 100644
--- a/src/main/java/net/micode/notes/gtask/exception/ActionFailureException.java
+++ b/src/main/java/net/micode/notes/gtask/exception/ActionFailureException.java
@@ -15,14 +15,27 @@
*/
package net.micode.notes.gtask.exception;
-
+/*
+ * Description：支持小米便签运行过程中的运行异常处理。
+ */
public class ActionFailureException extends RuntimeException {
private static final long serialVersionUID = 4425249765923293627L;
+ /*
+ * serialVersionUID相当于java类的身份证。主要用于版本控制。
+ * serialVersionUID作用是序列化时保持版本的兼容性，即在版本升级时反序列化仍保持对象的唯一性。
+ * Made By Cuican
+ */
public ActionFailureException() {
super();
}
-
+ /*
+ * 在JAVA类中使用super来引用父类的成分，用this来引用当前对象.
+ * 如果一个类从另外一个类继承，我们new这个子类的实例对象的时候，这个子类对象里面会有一个父类对象。
+ * 怎么去引用里面的父类对象呢？使用super来引用
+ * 也就是说，此处super()以及super (paramString)可认为是Exception ()和Exception (paramString)
+ * Made By Cuican
+ */
public ActionFailureException(String paramString) {
super(paramString);
}
diff --git a/src/main/java/net/micode/notes/gtask/exception/NetworkFailureException.java b/src/main/java/net/micode/notes/gtask/exception/NetworkFailureException.java
index b08cfb1..bfbda3e 100644
--- a/src/main/java/net/micode/notes/gtask/exception/NetworkFailureException.java
+++ b/src/main/java/net/micode/notes/gtask/exception/NetworkFailureException.java
@@ -15,14 +15,29 @@
*/
package net.micode.notes.gtask.exception;
+/*
+ * Description：支持小米便签运行过程中的网络异常处理。
+ */
public class NetworkFailureException extends Exception {
private static final long serialVersionUID = 2107610287180234136L;
+ /*
+ * serialVersionUID相当于java类的身份证。主要用于版本控制。
+ * serialVersionUID作用是序列化时保持版本的兼容性，即在版本升级时反序列化仍保持对象的唯一性。
+ * Made By Cuican
+ */
public NetworkFailureException() {
super();
}
+ /*
+ * 在JAVA类中使用super来引用父类的成分，用this来引用当前对象.
+ * 如果一个类从另外一个类继承，我们new这个子类的实例对象的时候，这个子类对象里面会有一个父类对象。
+ * 怎么去引用里面的父类对象呢？使用super来引用
+ * 也就是说，此处super()以及super (paramString)可认为是Exception ()和Exception (paramString)
+ * Made By Cuican
+ */
public NetworkFailureException(String paramString) {
super(paramString);
}
@@ -30,4 +45,4 @@ public class NetworkFailureException extends Exception {
public NetworkFailureException(String paramString, Throwable paramThrowable) {
super(paramString, paramThrowable);
}
-}
+}
\ No newline at end of file
diff --git a/src/main/java/net/micode/notes/gtask/remote/GTaskASyncTask.java b/src/main/java/net/micode/notes/gtask/remote/GTaskASyncTask.java
index afc2fe1..dee9cd3 100644
--- a/src/main/java/net/micode/notes/gtask/remote/GTaskASyncTask.java
+++ b/src/main/java/net/micode/notes/gtask/remote/GTaskASyncTask.java
@@ -29,8 +29,16 @@ import net.micode.notes.ui.NotesListActivity;
import net.micode.notes.ui.NotesPreferenceActivity;
+/*异步操作类，实现GTask的异步操作过程
+ * 主要方法：
+ * private void showNotification(int tickerId, String content) 向用户提示当前同步的状态，是一个用于交互的方法
+ * protected Integer doInBackground(Void... unused) 此方法在后台线程执行，完成任务的主要工作，通常需要较长的时间
+ * protected void onProgressUpdate(String... progress) 可以使用进度条增加用户体验度。 此方法在主线程执行，用于显示任务执行的进度。
+ * protected void onPostExecute(Integer result) 相当于Handler 处理UI的方式，在这里面可以使用在doInBackground 得到的结果处理操作UI
+ */
public class GTaskASyncTask extends AsyncTask {
+
private static int GTASK_SYNC_NOTIFICATION_ID = 5234235;
public interface OnCompleteListener {
@@ -57,9 +65,9 @@ public class GTaskASyncTask extends AsyncTask {
mTaskManager.cancelSync();
}
- public void publishProgess(String message) {
+ public void publishProgess(String message) { // 发布进度单位，系统将会调用onProgressUpdate()方法更新这些值
publishProgress(new String[] {
- message
+ message
});
}
@@ -85,28 +93,47 @@ public class GTaskASyncTask extends AsyncTask {
Notification notification=builder.getNotification();
mNotifiManager.notify(GTASK_SYNC_NOTIFICATION_ID, notification);
}
+ //旧版code,已不适用,故删除
+// private void showNotification(int tickerId, String content) {
+// Notification notification = new Notification(R.drawable.notification, mContext
+// .getString(tickerId), System.currentTimeMillis());
+// notification.defaults = Notification.DEFAULT_LIGHTS; // 调用系统自带灯光
+// notification.flags = Notification.FLAG_AUTO_CANCEL; // 点击清除按钮或点击通知后会自动消失
+// PendingIntent pendingIntent; //一个描述了想要启动一个Activity、Broadcast或是Service的意图
+// if (tickerId != R.string.ticker_success) {
+// pendingIntent = PendingIntent.getActivity(mContext, 0, new Intent(mContext,
+// NotesPreferenceActivity.class), 0); //如果同步不成功，那么从系统取得一个用于启动一个NotesPreferenceActivity的PendingIntent对象
+//
+// } else {
+// pendingIntent = PendingIntent.getActivity(mContext, 0, new Intent(mContext,
+// NotesListActivity.class), 0); //如果同步成功，那么从系统取得一个用于启动一个NotesListActivity的PendingIntent对象
+// }
+// notification.setLatestEventInfo(mContext, mContext.getString(R.string.app_name), content,
+// pendingIntent);
+// mNotifiManager.notify(GTASK_SYNC_NOTIFICATION_ID, notification);//通过NotificationManager对象的notify（）方法来执行一个notification的消息
+// }
@Override
protected Integer doInBackground(Void... unused) {
publishProgess(mContext.getString(R.string.sync_progress_login, NotesPreferenceActivity
- .getSyncAccountName(mContext)));
- return mTaskManager.sync(mContext, this);
+ .getSyncAccountName(mContext))); //利用getString,将把 NotesPreferenceActivity.getSyncAccountName(mContext))的字符串内容传进sync_progress_login中
+ return mTaskManager.sync(mContext, this); //进行后台同步具体操作
}
@Override
protected void onProgressUpdate(String... progress) {
showNotification(R.string.ticker_syncing, progress[0]);
- if (mContext instanceof GTaskSyncService) {
+ if (mContext instanceof GTaskSyncService) { //instanceof 判断mContext是否是GTaskSyncService的实例
((GTaskSyncService) mContext).sendBroadcast(progress[0]);
}
}
@Override
- protected void onPostExecute(Integer result) {
+ protected void onPostExecute(Integer result) { //用于在执行完后台任务后更新UI,显示结果
if (result == GTaskManager.STATE_SUCCESS) {
showNotification(R.string.ticker_success, mContext.getString(
R.string.success_sync_account, mTaskManager.getSyncAccount()));
- NotesPreferenceActivity.setLastSyncTime(mContext, System.currentTimeMillis());
+ NotesPreferenceActivity.setLastSyncTime(mContext, System.currentTimeMillis()); //设置最新同步的时间
} else if (result == GTaskManager.STATE_NETWORK_ERROR) {
showNotification(R.string.ticker_fail, mContext.getString(R.string.error_sync_network));
} else if (result == GTaskManager.STATE_INTERNAL_ERROR) {
@@ -114,14 +141,14 @@ public class GTaskASyncTask extends AsyncTask {
} else if (result == GTaskManager.STATE_SYNC_CANCELLED) {
showNotification(R.string.ticker_cancel, mContext
.getString(R.string.error_sync_cancelled));
- }
+ } //几种不同情况下的结果显示
if (mOnCompleteListener != null) {
- new Thread(new Runnable() {
+ new Thread(new Runnable() { //这里好像是方法内的一个线程，但是并不太懂什么意思
- public void run() {
+ public void run() { //完成后的操作，使用onComplete()将所有值都重新初始化，相当于完成一次操作
mOnCompleteListener.onComplete();
}
}).start();
}
}
-}
+}
\ No newline at end of file
diff --git a/src/main/java/net/micode/notes/gtask/remote/GTaskClient.java b/src/main/java/net/micode/notes/gtask/remote/GTaskClient.java
index c67dfdf..8bdf6d3 100644
--- a/src/main/java/net/micode/notes/gtask/remote/GTaskClient.java
+++ b/src/main/java/net/micode/notes/gtask/remote/GTaskClient.java
@@ -61,10 +61,14 @@ import java.util.zip.Inflater;
import java.util.zip.InflaterInputStream;
+/*
+ * 主要功能：实现GTASK的登录操作，进行GTASK任务的创建，创建任务列表，从网络上获取任务和任务列表的内容
+ * 主要使用类或技术：accountManager JSONObject HttpParams authToken Gid
+ */
public class GTaskClient {
private static final String TAG = GTaskClient.class.getSimpleName();
- private static final String GTASK_URL = "https://mail.google.com/tasks/";
+ private static final String GTASK_URL = "https://mail.google.com/tasks/"; //这个是指定的URL
private static final String GTASK_GET_URL = "https://mail.google.com/tasks/ig";
@@ -102,6 +106,10 @@ public class GTaskClient {
mUpdateArray = null;
}
+ /*用来获取的实例化对象
+ * 使用 getInstance()
+ * 返回mInstance这个实例化对象
+ */
public static synchronized GTaskClient getInstance() {
if (mInstance == null) {
mInstance = new GTaskClient();
@@ -109,42 +117,50 @@ public class GTaskClient {
return mInstance;
}
+ /*用来实现登录操作的函数，传入的参数是一个Activity
+ * 设置登录操作限制时间，如果超时则需要重新登录
+ * 有两种登录方式，使用用户自己的URL登录或者使用谷歌官方的URL登录
+ * 返回true或者false，即最后是否登陆成功
+ */
public boolean login(Activity activity) {
// we suppose that the cookie would expire after 5 minutes
// then we need to re-login
+ //判断距离最后一次登录操作是否超过5分钟
final long interval = 1000 * 60 * 5;
if (mLastLoginTime + interval < System.currentTimeMillis()) {
mLoggedin = false;
}
- // need to re-login after account switch
+ // need to re-login after account switch 重新登录操作
if (mLoggedin
&& !TextUtils.equals(getSyncAccount().name, NotesPreferenceActivity
- .getSyncAccountName(activity))) {
+ .getSyncAccountName(activity))) {
mLoggedin = false;
}
+ //如果没超过时间，则不需要重新登录
if (mLoggedin) {
Log.d(TAG, "already logged in");
return true;
}
- mLastLoginTime = System.currentTimeMillis();
- String authToken = loginGoogleAccount(activity, false);
+ mLastLoginTime = System.currentTimeMillis();//更新最后登录时间，改为系统当前的时间
+ String authToken = loginGoogleAccount(activity, false);//判断是否登录到谷歌账户
if (authToken == null) {
Log.e(TAG, "login google account failed");
return false;
}
// login with custom domain if necessary
- if (!(mAccount.name.toLowerCase().endsWith("gmail.com") || mAccount.name.toLowerCase()
+ //尝试使用用户自己的域名登录
+ if (!(mAccount.name.toLowerCase().endsWith("gmail.com") || mAccount.name.toLowerCase() //将用户账号名改为统一格式（小写）后判断是否为一个谷歌账号地址
.endsWith("googlemail.com"))) {
StringBuilder url = new StringBuilder(GTASK_URL).append("a/");
int index = mAccount.name.indexOf('@') + 1;
String suffix = mAccount.name.substring(index);
url.append(suffix + "/");
- mGetUrl = url.toString() + "ig";
- mPostUrl = url.toString() + "r/ig";
+ mGetUrl = url.toString() + "ig"; //设置用户对应的getUrl
+ mPostUrl = url.toString() + "r/ig"; //设置用户对应的postUrl
if (tryToLoginGtask(activity, authToken)) {
mLoggedin = true;
@@ -152,6 +168,7 @@ public class GTaskClient {
}
// try to login with google official url
+ //如果用户账户无法登录，则使用谷歌官方的URI进行登录
if (!mLoggedin) {
mGetUrl = GTASK_GET_URL;
mPostUrl = GTASK_POST_URL;
@@ -164,10 +181,15 @@ public class GTaskClient {
return true;
}
+ /*具体实现登录谷歌账户的方法
+ * 使用令牌机制
+ * 使用AccountManager来管理注册账号
+ * 返回值是账号的令牌
+ */
private String loginGoogleAccount(Activity activity, boolean invalidateToken) {
- String authToken;
- AccountManager accountManager = AccountManager.get(activity);
- Account[] accounts = accountManager.getAccountsByType("com.google");
+ String authToken; //令牌，是登录操作保证安全性的一个方法
+ AccountManager accountManager = AccountManager.get(activity);//AccountManager这个类给用户提供了集中注册账号的接口
+ Account[] accounts = accountManager.getAccountsByType("com.google");//获取全部以com.google结尾的account
if (accounts.length == 0) {
Log.e(TAG, "there is no available google account");
@@ -176,6 +198,7 @@ public class GTaskClient {
String accountName = NotesPreferenceActivity.getSyncAccountName(activity);
Account account = null;
+ //遍历获得的accounts信息，寻找已经记录过的账户信息
for (Account a : accounts) {
if (a.name.equals(accountName)) {
account = a;
@@ -190,11 +213,13 @@ public class GTaskClient {
}
// get the token now
+ //获取选中账号的令牌
AccountManagerFuture accountManagerFuture = accountManager.getAuthToken(account,
"goanna_mobile", null, activity, null, null);
try {
Bundle authTokenBundle = accountManagerFuture.getResult();
authToken = authTokenBundle.getString(AccountManager.KEY_AUTHTOKEN);
+ //如果是invalidateToken，那么需要调用invalidateAuthToken(String, String)方法废除这个无效token
if (invalidateToken) {
accountManager.invalidateAuthToken("com.google", authToken);
loginGoogleAccount(activity, false);
@@ -207,10 +232,12 @@ public class GTaskClient {
return authToken;
}
+ //尝试登陆Gtask，这只是一个预先判断令牌是否是有效以及是否能登上GTask的方法,而不是具体实现登陆的方法
private boolean tryToLoginGtask(Activity activity, String authToken) {
if (!loginGtask(authToken)) {
- // maybe the auth token is out of date, now let's invalidate the
+ // maybe the auth token is out of authTokedate, now let's invalidate the
// token and try again
+ //删除过一个无效的authToken，申请一个新的后再次尝试登陆
authToken = loginGoogleAccount(activity, true);
if (authToken == null) {
Log.e(TAG, "login google account failed");
@@ -225,25 +252,27 @@ public class GTaskClient {
return true;
}
+ //实现登录GTask的具体操作
private boolean loginGtask(String authToken) {
int timeoutConnection = 10000;
- int timeoutSocket = 15000;
- HttpParams httpParameters = new BasicHttpParams();
- HttpConnectionParams.setConnectionTimeout(httpParameters, timeoutConnection);
- HttpConnectionParams.setSoTimeout(httpParameters, timeoutSocket);
+ int timeoutSocket = 15000; //socket是一种通信连接实现数据的交换的端口
+ HttpParams httpParameters = new BasicHttpParams(); //实例化一个新的HTTP参数类
+ HttpConnectionParams.setConnectionTimeout(httpParameters, timeoutConnection);//设置连接超时时间
+ HttpConnectionParams.setSoTimeout(httpParameters, timeoutSocket);//设置设置端口超时时间
mHttpClient = new DefaultHttpClient(httpParameters);
- BasicCookieStore localBasicCookieStore = new BasicCookieStore();
+ BasicCookieStore localBasicCookieStore = new BasicCookieStore(); //设置本地cookie
mHttpClient.setCookieStore(localBasicCookieStore);
HttpProtocolParams.setUseExpectContinue(mHttpClient.getParams(), false);
// login gtask
try {
- String loginUrl = mGetUrl + "?auth=" + authToken;
- HttpGet httpGet = new HttpGet(loginUrl);
+ String loginUrl = mGetUrl + "?auth=" + authToken; //设置登录的url
+ HttpGet httpGet = new HttpGet(loginUrl); //通过登录的uri实例化网页上资源的查找
HttpResponse response = null;
response = mHttpClient.execute(httpGet);
// get the cookie now
+ //获取CookieStore里存放的cookie,看如果存有“GTL(不知道什么意思)”，则说明有验证成功的有效的cookie
List cookies = mHttpClient.getCookieStore().getCookies();
boolean hasAuthCookie = false;
for (Cookie cookie : cookies) {
@@ -256,6 +285,7 @@ public class GTaskClient {
}
// get the client version
+ //获取client的内容，具体操作是在返回的Content中截取从_setup(开始到)}中间的字符串内容，也就是gtask_url的内容
String resString = getResponseContent(response.getEntity());
String jsBegin = "_setup(";
String jsEnd = ")}";
@@ -284,6 +314,10 @@ public class GTaskClient {
return mActionId++;
}
+ /*实例化创建一个用于向网络传输数据的对象
+ * 使用HttpPost类
+ * 返回一个httpPost实例化对象，但里面还没有内容
+ */
private HttpPost createHttpPost() {
HttpPost httpPost = new HttpPost(mPostUrl);
httpPost.setHeader("Content-Type", "application/x-www-form-urlencoded;charset=utf-8");
@@ -291,24 +325,28 @@ public class GTaskClient {
return httpPost;
}
+ /*通过URL获取响应后返回的数据，也就是网络上的数据和资源
+ * 使用getContentEncoding()获取网络上的资源和数据
+ * 返回值就是获取到的资源
+ */
private String getResponseContent(HttpEntity entity) throws IOException {
String contentEncoding = null;
- if (entity.getContentEncoding() != null) {
+ if (entity.getContentEncoding() != null) {//通过URL得到HttpEntity对象，如果不为空则使用getContent（）方法创建一个流将数据从网络都过来
contentEncoding = entity.getContentEncoding().getValue();
Log.d(TAG, "encoding: " + contentEncoding);
}
InputStream input = entity.getContent();
- if (contentEncoding != null && contentEncoding.equalsIgnoreCase("gzip")) {
+ if (contentEncoding != null && contentEncoding.equalsIgnoreCase("gzip")) {//GZIP是使用DEFLATE进行压缩数据的另一个压缩库
input = new GZIPInputStream(entity.getContent());
- } else if (contentEncoding != null && contentEncoding.equalsIgnoreCase("deflate")) {
+ } else if (contentEncoding != null && contentEncoding.equalsIgnoreCase("deflate")) {//DEFLATE是一个无专利的压缩算法，它可以实现无损数据压缩
Inflater inflater = new Inflater(true);
input = new InflaterInputStream(entity.getContent(), inflater);
}
try {
InputStreamReader isr = new InputStreamReader(input);
- BufferedReader br = new BufferedReader(isr);
+ BufferedReader br = new BufferedReader(isr);//是一个包装类，它可以包装字符流，将字符流放入缓存里，先把字符读到缓存里，到缓存满了时候，再读入内存，是为了提供读的效率而设计的
StringBuilder sb = new StringBuilder();
while (true) {
@@ -323,20 +361,28 @@ public class GTaskClient {
}
}
+ /*通过JSON发送请求
+ * 请求的具体内容在json的实例化对象js中然后传入
+ * 利用UrlEncodedFormEntity entity和httpPost.setEntity(entity)方法把js中的内容放置到httpPost中
+ * 执行请求后使用getResponseContent方法得到返回的数据和资源
+ * 将资源再次放入json后返回
+ */
private JSONObject postRequest(JSONObject js) throws NetworkFailureException {
- if (!mLoggedin) {
+ if (!mLoggedin) {//未登录
Log.e(TAG, "please login first");
throw new ActionFailureException("not logged in");
}
+ //实例化一个httpPost的对象用来向服务器传输数据，在这里就是发送请求，而请求的内容在js里
HttpPost httpPost = createHttpPost();
try {
LinkedList list = new LinkedList();
list.add(new BasicNameValuePair("r", js.toString()));
- UrlEncodedFormEntity entity = new UrlEncodedFormEntity(list, "UTF-8");
+ UrlEncodedFormEntity entity = new UrlEncodedFormEntity(list, "UTF-8"); //UrlEncodedFormEntity()的形式比较单一，是普通的键值对
httpPost.setEntity(entity);
// execute the post
+ //执行这个请求
HttpResponse response = mHttpClient.execute(httpPost);
String jsString = getResponseContent(response.getEntity());
return new JSONObject(jsString);
@@ -360,6 +406,12 @@ public class GTaskClient {
}
}
+ /*创建单个任务
+ * 传入参数是一个.gtask.data.Task包里Task类的对象
+ * 利用json获取Task里的内容,并且创建相应的jsPost
+ * 利用postRequest得到任务的返回信息
+ * 使用task.setGid设置task的new_ID
+ */
public void createTask(Task task) throws NetworkFailureException {
commitUpdate();
try {
@@ -386,6 +438,9 @@ public class GTaskClient {
}
}
+ /*
+ * 创建一个任务列表，与createTask几乎一样，区别就是最后设置的是tasklist的gid
+ */
public void createTaskList(TaskList tasklist) throws NetworkFailureException {
commitUpdate();
try {
@@ -412,6 +467,11 @@ public class GTaskClient {
}
}
+ /*
+ * 同步更新操作
+ * 使用JSONObject进行数据存储，使用jsPost.put，Put的信息包括UpdateArray和ClientVersion
+ * 使用postRequest发送这个jspost,进行处理
+ */
public void commitUpdate() throws NetworkFailureException {
if (mUpdateArray != null) {
try {
@@ -433,6 +493,10 @@ public class GTaskClient {
}
}
+ /*
+ * 添加更新的事项
+ * 调用commitUpdate()实现
+ */
public void addUpdateNode(Node node) throws NetworkFailureException {
if (node != null) {
// too many update items may result in an error
@@ -447,6 +511,12 @@ public class GTaskClient {
}
}
+ /*
+ * 移动task,比如讲task移动到不同的task列表中去
+ * 通过getGid获取task所属列表的gid
+ * 通过JSONObject.put(String name, Object value)函数设置移动后的task的相关属性值，从而达到移动的目的
+ * 最后还是通过postRequest进行更新后的发送
+ */
public void moveTask(Task task, TaskList preParent, TaskList curParent)
throws NetworkFailureException {
commitUpdate();
@@ -463,15 +533,17 @@ public class GTaskClient {
if (preParent == curParent && task.getPriorSibling() != null) {
// put prioring_sibing_id only if moving within the tasklist and
// it is not the first one
+ //设置优先级ID，只有当移动是发生在文件中
action.put(GTaskStringUtils.GTASK_JSON_PRIOR_SIBLING_ID, task.getPriorSibling());
}
- action.put(GTaskStringUtils.GTASK_JSON_SOURCE_LIST, preParent.getGid());
- action.put(GTaskStringUtils.GTASK_JSON_DEST_PARENT, curParent.getGid());
+ action.put(GTaskStringUtils.GTASK_JSON_SOURCE_LIST, preParent.getGid()); //设置移动前所属列表
+ action.put(GTaskStringUtils.GTASK_JSON_DEST_PARENT, curParent.getGid()); //设置当前所属列表
if (preParent != curParent) {
// put the dest_list only if moving between tasklists
action.put(GTaskStringUtils.GTASK_JSON_DEST_LIST, curParent.getGid());
}
actionList.put(action);
+ //最后将ACTION_LIST加入到jsPost中
jsPost.put(GTaskStringUtils.GTASK_JSON_ACTION_LIST, actionList);
// client_version
@@ -486,6 +558,11 @@ public class GTaskClient {
}
}
+ /*
+ * 删除操作节点
+ * 还是利用JSON
+ * 删除过后使用postRequest发送删除后的结果
+ */
public void deleteNode(Node node) throws NetworkFailureException {
commitUpdate();
try {
@@ -494,7 +571,7 @@ public class GTaskClient {
// action_list
node.setDeleted(true);
- actionList.put(node.getUpdateAction(getActionId()));
+ actionList.put(node.getUpdateAction(getActionId())); //这里会获取到删除操作的ID，加入到actionLiast中
jsPost.put(GTaskStringUtils.GTASK_JSON_ACTION_LIST, actionList);
// client_version
@@ -509,6 +586,11 @@ public class GTaskClient {
}
}
+ /*
+ * 获取任务列表
+ * 首先通过GetURI使用getResponseContent从网上获取数据
+ * 然后筛选出"_setup("到)}的部分，并且从中获取GTASK_JSON_LISTS的内容返回
+ */
public JSONArray getTaskLists() throws NetworkFailureException {
if (!mLoggedin) {
Log.e(TAG, "please login first");
@@ -521,6 +603,7 @@ public class GTaskClient {
response = mHttpClient.execute(httpGet);
// get the task list
+ //筛选工作，把筛选出的字符串放入jsString
String resString = getResponseContent(response.getEntity());
String jsBegin = "_setup(";
String jsEnd = ")}";
@@ -531,6 +614,7 @@ public class GTaskClient {
jsString = resString.substring(begin + jsBegin.length(), end);
}
JSONObject js = new JSONObject(jsString);
+ //获取GTASK_JSON_LISTS
return js.getJSONObject("t").getJSONArray(GTaskStringUtils.GTASK_JSON_LISTS);
} catch (ClientProtocolException e) {
Log.e(TAG, e.toString());
@@ -547,6 +631,9 @@ public class GTaskClient {
}
}
+ /*
+ * 通过传入的TASKList的gid,从网络上获取相应属于这个任务列表的任务
+ */
public JSONArray getTaskList(String listGid) throws NetworkFailureException {
commitUpdate();
try {
@@ -558,7 +645,7 @@ public class GTaskClient {
action.put(GTaskStringUtils.GTASK_JSON_ACTION_TYPE,
GTaskStringUtils.GTASK_JSON_ACTION_TYPE_GETALL);
action.put(GTaskStringUtils.GTASK_JSON_ACTION_ID, getActionId());
- action.put(GTaskStringUtils.GTASK_JSON_LIST_ID, listGid);
+ action.put(GTaskStringUtils.GTASK_JSON_LIST_ID, listGid); //这里设置为传入的listGid
action.put(GTaskStringUtils.GTASK_JSON_GET_DELETED, false);
actionList.put(action);
jsPost.put(GTaskStringUtils.GTASK_JSON_ACTION_LIST, actionList);
@@ -579,7 +666,8 @@ public class GTaskClient {
return mAccount;
}
+ //重置更新的内容
public void resetUpdateArray() {
mUpdateArray = null;
}
-}
+}
\ No newline at end of file
diff --git a/src/main/java/net/micode/notes/gtask/remote/GTaskManager.java b/src/main/java/net/micode/notes/gtask/remote/GTaskManager.java
index d2b4082..4542acf 100644
--- a/src/main/java/net/micode/notes/gtask/remote/GTaskManager.java
+++ b/src/main/java/net/micode/notes/gtask/remote/GTaskManager.java
@@ -47,73 +47,74 @@ import java.util.HashSet;
import java.util.Iterator;
import java.util.Map;
-
public class GTaskManager {
private static final String TAG = GTaskManager.class.getSimpleName();
-
public static final int STATE_SUCCESS = 0;
-
public static final int STATE_NETWORK_ERROR = 1;
-
public static final int STATE_INTERNAL_ERROR = 2;
-
public static final int STATE_SYNC_IN_PROGRESS = 3;
-
public static final int STATE_SYNC_CANCELLED = 4;
-
private static GTaskManager mInstance = null;
private Activity mActivity;
-
private Context mContext;
-
private ContentResolver mContentResolver;
-
private boolean mSyncing;
-
private boolean mCancelled;
-
private HashMap mGTaskListHashMap;
-
private HashMap mGTaskHashMap;
-
private HashMap mMetaHashMap;
-
private TaskList mMetaList;
-
private HashSet mLocalDeleteIdMap;
-
private HashMap mGidToNid;
-
private HashMap mNidToGid;
- private GTaskManager() {
- mSyncing = false;
- mCancelled = false;
- mGTaskListHashMap = new HashMap();
+ private GTaskManager() { //对象初始化函数
+ mSyncing = false; //正在同步,flase代表未执行
+ mCancelled = false; //全局标识，flase代表可以执行
+ mGTaskListHashMap = new HashMap(); //<>代表Java的泛型,就是创建一个用类型作为参数的类。
mGTaskHashMap = new HashMap();
mMetaHashMap = new HashMap();
mMetaList = null;
mLocalDeleteIdMap = new HashSet();
- mGidToNid = new HashMap();
- mNidToGid = new HashMap();
+ mGidToNid = new HashMap(); //GoogleID to NodeID??
+ mNidToGid = new HashMap(); //NodeID to GoogleID???通过hashmap散列表建立映射
}
- public static synchronized GTaskManager getInstance() {
+ /**
+ * 包含关键字synchronized，语言级同步，指明该函数可能运行在多线程的环境下。
+ * 功能：类初始化函数
+ * @author TTS
+ * @return GtaskManger
+ */
+ public static synchronized GTaskManager getInstance() { //可能运行在多线程环境下，使用语言级同步--synchronized
if (mInstance == null) {
mInstance = new GTaskManager();
}
return mInstance;
}
+ /**
+ * 包含关键字synchronized，语言级同步，指明该函数可能运行在多线程的环境下。
+ * @author TTS
+ * @param activity
+ */
public synchronized void setActivityContext(Activity activity) {
- // used for getting authtoken
+ // used for getting auth token
mActivity = activity;
}
- public int sync(Context context, GTaskASyncTask asyncTask) {
+ /**
+ * 核心函数
+ * 功能：实现了本地同步操作和远端同步操作
+ * @author TTS
+ * @param context-----获取上下文
+ * @param asyncTask-------用于同步的异步操作类
+ * @return int
+ */
+ public int sync(Context context, GTaskASyncTask asyncTask) { //核心函数
if (mSyncing) {
- Log.d(TAG, "Sync is in progress");
+ Log.d(TAG, "Sync is in progress"); //创建日志文件（调试信息），debug
return STATE_SYNC_IN_PROGRESS;
}
mContext = context;
@@ -128,8 +129,8 @@ public class GTaskManager {
mNidToGid.clear();
try {
- GTaskClient client = GTaskClient.getInstance();
- client.resetUpdateArray();
+ GTaskClient client = GTaskClient.getInstance(); //getInstance即为创建一个实例,client--客户机
+ client.resetUpdateArray(); //JSONArray类型，reset即置为NULL
// login google task
if (!mCancelled) {
@@ -140,15 +141,15 @@ public class GTaskManager {
// get the task list from google
asyncTask.publishProgess(mContext.getString(R.string.sync_progress_init_list));
- initGTaskList();
+ initGTaskList(); //获取Google上的JSONtasklist转为本地TaskList
// do content sync work
asyncTask.publishProgess(mContext.getString(R.string.sync_progress_syncing));
syncContent();
- } catch (NetworkFailureException e) {
- Log.e(TAG, e.toString());
+ } catch (NetworkFailureException e) { //分为两种异常，此类异常为网络异常
+ Log.e(TAG, e.toString()); //创建日志文件（调试信息），error
return STATE_NETWORK_ERROR;
- } catch (ActionFailureException e) {
+ } catch (ActionFailureException e) { //此类异常为操作异常
Log.e(TAG, e.toString());
return STATE_INTERNAL_ERROR;
} catch (Exception e) {
@@ -168,32 +169,41 @@ public class GTaskManager {
return mCancelled ? STATE_SYNC_CANCELLED : STATE_SUCCESS;
}
+ /**
+ *功能：初始化GtaskList，获取Google上的JSONtasklist转为本地TaskList。
+ *获得的数据存储在mMetaList，mGTaskListHashMap，mGTaskHashMap
+ *@author TTS
+ *@exception NetworkFailureException
+ *@return void
+ */
private void initGTaskList() throws NetworkFailureException {
if (mCancelled)
return;
- GTaskClient client = GTaskClient.getInstance();
+ GTaskClient client = GTaskClient.getInstance(); //getInstance即为创建一个实例，client应指远端客户机
try {
- JSONArray jsTaskLists = client.getTaskLists();
+ //Json对象是Name Value对(即子元素)的无序集合，相当于一个Map对象。JsonObject类是bantouyan-json库对Json对象的抽象，提供操纵Json对象的各种方法。
+ //其格式为{"key1":value1,"key2",value2....};key 必须是字符串。
+ //因为ajax请求不刷新页面，但配合js可以实现局部刷新，因此json常常被用来作为异步请求的返回对象使用。
+ JSONArray jsTaskLists = client.getTaskLists(); //原注释为get task list------lists？？？
// init meta list first
- mMetaList = null;
+ mMetaList = null; //TaskList类型
for (int i = 0; i < jsTaskLists.length(); i++) {
- JSONObject object = jsTaskLists.getJSONObject(i);
+ JSONObject object = jsTaskLists.getJSONObject(i); //JSONObject与JSONArray一个为对象，一个为数组。此处取出单个JASONObject
String gid = object.getString(GTaskStringUtils.GTASK_JSON_ID);
String name = object.getString(GTaskStringUtils.GTASK_JSON_NAME);
- if (name
- .equals(GTaskStringUtils.MIUI_FOLDER_PREFFIX + GTaskStringUtils.FOLDER_META)) {
- mMetaList = new TaskList();
- mMetaList.setContentByRemoteJSON(object);
+ if (name.equals(GTaskStringUtils.MIUI_FOLDER_PREFFIX + GTaskStringUtils.FOLDER_META)) {
+ mMetaList = new TaskList(); //MetaList意为元表,Tasklist类型，此处为初始化
+ mMetaList.setContentByRemoteJSON(object); //将JSON中部分数据复制到自己定义的对象中相对应的数据：name->mname...
// load meta data
- JSONArray jsMetas = client.getTaskList(gid);
+ JSONArray jsMetas = client.getTaskList(gid); //原注释为get action_list------list？？？
for (int j = 0; j < jsMetas.length(); j++) {
object = (JSONObject) jsMetas.getJSONObject(j);
- MetaData metaData = new MetaData();
+ MetaData metaData = new MetaData(); //继承自Node
metaData.setContentByRemoteJSON(object);
- if (metaData.isWorthSaving()) {
+ if (metaData.isWorthSaving()) { //if not worth to save，metadata将不加入mMetaList
mMetaList.addChildTask(metaData);
if (metaData.getGid() != null) {
mMetaHashMap.put(metaData.getRelatedGid(), metaData);
@@ -214,16 +224,16 @@ public class GTaskManager {
// init task list
for (int i = 0; i < jsTaskLists.length(); i++) {
JSONObject object = jsTaskLists.getJSONObject(i);
- String gid = object.getString(GTaskStringUtils.GTASK_JSON_ID);
+ String gid = object.getString(GTaskStringUtils.GTASK_JSON_ID); //通过getString函数传入本地某个标志数据的名称，获取其在远端的名称。
String name = object.getString(GTaskStringUtils.GTASK_JSON_NAME);
if (name.startsWith(GTaskStringUtils.MIUI_FOLDER_PREFFIX)
&& !name.equals(GTaskStringUtils.MIUI_FOLDER_PREFFIX
- + GTaskStringUtils.FOLDER_META)) {
- TaskList tasklist = new TaskList();
+ + GTaskStringUtils.FOLDER_META)) {
+ TaskList tasklist = new TaskList(); //继承自Node
tasklist.setContentByRemoteJSON(object);
mGTaskListHashMap.put(gid, tasklist);
- mGTaskHashMap.put(gid, tasklist);
+ mGTaskHashMap.put(gid, tasklist); //为什么加两遍？？？
// load tasks
JSONArray jsTasks = client.getTaskList(gid);
@@ -247,13 +257,18 @@ public class GTaskManager {
}
}
- private void syncContent() throws NetworkFailureException {
+ /**
+ * 功能：本地内容同步操作
+ * @throws NetworkFailureException
+ * @return 无返回值
+ */
+ private void syncContent() throws NetworkFailureException { //本地内容同步操作
int syncType;
- Cursor c = null;
- String gid;
- Node node;
+ Cursor c = null; //数据库指针
+ String gid; //GoogleID??
+ Node node; //Node包含Sync_Action的不同类型
- mLocalDeleteIdMap.clear();
+ mLocalDeleteIdMap.clear(); //HashSet类型
if (mCancelled) {
return;
@@ -301,8 +316,8 @@ public class GTaskManager {
node = mGTaskHashMap.get(gid);
if (node != null) {
mGTaskHashMap.remove(gid);
- mGidToNid.put(gid, c.getLong(SqlNote.ID_COLUMN));
- mNidToGid.put(c.getLong(SqlNote.ID_COLUMN), gid);
+ mGidToNid.put(gid, c.getLong(SqlNote.ID_COLUMN)); //通过hashmap建立联系
+ mNidToGid.put(c.getLong(SqlNote.ID_COLUMN), gid); //通过hashmap建立联系
syncType = node.getSyncAction(c);
} else {
if (c.getString(SqlNote.GTASK_ID_COLUMN).trim().length() == 0) {
@@ -327,14 +342,14 @@ public class GTaskManager {
}
// go through remaining items
- Iterator> iter = mGTaskHashMap.entrySet().iterator();
+ Iterator> iter = mGTaskHashMap.entrySet().iterator(); //Iterator迭代器
while (iter.hasNext()) {
Map.Entry entry = iter.next();
node = entry.getValue();
doContentSync(Node.SYNC_ACTION_ADD_LOCAL, node, null);
}
- // mCancelled can be set by another thread, so we neet to check one by
+ // mCancelled can be set by another thread, so we neet to check one by //thread----线程
// one
// clear local delete table
if (!mCancelled) {
@@ -351,6 +366,11 @@ public class GTaskManager {
}
+ /**
+ * 功能：
+ * @author TTS
+ * @throws NetworkFailureException
+ */
private void syncFolder() throws NetworkFailureException {
Cursor c = null;
String gid;
@@ -394,7 +414,7 @@ public class GTaskManager {
try {
c = mContentResolver.query(Notes.CONTENT_NOTE_URI, SqlNote.PROJECTION_NOTE, "(_id=?)",
new String[] {
- String.valueOf(Notes.ID_CALL_RECORD_FOLDER)
+ String.valueOf(Notes.ID_CALL_RECORD_FOLDER)
}, null);
if (c != null) {
if (c.moveToNext()) {
@@ -476,6 +496,14 @@ public class GTaskManager {
GTaskClient.getInstance().commitUpdate();
}
+ /**
+ * 功能：syncType分类，addLocalNode，addRemoteNode，deleteNode，updateLocalNode，updateRemoteNode
+ * @author TTS
+ * @param syncType
+ * @param node
+ * @param c
+ * @throws NetworkFailureException
+ */
private void doContentSync(int syncType, Node node, Cursor c) throws NetworkFailureException {
if (mCancelled) {
return;
@@ -522,6 +550,12 @@ public class GTaskManager {
}
}
+ /**
+ * 功能：本地增加Node
+ * @author TTS
+ * @param node
+ * @throws NetworkFailureException
+ */
private void addLocalNode(Node node) throws NetworkFailureException {
if (mCancelled) {
return;
@@ -596,6 +630,15 @@ public class GTaskManager {
updateRemoteMeta(node.getGid(), sqlNote);
}
+ /**
+ * 功能：update本地node
+ * @author TTS
+ * @param node
+ * ----同步操作的基础数据类型
+ * @param c
+ * ----Cursor
+ * @throws NetworkFailureException
+ */
private void updateLocalNode(Node node, Cursor c) throws NetworkFailureException {
if (mCancelled) {
return;
@@ -619,12 +662,22 @@ public class GTaskManager {
updateRemoteMeta(node.getGid(), sqlNote);
}
+ /**
+ * 功能：远程增加Node
+ * 需要updateRemoteMeta
+ * @author TTS
+ * @param node
+ * ----同步操作的基础数据类型
+ * @param c
+ * --Cursor
+ * @throws NetworkFailureException
+ */
private void addRemoteNode(Node node, Cursor c) throws NetworkFailureException {
if (mCancelled) {
return;
}
- SqlNote sqlNote = new SqlNote(mContext, c);
+ SqlNote sqlNote = new SqlNote(mContext, c); //从本地mContext中获取内容
Node n;
// update remotely
@@ -634,11 +687,12 @@ public class GTaskManager {
String parentGid = mNidToGid.get(sqlNote.getParentId());
if (parentGid == null) {
- Log.e(TAG, "cannot find task's parent tasklist");
+ Log.e(TAG, "cannot find task's parent tasklist"); //调试信息
throw new ActionFailureException("cannot add remote task");
}
- mGTaskListHashMap.get(parentGid).addChildTask(task);
+ mGTaskListHashMap.get(parentGid).addChildTask(task); //在本地生成的GTaskList中增加子结点
+ //登录远程服务器，创建Task
GTaskClient.getInstance().createTask(task);
n = (Node) task;
@@ -656,6 +710,7 @@ public class GTaskManager {
else
folderName += sqlNote.getSnippet();
+ //iterator迭代器，通过统一的接口迭代所有的map元素
Iterator> iter = mGTaskListHashMap.entrySet().iterator();
while (iter.hasNext()) {
Map.Entry entry = iter.next();
@@ -687,11 +742,20 @@ public class GTaskManager {
sqlNote.resetLocalModified();
sqlNote.commit(true);
- // gid-id mapping
+ // gid-id mapping //创建id间的映射
mGidToNid.put(n.getGid(), sqlNote.getId());
mNidToGid.put(sqlNote.getId(), n.getGid());
}
+ /**
+ * 功能：更新远端的Node，包含meta更新(updateRemoteMeta)
+ * @author TTS
+ * @param node
+ * ----同步操作的基础数据类型
+ * @param c
+ * --Cursor
+ * @throws NetworkFailureException
+ */
private void updateRemoteNode(Node node, Cursor c) throws NetworkFailureException {
if (mCancelled) {
return;
@@ -701,7 +765,7 @@ public class GTaskManager {
// update remotely
node.setContentByLocalJSON(sqlNote.getContent());
- GTaskClient.getInstance().addUpdateNode(node);
+ GTaskClient.getInstance().addUpdateNode(node); //GTaskClient用途为从本地登陆远端服务器
// update meta
updateRemoteMeta(node.getGid(), sqlNote);
@@ -710,15 +774,19 @@ public class GTaskManager {
if (sqlNote.isNoteType()) {
Task task = (Task) node;
TaskList preParentList = task.getParent();
+ //preParentList为通过node获取的父节点列表
String curParentGid = mNidToGid.get(sqlNote.getParentId());
+ //curParentGid为通过光标在数据库中找到sqlNote的mParentId，再通过mNidToGid由long类型转为String类型的Gid
+
if (curParentGid == null) {
Log.e(TAG, "cannot find task's parent tasklist");
throw new ActionFailureException("cannot update remote task");
}
TaskList curParentList = mGTaskListHashMap.get(curParentGid);
+ //通过HashMap找到对应Gid的TaskList
- if (preParentList != curParentList) {
+ if (preParentList != curParentList) { //?????????????
preParentList.removeChildTask(task);
curParentList.addChildTask(task);
GTaskClient.getInstance().moveTask(task, preParentList, curParentList);
@@ -727,9 +795,19 @@ public class GTaskManager {
// clear local modified flag
sqlNote.resetLocalModified();
+ //commit到本地数据库
sqlNote.commit(true);
}
+ /**
+ * 功能：升级远程meta。 meta---元数据----计算机文件系统管理数据---管理数据的数据。
+ * @author TTS
+ * @param gid
+ * ---GoogleID为String类型
+ * @param sqlNote
+ * ---同步前的数据库操作，故使用类SqlNote
+ * @throws NetworkFailureException
+ */
private void updateRemoteMeta(String gid, SqlNote sqlNote) throws NetworkFailureException {
if (sqlNote != null && sqlNote.isNoteType()) {
MetaData metaData = mMetaHashMap.get(gid);
@@ -746,12 +824,18 @@ public class GTaskManager {
}
}
+ /**
+ * 功能：刷新本地，给sync的ID对应上最后更改过的对象
+ * @author TTS
+ * @return void
+ * @throws NetworkFailureException
+ */
private void refreshLocalSyncId() throws NetworkFailureException {
if (mCancelled) {
return;
}
- // get the latest gtask list
+ // get the latest gtask list //获取最近的（最晚的）gtask list
mGTaskHashMap.clear();
mGTaskListHashMap.clear();
mMetaHashMap.clear();
@@ -762,16 +846,16 @@ public class GTaskManager {
c = mContentResolver.query(Notes.CONTENT_NOTE_URI, SqlNote.PROJECTION_NOTE,
"(type<>? AND parent_id<>?)", new String[] {
String.valueOf(Notes.TYPE_SYSTEM), String.valueOf(Notes.ID_TRASH_FOLER)
- }, NoteColumns.TYPE + " DESC");
+ }, NoteColumns.TYPE + " DESC"); //query语句：五个参数，NoteColumns.TYPE + " DESC"-----为按类型递减顺序返回查询结果。new String[] {String.valueOf(Notes.TYPE_SYSTEM), String.valueOf(Notes.ID_TRASH_FOLER)}------为选择参数。"(type<>? AND parent_id<>?)"-------指明返回行过滤器。SqlNote.PROJECTION_NOTE--------应返回的数据列的名字。Notes.CONTENT_NOTE_URI--------contentProvider包含所有数据集所对应的uri
if (c != null) {
while (c.moveToNext()) {
String gid = c.getString(SqlNote.GTASK_ID_COLUMN);
Node node = mGTaskHashMap.get(gid);
if (node != null) {
mGTaskHashMap.remove(gid);
- ContentValues values = new ContentValues();
+ ContentValues values = new ContentValues(); //在ContentValues中创建键值对。准备通过contentResolver写入数据
values.put(NoteColumns.SYNC_ID, node.getLastModified());
- mContentResolver.update(ContentUris.withAppendedId(Notes.CONTENT_NOTE_URI,
+ mContentResolver.update(ContentUris.withAppendedId(Notes.CONTENT_NOTE_URI, //进行批量更改，选择参数为NULL，应该可以用insert替换，参数分别为表名和需要更新的value对象。
c.getLong(SqlNote.ID_COLUMN)), values, null, null);
} else {
Log.e(TAG, "something is missed");
@@ -790,11 +874,20 @@ public class GTaskManager {
}
}
+ /**
+ * 功能：获取同步账号,mAccount.name
+ * @author TTS
+ * @return String
+ */
public String getSyncAccount() {
return GTaskClient.getInstance().getSyncAccount().name;
}
+ /**
+ * 功能：取消同步，置mCancelled为true
+ * @author TTS
+ */
public void cancelSync() {
mCancelled = true;
}
-}
+}
\ No newline at end of file
diff --git a/src/main/java/net/micode/notes/gtask/remote/GTaskSyncService.java b/src/main/java/net/micode/notes/gtask/remote/GTaskSyncService.java
index cca36f7..950b06e 100644
--- a/src/main/java/net/micode/notes/gtask/remote/GTaskSyncService.java
+++ b/src/main/java/net/micode/notes/gtask/remote/GTaskSyncService.java
@@ -23,6 +23,22 @@ import android.content.Intent;
import android.os.Bundle;
import android.os.IBinder;
+/*
+ * Service是在一段不定的时间运行在后台，不和用户交互的应用组件
+ * 主要方法：
+ * private void startSync() 启动一个同步工作
+ * private void cancelSync() 取消同步
+ * public void onCreate()
+ * public int onStartCommand(Intent intent, int flags, int startId) service生命周期的组成部分，相当于重启service（比如在被暂停之后），而不是创建一个新的service
+ * public void onLowMemory() 在没有内存的情况下如果存在service则结束掉这的service
+ * public IBinder onBind()
+ * public void sendBroadcast(String msg) 发送同步的相关通知
+ * public static void startSync(Activity activity)
+ * public static void cancelSync(Context context)
+ * public static boolean isSyncing() 判读是否在进行同步
+ * public static String getProgressString() 获取当前进度的信息
+ */
+
public class GTaskSyncService extends Service {
public final static String ACTION_STRING_NAME = "sync_action_type";
@@ -42,6 +58,7 @@ public class GTaskSyncService extends Service {
private static String mSyncProgress = "";
+ //开始一个同步的工作
private void startSync() {
if (mSyncTask == null) {
mSyncTask = new GTaskASyncTask(this, new GTaskASyncTask.OnCompleteListener() {
@@ -52,10 +69,11 @@ public class GTaskSyncService extends Service {
}
});
sendBroadcast("");
- mSyncTask.execute();
+ mSyncTask.execute(); //这个函数让任务是以单线程队列方式或线程池队列方式运行
}
}
+
private void cancelSync() {
if (mSyncTask != null) {
mSyncTask.cancelSync();
@@ -63,7 +81,7 @@ public class GTaskSyncService extends Service {
}
@Override
- public void onCreate() {
+ public void onCreate() { //初始化一个service
mSyncTask = null;
}
@@ -72,6 +90,7 @@ public class GTaskSyncService extends Service {
Bundle bundle = intent.getExtras();
if (bundle != null && bundle.containsKey(ACTION_STRING_NAME)) {
switch (bundle.getInt(ACTION_STRING_NAME, ACTION_INVALID)) {
+ //两种情况，开始同步或者取消同步
case ACTION_START_SYNC:
startSync();
break;
@@ -81,7 +100,7 @@ public class GTaskSyncService extends Service {
default:
break;
}
- return START_STICKY;
+ return START_STICKY; //等待新的intent来是这个service继续运行
}
return super.onStartCommand(intent, flags, startId);
}
@@ -93,26 +112,26 @@ public class GTaskSyncService extends Service {
}
}
- public IBinder onBind(Intent intent) {
+ public IBinder onBind(Intent intent) { //不知道干吗用的
return null;
}
public void sendBroadcast(String msg) {
mSyncProgress = msg;
- Intent intent = new Intent(GTASK_SERVICE_BROADCAST_NAME);
- intent.putExtra(GTASK_SERVICE_BROADCAST_IS_SYNCING, mSyncTask != null);
+ Intent intent = new Intent(GTASK_SERVICE_BROADCAST_NAME); //创建一个新的Intent
+ intent.putExtra(GTASK_SERVICE_BROADCAST_IS_SYNCING, mSyncTask != null); //附加INTENT中的相应参数的值
intent.putExtra(GTASK_SERVICE_BROADCAST_PROGRESS_MSG, msg);
- sendBroadcast(intent);
+ sendBroadcast(intent); //发送这个通知
}
- public static void startSync(Activity activity) {
+ public static void startSync(Activity activity) {//执行一个service，service的内容里的同步动作就是开始同步
GTaskManager.getInstance().setActivityContext(activity);
Intent intent = new Intent(activity, GTaskSyncService.class);
intent.putExtra(GTaskSyncService.ACTION_STRING_NAME, GTaskSyncService.ACTION_START_SYNC);
activity.startService(intent);
}
- public static void cancelSync(Context context) {
+ public static void cancelSync(Context context) {//执行一个service，service的内容里的同步动作就是取消同步
Intent intent = new Intent(context, GTaskSyncService.class);
intent.putExtra(GTaskSyncService.ACTION_STRING_NAME, GTaskSyncService.ACTION_CANCEL_SYNC);
context.startService(intent);
@@ -125,4 +144,4 @@ public class GTaskSyncService extends Service {
public static String getProgressString() {
return mSyncProgress;
}
-}
+}
\ No newline at end of file
diff --git a/src/main/java/net/micode/notes/model/Note.java b/src/main/java/net/micode/notes/model/Note.java
index 6706cf6..32d47c7 100644
--- a/src/main/java/net/micode/notes/model/Note.java
+++ b/src/main/java/net/micode/notes/model/Note.java
@@ -33,11 +33,12 @@ import net.micode.notes.data.Notes.TextNote;
import java.util.ArrayList;
-
public class Note {
- private ContentValues mNoteDiffValues;
+ // private ContentValues mNoteDiffValues;
+ ContentValues mNoteDiffValues;//
private NoteData mNoteData;
private static final String TAG = "Note";
+
/**
* Create a new note id for adding a new note to databases
*/
@@ -49,16 +50,17 @@ public class Note {
values.put(NoteColumns.MODIFIED_DATE, createdTime);
values.put(NoteColumns.TYPE, Notes.TYPE_NOTE);
values.put(NoteColumns.LOCAL_MODIFIED, 1);
- values.put(NoteColumns.PARENT_ID, folderId);
+ values.put(NoteColumns.PARENT_ID, folderId);//将数据写入数据库表格
Uri uri = context.getContentResolver().insert(Notes.CONTENT_NOTE_URI, values);
-
+ //ContentResolver()主要是实现外部应用对ContentProvider中的数据
+ //进行添加、删除、修改和查询操作
long noteId = 0;
try {
noteId = Long.valueOf(uri.getPathSegments().get(1));
} catch (NumberFormatException e) {
Log.e(TAG, "Get note id error :" + e.toString());
noteId = 0;
- }
+ }//try-catch异常处理
if (noteId == -1) {
throw new IllegalStateException("Wrong note id:" + noteId);
}
@@ -68,37 +70,37 @@ public class Note {
public Note() {
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 setTextData(String key, String 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);
- }
+ }//得到电话号码数据的ID
public boolean isLocalModified() {
return mNoteDiffValues.size() > 0 || mNoteData.isLocalModified();
- }
+ }//判断是否是本地修改
public boolean syncNote(Context context, long noteId) {
if (noteId <= 0) {
@@ -128,16 +130,16 @@ public class Note {
}
return true;
- }
+ }//判断数据是否同步
- private class NoteData {
+ private class NoteData {//定义一个基本的便签内容的数据类，主要包含文本数据和电话号码数据
private long mTextDataId;
- private ContentValues mTextDataValues;
+ private ContentValues mTextDataValues;//文本数据
private long mCallDataId;
- private ContentValues mCallDataValues;
+ private ContentValues mCallDataValues;//电话号码数据
private static final String TAG = "NoteData";
@@ -147,7 +149,7 @@ public class Note {
mTextDataId = 0;
mCallDataId = 0;
}
-
+ //下面是上述几个函数的具体实现
boolean isLocalModified() {
return mTextDataValues.size() > 0 || mCallDataValues.size() > 0;
}
@@ -177,17 +179,17 @@ public class Note {
mNoteDiffValues.put(NoteColumns.LOCAL_MODIFIED, 1);
mNoteDiffValues.put(NoteColumns.MODIFIED_DATE, System.currentTimeMillis());
}
-
+ //下面函数的作用是将新的数据通过Uri的操作存储到数据库
Uri pushIntoContentResolver(Context context, long noteId) {
/**
* Check for safety
*/
if (noteId <= 0) {
throw new IllegalArgumentException("Wrong note id:" + noteId);
- }
+ }//判断数据是否合法
ArrayList operationList = new ArrayList();
- ContentProviderOperation.Builder builder = null;
+ ContentProviderOperation.Builder builder = null;//数据库的操作列表
if(mTextDataValues.size() > 0) {
mTextDataValues.put(DataColumns.NOTE_ID, noteId);
@@ -209,7 +211,7 @@ public class Note {
operationList.add(builder.build());
}
mTextDataValues.clear();
- }
+ }//把文本数据存入DataColumns
if(mCallDataValues.size() > 0) {
mCallDataValues.put(DataColumns.NOTE_ID, noteId);
@@ -231,7 +233,7 @@ public class Note {
operationList.add(builder.build());
}
mCallDataValues.clear();
- }
+ }//把电话号码数据存入DataColumns
if (operationList.size() > 0) {
try {
@@ -246,8 +248,8 @@ public class Note {
Log.e(TAG, String.format("%s: %s", e.toString(), e.getMessage()));
return null;
}
- }
+ }//存储过程中的异常处理
return null;
}
}
-}
+}
\ No newline at end of file
diff --git a/src/main/java/net/micode/notes/model/WorkingNote.java b/src/main/java/net/micode/notes/model/WorkingNote.java
index be081e4..a0e082c 100644
--- a/src/main/java/net/micode/notes/model/WorkingNote.java
+++ b/src/main/java/net/micode/notes/model/WorkingNote.java
@@ -31,7 +31,6 @@ import net.micode.notes.data.Notes.NoteColumns;
import net.micode.notes.data.Notes.TextNote;
import net.micode.notes.tool.ResourceParser.NoteBgResources;
-
public class WorkingNote {
// Note for the working note
private Note mNote;
@@ -43,17 +42,11 @@ public class WorkingNote {
private int mMode;
private long mAlertDate;
-
private long mModifiedDate;
-
private int mBgColorId;
-
private int mWidgetId;
-
private int mWidgetType;
-
private long mFolderId;
-
private Context mContext;
private static final String TAG = "WorkingNote";
@@ -62,6 +55,7 @@ public class WorkingNote {
private NoteSettingChangedListener mNoteSettingStatusListener;
+ // 声明 DATA_PROJECTION字符串数组
public static final String[] DATA_PROJECTION = new String[] {
DataColumns.ID,
DataColumns.CONTENT,
@@ -72,6 +66,7 @@ public class WorkingNote {
DataColumns.DATA4,
};
+ // 声明 NOTE_PROJECTION字符串数组
public static final String[] NOTE_PROJECTION = new String[] {
NoteColumns.PARENT_ID,
NoteColumns.ALERTED_DATE,
@@ -82,27 +77,18 @@ public class WorkingNote {
};
private static final int DATA_ID_COLUMN = 0;
-
private static final int DATA_CONTENT_COLUMN = 1;
-
private static final int DATA_MIME_TYPE_COLUMN = 2;
-
private static final int DATA_MODE_COLUMN = 3;
-
private static final int NOTE_PARENT_ID_COLUMN = 0;
-
private static final int NOTE_ALERTED_DATE_COLUMN = 1;
-
private static final int NOTE_BG_COLOR_ID_COLUMN = 2;
-
private static final int NOTE_WIDGET_ID_COLUMN = 3;
-
private static final int NOTE_WIDGET_TYPE_COLUMN = 4;
-
private static final int NOTE_MODIFIED_DATE_COLUMN = 5;
// New note construct
- private WorkingNote(Context context, long folderId) {
+ public WorkingNote(Context context, long folderId) {
mContext = context;
mAlertDate = 0;
mModifiedDate = System.currentTimeMillis();
@@ -114,6 +100,7 @@ public class WorkingNote {
mWidgetType = Notes.TYPE_WIDGET_INVALIDE;
}
+ // WorkingNote的构造函数
// Existing note construct
private WorkingNote(Context context, long noteId, long folderId) {
mContext = context;
@@ -124,11 +111,14 @@ public class WorkingNote {
loadNote();
}
+ // 加载Note
+ // 通过数据库调用query函数找到第一个条目
private void loadNote() {
Cursor cursor = mContext.getContentResolver().query(
ContentUris.withAppendedId(Notes.CONTENT_NOTE_URI, mNoteId), NOTE_PROJECTION, null,
null, null);
+ // 若存在，储存相应信息
if (cursor != null) {
if (cursor.moveToFirst()) {
mFolderId = cursor.getLong(NOTE_PARENT_ID_COLUMN);
@@ -139,6 +129,7 @@ public class WorkingNote {
mModifiedDate = cursor.getLong(NOTE_MODIFIED_DATE_COLUMN);
}
cursor.close();
+ // 若不存在，报错
} else {
Log.e(TAG, "No note with id:" + mNoteId);
throw new IllegalArgumentException("Unable to find note with id " + mNoteId);
@@ -146,14 +137,16 @@ public class WorkingNote {
loadNoteData();
}
+ // 加载NoteData
private void loadNoteData() {
Cursor cursor = mContext.getContentResolver().query(Notes.CONTENT_DATA_URI, DATA_PROJECTION,
DataColumns.NOTE_ID + "=?", new String[] {
- String.valueOf(mNoteId)
+ String.valueOf(mNoteId)
}, null);
if (cursor != null) {
- if (cursor.moveToFirst()) {
+ // 查到信息不为空
+ if (cursor.moveToFirst()) { // 查看第一项是否存在
do {
String type = cursor.getString(DATA_MIME_TYPE_COLUMN);
if (DataConstants.NOTE.equals(type)) {
@@ -165,7 +158,7 @@ public class WorkingNote {
} else {
Log.d(TAG, "Wrong note type with type:" + type);
}
- } while (cursor.moveToNext());
+ } while (cursor.moveToNext());//查阅所有项,直到为空
}
cursor.close();
} else {
@@ -174,9 +167,12 @@ public class WorkingNote {
}
}
+ // 创建空的Note
+ // 传参：context，文件夹id，widget，背景颜色
public static WorkingNote createEmptyNote(Context context, long folderId, int widgetId,
- int widgetType, int defaultBgColorId) {
+ int widgetType, int defaultBgColorId) {
WorkingNote note = new WorkingNote(context, folderId);
+ // 设定相关属性
note.setBgColorId(defaultBgColorId);
note.setWidgetId(widgetId);
note.setWidgetType(widgetType);
@@ -187,9 +183,10 @@ public class WorkingNote {
return new WorkingNote(context, id, 0);
}
+ // 保存Note
public synchronized boolean saveNote() {
- if (isWorthSaving()) {
- if (!existInDatabase()) {
+ if (isWorthSaving()) { //是否值得保存
+ if (!existInDatabase()) { // 是否存在数据库中
if ((mNoteId = Note.getNewNoteId(mContext, mFolderId)) == 0) {
Log.e(TAG, "Create new note fail with id:" + mNoteId);
return false;
@@ -212,11 +209,14 @@ public class WorkingNote {
}
}
+ // 是否在数据库中存在
public boolean existInDatabase() {
return mNoteId > 0;
}
+ // 是否值得保存
private boolean isWorthSaving() {
+ // 被删除，或（不在数据库中 内容为空），或 本地已保存过
if (mIsDeleted || (!existInDatabase() && TextUtils.isEmpty(mContent))
|| (existInDatabase() && !mNote.isLocalModified())) {
return false;
@@ -225,10 +225,14 @@ public class WorkingNote {
}
}
+
+ // 设置mNoteSettingStatusListener
public void setOnSettingStatusChangedListener(NoteSettingChangedListener l) {
mNoteSettingStatusListener = l;
}
+ // 设置AlertDate
+ // 若 mAlertDate与data不同，则更改mAlertDate并设定NoteValue
public void setAlertDate(long date, boolean set) {
if (date != mAlertDate) {
mAlertDate = date;
@@ -239,16 +243,20 @@ public class WorkingNote {
}
}
+ // 设定删除标记
public void markDeleted(boolean mark) {
+ // 设定标记
mIsDeleted = mark;
if (mWidgetId != AppWidgetManager.INVALID_APPWIDGET_ID
&& mWidgetType != Notes.TYPE_WIDGET_INVALIDE && mNoteSettingStatusListener != null) {
- mNoteSettingStatusListener.onWidgetChanged();
+ mNoteSettingStatusListener.onWidgetChanged();
+ // 调用mNoteSettingStatusListener的 onWidgetChanged方法
}
}
+ // 设定背景颜色
public void setBgColorId(int id) {
- if (id != mBgColorId) {
+ if (id != mBgColorId) { //设定条件 id != mBgColorId
mBgColorId = id;
if (mNoteSettingStatusListener != null) {
mNoteSettingStatusListener.onBackgroundColorChanged();
@@ -257,8 +265,10 @@ public class WorkingNote {
}
}
+ // 设定检查列表模式
+ // 参数：mode
public void setCheckListMode(int mode) {
- if (mMode != mode) {
+ if (mMode != mode) { //设定条件 mMode != mode
if (mNoteSettingStatusListener != null) {
mNoteSettingStatusListener.onCheckListModeChanged(mMode, mode);
}
@@ -267,81 +277,108 @@ public class WorkingNote {
}
}
+
+ // 设定WidgetType
+ // 参数：type
public void setWidgetType(int type) {
- if (type != mWidgetType) {
+ if (type != mWidgetType) {//设定条件 type != mWidgetType
mWidgetType = type;
mNote.setNoteValue(NoteColumns.WIDGET_TYPE, String.valueOf(mWidgetType));
+ // 调用Note的setNoteValue方法更改WidgetType
}
}
+ // 设定WidgetId
+ // 参数：id
public void setWidgetId(int id) {
- if (id != mWidgetId) {
+ if (id != mWidgetId) {//设定条件 id != mWidgetId
mWidgetId = id;
mNote.setNoteValue(NoteColumns.WIDGET_ID, String.valueOf(mWidgetId));
+ // 调用Note的setNoteValue方法更改WidgetId
}
}
+ // 设定WorkingTex
+ // 参数：更改的text
public void setWorkingText(String text) {
- if (!TextUtils.equals(mContent, text)) {
+ if (!TextUtils.equals(mContent, text)) {//设定条件 mContent, text内容不同
mContent = text;
mNote.setTextData(DataColumns.CONTENT, mContent);
+ // 调用Note的setTextData方法更改WorkingText
}
}
+ // 转变mNote的CallData及CallNote信息
+ // 参数：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));
}
+ // 判断是否有时钟题型
public boolean hasClockAlert() {
return (mAlertDate > 0 ? true : false);
}
+ // 获取Content
public String getContent() {
return mContent;
}
+ // 获取AlertDate
public long getAlertDate() {
return mAlertDate;
}
+ // 获取ModifiedDate
public long getModifiedDate() {
return mModifiedDate;
}
+ // 获取背景颜色来源id
public int getBgColorResId() {
return NoteBgResources.getNoteBgResource(mBgColorId);
}
+ // 获取背景颜色id
public int getBgColorId() {
return mBgColorId;
}
+ // 获取标题背景颜色id
public int getTitleBgResId() {
return NoteBgResources.getNoteTitleBgResource(mBgColorId);
}
+ // 获取CheckListMode
public int getCheckListMode() {
return mMode;
}
+ // 获取便签id
public long getNoteId() {
return mNoteId;
}
+ // 获取文件夹id
public long getFolderId() {
return mFolderId;
}
+ // 获取WidgetId
public int getWidgetId() {
return mWidgetId;
}
+ // 获取WidgetType
public int getWidgetType() {
return mWidgetType;
}
+ // 创建接口 NoteSettingChangedListener,便签更新监视
+ // 为NoteEditActivity提供接口
+ // 提供函数有
public interface NoteSettingChangedListener {
/**
* Called when the background color of current note has just changed
diff --git a/src/main/java/net/micode/notes/tool/BackupUtils.java b/src/main/java/net/micode/notes/tool/BackupUtils.java
index 39f6ec4..249a138 100644
--- a/src/main/java/net/micode/notes/tool/BackupUtils.java
+++ b/src/main/java/net/micode/notes/tool/BackupUtils.java
@@ -1,17 +1,17 @@
/*
- * Copyright (c) 2010-2011, The MiCode Open Source Community (www.micode.net)
+ *版权所有（c）2010-2011，MiCode开源社区（www.MiCode.net）
*
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
+ *根据Apache许可证2.0版（“许可证”）许可；
+ *除非符合许可证的规定，否则您不得使用此文件。
+ *您可以在以下网址获取许可证副本
*
* http://www.apache.org/licenses/LICENSE-2.0
*
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
+ *除非适用法律要求或书面同意，否则软件
+ *根据许可证分发是在“按原样”的基础上分发的，
+ *无任何明示或暗示的保证或条件。
+ *有关管理权限的特定语言，请参阅许可证
+ *许可证下的限制。
*/
package net.micode.notes.tool;
@@ -35,14 +35,17 @@ import java.io.FileOutputStream;
import java.io.IOException;
import java.io.PrintStream;
-
public class BackupUtils {
private static final String TAG = "BackupUtils";
// Singleton stuff
- private static BackupUtils sInstance;
+ private static BackupUtils sInstance; //类里面为什么可以定义自身类的对象？
public static synchronized BackupUtils getInstance(Context context) {
+ //ynchronized 关键字，代表这个方法加锁,相当于不管哪一个线程（例如线程A）
+ //运行到这个方法时,都要检查有没有其它线程B（或者C、 D等）正在用这个方法(或者该类的其他同步方法)，有的话要等正在使用synchronized方法的线程B（或者C 、D）运行完这个方法后再运行此线程A,没有的话,锁定调用者,然后直接运行。
+ //它包括两种用法：synchronized 方法和 synchronized 块。
if (sInstance == null) {
+ //如果当前备份不存在，则新声明一个
sInstance = new BackupUtils(context);
}
return sInstance;
@@ -52,24 +55,24 @@ public class BackupUtils {
* Following states are signs to represents backup or restore
* status
*/
- // Currently, the sdcard is not mounted
+ // Currently, the sdcard is not mounted SD卡没有被装入手机
public static final int STATE_SD_CARD_UNMOUONTED = 0;
- // The backup file not exist
+ // The backup file not exist 备份文件夹不存在
public static final int STATE_BACKUP_FILE_NOT_EXIST = 1;
- // The data is not well formated, may be changed by other programs
+ // The data is not well formated, may be changed by other programs 数据已被破坏，可能被修改
public static final int STATE_DATA_DESTROIED = 2;
- // Some run-time exception which causes restore or backup fails
+ // Some run-time exception which causes restore or backup fails 超时异常
public static final int STATE_SYSTEM_ERROR = 3;
- // Backup or restore success
+ // Backup or restore success 成功存储
public static final int STATE_SUCCESS = 4;
private TextExport mTextExport;
- private BackupUtils(Context context) {
+ private BackupUtils(Context context) { //初始化函数
mTextExport = new TextExport(context);
}
- private static boolean externalStorageAvailable() {
+ private static boolean externalStorageAvailable() { //外部存储功能是否可用
return Environment.MEDIA_MOUNTED.equals(Environment.getExternalStorageState());
}
@@ -128,11 +131,11 @@ public class BackupUtils {
public TextExport(Context context) {
TEXT_FORMAT = context.getResources().getStringArray(R.array.format_for_exported_note);
mContext = context;
- mFileName = "";
+ mFileName = ""; //为什么为空?
mFileDirectory = "";
}
- private String getFormat(int id) {
+ private String getFormat(int id) { //获取文本的组成部分
return TEXT_FORMAT[id];
}
@@ -140,22 +143,22 @@ public class BackupUtils {
* Export the folder identified by folder id to text
*/
private void exportFolderToText(String folderId, PrintStream ps) {
- // Query notes belong to this folder
+ // Query notes belong to this folder 通过查询parent id是文件夹id的note来选出制定ID文件夹下的Note
Cursor notesCursor = mContext.getContentResolver().query(Notes.CONTENT_NOTE_URI,
NOTE_PROJECTION, NoteColumns.PARENT_ID + "=?", new String[] {
- folderId
+ folderId
}, null);
if (notesCursor != null) {
if (notesCursor.moveToFirst()) {
do {
- // Print note's last modified date
+ // Print note's last modified date ps里面保存有这份note的日期
ps.println(String.format(getFormat(FORMAT_NOTE_DATE), DateFormat.format(
mContext.getString(R.string.format_datetime_mdhm),
notesCursor.getLong(NOTE_COLUMN_MODIFIED_DATE))));
// Query data belong to this note
String noteId = notesCursor.getString(NOTE_COLUMN_ID);
- exportNoteToText(noteId, ps);
+ exportNoteToText(noteId, ps); //将文件导出到text
} while (notesCursor.moveToNext());
}
notesCursor.close();
@@ -168,10 +171,10 @@ public class BackupUtils {
private void exportNoteToText(String noteId, PrintStream ps) {
Cursor dataCursor = mContext.getContentResolver().query(Notes.CONTENT_DATA_URI,
DATA_PROJECTION, DataColumns.NOTE_ID + "=?", new String[] {
- noteId
+ noteId
}, null);
- if (dataCursor != null) {
+ if (dataCursor != null) { //利用光标来扫描内容，区别为callnote和note两种，靠ps.printline输出
if (dataCursor.moveToFirst()) {
do {
String mimeType = dataCursor.getString(DATA_COLUMN_MIME_TYPE);
@@ -181,7 +184,7 @@ public class BackupUtils {
long callDate = dataCursor.getLong(DATA_COLUMN_CALL_DATE);
String location = dataCursor.getString(DATA_COLUMN_CONTENT);
- if (!TextUtils.isEmpty(phoneNumber)) {
+ if (!TextUtils.isEmpty(phoneNumber)) { //判断是否为空字符
ps.println(String.format(getFormat(FORMAT_NOTE_CONTENT),
phoneNumber));
}
@@ -218,7 +221,7 @@ public class BackupUtils {
/**
* Note will be exported as text which is user readable
*/
- public int exportToText() {
+ public int exportToText() { //总函数，调用上面的exportFolder和exportNote
if (!externalStorageAvailable()) {
Log.d(TAG, "Media was not mounted");
return STATE_SD_CARD_UNMOUONTED;
@@ -229,7 +232,7 @@ public class BackupUtils {
Log.e(TAG, "get print stream error");
return STATE_SYSTEM_ERROR;
}
- // First export folder and its notes
+ // First export folder and its notes 导出文件夹，就是导出里面包含的便签
Cursor folderCursor = mContext.getContentResolver().query(
Notes.CONTENT_NOTE_URI,
NOTE_PROJECTION,
@@ -257,7 +260,7 @@ public class BackupUtils {
folderCursor.close();
}
- // Export notes in root's folder
+ // Export notes in root's folder 将根目录里的便签导出（由于不属于任何文件夹，因此无法通过文件夹导出来实现这一部分便签的导出）
Cursor noteCursor = mContext.getContentResolver().query(
Notes.CONTENT_NOTE_URI,
NOTE_PROJECTION,
@@ -297,7 +300,7 @@ public class BackupUtils {
PrintStream ps = null;
try {
FileOutputStream fos = new FileOutputStream(file);
- ps = new PrintStream(fos);
+ ps = new PrintStream(fos); //将ps输出流输出到特定的文件，目的就是导出到文件，而不是直接输出
} catch (FileNotFoundException e) {
e.printStackTrace();
return null;
@@ -314,16 +317,16 @@ public class BackupUtils {
*/
private static File generateFileMountedOnSDcard(Context context, int filePathResId, int fileNameFormatResId) {
StringBuilder sb = new StringBuilder();
- sb.append(Environment.getExternalStorageDirectory());
- sb.append(context.getString(filePathResId));
- File filedir = new File(sb.toString());
+ sb.append(Environment.getExternalStorageDirectory()); //外部（SD卡）的存储路径
+ sb.append(context.getString(filePathResId)); //文件的存储路径
+ File filedir = new File(sb.toString()); //filedir应该就是用来存储路径信息
sb.append(context.getString(
fileNameFormatResId,
DateFormat.format(context.getString(R.string.format_date_ymd),
System.currentTimeMillis())));
File file = new File(sb.toString());
- try {
+ try { //如果这些文件不存在，则新建
if (!filedir.exists()) {
filedir.mkdir();
}
@@ -336,9 +339,7 @@ public class BackupUtils {
} catch (IOException e) {
e.printStackTrace();
}
-
+// try catch 异常处理
return null;
}
}
-
-
diff --git a/src/main/java/net/micode/notes/tool/DataUtils.java b/src/main/java/net/micode/notes/tool/DataUtils.java
index 2a14982..191d589 100644
--- a/src/main/java/net/micode/notes/tool/DataUtils.java
+++ b/src/main/java/net/micode/notes/tool/DataUtils.java
@@ -34,10 +34,9 @@ import net.micode.notes.ui.NotesListAdapter.AppWidgetAttribute;
import java.util.ArrayList;
import java.util.HashSet;
-
public class DataUtils {
public static final String TAG = "DataUtils";
- public static boolean batchDeleteNotes(ContentResolver resolver, HashSet ids) {
+ public static boolean batchDeleteNotes(ContentResolver resolver, HashSet ids) { //直接删除多个笔记
if (ids == null) {
Log.d(TAG, "the ids is null");
return true;
@@ -47,18 +46,19 @@ public class DataUtils {
return true;
}
- ArrayList operationList = new ArrayList();
+ ArrayList operationList = new ArrayList(); //提供一个任务列表
for (long id : ids) {
if(id == Notes.ID_ROOT_FOLDER) {
Log.e(TAG, "Don't delete system folder root");
continue;
- }
+ } //如果发现是根文件夹，则不删除
ContentProviderOperation.Builder builder = ContentProviderOperation
- .newDelete(ContentUris.withAppendedId(Notes.CONTENT_NOTE_URI, id));
- operationList.add(builder.build());
+ .newDelete(ContentUris.withAppendedId(Notes.CONTENT_NOTE_URI, id)); //用newDelete实现删除功能
+ operationList.add(builder.build()); //
}
try {
- ContentProviderResult[] results = resolver.applyBatch(Notes.AUTHORITY, operationList);
+ ContentProviderResult[] results = resolver.applyBatch(Notes.AUTHORITY, operationList);//主机名（或叫Authority）用于唯一标识这个ContentProvider，外部调用者可以根据这个标识来找到它。
+ //数据库事务，数据库事务是由一组数据库操作序列组成，事务作为一个整体被执行
if (results == null || results.length == 0 || results[0] == null) {
Log.d(TAG, "delete notes failed, ids:" + ids.toString());
return false;
@@ -77,11 +77,11 @@ public class DataUtils {
values.put(NoteColumns.PARENT_ID, desFolderId);
values.put(NoteColumns.ORIGIN_PARENT_ID, srcFolderId);
values.put(NoteColumns.LOCAL_MODIFIED, 1);
- resolver.update(ContentUris.withAppendedId(Notes.CONTENT_NOTE_URI, id), values, null, null);
+ resolver.update(ContentUris.withAppendedId(Notes.CONTENT_NOTE_URI, id), values, null, null); //对需要移动的便签进行数据更新，然后用update实现
}
public static boolean batchMoveToFolder(ContentResolver resolver, HashSet ids,
- long folderId) {
+ long folderId) {
if (ids == null) {
Log.d(TAG, "the ids is null");
return true;
@@ -90,14 +90,14 @@ public class DataUtils {
ArrayList operationList = new ArrayList();
for (long id : ids) {
ContentProviderOperation.Builder builder = ContentProviderOperation
- .newUpdate(ContentUris.withAppendedId(Notes.CONTENT_NOTE_URI, id));
+ .newUpdate(ContentUris.withAppendedId(Notes.CONTENT_NOTE_URI, id)); //通过withAppendedId方法，为该Uri加上ID
builder.withValue(NoteColumns.PARENT_ID, folderId);
builder.withValue(NoteColumns.LOCAL_MODIFIED, 1);
operationList.add(builder.build());
- }
+ }//将ids里包含的每一列的数据逐次加入到operationList中，等待最后的批量处理
try {
- ContentProviderResult[] results = resolver.applyBatch(Notes.AUTHORITY, operationList);
+ ContentProviderResult[] results = resolver.applyBatch(Notes.AUTHORITY, operationList); //applyBatch一次性处理一个操作列表
if (results == null || results.length == 0 || results[0] == null) {
Log.d(TAG, "delete notes failed, ids:" + ids.toString());
return false;
@@ -119,7 +119,7 @@ public class DataUtils {
new String[] { "COUNT(*)" },
NoteColumns.TYPE + "=? AND " + NoteColumns.PARENT_ID + "<>?",
new String[] { String.valueOf(Notes.TYPE_FOLDER), String.valueOf(Notes.ID_TRASH_FOLER)},
- null);
+ null); //筛选条件：源文件不为trash folder
int count = 0;
if(cursor != null) {
@@ -137,15 +137,15 @@ public class DataUtils {
}
public static boolean visibleInNoteDatabase(ContentResolver resolver, long noteId, int type) {
- Cursor cursor = resolver.query(ContentUris.withAppendedId(Notes.CONTENT_NOTE_URI, noteId),
+ Cursor cursor = resolver.query(ContentUris.withAppendedId(Notes.CONTENT_NOTE_URI, noteId), //通过withAppendedId方法，为该Uri加上ID
null,
NoteColumns.TYPE + "=? AND " + NoteColumns.PARENT_ID + "<>" + Notes.ID_TRASH_FOLER,
new String [] {String.valueOf(type)},
- null);
+ null); //查询条件：type符合，且不属于垃圾文件夹
boolean exist = false;
if (cursor != null) {
- if (cursor.getCount() > 0) {
+ if (cursor.getCount() > 0) {//用getcount函数判断cursor是否为空
exist = true;
}
cursor.close();
@@ -184,9 +184,10 @@ public class DataUtils {
public static boolean checkVisibleFolderName(ContentResolver resolver, String name) {
Cursor cursor = resolver.query(Notes.CONTENT_NOTE_URI, null,
NoteColumns.TYPE + "=" + Notes.TYPE_FOLDER +
- " AND " + NoteColumns.PARENT_ID + "<>" + Notes.ID_TRASH_FOLER +
- " AND " + NoteColumns.SNIPPET + "=?",
+ " AND " + NoteColumns.PARENT_ID + "<>" + Notes.ID_TRASH_FOLER +
+ " AND " + NoteColumns.SNIPPET + "=?",
new String[] { name }, null);
+ //通过名字查询文件是否存在
boolean exist = false;
if(cursor != null) {
if(cursor.getCount() > 0) {
@@ -202,7 +203,7 @@ public class DataUtils {
new String[] { NoteColumns.WIDGET_ID, NoteColumns.WIDGET_TYPE },
NoteColumns.PARENT_ID + "=?",
new String[] { String.valueOf(folderId) },
- null);
+ null); //查询条件：父ID是传入的folderId;
HashSet set = null;
if (c != null) {
@@ -211,13 +212,13 @@ public class DataUtils {
do {
try {
AppWidgetAttribute widget = new AppWidgetAttribute();
- widget.widgetId = c.getInt(0);
- widget.widgetType = c.getInt(1);
+ widget.widgetId = c.getInt(0); //0对应的NoteColumns.WIDGET_ID
+ widget.widgetType = c.getInt(1); //1对应的NoteColumns.WIDGET_TYPE
set.add(widget);
} catch (IndexOutOfBoundsException e) {
Log.e(TAG, e.toString());
}
- } while (c.moveToNext());
+ } while (c.moveToNext()); //查询下一条
}
c.close();
}
@@ -247,14 +248,15 @@ public class DataUtils {
Cursor cursor = resolver.query(Notes.CONTENT_DATA_URI,
new String [] { CallNote.NOTE_ID },
CallNote.CALL_DATE + "=? AND " + CallNote.MIME_TYPE + "=? AND PHONE_NUMBERS_EQUAL("
- + CallNote.PHONE_NUMBER + ",?)",
+ + CallNote.PHONE_NUMBER + ",?)",
new String [] { String.valueOf(callDate), CallNote.CONTENT_ITEM_TYPE, phoneNumber },
null);
+ //通过数据库操作，查询条件是（callDate和phoneNumber匹配传入参数的值）
if (cursor != null) {
if (cursor.moveToFirst()) {
try {
- return cursor.getLong(0);
+ return cursor.getLong(0); //0对应的CallNote.NOTE_ID
} catch (IndexOutOfBoundsException e) {
Log.e(TAG, "Get call note id fails " + e.toString());
}
@@ -269,7 +271,7 @@ public class DataUtils {
new String [] { NoteColumns.SNIPPET },
NoteColumns.ID + "=?",
new String [] { String.valueOf(noteId)},
- null);
+ null);//查询条件：noteId
if (cursor != null) {
String snippet = "";
@@ -281,8 +283,7 @@ public class DataUtils {
}
throw new IllegalArgumentException("Note is not found with id: " + noteId);
}
-
- public static String getFormattedSnippet(String snippet) {
+ public static String getFormattedSnippet(String snippet) { //对字符串进行格式处理，将字符串两头的空格去掉，同时将换行符去掉
if (snippet != null) {
snippet = snippet.trim();
int index = snippet.indexOf('\n');
@@ -292,4 +293,5 @@ public class DataUtils {
}
return snippet;
}
-}
+
+}
\ No newline at end of file
diff --git a/src/main/java/net/micode/notes/tool/GTaskStringUtils.java b/src/main/java/net/micode/notes/tool/GTaskStringUtils.java
index 666b729..040c553 100644
--- a/src/main/java/net/micode/notes/tool/GTaskStringUtils.java
+++ b/src/main/java/net/micode/notes/tool/GTaskStringUtils.java
@@ -13,9 +13,10 @@
* See the License for the specific language governing permissions and
* limitations under the License.
*/
-
+//简介：定义了很多的静态字符串，目的就是为了提供jsonObject中相应字符串的"key"。把这些静态的定义单独写到了一个类里面，这是非常好的编程规范
package net.micode.notes.tool;
+//这个类就是定义了一堆static string，实际就是为jsonObject提供Key，把这些定义全部写到一个类里，方便查看管理，是一个非常好的编程习惯
public class GTaskStringUtils {
public final static String GTASK_JSON_ACTION_ID = "action_id";
@@ -110,4 +111,4 @@ public class GTaskStringUtils {
public final static String META_NOTE_NAME = "[META INFO] DON'T UPDATE AND DELETE";
-}
+}
\ No newline at end of file
diff --git a/src/main/java/net/micode/notes/tool/ResourceParser.java b/src/main/java/net/micode/notes/tool/ResourceParser.java
index 1ad3ad6..7578b68 100644
--- a/src/main/java/net/micode/notes/tool/ResourceParser.java
+++ b/src/main/java/net/micode/notes/tool/ResourceParser.java
@@ -22,6 +22,21 @@ import android.preference.PreferenceManager;
import net.micode.notes.R;
import net.micode.notes.ui.NotesPreferenceActivity;
+/*简介：字面意义是资源分析器，实际上就是获取资源并且在程序中使用，比如颜色图片等
+ * 实现方法：主要利用R.java这个类，其中包括
+ * R.id 组件资源引用
+ * R.drawable 图片资源 （被使用）
+ * R.layout 布局资源
+ * R.menu 菜单资源
+ * R.String 文字资源
+ * R.style 主题资源 （被使用）
+ * 在按顺序设置好相应的id后，就可以编写简单的getXXX函数获取需要的资源
+ *
+ * 特殊的变量 ：
+ * @BG_DEFAULT_COLOR 默认背景颜色（黄）
+ * BG_DEFAULT_FONT_SIZE 默认文本大小（中）
+ */
+
public class ResourceParser {
public static final int YELLOW = 0;
@@ -41,19 +56,19 @@ public class ResourceParser {
public static class NoteBgResources {
private final static int [] BG_EDIT_RESOURCES = new int [] {
- R.drawable.edit_yellow,
- R.drawable.edit_blue,
- R.drawable.edit_white,
- R.drawable.edit_green,
- R.drawable.edit_red
+ R.drawable.edit_yellow,
+ R.drawable.edit_blue,
+ R.drawable.edit_white,
+ R.drawable.edit_green,
+ R.drawable.edit_red
};
private final static int [] BG_EDIT_TITLE_RESOURCES = new int [] {
- R.drawable.edit_title_yellow,
- R.drawable.edit_title_blue,
- R.drawable.edit_title_white,
- R.drawable.edit_title_green,
- R.drawable.edit_title_red
+ R.drawable.edit_title_yellow,
+ R.drawable.edit_title_blue,
+ R.drawable.edit_title_white,
+ R.drawable.edit_title_green,
+ R.drawable.edit_title_red
};
public static int getNoteBgResource(int id) {
@@ -64,7 +79,7 @@ public class ResourceParser {
return BG_EDIT_TITLE_RESOURCES[id];
}
}
-
+ //直接获取默认的背景颜色。看不太懂，这个PREFERENCE_SET_BG_COLOR_KEY是个final string,也就是说getBoolean肯定执行else，为什么要这么写
public static int getDefaultBgId(Context context) {
if (PreferenceManager.getDefaultSharedPreferences(context).getBoolean(
NotesPreferenceActivity.PREFERENCE_SET_BG_COLOR_KEY, false)) {
@@ -76,35 +91,35 @@ public class ResourceParser {
public static class NoteItemBgResources {
private final static int [] BG_FIRST_RESOURCES = new int [] {
- R.drawable.list_yellow_up,
- R.drawable.list_blue_up,
- R.drawable.list_white_up,
- R.drawable.list_green_up,
- R.drawable.list_red_up
+ R.drawable.list_yellow_up,
+ R.drawable.list_blue_up,
+ R.drawable.list_white_up,
+ R.drawable.list_green_up,
+ R.drawable.list_red_up
};
private final static int [] BG_NORMAL_RESOURCES = new int [] {
- R.drawable.list_yellow_middle,
- R.drawable.list_blue_middle,
- R.drawable.list_white_middle,
- R.drawable.list_green_middle,
- R.drawable.list_red_middle
+ R.drawable.list_yellow_middle,
+ R.drawable.list_blue_middle,
+ R.drawable.list_white_middle,
+ R.drawable.list_green_middle,
+ R.drawable.list_red_middle
};
private final static int [] BG_LAST_RESOURCES = new int [] {
- R.drawable.list_yellow_down,
- R.drawable.list_blue_down,
- R.drawable.list_white_down,
- R.drawable.list_green_down,
- R.drawable.list_red_down,
+ R.drawable.list_yellow_down,
+ R.drawable.list_blue_down,
+ R.drawable.list_white_down,
+ R.drawable.list_green_down,
+ R.drawable.list_red_down,
};
private final static int [] BG_SINGLE_RESOURCES = new int [] {
- R.drawable.list_yellow_single,
- R.drawable.list_blue_single,
- R.drawable.list_white_single,
- R.drawable.list_green_single,
- R.drawable.list_red_single
+ R.drawable.list_yellow_single,
+ R.drawable.list_blue_single,
+ R.drawable.list_white_single,
+ R.drawable.list_green_single,
+ R.drawable.list_red_single
};
public static int getNoteBgFirstRes(int id) {
@@ -130,11 +145,11 @@ public class ResourceParser {
public static class WidgetBgResources {
private final static int [] BG_2X_RESOURCES = new int [] {
- R.drawable.widget_2x_yellow,
- R.drawable.widget_2x_blue,
- R.drawable.widget_2x_white,
- R.drawable.widget_2x_green,
- R.drawable.widget_2x_red,
+ 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,
};
public static int getWidget2xBgResource(int id) {
@@ -142,11 +157,11 @@ public class ResourceParser {
}
private final static int [] BG_4X_RESOURCES = new int [] {
- R.drawable.widget_4x_yellow,
- R.drawable.widget_4x_blue,
- R.drawable.widget_4x_white,
- R.drawable.widget_4x_green,
- R.drawable.widget_4x_red
+ R.drawable.widget_4x_yellow,
+ R.drawable.widget_4x_blue,
+ R.drawable.widget_4x_white,
+ R.drawable.widget_4x_green,
+ R.drawable.widget_4x_red
};
public static int getWidget4xBgResource(int id) {
@@ -156,12 +171,13 @@ public class ResourceParser {
public static class TextAppearanceResources {
private final static int [] TEXTAPPEARANCE_RESOURCES = new int [] {
- R.style.TextAppearanceNormal,
- R.style.TextAppearanceMedium,
- R.style.TextAppearanceLarge,
- R.style.TextAppearanceSuper
+ R.style.TextAppearanceNormal,
+ R.style.TextAppearanceMedium,
+ R.style.TextAppearanceLarge,
+ R.style.TextAppearanceSuper
};
+ //这里有一个容错的函数，防止输入的id大于资源总量，若如此，则自动返回默认的设置结果
public static int getTexAppearanceResource(int id) {
/**
* HACKME: Fix bug of store the resource id in shared preference.
@@ -178,4 +194,4 @@ public class ResourceParser {
return TEXTAPPEARANCE_RESOURCES.length;
}
}
-}
+}
\ No newline at end of file
diff --git a/src/main/java/net/micode/notes/ui/AlarmAlertActivity.java b/src/main/java/net/micode/notes/ui/AlarmAlertActivity.java
index 85723be..54b5f2f 100644
--- a/src/main/java/net/micode/notes/ui/AlarmAlertActivity.java
+++ b/src/main/java/net/micode/notes/ui/AlarmAlertActivity.java
@@ -1,18 +1,3 @@
-/*
- * Copyright (c) 2010-2011, The MiCode Open Source Community (www.micode.net)
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
package net.micode.notes.ui;
@@ -39,58 +24,81 @@ import net.micode.notes.tool.DataUtils;
import java.io.IOException;
-
public class AlarmAlertActivity extends Activity implements OnClickListener, OnDismissListener {
- private long mNoteId;
- private String mSnippet;
+ private long mNoteId; //文本在数据库存储中的ID号
+ private String mSnippet; //闹钟提示时出现的文本片段
private static final int SNIPPET_PREW_MAX_LEN = 60;
MediaPlayer mPlayer;
@Override
protected void onCreate(Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
+ //Bundle类型的数据与Map类型的数据相似，都是以key-value的形式存储数据的
+ //onsaveInstanceState方法是用来保存Activity的状态的
+ //能从onCreate的参数savedInsanceState中获得状态数据
requestWindowFeature(Window.FEATURE_NO_TITLE);
+ //界面显示——无标题
final Window win = getWindow();
win.addFlags(WindowManager.LayoutParams.FLAG_SHOW_WHEN_LOCKED);
if (!isScreenOn()) {
win.addFlags(WindowManager.LayoutParams.FLAG_KEEP_SCREEN_ON
+ //保持窗体点亮
| WindowManager.LayoutParams.FLAG_TURN_SCREEN_ON
+ //将窗体点亮
| WindowManager.LayoutParams.FLAG_ALLOW_LOCK_WHILE_SCREEN_ON
+ //允许窗体点亮时锁屏
| WindowManager.LayoutParams.FLAG_LAYOUT_INSET_DECOR);
- }
+ }//在手机锁屏后如果到了闹钟提示时间，点亮屏幕
Intent intent = getIntent();
try {
mNoteId = Long.valueOf(intent.getData().getPathSegments().get(1));
mSnippet = DataUtils.getSnippetById(this.getContentResolver(), mNoteId);
+ //根据ID从数据库中获取标签的内容；
+ //getContentResolver（）是实现数据共享，实例存储。
mSnippet = mSnippet.length() > SNIPPET_PREW_MAX_LEN ? mSnippet.substring(0,
SNIPPET_PREW_MAX_LEN) + getResources().getString(R.string.notelist_string_info)
: mSnippet;
+ //判断标签片段是否达到符合长度
} catch (IllegalArgumentException e) {
e.printStackTrace();
return;
}
-
+ /*
+ try
+ {
+ // 代码区
+ }
+ catch(Exception e)
+ {
+ // 异常处理
+ }
+ 代码区如果有错误，就会返回所写异常的处理。*/
mPlayer = new MediaPlayer();
if (DataUtils.visibleInNoteDatabase(getContentResolver(), mNoteId, Notes.TYPE_NOTE)) {
showActionDialog();
+ //弹出对话框
playAlarmSound();
+ //闹钟提示音激发
} else {
finish();
+ //完成闹钟动作
}
}
private boolean isScreenOn() {
+ //判断屏幕是否锁屏，调用系统函数判断，最后返回值是布尔类型
PowerManager pm = (PowerManager) getSystemService(Context.POWER_SERVICE);
return pm.isScreenOn();
}
private void playAlarmSound() {
+ //闹钟提示音激发
Uri url = RingtoneManager.getActualDefaultRingtoneUri(this, RingtoneManager.TYPE_ALARM);
-
+ //调用系统的铃声管理URI，得到闹钟提示音
int silentModeStreams = Settings.System.getInt(getContentResolver(),
Settings.System.MODE_RINGER_STREAMS_AFFECTED, 0);
@@ -101,12 +109,19 @@ public class AlarmAlertActivity extends Activity implements OnClickListener, OnD
}
try {
mPlayer.setDataSource(this, url);
+ //方法：setDataSource(Context context, Uri uri)
+ //解释：无返回值，设置多媒体数据来源【根据 Uri】
mPlayer.prepare();
+ //准备同步
mPlayer.setLooping(true);
+ //设置是否循环播放
mPlayer.start();
+ //开始播放
} catch (IllegalArgumentException e) {
// TODO Auto-generated catch block
e.printStackTrace();
+ //e.printStackTrace()函数功能是抛出异常， 还将显示出更深的调用信息
+ //System.out.println(e)，这个方法打印出异常，并且输出在哪里出现的异常
} catch (SecurityException e) {
// TODO Auto-generated catch block
e.printStackTrace();
@@ -121,38 +136,58 @@ public class AlarmAlertActivity extends Activity implements OnClickListener, OnD
private void showActionDialog() {
AlertDialog.Builder dialog = new AlertDialog.Builder(this);
+ //AlertDialog的构造方法全部是Protected的
+ //所以不能直接通过new一个AlertDialog来创建出一个AlertDialog。
+ //要创建一个AlertDialog，就要用到AlertDialog.Builder中的create()方法
+ //如这里的dialog就是新建了一个AlertDialog
dialog.setTitle(R.string.app_name);
+ //为对话框设置标题
dialog.setMessage(mSnippet);
+ //为对话框设置内容
dialog.setPositiveButton(R.string.notealert_ok, this);
+ //给对话框添加"Yes"按钮
if (isScreenOn()) {
dialog.setNegativeButton(R.string.notealert_enter, this);
- }
+ }//对话框添加"No"按钮
dialog.show().setOnDismissListener(this);
}
public void onClick(DialogInterface dialog, int which) {
switch (which) {
+ //用which来选择click后下一步的操作
case DialogInterface.BUTTON_NEGATIVE:
+ //这是取消操作
Intent intent = new Intent(this, NoteEditActivity.class);
+ //实现两个类间的数据传输
intent.setAction(Intent.ACTION_VIEW);
+ //设置动作属性
intent.putExtra(Intent.EXTRA_UID, mNoteId);
+ //实现key-value对
+ //EXTRA_UID为key；mNoteId为键
startActivity(intent);
+ //开始动作
break;
default:
+ //这是确定操作
break;
}
}
public void onDismiss(DialogInterface dialog) {
+ //忽略
stopAlarmSound();
+ //停止闹钟声音
finish();
+ //完成该动作
}
private void stopAlarmSound() {
if (mPlayer != null) {
mPlayer.stop();
+ //停止播放
mPlayer.release();
+ //释放MediaPlayer对象
mPlayer = null;
}
}
-}
+}
\ No newline at end of file
diff --git a/src/main/java/net/micode/notes/ui/AlarmInitReceiver.java b/src/main/java/net/micode/notes/ui/AlarmInitReceiver.java
index f221202..4163ccd 100644
--- a/src/main/java/net/micode/notes/ui/AlarmInitReceiver.java
+++ b/src/main/java/net/micode/notes/ui/AlarmInitReceiver.java
@@ -1,19 +1,3 @@
-/*
- * Copyright (c) 2010-2011, The MiCode Open Source Community (www.micode.net)
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-
package net.micode.notes.ui;
import android.app.AlarmManager;
@@ -31,21 +15,25 @@ import net.micode.notes.data.Notes.NoteColumns;
public class AlarmInitReceiver extends BroadcastReceiver {
private static final String [] PROJECTION = new String [] {
- NoteColumns.ID,
- NoteColumns.ALERTED_DATE
+ NoteColumns.ID,
+ NoteColumns.ALERTED_DATE
};
-
+ //对数据库的操作，调用标签ID和闹钟时间
private static final int COLUMN_ID = 0;
private static final int COLUMN_ALERTED_DATE = 1;
@Override
public void onReceive(Context context, Intent intent) {
long currentDate = System.currentTimeMillis();
+ //System.currentTimeMillis()产生一个当前的毫秒
+ //这个毫秒其实就是自1970年1月1日0时起的毫秒数
Cursor c = context.getContentResolver().query(Notes.CONTENT_NOTE_URI,
PROJECTION,
NoteColumns.ALERTED_DATE + ">? AND " + NoteColumns.TYPE + "=" + Notes.TYPE_NOTE,
new String[] { String.valueOf(currentDate) },
+ //将long变量currentDate转化为字符串
null);
+ //Cursor在这里的作用是通过查找数据库中的标签内容，找到和当前系统时间相等的标签
if (c != null) {
if (c.moveToFirst()) {
@@ -61,5 +49,8 @@ public class AlarmInitReceiver extends BroadcastReceiver {
}
c.close();
}
+ //然而通过网上查找资料发现，对于闹钟机制的启动，通常需要上面的几个步骤
+ //如新建Intent、PendingIntent以及AlarmManager等
+ //这里就是根据数据库里的闹钟时间创建一个闹钟机制
}
-}
+}
\ No newline at end of file
diff --git a/src/main/java/net/micode/notes/ui/AlarmReceiver.java b/src/main/java/net/micode/notes/ui/AlarmReceiver.java
index 54e503b..6e22aff 100644
--- a/src/main/java/net/micode/notes/ui/AlarmReceiver.java
+++ b/src/main/java/net/micode/notes/ui/AlarmReceiver.java
@@ -1,19 +1,3 @@
-/*
- * Copyright (c) 2010-2011, The MiCode Open Source Community (www.micode.net)
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-
package net.micode.notes.ui;
import android.content.BroadcastReceiver;
@@ -24,7 +8,13 @@ public class AlarmReceiver extends BroadcastReceiver {
@Override
public void onReceive(Context context, Intent intent) {
intent.setClass(context, AlarmAlertActivity.class);
+ //启动AlarmAlertActivity
intent.addFlags(Intent.FLAG_ACTIVITY_NEW_TASK);
+ //activity要存在于activity的栈中，而非activity的途径启动activity时必然不存在一个activity的栈
+ //所以要新起一个栈装入启动的activity
context.startActivity(intent);
}
}
+//这是实现alarm这个功能最接近用户层的包，基于上面的两个包，
+//作用还需要深究但是对于setClass和addFlags的
+
\ No newline at end of file
diff --git a/src/main/java/net/micode/notes/ui/DateTimePicker.java b/src/main/java/net/micode/notes/ui/DateTimePicker.java
index 496b0cd..8d74062 100644
--- a/src/main/java/net/micode/notes/ui/DateTimePicker.java
+++ b/src/main/java/net/micode/notes/ui/DateTimePicker.java
@@ -1,19 +1,3 @@
-/*
- * Copyright (c) 2010-2011, The MiCode Open Source Community (www.micode.net)
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-
package net.micode.notes.ui;
import java.text.DateFormatSymbols;
@@ -29,7 +13,8 @@ import android.widget.FrameLayout;
import android.widget.NumberPicker;
public class DateTimePicker extends FrameLayout {
-
+ //FrameLayout是布局模板之一
+ //所有的子元素全部在屏幕的右上方
private static final boolean DEFAULT_ENABLE_STATE = true;
private static final int HOURS_IN_HALF_DAY = 12;
@@ -45,13 +30,15 @@ public class DateTimePicker extends FrameLayout {
private static final int MINUT_SPINNER_MAX_VAL = 59;
private static final int AMPM_SPINNER_MIN_VAL = 0;
private static final int AMPM_SPINNER_MAX_VAL = 1;
-
+ //初始化控件
private final NumberPicker mDateSpinner;
private final NumberPicker mHourSpinner;
private final NumberPicker mMinuteSpinner;
private final NumberPicker mAmPmSpinner;
+ //NumberPicker是数字选择器
+ //这里定义的四个变量全部是在设置闹钟时需要选择的变量（如日期、时、分、上午或者下午）
private Calendar mDate;
-
+ //定义了Calendar类型的变量mDate，用于操作时间
private String[] mDateDisplayValues = new String[DAYS_IN_ALL_WEEK];
private boolean mIsAm;
@@ -71,41 +58,49 @@ public class DateTimePicker extends FrameLayout {
updateDateControl();
onDateTimeChanged();
}
- };
+ };//OnValueChangeListener，这是时间改变监听器，这里主要是对日期的监听
+ //将现在日期的值传递给mDate；updateDateControl是同步操作
private NumberPicker.OnValueChangeListener mOnHourChangedListener = new NumberPicker.OnValueChangeListener() {
+ //这里是对 小时（Hour） 的监听
@Override
public void onValueChange(NumberPicker picker, int oldVal, int newVal) {
boolean isDateChanged = false;
Calendar cal = Calendar.getInstance();
+ //声明一个Calendar的变量cal，便于后续的操作
if (!mIs24HourView) {
if (!mIsAm && oldVal == HOURS_IN_HALF_DAY - 1 && newVal == HOURS_IN_HALF_DAY) {
cal.setTimeInMillis(mDate.getTimeInMillis());
cal.add(Calendar.DAY_OF_YEAR, 1);
isDateChanged = true;
+ //这里是对于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点交替时对日期的更改
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();
- }
+ }//这里是对于12小时制时，中午11点和12点交替时对AM和PM的更改
} else {
if (oldVal == HOURS_IN_ALL_DAY - 1 && newVal == 0) {
cal.setTimeInMillis(mDate.getTimeInMillis());
cal.add(Calendar.DAY_OF_YEAR, 1);
isDateChanged = true;
+ //这里是对于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;
}
- }
+ } //这里是对于12小时制时，凌晨11点和12点交替时对日期的更改
int newHour = mHourSpinner.getValue() % HOURS_IN_HALF_DAY + (mIsAm ? 0 : HOURS_IN_HALF_DAY);
+ //通过数字选择器对newHour的赋值
mDate.set(Calendar.HOUR_OF_DAY, newHour);
+ //通过set函数将新的Hour值传给mDate
onDateTimeChanged();
if (isDateChanged) {
setCurrentYear(cal.get(Calendar.YEAR));
@@ -117,15 +112,19 @@ public class DateTimePicker extends FrameLayout {
private NumberPicker.OnValueChangeListener mOnMinuteChangedListener = new NumberPicker.OnValueChangeListener() {
@Override
+ //这里是对 分钟（Minute）改变的监听
public void onValueChange(NumberPicker picker, int oldVal, int newVal) {
int minValue = mMinuteSpinner.getMinValue();
int maxValue = mMinuteSpinner.getMaxValue();
int offset = 0;
+ //设置offset，作为小时改变的一个记录数据
if (oldVal == maxValue && newVal == minValue) {
offset += 1;
} else if (oldVal == minValue && newVal == maxValue) {
offset -= 1;
}
+ //如果原值为59，新值为0，则offset加1
+ //如果原值为0，新值为59，则offset减1
if (offset != 0) {
mDate.add(Calendar.HOUR_OF_DAY, offset);
mHourSpinner.setValue(getCurrentHour());
@@ -145,6 +144,7 @@ public class DateTimePicker extends FrameLayout {
};
private NumberPicker.OnValueChangeListener mOnAmPmChangedListener = new NumberPicker.OnValueChangeListener() {
+ //对AM和PM的监听
@Override
public void onValueChange(NumberPicker picker, int oldVal, int newVal) {
mIsAm = !mIsAm;
@@ -160,24 +160,27 @@ public class DateTimePicker extends FrameLayout {
public interface OnDateTimeChangedListener {
void onDateTimeChanged(DateTimePicker view, int year, int month,
- int dayOfMonth, int hourOfDay, int minute);
+ int dayOfMonth, int hourOfDay, int minute);
}
public DateTimePicker(Context context) {
this(context, System.currentTimeMillis());
- }
+ }//通过对数据库的访问，获取当前的系统时间
public DateTimePicker(Context context, long date) {
this(context, date, DateFormat.is24HourFormat(context));
- }
+ }//上面函数的得到的是一个天文数字（1970至今的秒数），需要DateFormat将其变得有意义
public DateTimePicker(Context context, long date, boolean is24HourView) {
super(context);
+ //获取系统时间
mDate = Calendar.getInstance();
mInitialising = true;
mIsAm = getCurrentHourOfDay() >= HOURS_IN_HALF_DAY;
inflate(context, R.layout.datetime_picker, this);
-
+ //如果当前Activity里用到别的layout，比如对话框layout
+ //还要设置这个layout上的其他组件的内容，就必须用inflate()方法先将对话框的layout找出来
+ //然后再用findViewById()找到它上面的其它组件
mDateSpinner = (NumberPicker) findViewById(R.id.date);
mDateSpinner.setMinValue(DATE_SPINNER_MIN_VAL);
mDateSpinner.setMaxValue(DATE_SPINNER_MAX_VAL);
@@ -185,7 +188,7 @@ public class DateTimePicker extends FrameLayout {
mHourSpinner = (NumberPicker) findViewById(R.id.hour);
mHourSpinner.setOnValueChangedListener(mOnHourChangedListener);
- mMinuteSpinner = (NumberPicker) findViewById(R.id.minute);
+ mMinuteSpinner = (NumberPicker) findViewById(R.id.minute);
mMinuteSpinner.setMinValue(MINUT_SPINNER_MIN_VAL);
mMinuteSpinner.setMaxValue(MINUT_SPINNER_MAX_VAL);
mMinuteSpinner.setOnLongPressUpdateInterval(100);
@@ -226,7 +229,9 @@ public class DateTimePicker extends FrameLayout {
mAmPmSpinner.setEnabled(enabled);
mIsEnabled = enabled;
}
-
+ //存在疑问！！！！！！！！！！！！！setEnabled的作用
+ //下面的代码通过原程序的注释已经比较清晰，另外可以通过函数名来判断
+ //下面的各函数主要是对上面代码引用到的各函数功能的实现
@Override
public boolean isEnabled() {
return mIsEnabled;
@@ -239,7 +244,7 @@ public class DateTimePicker extends FrameLayout {
*/
public long getCurrentDateInTimeMillis() {
return mDate.getTimeInMillis();
- }
+ }//实现函数——得到当前的秒数
/**
* Set the current date
@@ -251,7 +256,7 @@ public class DateTimePicker extends FrameLayout {
cal.setTimeInMillis(date);
setCurrentDate(cal.get(Calendar.YEAR), cal.get(Calendar.MONTH), cal.get(Calendar.DAY_OF_MONTH),
cal.get(Calendar.HOUR_OF_DAY), cal.get(Calendar.MINUTE));
- }
+ }//实现函数功能——设置当前的时间，参数是date
/**
* Set the current date
@@ -263,19 +268,20 @@ public class DateTimePicker extends FrameLayout {
* @param minute The current minute
*/
public void setCurrentDate(int year, int month,
- int dayOfMonth, int hourOfDay, int minute) {
+ int dayOfMonth, int hourOfDay, int minute) {
setCurrentYear(year);
setCurrentMonth(month);
setCurrentDay(dayOfMonth);
setCurrentHour(hourOfDay);
setCurrentMinute(minute);
- }
+ }//实现函数功能——设置当前的时间，参数是各详细的变量
/**
* Get current year
*
* @return The current year
*/
+ //下面是得到year、month、day等值
public int getCurrentYear() {
return mDate.get(Calendar.YEAR);
}
@@ -446,7 +452,7 @@ public class DateTimePicker extends FrameLayout {
mDateSpinner.setDisplayedValues(mDateDisplayValues);
mDateSpinner.setValue(DAYS_IN_ALL_WEEK / 2);
mDateSpinner.invalidate();
- }
+ }// 对于星期几的算法
private void updateAmPmControl() {
if (mIs24HourView) {
@@ -455,7 +461,7 @@ public class DateTimePicker extends FrameLayout {
int index = mIsAm ? Calendar.AM : Calendar.PM;
mAmPmSpinner.setValue(index);
mAmPmSpinner.setVisibility(View.VISIBLE);
- }
+ }// 对于上下午操作的算法
}
private void updateHourControl() {
@@ -465,7 +471,7 @@ public class DateTimePicker extends FrameLayout {
} else {
mHourSpinner.setMinValue(HOUR_SPINNER_MIN_VAL_12_HOUR_VIEW);
mHourSpinner.setMaxValue(HOUR_SPINNER_MAX_VAL_12_HOUR_VIEW);
- }
+ }// 对与小时的算法
}
/**
@@ -482,4 +488,4 @@ public class DateTimePicker extends FrameLayout {
getCurrentMonth(), getCurrentDay(), getCurrentHourOfDay(), getCurrentMinute());
}
}
-}
+}
\ No newline at end of file
diff --git a/src/main/java/net/micode/notes/ui/DateTimePickerDialog.java b/src/main/java/net/micode/notes/ui/DateTimePickerDialog.java
index 2c47ba4..d6ad95e 100644
--- a/src/main/java/net/micode/notes/ui/DateTimePickerDialog.java
+++ b/src/main/java/net/micode/notes/ui/DateTimePickerDialog.java
@@ -1,19 +1,3 @@
-/*
- * Copyright (c) 2010-2011, The MiCode Open Source Community (www.micode.net)
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-
package net.micode.notes.ui;
import java.util.Calendar;
@@ -32,35 +16,47 @@ import android.text.format.DateUtils;
public class DateTimePickerDialog extends AlertDialog implements OnClickListener {
private Calendar mDate = Calendar.getInstance();
+ //创建一个Calendar类型的变量 mDate，方便时间的操作
private boolean mIs24HourView;
private OnDateTimeSetListener mOnDateTimeSetListener;
+ //声明一个时间日期滚动选择控件 mOnDateTimeSetListener
private DateTimePicker mDateTimePicker;
+ //DateTimePicker控件，控件一般用于让用户可以从日期列表中选择单个值。
+ //运行时，单击控件边上的下拉箭头，会显示为两个部分：一个下拉列表，一个用于选择日期的
public interface OnDateTimeSetListener {
void OnDateTimeSet(AlertDialog dialog, long date);
}
public DateTimePickerDialog(Context context, long date) {
+ //对该界面对话框的实例化
super(context);
+ //对数据库的操作
mDateTimePicker = new DateTimePicker(context);
setView(mDateTimePicker);
+ //添加一个子视图
mDateTimePicker.setOnDateTimeChangedListener(new OnDateTimeChangedListener() {
public void onDateTimeChanged(DateTimePicker view, int year, int month,
- int dayOfMonth, int hourOfDay, int minute) {
+ 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);
+ //将秒数设置为0
mDateTimePicker.setCurrentDate(mDate.getTimeInMillis());
setButton(context.getString(R.string.datetime_dialog_ok), this);
setButton2(context.getString(R.string.datetime_dialog_cancel), (OnClickListener)null);
+ //设置按钮
set24HourView(DateFormat.is24HourFormat(this.getContext()));
+ //时间标准化打印
updateTitle(mDate.getTimeInMillis());
}
@@ -70,21 +66,22 @@ public class DateTimePickerDialog extends AlertDialog implements OnClickListener
public void setOnDateTimeSetListener(OnDateTimeSetListener callBack) {
mOnDateTimeSetListener = callBack;
- }
+ }//将时间日期滚动选择控件实例化
private void updateTitle(long date) {
int flag =
- DateUtils.FORMAT_SHOW_YEAR |
- DateUtils.FORMAT_SHOW_DATE |
- DateUtils.FORMAT_SHOW_TIME;
+ DateUtils.FORMAT_SHOW_YEAR |
+ DateUtils.FORMAT_SHOW_DATE |
+ DateUtils.FORMAT_SHOW_TIME;
flag |= mIs24HourView ? DateUtils.FORMAT_24HOUR : DateUtils.FORMAT_24HOUR;
setTitle(DateUtils.formatDateTime(this.getContext(), date, flag));
- }
+ }//android开发中常见日期管理工具类（API）——DateUtils：按照上下午显示时间
public void onClick(DialogInterface arg0, int arg1) {
if (mOnDateTimeSetListener != null) {
mOnDateTimeSetListener.OnDateTimeSet(this, mDate.getTimeInMillis());
}
- }
+ }//第一个参数arg0是接收到点击事件的对话框
+ //第二个参数arg1是该对话框上的按钮
}
\ No newline at end of file
diff --git a/src/main/java/net/micode/notes/ui/DropdownMenu.java b/src/main/java/net/micode/notes/ui/DropdownMenu.java
index 613dc74..c831a9b 100644
--- a/src/main/java/net/micode/notes/ui/DropdownMenu.java
+++ b/src/main/java/net/micode/notes/ui/DropdownMenu.java
@@ -1,19 +1,3 @@
-/*
- * Copyright (c) 2010-2011, The MiCode Open Source Community (www.micode.net)
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-
package net.micode.notes.ui;
import android.content.Context;
@@ -30,14 +14,18 @@ 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);
+ //设置这个view的背景
mPopupMenu = new PopupMenu(context, mButton);
mMenu = mPopupMenu.getMenu();
mPopupMenu.getMenuInflater().inflate(menuId, mMenu);
+ //MenuInflater是用来实例化Menu目录下的Menu布局文件
+ //根据ID来确认menu的内容选项
mButton.setOnClickListener(new OnClickListener() {
public void onClick(View v) {
mPopupMenu.show();
@@ -48,14 +36,14 @@ public class DropdownMenu {
public void setOnDropdownMenuItemClickListener(OnMenuItemClickListener listener) {
if (mPopupMenu != null) {
mPopupMenu.setOnMenuItemClickListener(listener);
- }
+ }//设置菜单的监听
}
public MenuItem findItem(int id) {
return mMenu.findItem(id);
- }
+ }//对于菜单选项的初始化，根据索引搜索菜单需要的选项
public void setTitle(CharSequence title) {
mButton.setText(title);
- }
-}
+ }//布局文件，设置标题
+}
\ No newline at end of file
diff --git a/src/main/java/net/micode/notes/ui/FoldersListAdapter.java b/src/main/java/net/micode/notes/ui/FoldersListAdapter.java
index 96b77da..b6867fb 100644
--- a/src/main/java/net/micode/notes/ui/FoldersListAdapter.java
+++ b/src/main/java/net/micode/notes/ui/FoldersListAdapter.java
@@ -1,19 +1,3 @@
-/*
- * Copyright (c) 2010-2011, The MiCode Open Source Community (www.micode.net)
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-
package net.micode.notes.ui;
import android.content.Context;
@@ -30,10 +14,14 @@ import net.micode.notes.data.Notes.NoteColumns;
public class FoldersListAdapter extends CursorAdapter {
+ //CursorAdapter是Cursor和ListView的接口
+ //FoldersListAdapter继承了CursorAdapter的类
+ //主要作用是便签数据库和用户的交互
+ //这里就是用folder（文件夹）的形式展现给用户
public static final String [] PROJECTION = {
- NoteColumns.ID,
- NoteColumns.SNIPPET
- };
+ NoteColumns.ID,
+ NoteColumns.SNIPPET
+ };//调用数据库中便签的ID和片段
public static final int ID_COLUMN = 0;
public static final int NAME_COLUMN = 1;
@@ -41,12 +29,13 @@ public class FoldersListAdapter extends CursorAdapter {
public FoldersListAdapter(Context context, Cursor c) {
super(context, c);
// TODO Auto-generated constructor stub
- }
+ }//数据库操作
@Override
public View newView(Context context, Cursor cursor, ViewGroup parent) {
+ //ViewGroup是容器
return new FolderListItem(context);
- }
+ }//创建一个文件夹，对于各文件夹中子标签的初始化
@Override
public void bindView(View view, Context context, Cursor cursor) {
@@ -55,20 +44,22 @@ public class FoldersListAdapter extends CursorAdapter {
.getString(R.string.menu_move_parent_folder) : cursor.getString(NAME_COLUMN);
((FolderListItem) view).bind(folderName);
}
- }
+ }//将各个布局文件绑定起来
public String getFolderName(Context context, int position) {
Cursor cursor = (Cursor) getItem(position);
return (cursor.getLong(ID_COLUMN) == Notes.ID_ROOT_FOLDER) ? context
.getString(R.string.menu_move_parent_folder) : cursor.getString(NAME_COLUMN);
- }
+ }//根据数据库中标签的ID得到标签的各项内容
private class FolderListItem extends LinearLayout {
private TextView mName;
public FolderListItem(Context context) {
super(context);
+ //操作数据库
inflate(context, R.layout.folder_list_item, this);
+ //根据布局文件的名字等信息将其找出来
mName = (TextView) findViewById(R.id.tv_folder_name);
}
@@ -77,4 +68,4 @@ public class FoldersListAdapter extends CursorAdapter {
}
}
-}
+}
\ No newline at end of file
diff --git a/src/main/java/net/micode/notes/ui/NoteEditActivity.java b/src/main/java/net/micode/notes/ui/NoteEditActivity.java
index 96a9ff8..0faa62e 100644
--- a/src/main/java/net/micode/notes/ui/NoteEditActivity.java
+++ b/src/main/java/net/micode/notes/ui/NoteEditActivity.java
@@ -1,19 +1,3 @@
-/*
- * Copyright (c) 2010-2011, The MiCode Open Source Community (www.micode.net)
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-
package net.micode.notes.ui;
import android.app.Activity;
@@ -74,6 +58,8 @@ import java.util.regex.Pattern;
public class NoteEditActivity extends Activity implements OnClickListener,
NoteSettingChangedListener, OnTextViewChangeListener {
+ //该类主要是针对标签的编辑
+ //继承了系统内部许多和监听有关的类
private class HeadViewHolder {
public TextView tvModified;
@@ -83,7 +69,7 @@ public class NoteEditActivity extends Activity implements OnClickListener,
public ImageView ibSetBgColor;
}
-
+ //使用Map实现数据存储
private static final Map sBgSelectorBtnsMap = new HashMap();
static {
sBgSelectorBtnsMap.put(R.id.iv_bg_yellow, ResourceParser.YELLOW);
@@ -91,6 +77,7 @@ public class NoteEditActivity extends Activity implements OnClickListener,
sBgSelectorBtnsMap.put(R.id.iv_bg_blue, ResourceParser.BLUE);
sBgSelectorBtnsMap.put(R.id.iv_bg_green, ResourceParser.GREEN);
sBgSelectorBtnsMap.put(R.id.iv_bg_white, ResourceParser.WHITE);
+ //put函数是将指定值和指定键相连
}
private static final Map sBgSelectorSelectionMap = new HashMap();
@@ -100,6 +87,7 @@ public class NoteEditActivity extends Activity implements OnClickListener,
sBgSelectorSelectionMap.put(ResourceParser.BLUE, R.id.iv_bg_blue_select);
sBgSelectorSelectionMap.put(ResourceParser.GREEN, R.id.iv_bg_green_select);
sBgSelectorSelectionMap.put(ResourceParser.WHITE, R.id.iv_bg_white_select);
+ //put函数是将指定值和指定键相连
}
private static final Map sFontSizeBtnsMap = new HashMap();
@@ -108,6 +96,7 @@ public class NoteEditActivity extends Activity implements OnClickListener,
sFontSizeBtnsMap.put(R.id.ll_font_small, ResourceParser.TEXT_SMALL);
sFontSizeBtnsMap.put(R.id.ll_font_normal, ResourceParser.TEXT_MEDIUM);
sFontSizeBtnsMap.put(R.id.ll_font_super, ResourceParser.TEXT_SUPER);
+ //put函数是将指定值和指定键相连
}
private static final Map sFontSelectorSelectionMap = new HashMap();
@@ -116,6 +105,7 @@ public class NoteEditActivity extends Activity implements OnClickListener,
sFontSelectorSelectionMap.put(ResourceParser.TEXT_SMALL, R.id.iv_small_select);
sFontSelectorSelectionMap.put(ResourceParser.TEXT_MEDIUM, R.id.iv_medium_select);
sFontSelectorSelectionMap.put(ResourceParser.TEXT_SUPER, R.id.iv_super_select);
+ //put函数是将指定值和指定键相连
}
private static final String TAG = "NoteEditActivity";
@@ -123,20 +113,23 @@ public class NoteEditActivity extends Activity implements OnClickListener,
private HeadViewHolder mNoteHeaderHolder;
private View mHeadViewPanel;
-
+ //私有化一个界面操作mHeadViewPanel，对表头的操作
private View mNoteBgColorSelector;
-
+ //私有化一个界面操作mNoteBgColorSelector，对背景颜色的操作
private View mFontSizeSelector;
-
+ //私有化一个界面操作mFontSizeSelector，对标签字体的操作
private EditText mNoteEditor;
-
+ //声明编辑控件，对文本操作
private View mNoteEditorPanel;
-
- private WorkingNote mWorkingNote;
-
+ //私有化一个界面操作mNoteEditorPanel，文本编辑的控制板
+ //private WorkingNote mWorkingNote;
+ public WorkingNote mWorkingNote;
+ //对模板WorkingNote的初始化
private SharedPreferences mSharedPrefs;
+ //私有化SharedPreferences的数据存储方式
+ //它的本质是基于XML文件存储key-value键值对数据
private int mFontSizeId;
-
+ //用于操作字体的大小
private static final String PREFERENCE_FONT_SIZE = "pref_font_size";
private static final int SHORTCUT_ICON_TITLE_MAX_LEN = 10;
@@ -145,7 +138,7 @@ public class NoteEditActivity extends Activity implements OnClickListener,
public static final String TAG_UNCHECKED = String.valueOf('\u25A1');
private LinearLayout mEditTextList;
-
+ //线性布局
private String mUserQuery;
private Pattern mPattern;
@@ -153,7 +146,7 @@ public class NoteEditActivity extends Activity implements OnClickListener,
protected void onCreate(Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
this.setContentView(R.layout.note_edit);
-
+ //对数据库的访问操作
if (savedInstanceState == null && !initActivityState(getIntent())) {
finish();
return;
@@ -176,7 +169,7 @@ public class NoteEditActivity extends Activity implements OnClickListener,
return;
}
Log.d(TAG, "Restoring from killed activity");
- }
+ }//为防止内存不足时程序的终止，在这里有一个保存现场的函数
}
private boolean initActivityState(Intent intent) {
@@ -188,34 +181,42 @@ public class NoteEditActivity extends Activity implements OnClickListener,
if (TextUtils.equals(Intent.ACTION_VIEW, intent.getAction())) {
long noteId = intent.getLongExtra(Intent.EXTRA_UID, 0);
mUserQuery = "";
-
+ //如果用户实例化标签时，系统并未给出标签ID
/**
* 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);
}
-
+ //如果ID在数据库中未找到
if (!DataUtils.visibleInNoteDatabase(getContentResolver(), noteId, Notes.TYPE_NOTE)) {
Intent jump = new Intent(this, NotesListActivity.class);
startActivity(jump);
+ //程序将跳转到上面声明的intent——jump
showToast(R.string.error_note_not_exist);
finish();
return false;
- } else {
+ }
+ //ID在数据库中找到
+ else {
mWorkingNote = WorkingNote.load(this, noteId);
if (mWorkingNote == null) {
Log.e(TAG, "load note failed with note id" + noteId);
+ //打印出红色的错误信息
finish();
return false;
}
}
+ //setSoftInputMode——软键盘输入模式
getWindow().setSoftInputMode(
WindowManager.LayoutParams.SOFT_INPUT_STATE_HIDDEN
| WindowManager.LayoutParams.SOFT_INPUT_ADJUST_RESIZE);
} else if(TextUtils.equals(Intent.ACTION_INSERT_OR_EDIT, intent.getAction())) {
- // New note
+ // intent.getAction()
+ // 大多用于broadcast发送广播时给机制（intent）设置一个action，就是一个字符串
+ // 用户可以通过receive（接受）intent，通过 getAction得到的字符串，来决定做什么
long folderId = intent.getLongExtra(Notes.INTENT_EXTRA_FOLDER_ID, 0);
int widgetId = intent.getIntExtra(Notes.INTENT_EXTRA_WIDGET_ID,
AppWidgetManager.INVALID_APPWIDGET_ID);
@@ -223,7 +224,7 @@ public class NoteEditActivity extends Activity implements OnClickListener,
Notes.TYPE_WIDGET_INVALIDE);
int bgResId = intent.getIntExtra(Notes.INTENT_EXTRA_BACKGROUND_ID,
ResourceParser.getDefaultBgId(this));
-
+ // intent.getInt（Long、String）Extra是对各变量的语法分析
// Parse call-record note
String phoneNumber = intent.getStringExtra(Intent.EXTRA_PHONE_NUMBER);
long callDate = intent.getLongExtra(Notes.INTENT_EXTRA_CALL_DATE, 0);
@@ -240,15 +241,17 @@ public class NoteEditActivity extends Activity implements OnClickListener,
finish();
return false;
}
+ //将电话号码与手机的号码簿相关
} else {
mWorkingNote = WorkingNote.createEmptyNote(this, folderId, widgetId,
widgetType, bgResId);
mWorkingNote.convertToCallNote(phoneNumber, callDate);
+ //
}
} else {
mWorkingNote = WorkingNote.createEmptyNote(this, folderId, widgetId, widgetType,
bgResId);
- }
+ }//创建一个新的WorkingNote
getWindow().setSoftInputMode(
WindowManager.LayoutParams.SOFT_INPUT_ADJUST_RESIZE
@@ -269,8 +272,10 @@ public class NoteEditActivity extends Activity implements OnClickListener,
}
private void initNoteScreen() {
+ //对界面的初始化操作
mNoteEditor.setTextAppearance(this, TextAppearanceResources
.getTexAppearanceResource(mFontSizeId));
+ //设置外观
if (mWorkingNote.getCheckListMode() == TextNote.MODE_CHECK_LIST) {
switchToListMode(mWorkingNote.getContent());
} else {
@@ -294,18 +299,21 @@ 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 {
+ }
+ //如果系统时间大于了闹钟设置的时间，那么闹钟失效
+ 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);
@@ -329,26 +337,29 @@ public class NoteEditActivity extends Activity implements OnClickListener,
if (!mWorkingNote.existInDatabase()) {
saveNote();
}
+ //在创建一个新的标签时，先在数据库中匹配
+ //如果不存在，那么先在数据库中存储
outState.putLong(Intent.EXTRA_UID, mWorkingNote.getNoteId());
Log.d(TAG, "Save working note id: " + mWorkingNote.getNoteId() + " onSaveInstanceState");
}
@Override
+ //MotionEvent是对屏幕触控的传递机制
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);
@@ -357,9 +368,11 @@ public class NoteEditActivity extends Activity implements OnClickListener,
if (ev.getX() < x
|| ev.getX() > (x + view.getWidth())
|| ev.getY() < y
- || ev.getY() > (y + view.getHeight())) {
- return false;
- }
+ || ev.getY() > (y + view.getHeight()))
+ //如果触控的位置超出了给定的范围，返回false
+ {
+ return false;
+ }
return true;
}
@@ -377,13 +390,13 @@ public class NoteEditActivity extends Activity implements OnClickListener,
for (int id : sBgSelectorBtnsMap.keySet()) {
ImageView iv = (ImageView) findViewById(id);
iv.setOnClickListener(this);
- }
+ }//对标签各项属性内容的初始化
mFontSizeSelector = findViewById(R.id.font_size_selector);
for (int id : sFontSizeBtnsMap.keySet()) {
View view = findViewById(id);
view.setOnClickListener(this);
- };
+ };//对字体大小的选择
mSharedPrefs = PreferenceManager.getDefaultSharedPreferences(this);
mFontSizeId = mSharedPrefs.getInt(PREFERENCE_FONT_SIZE, ResourceParser.BG_DEFAULT_FONT_SIZE);
/**
@@ -405,7 +418,7 @@ public class NoteEditActivity extends Activity implements OnClickListener,
}
clearSettingState();
}
-
+ //和桌面小工具的同步
private void updateWidget() {
Intent intent = new Intent(AppWidgetManager.ACTION_APPWIDGET_UPDATE);
if (mWorkingNote.getWidgetType() == Notes.TYPE_WIDGET_2X) {
@@ -418,7 +431,7 @@ public class NoteEditActivity extends Activity implements OnClickListener,
}
intent.putExtra(AppWidgetManager.EXTRA_APPWIDGET_IDS, new int[] {
- mWorkingNote.getWidgetId()
+ mWorkingNote.getWidgetId()
});
sendBroadcast(intent);
@@ -450,7 +463,7 @@ public class NoteEditActivity extends Activity implements OnClickListener,
}
mFontSizeSelector.setVisibility(View.GONE);
}
- }
+ }//************************存在问题
@Override
public void onBackPressed() {
@@ -481,6 +494,7 @@ public class NoteEditActivity extends Activity implements OnClickListener,
}
@Override
+ //对选择菜单的准备
public boolean onPrepareOptionsMenu(Menu menu) {
if (isFinishing()) {
return true;
@@ -489,6 +503,7 @@ public class NoteEditActivity extends Activity implements OnClickListener,
menu.clear();
if (mWorkingNote.getFolderId() == Notes.ID_CALL_RECORD_FOLDER) {
getMenuInflater().inflate(R.menu.call_note_edit, menu);
+ // MenuInflater是用来实例化Menu目录下的Menu布局文件的
} else {
getMenuInflater().inflate(R.menu.note_edit, menu);
}
@@ -506,45 +521,71 @@ public class NoteEditActivity extends Activity implements OnClickListener,
}
@Override
+ /*
+ * 函数功能：动态改变菜单选项内容
+ * 函数实现：如下注释
+ */
public boolean onOptionsItemSelected(MenuItem item) {
switch (item.getItemId()) {
+ //根据菜单的id来编剧相关项目
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));
+ // 设置标签的标题为alert_title_delete
builder.setIcon(android.R.drawable.ic_dialog_alert);
+ //设置对话框图标
builder.setMessage(getString(R.string.alert_message_delete_note));
+ //设置对话框内容
builder.setPositiveButton(android.R.string.ok,
new DialogInterface.OnClickListener() {
+ //建立按键监听器
public void onClick(DialogInterface dialog, int which) {
+ //点击所触发事件
deleteCurrentNote();
+ // 删除单签便签
finish();
}
});
+ //添加“YES”按钮
builder.setNegativeButton(android.R.string.cancel, null);
+ //添加“NO”的按钮
builder.show();
+ //显示对话框
break;
case R.id.menu_font_size:
+ //字体大小的编辑
mFontSizeSelector.setVisibility(View.VISIBLE);
+ // 将字体选择器置为可见
findViewById(sFontSelectorSelectionMap.get(mFontSizeId)).setVisibility(View.VISIBLE);
+ // 通过id找到相应的大小
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());
+ // 用sendto函数将运行文本发送到遍历的本文内
break;
case R.id.menu_send_to_desktop:
+ //发送到桌面
sendToDesktop();
break;
case R.id.menu_alert:
+ //创建提醒器
setReminder();
break;
case R.id.menu_delete_remind:
+ //删除日期提醒
mWorkingNote.setAlertDate(0, false);
break;
default:
@@ -553,111 +594,170 @@ 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();
+ //显示对话框
}
/**
* 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链接选项
intent.putExtra(Intent.EXTRA_TEXT, info);
+ //将需要传递的便签信息放入text文件中
intent.setType("text/plain");
+ //编辑连接器的类型
context.startActivity(intent);
+ //在acti中进行链接
}
+ /*
+ * 函数功能：创建一个新的便签
+ * 函数实现：如下注释
+ */
private void createNewNote() {
// Firstly, save current editing notes
+ //保存当前便签
saveNote();
// For safety, start a new NoteEditActivity
finish();
Intent intent = new Intent(this, NoteEditActivity.class);
+ //设置链接器
intent.setAction(Intent.ACTION_INSERT_OR_EDIT);
+ //该活动定义为创建或编辑
intent.putExtra(Notes.INTENT_EXTRA_FOLDER_ID, mWorkingNote.getFolderId());
+ //将运行便签的id添加到INTENT_EXTRA_FOLDER_ID标记中
startActivity(intent);
+ //开始activity并链接
}
+ /*
+ * 函数功能：删除当前便签
+ * 函数实现：如下注释
+ */
private void deleteCurrentNote() {
if (mWorkingNote.existInDatabase()) {
+ //假如当前运行的便签内存有数据
HashSet ids = new HashSet();
long id = mWorkingNote.getNoteId();
if (id != Notes.ID_ROOT_FOLDER) {
ids.add(id);
+ //如果不是头文件夹建立一个hash表把便签id存起来
} else {
Log.d(TAG, "Wrong note id, should not happen");
+ //否则报错
}
if (!isSyncMode()) {
+ //在非同步模式情况下
+ //删除操作
if (!DataUtils.batchDeleteNotes(getContentResolver(), ids)) {
Log.e(TAG, "Delete Note error");
}
} else {
+ //同步模式
+ //移动至垃圾文件夹的操作
if (!DataUtils.batchMoveToFolder(getContentResolver(), ids, Notes.ID_TRASH_FOLER)) {
Log.e(TAG, "Move notes to trash folder error, should not happens");
}
}
}
mWorkingNote.markDeleted(true);
+ //将这些标签的删除标记置为true
}
+ /*
+ * 函数功能：判断是否为同步模式
+ * 函数实现：直接看NotesPreferenceActivity中同步名称是否为空
+ */
private boolean isSyncMode() {
return NotesPreferenceActivity.getSyncAccountName(this).trim().length() > 0;
}
+ /*
+ * 函数功能：设置提醒时间
+ * 函数实现：如下注释
+ */
public void onClockAlertChanged(long date, boolean set) {
/**
* User could set clock to an unsaved note, so before setting the
* alert clock, we should save the note first
*/
if (!mWorkingNote.existInDatabase()) {
+ //首先保存已有的便签
saveNote();
}
if (mWorkingNote.getNoteId() > 0) {
Intent intent = new Intent(this, AlarmReceiver.class);
intent.setData(ContentUris.withAppendedId(Notes.CONTENT_NOTE_URI, mWorkingNote.getNoteId()));
+ //若有有运行的便签就是建立一个链接器将标签id都存在uri中
PendingIntent pendingIntent = PendingIntent.getBroadcast(this, 0, intent, 0);
AlarmManager alarmManager = ((AlarmManager) getSystemService(ALARM_SERVICE));
+ //设置提醒管理器
showAlertHeader();
if(!set) {
alarmManager.cancel(pendingIntent);
} else {
alarmManager.set(AlarmManager.RTC_WAKEUP, date, pendingIntent);
}
+ //如果用户设置了时间，就通过提醒管理器设置一个监听事项
} else {
/**
* There is the condition that user has input nothing (the note is
* not worthy saving), we have no note id, remind the user that he
* should input something
*/
+ //没有运行的便签就报错
Log.e(TAG, "Clock alert setting error");
showToast(R.string.error_note_empty_for_clock);
}
}
+ /*
+ * 函数功能：Widget发生改变的所触发的事件
+ */
public void onWidgetChanged() {
- updateWidget();
+ updateWidget();//更新Widget
}
+ /*
+ * 函数功能： 删除编辑文本框所触发的事件
+ * 函数实现：如下注释
+ */
public void onEditTextDelete(int index, String text) {
int childCount = mEditTextList.getChildCount();
if (childCount == 1) {
return;
}
-
+ //没有编辑框的话直接返回
for (int i = index + 1; i < childCount; i++) {
((NoteEditText) mEditTextList.getChildAt(i).findViewById(R.id.et_edit_text))
.setIndex(i - 1);
+ //通过id把编辑框存在便签编辑框中
}
mEditTextList.removeViewAt(index);
+ //删除特定位置的视图
NoteEditText edit = null;
if(index == 0) {
edit = (NoteEditText) mEditTextList.getChildAt(0).findViewById(
@@ -666,69 +766,101 @@ public class NoteEditActivity extends Activity implements OnClickListener,
edit = (NoteEditText) mEditTextList.getChildAt(index - 1).findViewById(
R.id.et_edit_text);
}
+ //通过id把编辑框存在空的NoteEditText中
int length = edit.length();
edit.append(text);
- edit.requestFocus();
- edit.setSelection(length);
+ edit.requestFocus();//请求优先完成该此 编辑
+ edit.setSelection(length);//定位到length位置处的条目
}
+ /*
+ * 函数功能：进入编辑文本框所触发的事件
+ * 函数实现：如下注释
+ */
public void onEditTextEnter(int index, String text) {
/**
* Should not happen, check for debug
*/
if(index > mEditTextList.getChildCount()) {
Log.e(TAG, "Index out of mEditTextList boundrary, should not happen");
+ //越界把偶偶
}
View view = getListItem(text, index);
mEditTextList.addView(view, index);
+ //建立一个新的视图并添加到编辑文本框内
NoteEditText edit = (NoteEditText) view.findViewById(R.id.et_edit_text);
- edit.requestFocus();
- edit.setSelection(0);
+ edit.requestFocus();//请求优先操作
+ edit.setSelection(0);//定位到起始位置
for (int i = index + 1; i < mEditTextList.getChildCount(); i++) {
((NoteEditText) mEditTextList.getChildAt(i).findViewById(R.id.et_edit_text))
.setIndex(i);
+ //遍历子文本框并设置对应对下标
}
}
+ /*
+ * 函数功能：切换至列表模式
+ * 函数实现：如下注释
+ */
private void switchToListMode(String text) {
mEditTextList.removeAllViews();
String[] items = text.split("\n");
int index = 0;
+ //清空所有视图，初始化下标
for (String item : items) {
if(!TextUtils.isEmpty(item)) {
mEditTextList.addView(getListItem(item, index));
index++;
+ //遍历所有文本单元并添加到文本框中
}
}
mEditTextList.addView(getListItem("", index));
mEditTextList.getChildAt(index).findViewById(R.id.et_edit_text).requestFocus();
+ //优先请求此操作
mNoteEditor.setVisibility(View.GONE);
+ //便签编辑器不可见
mEditTextList.setVisibility(View.VISIBLE);
+ //将文本编辑框置为可见
}
+ /*
+ * 函数功能：获取高亮效果的反馈情况
+ * 函数实现：如下注释
+ */
private Spannable getHighlightQueryResult(String fullText, String userQuery) {
SpannableString spannable = new SpannableString(fullText == null ? "" : fullText);
+ //新建一个效果选项
if (!TextUtils.isEmpty(userQuery)) {
mPattern = Pattern.compile(userQuery);
+ //将用户的询问进行解析
Matcher m = mPattern.matcher(fullText);
+ //建立一个状态机检查Pattern并进行匹配
int start = 0;
while (m.find(start)) {
spannable.setSpan(
new BackgroundColorSpan(this.getResources().getColor(
R.color.user_query_highlight)), m.start(), m.end(),
Spannable.SPAN_INCLUSIVE_EXCLUSIVE);
+ //设置背景颜色
start = m.end();
+ //跟新起始位置
}
}
return spannable;
}
+ /*
+ * 函数功能：获取列表项
+ * 函数实现：如下注释
+ */
private View getListItem(String item, int index) {
View view = LayoutInflater.from(this).inflate(R.layout.note_edit_list_item, null);
+ //创建一个视图
final NoteEditText edit = (NoteEditText) view.findViewById(R.id.et_edit_text);
edit.setTextAppearance(this, TextAppearanceResources.getTexAppearanceResource(mFontSizeId));
+ //创建一个文本编辑框并设置可见性
CheckBox cb = ((CheckBox) view.findViewById(R.id.cb_edit_item));
cb.setOnCheckedChangeListener(new OnCheckedChangeListener() {
public void onCheckedChanged(CompoundButton buttonView, boolean isChecked) {
@@ -739,12 +871,15 @@ public class NoteEditActivity extends Activity implements OnClickListener,
}
}
});
+ //建立一个打钩框并设置监听器
if (item.startsWith(TAG_CHECKED)) {
+ //选择勾选
cb.setChecked(true);
edit.setPaintFlags(edit.getPaintFlags() | Paint.STRIKE_THRU_TEXT_FLAG);
item = item.substring(TAG_CHECKED.length(), item.length()).trim();
} else if (item.startsWith(TAG_UNCHECKED)) {
+ //选择不勾选
cb.setChecked(false);
edit.setPaintFlags(Paint.ANTI_ALIAS_FLAG | Paint.DEV_KERN_TEXT_FLAG);
item = item.substring(TAG_UNCHECKED.length(), item.length()).trim();
@@ -753,61 +888,94 @@ public class NoteEditActivity extends Activity implements OnClickListener,
edit.setOnTextViewChangeListener(this);
edit.setIndex(index);
edit.setText(getHighlightQueryResult(item, mUserQuery));
+ //运行编辑框的监听器对该行为作出反应，并设置下标及文本内容
return view;
}
+ /*
+ * 函数功能：便签内容发生改变所 触发的事件
+ * 函数实现：如下注释
+ */
public void onTextChange(int index, boolean hasText) {
if (index >= mEditTextList.getChildCount()) {
Log.e(TAG, "Wrong index, should not happen");
return;
+ //越界报错
}
if(hasText) {
mEditTextList.getChildAt(index).findViewById(R.id.cb_edit_item).setVisibility(View.VISIBLE);
} else {
mEditTextList.getChildAt(index).findViewById(R.id.cb_edit_item).setVisibility(View.GONE);
}
+ //如果内容不为空则将其子编辑框可见性置为可见，否则不可见
}
+ /*
+ * 函数功能：检查模式和列表模式的切换
+ * 函数实现：如下注释
+ */
public void onCheckListModeChanged(int oldMode, int newMode) {
if (newMode == TextNote.MODE_CHECK_LIST) {
switchToListMode(mNoteEditor.getText().toString());
+ //检查模式切换到列表模式
} else {
if (!getWorkingText()) {
mWorkingNote.setWorkingText(mWorkingNote.getContent().replace(TAG_UNCHECKED + " ",
""));
}
+ //若是获取到文本就改变其检查标记
mNoteEditor.setText(getHighlightQueryResult(mWorkingNote.getContent(), mUserQuery));
mEditTextList.setVisibility(View.GONE);
mNoteEditor.setVisibility(View.VISIBLE);
+ //修改文本编辑器的内容和可见性
}
}
+ /*
+ * 函数功能：设置勾选选项表并返回是否勾选的标记
+ * 函数实现：如下注释
+ */
private boolean getWorkingText() {
boolean hasChecked = false;
+ //初始化check标记
if (mWorkingNote.getCheckListMode() == TextNote.MODE_CHECK_LIST) {
+ // 若模式为CHECK_LIST
StringBuilder sb = new StringBuilder();
+ //创建可变字符串
for (int i = 0; i < mEditTextList.getChildCount(); i++) {
View view = mEditTextList.getChildAt(i);
+ //遍历所有子编辑框的视图
NoteEditText edit = (NoteEditText) view.findViewById(R.id.et_edit_text);
if (!TextUtils.isEmpty(edit.getText())) {
+ //若文本不为空
if (((CheckBox) view.findViewById(R.id.cb_edit_item)).isChecked()) {
+ //该选项框已打钩
sb.append(TAG_CHECKED).append(" ").append(edit.getText()).append("\n");
hasChecked = true;
+ //扩展字符串为已打钩并把标记置true
} else {
sb.append(TAG_UNCHECKED).append(" ").append(edit.getText()).append("\n");
+ //扩展字符串添加未打钩
}
}
}
mWorkingNote.setWorkingText(sb.toString());
+ //利用编辑好的字符串设置运行便签的内容
} else {
mWorkingNote.setWorkingText(mNoteEditor.getText().toString());
+ // 若不是该模式直接用编辑器中的内容设置运行中标签的内容
}
return hasChecked;
}
+ /*
+ * 函数功能：保存便签
+ * 函数实现：如下注释
+ */
private boolean saveNote() {
getWorkingText();
boolean saved = mWorkingNote.saveNote();
+ //运行 getWorkingText()之后保存
if (saved) {
/**
* There are two modes from List view to edit view, open one note,
@@ -816,11 +984,16 @@ public class NoteEditActivity extends Activity implements OnClickListener,
* new node requires to the top of the list. This code
* {@link #RESULT_OK} is used to identify the create/edit state
*/
+ //如英文注释所说链接RESULT_OK是为了识别保存的2种情况，一是创建后保存，二是修改后保存
setResult(RESULT_OK);
}
return saved;
}
+ /*
+ * 函数功能：将便签发送至桌面
+ * 函数实现：如下注释
+ */
private void sendToDesktop() {
/**
* Before send message to home, we should make sure that current
@@ -829,12 +1002,16 @@ public class NoteEditActivity extends Activity implements OnClickListener,
*/
if (!mWorkingNote.existInDatabase()) {
saveNote();
+ //若不存在数据也就是新的标签就保存起来先
}
if (mWorkingNote.getNoteId() > 0) {
+ //若是有内容
Intent sender = new Intent();
Intent shortcutIntent = new Intent(this, NoteEditActivity.class);
+ //建立发送到桌面的连接器
shortcutIntent.setAction(Intent.ACTION_VIEW);
+ //链接为一个视图
shortcutIntent.putExtra(Intent.EXTRA_UID, mWorkingNote.getNoteId());
sender.putExtra(Intent.EXTRA_SHORTCUT_INTENT, shortcutIntent);
sender.putExtra(Intent.EXTRA_SHORTCUT_NAME,
@@ -842,9 +1019,12 @@ public class NoteEditActivity extends Activity implements OnClickListener,
sender.putExtra(Intent.EXTRA_SHORTCUT_ICON_RESOURCE,
Intent.ShortcutIconResource.fromContext(this, R.drawable.icon_app));
sender.putExtra("duplicate", true);
+ //将便签的相关信息都添加到要发送的文件里
sender.setAction("com.android.launcher.action.INSTALL_SHORTCUT");
+ //设置sneder的行为是发送
showToast(R.string.info_note_enter_desktop);
sendBroadcast(sender);
+ //显示到桌面
} else {
/**
* There is the condition that user has input nothing (the note is
@@ -853,21 +1033,35 @@ public class NoteEditActivity extends Activity implements OnClickListener,
*/
Log.e(TAG, "Send to desktop error");
showToast(R.string.error_note_empty_for_send_to_desktop);
+ //空便签直接报错
}
}
+ /*
+ * 函数功能：编辑小图标的标题
+ * 函数实现：如下注释
+ */
private String makeShortcutIconTitle(String content) {
content = content.replace(TAG_CHECKED, "");
content = content.replace(TAG_UNCHECKED, "");
return content.length() > SHORTCUT_ICON_TITLE_MAX_LEN ? content.substring(0,
SHORTCUT_ICON_TITLE_MAX_LEN) : content;
+ //直接设置为content中的内容并返回，有勾选和未勾选2种
}
+ /*
+ * 函数功能：显示提示的视图
+ * 函数实现：根据下标显示对应的提示
+ */
private void showToast(int resId) {
showToast(resId, Toast.LENGTH_SHORT);
}
+ /*
+ * 函数功能：持续显示提示的视图
+ * 函数实现：根据下标和持续的时间（duration）编辑提示视图并显示
+ */
private void showToast(int resId, int duration) {
Toast.makeText(this, resId, duration).show();
}
-}
+}
\ No newline at end of file
diff --git a/src/main/java/net/micode/notes/ui/NoteEditText.java b/src/main/java/net/micode/notes/ui/NoteEditText.java
index 2afe2a8..f658bd6 100644
--- a/src/main/java/net/micode/notes/ui/NoteEditText.java
+++ b/src/main/java/net/micode/notes/ui/NoteEditText.java
@@ -1,19 +1,3 @@
-/*
- * Copyright (c) 2010-2011, The MiCode Open Source Community (www.micode.net)
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-
package net.micode.notes.ui;
import android.content.Context;
@@ -37,6 +21,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 +31,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,17 +42,20 @@ 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
* and the text is null
*/
+ //处理删除按键时的操作
void onEditTextDelete(int index, String text);
/**
* Add edit text after current edit text when {@link KeyEvent#KEYCODE_ENTER}
* happen
*/
+ //处理进入按键时的操作
void onEditTextEnter(int index, String text);
/**
@@ -77,33 +66,43 @@ public class NoteEditText extends EditText {
private OnTextViewChangeListener mOnTextViewChangeListener;
+ //根据context设置文本
public NoteEditText(Context context) {
- super(context, null);
+ super(context, null);//用super引用父类变量
mIndex = 0;
}
+ //设置当前光标
public void setIndex(int index) {
mIndex = index;
}
+ //初始化文本修改标记
public void setOnTextViewChangeListener(OnTextViewChangeListener listener) {
mOnTextViewChangeListener = listener;
}
- public NoteEditText(Context context, AttributeSet attrs) {
+ //AttributeSet 百度了一下是自定义空控件属性，用于维护便签动态变化的属性
+ //初始化便签
+ public NoteEditText(Context context, AttributeSet attrs) {
super(context, attrs, android.R.attr.editTextStyle);
}
+ // 根据defstyle自动初始化
public NoteEditText(Context context, AttributeSet attrs, int defStyle) {
super(context, attrs, defStyle);
- // TODO Auto-generated constructor stub
+ // TODO Auto-generated construct or stub
}
@Override
+ //view里的函数，处理手机屏幕的所有事件
+ /*参数event为手机屏幕触摸事件封装类的对象，其中封装了该事件的所有信息，
+ 例如触摸的位置、触摸的类型以及触摸的时间等。该对象会在用户触摸手机屏幕时被创建。*/
public boolean onTouchEvent(MotionEvent event) {
switch (event.getAction()) {
+ //重写了需要处理屏幕被按下的事件
case MotionEvent.ACTION_DOWN:
-
+ //跟新当前坐标值
int x = (int) event.getX();
int y = (int) event.getY();
x -= getTotalPaddingLeft();
@@ -111,9 +110,12 @@ public class NoteEditText extends EditText {
x += getScrollX();
y += getScrollY();
+ //用布局控件layout根据x,y的新值设置新的位置
Layout layout = getLayout();
int line = layout.getLineForVertical(y);
int off = layout.getOffsetForHorizontal(line, x);
+
+ //更新光标新的位置
Selection.setSelection(getText(), off);
break;
}
@@ -122,96 +124,147 @@ public class NoteEditText extends EditText {
}
@Override
+ /*
+ * 函数功能：处理用户按下一个键盘按键时会触发 的事件
+ * 实现过程：如下注释
+ */
public boolean onKeyDown(int keyCode, KeyEvent event) {
switch (keyCode) {
+ //根据按键的 Unicode 编码值来处理
case KeyEvent.KEYCODE_ENTER:
+ //“进入”按键
if (mOnTextViewChangeListener != null) {
return false;
}
break;
case KeyEvent.KEYCODE_DEL:
+ //“删除”按键
mSelectionStartBeforeDelete = getSelectionStart();
break;
default:
break;
}
+ //继续执行父类的其他点击事件
return super.onKeyDown(keyCode, event);
}
@Override
+ /*
+ * 函数功能：处理用户松开一个键盘按键时会触发 的事件
+ * 实现方式：如下注释
+ */
public boolean onKeyUp(int keyCode, KeyEvent event) {
switch(keyCode) {
+ //根据按键的 Unicode 编码值来处理，有删除和进入2种操作
case KeyEvent.KEYCODE_DEL:
if (mOnTextViewChangeListener != null) {
+ //若是被修改过
if (0 == mSelectionStartBeforeDelete && mIndex != 0) {
+ //若之前有被修改并且文档不为空
mOnTextViewChangeListener.onEditTextDelete(mIndex, getText().toString());
+ //利用上文OnTextViewChangeListener对KEYCODE_DEL按键情况的删除函数进行删除
return true;
}
} else {
Log.d(TAG, "OnTextViewChangeListener was not seted");
+ //其他情况报错，文档的改动监听器并没有建立
}
break;
case KeyEvent.KEYCODE_ENTER:
+ //同上也是分为监听器是否建立2种情况
if (mOnTextViewChangeListener != null) {
int selectionStart = getSelectionStart();
+ //获取当前位置
String text = getText().subSequence(selectionStart, length()).toString();
+ //获取当前文本
setText(getText().subSequence(0, selectionStart));
+ //根据获取的文本设置当前文本
mOnTextViewChangeListener.onEditTextEnter(mIndex + 1, text);
+ //当{@link KeyEvent#KEYCODE_ENTER}添加新文本
} else {
Log.d(TAG, "OnTextViewChangeListener was not seted");
+ //其他情况报错，文档的改动监听器并没有建立
}
break;
default:
break;
}
+ //继续执行父类的其他按键弹起的事件
return super.onKeyUp(keyCode, event);
}
@Override
+ /*
+ * 函数功能：当焦点发生变化时，会自动调用该方法来处理焦点改变的事件
+ * 实现方式：如下注释
+ * 参数：focused表示触发该事件的View是否获得了焦点，当该控件获得焦点时，Focused等于true，否则等于false。
+ direction表示焦点移动的方向，用数值表示
+ Rect：表示在触发事件的View的坐标系中，前一个获得焦点的矩形区域，即表示焦点是从哪里来的。如果不可用则为null
+ */
protected void onFocusChanged(boolean focused, int direction, Rect previouslyFocusedRect) {
if (mOnTextViewChangeListener != null) {
+ //若监听器已经建立
if (!focused && TextUtils.isEmpty(getText())) {
+ //获取到焦点并且文本不为空
mOnTextViewChangeListener.onTextChange(mIndex, false);
+ //mOnTextViewChangeListener子函数，置false隐藏事件选项
} else {
mOnTextViewChangeListener.onTextChange(mIndex, true);
+ //mOnTextViewChangeListener子函数，置true显示事件选项
}
}
+ //继续执行父类的其他焦点变化的事件
super.onFocusChanged(focused, direction, previouslyFocusedRect);
}
@Override
+ /*
+ * 函数功能：生成上下文菜单
+ * 函数实现：如下注释
+ */
protected void onCreateContextMenu(ContextMenu menu) {
if (getText() instanceof Spanned) {
+ //有文本存在
int selStart = getSelectionStart();
int selEnd = getSelectionEnd();
+ //获取文本开始和结尾位置
int min = Math.min(selStart, selEnd);
int max = Math.max(selStart, selEnd);
+ //获取开始到结尾的最大值和最小值
final URLSpan[] urls = ((Spanned) getText()).getSpans(min, max, URLSpan.class);
+ //设置url的信息的范围值
if (urls.length == 1) {
int defaultResId = 0;
for(String schema: sSchemaActionResMap.keySet()) {
+ //获取计划表中所有的key值
if(urls[0].getURL().indexOf(schema) >= 0) {
+ //若url可以添加则在添加后将defaultResId置为key所映射的值
defaultResId = sSchemaActionResMap.get(schema);
break;
}
}
if (defaultResId == 0) {
+ //defaultResId == 0则说明url并没有添加任何东西，所以置为连接其他SchemaActionResMap的值
defaultResId = R.string.note_link_other;
}
+ //建立菜单
menu.add(0, 0, 0, defaultResId).setOnMenuItemClickListener(
new OnMenuItemClickListener() {
+ //新建按键监听器
public boolean onMenuItemClick(MenuItem item) {
// goto a new intent
urls[0].onClick(NoteEditText.this);
+ //根据相应的文本设置菜单的按键
return true;
}
});
}
}
+ //继续执行父类的其他菜单创建的事件
super.onCreateContextMenu(menu);
}
-}
+}
\ No newline at end of file
diff --git a/src/main/java/net/micode/notes/ui/NoteItemData.java b/src/main/java/net/micode/notes/ui/NoteItemData.java
index 0f5a878..9dde13c 100644
--- a/src/main/java/net/micode/notes/ui/NoteItemData.java
+++ b/src/main/java/net/micode/notes/ui/NoteItemData.java
@@ -1,19 +1,3 @@
-/*
- * Copyright (c) 2010-2011, The MiCode Open Source Community (www.micode.net)
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-
package net.micode.notes.ui;
import android.content.Context;
@@ -28,20 +12,20 @@ import net.micode.notes.tool.DataUtils;
public class NoteItemData {
static final String [] PROJECTION = new String [] {
- NoteColumns.ID,
- NoteColumns.ALERTED_DATE,
- NoteColumns.BG_COLOR_ID,
- NoteColumns.CREATED_DATE,
- NoteColumns.HAS_ATTACHMENT,
- NoteColumns.MODIFIED_DATE,
- NoteColumns.NOTES_COUNT,
- NoteColumns.PARENT_ID,
- NoteColumns.SNIPPET,
- NoteColumns.TYPE,
- NoteColumns.WIDGET_ID,
- NoteColumns.WIDGET_TYPE,
+ NoteColumns.ID,
+ NoteColumns.ALERTED_DATE,
+ NoteColumns.BG_COLOR_ID,
+ NoteColumns.CREATED_DATE,
+ NoteColumns.HAS_ATTACHMENT,
+ NoteColumns.MODIFIED_DATE,
+ NoteColumns.NOTES_COUNT,
+ NoteColumns.PARENT_ID,
+ NoteColumns.SNIPPET,
+ NoteColumns.TYPE,
+ NoteColumns.WIDGET_ID,
+ NoteColumns.WIDGET_TYPE,
};
-
+ //常量标记和数据就不一一标记了，意义翻译基本就知道
private static final int ID_COLUMN = 0;
private static final int ALERTED_DATE_COLUMN = 1;
private static final int BG_COLOR_ID_COLUMN = 2;
@@ -75,8 +59,9 @@ public class NoteItemData {
private boolean mIsOnlyOneItem;
private boolean mIsOneNoteFollowingFolder;
private boolean mIsMultiNotesFollowingFolder;
-
- public NoteItemData(Context context, Cursor cursor) {
+ //初始化NoteItemData，主要利用光标cursor获取的东西
+ public NoteItemData(Context context, Cursor cursor) {
+ //getxxx为转换格式
mId = cursor.getLong(ID_COLUMN);
mAlertDate = cursor.getLong(ALERTED_DATE_COLUMN);
mBgColorId = cursor.getInt(BG_COLOR_ID_COLUMN);
@@ -92,10 +77,11 @@ public class NoteItemData {
mWidgetId = cursor.getInt(WIDGET_ID_COLUMN);
mWidgetType = cursor.getInt(WIDGET_TYPE_COLUMN);
+ //初始化电话号码的信息
mPhoneNumber = "";
if (mParentId == Notes.ID_CALL_RECORD_FOLDER) {
mPhoneNumber = DataUtils.getCallNumberByNoteId(context.getContentResolver(), mId);
- if (!TextUtils.isEmpty(mPhoneNumber)) {
+ if (!TextUtils.isEmpty(mPhoneNumber)) {//mphonenumber里有符合字符串，则用contart功能连接
mName = Contact.getContact(context, mPhoneNumber);
if (mName == null) {
mName = mPhoneNumber;
@@ -108,32 +94,35 @@ public class NoteItemData {
}
checkPostion(cursor);
}
-
+ ///根据鼠标的位置设置标记，和位置
private void checkPostion(Cursor cursor) {
+ //初始化几个标记，cursor具体功能笔记中已提到，不一一叙述
mIsLastItem = cursor.isLast() ? true : false;
mIsFirstItem = cursor.isFirst() ? true : false;
mIsOnlyOneItem = (cursor.getCount() == 1);
+ //初始化“多重子文件”“单一子文件”2个标记
mIsMultiNotesFollowingFolder = false;
mIsOneNoteFollowingFolder = false;
- if (mType == Notes.TYPE_NOTE && !mIsFirstItem) {
+ //主要是设置上诉2标记
+ if (mType == Notes.TYPE_NOTE && !mIsFirstItem) {//若是note格式并且不是第一个元素
int position = cursor.getPosition();
- if (cursor.moveToPrevious()) {
+ if (cursor.moveToPrevious()) {//获取光标位置后看上一行
if (cursor.getInt(TYPE_COLUMN) == Notes.TYPE_FOLDER
- || cursor.getInt(TYPE_COLUMN) == Notes.TYPE_SYSTEM) {
+ || cursor.getInt(TYPE_COLUMN) == Notes.TYPE_SYSTEM) {//若光标满足系统或note格式
if (cursor.getCount() > (position + 1)) {
- mIsMultiNotesFollowingFolder = true;
+ mIsMultiNotesFollowingFolder = true;//若是数据行数大于但前位置+1则设置成正确
} else {
- mIsOneNoteFollowingFolder = true;
+ mIsOneNoteFollowingFolder = true;//否则单一文件夹标记为true
}
}
- if (!cursor.moveToNext()) {
+ if (!cursor.moveToNext()) {//若不能再往下走则报错
throw new IllegalStateException("cursor move to previous but can't move back");
}
}
}
}
-
+ ///以下都是获取标记没什么好说的，不过倒数第二个需要说明下，很具体看下面
public boolean isOneFollowingFolder() {
return mIsOneNoteFollowingFolder;
}
@@ -214,6 +203,7 @@ public class NoteItemData {
return (mAlertDate > 0);
}
+ //若数据父id为保存至文件夹模式的id且满足电话号码单元不为空，则isCallRecord为true
public boolean isCallRecord() {
return (mParentId == Notes.ID_CALL_RECORD_FOLDER && !TextUtils.isEmpty(mPhoneNumber));
}
@@ -221,4 +211,4 @@ public class NoteItemData {
public static int getNoteType(Cursor cursor) {
return cursor.getInt(TYPE_COLUMN);
}
-}
+}
\ No newline at end of file
diff --git a/src/main/java/net/micode/notes/ui/NotesListActivity.java b/src/main/java/net/micode/notes/ui/NotesListActivity.java
index e843aec..0813597 100644
--- a/src/main/java/net/micode/notes/ui/NotesListActivity.java
+++ b/src/main/java/net/micode/notes/ui/NotesListActivity.java
@@ -1,19 +1,3 @@
-/*
- * Copyright (c) 2010-2011, The MiCode Open Source Community (www.micode.net)
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-
package net.micode.notes.ui;
import android.app.Activity;
@@ -77,8 +61,12 @@ import java.io.IOException;
import java.io.InputStream;
import java.io.InputStreamReader;
import java.util.HashSet;
-
-public class NotesListActivity extends Activity implements OnClickListener, OnItemLongClickListener {
+//主界面，一进入就是这个界面
+/**
+ * @author k
+ *
+ */
+public class NotesListActivity extends Activity implements OnClickListener, OnItemLongClickListener { //没有用特定的标签加注释。。。感觉没有什么用
private static final int FOLDER_NOTE_LIST_QUERY_TOKEN = 0;
private static final int FOLDER_LIST_QUERY_TOKEN = 1;
@@ -89,7 +77,7 @@ public class NotesListActivity extends Activity implements OnClickListener, OnIt
private static final int MENU_FOLDER_CHANGE_NAME = 2;
- private static final String PREFERENCE_ADD_INTRODUCTION = "net.micode.notes.introduction";
+ private static final String PREFERENCE_ADD_INTRODUCTION = "net.micode.notes.introduction"; //单行超过80个字符
private enum ListEditState {
NOTE_LIST, SUB_FOLDER, CALL_RECORD_FOLDER
@@ -136,8 +124,13 @@ public class NotesListActivity extends Activity implements OnClickListener, OnIt
private final static int REQUEST_CODE_NEW_NODE = 103;
@Override
- protected void onCreate(Bundle savedInstanceState) {
- super.onCreate(savedInstanceState);
+ // 创建类
+ protected void onCreate(final Bundle savedInstanceState) { //需要是final类型 根据程序上下文环境，Java关键字final有“这是无法改变的”或者“终态的”含义，它可以修饰非抽象类、非抽象类成员方法和变量。你可能出于两种理解而需要阻止改变：设计或效率。
+ // final类不能被继承，没有子类，final类中的方法默认是final的。
+ //final方法不能被子类的方法覆盖，但可以被继承。
+ //final成员变量表示常量，只能被赋值一次，赋值后值不再改变。
+ //final不能用于修饰构造方法。
+ super.onCreate(savedInstanceState); // 调用父类的onCreate函数
setContentView(R.layout.note_list);
initResources();
@@ -148,26 +141,32 @@ public class NotesListActivity extends Activity implements OnClickListener, OnIt
}
@Override
+ // 返回一些子模块完成的数据交给主Activity处理
protected void onActivityResult(int requestCode, int resultCode, Intent data) {
+ // 结果值 和 要求值 符合要求
if (resultCode == RESULT_OK
&& (requestCode == REQUEST_CODE_OPEN_NODE || requestCode == REQUEST_CODE_NEW_NODE)) {
mNotesListAdapter.changeCursor(null);
} else {
super.onActivityResult(requestCode, resultCode, data);
+ // 调用 Activity 的onActivityResult（）
}
}
private void setAppInfoFromRawRes() {
+ // Android平台给我们提供了一个SharedPreferences类，它是一个轻量级的存储类，特别适合用于保存软件配置参数。
SharedPreferences sp = PreferenceManager.getDefaultSharedPreferences(this);
if (!sp.getBoolean(PREFERENCE_ADD_INTRODUCTION, false)) {
StringBuilder sb = new StringBuilder();
InputStream in = null;
try {
- in = getResources().openRawResource(R.raw.introduction);
+ // 把资源文件放到应用程序的/raw/raw下，那么就可以在应用中使用getResources获取资源后,
+ // 以openRawResource方法（不带后缀的资源文件名）打开这个文件。
+ in = getResources().openRawResource(R.raw.introduction);
if (in != null) {
InputStreamReader isr = new InputStreamReader(in);
BufferedReader br = new BufferedReader(isr);
- char [] buf = new char[1024];
+ char [] buf = new char[1024]; // 自行定义的数值，使用者不知道有什么意义
int len = 0;
while ((len = br.read(buf)) > 0) {
sb.append(buf, 0, len);
@@ -180,7 +179,7 @@ public class NotesListActivity extends Activity implements OnClickListener, OnIt
e.printStackTrace();
return;
} finally {
- if(in != null) {
+ if (in != null) {
try {
in.close();
} catch (IOException e) {
@@ -190,11 +189,13 @@ public class NotesListActivity extends Activity implements OnClickListener, OnIt
}
}
+ // 创建空的WorkingNote
WorkingNote note = WorkingNote.createEmptyNote(this, Notes.ID_ROOT_FOLDER,
AppWidgetManager.INVALID_APPWIDGET_ID, Notes.TYPE_WIDGET_INVALIDE,
ResourceParser.RED);
note.setWorkingText(sb.toString());
if (note.saveNote()) {
+ // 更新保存note的信息
sp.edit().putBoolean(PREFERENCE_ADD_INTRODUCTION, true).commit();
} else {
Log.e(TAG, "Save introduction note error");
@@ -209,18 +210,21 @@ public class NotesListActivity extends Activity implements OnClickListener, OnIt
startAsyncNotesListQuery();
}
+ // 初始化资源
private void initResources() {
- mContentResolver = this.getContentResolver();
+ mContentResolver = this.getContentResolver(); // 获取应用程序的数据，得到类似数据表的东西
mBackgroundQueryHandler = new BackgroundQueryHandler(this.getContentResolver());
mCurrentFolderId = Notes.ID_ROOT_FOLDER;
- mNotesListView = (ListView) findViewById(R.id.notes_list);
+
+ // findViewById 是安卓编程的定位函数，主要是引用.R文件里的引用名
+ mNotesListView = (ListView) findViewById(R.id.notes_list); // 绑定XML中的ListView，作为Item的容器
mNotesListView.addFooterView(LayoutInflater.from(this).inflate(R.layout.note_list_footer, null),
null, false);
mNotesListView.setOnItemClickListener(new OnListItemClickListener());
mNotesListView.setOnItemLongClickListener(this);
mNotesListAdapter = new NotesListAdapter(this);
mNotesListView.setAdapter(mNotesListAdapter);
- mAddNewNote = (Button) findViewById(R.id.btn_new_note);
+ mAddNewNote = (Button) findViewById(R.id.btn_new_note);// 在activity中要获取该按钮
mAddNewNote.setOnClickListener(this);
mAddNewNote.setOnTouchListener(new NewNoteOnTouchListener());
mDispatch = false;
@@ -231,6 +235,7 @@ public class NotesListActivity extends Activity implements OnClickListener, OnIt
mModeCallBack = new ModeCallback();
}
+ // 继承自ListView.MultiChoiceModeListener 和 OnMenuItemClickListener
private class ModeCallback implements ListView.MultiChoiceModeListener, OnMenuItemClickListener {
private DropdownMenu mDropDownMenu;
private ActionMode mActionMode;
@@ -259,7 +264,7 @@ public class NotesListActivity extends Activity implements OnClickListener, OnIt
(Button) customView.findViewById(R.id.selection_menu),
R.menu.note_list_dropdown);
mDropDownMenu.setOnDropdownMenuItemClickListener(new PopupMenu.OnMenuItemClickListener(){
- public boolean onMenuItemClick(MenuItem item) {
+ public boolean onMenuItemClick(final MenuItem item) {
mNotesListAdapter.selectAll(!mNotesListAdapter.isAllSelected());
updateMenu();
return true;
@@ -269,11 +274,12 @@ public class NotesListActivity extends Activity implements OnClickListener, OnIt
return true;
}
+ // 更新菜单
private void updateMenu() {
int selectedCount = mNotesListAdapter.getSelectedCount();
// Update dropdown menu
String format = getResources().getString(R.string.menu_select_title, selectedCount);
- mDropDownMenu.setTitle(format);
+ mDropDownMenu.setTitle(format); // 更改标题
MenuItem item = mDropDownMenu.findItem(R.id.action_select_all);
if (item != null) {
if (mNotesListAdapter.isAllSelected()) {
@@ -307,7 +313,7 @@ public class NotesListActivity extends Activity implements OnClickListener, OnIt
}
public void onItemCheckedStateChanged(ActionMode mode, int position, long id,
- boolean checked) {
+ boolean checked) {
mNotesListAdapter.setCheckedItem(position, checked);
updateMenu();
}
@@ -325,14 +331,14 @@ public class NotesListActivity extends Activity implements OnClickListener, OnIt
builder.setTitle(getString(R.string.alert_title_delete));
builder.setIcon(android.R.drawable.ic_dialog_alert);
builder.setMessage(getString(R.string.alert_message_delete_notes,
- mNotesListAdapter.getSelectedCount()));
+ mNotesListAdapter.getSelectedCount()));
builder.setPositiveButton(android.R.string.ok,
- new DialogInterface.OnClickListener() {
- public void onClick(DialogInterface dialog,
- int which) {
- batchDelete();
- }
- });
+ new DialogInterface.OnClickListener() {
+ public void onClick(DialogInterface dialog,
+ int which) {
+ batchDelete();
+ }
+ });
builder.setNegativeButton(android.R.string.cancel, null);
builder.show();
break;
@@ -366,7 +372,7 @@ public class NotesListActivity extends Activity implements OnClickListener, OnIt
/**
* HACKME:When click the transparent part of "New Note" button, dispatch
* the event to the list view behind this button. The transparent part of
- * "New Note" button could be expressed by formula y=-0.12x+94（Unit:pixel）
+ * "New Note" button could be expressed by formula y=-0.12x+94锛圲nit:pixel锛�
* and the line top of the button. The coordinate based on left of the "New
* Note" button. The 94 represents maximum height of the transparent part.
* Notice that, if the background of the button changes, the formula should
@@ -413,7 +419,7 @@ public class NotesListActivity extends Activity implements OnClickListener, OnIt
: NORMAL_SELECTION;
mBackgroundQueryHandler.startQuery(FOLDER_NOTE_LIST_QUERY_TOKEN, null,
Notes.CONTENT_NOTE_URI, NoteItemData.PROJECTION, selection, new String[] {
- String.valueOf(mCurrentFolderId)
+ String.valueOf(mCurrentFolderId)
}, NoteColumns.TYPE + " DESC," + NoteColumns.MODIFIED_DATE + " DESC");
}
@@ -624,7 +630,7 @@ public class NotesListActivity extends Activity implements OnClickListener, OnIt
values.put(NoteColumns.LOCAL_MODIFIED, 1);
mContentResolver.update(Notes.CONTENT_NOTE_URI, values, NoteColumns.ID
+ "=?", new String[] {
- String.valueOf(mFocusNoteDataItem.getId())
+ String.valueOf(mFocusNoteDataItem.getId())
});
}
} else if (!TextUtils.isEmpty(name)) {
@@ -664,30 +670,38 @@ public class NotesListActivity extends Activity implements OnClickListener, OnIt
});
}
+ /* (non-Javadoc)
+ * @see android.app.Activity#onBackPressed()
+ * 按返回键时根据情况更改类中的数据
+ */
@Override
- public void onBackPressed() {
- switch (mState) {
- case SUB_FOLDER:
- mCurrentFolderId = Notes.ID_ROOT_FOLDER;
- mState = ListEditState.NOTE_LIST;
- startAsyncNotesListQuery();
- mTitleBar.setVisibility(View.GONE);
- break;
- case CALL_RECORD_FOLDER:
- mCurrentFolderId = Notes.ID_ROOT_FOLDER;
- mState = ListEditState.NOTE_LIST;
- mAddNewNote.setVisibility(View.VISIBLE);
- mTitleBar.setVisibility(View.GONE);
- startAsyncNotesListQuery();
- break;
- case NOTE_LIST:
- super.onBackPressed();
- break;
- default:
- break;
- }
+ public void onBackPressed() { switch (mState) {
+ case SUB_FOLDER:
+ mCurrentFolderId = Notes.ID_ROOT_FOLDER;
+ mState = ListEditState.NOTE_LIST;
+ startAsyncNotesListQuery();
+ mTitleBar.setVisibility(View.GONE);
+ break;
+ case CALL_RECORD_FOLDER:
+ mCurrentFolderId = Notes.ID_ROOT_FOLDER;
+ mState = ListEditState.NOTE_LIST;
+ mAddNewNote.setVisibility(View.VISIBLE);
+ mTitleBar.setVisibility(View.GONE);
+ startAsyncNotesListQuery();
+ break;
+ case NOTE_LIST:
+ super.onBackPressed();
+ break;
+ default:
+ break;
+ }
}
+ /**
+ * @param appWidgetId
+ * @param appWidgetType
+ * 根据不同类型的widget更新插件，通过intent传送数据
+ */
private void updateWidget(int appWidgetId, int appWidgetType) {
Intent intent = new Intent(AppWidgetManager.ACTION_APPWIDGET_UPDATE);
if (appWidgetType == Notes.TYPE_WIDGET_2X) {
@@ -700,13 +714,16 @@ public class NotesListActivity extends Activity implements OnClickListener, OnIt
}
intent.putExtra(AppWidgetManager.EXTRA_APPWIDGET_IDS, new int[] {
- appWidgetId
+ appWidgetId
});
sendBroadcast(intent);
setResult(RESULT_OK, intent);
}
+ /**
+ * 声明监听器，建立菜单，包括名称，视图，删除操作，更改名称操作；
+ */
private final OnCreateContextMenuListener mFolderOnCreateContextMenuListener = new OnCreateContextMenuListener() {
public void onCreateContextMenu(ContextMenu menu, View v, ContextMenuInfo menuInfo) {
if (mFocusNoteDataItem != null) {
@@ -726,6 +743,10 @@ public class NotesListActivity extends Activity implements OnClickListener, OnIt
super.onContextMenuClosed(menu);
}
+ /* (non-Javadoc)
+ * @see android.app.Activity#onContextItemSelected(android.view.MenuItem)
+ * 针对menu中不同的选择进行不同的处理，里面详细注释
+ */
@Override
public boolean onContextItemSelected(MenuItem item) {
if (mFocusNoteDataItem == null) {
@@ -734,10 +755,10 @@ public class NotesListActivity extends Activity implements OnClickListener, OnIt
}
switch (item.getItemId()) {
case MENU_FOLDER_VIEW:
- openFolder(mFocusNoteDataItem);
+ openFolder(mFocusNoteDataItem);//打开对应文件
break;
case MENU_FOLDER_DELETE:
- AlertDialog.Builder builder = new AlertDialog.Builder(this);
+ AlertDialog.Builder builder = new AlertDialog.Builder(this);//设置确认是否删除的对话框
builder.setTitle(getString(R.string.alert_title_delete));
builder.setIcon(android.R.drawable.ic_dialog_alert);
builder.setMessage(getString(R.string.alert_message_delete_folder));
@@ -748,7 +769,7 @@ public class NotesListActivity extends Activity implements OnClickListener, OnIt
}
});
builder.setNegativeButton(android.R.string.cancel, null);
- builder.show();
+ builder.show();//显示对话框
break;
case MENU_FOLDER_CHANGE_NAME:
showCreateOrModifyFolderDialog(false);
@@ -818,12 +839,19 @@ public class NotesListActivity extends Activity implements OnClickListener, OnIt
return true;
}
+ /* (non-Javadoc)
+ * @see android.app.Activity#onSearchRequested()
+ * 直接调用startSearch函数
+ */
@Override
public boolean onSearchRequested() {
startSearch(null, false, null /* appData */, false);
return true;
}
+ /**
+ * 函数功能：实现将便签导出到文本功能
+ */
private void exportNoteToText() {
final BackupUtils backup = BackupUtils.getInstance(NotesListActivity.this);
new AsyncTask() {
@@ -866,16 +894,27 @@ public class NotesListActivity extends Activity implements OnClickListener, OnIt
}.execute();
}
+ /**
+ * @return
+ * 功能：判断是否正在同步
+ */
private boolean isSyncMode() {
return NotesPreferenceActivity.getSyncAccountName(this).trim().length() > 0;
}
+ /**
+ * 功能：跳转到PreferenceActivity界面
+ */
private void startPreferenceActivity() {
Activity from = getParent() != null ? getParent() : this;
Intent intent = new Intent(from, NotesPreferenceActivity.class);
from.startActivityIfNeeded(intent, -1);
}
+ /**
+ * @author k
+ * 函数功能：实现对便签列表项的点击事件（短按）
+ */
private class OnListItemClickListener implements OnItemClickListener {
public void onItemClick(AdapterView parent, View view, int position, long id) {
@@ -917,10 +956,13 @@ public class NotesListActivity extends Activity implements OnClickListener, OnIt
}
+ /**
+ * 查询目标文件
+ */
private void startQueryDestinationFolders() {
String selection = NoteColumns.TYPE + "=? AND " + NoteColumns.PARENT_ID + "<>? AND " + NoteColumns.ID + "<>?";
selection = (mState == ListEditState.NOTE_LIST) ? selection:
- "(" + selection + ") OR (" + NoteColumns.ID + "=" + Notes.ID_ROOT_FOLDER + ")";
+ "(" + selection + ") OR (" + NoteColumns.ID + "=" + Notes.ID_ROOT_FOLDER + ")";
mBackgroundQueryHandler.startQuery(FOLDER_LIST_QUERY_TOKEN,
null,
@@ -935,6 +977,12 @@ public class NotesListActivity extends Activity implements OnClickListener, OnIt
NoteColumns.MODIFIED_DATE + " DESC");
}
+ /* (non-Javadoc)
+ * @see android.widget.AdapterView.OnItemLongClickListener#onItemLongClick(android.widget.AdapterView, android.view.View, int, long)
+ * 长按某一项时进行的操作
+ * 如果长按的是便签，则通过ActionMode菜单实现；如果长按的是文件夹，则通过ContextMenu菜单实现；
+ * 具体ActionMOde菜单和ContextMenu菜单的详细见精度笔记
+ */
public boolean onItemLongClick(AdapterView parent, View view, int position, long id) {
if (view instanceof NotesListItem) {
mFocusNoteDataItem = ((NotesListItem) view).getItemData();
@@ -951,4 +999,4 @@ public class NotesListActivity extends Activity implements OnClickListener, OnIt
}
return false;
}
-}
+}
\ No newline at end of file
diff --git a/src/main/java/net/micode/notes/ui/NotesListAdapter.java b/src/main/java/net/micode/notes/ui/NotesListAdapter.java
index 51c9cb9..b165769 100644
--- a/src/main/java/net/micode/notes/ui/NotesListAdapter.java
+++ b/src/main/java/net/micode/notes/ui/NotesListAdapter.java
@@ -1,19 +1,3 @@
-/*
- * Copyright (c) 2010-2011, The MiCode Open Source Community (www.micode.net)
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-
package net.micode.notes.ui;
import android.content.Context;
@@ -23,6 +7,7 @@ import android.view.View;
import android.view.ViewGroup;
import android.widget.CursorAdapter;
+
import net.micode.notes.data.Notes;
import java.util.Collection;
@@ -31,55 +16,94 @@ import java.util.HashSet;
import java.util.Iterator;
+/*
+ * 功能：直译为便签表连接器，继承了CursorAdapter，它为cursor和ListView提供了连接的桥梁。
+ * 所以NotesListAdapter实现的是鼠标和编辑便签链接的桥梁
+ */
public class NotesListAdapter extends CursorAdapter {
private static final String TAG = "NotesListAdapter";
private Context mContext;
private HashMap mSelectedIndex;
- private int mNotesCount;
- private boolean mChoiceMode;
+ private int mNotesCount; //便签数
+ private boolean mChoiceMode; //选择模式标记
+ /*
+ * 桌面widget的属性，包括编号和类型
+ */
public static class AppWidgetAttribute {
public int widgetId;
public int widgetType;
};
+ /*
+ * 函数功能：初始化便签链接器
+ * 函数实现：根据传进来的内容设置相关变量
+ */
public NotesListAdapter(Context context) {
- super(context, null);
- mSelectedIndex = new HashMap();
+ super(context, null); //父类对象置空
+ mSelectedIndex = new HashMap(); //新建选项下标的hash表
mContext = context;
mNotesCount = 0;
}
@Override
+ /*
+ * 函数功能：新建一个视图来存储光标所指向的数据
+ * 函数实现：使用兄弟类NotesListItem新建一个项目选项
+ */
public View newView(Context context, Cursor cursor, ViewGroup parent) {
return new NotesListItem(context);
}
+ /*
+ * 函数功能：将已经存在的视图和鼠标指向的数据进行捆绑
+ * 函数实现：如下注释
+ */
@Override
public void bindView(View view, Context context, Cursor cursor) {
if (view instanceof NotesListItem) {
+ //若view是NotesListItem的一个实例
NoteItemData itemData = new NoteItemData(context, cursor);
((NotesListItem) view).bind(context, itemData, mChoiceMode,
isSelectedItem(cursor.getPosition()));
+ //则新建一个项目选项并且用bind跟将view和鼠标，内容，便签数据捆绑在一起
}
}
+ /*
+ * 函数功能：设置勾选框
+ * 函数实现：如下注释
+ */
public void setCheckedItem(final int position, final boolean checked) {
mSelectedIndex.put(position, checked);
+ //根据定位和是否勾选设置下标
notifyDataSetChanged();
+ //在修改后刷新activity
}
+ /*
+ * 函数功能：判断单选按钮是否勾选
+ */
public boolean isInChoiceMode() {
return mChoiceMode;
}
+ /*
+ * 函数功能：设置单项选项框
+ * 函数实现：重置下标并且根据参数mode设置选项
+ */
public void setChoiceMode(boolean mode) {
mSelectedIndex.clear();
mChoiceMode = mode;
}
+ /*
+ * 函数功能：选择全部选项
+ * 函数实现：如下注释
+ */
public void selectAll(boolean checked) {
Cursor cursor = getCursor();
+ //获取光标位置
for (int i = 0; i < getCount(); i++) {
if (cursor.moveToPosition(i)) {
if (NoteItemData.getNoteType(cursor) == Notes.TYPE_NOTE) {
@@ -87,30 +111,47 @@ public class NotesListAdapter extends CursorAdapter {
}
}
}
+ //遍历所有光标可用的位置在判断为便签类型之后勾选单项框
}
+ /*
+ * 函数功能：建立选择项的下标列表
+ * 函数实现：如下注释
+ */
public HashSet getSelectedItemIds() {
HashSet itemSet = new HashSet();
+ //建立hash表
for (Integer position : mSelectedIndex.keySet()) {
+ //遍历所有的关键
if (mSelectedIndex.get(position) == true) {
+ //若光标位置可用
Long id = getItemId(position);
if (id == Notes.ID_ROOT_FOLDER) {
+ //原文件不需要添加
Log.d(TAG, "Wrong item id, should not happen");
} else {
itemSet.add(id);
}
+ //则将id该下标假如选项集合中
+
}
}
return itemSet;
}
+ /*
+ * 函数功能：建立桌面Widget的选项表
+ * 函数实现：如下注释
+ */
public HashSet getSelectedWidget() {
HashSet itemSet = new HashSet();
for (Integer position : mSelectedIndex.keySet()) {
if (mSelectedIndex.get(position) == true) {
Cursor c = (Cursor) getItem(position);
+ //以上4句和getSelectedItemIds一样，不再重复
if (c != null) {
+ //光标位置可用的话就建立新的Widget属性并编辑下标和类型，最后添加到选项集中
AppWidgetAttribute widget = new AppWidgetAttribute();
NoteItemData item = new NoteItemData(mContext, c);
widget.widgetId = item.getWidgetId();
@@ -128,26 +169,42 @@ public class NotesListAdapter extends CursorAdapter {
return itemSet;
}
+ /*
+ * 函数功能：获取选项个数
+ * 函数实现：如下注释
+ */
public int getSelectedCount() {
Collection values = mSelectedIndex.values();
+ //首先获取选项下标的值
if (null == values) {
return 0;
}
Iterator iter = values.iterator();
+ //初始化叠加器
int count = 0;
while (iter.hasNext()) {
if (true == iter.next()) {
+ //若value值为真计数+1
count++;
}
}
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;
@@ -156,29 +213,45 @@ public class NotesListAdapter extends CursorAdapter {
}
@Override
+ /*
+ * 函数功能：在activity内容发生局部变动的时候回调该函数计算便签的数量
+ * 函数实现：如下注释
+ */
protected void onContentChanged() {
super.onContentChanged();
+ //执行基类函数
calcNotesCount();
}
@Override
+ /*
+ * 函数功能：在activity光标发生局部变动的时候回调该函数计算便签的数量
+ */
public void changeCursor(Cursor cursor) {
super.changeCursor(cursor);
+ //执行基类函数
calcNotesCount();
}
+ /*
+ * 函数功能：计算便签数量
+ *
+ */
private void calcNotesCount() {
mNotesCount = 0;
for (int i = 0; i < getCount(); i++) {
+ //获取总数同时遍历
Cursor c = (Cursor) getItem(i);
if (c != null) {
if (NoteItemData.getNoteType(c) == Notes.TYPE_NOTE) {
mNotesCount++;
+ //若该位置不为空并且文本类型为便签就+1
}
} else {
Log.e(TAG, "Invalid cursor");
return;
}
+ //否则报错
}
}
-}
+}
\ No newline at end of file
diff --git a/src/main/java/net/micode/notes/ui/NotesListItem.java b/src/main/java/net/micode/notes/ui/NotesListItem.java
index 1221e80..fa8b3d2 100644
--- a/src/main/java/net/micode/notes/ui/NotesListItem.java
+++ b/src/main/java/net/micode/notes/ui/NotesListItem.java
@@ -1,19 +1,3 @@
-/*
- * Copyright (c) 2010-2011, The MiCode Open Source Community (www.micode.net)
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-
package net.micode.notes.ui;
import android.content.Context;
@@ -30,37 +14,43 @@ import net.micode.notes.tool.DataUtils;
import net.micode.notes.tool.ResourceParser.NoteItemBgResources;
+//创建便签列表项目选项
public class NotesListItem extends LinearLayout {
- private ImageView mAlert;
- private TextView mTitle;
- private TextView mTime;
- private TextView mCallName;
- private NoteItemData mItemData;
- private CheckBox mCheckBox;
+ private ImageView mAlert;//闹钟图片
+ private TextView mTitle; //标题
+ private TextView mTime; //时间
+ private TextView mCallName; //
+ private NoteItemData mItemData; //标签数据
+ private CheckBox mCheckBox; //打钩框
+ /*初始化基本信息*/
public NotesListItem(Context context) {
- super(context);
- inflate(context, R.layout.note_item, this);
+ super(context); //super()它的主要作用是调整调用父类构造函数的顺序
+ inflate(context, R.layout.note_item, this);//Inflate可用于将一个xml中定义的布局控件找出来,这里的xml是r。layout
+ //findViewById用于从contentView中查找指定ID的View，转换出来的形式根据需要而定;
mAlert = (ImageView) findViewById(R.id.iv_alert_icon);
mTitle = (TextView) findViewById(R.id.tv_title);
mTime = (TextView) findViewById(R.id.tv_time);
mCallName = (TextView) findViewById(R.id.tv_name);
mCheckBox = (CheckBox) findViewById(android.R.id.checkbox);
}
-
+ ///根据data的属性对各个控件的属性的控制，主要是可见性Visibility，内容setText，格式setTextAppearance
public void bind(Context context, NoteItemData data, boolean choiceMode, boolean checked) {
if (choiceMode && data.getType() == Notes.TYPE_NOTE) {
- mCheckBox.setVisibility(View.VISIBLE);
- mCheckBox.setChecked(checked);
+ mCheckBox.setVisibility(View.VISIBLE); ///设置可见行为可见
+ mCheckBox.setChecked(checked); ///格子打钩
} else {
mCheckBox.setVisibility(View.GONE);
}
mItemData = data;
+ ///设置控件属性，一共三种情况，由data的id和父id是否与保存到文件夹的id一致来决定
if (data.getId() == Notes.ID_CALL_RECORD_FOLDER) {
mCallName.setVisibility(View.GONE);
mAlert.setVisibility(View.VISIBLE);
+ //设置该textview的style
mTitle.setTextAppearance(context, R.style.TextAppearancePrimaryItem);
+ //settext为设置内容
mTitle.setText(context.getString(R.string.call_record_folder_name)
+ context.getString(R.string.format_folder_files_count, data.getNotesCount()));
mAlert.setImageResource(R.drawable.call_record);
@@ -69,8 +59,9 @@ public class NotesListItem extends LinearLayout {
mCallName.setText(data.getCallName());
mTitle.setTextAppearance(context,R.style.TextAppearanceSecondaryItem);
mTitle.setText(DataUtils.getFormattedSnippet(data.getSnippet()));
+ ///关于闹钟的设置
if (data.hasAlert()) {
- mAlert.setImageResource(R.drawable.clock);
+ mAlert.setImageResource(R.drawable.clock);//图片来源的设置
mAlert.setVisibility(View.VISIBLE);
} else {
mAlert.setVisibility(View.GONE);
@@ -78,45 +69,48 @@ public class NotesListItem extends LinearLayout {
} else {
mCallName.setVisibility(View.GONE);
mTitle.setTextAppearance(context, R.style.TextAppearancePrimaryItem);
-
+ ///设置title格式
if (data.getType() == Notes.TYPE_FOLDER) {
mTitle.setText(data.getSnippet()
+ context.getString(R.string.format_folder_files_count,
- data.getNotesCount()));
+ data.getNotesCount()));
mAlert.setVisibility(View.GONE);
} else {
mTitle.setText(DataUtils.getFormattedSnippet(data.getSnippet()));
if (data.hasAlert()) {
- mAlert.setImageResource(R.drawable.clock);
+ mAlert.setImageResource(R.drawable.clock);///设置图片来源
mAlert.setVisibility(View.VISIBLE);
} else {
mAlert.setVisibility(View.GONE);
}
}
}
- mTime.setText(DateUtils.getRelativeTimeSpanString(data.getModifiedDate()));
+ ///设置内容，获取相关时间，从data里编辑的日期中获取
+ mTime. setText(DateUtils.getRelativeTimeSpanString(data.getModifiedDate()));
setBackground(data);
}
-
+ //根据data的文件属性来设置背景
private void setBackground(NoteItemData data) {
int id = data.getBgColorId();
+ //，若是note型文件，则4种情况，对于4种不同情况的背景来源
if (data.getType() == Notes.TYPE_NOTE) {
+ //单个数据并且只有一个子文件夹
if (data.isSingle() || data.isOneFollowingFolder()) {
setBackgroundResource(NoteItemBgResources.getNoteBgSingleRes(id));
- } else if (data.isLast()) {
+ } else if (data.isLast()) {//是最后一个数据
setBackgroundResource(NoteItemBgResources.getNoteBgLastRes(id));
- } else if (data.isFirst() || data.isMultiFollowingFolder()) {
+ } else if (data.isFirst() || data.isMultiFollowingFolder()) {//是一个数据并有多个子文件夹
setBackgroundResource(NoteItemBgResources.getNoteBgFirstRes(id));
} else {
setBackgroundResource(NoteItemBgResources.getNoteBgNormalRes(id));
}
} else {
+ //若不是note直接调用文件夹的背景来源
setBackgroundResource(NoteItemBgResources.getFolderBgRes());
}
}
-
public NoteItemData getItemData() {
return mItemData;
}
-}
+}
\ No newline at end of file
diff --git a/src/main/java/net/micode/notes/ui/NotesPreferenceActivity.java b/src/main/java/net/micode/notes/ui/NotesPreferenceActivity.java
index 07c5f7e..6f8a89f 100644
--- a/src/main/java/net/micode/notes/ui/NotesPreferenceActivity.java
+++ b/src/main/java/net/micode/notes/ui/NotesPreferenceActivity.java
@@ -1,19 +1,3 @@
-/*
- * Copyright (c) 2010-2011, The MiCode Open Source Community (www.micode.net)
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-
package net.micode.notes.ui;
import android.accounts.Account;
@@ -47,66 +31,92 @@ import net.micode.notes.data.Notes;
import net.micode.notes.data.Notes.NoteColumns;
import net.micode.notes.gtask.remote.GTaskSyncService;
-
+/*
+ *该类功能：NotesPreferenceActivity，在小米便签中主要实现的是对背景颜色和字体大小的数据储存。
+ * 继承了PreferenceActivity主要功能为对系统信息和配置进行自动保存的Activity
+ */
public class NotesPreferenceActivity extends PreferenceActivity {
public static final String PREFERENCE_NAME = "notes_preferences";
-
+ //优先名
public static final String PREFERENCE_SYNC_ACCOUNT_NAME = "pref_key_account_name";
-
+ //同步账号
public static final String PREFERENCE_LAST_SYNC_TIME = "pref_last_sync_time";
-
+ //同步时间
public static final String PREFERENCE_SET_BG_COLOR_KEY = "pref_key_bg_random_appear";
private static final String PREFERENCE_SYNC_ACCOUNT_KEY = "pref_sync_account_key";
-
+ //同步密码
private static final String AUTHORITIES_FILTER_KEY = "authorities";
-
+ //本地密码
private PreferenceCategory mAccountCategory;
-
+ //账户分组
private GTaskReceiver mReceiver;
-
+ //同步任务接收器
private Account[] mOriAccounts;
-
+ //账户
private boolean mHasAddedAccount;
+ //账户的hash标记
@Override
+ /*
+ *函数功能：创建一个activity，在函数里要完成所有的正常静态设置
+ *参数：Bundle icicle：存放了 activity 当前的状态
+ *函数实现：如下注释
+ */
protected void onCreate(Bundle icicle) {
+ //先执行父类的创建函数
super.onCreate(icicle);
/* using the app icon for navigation */
getActionBar().setDisplayHomeAsUpEnabled(true);
+ //给左上角图标的左边加上一个返回的图标
addPreferencesFromResource(R.xml.preferences);
+ //添加xml来源并显示 xml
mAccountCategory = (PreferenceCategory) findPreference(PREFERENCE_SYNC_ACCOUNT_KEY);
+ //根据同步账户关键码来初始化分组
mReceiver = new GTaskReceiver();
IntentFilter filter = new IntentFilter();
filter.addAction(GTaskSyncService.GTASK_SERVICE_BROADCAST_NAME);
registerReceiver(mReceiver, filter);
+ //初始化同步组件
mOriAccounts = null;
View header = LayoutInflater.from(this).inflate(R.layout.settings_header, null);
+ //获取listvivew，ListView的作用:用于列出所有选择
getListView().addHeaderView(header, null, true);
+ //在listview组件上方添加其他组件
}
@Override
+ /*
+ * 函数功能：activity交互功能的实现，用于接受用户的输入
+ * 函数实现：如下注释
+ */
protected void onResume() {
+ //先执行父类 的交互实现
super.onResume();
// need to set sync account automatically if user has added a new
// account
if (mHasAddedAccount) {
+ //若用户新加了账户则自动设置同步账户
Account[] accounts = getGoogleAccounts();
+ //获取google同步账户
if (mOriAccounts != null && accounts.length > mOriAccounts.length) {
+ //若原账户不为空且当前账户有增加
for (Account accountNew : accounts) {
boolean found = false;
for (Account accountOld : mOriAccounts) {
if (TextUtils.equals(accountOld.name, accountNew.name)) {
+ //更新账户
found = true;
break;
}
}
if (!found) {
setSyncAccount(accountNew.name);
+ //若是没有找到旧的账户，那么同步账号中就只添加新账户
break;
}
}
@@ -114,58 +124,83 @@ public class NotesPreferenceActivity extends PreferenceActivity {
}
refreshUI();
+ //刷新标签界面
}
@Override
+ /*
+ * 函数功能：销毁一个activity
+ * 函数实现：如下注释
+ */
protected void onDestroy() {
if (mReceiver != null) {
unregisterReceiver(mReceiver);
+ //注销接收器
}
super.onDestroy();
+ //执行父类的销毁动作
}
+ /*
+ * 函数功能：重新设置账户信息
+ * 函数实现：如下注释
+ */
private void loadAccountPreference() {
mAccountCategory.removeAll();
-
+ //销毁所有的分组
Preference accountPref = new Preference(this);
+ //建立首选项
final String defaultAccount = getSyncAccountName(this);
accountPref.setTitle(getString(R.string.preferences_account_title));
accountPref.setSummary(getString(R.string.preferences_account_summary));
+ //设置首选项的大标题和小标题
accountPref.setOnPreferenceClickListener(new OnPreferenceClickListener() {
public boolean onPreferenceClick(Preference preference) {
+ //建立监听器
if (!GTaskSyncService.isSyncing()) {
if (TextUtils.isEmpty(defaultAccount)) {
// the first time to set account
+ //若是第一次建立账户显示选择账户提示对话框
showSelectAccountAlertDialog();
} else {
// if the account has already been set, we need to promp
// user about the risk
+ //若是已经建立则显示修改对话框并进行修改操作
showChangeAccountConfirmAlertDialog();
}
} else {
+ //若在没有同步的情况下，则在toast中显示不能修改
Toast.makeText(NotesPreferenceActivity.this,
- R.string.preferences_toast_cannot_change_account, Toast.LENGTH_SHORT)
+ R.string.preferences_toast_cannot_change_account, Toast.LENGTH_SHORT)
.show();
}
return true;
}
});
+ //根据新建首选项编辑新的账户分组
mAccountCategory.addPreference(accountPref);
}
+ /*
+ *函数功能：设置按键的状态和最后同步的时间
+ *函数实现：如下注释
+ */
private void loadSyncButton() {
Button syncButton = (Button) findViewById(R.id.preference_sync_button);
TextView lastSyncTimeView = (TextView) findViewById(R.id.prefenerece_sync_status_textview);
-
+ //获取同步按钮控件和最终同步时间的的窗口
// set button state
+ //设置按钮的状态
if (GTaskSyncService.isSyncing()) {
+ //若是在同步状态下
syncButton.setText(getString(R.string.preferences_button_sync_cancel));
syncButton.setOnClickListener(new View.OnClickListener() {
public void onClick(View v) {
GTaskSyncService.cancelSync(NotesPreferenceActivity.this);
}
});
+ //设置按钮显示的文本为“取消同步”以及监听器
} else {
syncButton.setText(getString(R.string.preferences_button_sync_immediately));
syncButton.setOnClickListener(new View.OnClickListener() {
@@ -173,50 +208,67 @@ public class NotesPreferenceActivity extends PreferenceActivity {
GTaskSyncService.startSync(NotesPreferenceActivity.this);
}
});
+ //若是不同步则设置按钮显示的文本为“立即同步”以及对应监听器
}
syncButton.setEnabled(!TextUtils.isEmpty(getSyncAccountName(this)));
+ //设置按键可用还是不可用
// set last sync time
+ // 设置最终同步时间
if (GTaskSyncService.isSyncing()) {
+ //若是在同步的情况下
lastSyncTimeView.setText(GTaskSyncService.getProgressString());
lastSyncTimeView.setVisibility(View.VISIBLE);
+ // 根据当前同步服务器设置时间显示框的文本以及可见性
} else {
+ //若是非同步情况
long lastSyncTime = getLastSyncTime(this);
if (lastSyncTime != 0) {
lastSyncTimeView.setText(getString(R.string.preferences_last_sync_time,
DateFormat.format(getString(R.string.preferences_last_sync_time_format),
lastSyncTime)));
lastSyncTimeView.setVisibility(View.VISIBLE);
+ //则根据最后同步时间的信息来编辑时间显示框的文本内容和可见性
} else {
+ //若时间为空直接设置为不可见状态
lastSyncTimeView.setVisibility(View.GONE);
}
}
}
-
+ /*
+ *函数功能：刷新标签界面
+ *函数实现：调用上文设置账号和设置按键两个函数来实现
+ */
private void refreshUI() {
loadAccountPreference();
loadSyncButton();
}
+ /*
+ * 函数功能：显示账户选择的对话框并进行账户的设置
+ * 函数实现：如下注释
+ */
private void showSelectAccountAlertDialog() {
AlertDialog.Builder dialogBuilder = new AlertDialog.Builder(this);
+ //创建一个新的对话框
View titleView = LayoutInflater.from(this).inflate(R.layout.account_dialog_title, null);
TextView titleTextView = (TextView) titleView.findViewById(R.id.account_dialog_title);
titleTextView.setText(getString(R.string.preferences_dialog_select_account_title));
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);
-
+ //设置对话框的自定义标题，建立一个YES的按钮
Account[] accounts = getGoogleAccounts();
String defAccount = getSyncAccountName(this);
-
+ //获取同步账户信息
mOriAccounts = accounts;
mHasAddedAccount = false;
if (accounts.length > 0) {
+ //若账户不为空
CharSequence[] items = new CharSequence[accounts.length];
final CharSequence[] itemMapping = items;
int checkedItem = -1;
@@ -224,83 +276,119 @@ public class NotesPreferenceActivity extends PreferenceActivity {
for (Account account : accounts) {
if (TextUtils.equals(account.name, defAccount)) {
checkedItem = index;
+ //在账户列表中查询到所需账户
}
items[index++] = account.name;
}
dialogBuilder.setSingleChoiceItems(items, checkedItem,
+ //在对话框建立一个单选的复选框
new DialogInterface.OnClickListener() {
public void onClick(DialogInterface dialog, int which) {
setSyncAccount(itemMapping[which].toString());
dialog.dismiss();
+ //取消对话框
refreshUI();
}
+ //设置点击后执行的事件，包括检录新同步账户和刷新标签界面
});
+ //建立对话框网络版的监听器
}
View addAccountView = LayoutInflater.from(this).inflate(R.layout.add_account_text, null);
dialogBuilder.setView(addAccountView);
+ //给新加账户对话框设置自定义样式
final AlertDialog dialog = dialogBuilder.show();
+ //显示对话框
addAccountView.setOnClickListener(new View.OnClickListener() {
public void onClick(View v) {
mHasAddedAccount = true;
+ //将新加账户的hash置true
Intent intent = new Intent("android.settings.ADD_ACCOUNT_SETTINGS");
+ //建立网络建立组件
intent.putExtra(AUTHORITIES_FILTER_KEY, new String[] {
- "gmail-ls"
+ "gmail-ls"
});
startActivityForResult(intent, -1);
+ //跳回上一个选项
dialog.dismiss();
}
});
+ //建立新加账户对话框的监听器
}
+ /*
+ * 函数功能：显示账户选择对话框和相关账户操作
+ * 函数实现：如下注释
+ */
private void showChangeAccountConfirmAlertDialog() {
AlertDialog.Builder dialogBuilder = new AlertDialog.Builder(this);
-
+ //创建一个新的对话框
View titleView = LayoutInflater.from(this).inflate(R.layout.account_dialog_title, null);
TextView titleTextView = (TextView) titleView.findViewById(R.id.account_dialog_title);
titleTextView.setText(getString(R.string.preferences_dialog_change_account_title,
getSyncAccountName(this)));
TextView subtitleTextView = (TextView) titleView.findViewById(R.id.account_dialog_subtitle);
subtitleTextView.setText(getString(R.string.preferences_dialog_change_account_warn_msg));
+ //根据同步修改的账户信息设置标题以及子标题的内容
dialogBuilder.setCustomTitle(titleView);
-
+ //设置对话框的自定义标题
CharSequence[] menuItemArray = new CharSequence[] {
getString(R.string.preferences_menu_change_account),
getString(R.string.preferences_menu_remove_account),
getString(R.string.preferences_menu_cancel)
};
+ //定义一些标记字符串
dialogBuilder.setItems(menuItemArray, new DialogInterface.OnClickListener() {
+ //设置对话框要显示的一个list，用于显示几个命令时,即change，remove，cancel
public void onClick(DialogInterface dialog, int which) {
+ //按键功能，由which来决定
if (which == 0) {
+ //进入账户选择对话框
showSelectAccountAlertDialog();
} else if (which == 1) {
+ //删除账户并且跟新便签界面
removeSyncAccount();
refreshUI();
}
}
});
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);
SharedPreferences.Editor editor = settings.edit();
+ //编辑共享的首选项
if (account != null) {
editor.putString(PREFERENCE_SYNC_ACCOUNT_NAME, account);
} else {
editor.putString(PREFERENCE_SYNC_ACCOUNT_NAME, "");
}
+ //将该账号加入到首选项中
+
editor.commit();
+ //提交修改的数据
+
- // clean up last sync time
setLastSyncTime(this, 0);
+ //将最后同步时间清零
// clean up local gtask related info
new Thread(new Runnable() {
@@ -311,23 +399,33 @@ public class NotesPreferenceActivity extends PreferenceActivity {
getContentResolver().update(Notes.CONTENT_NOTE_URI, values, null, null);
}
}).start();
+ //重置当地同步任务的信息
Toast.makeText(NotesPreferenceActivity.this,
getString(R.string.preferences_toast_success_set_accout, account),
Toast.LENGTH_SHORT).show();
+ //将toast的文本信息置为“设置账户成功”并显示出来
}
}
-
+ /*
+ * 函数功能：删除同步账户
+ * 函数实现：如下注释：
+ */
private void removeSyncAccount() {
SharedPreferences settings = getSharedPreferences(PREFERENCE_NAME, Context.MODE_PRIVATE);
SharedPreferences.Editor editor = settings.edit();
+ //设置共享首选项
+
if (settings.contains(PREFERENCE_SYNC_ACCOUNT_NAME)) {
editor.remove(PREFERENCE_SYNC_ACCOUNT_NAME);
+ //假如当前首选项中有账户就删除
}
if (settings.contains(PREFERENCE_LAST_SYNC_TIME)) {
editor.remove(PREFERENCE_LAST_SYNC_TIME);
+ //删除当前首选项中有账户时间
}
editor.commit();
+ //提交更新后的数据
// clean up local gtask related info
new Thread(new Runnable() {
@@ -338,51 +436,79 @@ public class NotesPreferenceActivity extends PreferenceActivity {
getContentResolver().update(Notes.CONTENT_NOTE_URI, values, null, null);
}
}).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);
SharedPreferences.Editor editor = settings.edit();
+ // 从共享首选项中找到相关账户并获取其编辑器
editor.putLong(PREFERENCE_LAST_SYNC_TIME, time);
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);
}
+ /*
+ * 函数功能：接受同步信息
+ * 函数实现：继承BroadcastReceiver
+ */
private class GTaskReceiver extends BroadcastReceiver {
@Override
public void onReceive(Context context, Intent intent) {
refreshUI();
if (intent.getBooleanExtra(GTaskSyncService.GTASK_SERVICE_BROADCAST_IS_SYNCING, false)) {
+ //获取随广播而来的Intent中的同步服务的数据
TextView syncStatus = (TextView) findViewById(R.id.prefenerece_sync_status_textview);
syncStatus.setText(intent
.getStringExtra(GTaskSyncService.GTASK_SERVICE_BROADCAST_PROGRESS_MSG));
+ //通过获取的数据在设置系统的状态
}
}
}
+ /*
+ * 函数功能：处理菜单的选项
+ * 函数实现：如下注释
+ * 参数:MenuItem菜单选项
+ */
public boolean onOptionsItemSelected(MenuItem item) {
switch (item.getItemId()) {
+ //根据选项的id选择，这里只有一个主页
case android.R.id.home:
Intent intent = new Intent(this, NotesListActivity.class);
intent.addFlags(Intent.FLAG_ACTIVITY_CLEAR_TOP);
startActivity(intent);
return true;
+ //在主页情况下在创建连接组件intent，发出清空的信号并开始一个相应的activity
default:
return false;
}
}
}
+
\ No newline at end of file
diff --git a/src/main/java/net/micode/notes/widget/NoteWidgetProvider.java b/src/main/java/net/micode/notes/widget/NoteWidgetProvider.java
index ec6f819..9d67278 100644
--- a/src/main/java/net/micode/notes/widget/NoteWidgetProvider.java
+++ b/src/main/java/net/micode/notes/widget/NoteWidgetProvider.java
@@ -16,7 +16,10 @@
package net.micode.notes.widget;
import android.app.PendingIntent;
+//1.* AppWidgetManager类维护了应用程序中所有的AppWidget，并且为给每个AppWidget特定的Id去标识他们(一般用 appWidgetId去标识)
+// * 通过给定的appWidgetId，AppWidgetManager可以管理对应的AppWidget
import android.appwidget.AppWidgetManager;
+//提供可在桌面显示小插件的方法，基本操作。
import android.appwidget.AppWidgetProvider;
import android.content.ContentValues;
import android.content.Context;
@@ -24,20 +27,29 @@ import android.content.Intent;
import android.database.Cursor;
import android.util.Log;
import android.widget.RemoteViews;
+//远程访问
import net.micode.notes.R;
+//引入android自动生成的R类资源
import net.micode.notes.data.Notes;
import net.micode.notes.data.Notes.NoteColumns;
import net.micode.notes.tool.ResourceParser;
import net.micode.notes.ui.NoteEditActivity;
import net.micode.notes.ui.NotesListActivity;
+/**
+ * extends用法继承或者覆盖
+ * 继承——派生类继承了父类的所有方法。
+ * 覆盖——在子类中定义一个与父类同名，返回类型，参数类型均相同的一个方法
+ * abstract class 定义抽象类，如果设计这个类的某个描述方法不清楚，则应该定义为抽象类，可以在以后继承这个抽象类的时候进行完善
+ */
public abstract class NoteWidgetProvider extends AppWidgetProvider {
public static final String [] PROJECTION = new String [] {
NoteColumns.ID,
NoteColumns.BG_COLOR_ID,
NoteColumns.SNIPPET
};
+//
public static final int COLUMN_ID = 0;
public static final int COLUMN_BG_COLOR_ID = 1;
@@ -45,9 +57,16 @@ public abstract class NoteWidgetProvider extends AppWidgetProvider {
private static final String TAG = "NoteWidgetProvider";
+ /**
+ * onDeleted()处理 AppWidgetManager.ACTION_APPWIDGET_DELETED 广播，当该类型的AppWidget每次被删除时，调用此方法
+ * 该广播在有该 AppWidgetProvider 的实例被删除时，由 AppWidgetService.deleteAppWidgetLocked() 发出
+ * @param context
+ * @param appWidgetIds
+ */
@Override
public void onDeleted(Context context, int[] appWidgetIds) {
ContentValues values = new ContentValues();
+ //对每个AppWidget，可以创建其多个实例，这些实例对应于不同的appWidgetId
values.put(NoteColumns.WIDGET_ID, AppWidgetManager.INVALID_APPWIDGET_ID);
for (int i = 0; i < appWidgetIds.length; i++) {
context.getContentResolver().update(Notes.CONTENT_NOTE_URI,
@@ -56,7 +75,7 @@ public abstract class NoteWidgetProvider extends AppWidgetProvider {
new String[] { String.valueOf(appWidgetIds[i])});
}
}
-
+ //一个私有的Cursor类，用于返回当前窗口id所对应在context中的位置
private Cursor getNoteWidgetInfo(Context context, int widgetId) {
return context.getContentResolver().query(Notes.CONTENT_NOTE_URI,
PROJECTION,
@@ -68,10 +87,11 @@ public abstract class NoteWidgetProvider extends AppWidgetProvider {
protected void update(Context context, AppWidgetManager appWidgetManager, int[] appWidgetIds) {
update(context, appWidgetManager, appWidgetIds, false);
}
-
+//获取有关已安装appwidget提供程序和其他appwidget相关状态的信息。然后在update中根据这些信息更新状态
private void update(Context context, AppWidgetManager appWidgetManager, int[] appWidgetIds,
boolean privacyMode) {
for (int i = 0; i < appWidgetIds.length; i++) {
+ //appWidgetId是每添加一个Widget会有一个WidgetId
if (appWidgetIds[i] != AppWidgetManager.INVALID_APPWIDGET_ID) {
int bgId = ResourceParser.getDefaultBgId(context);
String snippet = "";
@@ -81,6 +101,9 @@ public abstract class NoteWidgetProvider extends AppWidgetProvider {
intent.putExtra(Notes.INTENT_EXTRA_WIDGET_TYPE, getWidgetType());
Cursor c = getNoteWidgetInfo(context, appWidgetIds[i]);
+ //根据widgetID查询一些数据，放到cursor对象里，
+ // 就是数据库里的筛选出来的一行或者几行放进“游标”里，如果查询到多个结果，报错，
+ // 否则对intent进行设置，在widget和小米便签之间传递信息
if (c != null && c.moveToFirst()) {
if (c.getCount() > 1) {
Log.e(TAG, "Multiple message with same widget id:" + appWidgetIds[i]);
@@ -92,6 +115,7 @@ public abstract class NoteWidgetProvider extends AppWidgetProvider {
intent.putExtra(Intent.EXTRA_UID, c.getLong(COLUMN_ID));
intent.setAction(Intent.ACTION_VIEW);
} else {
+ //没有关联内容，点击新建便签
snippet = context.getResources().getString(R.string.widget_havenot_content);
intent.setAction(Intent.ACTION_INSERT_OR_EDIT);
}
@@ -99,7 +123,12 @@ public abstract class NoteWidgetProvider extends AppWidgetProvider {
if (c != null) {
c.close();
}
-
+ /**
+ * RemoteViews即远程view，他可以用来在进程A显示进程B的view，
+ * 发通知到状态栏也是利用RemoteViews.如果是私密模式，则显示一串特定的字符串；
+ * 如果不是，，显示小片，并执行pendingIntent的activity；更新widget
+ * 最后如果点击
+ */
RemoteViews rv = new RemoteViews(context.getPackageName(), getLayoutId());
rv.setImageViewResource(R.id.widget_bg_image, getBgResourceId(bgId));
intent.putExtra(Notes.INTENT_EXTRA_BACKGROUND_ID, bgId);
@@ -107,6 +136,8 @@ public abstract class NoteWidgetProvider extends AppWidgetProvider {
* Generate the pending intent to start host for the widget
*/
PendingIntent pendingIntent = null;
+ //为小部件生成启动主机的挂起的目标选项
+ //判定是否是私密模式
if (privacyMode) {
rv.setTextViewText(R.id.widget_text,
context.getString(R.string.widget_under_visit_mode));
@@ -117,16 +148,16 @@ public abstract class NoteWidgetProvider extends AppWidgetProvider {
pendingIntent = PendingIntent.getActivity(context, appWidgetIds[i], intent,
PendingIntent.FLAG_UPDATE_CURRENT);
}
-
+ //点击“按钮(widget_text)”时会触发的Intent，从而对按钮点击事件进行处理
rv.setOnClickPendingIntent(R.id.widget_text, pendingIntent);
appWidgetManager.updateAppWidget(appWidgetIds[i], rv);
}
}
}
-
+ //从背景资源中获取当前应用ID
protected abstract int getBgResourceId(int bgId);
-
+ //获取部局ID
protected abstract int getLayoutId();
-
+ //获取挂件的类型，即2x2型或者4x4型
protected abstract int getWidgetType();
}
diff --git a/src/main/java/net/micode/notes/widget/NoteWidgetProvider_2x.java b/src/main/java/net/micode/notes/widget/NoteWidgetProvider_2x.java
index adcb2f7..1d09c53 100644
--- a/src/main/java/net/micode/notes/widget/NoteWidgetProvider_2x.java
+++ b/src/main/java/net/micode/notes/widget/NoteWidgetProvider_2x.java
@@ -23,7 +23,9 @@ import net.micode.notes.R;
import net.micode.notes.data.Notes;
import net.micode.notes.tool.ResourceParser;
-
+/**
+ * 主要的内容继承自NoteWidgetProvider，不同在于窗口的大小不同，只需要重载部分函数即可。
+ */
public class NoteWidgetProvider_2x extends NoteWidgetProvider {
@Override
public void onUpdate(Context context, AppWidgetManager appWidgetManager, int[] appWidgetIds) {
diff --git a/src/main/java/net/micode/notes/widget/NoteWidgetProvider_4x.java b/src/main/java/net/micode/notes/widget/NoteWidgetProvider_4x.java
index c12a02e..c15929c 100644
--- a/src/main/java/net/micode/notes/widget/NoteWidgetProvider_4x.java
+++ b/src/main/java/net/micode/notes/widget/NoteWidgetProvider_4x.java
@@ -23,7 +23,9 @@ import net.micode.notes.R;
import net.micode.notes.data.Notes;
import net.micode.notes.tool.ResourceParser;
-
+/**
+ * 主要的内容继承自NoteWidgetProvider，不同在于窗口的大小不同，只需要重载部分函数即可。
+ */
public class NoteWidgetProvider_4x extends NoteWidgetProvider {
@Override
public void onUpdate(Context context, AppWidgetManager appWidgetManager, int[] appWidgetIds) {
--
2.34.1