diff --git a/NotesListActivity.java b/NotesListActivity.java index e843aec..83cd2e2 100644 --- a/NotesListActivity.java +++ b/NotesListActivity.java @@ -77,7 +77,7 @@ import java.io.IOException; import java.io.InputStream; import java.io.InputStreamReader; import java.util.HashSet; - +//主界面，一进入就是这个界面 public class NotesListActivity extends Activity implements OnClickListener, OnItemLongClickListener { private static final int FOLDER_NOTE_LIST_QUERY_TOKEN = 0; @@ -89,7 +89,7 @@ public class NotesListActivity extends Activity implements OnClickListener, OnIt private static final int MENU_FOLDER_CHANGE_NAME = 2; - private static final String PREFERENCE_ADD_INTRODUCTION = "net.micode.notes.introduction"; + private static final String PREFERENCE_ADD_INTRODUCTION = "net.micode.notes.introduction";//单行超过80个字符 private enum ListEditState { NOTE_LIST, SUB_FOLDER, CALL_RECORD_FOLDER @@ -136,8 +136,14 @@ public class NotesListActivity extends Activity implements OnClickListener, OnIt private final static int REQUEST_CODE_NEW_NODE = 103; @Override - protected void onCreate(Bundle savedInstanceState) { - super.onCreate(savedInstanceState); +//创建类 + protected void onCreate(Bundle savedInstanceState) {//需要是final类型，根据程序上下文环境，java关键字final有“这是无法改变的”或“终态的” +//含义，它可以修饰非抽象类、非抽象类成员方法和变量 +//final类不能被继承，没有字类，final类中的方法默认是final的 +//final方法不能被子类的方法覆盖，但可以被继承 +//final成员变量表示常量，只能被赋值一次，赋值后值不再改变 +//final不能用于修饰构造方法 + super.onCreate(savedInstanceState);//调用父类的onCreate函数 setContentView(R.layout.note_list); initResources(); @@ -148,26 +154,30 @@ public class NotesListActivity extends Activity implements OnClickListener, OnIt } @Override +//返回一些子模块完成的数据交给主Activity处理 protected void onActivityResult(int requestCode, int resultCode, Intent data) { if (resultCode == RESULT_OK - && (requestCode == REQUEST_CODE_OPEN_NODE || requestCode == REQUEST_CODE_NEW_NODE)) { + && (requestCode == REQUEST_CODE_OPEN_NODE || requestCode == REQUEST_CODE_NEW_NODE)) {//若结果值和要求值符合要求 mNotesListAdapter.changeCursor(null); } else { - super.onActivityResult(requestCode, resultCode, data); + super.onActivityResult(requestCode, resultCode, data);//调用Activity的onActivityResult } } private void setAppInfoFromRawRes() { + //Android平台给我们提供了一个SharedPreferences类，它是一个轻量级的存储类，特别适合用于保存软件配置参数 SharedPreferences sp = PreferenceManager.getDefaultSharedPreferences(this); if (!sp.getBoolean(PREFERENCE_ADD_INTRODUCTION, false)) { StringBuilder sb = new StringBuilder(); InputStream in = null; try { + //把资源文件放到应用程序的/raw/raw下，那么就可以在应用中使用getResources获取资源后， + //以openRawResource方法（不带后缀的资源文件名）打开这个文件 in = getResources().openRawResource(R.raw.introduction); 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); @@ -189,12 +199,13 @@ public class NotesListActivity extends Activity implements OnClickListener, OnIt } } } - +//创建空的WorkingNote WorkingNote note = WorkingNote.createEmptyNote(this, Notes.ID_ROOT_FOLDER, AppWidgetManager.INVALID_APPWIDGET_ID, Notes.TYPE_WIDGET_INVALIDE, ResourceParser.RED); note.setWorkingText(sb.toString()); if (note.saveNote()) { + //更新保存note的信息 sp.edit().putBoolean(PREFERENCE_ADD_INTRODUCTION, true).commit(); } else { Log.e(TAG, "Save introduction note error"); @@ -208,19 +219,20 @@ public class NotesListActivity extends Activity implements OnClickListener, OnIt super.onStart(); startAsyncNotesListQuery(); } - +//初始化资源 private void initResources() { - mContentResolver = this.getContentResolver(); + mContentResolver = this.getContentResolver();//获取应用程序的数据，得到类似于数据表的东西 mBackgroundQueryHandler = new BackgroundQueryHandler(this.getContentResolver()); mCurrentFolderId = Notes.ID_ROOT_FOLDER; - mNotesListView = (ListView) findViewById(R.id.notes_list); + //findViewById是安卓编程的定位函数，主要是引用.R文件里的引用名 + mNotesListView = (ListView) findViewById(R.id.notes_list);//绑定xml中的ListView，作为Item的容器 mNotesListView.addFooterView(LayoutInflater.from(this).inflate(R.layout.note_list_footer, null), null, false); mNotesListView.setOnItemClickListener(new OnListItemClickListener()); mNotesListView.setOnItemLongClickListener(this); mNotesListAdapter = new NotesListAdapter(this); mNotesListView.setAdapter(mNotesListAdapter); - mAddNewNote = (Button) findViewById(R.id.btn_new_note); + mAddNewNote = (Button) findViewById(R.id.btn_new_note);//在activity中要获取该按钮 mAddNewNote.setOnClickListener(this); mAddNewNote.setOnTouchListener(new NewNoteOnTouchListener()); mDispatch = false; @@ -230,7 +242,7 @@ public class NotesListActivity extends Activity implements OnClickListener, OnIt mState = ListEditState.NOTE_LIST; mModeCallBack = new ModeCallback(); } - +//继承自ListView.MultiChoiceModeListener和OnMenuItemClickListener private class ModeCallback implements ListView.MultiChoiceModeListener, OnMenuItemClickListener { private DropdownMenu mDropDownMenu; private ActionMode mActionMode; @@ -268,12 +280,12 @@ public class NotesListActivity extends Activity implements OnClickListener, OnIt }); return true; } - +//更新菜单 private void updateMenu() { int selectedCount = mNotesListAdapter.getSelectedCount(); // Update dropdown menu String format = getResources().getString(R.string.menu_select_title, selectedCount); - mDropDownMenu.setTitle(format); + mDropDownMenu.setTitle(format);//更改标题 MenuItem item = mDropDownMenu.findItem(R.id.action_select_all); if (item != null) { if (mNotesListAdapter.isAllSelected()) { @@ -663,7 +675,7 @@ public class NotesListActivity extends Activity implements OnClickListener, OnIt } }); } - +/**按返回键时根据情况更改类中的数据 */ @Override public void onBackPressed() { switch (mState) { @@ -687,7 +699,7 @@ public class NotesListActivity extends Activity implements OnClickListener, OnIt break; } } - +/**根据不同类型的widget更新插件，通过intent传送数据； */ private void updateWidget(int appWidgetId, int appWidgetType) { Intent intent = new Intent(AppWidgetManager.ACTION_APPWIDGET_UPDATE); if (appWidgetType == Notes.TYPE_WIDGET_2X) { @@ -706,7 +718,7 @@ public class NotesListActivity extends Activity implements OnClickListener, OnIt sendBroadcast(intent); setResult(RESULT_OK, intent); } - +/**声明监听器，建立菜单，包括名称、视图、删除、更改名称操作 */ private final OnCreateContextMenuListener mFolderOnCreateContextMenuListener = new OnCreateContextMenuListener() { public void onCreateContextMenu(ContextMenu menu, View v, ContextMenuInfo menuInfo) { if (mFocusNoteDataItem != null) { @@ -725,7 +737,7 @@ public class NotesListActivity extends Activity implements OnClickListener, OnIt } super.onContextMenuClosed(menu); } - +/**针对menu中不同的选择进行不同的处理 */ @Override public boolean onContextItemSelected(MenuItem item) { if (mFocusNoteDataItem == null) { @@ -734,10 +746,10 @@ public class NotesListActivity extends Activity implements OnClickListener, OnIt } switch (item.getItemId()) { case MENU_FOLDER_VIEW: - openFolder(mFocusNoteDataItem); + openFolder(mFocusNoteDataItem);//打开对应文件 break; case MENU_FOLDER_DELETE: - AlertDialog.Builder builder = new AlertDialog.Builder(this); + AlertDialog.Builder builder = new AlertDialog.Builder(this);//设置确认是否删除的对话框 builder.setTitle(getString(R.string.alert_title_delete)); builder.setIcon(android.R.drawable.ic_dialog_alert); builder.setMessage(getString(R.string.alert_message_delete_folder)); @@ -748,7 +760,7 @@ public class NotesListActivity extends Activity implements OnClickListener, OnIt } }); builder.setNegativeButton(android.R.string.cancel, null); - builder.show(); + builder.show();//显示对话框 break; case MENU_FOLDER_CHANGE_NAME: showCreateOrModifyFolderDialog(false); @@ -817,13 +829,13 @@ public class NotesListActivity extends Activity implements OnClickListener, OnIt } return true; } - +/**直接调用startSearch函数 */ @Override public boolean onSearchRequested() { startSearch(null, false, null /* appData */, false); return true; } - +/**函数功能：实现将便签导出到文本功能 */ private void exportNoteToText() { final BackupUtils backup = BackupUtils.getInstance(NotesListActivity.this); new AsyncTask() { @@ -865,17 +877,17 @@ public class NotesListActivity extends Activity implements OnClickListener, OnIt }.execute(); } - +/**判断是否正在同步 */ private boolean isSyncMode() { return NotesPreferenceActivity.getSyncAccountName(this).trim().length() > 0; } - +/**跳转到PreferenceActivity界面 */ private void startPreferenceActivity() { Activity from = getParent() != null ? getParent() : this; Intent intent = new Intent(from, NotesPreferenceActivity.class); from.startActivityIfNeeded(intent, -1); } - +/**函数功能：实现对便签列表项的点击事件（短按） */ private class OnListItemClickListener implements OnItemClickListener { public void onItemClick(AdapterView parent, View view, int position, long id) { @@ -916,7 +928,7 @@ public class NotesListActivity extends Activity implements OnClickListener, OnIt } } - +//查询目标文件 private void startQueryDestinationFolders() { String selection = NoteColumns.TYPE + "=? AND " + NoteColumns.PARENT_ID + "<>? AND " + NoteColumns.ID + "<>?"; selection = (mState == ListEditState.NOTE_LIST) ? selection: @@ -934,7 +946,9 @@ public class NotesListActivity extends Activity implements OnClickListener, OnIt }, NoteColumns.MODIFIED_DATE + " DESC"); } - +/**长按某一项时进行的操作 + * 如果长按的是便签，则通过ActionMode菜单实现；如果长按的是文件夹，则通过ContextMenu菜单实现 + */ public boolean onItemLongClick(AdapterView parent, View view, int position, long id) { if (view instanceof NotesListItem) { mFocusNoteDataItem = ((NotesListItem) view).getItemData(); diff --git a/NotesListAdapter.java b/NotesListAdapter.java index 51c9cb9..1440055 100644 --- a/NotesListAdapter.java +++ b/NotesListAdapter.java @@ -30,56 +30,77 @@ import java.util.HashMap; 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 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(); + super(context, null);//父类对象置空 + mSelectedIndex = new HashMap();//新建选项下标的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) { + 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(); + 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(); + Cursor cursor = getCursor();//获取光标位置 for (int i = 0; i < getCount(); i++) { if (cursor.moveToPosition(i)) { if (NoteItemData.getNoteType(cursor) == Notes.TYPE_NOTE) { @@ -87,30 +108,37 @@ public class NotesListAdapter extends CursorAdapter { } } } +//遍历所有光标可用的位置在判断为便签类型之后勾选单项框 } - +/* +建立选择项的下标列表 +*/ public HashSet getSelectedItemIds() { - HashSet itemSet = new HashSet(); - for (Integer position : mSelectedIndex.keySet()) { - if (mSelectedIndex.get(position) == true) { + HashSet itemSet = new HashSet();//建立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"); + Log.d(TAG, "Wrong item id, should not happen");//原文件不需要添加 } else { itemSet.add(id); } +//则将id下标加入选项集合中 } } return itemSet; } - +/* +函数功能：建立桌面widget的选项表 +*/ public HashSet getSelectedWidget() { HashSet itemSet = new HashSet(); for (Integer position : mSelectedIndex.keySet()) { if (mSelectedIndex.get(position) == true) { Cursor c = (Cursor) getItem(position); - if (c != null) { +//以上4句和getSelectedItemIds一样 + if (c != null) {//若光标位置可用就建立新的widget属性并编辑下表和类型，最后添加到选项集中 AppWidgetAttribute widget = new AppWidgetAttribute(); NoteItemData item = new NoteItemData(mContext, c); widget.widgetId = item.getWidgetId(); @@ -127,27 +155,35 @@ public class NotesListAdapter extends CursorAdapter { } return itemSet; } - +/* +函数功能：获取选项个数 +*/ public int getSelectedCount() { - Collection values = mSelectedIndex.values(); + Collection values = mSelectedIndex.values();//首先获取选项下标的值 if (null == values) { return 0; } - Iterator iter = values.iterator(); + Iterator 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 +192,41 @@ 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++) { + 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; } +//否则报错 } } } diff --git a/NotesListItem.java b/NotesListItem.java index 1221e80..93414b7 100644 --- a/NotesListItem.java +++ b/NotesListItem.java @@ -29,38 +29,45 @@ import net.micode.notes.data.Notes; 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);//调整调用父类构造函数的顺序 + inflate(context, R.layout.note_item, this);//将一个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 +76,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,7 +86,7 @@ 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, @@ -87,31 +95,35 @@ public class NotesListItem extends LinearLayout { } 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); } } } +//设置内容，获取相关时间，从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()); } } diff --git a/NotesPreferenceActivity.java b/NotesPreferenceActivity.java index 07c5f7e..7078cf6 100644 --- a/NotesPreferenceActivity.java +++ b/NotesPreferenceActivity.java @@ -15,7 +15,6 @@ */ package net.micode.notes.ui; - import android.accounts.Account; import android.accounts.AccountManager; import android.app.ActionBar; @@ -47,102 +46,124 @@ import net.micode.notes.data.Notes; import net.micode.notes.data.Notes.NoteColumns; import net.micode.notes.gtask.remote.GTaskSyncService; - +/* +此类功能为，在小米便签中实现对背景颜色和字体大小的数据储存，继承了 +PreferenceActivity主要功能为对系统信息和配置进行自动保存的Activity。 +*/ public class NotesPreferenceActivity extends PreferenceActivity { - public static final String PREFERENCE_NAME = "notes_preferences"; + public static final String PREFERENCE_NAME = "notes_preferences";//优先名 - public static final String PREFERENCE_SYNC_ACCOUNT_NAME = "pref_key_account_name"; + public static final String PREFERENCE_SYNC_ACCOUNT_NAME = "pref_key_account_name";//同步账号 - public static final String PREFERENCE_LAST_SYNC_TIME = "pref_last_sync_time"; + public static final String PREFERENCE_LAST_SYNC_TIME = "pref_last_sync_time";同步时间 public static final String PREFERENCE_SET_BG_COLOR_KEY = "pref_key_bg_random_appear"; - private static final String PREFERENCE_SYNC_ACCOUNT_KEY = "pref_sync_account_key"; + private static final String PREFERENCE_SYNC_ACCOUNT_KEY = "pref_sync_account_key";//同步密码 - private static final String AUTHORITIES_FILTER_KEY = "authorities"; + private static final String AUTHORITIES_FILTER_KEY = "authorities";//本地密码 - private PreferenceCategory mAccountCategory; + private PreferenceCategory mAccountCategory;//账户分组 - private GTaskReceiver mReceiver; + private GTaskReceiver mReceiver;//同步任务接收器 - private Account[] mOriAccounts; + private Account[] mOriAccounts;//账户 - private boolean mHasAddedAccount; + private boolean mHasAddedAccount;账户的hash标记 @Override +/* +函数功能：创建一个activity，在函数里要完成所有的正常静态设置。 +参数：Bundle icicle存放了activity当前的状态。 +*/ protected void onCreate(Bundle icicle) { - super.onCreate(icicle); + super.onCreate(icicle);//先执行父类的创建函数 /* using the app icon for navigation */ - getActionBar().setDisplayHomeAsUpEnabled(true); + getActionBar().setDisplayHomeAsUpEnabled(true);//给左上角图标的左边加上一个返回的图标 - addPreferencesFromResource(R.xml.preferences); - mAccountCategory = (PreferenceCategory) findPreference(PREFERENCE_SYNC_ACCOUNT_KEY); + addPreferencesFromResource(R.xml.preferences);//添加xml来源并显示xml + mAccountCategory = (PreferenceCategory) findPreference(PREFERENCE_SYNC_ACCOUNT_KEY);//根据同步账户关键码来初始化分组 mReceiver = new GTaskReceiver(); IntentFilter filter = new IntentFilter(); filter.addAction(GTaskSyncService.GTASK_SERVICE_BROADCAST_NAME); registerReceiver(mReceiver, filter); +//初始化同步组件 - mOriAccounts = null; - View header = LayoutInflater.from(this).inflate(R.layout.settings_header, null); - getListView().addHeaderView(header, null, true); + mOriAccounts = null;//mOriAccounts赋值为null + View header = LayoutInflater.from(this).inflate(R.layout.settings_header, null);//获取listview，ListView用于列出所有选择 + getListView().addHeaderView(header, null, true);//在listview组件上方添加其他组件 } @Override + +/* +函数功能：activity交互功能的实现，用于接受用户的输入 +*/ protected void onResume() { - super.onResume(); + super.onResume();//先执行父类的交互实现 // need to set sync account automatically if user has added a new // account - if (mHasAddedAccount) { - Account[] accounts = getGoogleAccounts(); - if (mOriAccounts != null && accounts.length > mOriAccounts.length) { + if (mHasAddedAccount) {//若用户新加了账户则自动设置同步账户 + Account[] accounts = getGoogleAccounts();//获取google同步账户 + if (mOriAccounts != null && accounts.length > mOriAccounts.length) {//若原账户不为空且当前账户有增加 for (Account accountNew : accounts) { boolean found = false; for (Account accountOld : mOriAccounts) { if (TextUtils.equals(accountOld.name, accountNew.name)) { +//更新账户 found = true; break; } } if (!found) { - setSyncAccount(accountNew.name); + setSyncAccount(accountNew.name);//若是没有找到旧的账户，那么同步账号中就只添加新账户 break; } } } } - refreshUI(); + refreshUI();//刷新标签页面 } @Override + +/* +函数功能：销毁一个activity +*/ protected void onDestroy() { - if (mReceiver != null) { - unregisterReceiver(mReceiver); + if (mReceiver != null) {//如果mReceiver不为空 + unregisterReceiver(mReceiver);//注销接收器 } - super.onDestroy(); + super.onDestroy();//执行父类的销毁动作 } - +/* +函数功能：重新设置账户信息 +*/ private void loadAccountPreference() { - mAccountCategory.removeAll(); + mAccountCategory.removeAll();//销毁所有的分组 - Preference accountPref = new Preference(this); + Preference accountPref = new Preference(this);//建立首选项 final String defaultAccount = getSyncAccountName(this); accountPref.setTitle(getString(R.string.preferences_account_title)); accountPref.setSummary(getString(R.string.preferences_account_summary)); +//设置首选项的大标题和小标题 accountPref.setOnPreferenceClickListener(new OnPreferenceClickListener() { - public boolean onPreferenceClick(Preference preference) { + public boolean onPreferenceClick(Preference preference) {//建立监听器 if (!GTaskSyncService.isSyncing()) { - if (TextUtils.isEmpty(defaultAccount)) { + if (TextUtils.isEmpty(defaultAccount)) {//若是第一次建立账户显示选择账户提示对话框 // the first time to set account showSelectAccountAlertDialog(); } else { +//若是已经建立则显示修改对话框并进行修改操作 // if the account has already been set, we need to promp // user about the risk showChangeAccountConfirmAlertDialog(); } } else { +//若在没有同步的情况下，则在toast中显示不能修改 Toast.makeText(NotesPreferenceActivity.this, R.string.preferences_toast_cannot_change_account, Toast.LENGTH_SHORT) .show(); @@ -150,23 +171,27 @@ public class NotesPreferenceActivity extends PreferenceActivity { return true; } }); - + //根据新建首选项编辑新的账户分组 mAccountCategory.addPreference(accountPref); } - +/* +函数功能：设置按键的状态和最后同步的时间 +*/ private void loadSyncButton() { Button syncButton = (Button) findViewById(R.id.preference_sync_button); TextView lastSyncTimeView = (TextView) findViewById(R.id.prefenerece_sync_status_textview); - +//获取同步按钮控件和最终同步时间的窗口 // set button state - if (GTaskSyncService.isSyncing()) { +//设置按钮的状态 + if (GTaskSyncService.isSyncing()) {//若是在同步状态下 syncButton.setText(getString(R.string.preferences_button_sync_cancel)); syncButton.setOnClickListener(new View.OnClickListener() { public void onClick(View v) { GTaskSyncService.cancelSync(NotesPreferenceActivity.this); } }); - } else { +//设置按钮显示的文本为“取消同步”以及监听器 + } else {//若是不同步则设置按钮显示的文本为“立即同步”以及对应监听器 syncButton.setText(getString(R.string.preferences_button_sync_immediately)); syncButton.setOnClickListener(new View.OnClickListener() { public void onClick(View v) { @@ -174,49 +199,57 @@ public class NotesPreferenceActivity extends PreferenceActivity { } }); } - syncButton.setEnabled(!TextUtils.isEmpty(getSyncAccountName(this))); + syncButton.setEnabled(!TextUtils.isEmpty(getSyncAccountName(this)));//设置按键可用还是不可用 // set last sync time - if (GTaskSyncService.isSyncing()) { +//设置最终同步时间 + if (GTaskSyncService.isSyncing()) {//若是再同步情况下 lastSyncTimeView.setText(GTaskSyncService.getProgressString()); lastSyncTimeView.setVisibility(View.VISIBLE); - } else { +//根据当前同步服务器设置时间显示框的文本以及可见性 + } else {//若是非同步情况 long lastSyncTime = getLastSyncTime(this); if (lastSyncTime != 0) { lastSyncTimeView.setText(getString(R.string.preferences_last_sync_time, DateFormat.format(getString(R.string.preferences_last_sync_time_format), lastSyncTime))); lastSyncTimeView.setVisibility(View.VISIBLE); - } else { +//则根据最后同步数据的信息来编辑时间显示框的文本内容和可见性 + } else {//若时间为空直接设置为不可见状态 lastSyncTimeView.setVisibility(View.GONE); } } } +/* +函数功能：刷新标签界面（调用上文设置账号和设置按键两个函数来实现） +*/ private void refreshUI() { loadAccountPreference(); loadSyncButton(); } - +/* +函数功能：显示账户选择的对话框并进行账户的设置 +*/ private void showSelectAccountAlertDialog() { - AlertDialog.Builder dialogBuilder = new AlertDialog.Builder(this); + AlertDialog.Builder dialogBuilder = new AlertDialog.Builder(this);//创建一个新的对话框 View titleView = LayoutInflater.from(this).inflate(R.layout.account_dialog_title, null); TextView titleTextView = (TextView) titleView.findViewById(R.id.account_dialog_title); titleTextView.setText(getString(R.string.preferences_dialog_select_account_title)); TextView subtitleTextView = (TextView) titleView.findViewById(R.id.account_dialog_subtitle); subtitleTextView.setText(getString(R.string.preferences_dialog_select_account_tips)); - +//设置标题以及子标题的内容 dialogBuilder.setCustomTitle(titleView); dialogBuilder.setPositiveButton(null, null); - +//设置对话框的自定义标题，建立一个YES的按钮 Account[] accounts = getGoogleAccounts(); String defAccount = getSyncAccountName(this); - +//获取同步账户信息 mOriAccounts = accounts; mHasAddedAccount = false; - if (accounts.length > 0) { + if (accounts.length > 0) {//若账户不为空 CharSequence[] items = new CharSequence[accounts.length]; final CharSequence[] itemMapping = items; int checkedItem = -1; @@ -224,38 +257,45 @@ public class NotesPreferenceActivity extends PreferenceActivity { for (Account account : accounts) { if (TextUtils.equals(account.name, defAccount)) { checkedItem = index; +//在账户列表中查询到所需账户 } items[index++] = account.name; } - dialogBuilder.setSingleChoiceItems(items, checkedItem, + dialogBuilder.setSingleChoiceItems(items, checkedItem,//在对话框建立一个单选的复选框 new DialogInterface.OnClickListener() { public void onClick(DialogInterface dialog, int which) { setSyncAccount(itemMapping[which].toString()); - dialog.dismiss(); + dialog.dismiss();//取消对话框 refreshUI(); } +//设置点击后执行的事件，包括检录新同步账户和刷新标签界面 }); +//建立对话框网络版的监听器 } View addAccountView = LayoutInflater.from(this).inflate(R.layout.add_account_text, null); dialogBuilder.setView(addAccountView); - - final AlertDialog dialog = dialogBuilder.show(); +//给新加账户对话框设置自定义样式 + final AlertDialog dialog = dialogBuilder.show();//显示对话框 addAccountView.setOnClickListener(new View.OnClickListener() { public void onClick(View v) { - mHasAddedAccount = true; - Intent intent = new Intent("android.settings.ADD_ACCOUNT_SETTINGS"); + mHasAddedAccount = true;//将新加账户的hash置true + Intent intent = new Intent("android.settings.ADD_ACCOUNT_SETTINGS");//建立网络建立组件 intent.putExtra(AUTHORITIES_FILTER_KEY, new String[] { "gmail-ls" }); startActivityForResult(intent, -1); +//跳回上一个选项 dialog.dismiss(); } }); +//建立新加账户对话框的监听器 } - +/* +函数功能：显示账户选择对话框和相关账户操作 +*/ private void showChangeAccountConfirmAlertDialog() { - AlertDialog.Builder dialogBuilder = new AlertDialog.Builder(this); + AlertDialog.Builder dialogBuilder = new AlertDialog.Builder(this);//创建一个新的对话框 View titleView = LayoutInflater.from(this).inflate(R.layout.account_dialog_title, null); TextView titleTextView = (TextView) titleView.findViewById(R.id.account_dialog_title); @@ -263,44 +303,53 @@ public class NotesPreferenceActivity extends PreferenceActivity { getSyncAccountName(this))); TextView subtitleTextView = (TextView) titleView.findViewById(R.id.account_dialog_subtitle); subtitleTextView.setText(getString(R.string.preferences_dialog_change_account_warn_msg)); - dialogBuilder.setCustomTitle(titleView); +//根据同步修改的账户信息设置标题以及子标题的内容 + dialogBuilder.setCustomTitle(titleView);//设置对话框的自定义标题 CharSequence[] menuItemArray = new CharSequence[] { getString(R.string.preferences_menu_change_account), getString(R.string.preferences_menu_remove_account), getString(R.string.preferences_menu_cancel) - }; - dialogBuilder.setItems(menuItemArray, new DialogInterface.OnClickListener() { - public void onClick(DialogInterface dialog, int which) { + };//定义一些标记字符串 + dialogBuilder.setItems(menuItemArray, new DialogInterface.OnClickListener() {//设置对话框要显示的一个list,用于显示几个命令时，即change，remove，cancel + public void onClick(DialogInterface dialog, int which) {//按键功能由which来决定 if (which == 0) { +//进入账户选择对话框 showSelectAccountAlertDialog(); } else if (which == 1) { +//删除账户且更新便签界面 removeSyncAccount(); refreshUI(); } } }); - dialogBuilder.show(); + dialogBuilder.show();//显示对话框 } - +/* +函数功能：获取谷歌账户（通过账户管理器直接获取） +*/ private Account[] getGoogleAccounts() { AccountManager accountManager = AccountManager.get(this); return accountManager.getAccountsByType("com.google"); } - +/* +函数功能：设置同步账户 +*/ private void setSyncAccount(String account) { - if (!getSyncAccountName(this).equals(account)) { + if (!getSyncAccountName(this).equals(account)) {//假如该账号不在同步账号列表中 SharedPreferences settings = getSharedPreferences(PREFERENCE_NAME, Context.MODE_PRIVATE); SharedPreferences.Editor editor = settings.edit(); +//编辑共享的首选项 if (account != null) { editor.putString(PREFERENCE_SYNC_ACCOUNT_NAME, account); } else { editor.putString(PREFERENCE_SYNC_ACCOUNT_NAME, ""); } - editor.commit(); +//将该帐号加入到首选项中 + editor.commit();//提交修改的数据 // clean up last sync time - setLastSyncTime(this, 0); + setLastSyncTime(this, 0);//将最后同步时间请零 // clean up local gtask related info new Thread(new Runnable() { @@ -311,23 +360,27 @@ public class NotesPreferenceActivity extends PreferenceActivity { getContentResolver().update(Notes.CONTENT_NOTE_URI, values, null, null); } }).start(); - +//重置当地同步任务的信息 Toast.makeText(NotesPreferenceActivity.this, getString(R.string.preferences_toast_success_set_accout, account), Toast.LENGTH_SHORT).show(); +//将toast的文本信息置为“设置账户成功”并显示出来 } } - +/* +函数功能：删除同步账户 +*/ private void removeSyncAccount() { SharedPreferences settings = getSharedPreferences(PREFERENCE_NAME, Context.MODE_PRIVATE); SharedPreferences.Editor editor = settings.edit(); - if (settings.contains(PREFERENCE_SYNC_ACCOUNT_NAME)) { +//设置共享首选项 + if (settings.contains(PREFERENCE_SYNC_ACCOUNT_NAME)) {//若当前首选项中有账户就删除 editor.remove(PREFERENCE_SYNC_ACCOUNT_NAME); } if (settings.contains(PREFERENCE_LAST_SYNC_TIME)) { - editor.remove(PREFERENCE_LAST_SYNC_TIME); + editor.remove(PREFERENCE_LAST_SYNC_TIME);//删除当前首选项中有账户时间 } - editor.commit(); + editor.commit();//提交更新后的数据 // clean up local gtask related info new Thread(new Runnable() { @@ -338,49 +391,66 @@ public class NotesPreferenceActivity extends PreferenceActivity { getContentResolver().update(Notes.CONTENT_NOTE_URI, values, null, null); } }).start(); +//重置当地同步任务的信息 } - +/* +函数功能：获取同步账户名称（通过共享的首选项里的信息直接获取） +*/ public static String getSyncAccountName(Context context) { SharedPreferences settings = context.getSharedPreferences(PREFERENCE_NAME, Context.MODE_PRIVATE); return settings.getString(PREFERENCE_SYNC_ACCOUNT_NAME, ""); } - +/* +函数功能：设置最终同步时间 +*/ public static void setLastSyncTime(Context context, long time) { SharedPreferences settings = context.getSharedPreferences(PREFERENCE_NAME, Context.MODE_PRIVATE); SharedPreferences.Editor editor = settings.edit(); +//从共享首选项中找到相关账户并获取其编辑器 editor.putLong(PREFERENCE_LAST_SYNC_TIME, time); editor.commit(); +//编辑最终同步时间并提交更新 } - +/* +函数功能：获取最终同步时间（通过共享的首选项里的信息直接获取） +*/ public static long getLastSyncTime(Context context) { SharedPreferences settings = context.getSharedPreferences(PREFERENCE_NAME, Context.MODE_PRIVATE); return settings.getLong(PREFERENCE_LAST_SYNC_TIME, 0); } - +/* +函数功能：接受同步信息（继承BroadcastReceiver） +*/ private class GTaskReceiver extends BroadcastReceiver { @Override public void onReceive(Context context, Intent intent) { refreshUI(); if (intent.getBooleanExtra(GTaskSyncService.GTASK_SERVICE_BROADCAST_IS_SYNCING, false)) { +//获取随广播而来的Internet中的同步服务的数据 TextView syncStatus = (TextView) findViewById(R.id.prefenerece_sync_status_textview); syncStatus.setText(intent .getStringExtra(GTaskSyncService.GTASK_SERVICE_BROADCAST_PROGRESS_MSG)); +//通过获取的数据设置系统的状态 } } } - +/* +函数功能：处理菜单的选项 +参数：MenuItem菜单选项 +*/ public boolean onOptionsItemSelected(MenuItem item) { - switch (item.getItemId()) { + switch (item.getItemId()) {//根据选项的id选择，这里只有一个主页 case android.R.id.home: Intent intent = new Intent(this, NotesListActivity.class); intent.addFlags(Intent.FLAG_ACTIVITY_CLEAR_TOP); startActivity(intent); return true; +//在主页情况下创建连接组件intent，发出清空的信号并开始一个相应的activity default: return false; } diff --git a/小米便签开源代码的泛读报告.docx b/小米便签开源代码的泛读报告.docx new file mode 100644 index 0000000..fddd9f7 Binary files /dev/null and b/小米便签开源代码的泛读报告.docx differ