ui-便签桌面小部件的基类注释

src/Notes-master/src/net/micode/notes/widget/NoteWidgetProvider.java

@@ -32,19 +32,31 @@ import net.micode.notes.tool.ResourceParser;
 import net.micode.notes.ui.NoteEditActivity;
 import net.micode.notes.ui.NotesListActivity;
 
+/**
+ * 便签桌面小部件的基类，提供了小部件的核心功能实现
+ * 继承自AppWidgetProvider，处理小部件的创建、更新和删除等操作
+ */
 public abstract class NoteWidgetProvider extends AppWidgetProvider {
+    // 定义查询便签内容时需要的字段
     public static final String [] PROJECTION = new String [] {
-        NoteColumns.ID,
-        NoteColumns.BG_COLOR_ID,
-        NoteColumns.SNIPPET
+        NoteColumns.ID,           // 便签ID
+        NoteColumns.BG_COLOR_ID,  // 便签背景色ID
+        NoteColumns.SNIPPET       // 便签摘要内容
     };
 
+    // 投影列的索引常量，方便从Cursor中获取对应数据
     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";
 
+    /**
+     * 当小部件被删除时调用此方法
+     * 将对应便签的widget_id字段置为INVALID_APPWIDGET_ID，表示该便签不再关联小部件
+     * @param context 上下文
+     * @param appWidgetIds 被删除的小部件ID数组
+     */
     @Override
     public void onDeleted(Context context, int[] appWidgetIds) {
         ContentValues values = new ContentValues();
@@ -57,6 +69,12 @@ public abstract class NoteWidgetProvider extends AppWidgetProvider {
         }
     }
 
+    /**
+     * 获取指定小部件ID对应的便签信息
+     * @param context 上下文
+     * @param widgetId 小部件ID
+     * @return 返回包含便签信息的Cursor，或null（如果查询失败）
+     */
     private Cursor getNoteWidgetInfo(Context context, int widgetId) {
         return context.getContentResolver().query(Notes.CONTENT_NOTE_URI,
                 PROJECTION,
@@ -65,68 +83,109 @@ public abstract class NoteWidgetProvider extends AppWidgetProvider {
                 null);
     }
 
+    /**
+     * 更新小部件（非隐私模式）
+     * @param context 上下文
+     * @param appWidgetManager AppWidgetManager实例
+     * @param appWidgetIds 需要更新的小部件ID数组
+     */
     protected void update(Context context, AppWidgetManager appWidgetManager, int[] appWidgetIds) {
         update(context, appWidgetManager, appWidgetIds, false);
     }
 
+    /**
+     * 更新小部件显示内容
+     * @param context 上下文
+     * @param appWidgetManager AppWidgetManager实例
+     * @param appWidgetIds 需要更新的小部件ID数组
+     * @param privacyMode 是否为隐私模式（隐私模式下显示通用提示，隐藏具体便签内容）
+     */
     private void update(Context context, AppWidgetManager appWidgetManager, int[] appWidgetIds,
             boolean privacyMode) {
         for (int i = 0; i < appWidgetIds.length; i++) {
             if (appWidgetIds[i] != AppWidgetManager.INVALID_APPWIDGET_ID) {
-                int bgId = ResourceParser.getDefaultBgId(context);
-                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.putExtra(Notes.INTENT_EXTRA_WIDGET_ID, appWidgetIds[i]);
                 intent.putExtra(Notes.INTENT_EXTRA_WIDGET_TYPE, getWidgetType());
 
+                // 查询小部件对应的便签内容
                 Cursor c = getNoteWidgetInfo(context, appWidgetIds[i]);
                 if (c != null && c.moveToFirst()) {
+                    // 检查是否存在多个便签关联同一个小部件ID的异常情况
                     if (c.getCount() > 1) {
                         Log.e(TAG, "Multiple message with same widget id:" + appWidgetIds[i]);
                         c.close();
                         return;
                     }
+                    
+                    // 从Cursor中获取便签内容和背景色
                     snippet = c.getString(COLUMN_SNIPPET);
                     bgId = c.getInt(COLUMN_BG_COLOR_ID);
                     intent.putExtra(Intent.EXTRA_UID, c.getLong(COLUMN_ID));
-                    intent.setAction(Intent.ACTION_VIEW);
+                    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动作为新建便签
                 }
 
+                // 确保Cursor被关闭，防止内存泄漏
                 if (c != null) {
                     c.close();
                 }
 
+                // 创建RemoteViews对象，用于设置小部件的显示内容
                 RemoteViews rv = new RemoteViews(context.getPackageName(), getLayoutId());
                 rv.setImageViewResource(R.id.widget_bg_image, getBgResourceId(bgId));
                 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.getActivity(context, appWidgetIds[i], new Intent(
                             context, NotesListActivity.class), PendingIntent.FLAG_UPDATE_CURRENT);
                 } else {
+                    // 正常模式下显示便签内容，点击后跳转到便签编辑页
                     rv.setTextViewText(R.id.widget_text, snippet);
                     pendingIntent = PendingIntent.getActivity(context, appWidgetIds[i], intent,
                             PendingIntent.FLAG_UPDATE_CURRENT);
                 }
 
+                // 设置小部件的点击事件
                 rv.setOnClickPendingIntent(R.id.widget_text, pendingIntent);
+                // 更新小部件
                 appWidgetManager.updateAppWidget(appWidgetIds[i], rv);
             }
         }
     }
 
+    /**
+     * 获取背景资源ID（由子类实现）
+     * @param bgId 背景色ID
+     * @return 对应的资源ID
+     */
     protected abstract int getBgResourceId(int bgId);
 
+    /**
+     * 获取小部件布局ID（由子类实现）
+     * @return 布局资源ID
+     */
     protected abstract int getLayoutId();
 
+    /**
+     * 获取小部件类型（由子类实现）
+     * @return 小部件类型常量
+     */
     protected abstract int getWidgetType();
-}
+}