diff --git a/NoteWidgetProvider.java b/NoteWidgetProvider.java new file mode 100644 index 0000000..c746e27 --- /dev/null +++ b/NoteWidgetProvider.java @@ -0,0 +1,159 @@ +package net.micode.notes.widget; + +// 导入必要的 Android 和应用相关的类和包 +import android.app.PendingIntent; +import android.appwidget.AppWidgetManager; +import android.appwidget.AppWidgetProvider; +import android.content.ContentValues; +import android.content.Context; +import android.content.Intent; +import android.database.Cursor; +import android.util.Log; +import android.widget.RemoteViews; + +import net.micode.notes.R; +import net.micode.notes.data.Notes; +import net.micode.notes.data.Notes.NoteColumns; +import net.micode.notes.tool.ResourceParser; +import net.micode.notes.ui.NoteEditActivity; +import net.micode.notes.ui.NotesListActivity; + +// 抽象类 NoteWidgetProvider,继承自 AppWidgetProvider,用于定义笔记小部件的逻辑 +public abstract class NoteWidgetProvider extends AppWidgetProvider { + + // 定义数据库查询时所需的列名数组 + public static final String[] PROJECTION = new String[]{ + NoteColumns.ID, // 笔记的唯一 ID + NoteColumns.BG_COLOR_ID, // 笔记的背景颜色 ID + NoteColumns.SNIPPET // 笔记的摘要(内容片段) + }; + + // 定义列索引的常量,以便访问查询结果时更加清晰和方便 + public static final int COLUMN_ID = 0; + public static final int COLUMN_BG_COLOR_ID = 1; + public static final int COLUMN_SNIPPET = 2; + + // 定义日志标签,便于在调试和记录日志时标识日志来源 + private static final String TAG = "NoteWidgetProvider"; + + // 覆写 onDeleted 方法,当小部件被用户移除时调用 + @Override + public void onDeleted(Context context, int[] appWidgetIds) { + // 创建一个 ContentValues 对象,用于更新数据库 + ContentValues values = new ContentValues(); + // 将小部件 ID 设置为无效 ID,以便从数据库中移除相关关联 + values.put(NoteColumns.WIDGET_ID, AppWidgetManager.INVALID_APPWIDGET_ID); + // 遍历被删除的小部件 ID 数组 + for (int i = 0; i < appWidgetIds.length; i++) { + // 更新数据库中与该小部件关联的记录 + context.getContentResolver().update(Notes.CONTENT_NOTE_URI, + values, + NoteColumns.WIDGET_ID + "=?", // WHERE 子句:匹配指定小部件 ID + new String[]{String.valueOf(appWidgetIds[i])}); // WHERE 参数 + } + } + + // 私有方法:根据小部件 ID 查询对应的笔记信息 + private Cursor getNoteWidgetInfo(Context context, int widgetId) { + // 执行数据库查询,返回与指定小部件 ID 相关的笔记 + return context.getContentResolver().query(Notes.CONTENT_NOTE_URI, + PROJECTION, // 查询的列 + NoteColumns.WIDGET_ID + "=? AND " + NoteColumns.PARENT_ID + "<>?", // 条件:小部件 ID 匹配且不在垃圾箱中 + new String[]{String.valueOf(widgetId), String.valueOf(Notes.ID_TRASH_FOLER)}, // 参数值 + null); // 排序方式(此处为 null,即不排序) + } + + // 受保护方法:更新小部件显示内容的公共接口 + protected void update(Context context, AppWidgetManager appWidgetManager, int[] appWidgetIds) { + // 默认调用私有方法,并将隐私模式设置为 false + update(context, appWidgetManager, appWidgetIds, false); + } + + // 私有方法:根据隐私模式,更新小部件显示内容 + private void update(Context context, AppWidgetManager appWidgetManager, int[] appWidgetIds, + boolean privacyMode) { + // 遍历所有小部件 ID + for (int i = 0; i < appWidgetIds.length; i++) { + // 如果小部件 ID 无效,则跳过 + if (appWidgetIds[i] != AppWidgetManager.INVALID_APPWIDGET_ID) { + // 获取默认的背景颜色 ID + int bgId = ResourceParser.getDefaultBgId(context); + // 初始化笔记摘要为空字符串 + String snippet = ""; + // 创建一个 Intent,指定跳转到 NoteEditActivity + Intent intent = new Intent(context, NoteEditActivity.class); + // 设置 Intent 的标志,确保活动以单一实例模式启动 + intent.setFlags(Intent.FLAG_ACTIVITY_SINGLE_TOP); + // 将小部件 ID 和类型作为额外数据加入 Intent + intent.putExtra(Notes.INTENT_EXTRA_WIDGET_ID, appWidgetIds[i]); + intent.putExtra(Notes.INTENT_EXTRA_WIDGET_TYPE, getWidgetType()); + + // 查询数据库,获取与当前小部件 ID 关联的笔记信息 + Cursor c = getNoteWidgetInfo(context, appWidgetIds[i]); + // 如果查询结果不为空且有数据 + if (c != null && c.moveToFirst()) { + // 如果查询结果超过一条记录,则记录日志并返回 + if (c.getCount() > 1) { + Log.e(TAG, "Multiple message with same widget id:" + appWidgetIds[i]); + c.close(); + return; + } + // 从查询结果中获取笔记摘要和背景颜色 ID + snippet = c.getString(COLUMN_SNIPPET); + bgId = c.getInt(COLUMN_BG_COLOR_ID); + // 将笔记 ID 添加到 Intent 的额外数据中 + intent.putExtra(Intent.EXTRA_UID, c.getLong(COLUMN_ID)); + // 设置 Intent 的操作类型为查看 + intent.setAction(Intent.ACTION_VIEW); + } else { + // 如果查询结果为空,则设置默认的内容和操作类型 + snippet = context.getResources().getString(R.string.widget_havenot_content); + intent.setAction(Intent.ACTION_INSERT_OR_EDIT); + } + + // 如果 Cursor 对象不为空,则关闭以释放资源 + if (c != null) { + c.close(); + } + + // 创建 RemoteViews 对象,用于更新小部件的布局 + RemoteViews rv = new RemoteViews(context.getPackageName(), getLayoutId()); + // 设置小部件的背景图片资源 + rv.setImageViewResource(R.id.widget_bg_image, getBgResourceId(bgId)); + // 将背景颜色 ID 添加到 Intent 的额外数据中 + intent.putExtra(Notes.INTENT_EXTRA_BACKGROUND_ID, bgId); + + // 声明 PendingIntent 对象,用于处理小部件的点击事件 + PendingIntent pendingIntent = null; + if (privacyMode) { + // 如果处于隐私模式,则显示隐私模式文本 + rv.setTextViewText(R.id.widget_text, + context.getString(R.string.widget_under_visit_mode)); + // 设置 PendingIntent,点击时跳转到 NotesListActivity + pendingIntent = PendingIntent.getActivity(context, appWidgetIds[i], new Intent( + context, NotesListActivity.class), PendingIntent.FLAG_UPDATE_CURRENT); + } else { + // 非隐私模式,显示笔记摘要 + rv.setTextViewText(R.id.widget_text, snippet); + // 设置 PendingIntent,点击时跳转到笔记编辑页面 + pendingIntent = PendingIntent.getActivity(context, appWidgetIds[i], intent, + PendingIntent.FLAG_UPDATE_CURRENT); + } + + // 为小部件的文本区域设置点击事件 + rv.setOnClickPendingIntent(R.id.widget_text, pendingIntent); + // 更新小部件显示内容 + appWidgetManager.updateAppWidget(appWidgetIds[i], rv); + } + } + } + + // 抽象方法:获取背景资源的 ID,具体实现由子类提供 + protected abstract int getBgResourceId(int bgId); + + // 抽象方法:获取小部件布局的资源 ID,具体实现由子类提供 + protected abstract int getLayoutId(); + + // 抽象方法:获取小部件的类型,具体实现由子类提供 + protected abstract int getWidgetType(); +} diff --git a/NoteWidgetProvider_2x.java b/NoteWidgetProvider_2x.java new file mode 100644 index 0000000..9a547d2 --- /dev/null +++ b/NoteWidgetProvider_2x.java @@ -0,0 +1,76 @@ +/* + * 版权声明:MiCode开源社区(www.micode.net) + * + * 本代码遵循Apache 2.0开源协议 + * 如需获取完整的授权条款,请访问:http://www.apache.org/licenses/LICENSE-2.0.html + * + * 代码开始 + */ + +// 定义包名,组织代码模块化管理 +package net.micode.notes.widget; + +// 导入Android小部件相关类和应用的资源类 +import android.appwidget.AppWidgetManager; +import android.content.Context; + +import net.micode.notes.R; // 导入资源文件R类,用于访问布局和其他资源 +import net.micode.notes.data.Notes; // 导入笔记相关的数据类 +import net.micode.notes.tool.ResourceParser; // 导入资源解析工具类 + +/** + * 2x版本的小部件提供者类。 + * 该类继承自 NoteWidgetProvider,专门处理 2x2 尺寸的笔记小部件。 + */ +public class NoteWidgetProvider_2x extends NoteWidgetProvider { + /** + * 当系统需要更新小部件时,会调用此方法。 + * 此方法通过调用父类的 `update` 方法来处理小部件更新的逻辑。 + * + * @param context 上下文环境,用于获取应用程序资源和操作。 + * @param appWidgetManager 管理当前应用中所有小部件的 AppWidgetManager 实例。 + * @param appWidgetIds 当前需要更新的小部件 ID 数组。 + */ + @Override + public void onUpdate(Context context, AppWidgetManager appWidgetManager, int[] appWidgetIds) { + // 调用父类的 update 方法,完成小部件的更新逻辑 + super.update(context, appWidgetManager, appWidgetIds); + } + + /** + * 获取小部件布局的资源 ID。 + * 此方法返回当前小部件所使用的布局文件的资源 ID。 + * 该布局文件定义了小部件在屏幕上的外观。 + * + * @return 布局资源的 ID,对应 `res/layout/widget_2x.xml` 文件。 + */ + @Override + protected int getLayoutId() { + return R.layout.widget_2x; // 返回 2x 小部件的布局资源 ID + } + + /** + * 根据背景 ID 获取对应的背景资源 ID。 + * 小部件有不同的背景样式(如不同颜色或主题),通过背景 ID 选择对应的资源。 + * + * @param bgId 背景资源的索引 ID,表示选择哪一种背景样式。 + * @return 背景资源的 ID,用于设置小部件的背景。 + */ + @Override + protected int getBgResourceId(int bgId) { + // 使用 ResourceParser 工具类,根据背景 ID 获取 2x 小部件的背景资源 ID + return ResourceParser.WidgetBgResources.getWidget2xBgResource(bgId); + } + + /** + * 获取当前小部件的类型。 + * 该方法返回一个常量,用于标识当前小部件的类型。 + * 不同尺寸的小部件有不同的类型常量,例如 2x 和 4x 小部件。 + * + * @return 小部件类型的常量值,表示当前为 2x 尺寸的小部件。 + */ + @Override + protected int getWidgetType() { + return Notes.TYPE_WIDGET_2X; // 返回表示 2x 小部件类型的常量 + } +} diff --git a/NoteWidgetProvider_4x.java b/NoteWidgetProvider_4x.java new file mode 100644 index 0000000..29c55e0 --- /dev/null +++ b/NoteWidgetProvider_4x.java @@ -0,0 +1,74 @@ +/* + * 版权声明:MiCode开源社区(www.micode.net) + * + * 本代码遵循Apache 2.0开源协议 + * 详细授权信息请访问:http://www.apache.org/licenses/LICENSE-2.0 + */ + +// 定义代码所在的包,用于组织代码模块化 +package net.micode.notes.widget; + +// 导入小部件和应用程序相关的类 +import android.appwidget.AppWidgetManager; +import android.content.Context; + +import net.micode.notes.R; // 导入应用资源文件 R,访问布局和其他资源 +import net.micode.notes.data.Notes; // 导入笔记相关的常量和数据类 +import net.micode.notes.tool.ResourceParser; // 导入工具类,用于解析小部件资源 + +/** + * 4x大小的便签小部件提供者类,继承自 NoteWidgetProvider。 + * 专门用于处理 4x 大小的便签小部件的更新和相关操作。 + */ +public class NoteWidgetProvider_4x extends NoteWidgetProvider { + + /** + * 当系统请求更新小部件时,会调用此方法。 + * 该方法通过调用父类的 `update` 方法来处理小部件的更新逻辑。 + * + * @param context 上下文环境,提供应用程序的全局信息和操作能力。 + * @param appWidgetManager 小部件管理器,用于管理当前应用中所有的小部件。 + * @param appWidgetIds 需要更新的小部件 ID 数组,包含多个小部件的唯一标识符。 + */ + @Override + public void onUpdate(Context context, AppWidgetManager appWidgetManager, int[] appWidgetIds) { + // 调用父类的 update 方法,完成通用的更新逻辑 + super.update(context, appWidgetManager, appWidgetIds); + } + + /** + * 获取小部件的布局资源 ID。 + * 布局资源定义了小部件的界面结构,例如显示的文本和背景图片等。 + * + * @return 返回 4x 小部件的布局资源 ID,对应 `res/layout/widget_4x.xml` 文件。 + */ + @Override + protected int getLayoutId() { + return R.layout.widget_4x; // 指定用于 4x 小部件的布局资源 + } + + /** + * 根据背景 ID 获取对应的背景资源 ID。 + * 小部件可以有不同的背景样式,例如不同的颜色或主题,通过背景 ID 来选择。 + * + * @param bgId 背景的索引 ID,表示不同的背景样式。 + * @return 返回与背景 ID 对应的背景资源 ID,用于设置小部件的背景。 + */ + @Override + protected int getBgResourceId(int bgId) { + // 使用 ResourceParser 工具类,根据背景 ID 获取 4x 小部件的背景资源 ID + return ResourceParser.WidgetBgResources.getWidget4xBgResource(bgId); + } + + /** + * 获取当前小部件的类型标识。 + * 该方法返回一个整型常量,用于标识当前小部件的类型。 + * 在应用中可以通过该标识区分不同的小部件类型,例如 4x 和 2x 小部件。 + * + * @return 返回小部件类型的整型标识,表示这是一个 4x 大小的小部件。 + */ + @Override + protected int getWidgetType() { + return Notes.TYPE_WIDGET_4X; // 返回 4x 小部件类型的常量 + } +} diff --git a/泛读报告.docx b/泛读报告.docx new file mode 100644 index 0000000..5e87929 Binary files /dev/null and b/泛读报告.docx differ