Update NoteWidgetProvider.java

xiaomi/src/widget/NoteWidgetProvider.java

@@ -14,7 +14,10 @@
  * limitations under the License.
  */
 
+// 定义包名，表示该类属于 net.micode.notes.widget 包
 package net.micode.notes.widget;
+
+// 导入 Android 系统提供的相关类
 import android.app.PendingIntent;
 import android.appwidget.AppWidgetManager;
 import android.appwidget.AppWidgetProvider;
@@ -25,6 +28,7 @@ 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;
@@ -32,24 +36,36 @@ 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 {
+
+    // 定义一个常量数组 PROJECTION，用于指定查询数据库时需要的列
+    // 包括笔记的 ID、背景颜色 ID 和内容摘要
     public static final String[] PROJECTION = new String[]{
         NoteColumns.ID,
         NoteColumns.BG_COLOR_ID,
         NoteColumns.SNIPPET
     };
 
-    public static final int COLUMN_ID           = 0;
+    // 定义常量，用于表示 PROJECTION 数组中各列的索引
-    public static final int COLUMN_BG_COLOR_ID  = 1;
+    public static final int COLUMN_ID = 0;           // ID 列的索引
-    public static final int COLUMN_SNIPPET      = 2;
+    public static final int COLUMN_BG_COLOR_ID = 1;  // 背景颜色 ID 列的索引
+    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();
+        // 将 WIDGET_ID 设置为无效值，表示该小部件已被删除
         values.put(NoteColumns.WIDGET_ID, AppWidgetManager.INVALID_APPWIDGET_ID);
+        // 遍历所有被删除的小部件 ID
         for (int i = 0; i < appWidgetIds.length; i++) {
+            // 更新数据库，将对应的小部件 ID 的 WIDGET_ID 设置为无效值
             context.getContentResolver().update(Notes.CONTENT_NOTE_URI,
                     values,
                     NoteColumns.WIDGET_ID + "=?",
@@ -57,7 +73,10 @@ public abstract class NoteWidgetProvider extends AppWidgetProvider {
         }
     }
 
+    // 定义一个私有方法 getNoteWidgetInfo，用于根据小部件 ID 查询笔记信息
     private Cursor getNoteWidgetInfo(Context context, int widgetId) {
+        // 查询数据库，获取与小部件 ID 匹配的笔记信息
+        // 查询条件为 WIDGET_ID 等于 widgetId，且 PARENT_ID 不等于回收站 ID
         return context.getContentResolver().query(Notes.CONTENT_NOTE_URI,
                 PROJECTION,
                 NoteColumns.WIDGET_ID + "=? AND " + NoteColumns.PARENT_ID + "<>?",
@@ -65,68 +84,92 @@ public abstract class NoteWidgetProvider extends AppWidgetProvider {
                 null);
     }
 
+    // 定义一个受保护的方法 update，用于更新小部件
     protected void update(Context context, AppWidgetManager appWidgetManager, int[] appWidgetIds) {
+        // 调用带有隐私模式参数的 update 方法，默认隐私模式为 false
         update(context, appWidgetManager, appWidgetIds, false);
     }
 
+    // 定义一个私有方法 update，用于更新小部件
     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) {
-                int bgId = ResourceParser.getDefaultBgId(context);
+                // 初始化背景 ID 和内容摘要
-                String snippet = "";
+                int bgId = ResourceParser.getDefaultBgId(context); // 获取默认背景 ID
+                String snippet = ""; // 初始化内容摘要为空字符串
+
+                // 创建一个 Intent，用于打开笔记编辑页面
                 Intent intent = new Intent(context, NoteEditActivity.class);
-                intent.setFlags(Intent.FLAG_ACTIVITY_SINGLE_TOP);
+                intent.setFlags(Intent.FLAG_ACTIVITY_SINGLE_TOP); // 设置 Intent 标志
-                intent.putExtra(Notes.INTENT_EXTRA_WIDGET_ID, appWidgetIds[i]);
+                intent.putExtra(Notes.INTENT_EXTRA_WIDGET_ID, appWidgetIds[i]); // 添加小部件 ID
-                intent.putExtra(Notes.INTENT_EXTRA_WIDGET_TYPE, getWidgetType());
+                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();
+                        c.close(); // 关闭游标
-                        return;
+                        return; // 退出方法
                     }
-                    snippet = c.getString(COLUMN_SNIPPET);
+                    // 获取内容摘要和背景颜色 ID
-                    bgId = c.getInt(COLUMN_BG_COLOR_ID);
+                    snippet = c.getString(COLUMN_SNIPPET); // 获取内容摘要
-                    intent.putExtra(Intent.EXTRA_UID, c.getLong(COLUMN_ID));
+                    bgId = c.getInt(COLUMN_BG_COLOR_ID); // 获取背景颜色 ID
-                    intent.setAction(Intent.ACTION_VIEW);
+                    intent.putExtra(Intent.EXTRA_UID, c.getLong(COLUMN_ID)); // 添加笔记 ID
+                    intent.setAction(Intent.ACTION_VIEW); // 设置 Intent 动作
                 } else {
+                    // 如果未查询到笔记信息，设置默认内容摘要
                     snippet = context.getResources().getString(R.string.widget_havenot_content);
-                    intent.setAction(Intent.ACTION_INSERT_OR_EDIT);
+                    intent.setAction(Intent.ACTION_INSERT_OR_EDIT); // 设置 Intent 动作
                 }
 
+                // 关闭游标
                 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);
-                /**
+
-                 * Generate the pending intent to start host for the widget
+                // 创建 PendingIntent 对象，用于处理小部件的点击事件
-                 */
                 PendingIntent pendingIntent = null;
                 if (privacyMode) {
+                    // 如果处于隐私模式，显示隐私模式提示
                     rv.setTextViewText(R.id.widget_text,
                             context.getString(R.string.widget_under_visit_mode));
+                    // 创建一个指向笔记列表页面的 PendingIntent
                     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);
                 }
 
+                // 设置小部件点击事件的 PendingIntent
                 rv.setOnClickPendingIntent(R.id.widget_text, pendingIntent);
+                // 更新小部件
                 appWidgetManager.updateAppWidget(appWidgetIds[i], rv);
             }
         }
     }
 
+    // 定义一个抽象方法 getBgResourceId，用于根据背景 ID 获取背景资源 ID
     protected abstract int getBgResourceId(int bgId);
 
+    // 定义一个抽象方法 getLayoutId，用于获取小部件的布局资源 ID
     protected abstract int getLayoutId();
 
+    // 定义一个抽象方法 getWidgetType，用于获取小部件的类型
     protected abstract int getWidgetType();
 }