diff --git a/Note.java b/Note.java new file mode 100644 index 0000000..27b9dab --- /dev/null +++ b/Note.java @@ -0,0 +1,382 @@ +/* + * 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.content.ContentProviderOperation; +import android.content.ContentProviderResult; +import android.content.ContentUris; +import android.content.ContentValues; +import android.content.Context; +import android.content.OperationApplicationException; +import android.net.Uri; +import android.os.RemoteException; +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.NoteColumns; +import net.micode.notes.data.Notes.TextNote; + +import java.util.ArrayList; + +/* + * Note 类用于管理笔记的创建、更新和同步。 + * 该类提供了创建新笔记、设置笔记内容、同步笔记等功能。 + */ +public class Note { + private ContentValues mNoteDiffValues; + private NoteData mNoteData; + private static final String TAG = "Note"; + /** + * Create a new note id for adding a new note to databases + */ + /* + * 创建一个新的笔记 ID，用于将新笔记添加到数据库中。 + * + * @param context 应用程序上下文 + * @param folderId 文件夹 ID + * @return 新创建的笔记 ID + */ + public static synchronized long getNewNoteId(Context context, long folderId) { + // Create a new note in the database + // 创建一个新的笔记到数据库中 + ContentValues values = new ContentValues(); + //创建一个新的 ContentValues 对象，用于存储笔记的初始值。 + long createdTime = System.currentTimeMillis(); + //获取当前时间戳，作为笔记的创建时间和修改时间。 + values.put(NoteColumns.CREATED_DATE, createdTime); + //将创建时间存储到 ContentValues 对象中。 + values.put(NoteColumns.MODIFIED_DATE, createdTime); + //将修改时间存储到 ContentValues 对象中。 + values.put(NoteColumns.TYPE, Notes.TYPE_NOTE); + //将笔记类型存储到 ContentValues 对象中。 + values.put(NoteColumns.LOCAL_MODIFIED, 1); + //将本地修改标志设置为 1，表示笔记已被修改。 + values.put(NoteColumns.PARENT_ID, folderId); + //将文件夹 ID 存储到 ContentValues 对象中。 + Uri uri = context.getContentResolver().insert(Notes.CONTENT_NOTE_URI, values); + //将 ContentValues 对象插入到数据库中，并返回新创建笔记的 URI。 + long noteId = 0;//初始化笔记 ID 变量。 + try { + //尝试从 URI 中获取笔记 ID。如果发生 NumberFormatException 异常，则记录错误日志，并将笔记 ID 设置为 0。 + noteId = Long.valueOf(uri.getPathSegments().get(1)); + } catch (NumberFormatException e) { + Log.e(TAG, "Get note id error :" + e.toString()); + noteId = 0; + } + if (noteId == -1) { + //检查笔记 ID 是否为 -1。如果为 -1，则抛出 IllegalStateException 异常。 + throw new IllegalStateException("Wrong note id:" + noteId); + } + return noteId;//返回新创建的笔记 ID。 + } +/* + * 构造函数，初始化笔记的差异值和笔记数据。 + */ + public Note() { + //// 初始化笔记的差异值 + mNoteDiffValues = new ContentValues(); + // // 初始化笔记数据 + mNoteData = new NoteData(); + } +/* + * 设置笔记的差异值。 + * @param key 键 + * @param value 值 + */ + public void setNoteValue(String key, String value) { + // 将键值对存储到笔记的差异值中 + mNoteDiffValues.put(key, value); + // 设置本地修改标志为 1，表示笔记已被修改 + mNoteDiffValues.put(NoteColumns.LOCAL_MODIFIED, 1); + // 设置修改时间为当前时间 + mNoteDiffValues.put(NoteColumns.MODIFIED_DATE, System.currentTimeMillis()); + } +/* + * 设置笔记的文本数据。 + * @param key 键 + * @param value 值 + */ + public void setTextData(String key, String value) { + // 调用 NoteData 类的 setTextData 方法，设置文本数据 + mNoteData.setTextData(key, value); + } +/* + * 设置笔记的文本数据 ID。 + * @param id 文本数据 ID + */ + public void setTextDataId(long id) { + // 调用 NoteData 类的 setTextDataId 方法，设置文本数据 ID + mNoteData.setTextDataId(id); + } +/* + * 获取笔记的文本数据 ID。 + * @return 文本数据 ID + */ + public long getTextDataId() { + // 返回 NoteData 类的 mTextDataId 字段 + return mNoteData.mTextDataId; + } +/* + * 设置笔记的通话数据 ID。 + * @param id 通话数据 ID + */ + public void setCallDataId(long id) { + // 调用 NoteData 类的 setCallDataId 方法，设置通话数据 ID + mNoteData.setCallDataId(id); + } +/* + * 设置调用数据的方法。 + * 该方法接受两个参数：一个键和一个值，并将它们传递给 `mNoteData` 对象的 `setCallData` 方法。 + * @param key 用于存储数据的键。 + * @param value 与键关联的值。 + */ + public void setCallData(String key, String value) { + //调用 `mNoteData` 对象的 `setCallData` 方法，并将 `key` 和 `value` 作为参数传递。 + mNoteData.setCallData(key, value); + } +/* + * 检查是否有本地修改的方法。 + * 该方法返回一个布尔值，指示是否有本地修改。如果有本地修改，则返回 true；否则返回 false。 + * 本地修改的判断基于两个条件： + * 1. `mNoteDiffValues` 集合的大小是否大于 0。 + * 2. `mNoteData` 对象是否报告本地修改。 + * @return 如果有本地修改，则返回 true；否则返回 false。 + */ + public boolean isLocalModified() { + // 检查 `mNoteDiffValues` 集合的大小是否大于 0，或者 `mNoteData` 对象是否报告本地修改。 + return mNoteDiffValues.size() > 0 || mNoteData.isLocalModified(); + } +/* + * 同步笔记的方法。 + * 该方法用于将本地修改的笔记数据同步到内容提供者中。 + * @param context 应用程序上下文。 + * @param noteId 笔记的唯一标识符。 + * @return 如果同步成功，则返回 true；否则返回 false。 + * @throws IllegalArgumentException 如果 noteId 小于或等于 0，则抛出此异常。 + */ + public boolean syncNote(Context context, long noteId) { + /// 检查 noteId 是否有效，如果无效则抛出异常。 + if (noteId <= 0) { + throw new IllegalArgumentException("Wrong note id:" + noteId); + } + // 如果没有本地修改，则直接返回 true。 + if (!isLocalModified()) { + return true; + } + + /** + * In theory, once data changed, the note should be updated on {@link NoteColumns#LOCAL_MODIFIED} and + * {@link NoteColumns#MODIFIED_DATE}. For data safety, though update note fails, we also update the + * note data info + * 理论上，一旦数据发生变化，笔记应该在 {@link NoteColumns#LOCAL_MODIFIED} 和 + * {@link NoteColumns#MODIFIED_DATE} 上更新。为了数据安全，即使更新笔记失败，我们也会更新笔记数据信息。 + */ + // 尝试更新笔记数据。 + if (context.getContentResolver().update( + ContentUris.withAppendedId(Notes.CONTENT_NOTE_URI, noteId), mNoteDiffValues, null, + null) == 0) { + // 如果更新失败，记录错误日志。 + Log.e(TAG, "Update note error, should not happen"); + // Do not return, fall through + // 不返回，继续执行。 + } + // 清空 mNoteDiffValues 集合。 + mNoteDiffValues.clear(); + // 如果 mNoteData 有本地修改，并且推送数据到内容提供者失败，则返回 false。 + if (mNoteData.isLocalModified() + && (mNoteData.pushIntoContentResolver(context, noteId) == null)) { + return false; + } + // 如果所有操作成功，则返回 true。 + return true; + } +/* + * 笔记数据类，用于管理笔记的文本数据和通话数据。 + */ + private class NoteData { + private long mTextDataId;// 文本数据的唯一标识符 + + private ContentValues mTextDataValues;// 文本数据的 ContentValues 对象 + + private long mCallDataId; // 通话数据的唯一标识符 + + private ContentValues mCallDataValues; // 通话数据的 ContentValues 对象 + + private static final String TAG = "NoteData";// 日志标签 +/* + * 构造函数，初始化文本数据和通话数据的 ContentValues 对象，并将数据 ID 设置为 0。 + */ + public NoteData() { + mTextDataValues = new ContentValues(); + mCallDataValues = new ContentValues(); + mTextDataId = 0; + mCallDataId = 0; + } +/* + * 检查是否有本地修改的方法。 + * @return 如果有本地修改，则返回 true；否则返回 false。 + */ + boolean isLocalModified() { + return mTextDataValues.size() > 0 || mCallDataValues.size() > 0; + } +/* + * 设置文本数据的唯一标识符。 + * 该方法用于设置文本数据的唯一标识符。如果传入的 id 小于或等于 0，则抛出 IllegalArgumentException 异常。 + * @param id 文本数据的唯一标识符。 + * @throws IllegalArgumentException 如果 id 小于或等于 0，则抛出此异常。 + */ + void setTextDataId(long id) { + // 检查传入的 id 是否有效，如果无效则抛出异常。 + if(id <= 0) { + throw new IllegalArgumentException("Text data id should larger than 0"); + } + mTextDataId = id;// 设置文本数据的唯一标识符。 + } +/* + * 设置通话数据的唯一标识符。 + * 该方法用于设置通话数据的唯一标识符。如果传入的 id 小于或等于 0，则抛出 IllegalArgumentException 异常。 + * @param id 通话数据的唯一标识符。 + * @throws IllegalArgumentException 如果 id 小于或等于 0，则抛出此异常。 + */ + void setCallDataId(long id) { + // 检查传入的 id 是否有效，如果无效则抛出异常。 + if (id <= 0) { + throw new IllegalArgumentException("Call data id should larger than 0"); + } + mCallDataId = id; // 设置通话数据的唯一标识符。 + } +/* + * 设置通话数据的方法。 + * 该方法用于将给定的键值对存储到通话数据的 ContentValues 对象中，并更新笔记的本地修改状态和修改日期。 + * @param key 通话数据的键。 + * @param value 通话数据的值。 + */ + void setCallData(String key, String value) { + // 将给定的键值对存储到通话数据的 ContentValues 对象中。 + mCallDataValues.put(key, value); + // 更新笔记的本地修改状态为 1，表示有本地修改。 + mNoteDiffValues.put(NoteColumns.LOCAL_MODIFIED, 1); + // 更新笔记的修改日期为当前时间。 + mNoteDiffValues.put(NoteColumns.MODIFIED_DATE, System.currentTimeMillis()); + } +/* + *设置文本数据的方法。 + * 该方法用于将给定的键值对存储到文本数据的 ContentValues 对象中，并更新笔记的本地修改状态和修改日期。 + * @param key 文本数据的键。 + * @param value 文本数据的值。 + */ + void setTextData(String key, String value) { + // 将给定的键值对存储到文本数据的 ContentValues 对象中。 + mTextDataValues.put(key, value); + // 更新笔记的本地修改状态为 1，表示有本地修改。 + mNoteDiffValues.put(NoteColumns.LOCAL_MODIFIED, 1); + // 更新笔记的修改日期为当前时间。 + mNoteDiffValues.put(NoteColumns.MODIFIED_DATE, System.currentTimeMillis()); + } +/* + * 将数据推送到内容提供者的方法。 + * 该方法用于将文本数据和通话数据推送到内容提供者中。如果文本数据或通话数据有修改，则将其插入或更新到内容提供者中。 + * @param context 应用程序上下文。 + * @param noteId 笔记的唯一标识符。 + * @return 如果推送成功，则返回 Uri；否则返回 null。 + * @throws IllegalArgumentException 如果 noteId 小于或等于 0，则抛出此异常。 + */ + Uri pushIntoContentResolver(Context context, long noteId) { + // 这是方法的签名，定义了方法的访问修饰符、返回类型、方法名称和参数列表。 + /** + * Check for safety + */ + //检查 noteId 是否有效，如果无效则抛出 + if (noteId <= 0) { + throw new IllegalArgumentException("Wrong note id:" + noteId); + } + //创建一个操作列表，用于批量操作。 + ArrayList operationList = new ArrayList(); + ContentProviderOperation.Builder builder = null; + //如果文本数据有修改，处理文本数据。 + if(mTextDataValues.size() > 0) { + //将笔记 ID 添加到文本数据的 ContentValues 对象中。 + mTextDataValues.put(DataColumns.NOTE_ID, noteId); + //如果文本数据的 ID 为 0，表示是新数据，插入到内容提供者中。 + if (mTextDataId == 0) { + mTextDataValues.put(DataColumns.MIME_TYPE, TextNote.CONTENT_ITEM_TYPE); + Uri uri = context.getContentResolver().insert(Notes.CONTENT_DATA_URI, + mTextDataValues); + try { + setTextDataId(Long.valueOf(uri.getPathSegments().get(1))); + } catch (NumberFormatException e) { + Log.e(TAG, "Insert new text data fail with noteId" + noteId); + mTextDataValues.clear(); + return null; + } + } //如果文本数据的 ID 不为 0，表示是已有数据，更新到内容提供者中。 + else { + builder = ContentProviderOperation.newUpdate(ContentUris.withAppendedId( + Notes.CONTENT_DATA_URI, mTextDataId)); + builder.withValues(mTextDataValues); + operationList.add(builder.build()); + } + mTextDataValues.clear();// 清空文本数据的 ContentValues 对象。 + } + // 如果通话数据有修改，处理通话数据。 + if(mCallDataValues.size() > 0) { + mCallDataValues.put(DataColumns.NOTE_ID, noteId); + //将笔记 ID 添加到通话数据的 ContentValues 对象中。 + //如果通话数据的 ID 为 0，表示是新数据，插入到内容提供者中。 + if (mCallDataId == 0) { + mCallDataValues.put(DataColumns.MIME_TYPE, CallNote.CONTENT_ITEM_TYPE); + Uri uri = context.getContentResolver().insert(Notes.CONTENT_DATA_URI, + mCallDataValues); + try { + setCallDataId(Long.valueOf(uri.getPathSegments().get(1))); + } catch (NumberFormatException e) { + Log.e(TAG, "Insert new call data fail with noteId" + noteId); + mCallDataValues.clear(); + return null; + } + } //如果通话数据的 ID 不为 0，表示是已有数据，更新到内容提供者中。 + else { + builder = ContentProviderOperation.newUpdate(ContentUris.withAppendedId( + Notes.CONTENT_DATA_URI, mCallDataId)); + builder.withValues(mCallDataValues); + operationList.add(builder.build()); + } + mCallDataValues.clear();//清空通话数据的 ContentValues 对象。 + } + //如果操作列表中有操作，执行批量操作。 + if (operationList.size() > 0) { + //尝试执行批量操作。 + try { + ContentProviderResult[] results = context.getContentResolver().applyBatch( + Notes.AUTHORITY, operationList); + return (results == null || results.length == 0 || results[0] == null) ? null + : ContentUris.withAppendedId(Notes.CONTENT_NOTE_URI, noteId); + } catch (RemoteException e) { + //捕获远程异常并记录日志。 + Log.e(TAG, String.format("%s: %s", e.toString(), e.getMessage())); + return null; + } catch (OperationApplicationException e) { + // 捕获操作应用异常并记录日志。 + Log.e(TAG, String.format("%s: %s", e.toString(), e.getMessage())); + return null; + } + } + return null; + } + } +} diff --git a/WorkingNote.java b/WorkingNote.java new file mode 100644 index 0000000..ebb8233 --- /dev/null +++ b/WorkingNote.java @@ -0,0 +1,532 @@ +/* + * 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; +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 for the working note + // 当前工作笔记的 Note 对象 + private Note mNote; + // Note 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, // 数据内容 + DataColumns.MIME_TYPE,// 数据的 MIME 类型 + DataColumns.DATA1,// 数据字段 1 + DataColumns.DATA2, // 数据字段 2 + DataColumns.DATA3, // 数据字段 3 + DataColumns.DATA4, // 数据字段 4 + }; +/* + * 笔记查询投影。 + * 该常量定义了在查询笔记时需要返回的列。 + * @see NoteColumns + */ + public static final String[] NOTE_PROJECTION = new String[] { + NoteColumns.PARENT_ID, // 笔记的父 ID（文件夹 ID） + NoteColumns.ALERTED_DATE, // 笔记的提醒日期 + NoteColumns.BG_COLOR_ID, // 笔记的背景颜色 ID + NoteColumns.WIDGET_ID, // 笔记的小部件 ID + NoteColumns.WIDGET_TYPE, // 笔记的小部件类型 + 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; // 初始化提醒日期为 0 + mModifiedDate = System.currentTimeMillis();// 设置修改日期为当前时间 + mFolderId = folderId;// 设置文件夹 ID + mNote = new Note();// 创建一个新的 Note 对象 + mNoteId = 0;// 初始化笔记 ID 为 0 + mIsDeleted = false;// 初始化删除状态为 false + mMode = 0;// 初始化笔记模式为 0 + mWidgetType = Notes.TYPE_WIDGET_INVALIDE;// 初始化小部件类型为无效类型 + } + + // Existing note construct + /* + * 加载现有的笔记 + * 该构造函数用于加载现有的笔记对象。 + * @param context 应用程序上下文。 + * @param noteId 笔记的唯一标识符。 + * @param folderId 文件夹 ID。 + */ + private WorkingNote(Context context, long noteId, long folderId) { + mContext = context;// 设置应用程序上下文 + mNoteId = noteId;// 设置笔记的唯一标识符 + mFolderId = folderId;// 设置文件夹 ID + mIsDeleted = false;// 初始化删除状态为 false + mNote = new Note(); // 创建一个新的 Note 对象 + loadNote();// 加载笔记数据 + } +/* + * 加载笔记数据。 + * 该方法用于从内容提供者中加载笔记数据，并将其设置到当前的 WorkingNote 对象中。 + */ + 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); // 获取文件夹 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(); // 关闭游标 + } else { // 记录错误日志 + Log.e(TAG, "No note with id:" + mNoteId); + // 抛出异常 + throw new IllegalArgumentException("Unable to find note with id " + mNoteId); + } + loadNoteData();// 加载笔记数据 + } +/* + * 加载笔记数据。 + * 该方法用于从内容提供者中加载笔记的具体数据，并将其设置到当前的 WorkingNote 对象中。 + */ + 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 类型 + String type = cursor.getString(DATA_MIME_TYPE_COLUMN); + if (DataConstants.NOTE.equals(type)) {// 根据 MIME 类型处理数据 + 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)); // 如果是通话笔记，获取通话数据 ID + } 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); + } + } +/* + * 创建一个新的空笔记。 + * 该方法用于创建一个新的空笔记对象，并设置其背景颜色、小部件 ID 和小部件类型。 + * @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);// 创建一个新的空笔记对象 + note.setBgColorId(defaultBgColorId); // 设置背景颜色 ID + note.setWidgetId(widgetId);// 设置小部件 ID + note.setWidgetType(widgetType); // 设置小部件类型 + return note;// 返回新的 WorkingNote 对象 + } +/* + *加载现有的笔记。 + * 该方法用于加载现有的笔记对象。 + * @param context 应用程序上下文。 + * @param id 笔记的唯一标识符。 + * @return 加载的 WorkingNote 对象。 + */ + public static WorkingNote load(Context context, long id) { + return new WorkingNote(context, id, 0); // 返回一个新的 WorkingNote 对象，使用指定的上下文和笔记 ID + } +/* + * 保存笔记。 + * 该方法用于保存当前的笔记对象。如果笔记值得保存，则将其同步到数据库中，并更新小部件内容（如果存在小部件）。 + * @return 如果保存成功，则返回 true；否则返回 false。 + */ + public synchronized boolean saveNote() { + if (isWorthSaving()) { // 检查笔记是否值得保存 + if (!existInDatabase()) { // 如果笔记不存在于数据库中 + if ((mNoteId = Note.getNewNoteId(mContext, mFolderId)) == 0) { + // 获取新的笔记 ID + 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 + && mNoteSettingStatusListener != null) { + mNoteSettingStatusListener.onWidgetChanged(); + } + return true; + } else { + return false; + } + } +/* + * 检查笔记是否存在于数据库中。 + * 该方法用于检查当前笔记对象是否已经存在于数据库中。 + * @return 如果笔记存在于数据库中，则返回 true；否则返回 false。 + */ + public boolean existInDatabase() {// 如果笔记 ID 大于 0，表示笔记存在于数据库中 + return mNoteId > 0; + } +/* + * 检查笔记是否值得保存。 + * 该方法用于检查当前笔记对象是否值得保存。如果笔记已被删除、内容为空且不存在于数据库中，或者笔记存在于数据库中但没有本地修改，则不值得保存。 + * @return 如果笔记值得保存，则返回 true；否则返回 false。 + */ + private boolean isWorthSaving() { + // 如果笔记已被删除，或者内容为空且不存在于数据库中，或者笔记存在于数据库中但没有本地修改，则不值得保存 + if (mIsDeleted || (!existInDatabase() && TextUtils.isEmpty(mContent)) + || (existInDatabase() && !mNote.isLocalModified())) { + return false; + } else { + return true; + } + } +/* + * 设置笔记设置状态监听器。 + * 该方法用于设置笔记设置状态的监听器，以便在笔记设置状态发生变化时通知监听器。 + * @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;// 更新提醒日期 + mNote.setNoteValue(NoteColumns.ALERTED_DATE, String.valueOf(mAlertDate));// 设置笔记的提醒日期 + } + if (mNoteSettingStatusListener != null) {// 如果笔记设置状态监听器不为空 + mNoteSettingStatusListener.onClockAlertChanged(date, set); // 通知笔记设置状态监听器提醒日期已更改 + } + } +/* + * 标记笔记为已删除或未删除。 + * 该方法用于标记笔记为已删除或未删除。如果笔记存在小部件，并且笔记设置状态监听器不为空，则通知笔记设置状态监听器小部件已更改。 + * @param mark 是否标记为已删除。 + */ + public void markDeleted(boolean mark) { + mIsDeleted = mark; // 标记笔记为已删除或未删除 + if (mWidgetId != AppWidgetManager.INVALID_APPWIDGET_ID // 如果笔记存在小部件，并且笔记设置状态监听器不为空 + && mWidgetType != Notes.TYPE_WIDGET_INVALIDE && mNoteSettingStatusListener != null) { + // 通知笔记设置状态监听器小部件已更改 + mNoteSettingStatusListener.onWidgetChanged(); + } + } +/* + * 设置背景颜色 ID。 + * 该方法用于设置笔记的背景颜色 ID。如果新的背景颜色 ID 与当前背景颜色 ID 不同，则更新背景颜色 ID，并通知笔记设置状态监听器背景颜色已更改。 + * @param id 背景颜色 ID。 + */ + public void setBgColorId(int id) { + if (id != mBgColorId) { // 如果新的背景颜色 ID 与当前背景颜色 ID 不同 + mBgColorId = id;// 更新背景颜色 ID + if (mNoteSettingStatusListener != null) { // 如果笔记设置状态监听器不为空 + mNoteSettingStatusListener.onBackgroundColorChanged(); // 通知笔记设置状态监听器背景颜色已更改 + } + mNote.setNoteValue(NoteColumns.BG_COLOR_ID, String.valueOf(id)); // 设置笔记的背景颜色 ID + } + } +/* + * 设置检查列表模式。 + * 该方法用于设置笔记的检查列表模式。如果新的模式与当前模式不同，则更新模式，并通知笔记设置状态监听器检查列表模式已更改。 + * @param mode 检查列表模式。 + */ + public void setCheckListMode(int mode) {// 如果新的模式与当前模式不同 + if (mMode != mode) { // 如果笔记设置状态监听器不为空 + if (mNoteSettingStatusListener != null) { // 通知笔记设置状态监听器检查列表模式已更改 + mNoteSettingStatusListener.onCheckListModeChanged(mMode, mode); + } + mMode = mode;// 更新模式 + mNote.setTextData(TextNote.MODE, String.valueOf(mMode)); // 设置笔记的检查列表模式 + } + } +/* + * 设置小部件类型。 + * 该方法用于设置笔记的小部件类型。如果新的类型与当前类型不同，则更新小部件类型，并将其保存到笔记数据中。 + * @param type 小部件类型。 + */ + public void setWidgetType(int type) { // 如果新的类型与当前类型不同 + if (type != mWidgetType) { // 更新小部件类型 + mWidgetType = type; + mNote.setNoteValue(NoteColumns.WIDGET_TYPE, String.valueOf(mWidgetType)); // 设置笔记的小部件类型 + } + } +/* + * 设置小部件 ID。 + * 该方法用于设置笔记的小部件 ID。如果新的 ID 与当前 ID 不同，则更新小部件 ID，并将其保存到笔记数据中。 + * @param id 小部件 ID。 + */ + public void setWidgetId(int id) { // 如果新的 ID 与当前 ID 不同 + if (id != mWidgetId) { // 更新小部件 ID + mWidgetId = id; + mNote.setNoteValue(NoteColumns.WIDGET_ID, String.valueOf(mWidgetId)); // 设置笔记的小部件 ID + } + } +/* + * 设置工作文本。 + * 该方法用于设置笔记的工作文本。如果新的文本与当前文本不同，则更新工作文本，并将其保存到笔记数据中。 + * @param text 工作文本。 + */ + public void setWorkingText(String text) { // 如果新的文本与当前文本不同 + if (!TextUtils.equals(mContent, text)) { // 更新工作文本 + mContent = text; + mNote.setTextData(DataColumns.CONTENT, mContent);// 设置笔记的工作文本 + } + } +/* + * 将笔记转换为通话笔记。 + * 该方法用于将笔记转换为通话笔记。它设置通话日期、电话号码和父文件夹 ID。 + * @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)); // 设置父文件夹 ID + } +/* + * 检查是否有提醒。 + * 该方法用于检查笔记是否有提醒。如果提醒日期大于 0，则表示有提醒。 + * @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。 + * 该方法用于获取笔记的背景颜色资源 ID。 + * @return 背景颜色资源 ID。 + */ + public int getBgColorResId() { + return NoteBgResources.getNoteBgResource(mBgColorId); + } +/* + * 获取背景颜色 ID。 + * 该方法用于获取笔记的背景颜色 ID。 + * @return 背景颜色 ID。 + */ + public int getBgColorId() { + return mBgColorId; + } +/* + * 获取标题背景资源 ID。 + * 该方法用于获取笔记的标题背景资源 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。 + * 该方法用于获取笔记所属的文件夹 ID。 + * @return 文件夹 ID。 + */ + public long getFolderId() { + return mFolderId; + } +/* + * 获取小部件 ID。 + * 该方法用于获取笔记的小部件 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); + } +}