model/WorkingNote.java注释提交

Notes-master2/src/net/micode/notes/model/WorkingNote.java

@@ -33,36 +33,37 @@ import net.micode.notes.tool.ResourceParser.NoteBgResources;
 
 
 public class WorkingNote {
-    // Note for the working note
+// 工作笔记的类定义
+
+// 笔记对象
 private Note mNote;
-    // Note Id
+// 笔记ID
 private long mNoteId;
-    // Note content
+// 笔记内容
 private String mContent;
-    // Note mode
+// 笔记模式
 private int mMode;
-
+// 提醒日期
 private long mAlertDate;
-
+// 修改日期
 private long mModifiedDate;
-
+// 背景颜色ID
 private int mBgColorId;
-
+// 小部件ID
 private int mWidgetId;
-
+// 小部件类型
 private int mWidgetType;
-
+// 文件夹ID
 private long mFolderId;
-
+// 上下文
 private Context mContext;
-
-    private static final String TAG = "WorkingNote";
-
+// 删除标记
 private boolean mIsDeleted;
-
+// 笔记设置变更监听器
 private NoteSettingChangedListener mNoteSettingStatusListener;
 
-    public static final String[] DATA_PROJECTION = new String[] {// 声明 DATA_PROJECTION字符串数组
+// 查询字符串数组
+public static final String[] DATA_PROJECTION = new String[] {
     DataColumns.ID,
     DataColumns.CONTENT,
     DataColumns.MIME_TYPE,
@@ -72,7 +73,8 @@ public class WorkingNote {
     DataColumns.DATA4,
 };
 
-    public static final String[] NOTE_PROJECTION = new String[] { // 声明 NOTE_PROJECTION字符串数组
+// 查询字符串数组
+public static final String[] NOTE_PROJECTION = new String[] {
     NoteColumns.PARENT_ID,
     NoteColumns.ALERTED_DATE,
     NoteColumns.BG_COLOR_ID,
@@ -81,27 +83,28 @@ public class WorkingNote {
     NoteColumns.MODIFIED_DATE
 };
 
+// 数据 ID 列
 private static final int DATA_ID_COLUMN = 0;
-
+// 数据内容列
 private static final int DATA_CONTENT_COLUMN = 1;
-
+// 数据 MIME 类型列
 private static final int DATA_MIME_TYPE_COLUMN = 2;
-
+// 数据模式列
 private static final int DATA_MODE_COLUMN = 3;
-
+// 笔记父ID列
 private static final int NOTE_PARENT_ID_COLUMN = 0;
-
+// 笔记提醒日期列
 private static final int NOTE_ALERTED_DATE_COLUMN = 1;
-
+// 笔记背景颜色ID列
 private static final int NOTE_BG_COLOR_ID_COLUMN = 2;
-
+// 笔记小部件ID列
 private static final int NOTE_WIDGET_ID_COLUMN = 3;
-
+// 笔记小部件类型列
 private static final int NOTE_WIDGET_TYPE_COLUMN = 4;
-
+// 笔记修改日期列
 private static final int NOTE_MODIFIED_DATE_COLUMN = 5;
 
-    // New note construct
+// 新建笔记构造函数
 private WorkingNote(Context context, long folderId) {
     mContext = context;
     mAlertDate = 0;
@@ -113,8 +116,8 @@ public class WorkingNote {
     mMode = 0;
     mWidgetType = Notes.TYPE_WIDGET_INVALIDE;
 }
-    // WorkingNote的构造函数
-    // Existing note construct
+
+// 已有笔记构造函数
 private WorkingNote(Context context, long noteId, long folderId) {
     mContext = context;
     mNoteId = noteId;
@@ -124,10 +127,14 @@ public class WorkingNote {
     loadNote();
 }
 
+// 载入笔记
 private void loadNote() {
     Cursor cursor = mContext.getContentResolver().query(
-                ContentUris.withAppendedId(Notes.CONTENT_NOTE_URI, mNoteId), NOTE_PROJECTION, null,
-                null, null);
+        ContentUris.withAppendedId(Notes.CONTENT_NOTE_URI, mNoteId),
+        NOTE_PROJECTION,
+        null,
+        null,
+        null);
 
     if (cursor != null) {
         if (cursor.moveToFirst()) {
@@ -146,11 +153,14 @@ public class WorkingNote {
     loadNoteData();
 }
 
+// 载入笔记的数据
 private void loadNoteData() {
-        Cursor cursor = mContext.getContentResolver().query(Notes.CONTENT_DATA_URI, DATA_PROJECTION,
-                DataColumns.NOTE_ID + "=?", new String[] {
-                    String.valueOf(mNoteId)
-                }, null);
+    Cursor cursor = mContext.getContentResolver().query(
+        Notes.CONTENT_DATA_URI,
+        DATA_PROJECTION,
+        DataColumns.NOTE_ID + "=?",
+        new String[] { String.valueOf(mNoteId) },
+        null);
 
     if (cursor != null) {
         if (cursor.moveToFirst()) {
@@ -174,8 +184,13 @@ public class WorkingNote {
     }
 }
 
-    public static WorkingNote createEmptyNote(Context context, long folderId, int widgetId,
-            int widgetType, int defaultBgColorId) {
+// 创建空笔记
+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);
@@ -183,23 +198,27 @@ public class WorkingNote {
     return note;
 }
 
+// 载入笔记
 public static WorkingNote load(Context context, long id) {
     return new WorkingNote(context, id, 0);
 }
+}    
 
+// 保存笔记
 public synchronized boolean saveNote() {
     if (isWorthSaving()) {
+        // 新建笔记
         if (!existInDatabase()) {
             if ((mNoteId = Note.getNewNoteId(mContext, mFolderId)) == 0) {
                 Log.e(TAG, "Create new note fail with id:" + mNoteId);
                 return false;
             }
         }
-
+        // 更新笔记
         mNote.syncNote(mContext, mNoteId);
 
         /** 
-             * Update widget content if there exist any widget of this note
+          * 如果笔记可以设置提醒，更新相关的部件
           */
         if (mWidgetId != AppWidgetManager.INVALID_APPWIDGET_ID
                 && mWidgetType != Notes.TYPE_WIDGET_INVALIDE
@@ -212,10 +231,12 @@ public class WorkingNote {
     }
 }
 
+// 判断笔记是否已存在于数据库
 public boolean existInDatabase() {
     return mNoteId > 0;
 }
 
+// 判断是否需要保存笔记
 private boolean isWorthSaving() {
     if (mIsDeleted || (!existInDatabase() && TextUtils.isEmpty(mContent))
             || (existInDatabase() && !mNote.isLocalModified())) {
@@ -225,10 +246,12 @@ public class WorkingNote {
     }
 }
 
+// 设置笔记状态变化的监听器
 public void setOnSettingStatusChangedListener(NoteSettingChangedListener l) {
     mNoteSettingStatusListener = l;
 }
 
+// 设置提醒日期
 public void setAlertDate(long date, boolean set) {
     if (date != mAlertDate) {
         mAlertDate = date;
@@ -239,6 +262,7 @@ public class WorkingNote {
     }
 }
 
+// 对笔记进行标记
 public void markDeleted(boolean mark) {
     mIsDeleted = mark;
     if (mWidgetId != AppWidgetManager.INVALID_APPWIDGET_ID
@@ -247,6 +271,7 @@ public class WorkingNote {
     }
 }
 
+// 设置背景颜色
 public void setBgColorId(int id) {
     if (id != mBgColorId) {
         mBgColorId = id;
@@ -257,6 +282,7 @@ public class WorkingNote {
     }
 }
 
+// 设置检查清单
 public void setCheckListMode(int mode) {
     if (mMode != mode) {
         if (mNoteSettingStatusListener != null) {
@@ -267,6 +293,7 @@ public class WorkingNote {
     }
 }
 
+// 设置部件类型
 public void setWidgetType(int type) {
     if (type != mWidgetType) {
         mWidgetType = type;
@@ -274,6 +301,7 @@ public class WorkingNote {
     }
 }
 
+// 设置部件ID
 public void setWidgetId(int id) {
     if (id != mWidgetId) {
         mWidgetId = id;
@@ -281,6 +309,7 @@ public class WorkingNote {
     }
 }
 
+// 设置工作文本
 public void setWorkingText(String text) {
     if (!TextUtils.equals(mContent, text)) {
         mContent = text;
@@ -288,12 +317,14 @@ public class WorkingNote {
     }
 }
 
+// 转换成通话记录
 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);
 }
@@ -342,27 +373,18 @@ public class WorkingNote {
     return mWidgetType;
 }
 
+// 笔记状态监听器接口
 public interface NoteSettingChangedListener {
-        /**
-         * Called when the background color of current note has just changed
-         */
+    // 当当前笔记的背景颜色已改变时调用
     void onBackgroundColorChanged();
 
-        /**
-         * Called when user set clock
-         */
+    // 当用户设置闹钟时调用
     void onClockAlertChanged(long date, boolean set);
 
-        /**
-         * Call when user create note from widget
-         */
+    // 当从部件创建笔记时调用
     void onWidgetChanged();
 
-        /**
-         * Call when switch between check list mode and normal mode
-         * @param oldMode is previous mode before change
-         * @param newMode is new mode
-         */
+    // 当检查清单模式与普通模式之间切换时调用
     void onCheckListModeChanged(int oldMode, int newMode);
 }
 }