diff --git a/WorkingNote.java b/WorkingNote.java new file mode 100644 index 0000000..4807737 --- /dev/null +++ b/WorkingNote.java @@ -0,0 +1,407 @@ +/* + * Copyright (c) 2010 - 2011, The MiCode Open Source Community (www.micode.net) + * + * 遵循 Apache 许可证 2.0 版(“许可证”); + * 除非遵守许可证,否则不得使用此文件。 + * 你可以在以下网址获取许可证副本: + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * 除非适用法律要求或书面同意, + * 根据许可证分发的软件按“原样”分发, + * 不附带任何明示或暗示的保证或条件。 + * 请参阅许可证,了解具体的权限和限制。 + */ + +package net.micode.notes.model; + +import android.appwidget.AppWidgetManager; +import android.content.ContentUris; +import android.content.Context; +import android.database.Cursor; +import android.text.TextUtils; +import android.util.Log; + +import net.micode.notes.data.Notes; +import net.micode.notes.data.Notes.CallNote; +import net.micode.notes.data.Notes.DataColumns; +import net.micode.notes.data.Notes.DataConstants; +import net.micode.notes.data.Notes.NoteColumns; +import net.micode.notes.data.Notes.TextNote; +import net.micode.notes.tool.ResourceParser.NoteBgResources; + +// WorkingNote 类表示正在编辑或操作的笔记,它封装了笔记的各种属性和操作方法,如加载、保存、设置属性等 +public class WorkingNote { + // 关联的 Note 对象,用于存储和管理笔记的基本信息和数据 + private Note mNote; + // 笔记的 ID + private long mNoteId; + // 笔记的内容 + private String mContent; + // 笔记的模式 + 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[] { + DataColumns.ID, + DataColumns.CONTENT, + DataColumns.MIME_TYPE, + DataColumns.DATA1, + DataColumns.DATA2, + DataColumns.DATA3, + DataColumns.DATA4, + }; + + // 用于查询笔记属性的投影数组 + public static final String[] NOTE_PROJECTION = new String[] { + NoteColumns.PARENT_ID, + NoteColumns.ALERTED_DATE, + NoteColumns.BG_COLOR_ID, + NoteColumns.WIDGET_ID, + NoteColumns.WIDGET_TYPE, + NoteColumns.MODIFIED_DATE + }; + + // 数据投影数组中 ID 列的索引 + private static final int DATA_ID_COLUMN = 0; + // 数据投影数组中内容列的索引 + private static final int DATA_CONTENT_COLUMN = 1; + // 数据投影数组中 MIME_TYPE 列的索引 + private static final int DATA_MIME_TYPE_COLUMN = 2; + // 数据投影数组中 DATA1 列的索引 + private static final int DATA_MODE_COLUMN = 3; + // 笔记投影数组中 PARENT_ID 列的索引 + private static final int NOTE_PARENT_ID_COLUMN = 0; + // 笔记投影数组中 ALERTED_DATE 列的索引 + private static final int NOTE_ALERTED_DATE_COLUMN = 1; + // 笔记投影数组中 BG_COLOR_ID 列的索引 + private static final int NOTE_BG_COLOR_ID_COLOC = 2; + // 笔记投影数组中 WIDGET_ID 列的索引 + private static final int NOTE_WIDGET_ID_COLUMN = 3; + // 笔记投影数组中 WIDGET_TYPE 列的索引 + private static final int NOTE_WIDGET_TYPE_COLUMN = 4; + // 笔记投影数组中 MODIFIED_DATE 列的索引 + private static final int NOTE_MODIFIED_DATE_COLUMN = 5; + + // 构造函数,用于创建一个新的空笔记 + private WorkingNote(Context context, long folderId) { + mContext = context; + mAlertDate = 0; + mModifiedDate = System.currentTimeMillis(); + mFolderId = folderId; + mNote = new Note(); + mNoteId = 0; + mIsDeleted = false; + mMode = 0; + mWidgetType = Notes.TYPE_WIDGET_INVALIDE; + } + + // 构造函数,用于加载一个已存在的笔记 + private WorkingNote(Context context, long noteId, long folderId) { + mContext = context; + mNoteId = noteId; + mFolderId = folderId; + mIsDeleted = false; + mNote = new Note(); + loadNote(); + } + + // 加载笔记的方法,从数据库中获取笔记的属性信息 + 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); + mBgColorId = cursor.getInt(NOTE_BG_COLOR_ID_COLUMN); + mWidgetId = cursor.getInt(NOTE_WIDGET_ID_COLUMN); + mWidgetType = cursor.getInt(NOTE_WIDGET_TYPE_COLUMN); + mAlertDate = cursor.getLong(NOTE_ALERTED_DATE_COLUMN); + 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); + } + loadNoteData(); + } + + // 加载笔记数据的方法,从数据库中获取笔记的详细数据(如文本内容、通话数据等) + private void loadNoteData() { + // 查询数据库获取笔记的详细数据 + 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()) { + do { + // 从游标中获取数据的 MIME_TYPE 列信息 + String type = cursor.getString(DATA_MIME_TYPE_COLUMN); + if (DataConstants.NOTE.equals(type)) { + // 如果是文本类型数据,获取内容和模式信息并赋值给相应的成员变量,同时设置文本数据 ID + mContent = cursor.getString(DATA_CONTENT_COLUMN); + mMode = cursor.getInt(DATA_MODE_COLUMN); + mNote.setTextDataId(cursor.getLong(DATA_ID_COLUMN)); + } else if (DataConstants.CALL_NOTE.equals(type)) { + // 如果是通话类型数据,设置通话数据 ID + mNote.setCallDataId(cursor.getLong(DATA_ID_COLUMN)); + } else { + Log.d(TAG, "Wrong note type with type:" + type); + } + } while (cursor.moveToNext()); + } + cursor.close(); + } else { + Log.e(TAG, "No data with id:" + mNoteId); + throw new IllegalArgumentException("Unable to find note's data with id " + mNoteId); + } + } + + // 创建一个新的空笔记的静态方法 + 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); + return note; + } + + // 加载一个已存在笔记的静态方法 + public static WorkingNote load(Context context, long id) { + return new WorkingNote(context, id, 0); + } + + // 保存笔记的方法,将笔记的更改同步到数据库,并根据情况更新小部件内容 + public synchronized boolean saveNote() { + if (isWorthSaving()) { + if (!existInDatabase()) { + // 如果笔记不存在于数据库中,创建一个新的笔记 ID + if ((mNoteId = Note.getNewNoteId(mContext, mFolderId)) == 0) { + Log.e(TAG, "Create new note fail with id:" + mNoteId); + return false; + } + } + + // 同步笔记数据到数据库 + mNote.syncNote(mContext, mNoteId); + + /** + * 如果存在与该笔记相关的小部件,并且小部件 ID 和类型有效,同时设置了监听器,则通知监听器小部件内容已更改 + */ + if (mWidgetId!= AppWidgetManager.INVALID_APPWIDGET_ID + && mWidgetType!= Notes.TYPE_WIDGET_INVALIDE + && mNoteSettingStatusListener!= null) { + mNoteSettingStatusListener.onWidgetChanged(); + } + return true; + } else { + return false; + } + } + + // 检查笔记是否存在于数据库中的方法 + public boolean existInDatabase() { + return mNoteId > 0; + } + + // 检查笔记是否值得保存的方法,根据笔记的删除状态、内容和本地修改情况进行判断 + private boolean isWorthSaving() { + if (mIsDeleted || (!existInDatabase() && TextUtils.isEmpty(mContent)) + || (existInDatabase() &&!mNote.isLocalModified())) { + return false; + } else { + return true; + } + } + + // 设置笔记设置更改监听器的方法 + public void setOnSettingStatusChangedListener(NoteSettingChangedListener l) { + mNoteSettingStatusListener = l; + } + + // 设置笔记提醒日期的方法,同时更新笔记的属性值并通知监听器 + public void setAlertDate(long date, boolean set) { + if (date!= mAlertDate) { + mAlertDate = date; + mNote.setNoteValue(NoteColumns.ALERTED_DATE, String.valueOf(mAlertDate)); + } + if (mNoteSettingStatusListener!= null) { + mNoteSettingStatusListener.onClockAlertChanged(date, set); + } + } + + // 标记笔记为已删除或未删除的方法,同时更新笔记的状态并通知监听器 + public void markDeleted(boolean mark) { + mIsDeleted = mark; + if (mWidgetId!= AppWidgetManager.INVALID_APPWIDGET_ID + && mWidgetType!= Notes.TYPE_WIDGET_INVALIDE && mNoteSettingStatusListener!= null) { + mNoteSettingStatusListener.onWidgetChanged(); + } + } + + // 设置笔记背景颜色 ID 的方法,同时更新笔记的属性值并通知监听器 + public void setBgColorId(int id) { + if (id!= mBgColorId) { + mBgColorId = id; + if (mNoteSettingStatusListener!= null) { + mNoteSettingStatusListener.onBackgroundColorChanged(); + } + mNote.setNoteValue(NoteColumns.BG_COLOR_ID, String.valueOf(id)); + } + } + + // 设置笔记检查列表模式的方法,同时更新笔记的属性值并通知监听器 + public void setCheckListMode(int mode) { + if (mMode!= mode) { + if (mNoteSettingStatusListener!= null) { + mNoteSettingStatusListener.onCheckListModeChanged(mMode, mode); + } + mMode = mode; + mNote.setTextData(TextNote.MODE, String.valueOf(mMode)); + } + } + + // 设置笔记小部件类型的方法,同时更新笔记的属性值 + public void setWidgetType(int type) { + if (type!= mWidgetType) { + mWidgetType = type; + mNote.setNoteValue(NoteColumns.WIDGET_TYPE, String.valueOf(mWidgetType)); + } + } + + // 设置笔记小部件 ID 的方法,同时更新笔记的属性值 + public void setWidgetId(int id) { + if (id!= mWidgetId) { + mWidgetId = id; + mNote.setNoteValue(NoteColumns.WIDGET_ID, String.valueOf(mWidgetId)); + } + } + + // 设置笔记内容的方法,同时更新笔记的文本数据 + public void setWorkingText(String text) { + if (!TextUtils.equals(mContent, text)) { + mContent = text; + mNote.setTextData(DataColumns.CONTENT, mContent); + } + } + + // 将笔记转换为通话笔记的方法,设置通话相关的数据和笔记的父文件夹 ID + 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); + } + + // 获取笔记内容的方法 + public String getContent() { + return mContent; + } + + // 获取笔记提醒日期的方法 + public long getAlertDate() { + return mAlertDate; + } + + // 获取笔记最后修改日期的方法 + 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); + } + + // 获取笔记检查列表模式的方法 + public int getCheckListMode() { + return mMode; + } + + // 获取笔记 ID 的方法 + public long getNoteId() { + return mNoteId; + } + + // 获取笔记所属文件夹 ID 的方法 + public long getFolderId() { + return mFolderId; + } + + // 获取笔记小部件 ID 的方法 + public int getWidgetId() { + return mWidgetId; + } + + // 获取笔记小部件类型的方法 + public int getWidgetType() { + return mWidgetType; + } + + // 笔记设置更改监听器接口,定义了在笔记属性更改时需要调用的方法 + public interface NoteSettingChangedListener { + /** + * 当笔记的背景颜色更改时调用 + */ + void onBackgroundColorChanged(); + + /** + * 当用户设置闹钟提醒时调用 + */ + void onClockAlertChanged(long date, boolean set); + + /** + * 当用户从小部件创建笔记时调用 + */ + void onWidgetChanged(); + + /** + * 当在检查列表模式和普通模式之间切换时调用 + * @param oldMode 是切换前的模式 + * @param newMode 是切换后的模式 + */ + void onCheckListModeChanged(int oldMode, int newMode); + } +} \ No newline at end of file