From 895864363ca75b2512a5b87a18785928e9839b33 Mon Sep 17 00:00:00 2001 From: yangyixin <2686858302@qq.com> Date: Mon, 19 May 2025 00:26:32 +0800 Subject: [PATCH] three --- src/model/WorkingNote.java | 270 +++++++++++++++++++++++++++++-------- 1 file changed, 215 insertions(+), 55 deletions(-) diff --git a/src/model/WorkingNote.java b/src/model/WorkingNote.java index be081e4..358e2d4 100644 --- a/src/model/WorkingNote.java +++ b/src/model/WorkingNote.java @@ -1,19 +1,3 @@ -/* - * Copyright (c) 2010-2011, The MiCode Open Source Community (www.micode.net) - * - * Licensed under the Apache License, Version 2.0 (the "License"); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - */ - package net.micode.notes.model; import android.appwidget.AppWidgetManager; @@ -31,37 +15,42 @@ 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 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[] { DataColumns.ID, DataColumns.CONTENT, @@ -72,6 +61,7 @@ public class WorkingNote { DataColumns.DATA4, }; + // 查询笔记列的投影 public static final String[] NOTE_PROJECTION = new String[] { NoteColumns.PARENT_ID, NoteColumns.ALERTED_DATE, @@ -81,27 +71,26 @@ public class WorkingNote { NoteColumns.MODIFIED_DATE }; + // 数据列索引常量 private static final int DATA_ID_COLUMN = 0; - private static final int DATA_CONTENT_COLUMN = 1; - private static final int DATA_MIME_TYPE_COLUMN = 2; - private static final int DATA_MODE_COLUMN = 3; + // 笔记列索引常量 private static final int NOTE_PARENT_ID_COLUMN = 0; - private static final int NOTE_ALERTED_DATE_COLUMN = 1; - private static final int NOTE_BG_COLOR_ID_COLUMN = 2; - 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 + /** + * 私有构造函数，用于创建新笔记 + * + * @param context 应用上下文 + * @param folderId 文件夹ID + */ private WorkingNote(Context context, long folderId) { mContext = context; mAlertDate = 0; @@ -114,7 +103,13 @@ public class WorkingNote { mWidgetType = Notes.TYPE_WIDGET_INVALIDE; } - // Existing note construct + /** + * 私有构造函数，用于加载现有笔记 + * + * @param context 应用上下文 + * @param noteId 笔记ID + * @param folderId 文件夹ID + */ private WorkingNote(Context context, long noteId, long folderId) { mContext = context; mNoteId = noteId; @@ -124,13 +119,18 @@ public class WorkingNote { 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); @@ -140,13 +140,18 @@ public class WorkingNote { } cursor.close(); } else { - Log.e(TAG, "No note with id:" + mNoteId); - throw new IllegalArgumentException("Unable to find note with id " + mNoteId); + Log.e(TAG, "未找到ID为" + mNoteId + "的笔记"); + throw new IllegalArgumentException("无法找到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) @@ -154,26 +159,39 @@ public class WorkingNote { if (cursor != null) { if (cursor.moveToFirst()) { + // 读取笔记数据 do { 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); mNote.setTextDataId(cursor.getLong(DATA_ID_COLUMN)); } else if (DataConstants.CALL_NOTE.equals(type)) { + // 通话记录数据 mNote.setCallDataId(cursor.getLong(DATA_ID_COLUMN)); } else { - Log.d(TAG, "Wrong note type with type:" + type); + Log.d(TAG, "未知的笔记类型:" + 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); + Log.e(TAG, "未找到ID为" + mNoteId + "的笔记数据"); + throw new IllegalArgumentException("无法找到ID为" + mNoteId + "的笔记数据"); } } + /** + * 创建一个空笔记 + * + * @param context 应用上下文 + * @param folderId 文件夹ID + * @param widgetId 小部件ID + * @param widgetType 小部件类型 + * @param defaultBgColorId 默认背景色ID + * @return 新创建的WorkingNote对象 + */ public static WorkingNote createEmptyNote(Context context, long folderId, int widgetId, int widgetType, int defaultBgColorId) { WorkingNote note = new WorkingNote(context, folderId); @@ -183,23 +201,37 @@ public class WorkingNote { return note; } + /** + * 从数据库加载指定ID的笔记 + * + * @param context 应用上下文 + * @param id 笔记ID + * @return 加载的WorkingNote对象 + */ public static WorkingNote load(Context context, long id) { return new WorkingNote(context, id, 0); } + /** + * 同步保存笔记到数据库 + * + * @return 保存成功返回true，失败返回false + */ 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); + Log.e(TAG, "创建新笔记失败，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 +244,24 @@ public class WorkingNote { } } + /** + * 检查笔记是否已存在于数据库中 + * + * @return 存在返回true，否则返回false + */ public boolean existInDatabase() { return mNoteId > 0; } + /** + * 判断笔记是否值得保存 + * 以下情况不值得保存： + * 1. 笔记已被标记为删除 + * 2. 新笔记且内容为空 + * 3. 已存在的笔记但没有修改 + * + * @return 值得保存返回true，否则返回false + */ private boolean isWorthSaving() { if (mIsDeleted || (!existInDatabase() && TextUtils.isEmpty(mContent)) || (existInDatabase() && !mNote.isLocalModified())) { @@ -225,10 +271,21 @@ public class WorkingNote { } } + /** + * 设置笔记设置变更监听器 + * + * @param l 监听器对象 + */ public void setOnSettingStatusChangedListener(NoteSettingChangedListener l) { mNoteSettingStatusListener = l; } + /** + * 设置提醒日期 + * + * @param date 提醒日期时间戳 + * @param set 是否设置提醒 + */ public void setAlertDate(long date, boolean set) { if (date != mAlertDate) { mAlertDate = date; @@ -239,6 +296,11 @@ public class WorkingNote { } } + /** + * 标记笔记为已删除或未删除 + * + * @param mark true表示标记为删除，false表示未删除 + */ public void markDeleted(boolean mark) { mIsDeleted = mark; if (mWidgetId != AppWidgetManager.INVALID_APPWIDGET_ID @@ -247,6 +309,11 @@ public class WorkingNote { } } + /** + * 设置笔记背景色 + * + * @param id 背景色ID + */ public void setBgColorId(int id) { if (id != mBgColorId) { mBgColorId = id; @@ -257,6 +324,11 @@ public class WorkingNote { } } + /** + * 设置笔记模式（普通文本或待办列表） + * + * @param mode 模式值 + */ public void setCheckListMode(int mode) { if (mMode != mode) { if (mNoteSettingStatusListener != null) { @@ -267,6 +339,11 @@ public class WorkingNote { } } + /** + * 设置小部件类型 + * + * @param type 小部件类型 + */ public void setWidgetType(int type) { if (type != mWidgetType) { mWidgetType = type; @@ -274,6 +351,11 @@ public class WorkingNote { } } + /** + * 设置小部件ID + * + * @param id 小部件ID + */ public void setWidgetId(int id) { if (id != mWidgetId) { mWidgetId = id; @@ -281,6 +363,11 @@ public class WorkingNote { } } + /** + * 设置笔记文本内容 + * + * @param text 文本内容 + */ public void setWorkingText(String text) { if (!TextUtils.equals(mContent, text)) { mContent = text; @@ -288,81 +375,154 @@ public class WorkingNote { } } + /** + * 将笔记转换为通话记录笔记 + * + * @param phoneNumber 电话号码 + * @param 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)); } + /** + * 检查笔记是否设置了提醒 + * + * @return 设置了提醒返回true，否则返回false + */ public boolean hasClockAlert() { return (mAlertDate > 0 ? true : false); } + /** + * 获取笔记内容 + * + * @return 笔记内容字符串 + */ public String getContent() { return mContent; } + /** + * 获取提醒日期 + * + * @return 提醒日期时间戳 + */ public long getAlertDate() { return mAlertDate; } + /** + * 获取修改日期 + * + * @return 修改日期时间戳 + */ public long getModifiedDate() { return mModifiedDate; } + /** + * 获取背景色资源ID + * + * @return 背景色资源ID + */ public int getBgColorResId() { return NoteBgResources.getNoteBgResource(mBgColorId); } + /** + * 获取背景色ID + * + * @return 背景色ID + */ public int getBgColorId() { return mBgColorId; } + /** + * 获取标题背景资源ID + * + * @return 标题背景资源ID + */ public int getTitleBgResId() { return NoteBgResources.getNoteTitleBgResource(mBgColorId); } + /** + * 获取笔记模式 + * + * @return 笔记模式值 + */ public int getCheckListMode() { return mMode; } + /** + * 获取笔记ID + * + * @return 笔记ID + */ public long getNoteId() { return mNoteId; } + /** + * 获取文件夹ID + * + * @return 文件夹ID + */ public long getFolderId() { return mFolderId; } + /** + * 获取小部件ID + * + * @return 小部件ID + */ public int getWidgetId() { return mWidgetId; } + /** + * 获取小部件类型 + * + * @return 小部件类型 + */ public int getWidgetType() { return mWidgetType; } + /** + * 笔记设置变更监听器接口 + */ public interface NoteSettingChangedListener { /** - * Called when the background color of current note has just changed + * 当笔记背景色改变时调用 */ void onBackgroundColorChanged(); /** - * Called when user set clock + * 当用户设置或取消提醒时调用 + * + * @param date 提醒日期 + * @param set 是否设置提醒 */ 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 切换后的模式 */ void onCheckListModeChanged(int oldMode, int newMode); } -} +} \ No newline at end of file