注释

app/src/main/java/net/micode/notes/widget/NoteWidgetProvider.java

@@ -15,6 +15,7 @@
  */
 
 package net.micode.notes.widget;
+
 import android.app.PendingIntent;
 import android.appwidget.AppWidgetManager;
 import android.appwidget.AppWidgetProvider;
@@ -32,54 +33,87 @@ import net.micode.notes.tool.ResourceParser;
 import net.micode.notes.ui.NoteEditActivity;
 import net.micode.notes.ui.NotesListActivity;
 
+/**
+ * 便签桌面小部件提供者抽象基类
+ * 提供便签小部件的基本功能实现，子类需实现特定布局和样式
+ */
 public abstract class NoteWidgetProvider extends AppWidgetProvider {
-    public static final String [] PROJECTION = new String [] {
+    // 数据库查询投影，获取小部件关联的便签ID、背景色和摘要
-        NoteColumns.ID,
+    public static final String[] PROJECTION = new String[]{
-        NoteColumns.BG_COLOR_ID,
+            NoteColumns.ID,
-        NoteColumns.SNIPPET
+            NoteColumns.BG_COLOR_ID,
+            NoteColumns.SNIPPET
     };
 
-    public static final int COLUMN_ID           = 0;
+    // 投影列索引
-    public static final int COLUMN_BG_COLOR_ID  = 1;
+    public static final int COLUMN_ID = 0;
-    public static final int COLUMN_SNIPPET      = 2;
+    public static final int COLUMN_BG_COLOR_ID = 1;
+    public static final int COLUMN_SNIPPET = 2;
 
     private static final String TAG = "NoteWidgetProvider";
 
+    /**
+     * 当小部件被删除时调用
+     * @param context 上下文
+     * @param appWidgetIds 被删除的小部件ID数组
+     */
     @Override
     public void onDeleted(Context context, int[] appWidgetIds) {
         ContentValues values = new ContentValues();
         values.put(NoteColumns.WIDGET_ID, AppWidgetManager.INVALID_APPWIDGET_ID);
+        // 更新数据库，清除被删除小部件的关联信息
         for (int i = 0; i < appWidgetIds.length; i++) {
             context.getContentResolver().update(Notes.CONTENT_NOTE_URI,
                     values,
                     NoteColumns.WIDGET_ID + "=?",
-                    new String[] { String.valueOf(appWidgetIds[i])});
+                    new String[]{String.valueOf(appWidgetIds[i])});
         }
     }
 
+    /**
+     * 获取与小部件关联的便签信息
+     * @param context 上下文
+     * @param widgetId 小部件ID
+     * @return 包含便签信息的Cursor，若无则返回null
+     */
     private Cursor getNoteWidgetInfo(Context context, int widgetId) {
         return context.getContentResolver().query(Notes.CONTENT_NOTE_URI,
                 PROJECTION,
                 NoteColumns.WIDGET_ID + "=? AND " + NoteColumns.PARENT_ID + "<>?",
-                new String[] { String.valueOf(widgetId), String.valueOf(Notes.ID_TRASH_FOLER) },
+                new String[]{String.valueOf(widgetId), String.valueOf(Notes.ID_TRASH_FOLER)},
                 null);
     }
 
+    /**
+     * 更新小部件（隐私模式为false）
+     * @param context 上下文
+     * @param appWidgetManager 小部件管理器
+     * @param appWidgetIds 要更新的小部件ID数组
+     */
     protected void update(Context context, AppWidgetManager appWidgetManager, int[] appWidgetIds) {
         update(context, appWidgetManager, appWidgetIds, false);
     }
 
+    /**
+     * 更新小部件
+     * @param context 上下文
+     * @param appWidgetManager 小部件管理器
+     * @param appWidgetIds 要更新的小部件ID数组
+     * @param privacyMode 是否为隐私模式（显示保护信息）
+     */
     private void update(Context context, AppWidgetManager appWidgetManager, int[] appWidgetIds,
-            boolean privacyMode) {
+                        boolean privacyMode) {
         for (int i = 0; i < appWidgetIds.length; i++) {
             if (appWidgetIds[i] != AppWidgetManager.INVALID_APPWIDGET_ID) {
-                int bgId = ResourceParser.getDefaultBgId(context);
+                int bgId = ResourceParser.getDefaultBgId(context); // 默认背景色ID
-                String snippet = "";
+                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()) {
                     if (c.getCount() > 1) {
@@ -87,12 +121,16 @@ public abstract class NoteWidgetProvider extends AppWidgetProvider {
                         c.close();
                         return;
                     }
+                    // 获取便签摘要和背景色
                     snippet = c.getString(COLUMN_SNIPPET);
                     bgId = c.getInt(COLUMN_BG_COLOR_ID);
+                    // 设置Intent动作为查看已有便签
                     intent.putExtra(Intent.EXTRA_UID, c.getLong(COLUMN_ID));
                     intent.setAction(Intent.ACTION_VIEW);
                 } else {
+                    // 无关联便签时显示提示文本
                     snippet = context.getResources().getString(R.string.widget_havenot_content);
+                    // 设置Intent动作为新建便签
                     intent.setAction(Intent.ACTION_INSERT_OR_EDIT);
                 }
 
@@ -100,33 +138,51 @@ public abstract class NoteWidgetProvider extends AppWidgetProvider {
                     c.close();
                 }
 
+                // 创建RemoteViews对象（需子类提供布局ID）
                 RemoteViews rv = new RemoteViews(context.getPackageName(), getLayoutId());
+                // 设置背景图（需子类提供背景资源ID）
                 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 = null;
                 if (privacyMode) {
-                    rv.setTextViewText(R.id.widget_text,
+                    // 隐私模式下显示保护信息
-                            context.getString(R.string.widget_under_visit_mode));
+                    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();
-}
+}

app/src/main/java/net/micode/notes/widget/NoteWidgetProvider_2x.java

@@ -23,25 +23,48 @@ import net.micode.notes.R;
 import net.micode.notes.data.Notes;
 import net.micode.notes.tool.ResourceParser;
 
-
+/**
+ * 2x2尺寸便签桌面小部件提供者
+ * 继承自NoteWidgetProvider，实现2x2规格便签小部件的特定配置
+ */
 public class NoteWidgetProvider_2x extends NoteWidgetProvider {
+    /**
+     * 小部件更新回调
+     * @param context 上下文
+     * @param appWidgetManager 小部件管理器
+     * @param appWidgetIds 要更新的小部件ID数组
+     */
     @Override
     public void onUpdate(Context context, AppWidgetManager appWidgetManager, int[] appWidgetIds) {
+        // 调用父类的更新方法
         super.update(context, appWidgetManager, appWidgetIds);
     }
 
+    /**
+     * 获取小部件布局资源ID
+     * @return 2x2小部件布局资源ID
+     */
     @Override
     protected int getLayoutId() {
         return R.layout.widget_2x;
     }
 
+    /**
+     * 获取背景资源ID
+     * @param bgId 背景色ID
+     * @return 对应背景色的2x2小部件背景资源ID
+     */
     @Override
     protected int getBgResourceId(int bgId) {
         return ResourceParser.WidgetBgResources.getWidget2xBgResource(bgId);
     }
 
+    /**
+     * 获取小部件类型
+     * @return 小部件类型常量：Notes.TYPE_WIDGET_2X
+     */
     @Override
     protected int getWidgetType() {
         return Notes.TYPE_WIDGET_2X;
     }
-}
+}

app/src/main/java/net/micode/notes/widget/NoteWidgetProvider_4x.java

@@ -23,24 +23,48 @@ import net.micode.notes.R;
 import net.micode.notes.data.Notes;
 import net.micode.notes.tool.ResourceParser;
 
-
+/**
+ * 4x2尺寸便签桌面小部件提供者
+ * 继承自NoteWidgetProvider，实现4x2规格便签小部件的特定配置
+ */
 public class NoteWidgetProvider_4x extends NoteWidgetProvider {
+    /**
+     * 小部件更新回调
+     * @param context 上下文
+     * @param appWidgetManager 小部件管理器
+     * @param appWidgetIds 要更新的小部件ID数组
+     */
     @Override
     public void onUpdate(Context context, AppWidgetManager appWidgetManager, int[] appWidgetIds) {
+        // 调用父类的更新方法
         super.update(context, appWidgetManager, appWidgetIds);
     }
 
+    /**
+     * 获取小部件布局资源ID
+     * @return 4x2小部件布局资源ID
+     */
+    @Override
     protected int getLayoutId() {
         return R.layout.widget_4x;
     }
 
+    /**
+     * 获取背景资源ID
+     * @param bgId 背景色ID
+     * @return 对应背景色的4x2小部件背景资源ID
+     */
     @Override
     protected int getBgResourceId(int bgId) {
         return ResourceParser.WidgetBgResources.getWidget4xBgResource(bgId);
     }
 
+    /**
+     * 获取小部件类型
+     * @return 小部件类型常量：Notes.TYPE_WIDGET_4X
+     */
     @Override
     protected int getWidgetType() {
         return Notes.TYPE_WIDGET_4X;
     }
-}
+}