庞浩的注释

pull/18/head
庞浩 2 years ago
parent deeba68c2f
commit c6064d8257

@ -66,71 +66,75 @@ public class WorkingNote {
DataColumns.ID,// ID列 DataColumns.ID,// ID列
DataColumns.CONTENT, // 内容列 DataColumns.CONTENT, // 内容列
DataColumns.MIME_TYPE, // MIME类型列 DataColumns.MIME_TYPE, // MIME类型列
DataColumns.DATA1, DataColumns.DATA1, // 数据列1
DataColumns.DATA2, DataColumns.DATA2,// 数据列2
DataColumns.DATA3, DataColumns.DATA3, // 数据列3
DataColumns.DATA4, DataColumns.DATA4,// 数据列4
}; };
public static final String[] NOTE_PROJECTION = new String[] { public static final String[] NOTE_PROJECTION = new String[] {
NoteColumns.PARENT_ID, NoteColumns.PARENT_ID,// 父ID列
NoteColumns.ALERTED_DATE, NoteColumns.ALERTED_DATE,// 提醒日期列
NoteColumns.BG_COLOR_ID, NoteColumns.BG_COLOR_ID,// 背景颜色ID列
NoteColumns.WIDGET_ID, NoteColumns.WIDGET_ID,// 小部件ID列
NoteColumns.WIDGET_TYPE, NoteColumns.WIDGET_TYPE,// 小部件类型列
NoteColumns.MODIFIED_DATE NoteColumns.MODIFIED_DATE // 修改日期列
}; };
private static final int DATA_ID_COLUMN = 0; private static final int DATA_ID_COLUMN = 0;// 数据表中数据ID列的索引常量整数值为0
private static final int DATA_CONTENT_COLUMN = 1;
private static final int DATA_MIME_TYPE_COLUMN = 2; private static final int DATA_CONTENT_COLUMN = 1; // 数据表中数据内容列的索引常量整数值为1
private static final int DATA_MODE_COLUMN = 3;
private static final int NOTE_PARENT_ID_COLUMN = 0; private static final int DATA_MIME_TYPE_COLUMN = 2;// 数据表中数据MIME类型列的索引常量整数值为2
private static final int NOTE_ALERTED_DATE_COLUMN = 1;
private static final int NOTE_BG_COLOR_ID_COLUMN = 2; private static final int DATA_MODE_COLUMN = 3; // 数据表中数据模式列的索引常量整数值为3
private static final int NOTE_WIDGET_ID_COLUMN = 3;
private static final int NOTE_WIDGET_TYPE_COLUMN = 4; private static final int NOTE_PARENT_ID_COLUMN = 0; // 笔记表中笔记父ID列的索引常量整数值为0
private static final int NOTE_MODIFIED_DATE_COLUMN = 5; private static final int NOTE_ALERTED_DATE_COLUMN = 1;// 笔记表中笔记提醒日期列的索引常量整数值为1
// New note construct private static final int NOTE_BG_COLOR_ID_COLUMN = 2;// 笔记表中笔记背景色ID列的索引常量整数值为2
private static final int NOTE_WIDGET_ID_COLUMN = 3; // 笔记表中笔记小部件ID列的索引常量整数值为3
private static final int NOTE_WIDGET_TYPE_COLUMN = 4;// 笔记表中笔记小部件类型列的索引常量整数值为4
private static final int NOTE_MODIFIED_DATE_COLUMN = 5;// 笔记表中笔记修改日期列的索引常量整数值为5
// New note construct创建新的笔记构造函数传入上下文和文件夹ID
private WorkingNote(Context context, long folderId) { private WorkingNote(Context context, long folderId) {
mContext = context; mContext = context;// 初始化上下文
mAlertDate = 0; mAlertDate = 0;// 提醒日期设置为0
mModifiedDate = System.currentTimeMillis(); mModifiedDate = System.currentTimeMillis(); // 修改日期设置为当前时间
mFolderId = folderId; mFolderId = folderId;// 设置文件夹ID
mNote = new Note(); mNote = new Note(); // 创建一个新的Note对象
mNoteId = 0; mNoteId = 0;// 设置笔记ID为0
mIsDeleted = false; mIsDeleted = false;// 设置是否已删除为false
mMode = 0; mMode = 0;// 设置工作模式为0
mWidgetType = Notes.TYPE_WIDGET_INVALIDE; mWidgetType = Notes.TYPE_WIDGET_INVALIDE;// 设置小部件类型为无效类型
} }
// Existing note construct // Existing note construct加载现有笔记的构造函数传入上下文、笔记ID和文件夹ID
private WorkingNote(Context context, long noteId, long folderId) { private WorkingNote(Context context, long noteId, long folderId) {
mContext = context; mContext = context; // 初始化上下文
mNoteId = noteId; mNoteId = noteId;// 设置笔记ID
mFolderId = folderId; mFolderId = folderId;---------------------------// 设置文件夹ID
mIsDeleted = false; mIsDeleted = false;// 设置是否已删除为false
mNote = new Note(); mNote = new Note(); // 创建一个新的Note对象
loadNote(); loadNote();// 加载现有笔记
} }
private void loadNote() { private void loadNote() {// 通过笔记ID查询笔记的游标
Cursor cursor = mContext.getContentResolver().query( Cursor cursor = mContext.getContentResolver().query(// 通过笔记ID查询笔记的游标
ContentUris.withAppendedId(Notes.CONTENT_NOTE_URI, mNoteId), NOTE_PROJECTION, null, ContentUris.withAppendedId(Notes.CONTENT_NOTE_URI, mNoteId), NOTE_PROJECTION, null,
null, null); null, null);
if (cursor != null) { if (cursor != null) {
if (cursor.moveToFirst()) { if (cursor.moveToFirst()) {// 从游标中获取笔记的相关信息
mFolderId = cursor.getLong(NOTE_PARENT_ID_COLUMN); mFolderId = cursor.getLong(NOTE_PARENT_ID_COLUMN);
mBgColorId = cursor.getInt(NOTE_BG_COLOR_ID_COLUMN); mBgColorId = cursor.getInt(NOTE_BG_COLOR_ID_COLUMN);
mWidgetId = cursor.getInt(NOTE_WIDGET_ID_COLUMN); mWidgetId = cursor.getInt(NOTE_WIDGET_ID_COLUMN);
@ -139,14 +143,14 @@ public class WorkingNote {
mModifiedDate = cursor.getLong(NOTE_MODIFIED_DATE_COLUMN); mModifiedDate = cursor.getLong(NOTE_MODIFIED_DATE_COLUMN);
} }
cursor.close(); cursor.close();
} else { } else {// 如果找不到笔记,则记录错误日志并抛出异常
Log.e(TAG, "No note with id:" + mNoteId); Log.e(TAG, "No note with id:" + mNoteId);
throw new IllegalArgumentException("Unable to find note with id " + mNoteId); throw new IllegalArgumentException("Unable to find note with id " + mNoteId);
} }// 加载笔记的数据
loadNoteData(); loadNoteData();
} }
private void loadNoteData() { private void loadNoteData() { // 通过笔记ID查询笔记数据的游标
Cursor cursor = mContext.getContentResolver().query(Notes.CONTENT_DATA_URI, DATA_PROJECTION, Cursor cursor = mContext.getContentResolver().query(Notes.CONTENT_DATA_URI, DATA_PROJECTION,
DataColumns.NOTE_ID + "=?", new String[] { DataColumns.NOTE_ID + "=?", new String[] {
String.valueOf(mNoteId) String.valueOf(mNoteId)
@ -154,26 +158,26 @@ public class WorkingNote {
if (cursor != null) { if (cursor != null) {
if (cursor.moveToFirst()) { if (cursor.moveToFirst()) {
do { do {// 获取笔记数据的类型
String type = cursor.getString(DATA_MIME_TYPE_COLUMN); String type = cursor.getString(DATA_MIME_TYPE_COLUMN);
if (DataConstants.NOTE.equals(type)) { if (DataConstants.NOTE.equals(type)) {// 如果是笔记文本数据则获取内容和模式并设置笔记的文本数据ID
mContent = cursor.getString(DATA_CONTENT_COLUMN); mContent = cursor.getString(DATA_CONTENT_COLUMN);
mMode = cursor.getInt(DATA_MODE_COLUMN); mMode = cursor.getInt(DATA_MODE_COLUMN);
mNote.setTextDataId(cursor.getLong(DATA_ID_COLUMN)); mNote.setTextDataId(cursor.getLong(DATA_ID_COLUMN));
} else if (DataConstants.CALL_NOTE.equals(type)) { } else if (DataConstants.CALL_NOTE.equals(type)) {
mNote.setCallDataId(cursor.getLong(DATA_ID_COLUMN)); mNote.setCallDataId(cursor.getLong(DATA_ID_COLUMN));// 如果是电话笔记数据则设置笔记的电话数据ID
} else { } else {
Log.d(TAG, "Wrong note type with type:" + type); Log.d(TAG, "Wrong note type with type:" + type);
} }// 如果是其他类型的笔记数据,则记录错误日志
} while (cursor.moveToNext()); } while (cursor.moveToNext());
} }
cursor.close(); cursor.close();
} else { } else { // 如果找不到笔记数据,则记录错误日志并抛出异常
Log.e(TAG, "No data with id:" + mNoteId); Log.e(TAG, "No data with id:" + mNoteId);
throw new IllegalArgumentException("Unable to find note's data with id " + mNoteId); throw new IllegalArgumentException("Unable to find note's data with id " + mNoteId);
} }
} }
// 创建一个空笔记
public static WorkingNote createEmptyNote(Context context, long folderId, int widgetId, public static WorkingNote createEmptyNote(Context context, long folderId, int widgetId,
int widgetType, int defaultBgColorId) { int widgetType, int defaultBgColorId) {
WorkingNote note = new WorkingNote(context, folderId); WorkingNote note = new WorkingNote(context, folderId);
@ -182,24 +186,24 @@ public class WorkingNote {
note.setWidgetType(widgetType); note.setWidgetType(widgetType);
return note; return note;
} }
// 加载笔记
public static WorkingNote load(Context context, long id) { public static WorkingNote load(Context context, long id) {
return new WorkingNote(context, id, 0); return new WorkingNote(context, id, 0);
} }
// 保存笔记
public synchronized boolean saveNote() { public synchronized boolean saveNote() {
if (isWorthSaving()) { if (isWorthSaving()) {
if (!existInDatabase()) { if (!existInDatabase()) {// 如果笔记还不存在于数据库中则为其生成一个新的ID
if ((mNoteId = Note.getNewNoteId(mContext, mFolderId)) == 0) { if ((mNoteId = Note.getNewNoteId(mContext, mFolderId)) == 0) {
Log.e(TAG, "Create new note fail with id:" + mNoteId); Log.e(TAG, "Create new note fail with id:" + mNoteId);
return false; return false;
} }
} }
// 将笔记同步到数据库中
mNote.syncNote(mContext, mNoteId); mNote.syncNote(mContext, mNoteId);
/** /**
* Update widget content if there exist any widget of this note * Update widget content if there exist any widget of this note
*/ */
if (mWidgetId != AppWidgetManager.INVALID_APPWIDGET_ID if (mWidgetId != AppWidgetManager.INVALID_APPWIDGET_ID
&& mWidgetType != Notes.TYPE_WIDGET_INVALIDE && mWidgetType != Notes.TYPE_WIDGET_INVALIDE
@ -211,11 +215,11 @@ public class WorkingNote {
return false; return false;
} }
} }
// 判断笔记是否已经存在于数据库中
public boolean existInDatabase() { public boolean existInDatabase() {
return mNoteId > 0; return mNoteId > 0;
} }
// 判断笔记是否值得保存
private boolean isWorthSaving() { private boolean isWorthSaving() {
if (mIsDeleted || (!existInDatabase() && TextUtils.isEmpty(mContent)) if (mIsDeleted || (!existInDatabase() && TextUtils.isEmpty(mContent))
|| (existInDatabase() && !mNote.isLocalModified())) { || (existInDatabase() && !mNote.isLocalModified())) {
@ -224,11 +228,11 @@ public class WorkingNote {
return true; return true;
} }
} }
// 设置笔记设置状态改变的监听器
public void setOnSettingStatusChangedListener(NoteSettingChangedListener l) { public void setOnSettingStatusChangedListener(NoteSettingChangedListener l) {
mNoteSettingStatusListener = l; mNoteSettingStatusListener = l;
} }
// 设置提醒日期
public void setAlertDate(long date, boolean set) { public void setAlertDate(long date, boolean set) {
if (date != mAlertDate) { if (date != mAlertDate) {
mAlertDate = date; mAlertDate = date;
@ -238,7 +242,7 @@ public class WorkingNote {
mNoteSettingStatusListener.onClockAlertChanged(date, set); mNoteSettingStatusListener.onClockAlertChanged(date, set);
} }
} }
// 标记笔记是否被删除
public void markDeleted(boolean mark) { public void markDeleted(boolean mark) {
mIsDeleted = mark; mIsDeleted = mark;
if (mWidgetId != AppWidgetManager.INVALID_APPWIDGET_ID if (mWidgetId != AppWidgetManager.INVALID_APPWIDGET_ID
@ -246,7 +250,7 @@ public class WorkingNote {
mNoteSettingStatusListener.onWidgetChanged(); mNoteSettingStatusListener.onWidgetChanged();
} }
} }
// 设置笔记的背景颜色
public void setBgColorId(int id) { public void setBgColorId(int id) {
if (id != mBgColorId) { if (id != mBgColorId) {
mBgColorId = id; mBgColorId = id;
@ -256,7 +260,7 @@ public class WorkingNote {
mNote.setNoteValue(NoteColumns.BG_COLOR_ID, String.valueOf(id)); mNote.setNoteValue(NoteColumns.BG_COLOR_ID, String.valueOf(id));
} }
} }
// 设置笔记的检查列表模式
public void setCheckListMode(int mode) { public void setCheckListMode(int mode) {
if (mMode != mode) { if (mMode != mode) {
if (mNoteSettingStatusListener != null) { if (mNoteSettingStatusListener != null) {
@ -266,78 +270,78 @@ public class WorkingNote {
mNote.setTextData(TextNote.MODE, String.valueOf(mMode)); mNote.setTextData(TextNote.MODE, String.valueOf(mMode));
} }
} }
// 设置笔记的小部件类型
public void setWidgetType(int type) { public void setWidgetType(int type) {
if (type != mWidgetType) { if (type != mWidgetType) {
mWidgetType = type; mWidgetType = type;
mNote.setNoteValue(NoteColumns.WIDGET_TYPE, String.valueOf(mWidgetType)); mNote.setNoteValue(NoteColumns.WIDGET_TYPE, String.valueOf(mWidgetType));
} }
} }
// 设置笔记的小部件ID
public void setWidgetId(int id) { public void setWidgetId(int id) {
if (id != mWidgetId) { if (id != mWidgetId) {
mWidgetId = id; mWidgetId = id;
mNote.setNoteValue(NoteColumns.WIDGET_ID, String.valueOf(mWidgetId)); mNote.setNoteValue(NoteColumns.WIDGET_ID, String.valueOf(mWidgetId));
} }
} }
//设置文本内容
public void setWorkingText(String text) { public void setWorkingText(String text) {
if (!TextUtils.equals(mContent, text)) { if (!TextUtils.equals(mContent, text)) {
mContent = text; mContent = text;
mNote.setTextData(DataColumns.CONTENT, mContent); mNote.setTextData(DataColumns.CONTENT, mContent);
} }
} }
//这是一个将笔记转换为电话记录的方法。它包含电话号码和通话日期,并更新笔记对象的值
public void convertToCallNote(String phoneNumber, long callDate) { public void convertToCallNote(String phoneNumber, long callDate) {
mNote.setCallData(CallNote.CALL_DATE, String.valueOf(callDate)); mNote.setCallData(CallNote.CALL_DATE, String.valueOf(callDate));
mNote.setCallData(CallNote.PHONE_NUMBER, phoneNumber); mNote.setCallData(CallNote.PHONE_NUMBER, phoneNumber);
mNote.setNoteValue(NoteColumns.PARENT_ID, String.valueOf(Notes.ID_CALL_RECORD_FOLDER)); mNote.setNoteValue(NoteColumns.PARENT_ID, String.valueOf(Notes.ID_CALL_RECORD_FOLDER));
} }
//指示笔记是否有闹钟提醒
public boolean hasClockAlert() { public boolean hasClockAlert() {
return (mAlertDate > 0 ? true : false); return (mAlertDate > 0 ? true : false);
} }
// 返回笔记的文本内容
public String getContent() { public String getContent() {
return mContent; return mContent;
} }
// 返回笔记的警报日期
public long getAlertDate() { public long getAlertDate() {
return mAlertDate; return mAlertDate;
} }
// 返回笔记的修改日期
public long getModifiedDate() { public long getModifiedDate() {
return mModifiedDate; return mModifiedDate;
} }
// 返回笔记的背景颜色资源ID
public int getBgColorResId() { public int getBgColorResId() {
return NoteBgResources.getNoteBgResource(mBgColorId); return NoteBgResources.getNoteBgResource(mBgColorId);
} }
// 返回笔记的背景颜色ID
public int getBgColorId() { public int getBgColorId() {
return mBgColorId; return mBgColorId;
} }
// 返回笔记标题的背景颜色资源ID
public int getTitleBgResId() { public int getTitleBgResId() {
return NoteBgResources.getNoteTitleBgResource(mBgColorId); return NoteBgResources.getNoteTitleBgResource(mBgColorId);
} }
// 返回笔记的检查清单模式
public int getCheckListMode() { public int getCheckListMode() {
return mMode; return mMode;
} }
// 返回笔记的ID
public long getNoteId() { public long getNoteId() {
return mNoteId; return mNoteId;
} }
// 返回笔记所在文件夹的ID
public long getFolderId() { public long getFolderId() {
return mFolderId; return mFolderId;
} }
// 返回笔记所属的小部件ID
public int getWidgetId() { public int getWidgetId() {
return mWidgetId; return mWidgetId;
} }
// 返回笔记所属的小部件类型
public int getWidgetType() { public int getWidgetType() {
return mWidgetType; return mWidgetType;
} }

Loading…
Cancel
Save