123

doc/ui/NotesListActivity.java

@@ -77,12 +77,12 @@ import java.io.IOException;
 import java.io.InputStream;
 import java.io.InputStreamReader;
 import java.util.HashSet;
-//主界面，一进入就是这个界面
+//主界面
 /**
  * @author k
  *
  */
-public class NotesListActivity extends Activity implements OnClickListener, OnItemLongClickListener {   //没有用特定的标签加注释。。。感觉没有什么用
+public class NotesListActivity extends Activity implements OnClickListener, OnItemLongClickListener {
     private static final int FOLDER_NOTE_LIST_QUERY_TOKEN = 0;
 
     private static final int FOLDER_LIST_QUERY_TOKEN      = 1;
@@ -141,7 +141,9 @@ public class NotesListActivity extends Activity implements OnClickListener, OnIt
 
     @Override
     // 创建类
-    protected void onCreate(final Bundle savedInstanceState) {  //需要是final类型   根据程序上下文环境，Java关键字final有“这是无法改变的”或者“终态的”含义，它可以修饰非抽象类、非抽象类成员方法和变量。你可能出于两种理解而需要阻止改变：设计或效率。
+    protected void onCreate(final Bundle savedInstanceState) {
+        //需要是final类型   根据程序上下文环境，Java关键字final有“这是无法改变的”或者“终态的”含义，
+        // 它可以修饰非抽象类、非抽象类成员方法和变量。
         // final类不能被继承，没有子类，final类中的方法默认是final的。
         //final方法不能被子类的方法覆盖，但可以被继承。
         //final成员变量表示常量，只能被赋值一次，赋值后值不再改变。
@@ -170,7 +172,7 @@ public class NotesListActivity extends Activity implements OnClickListener, OnIt
     }
 
     private void setAppInfoFromRawRes() {
-        // Android平台给我们提供了一个SharedPreferences类，它是一个轻量级的存储类，特别适合用于保存软件配置参数。
+        // Android平台给提供了一个SharedPreferences类，它是一个轻量级的存储类，特别适合用于保存软件配置参数。
         SharedPreferences sp = PreferenceManager.getDefaultSharedPreferences(this);
         if (!sp.getBoolean(PREFERENCE_ADD_INTRODUCTION, false)) {
             StringBuilder sb = new StringBuilder();
@@ -182,7 +184,7 @@ public class NotesListActivity extends Activity implements OnClickListener, OnIt
                 if (in != null) {
                     InputStreamReader isr = new InputStreamReader(in);
                     BufferedReader br = new BufferedReader(isr);
-                    char [] buf = new char[1024];  // 自行定义的数值，使用者不知道有什么意义
+                    char [] buf = new char[1024];  // 自行定义的数值
                     int len = 0;
                     while ((len = br.read(buf)) > 0) {
                         sb.append(buf, 0, len);

doc/ui/NotesListAdapter.java

@@ -14,6 +14,7 @@
  * limitations under the License.
  */
 
+
 package net.micode.notes.ui;
 
 import android.content.Context;
@@ -23,6 +24,7 @@ import android.view.View;
 import android.view.ViewGroup;
 import android.widget.CursorAdapter;
 
+
 import net.micode.notes.data.Notes;
 
 import java.util.Collection;
@@ -31,55 +33,94 @@ import java.util.HashSet;
 import java.util.Iterator;
 
 
+/*
+ * 功能：直译为便签表连接器，继承了CursorAdapter，它为cursor和ListView提供了连接的桥梁。
+ *     所以NotesListAdapter实现的是鼠标和编辑便签链接的桥梁
+ */
 public class NotesListAdapter extends CursorAdapter {
     private static final String TAG = "NotesListAdapter";
     private Context mContext;
     private HashMap<Integer, Boolean> mSelectedIndex;
-    private int mNotesCount;
-    private boolean mChoiceMode;
+    private int mNotesCount;    //便签数
+    private boolean mChoiceMode;   //选择模式标记
 
+    /*
+     * 桌面widget的属性，包括编号和类型
+     */
     public static class AppWidgetAttribute {
         public int widgetId;
         public int widgetType;
     };
 
+    /*
+     * 函数功能：初始化便签链接器
+     * 函数实现：根据传进来的内容设置相关变量
+     */
     public NotesListAdapter(Context context) {
-        super(context, null);
-        mSelectedIndex = new HashMap<Integer, Boolean>();
+        super(context, null);  //父类对象置空
+        mSelectedIndex = new HashMap<Integer, Boolean>();  //新建选项下标的hash表
         mContext = context;
         mNotesCount = 0;
     }
 
     @Override
+    /*
+     * 函数功能：新建一个视图来存储光标所指向的数据
+     * 函数实现：使用兄弟类NotesListItem新建一个项目选项
+     */
     public View newView(Context context, Cursor cursor, ViewGroup parent) {
         return new NotesListItem(context);
     }
 
+    /*
+     * 函数功能：将已经存在的视图和鼠标指向的数据进行捆绑
+     * 函数实现：如下注释
+     */
     @Override
     public void bindView(View view, Context context, Cursor cursor) {
         if (view instanceof NotesListItem) {
+            //若view是NotesListItem的一个实例
             NoteItemData itemData = new NoteItemData(context, cursor);
             ((NotesListItem) view).bind(context, itemData, mChoiceMode,
                     isSelectedItem(cursor.getPosition()));
+            //则新建一个项目选项并且用bind跟将view和鼠标，内容，便签数据捆绑在一起
         }
     }
 
+    /*
+     * 函数功能：设置勾选框
+     * 函数实现：如下注释
+     */
     public void setCheckedItem(final int position, final boolean checked) {
         mSelectedIndex.put(position, checked);
+        //根据定位和是否勾选设置下标
         notifyDataSetChanged();
+        //在修改后刷新activity
     }
 
+    /*
+     * 函数功能：判断单选按钮是否勾选
+     */
     public boolean isInChoiceMode() {
         return mChoiceMode;
     }
 
+    /*
+     * 函数功能：设置单项选项框
+     * 函数实现：重置下标并且根据参数mode设置选项
+     */
     public void setChoiceMode(boolean mode) {
         mSelectedIndex.clear();
         mChoiceMode = mode;
     }
 
+    /*
+     * 函数功能：选择全部选项
+     * 函数实现：如下注释
+     */
     public void selectAll(boolean checked) {
         Cursor cursor = getCursor();
+        //获取光标位置
         for (int i = 0; i < getCount(); i++) {
             if (cursor.moveToPosition(i)) {
                 if (NoteItemData.getNoteType(cursor) == Notes.TYPE_NOTE) {
@@ -87,30 +128,47 @@ public class NotesListAdapter extends CursorAdapter {
                 }
             }
         }
+        //遍历所有光标可用的位置在判断为便签类型之后勾选单项框
     }
 
+    /*
+     * 函数功能：建立选择项的下标列表
+     * 函数实现：如下注释
+     */
     public HashSet<Long> getSelectedItemIds() {
         HashSet<Long> itemSet = new HashSet<Long>();
+        //建立hash表
         for (Integer position : mSelectedIndex.keySet()) {
+            //遍历所有的关键
             if (mSelectedIndex.get(position) == true) {
+                //若光标位置可用
                 Long id = getItemId(position);
                 if (id == Notes.ID_ROOT_FOLDER) {
+                    //原文件不需要添加
                     Log.d(TAG, "Wrong item id, should not happen");
                 } else {
                     itemSet.add(id);
                 }
+                //则将id该下标假如选项集合中
+
             }
         }
 
         return itemSet;
     }
 
+    /*
+     * 函数功能：建立桌面Widget的选项表
+     * 函数实现：如下注释
+     */
     public HashSet<AppWidgetAttribute> getSelectedWidget() {
         HashSet<AppWidgetAttribute> itemSet = new HashSet<AppWidgetAttribute>();
         for (Integer position : mSelectedIndex.keySet()) {
             if (mSelectedIndex.get(position) == true) {
                 Cursor c = (Cursor) getItem(position);
+                //以上4句和getSelectedItemIds一样，不再重复
                 if (c != null) {
+                    //光标位置可用的话就建立新的Widget属性并编辑下标和类型，最后添加到选项集中
                     AppWidgetAttribute widget = new AppWidgetAttribute();
                     NoteItemData item = new NoteItemData(mContext, c);
                     widget.widgetId = item.getWidgetId();
@@ -128,26 +186,42 @@ public class NotesListAdapter extends CursorAdapter {
         return itemSet;
     }
 
+    /*
+     * 函数功能：获取选项个数
+     * 函数实现：如下注释
+     */
     public int getSelectedCount() {
         Collection<Boolean> values = mSelectedIndex.values();
+        //首先获取选项下标的值
         if (null == values) {
             return 0;
         }
         Iterator<Boolean> iter = values.iterator();
+        //初始化叠加器
         int count = 0;
         while (iter.hasNext()) {
             if (true == iter.next()) {
+                //若value值为真计数+1
                 count++;
             }
         }
         return count;
     }
 
+    /*
+     * 函数功能：判断是否全部选中
+     * 函数实现：如下注释
+     */
     public boolean isAllSelected() {
         int checkedCount = getSelectedCount();
         return (checkedCount != 0 && checkedCount == mNotesCount);
+        //获取选项数看是否等于便签的个数
     }
 
+    /*
+     * 函数功能：判断是否为选项表
+     * 函数实现：通过传递的下标来确定
+     */
     public boolean isSelectedItem(final int position) {
         if (null == mSelectedIndex.get(position)) {
             return false;
@@ -156,29 +230,45 @@ public class NotesListAdapter extends CursorAdapter {
     }
 
     @Override
+    /*
+     * 函数功能：在activity内容发生局部变动的时候回调该函数计算便签的数量
+     * 函数实现：如下注释
+     */
     protected void onContentChanged() {
         super.onContentChanged();
+        //执行基类函数
         calcNotesCount();
     }
 
     @Override
+    /*
+     * 函数功能：在activity光标发生局部变动的时候回调该函数计算便签的数量
+     */
     public void changeCursor(Cursor cursor) {
         super.changeCursor(cursor);
+        //执行基类函数
         calcNotesCount();
     }
 
+    /*
+     * 函数功能：计算便签数量
+     *
+     */
     private void calcNotesCount() {
         mNotesCount = 0;
         for (int i = 0; i < getCount(); i++) {
+            //获取总数同时遍历
             Cursor c = (Cursor) getItem(i);
             if (c != null) {
                 if (NoteItemData.getNoteType(c) == Notes.TYPE_NOTE) {
                     mNotesCount++;
+                    //若该位置不为空并且文本类型为便签就+1
                 }
             } else {
                 Log.e(TAG, "Invalid cursor");
                 return;
             }
+            //否则报错
         }
     }
-}
+}

doc/ui/NotesListItem.java

@@ -14,6 +14,22 @@
  * limitations under the License.
  */
 
+/*
+ * 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.ui;
 
 import android.content.Context;
@@ -30,37 +46,43 @@ import net.micode.notes.tool.DataUtils;
 import net.micode.notes.tool.ResourceParser.NoteItemBgResources;
 
 
+//创建便签列表项目选项
 public class NotesListItem extends LinearLayout {
-    private ImageView mAlert;
-    private TextView mTitle;
-    private TextView mTime;
-    private TextView mCallName;
-    private NoteItemData mItemData;
-    private CheckBox mCheckBox;
+    private ImageView mAlert;//闹钟图片
+    private TextView mTitle;  //标题
+    private TextView mTime;   //时间
+    private TextView mCallName;    //
+    private NoteItemData mItemData; //标签数据
+    private CheckBox mCheckBox;    //打钩框
 
+    /*初始化基本信息*/
     public NotesListItem(Context context) {
-        super(context);
-        inflate(context, R.layout.note_item, this);
+        super(context);   //super()它的主要作用是调整调用父类构造函数的顺序
+        inflate(context, R.layout.note_item, this);//Inflate可用于将一个xml中定义的布局控件找出来,这里的xml是r.layout
+        //findViewById用于从contentView中查找指定ID的View，转换出来的形式根据需要而定
         mAlert = (ImageView) findViewById(R.id.iv_alert_icon);
         mTitle = (TextView) findViewById(R.id.tv_title);
         mTime = (TextView) findViewById(R.id.tv_time);
         mCallName = (TextView) findViewById(R.id.tv_name);
         mCheckBox = (CheckBox) findViewById(android.R.id.checkbox);
     }
-
+    //根据data的属性对各个控件的属性的控制，主要是可见性Visibility，内容setText，格式setTextAppearance
     public void bind(Context context, NoteItemData data, boolean choiceMode, boolean checked) {
         if (choiceMode && data.getType() == Notes.TYPE_NOTE) {
-            mCheckBox.setVisibility(View.VISIBLE);
-            mCheckBox.setChecked(checked);
+            mCheckBox.setVisibility(View.VISIBLE);  ///设置可见行为可见
+            mCheckBox.setChecked(checked);         ///格子打钩
         } else {
             mCheckBox.setVisibility(View.GONE);
         }
 
         mItemData = data;
+        ///设置控件属性，一共三种情况，由data的id和父id是否与保存到文件夹的id一致来决定
         if (data.getId() == Notes.ID_CALL_RECORD_FOLDER) {
             mCallName.setVisibility(View.GONE);
             mAlert.setVisibility(View.VISIBLE);
+            //设置该textview的style
             mTitle.setTextAppearance(context, R.style.TextAppearancePrimaryItem);
+            //setText为设置内容
             mTitle.setText(context.getString(R.string.call_record_folder_name)
                     + context.getString(R.string.format_folder_files_count, data.getNotesCount()));
             mAlert.setImageResource(R.drawable.call_record);
@@ -69,8 +91,9 @@ public class NotesListItem extends LinearLayout {
             mCallName.setText(data.getCallName());
             mTitle.setTextAppearance(context,R.style.TextAppearanceSecondaryItem);
             mTitle.setText(DataUtils.getFormattedSnippet(data.getSnippet()));
+            ///给闹钟进行相关设置
             if (data.hasAlert()) {
-                mAlert.setImageResource(R.drawable.clock);
+                mAlert.setImageResource(R.drawable.clock);//图片来源的设置
                 mAlert.setVisibility(View.VISIBLE);
             } else {
                 mAlert.setVisibility(View.GONE);
@@ -78,45 +101,48 @@ public class NotesListItem extends LinearLayout {
         } else {
             mCallName.setVisibility(View.GONE);
             mTitle.setTextAppearance(context, R.style.TextAppearancePrimaryItem);
-
+            ///设置title格式
             if (data.getType() == Notes.TYPE_FOLDER) {
                 mTitle.setText(data.getSnippet()
                         + context.getString(R.string.format_folder_files_count,
-                                data.getNotesCount()));
+                        data.getNotesCount()));
                 mAlert.setVisibility(View.GONE);
             } else {
                 mTitle.setText(DataUtils.getFormattedSnippet(data.getSnippet()));
                 if (data.hasAlert()) {
-                    mAlert.setImageResource(R.drawable.clock);
+                    mAlert.setImageResource(R.drawable.clock);///设置图片来源
                     mAlert.setVisibility(View.VISIBLE);
                 } else {
                     mAlert.setVisibility(View.GONE);
                 }
             }
         }
-        mTime.setText(DateUtils.getRelativeTimeSpanString(data.getModifiedDate()));
+        ///设置内容，获取相关时间，从data里编辑的日期中获取
+        mTime. setText(DateUtils.getRelativeTimeSpanString(data.getModifiedDate()));
 
         setBackground(data);
     }
-
+    //根据data的文件属性来设置背景
     private void setBackground(NoteItemData data) {
         int id = data.getBgColorId();
+        //，若是note型文件，则4种情况，对于4种不同情况的背景来源
         if (data.getType() == Notes.TYPE_NOTE) {
+            //单个数据并且只有一个子文件夹
             if (data.isSingle() || data.isOneFollowingFolder()) {
                 setBackgroundResource(NoteItemBgResources.getNoteBgSingleRes(id));
-            } else if (data.isLast()) {
+            } else if (data.isLast()) {//是最后一个数据
                 setBackgroundResource(NoteItemBgResources.getNoteBgLastRes(id));
-            } else if (data.isFirst() || data.isMultiFollowingFolder()) {
+            } else if (data.isFirst() || data.isMultiFollowingFolder()) {//是一个数据并有多个子文件夹
                 setBackgroundResource(NoteItemBgResources.getNoteBgFirstRes(id));
             } else {
                 setBackgroundResource(NoteItemBgResources.getNoteBgNormalRes(id));
             }
         } else {
+            //若不是note直接调用文件夹的背景来源
             setBackgroundResource(NoteItemBgResources.getFolderBgRes());
         }
     }
-
     public NoteItemData getItemData() {
         return mItemData;
     }
-}
+}