WorkingNote.java代码注释

notes/model/WorkingNote.java

@@ -56,12 +56,14 @@ public class WorkingNote {
 
     private Context mContext;
 
+    //声明DATA_PROJECTION字符串数组
     private static final String TAG = "WorkingNote";
 
     private boolean mIsDeleted;
 
     private NoteSettingChangedListener mNoteSettingStatusListener;
 
+    //声明 NOTE_PROJECTION字符串数组
     public static final String[] DATA_PROJECTION = new String[] {
             DataColumns.ID,
             DataColumns.CONTENT,
@@ -115,6 +117,7 @@ public class WorkingNote {
     }
 
     // Existing note construct
+    //WorkingNote的构造函数
     private WorkingNote(Context context, long noteId, long folderId) {
         mContext = context;
         mNoteId = noteId;
@@ -124,11 +127,13 @@ 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,13 +144,14 @@ public class WorkingNote {
                 mModifiedDate = cursor.getLong(NOTE_MODIFIED_DATE_COLUMN);
             }
             cursor.close();
-        } else {
+        } else {//若不存在，报错
             Log.e(TAG, "No note with id:" + mNoteId);
             throw new IllegalArgumentException("Unable to find note with id " + mNoteId);
         }
         loadNoteData();
     }
 
+    //加载NoteData
     private void loadNoteData() {
         Cursor cursor = mContext.getContentResolver().query(Notes.CONTENT_DATA_URI, DATA_PROJECTION,
                 DataColumns.NOTE_ID + "=?", new String[] {
@@ -153,7 +159,8 @@ public class WorkingNote {
                 }, 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 +172,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 +181,12 @@ public class WorkingNote {
         }
     }
 
+    // 创建空的Note
+    // 传参：context，文件夹id，widget，背景颜色
     public static WorkingNote createEmptyNote(Context context, long folderId, int widgetId,
             int widgetType, int defaultBgColorId) {
         WorkingNote note = new WorkingNote(context, folderId);
+        //设定相关属性
         note.setBgColorId(defaultBgColorId);
         note.setWidgetId(widgetId);
         note.setWidgetType(widgetType);
@@ -187,9 +197,10 @@ public class WorkingNote {
         return new WorkingNote(context, id, 0);
     }
 
+    //保存Note
     public synchronized boolean saveNote() {
-        if (isWorthSaving()) {
+        if (isWorthSaving()) {//是否值得保存
-            if (!existInDatabase()) {
+            if (!existInDatabase()) {//是否存在数据库中
                 if ((mNoteId = Note.getNewNoteId(mContext, mFolderId)) == 0) {
                     Log.e(TAG, "Create new note fail with id:" + mNoteId);
                     return false;
@@ -212,11 +223,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 +239,13 @@ 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,15 +256,21 @@ 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方法
+
         }
     }
 
+    //设定背景颜色
     public void setBgColorId(int id) {
+        //设定条件 id != mBgColorId
         if (id != mBgColorId) {
             mBgColorId = id;
             if (mNoteSettingStatusListener != null) {
@@ -257,7 +280,10 @@ public class WorkingNote {
         }
     }
 
+    // 设定检查列表模式
+    // 参数：mode
     public void setCheckListMode(int mode) {
+        //设定条件 mMode != mode
         if (mMode != mode) {
             if (mNoteSettingStatusListener != null) {
                 mNoteSettingStatusListener.onCheckListModeChanged(mMode, mode);
@@ -267,81 +293,107 @@ public class WorkingNote {
         }
     }
 
+    // 设定WidgetType
+    // 参数：type
     public void setWidgetType(int type) {
-        if (type != mWidgetType) {
+        if (type != mWidgetType) {//设定条件 type != mWidgetType
             mWidgetType = type;
+            // 调用Note的setNoteValue方法更改WidgetType
             mNote.setNoteValue(NoteColumns.WIDGET_TYPE, String.valueOf(mWidgetType));
         }
     }
 
+    // 设定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