p7tupf26b
/
git
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
Labels Milestones
New Pull Request

添加部分注释 #5

Merged
mbls3xqnp merged 10 commits from develop into master 3 weeks ago
Conversation 0 Commits 10 Files Changed 2
2 changed files with 238 additions and 22 deletions
Show Stats Download Patch File Download Diff File

BIN
doc/小米便签泛读报告.docx
View File

Binary file not shown.

260
src/Notes-master/src/net/micode/notes/model/WorkingNote.java
Unescape View File

@ -124,99 +124,202 @@ public class WorkingNote {
loadNote();
}
/**
* 从数据库加载笔记的基本属性信息
*
* 该方法根据笔记ID从数据库中查询并加载笔记的基本属性，包括所属文件夹、背景颜色、
* 小部件信息、提醒日期和修改日期等。加载完基本属性后，会调用loadNoteData()方法
* 加载笔记的具体内容数据。
*
* @throws IllegalArgumentException 当找不到指定ID的笔记时抛出此异常
*/
private void loadNote() {
// 构建查询URI，通过笔记ID定位特定的笔记记录
// 使用NOTE_PROJECTION指定需要查询的列（父文件夹ID、提醒日期、背景颜色ID等）
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);
// 从查询结果中提取笔记的基本属性并赋值给相应的成员变量
mFolderId = cursor.getLong(NOTE_PARENT_ID_COLUMN); // 获取笔记所属文件夹的ID
mBgColorId = cursor.getInt(NOTE_BG_COLOR_ID_COLUMN); // 获取笔记背景颜色ID
mWidgetId = cursor.getInt(NOTE_WIDGET_ID_COLUMN); // 获取关联的小部件ID
mWidgetType = cursor.getInt(NOTE_WIDGET_TYPE_COLUMN); // 获取小部件类型
mAlertDate = cursor.getLong(NOTE_ALERTED_DATE_COLUMN); // 获取提醒日期
mModifiedDate = cursor.getLong(NOTE_MODIFIED_DATE_COLUMN); // 获取最后修改日期
}
cursor.close();
cursor.close(); // 关闭游标，释放资源
} else {
// 如果查询结果为空，记录错误日志并抛出异常
Log.e(TAG, "No note with id:" + mNoteId);
throw new IllegalArgumentException("Unable to find note with id " + mNoteId);
}
// 加载笔记的具体内容数据（文本内容、通话记录等）
loadNoteData();
}
/**
* 与loadNote()方法相似，loadNoteData()方法专门用于加载笔记的具体内容数据
* 从数据库中加载指定笔记ID的所有相关数据，包括文本内容和通话记录等
*/
private void loadNoteData() {
// 通过ContentResolver查询数据库，获取指定笔记ID的数据
// Notes.CONTENT_DATA_URI: 指向数据表的URI，格式为"content://micode_notes/data"
// DATA_PROJECTION: 指定要查询的列，包括ID、内容、MIME类型、DATA1-DATA4等字段
// DataColumns.NOTE_ID + "=?": 查询条件，筛选note_id等于指定值的记录
// new String[] { String.valueOf(mNoteId) }: 查询参数，将mNoteId转换为字符串作为查询条件的值
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类型，用于区分不同类型的数据
String type = cursor.getString(DATA_MIME_TYPE_COLUMN);
// 如果是普通文本笔记类型
if (DataConstants.NOTE.equals(type)) {
// 获取笔记的文本内容
mContent = cursor.getString(DATA_CONTENT_COLUMN);
// 获取笔记的显示模式（普通模式或清单模式）
mMode = cursor.getInt(DATA_MODE_COLUMN);
// 设置文本数据的ID，用于后续更新操作
mNote.setTextDataId(cursor.getLong(DATA_ID_COLUMN));
} else if (DataConstants.CALL_NOTE.equals(type)) {
}
// 如果是通话记录笔记类型
else if (DataConstants.CALL_NOTE.equals(type)) {
// 设置通话记录数据的ID
mNote.setCallDataId(cursor.getLong(DATA_ID_COLUMN));
} else {
}
// 如果是未知类型，记录调试信息
else {
Log.d(TAG, "Wrong note type with type:" + type);
}
} while (cursor.moveToNext());
} while (cursor.moveToNext()); // 移动到下一条记录，直到遍历完所有记录
}
// 关闭游标，释放资源
cursor.close();
} else {
// 如果查询结果为空，记录错误日志
Log.e(TAG, "No data with id:" + mNoteId);
// 抛出异常，表示无法找到指定ID的笔记数据
throw new IllegalArgumentException("Unable to find note's data with id " + mNoteId);
}
}
/**
* 创建一个空的笔记对象
*
* 此方法用于初始化一个新的空白笔记，设置基本属性但不包含任何内容。
* 新创建的笔记对象可以用于后续的编辑和保存操作。
*
* @param context 上下文对象，用于访问系统资源和服务
* @param folderId 笔记所属的文件夹ID，用于确定笔记的存储位置
* @param widgetId 关联的桌面小部件ID，如果笔记与桌面小部件关联则使用此ID
* @param widgetType 小部件类型，定义小部件的显示方式和功能
* @param defaultBgColorId 默认背景颜色ID，设置笔记的初始背景颜色
* @return 返回新创建的WorkingNote对象，包含基本属性但内容为空
*/
public static WorkingNote createEmptyNote(Context context, long folderId, int widgetId,
int widgetType, int defaultBgColorId) {
// 创建一个新的WorkingNote实例，指定上下文和所属文件夹
WorkingNote note = new WorkingNote(context, folderId);
// 设置笔记的背景颜色ID
note.setBgColorId(defaultBgColorId);
// 设置关联的桌面小部件ID
note.setWidgetId(widgetId);
// 设置小部件类型
note.setWidgetType(widgetType);
// 返回创建的笔记对象
return note;
}
/**
* 从数据库加载指定ID的笔记
*
* 此方法是一个工厂方法，用于从数据库中加载已存在的笔记数据。
* 它会创建一个新的WorkingNote实例，并自动调用loadNote()方法从数据库中
* 加载笔记的所有属性和内容数据。
*
* @param context 上下文对象，用于访问系统资源和服务
* @param id 要加载的笔记的ID，必须是数据库中已存在的笔记ID
* @return 返回一个包含完整笔记数据的WorkingNote对象
* @throws IllegalArgumentException 如果找不到指定ID的笔记，构造函数内部会抛出此异常
*/
public static WorkingNote load(Context context, long id) {
// 创建一个新的WorkingNote实例，传入笔记ID和文件夹ID(0表示不指定)
// 构造函数会自动调用loadNote()方法从数据库加载笔记数据
return new WorkingNote(context, id, 0);
}
/**
* 保存笔记到数据库
*
* 此方法用于将当前笔记对象保存到数据库中。如果是新笔记，会先分配一个ID；
* 如果是已存在的笔记，会更新其内容。方法使用synchronized关键字确保线程安全。
*
* @return 保存成功返回true，否则返回false
*/
public synchronized boolean saveNote() {
// 检查笔记是否值得保存（非空内容或已修改）
if (isWorthSaving()) {
// 如果笔记在数据库中不存在（新笔记），则需要先获取一个新的笔记ID
if (!existInDatabase()) {
// 调用Note.getNewNoteId()方法获取一个新的笔记ID
// 如果获取失败（返回0），记录错误日志并返回false
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
*/
// 如果笔记关联了桌面小部件，则更新小部件显示内容
// 检查条件：小部件ID有效、小部件类型有效、状态监听器不为空
if (mWidgetId != AppWidgetManager.INVALID_APPWIDGET_ID
&& mWidgetType != Notes.TYPE_WIDGET_INVALIDE
&& mNoteSettingStatusListener != null) {
// 通知监听器小部件内容已更改，需要更新显示
mNoteSettingStatusListener.onWidgetChanged();
}
// 保存成功，返回true
return true;
} else {
// 笔记不值得保存（空内容且未修改），返回false
return false;
}
}
/**
* 检查笔记是否已存在于数据库中
*
* @return 如果笔记已存在于数据库中返回true，否则返回false
*/
public boolean existInDatabase() {
// 通过检查笔记ID是否大于0来判断笔记是否已保存到数据库
// 新笔记的mNoteId初始值为0，保存成功后会被分配一个正整数ID
return mNoteId > 0;
}
/**
* 检查笔记是否值得保存（非空内容或已修改）
*
* @return 如果笔记值得保存（非空内容或已修改）返回true，否则返回false
*/
private boolean isWorthSaving() {
// 检查笔记是否已被删除、是否为空内容（新笔记）、是否已修改（已存在笔记）
if (mIsDeleted || (!existInDatabase() && TextUtils.isEmpty(mContent))
|| (existInDatabase() && !mNote.isLocalModified())) {
return false;
@ -225,44 +328,138 @@ public class WorkingNote {
}
}
/**
* 设置笔记设置状态变化监听器
*
* 此方法用于注册一个监听器对象，当笔记的各种设置（如背景颜色、提醒时间、
* 小部件状态等）发生变化时，会通知该监听器以便进行相应的处理。
*
* 这是观察者模式的应用，允许外部对象监听WorkingNote内部状态的变化，
* 实现了数据模型与UI之间的解耦。当笔记设置发生变化时，UI组件可以
* 通过监听器收到通知并及时更新显示。
*
* @param l 实现了NoteSettingChangedListener接口的监听器对象，
* 如果传入null则表示取消之前的监听器
*/
public void setOnSettingStatusChangedListener(NoteSettingChangedListener l) {
// 将传入的监听器对象保存到成员变量中
// 当笔记设置发生变化时，会调用该监听器的相应方法
mNoteSettingStatusListener = l;
}
/**
* 设置笔记的提醒日期
*
* 此方法用于设置或取消笔记的提醒日期。当用户为笔记设置提醒时间时，
* 系统会在指定时间显示通知。方法会更新笔记对象的提醒日期属性，
* 并将更改同步到数据库中。
*
* @param date 提醒日期的时间戳（毫秒），如果为0表示取消提醒
* @param set 布尔值，表示是否设置提醒（true）还是取消提醒（false）
*/
public void setAlertDate(long date, boolean set) {
// 检查新的提醒日期是否与当前日期不同
if (date != mAlertDate) {
// 更新笔记对象的提醒日期
mAlertDate = date;
// 将新的提醒日期同步到数据库中
// NoteColumns.ALERTED_DATE 是数据库中存储提醒日期的字段名
mNote.setNoteValue(NoteColumns.ALERTED_DATE, String.valueOf(mAlertDate));
}
// 如果有注册的状态变化监听器，则通知它提醒日期已更改
// 这样UI组件可以及时更新显示，如显示或隐藏提醒图标
if (mNoteSettingStatusListener != null) {
// 调用监听器的onClockAlertChanged方法，传入新的日期和设置状态
mNoteSettingStatusListener.onClockAlertChanged(date, set);
}
}
/**
* 标记笔记为已删除状态
*
* 此方法用于将笔记标记为已删除或取消删除状态。被标记为删除的笔记
* 在下次保存操作时会被从数据库中物理删除。这是一种软删除机制，
* 允许用户在确认删除前有机会恢复笔记。
*
* 如果笔记关联了桌面小部件，删除标记会触发小部件内容的更新，
* 以确保小部件显示与笔记状态保持一致。
*
* @param mark 布尔值，true表示标记为已删除，false表示取消删除标记
*/
public void markDeleted(boolean mark) {
// 设置笔记的删除标记状态
mIsDeleted = mark;
// 如果笔记关联了有效的桌面小部件且有注册的状态监听器
// AppWidgetManager.INVALID_APPWIDGET_ID 表示无效的小部件ID
// Notes.TYPE_WIDGET_INVALIDE 表示无效的小部件类型
if (mWidgetId != AppWidgetManager.INVALID_APPWIDGET_ID
&& mWidgetType != Notes.TYPE_WIDGET_INVALIDE && mNoteSettingStatusListener != null) {
// 通知监听器小部件内容已更改，需要更新显示
// 这样可以确保桌面小部件反映笔记的删除状态
mNoteSettingStatusListener.onWidgetChanged();
}
}
/**
* 设置笔记的背景颜色ID
*
* 与setAlertDate结构相似，此方法用于更改笔记的背景颜色。应用中预定义了多种背景颜色，
* 每种颜色对应一个唯一的ID。当用户选择不同的背景颜色时，
* 此方法会被调用来更新笔记的显示效果。
*
* 背景颜色变化会触发UI更新，确保用户界面立即反映新的颜色设置。
* 同时，新的颜色ID会被保存到数据库中，以便在应用重启后
* 能够恢复笔记的背景颜色设置。
*
* @param id 背景颜色的ID，对应应用中预定义的颜色资源
*/
public void setBgColorId(int id) {
// 检查新的背景颜色ID是否与当前ID不同
if (id != mBgColorId) {
// 更新笔记对象的背景颜色ID
mBgColorId = id;
// 如果有注册的状态变化监听器，则通知它背景颜色已更改
// 这样UI组件可以及时更新显示，反映新的背景颜色
if (mNoteSettingStatusListener != null) {
mNoteSettingStatusListener.onBackgroundColorChanged();
}
// 将新的背景颜色ID同步到数据库中
// NoteColumns.BG_COLOR_ID 是数据库中存储背景颜色ID的字段名
mNote.setNoteValue(NoteColumns.BG_COLOR_ID, String.valueOf(id));
}
}
/**
* 设置笔记的清单模式
*
* 此方法用于切换笔记的显示模式，支持普通文本模式和清单模式两种。
* 在清单模式下，笔记内容会被解析为可勾选的任务列表，每行文本
* 前会显示复选框，用户可以勾选或取消勾选任务项。
*
* 模式切换会触发UI更新，确保用户界面立即反映新的显示模式。
* 同时，新的模式值会被保存到数据库中，以便在应用重启后
* 能够恢复笔记的显示模式设置。
*
* @param mode 笔记的显示模式，值为预定义的模式常量
*/
public void setCheckListMode(int mode) {
// 检查新的模式是否与当前模式不同
if (mMode != mode) {
// 如果有注册的状态变化监听器，则通知它清单模式已更改
// 传入旧模式和新模式作为参数，以便UI可以进行适当的过渡处理
if (mNoteSettingStatusListener != null) {
mNoteSettingStatusListener.onCheckListModeChanged(mMode, mode);
}
// 更新笔记对象的模式值
mMode = mode;
// 将新的模式值同步到数据库中
// TextNote.MODE 是数据库中存储笔记模式的字段名
mNote.setTextData(TextNote.MODE, String.valueOf(mMode));
}
}
@ -342,26 +539,45 @@ public class WorkingNote {
return mWidgetType;
}
/**
* 笔记设置状态变化监听器接口
*
* 该接口定义了四个回调方法，用于监听笔记各项设置的变化，并在变化发生时通知UI组件进行相应更新。
* 实现该接口的类可以实时响应笔记设置的修改，如背景颜色、提醒时间、小部件内容和显示模式等。
*/
public interface NoteSettingChangedListener {
/**
* Called when the background color of current note has just changed
* 当笔记背景颜色改变时调用
*
* 实现类应在此方法中更新UI以反映新的背景颜色，通常包括更新编辑器面板和标题面板的背景。
*/
void onBackgroundColorChanged();
/**
* Called when user set clock
* 当设置或取消时钟提醒时调用
*
* @param date 提醒时间戳，0表示取消提醒
* @param set true表示设置提醒，false表示取消提醒
*
* 实现类应在此方法中处理系统闹钟的设置或取消，通常使用AlarmManager和PendingIntent。
*/
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
* 当切换清单模式与普通模式时调用
*
* @param oldMode 切换前的模式
* @param newMode 切换后的模式
*
* 实现类应在此方法中根据模式切换显示不同的UI组件，普通模式显示文本编辑器，
* 清单模式显示可勾选的列表视图。
*/
void onCheckListModeChanged(int oldMode, int newMode);
}

Write Preview
Loading…
Cancel
Save