diff --git a/doc/小米便签开源代码的泛读报告(实验一).docx b/doc/01_温雍敬_泛读报告.docx similarity index 100% rename from doc/小米便签开源代码的泛读报告(实验一).docx rename to doc/01_温雍敬_泛读报告.docx diff --git a/doc/小米便签开源代码的质量分析报告.docx b/doc/02_温雍敬_质量分析报告.docx similarity index 100% rename from doc/小米便签开源代码的质量分析报告.docx rename to doc/02_温雍敬_质量分析报告.docx diff --git a/doc/小米便签维护需求与设计方案.docx b/doc/03_温雍敬_维护需求与设计方案.docx similarity index 100% rename from doc/小米便签维护需求与设计方案.docx rename to doc/03_温雍敬_维护需求与设计方案.docx diff --git a/other/小米便签阅读与维护-汇报.pptx b/other/04_温雍敬_软件工程汇报PPT.pptx similarity index 100% rename from other/小米便签阅读与维护-汇报.pptx rename to other/04_温雍敬_软件工程汇报PPT.pptx diff --git a/other/05_温雍敬_系统演示录屏.mp4 b/other/05_温雍敬_系统演示录屏.mp4 new file mode 100644 index 0000000..2ff7a3e Binary files /dev/null and b/other/05_温雍敬_系统演示录屏.mp4 differ diff --git a/other/06_温雍敬_贡献度Excel.xls b/other/06_温雍敬_贡献度Excel.xls new file mode 100644 index 0000000..bc107dd Binary files /dev/null and b/other/06_温雍敬_贡献度Excel.xls differ diff --git a/other/07_210340161孙庆斌_代码标注/AlarmReceiver.java b/other/07_210340161孙庆斌_代码标注/AlarmReceiver.java new file mode 100644 index 0000000..ad7328c --- /dev/null +++ b/other/07_210340161孙庆斌_代码标注/AlarmReceiver.java @@ -0,0 +1,30 @@ +/* + * 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.BroadcastReceiver; +import android.content.Context; +import android.content.Intent; + +public class AlarmReceiver extends BroadcastReceiver { //类描述：继承广播接收器的类闹钟消息接收器 + @Override + public void onReceive(Context context, Intent intent) {//对闹铃进行监听，为intent设置class对象并增加标志 + intent.setClass(context, AlarmAlertActivity.class);//将该intent与类AlarmAlertActivity建立连接。 + intent.addFlags(Intent.FLAG_ACTIVITY_NEW_TASK); + context.startActivity(intent);//启动该intent所连接的类 + } +} diff --git a/other/07_210340161孙庆斌_代码标注/NoteEditText.java b/other/07_210340161孙庆斌_代码标注/NoteEditText.java new file mode 100644 index 0000000..b85575c --- /dev/null +++ b/other/07_210340161孙庆斌_代码标注/NoteEditText.java @@ -0,0 +1,217 @@ +/* + * 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; +import android.graphics.Rect; +import android.text.Layout; +import android.text.Selection; +import android.text.Spanned; +import android.text.TextUtils; +import android.text.style.URLSpan; +import android.util.AttributeSet; +import android.util.Log; +import android.view.ContextMenu; +import android.view.KeyEvent; +import android.view.MenuItem; +import android.view.MenuItem.OnMenuItemClickListener; +import android.view.MotionEvent; +import android.widget.EditText; + +import net.micode.notes.R; + +import java.util.HashMap; +import java.util.Map; + +public class NoteEditText extends EditText {//声明了一个公有类NoteEditText,它继承了EditText + private static final String TAG = "NoteEditText";//标志为字符串"NoteEditText" + private int mIndex; + private int mSelectionStartBeforeDelete; + + private static final String SCHEME_TEL = "tel:" ;//声明字符串常量，标志电话、网址、邮件 + private static final String SCHEME_HTTP = "http:" ; + private static final String SCHEME_EMAIL = "mailto:" ; + + private static final Map sSchemaActionResMap = new HashMap();//设置映射，将文本内容（电话、网址、邮件）做链接处理 + static {//这个接口将会被NoteEditActivity实现来删除或添加编辑文本 + sSchemaActionResMap.put(SCHEME_TEL, R.string.note_link_tel); + sSchemaActionResMap.put(SCHEME_HTTP, R.string.note_link_web); + sSchemaActionResMap.put(SCHEME_EMAIL, R.string.note_link_email); + } + + /** + * Call by the {@link NoteEditActivity} to delete or add edit text + */ + public interface OnTextViewChangeListener {//该接口用于实现对TextView组件中的文字信息进行修改 + /** + * Delete current edit text when {@link KeyEvent#KEYCODE_DEL} happens + * and the text is null + */ + void onEditTextDelete(int index, String text);//当触发删除文本KeyEvent时删除文本 + + /** + * Add edit text after current edit text when {@link KeyEvent#KEYCODE_ENTER} + * happen + */ + void onEditTextEnter(int index, String text);//当触发输入文本KeyEvent时增添文本 + + /** + * Hide or show item option when text change + */ + void onTextChange(int index, boolean hasText);//文字更改时隐藏或显示项目选项 + } + + private OnTextViewChangeListener mOnTextViewChangeListener; + + public NoteEditText(Context context) {//这个函数是NoteEditText的构造函数,直接借用了父类的构造函数 + super(context, null); + mIndex = 0; + } + + public void setIndex(int index){//这个函数设置了针对textview的监听器 + mIndex = index; + } + + public void setOnTextViewChangeListener(OnTextViewChangeListener listener) {//置文本视图变化监听器 + mOnTextViewChangeListener = listener; + } + + public NoteEditText(Context context, AttributeSet attrs) {//便签初始化 + super(context, attrs, android.R.attr.editTextStyle); + } + + public NoteEditText(Context context, AttributeSet attrs, int defStyle) {//自动初始化 + super(context, attrs, defStyle); + // TODO Auto-generated constructor stub + } + + @Override + public boolean onTouchEvent(MotionEvent event) {//我们打开一个便签后触碰它的文本内容时,该便签就会跳转到响应的编辑状态.这个函数设计了当我们在便签文本编辑视图中触碰文本后系统的响应方式 + switch (event.getAction()) {//根据按键的KeyCode来处理 + case MotionEvent.ACTION_DOWN: + + int x = (int) event.getX(); + int y = (int) event.getY(); + x -= getTotalPaddingLeft(); + y -= getTotalPaddingTop(); + x += getScrollX(); + y += getScrollY(); + + Layout layout = getLayout(); + int line = layout.getLineForVertical(y); + int off = layout.getOffsetForHorizontal(line, x); + Selection.setSelection(getText(), off); + break; + } + + return super.onTouchEvent(event); + } + + @Override + public boolean onKeyDown(int keyCode, KeyEvent event) { + switch (keyCode) {//根据按键的KeyCode来处理 + case KeyEvent.KEYCODE_ENTER: + if (mOnTextViewChangeListener != null) { + return false; + } + break; + case KeyEvent.KEYCODE_DEL: + mSelectionStartBeforeDelete = getSelectionStart(); + break; + default: + break; + } + return super.onKeyDown(keyCode, event); + } + + @Override + public boolean onKeyUp(int keyCode, KeyEvent event) {//这个函数规定了当用户松开按键瞬间系统的响应 + switch(keyCode) {//根据按键的 Unicode 编码值来处理，有删除和进入2种操作 + case KeyEvent.KEYCODE_DEL: + if (mOnTextViewChangeListener != null) { + if (0 == mSelectionStartBeforeDelete && mIndex != 0) { + mOnTextViewChangeListener.onEditTextDelete(mIndex, getText().toString()); + return true; + } + } else { + Log.d(TAG, "OnTextViewChangeListener was not seted"); + } + break; + case KeyEvent.KEYCODE_ENTER: + if (mOnTextViewChangeListener != null) { + int selectionStart = getSelectionStart(); + String text = getText().subSequence(selectionStart, length()).toString(); + setText(getText().subSequence(0, selectionStart)); + mOnTextViewChangeListener.onEditTextEnter(mIndex + 1, text); + } else { + Log.d(TAG, "OnTextViewChangeListener was not seted"); + } + break; + default: + break; + } + return super.onKeyUp(keyCode, event); + } + + @Override + protected void onFocusChanged(boolean focused, int direction, Rect previouslyFocusedRect) {//这个函数规定了编辑文本焦点改变时的系统响应 + if (mOnTextViewChangeListener != null) { + if (!focused && TextUtils.isEmpty(getText())) { + mOnTextViewChangeListener.onTextChange(mIndex, false); + } else { + mOnTextViewChangeListener.onTextChange(mIndex, true); + } + } + super.onFocusChanged(focused, direction, previouslyFocusedRect); + } + + @Override + protected void onCreateContextMenu(ContextMenu menu) {//这个重载函数定义了新建文本菜单的过程 + if (getText() instanceof Spanned) {//如果有文本存在 + int selStart = getSelectionStart(); + int selEnd = getSelectionEnd(); + + int min = Math.min(selStart, selEnd); + int max = Math.max(selStart, selEnd); + + final URLSpan[] urls = ((Spanned) getText()).getSpans(min, max, URLSpan.class); + if (urls.length == 1) {//设置url的信息的范围值 + int defaultResId = 0; + for(String schema: sSchemaActionResMap.keySet()) {//获取计划表中所有的key值 + if(urls[0].getURL().indexOf(schema) >= 0) { + defaultResId = sSchemaActionResMap.get(schema); + break; + } + } + + if (defaultResId == 0) {//defaultResId == 0则说明url并没有添加任何东西，所以置为连接其他SchemaActionResMap的值 + defaultResId = R.string.note_link_other; + } + + menu.add(0, 0, 0, defaultResId).setOnMenuItemClickListener( + new OnMenuItemClickListener() { + public boolean onMenuItemClick(MenuItem item) { + // goto a new intent + urls[0].onClick(NoteEditText.this); + return true; + } + }); + } + } + super.onCreateContextMenu(menu); + } +} diff --git a/other/07_210340161孙庆斌_代码标注/NoteItemData.java b/other/07_210340161孙庆斌_代码标注/NoteItemData.java new file mode 100644 index 0000000..cf146db --- /dev/null +++ b/other/07_210340161孙庆斌_代码标注/NoteItemData.java @@ -0,0 +1,225 @@ +/* + * 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; +import android.database.Cursor; +import android.text.TextUtils; + +import net.micode.notes.data.Contact; +import net.micode.notes.data.Notes; +import net.micode.notes.data.Notes.NoteColumns; +import net.micode.notes.tool.DataUtils; + + +public class NoteItemData {//提供便签的项目数据 + static final String [] PROJECTION = new String [] {//常量标记和数据 + NoteColumns.ID, + NoteColumns.ALERTED_DATE, + NoteColumns.BG_COLOR_ID, + NoteColumns.CREATED_DATE, + NoteColumns.HAS_ATTACHMENT, + NoteColumns.MODIFIED_DATE, + NoteColumns.NOTES_COUNT, + NoteColumns.PARENT_ID, + NoteColumns.SNIPPET, + NoteColumns.TYPE, + NoteColumns.WIDGET_ID, + NoteColumns.WIDGET_TYPE, + }; + + private static final int ID_COLUMN = 0;//声明类属性，包括背景颜色、手机号码等 + private static final int ALERTED_DATE_COLUMN = 1; + private static final int BG_COLOR_ID_COLUMN = 2; + private static final int CREATED_DATE_COLUMN = 3; + private static final int HAS_ATTACHMENT_COLUMN = 4; + private static final int MODIFIED_DATE_COLUMN = 5; + private static final int NOTES_COUNT_COLUMN = 6; + private static final int PARENT_ID_COLUMN = 7; + private static final int SNIPPET_COLUMN = 8; + private static final int TYPE_COLUMN = 9; + private static final int WIDGET_ID_COLUMN = 10; + private static final int WIDGET_TYPE_COLUMN = 11; + + private long mId; + private long mAlertDate; + private int mBgColorId; + private long mCreatedDate; + private boolean mHasAttachment; + private long mModifiedDate; + private int mNotesCount; + private long mParentId; + private String mSnippet; + private int mType; + private int mWidgetId; + private int mWidgetType; + private String mName; + private String mPhoneNumber; + + private boolean mIsLastItem; + private boolean mIsFirstItem; + private boolean mIsOnlyOneItem; + private boolean mIsOneNoteFollowingFolder; + private boolean mIsMultiNotesFollowingFolder; + + public NoteItemData(Context context, Cursor cursor) {//初始化NoteItemData利用光标和context获取的内容 + mId = cursor.getLong(ID_COLUMN);//调用getxxxx（）的函数，是指 数据库游标通过把参数索引获得数据 + mAlertDate = cursor.getLong(ALERTED_DATE_COLUMN); + mBgColorId = cursor.getInt(BG_COLOR_ID_COLUMN); + mCreatedDate = cursor.getLong(CREATED_DATE_COLUMN); + mHasAttachment = (cursor.getInt(HAS_ATTACHMENT_COLUMN) > 0) ? true : false;//判断行列 + mModifiedDate = cursor.getLong(MODIFIED_DATE_COLUMN); + mNotesCount = cursor.getInt(NOTES_COUNT_COLUMN); + mParentId = cursor.getLong(PARENT_ID_COLUMN); + mSnippet = cursor.getString(SNIPPET_COLUMN); + mSnippet = mSnippet.replace(NoteEditActivity.TAG_CHECKED, "").replace(//把每项前的方框符号和✔符号去掉 + NoteEditActivity.TAG_UNCHECKED, ""); + mType = cursor.getInt(TYPE_COLUMN); + mWidgetId = cursor.getInt(WIDGET_ID_COLUMN); + mWidgetType = cursor.getInt(WIDGET_TYPE_COLUMN); + + mPhoneNumber = ""; + if (mParentId == Notes.ID_CALL_RECORD_FOLDER) {//初始化电话号码的信息 + mPhoneNumber = DataUtils.getCallNumberByNoteId(context.getContentResolver(), mId); + if (!TextUtils.isEmpty(mPhoneNumber)) { + mName = Contact.getContact(context, mPhoneNumber); + if (mName == null) { + + mName = mPhoneNumber; + } + } + } + + if (mName == null) {//如果没有对name复制成功，则把name设置为空值 + mName = ""; + } + checkPostion(cursor); + } + + private void checkPostion(Cursor cursor) {//通过光标所处位置设置标记 + mIsLastItem = cursor.isLast() ? true : false; + mIsFirstItem = cursor.isFirst() ? true : false; + mIsOnlyOneItem = (cursor.getCount() == 1); + mIsMultiNotesFollowingFolder = false; + mIsOneNoteFollowingFolder = false; + + if (mType == Notes.TYPE_NOTE && !mIsFirstItem) {//如果是note格式并且不是第一个元素，则获取光标位置并根据上一行信息更改标记 + int position = cursor.getPosition(); + if (cursor.moveToPrevious()) {//获取光标位置后看上一行 + if (cursor.getInt(TYPE_COLUMN) == Notes.TYPE_FOLDER + || cursor.getInt(TYPE_COLUMN) == Notes.TYPE_SYSTEM) {//若光标满足SYSTEM或FOLDER格式 + if (cursor.getCount() > (position + 1)) { + mIsMultiNotesFollowingFolder = true; + } else { + mIsOneNoteFollowingFolder = true; + } + } + if (!cursor.moveToNext()) { + throw new IllegalStateException("cursor move to previous but can't move back"); + } + } + } + } + + public boolean isOneFollowingFolder() { + return mIsOneNoteFollowingFolder; + }//以下都是获取标记的函数 + + public boolean isMultiFollowingFolder() { + return mIsMultiNotesFollowingFolder; + } + + public boolean isLast() { + return mIsLastItem; + } + + public String getCallName() { + return mName; + } + + public boolean isFirst() { + return mIsFirstItem; + } + + public boolean isSingle() { + return mIsOnlyOneItem; + } + + public long getId() { + return mId; + } + + public long getAlertDate() { + return mAlertDate; + } + + public long getCreatedDate() { + return mCreatedDate; + } + + public boolean hasAttachment() { + return mHasAttachment; + } + + public long getModifiedDate() { + return mModifiedDate; + } + + public int getBgColorId() { + return mBgColorId; + } + + public long getParentId() { + return mParentId; + } + + public int getNotesCount() { + return mNotesCount; + } + + public long getFolderId () { + return mParentId; + } + + public int getType() { + return mType; + } + + public int getWidgetType() { + return mWidgetType; + } + + public int getWidgetId() { + return mWidgetId; + } + + public String getSnippet() { + return mSnippet; + } + + public boolean hasAlert() { + return (mAlertDate > 0); + } + + public boolean isCallRecord() { + return (mParentId == Notes.ID_CALL_RECORD_FOLDER && !TextUtils.isEmpty(mPhoneNumber)); + } + + public static int getNoteType(Cursor cursor) { + return cursor.getInt(TYPE_COLUMN); + } +} diff --git a/other/07_210340161孙庆斌_代码标注/NotesListActivity.java b/other/07_210340161孙庆斌_代码标注/NotesListActivity.java new file mode 100644 index 0000000..69d5a7a --- /dev/null +++ b/other/07_210340161孙庆斌_代码标注/NotesListActivity.java @@ -0,0 +1,964 @@ +/* + * 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.app.Activity; +import android.app.AlertDialog; +import android.app.Dialog; +import android.appwidget.AppWidgetManager; +import android.content.AsyncQueryHandler; +import android.content.ContentResolver; +import android.content.ContentValues; +import android.content.Context; +import android.content.DialogInterface; +import android.content.Intent; +import android.content.SharedPreferences; +import android.database.Cursor; +import android.os.AsyncTask; +import android.os.Bundle; +import android.preference.PreferenceManager; +import android.text.Editable; +import android.text.TextUtils; +import android.text.TextWatcher; +import android.util.Log; +import android.view.ActionMode; +import android.view.ContextMenu; +import android.view.ContextMenu.ContextMenuInfo; +import android.view.Display; +import android.view.HapticFeedbackConstants; +import android.view.LayoutInflater; +import android.view.Menu; +import android.view.MenuItem; +import android.view.MenuItem.OnMenuItemClickListener; +import android.view.MotionEvent; +import android.view.View; +import android.view.View.OnClickListener; +import android.view.View.OnCreateContextMenuListener; +import android.view.View.OnTouchListener; +import android.view.inputmethod.InputMethodManager; +import android.widget.AdapterView; +import android.widget.AdapterView.OnItemClickListener; +import android.widget.AdapterView.OnItemLongClickListener; +import android.widget.Button; +import android.widget.EditText; +import android.widget.ListView; +import android.widget.PopupMenu; +import android.widget.TextView; +import android.widget.Toast; + +import net.micode.notes.R; +import net.micode.notes.data.Notes; +import net.micode.notes.data.Notes.NoteColumns; +import net.micode.notes.gtask.remote.GTaskSyncService; +import net.micode.notes.model.WorkingNote; +import net.micode.notes.tool.BackupUtils; +import net.micode.notes.tool.DataUtils; +import net.micode.notes.tool.ResourceParser; +import net.micode.notes.ui.NotesListAdapter.AppWidgetAttribute; +import net.micode.notes.widget.NoteWidgetProvider_2x; +import net.micode.notes.widget.NoteWidgetProvider_4x; + +import java.io.BufferedReader; +import java.io.IOException; +import java.io.InputStream; +import java.io.InputStreamReader; +import java.util.HashSet; + +public class NotesListActivity extends Activity implements OnClickListener, OnItemLongClickListener { + //这个类继承于Activity类，实现了两个接口，分别是点击监听器，和长按监听器，即在这个类的界面实现对这两种操作的响应，这是整个project的主类 + private static final int FOLDER_NOTE_LIST_QUERY_TOKEN = 0;//声明并赋值一些不可更改的私有属性 + + private static final int FOLDER_LIST_QUERY_TOKEN = 1;//查询记号 + + private static final int MENU_FOLDER_DELETE = 0;//删除菜单文件 + + private static final int MENU_FOLDER_VIEW = 1;// 阅读菜单文件 + + private static final int MENU_FOLDER_CHANGE_NAME = 2;//更改菜单文件名称 + + private static final String PREFERENCE_ADD_INTRODUCTION = "net.micode.notes.introduction";//用于第一次打开小米便签的判断 + + private enum ListEditState {//列表编辑三种状态 + NOTE_LIST, SUB_FOLDER, CALL_RECORD_FOLDER + }; + + private ListEditState mState;// 声明一些私有属性 + + private BackgroundQueryHandler mBackgroundQueryHandler;//后台疑问处理功能 + + private NotesListAdapter mNotesListAdapter;//便签列表配适器 + + private ListView mNotesListView;//主界面的视图 + + private Button mAddNewNote;//最下方添加便签的按钮 + + private boolean mDispatch;//是否调度的判断变量 + + private int mOriginY;//首次触摸时屏幕上的垂直距离（y值） + + private int mDispatchY;//重新调度时的触摸的在屏幕上的垂直距离 + + private TextView mTitleBar;//子文件夹下的标头 + + private long mCurrentFolderId;//当前文件夹的ID + + private ContentResolver mContentResolver;//提供内容分析 + + private ModeCallback mModeCallBack;//返回调用方法 + + private static final String TAG = "NotesListActivity";//名称（可用于日志文件调试） + + public static final int NOTES_LISTVIEW_SCROLL_RATE = 30;//列表滚轮速度 + + private NoteItemData mFocusNoteDataItem;//所指的便签数据内容 + + private static final String NORMAL_SELECTION = NoteColumns.PARENT_ID + "=?";//定义私有字符串变量 + + private static final String ROOT_FOLDER_SELECTION = "(" + NoteColumns.TYPE + "<>"//用于表明处于父文件夹下（主列表） + + Notes.TYPE_SYSTEM + " AND " + NoteColumns.PARENT_ID + "=?)" + " OR (" + + NoteColumns.ID + "=" + Notes.ID_CALL_RECORD_FOLDER + " AND " + + NoteColumns.NOTES_COUNT + ">0)"; + + private final static int REQUEST_CODE_OPEN_NODE = 102;//请求代码开放节点 + private final static int REQUEST_CODE_NEW_NODE = 103;//请求代码新节点 + + @Override + protected void onCreate(Bundle savedInstanceState) {//创建类 + super.onCreate(savedInstanceState);//super调用父类的protected函数,创建窗口时使用 + setContentView(R.layout.note_list); + initResources(); + + /** + * Insert an introduction when user firstly use this application + */ + setAppInfoFromRawRes(); + } + + @Override + protected void onActivityResult(int requestCode, int resultCode, Intent data) {//对子模块的一些数据进行分析 + if (resultCode == RESULT_OK//结果值与要求值正确 + && (requestCode == REQUEST_CODE_OPEN_NODE || requestCode == REQUEST_CODE_NEW_NODE)) { + mNotesListAdapter.changeCursor(null); + } else {//如果条件不满足，则将数据返回给父类，即调用父类的onActivityResult()。 + super.onActivityResult(requestCode, resultCode, data); + } + } + + private void setAppInfoFromRawRes() {//从原始数据里生成应用的基本信息。 + SharedPreferences sp = PreferenceManager.getDefaultSharedPreferences(this); + if (!sp.getBoolean(PREFERENCE_ADD_INTRODUCTION, false)) {//判断偏好，增加说明 + StringBuilder sb = new StringBuilder(); + InputStream in = null; + try {//从原始配置文件当中获取基本信息 + in = getResources().openRawResource(R.raw.introduction); + if (in != null) {//如果加载到输入流成功，填充到缓冲区里 + InputStreamReader isr = new InputStreamReader(in); + BufferedReader br = new BufferedReader(isr); + char [] buf = new char[1024]; + int len = 0; + while ((len = br.read(buf)) > 0) {//不断在buf中读取数据放入sb里 + sb.append(buf, 0, len); + } + } else { + Log.e(TAG, "Read introduction file error");//报错，读取文件错误 + return; + } + } catch (IOException e) {//获取IO中断异常 + e.printStackTrace(); + return; + } finally {// finally是必然会执行的部分 + if(in != null) { + try { + in.close(); + } catch (IOException e) { + // TODO Auto-generated catch block + e.printStackTrace(); + } + } + } + + 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()) {//判断便签是否保存成功。 + sp.edit().putBoolean(PREFERENCE_ADD_INTRODUCTION, true).commit(); + } else { + Log.e(TAG, "Save introduction note error"); + return; + } + } + } + + @Override + protected void onStart() {//调用父类的onCreate活动，和同步便签列表 + super.onStart(); + startAsyncNotesListQuery(); + } + + private void initResources() {//初始化资源 + mContentResolver = this.getContentResolver(); + mBackgroundQueryHandler = new BackgroundQueryHandler(this.getContentResolver()); + mCurrentFolderId = Notes.ID_ROOT_FOLDER; + mNotesListView = (ListView) findViewById(R.id.notes_list); + 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.setOnClickListener(this); + mAddNewNote.setOnTouchListener(new NewNoteOnTouchListener()); + mDispatch = false; + mDispatchY = 0; + mOriginY = 0; + mTitleBar = (TextView) findViewById(R.id.tv_title_bar); + mState = ListEditState.NOTE_LIST; + mModeCallBack = new ModeCallback(); + } + + private class ModeCallback implements ListView.MultiChoiceModeListener, OnMenuItemClickListener { + //实现了ActionMode接口，该接口继承了MultiChoiceListener，OnMenuItemClickListener两个类，用户界面所看到的就是长按后进入多选模式以及之后的多种操作 + private DropdownMenu mDropDownMenu; + private ActionMode mActionMode; + private MenuItem mMoveMenu; + + public boolean onCreateActionMode(ActionMode mode, Menu menu) {//创建动作方式 + getMenuInflater().inflate(R.menu.note_list_options, menu); + menu.findItem(R.id.delete).setOnMenuItemClickListener(this); + mMoveMenu = menu.findItem(R.id.move); + if (mFocusNoteDataItem.getParentId() == Notes.ID_CALL_RECORD_FOLDER + || DataUtils.getUserFolderCount(mContentResolver) == 0) {//如果父类id在文件夹中保存或者用户文件数量为零，设置移动菜单为不可见，否者设为可见 + mMoveMenu.setVisible(false); + } else {//设置菜单项目为可见 + mMoveMenu.setVisible(true); + mMoveMenu.setOnMenuItemClickListener(this); + } + mActionMode = mode; + mNotesListAdapter.setChoiceMode(true); + mNotesListView.setLongClickable(false); + mAddNewNote.setVisibility(View.GONE); + + View customView = LayoutInflater.from(NotesListActivity.this).inflate( + R.layout.note_list_dropdown_menu, null); + mode.setCustomView(customView); + mDropDownMenu = new DropdownMenu(NotesListActivity.this, + (Button) customView.findViewById(R.id.selection_menu), + R.menu.note_list_dropdown); + mDropDownMenu.setOnDropdownMenuItemClickListener(new PopupMenu.OnMenuItemClickListener(){ + public boolean onMenuItemClick(MenuItem item) {//点击菜单时，设置为全选并更新菜单 + mNotesListAdapter.selectAll(!mNotesListAdapter.isAllSelected()); + updateMenu(); + return true; + } + + }); + 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); + MenuItem item = mDropDownMenu.findItem(R.id.action_select_all); + if (item != null) {//当全选成功，则将“全选”菜单项改为“取消全选”菜单，否则仍保持“全选”菜单项。 + if (mNotesListAdapter.isAllSelected()) { + item.setChecked(true); + item.setTitle(R.string.menu_deselect_all); + } else { + item.setChecked(false); + item.setTitle(R.string.menu_select_all); + } + } + } + + public boolean onPrepareActionMode(ActionMode mode, Menu menu) {//准备动作模式 + // TODO Auto-generated method stub + return false; + } + + public boolean onActionItemClicked(ActionMode mode, MenuItem item) {//菜单动作触发标记 + // TODO Auto-generated method stub + return false; + } + + public void onDestroyActionMode(ActionMode mode) {//销毁动作模式，设置便签可见 + mNotesListAdapter.setChoiceMode(false); + mNotesListView.setLongClickable(true); + mAddNewNote.setVisibility(View.VISIBLE); + } + + public void finishActionMode() { + //结束动作模式 + mActionMode.finish(); + } + + public void onItemCheckedStateChanged(ActionMode mode, int position, long id, + boolean checked) {//勾选的状态改变时，更改勾选状态，更新菜单 + mNotesListAdapter.setCheckedItem(position, checked); + updateMenu(); + } + + public boolean onMenuItemClick(MenuItem item) {//判断菜单是否被点击 + if (mNotesListAdapter.getSelectedCount() == 0) {//当勾选数为零时（即未点击），创建文本并显示 + Toast.makeText(NotesListActivity.this, getString(R.string.menu_select_none), + Toast.LENGTH_SHORT).show(); + return true; + } + + switch (item.getItemId()) {//根据id号判断是删除还是移动 + case R.id.delete: + AlertDialog.Builder builder = new AlertDialog.Builder(NotesListActivity.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_notes, + mNotesListAdapter.getSelectedCount())); + builder.setPositiveButton(android.R.string.ok, + new DialogInterface.OnClickListener() { + public void onClick(DialogInterface dialog, + int which) { + batchDelete(); + } + }); + builder.setNegativeButton(android.R.string.cancel, null); + builder.show(); + break; + case R.id.move: + startQueryDestinationFolders(); + break; + default: + return false; + } + return true; + } + } + + private class NewNoteOnTouchListener implements OnTouchListener {//触摸便签监听器 + + public boolean onTouch(View v, MotionEvent event) {//新建便签的触摸事件的处理 + switch (event.getAction()) {//获取不同动作对应不同操作 + case MotionEvent.ACTION_DOWN: { + Display display = getWindowManager().getDefaultDisplay(); + int screenHeight = display.getHeight(); + int newNoteViewHeight = mAddNewNote.getHeight(); + int start = screenHeight - newNoteViewHeight; + int eventY = start + (int) event.getY(); + /** + * Minus TitleBar's height + */ + if (mState == ListEditState.SUB_FOLDER) {//如果再其他文件夹下，则需要减去子文件夹的title的高度 + eventY -= mTitleBar.getHeight(); + start -= mTitleBar.getHeight(); + } + /** + * HACKME:When click the transparent part of "New Note" button, dispatch + * the event to the list view behind this button. The transparent part of + * "New Note" button could be expressed by formula y=-0.12x+94（Unit:pixel） + * and the line top of the button. The coordinate based on left of the "New + * Note" button. The 94 represents maximum height of the transparent part. + * Notice that, if the background of the button changes, the formula should + * also change. This is very bad, just for the UI designer's strong requirement. + */ + if (event.getY() < (event.getX() * (-0.12) + 94)) {//如果当前点击的位置不在“写便签”区域内 + View view = mNotesListView.getChildAt(mNotesListView.getChildCount() - 1 + - mNotesListView.getFooterViewsCount()); + if (view != null && view.getBottom() > start + && (view.getTop() < (start + 94))) {//如果不在新建便签的按钮上，重新调度响应按键 + mOriginY = (int) event.getY(); + mDispatchY = eventY; + event.setLocation(event.getX(), mDispatchY); + mDispatch = true; + return mNotesListView.dispatchTouchEvent(event); + } + } + break; + } + case MotionEvent.ACTION_MOVE: {//如果是移动操作，调度动作顺序 + if (mDispatch) { + mDispatchY += (int) event.getY() - mOriginY; + event.setLocation(event.getX(), mDispatchY); + return mNotesListView.dispatchTouchEvent(event); + } + break; + } + default: { + if (mDispatch) { + event.setLocation(event.getX(), mDispatchY);//重新赋值 + mDispatch = false; + return mNotesListView.dispatchTouchEvent(event); + } + break; + } + } + return false; + } + + }; + + private void startAsyncNotesListQuery() {//同步便签列表请求 + String selection = (mCurrentFolderId == Notes.ID_ROOT_FOLDER) ? ROOT_FOLDER_SELECTION + : NORMAL_SELECTION; + mBackgroundQueryHandler.startQuery(FOLDER_NOTE_LIST_QUERY_TOKEN, null, + Notes.CONTENT_NOTE_URI, NoteItemData.PROJECTION, selection, new String[] { + String.valueOf(mCurrentFolderId) + }, NoteColumns.TYPE + " DESC," + NoteColumns.MODIFIED_DATE + " DESC"); + } + + private final class BackgroundQueryHandler extends AsyncQueryHandler {//背景请求处理器 + public BackgroundQueryHandler(ContentResolver contentResolver) { + //调用父类的方法 + super(contentResolver); + } + + @Override + protected void onQueryComplete(int token, Object cookie, Cursor cursor) {//查询完成后对光标的处理 + switch (token) { + case FOLDER_NOTE_LIST_QUERY_TOKEN://如果是便签查询被采用，更改光标位置 + mNotesListAdapter.changeCursor(cursor); + break; + case FOLDER_LIST_QUERY_TOKEN://如果是采用列表查询，显示菜单列表 + if (cursor != null && cursor.getCount() > 0) { + showFolderListMenu(cursor); + } else { + Log.e(TAG, "Query folder failed"); + } + break; + default: + return; + } + } + } + + private void showFolderListMenu(Cursor cursor) {//执行批量删除的操作 + AlertDialog.Builder builder = new AlertDialog.Builder(NotesListActivity.this); + builder.setTitle(R.string.menu_title_select_folder); + final FoldersListAdapter adapter = new FoldersListAdapter(this, cursor);//文件夹列表配适器 + builder.setAdapter(adapter, new DialogInterface.OnClickListener() { + + public void onClick(DialogInterface dialog, int which) {//为对话框设置监听事件 + DataUtils.batchMoveToFolder(mContentResolver, + mNotesListAdapter.getSelectedItemIds(), adapter.getItemId(which)); + Toast.makeText( + NotesListActivity.this, + getString(R.string.format_move_notes_to_folder, + mNotesListAdapter.getSelectedCount(), + adapter.getFolderName(NotesListActivity.this, which)), + Toast.LENGTH_SHORT).show(); + mModeCallBack.finishActionMode(); + } + }); + builder.show(); + } + + private void createNewNote() {//创建新便签 + Intent intent = new Intent(this, NoteEditActivity.class);//新建一个意图，与NoteEditActivity相关联 + intent.setAction(Intent.ACTION_INSERT_OR_EDIT); + intent.putExtra(Notes.INTENT_EXTRA_FOLDER_ID, mCurrentFolderId);//设置键对值 + this.startActivityForResult(intent, REQUEST_CODE_NEW_NODE);//这个活动发出请求，等待下一个活动返回数据 + } + + private void batchDelete() {//批量删除便签 + new AsyncTask>() { + protected HashSet doInBackground(Void... unused) { + HashSet widgets = mNotesListAdapter.getSelectedWidget(); + if (!isSyncMode()) {//如果为同步模式则删除笔记，若删除不成功打印错误信息 + // if not synced, delete notes directly + if (DataUtils.batchDeleteNotes(mContentResolver, mNotesListAdapter + .getSelectedItemIds())) { + } else { + Log.e(TAG, "Delete notes error, should not happens"); + } + } else { + // in sync mode, we'll move the deleted note into the trash + // folder + if (!DataUtils.batchMoveToFolder(mContentResolver, mNotesListAdapter + .getSelectedItemIds(), Notes.ID_TRASH_FOLER)) { + Log.e(TAG, "Move notes to trash folder error, should not happens"); + } + } + return widgets; + } + + @Override + protected void onPostExecute(HashSet widgets) {//这是一个循环体结构，如果id不等的话，会进行更新id的操作。 + if (widgets != null) { + for (AppWidgetAttribute widget : widgets) { + if (widget.widgetId != AppWidgetManager.INVALID_APPWIDGET_ID + && widget.widgetType != Notes.TYPE_WIDGET_INVALIDE) { + updateWidget(widget.widgetId, widget.widgetType); + } + } + } + mModeCallBack.finishActionMode(); + } + }.execute(); + } + + private void deleteFolder(long folderId) {//删除文件夹 + if (folderId == Notes.ID_ROOT_FOLDER) { + Log.e(TAG, "Wrong folder id, should not happen " + folderId); + return; + } + + HashSet ids = new HashSet(); + ids.add(folderId); + HashSet widgets = DataUtils.getFolderNoteWidget(mContentResolver, + folderId); + if (!isSyncMode()) {//如果不同步，直接删除，否则放入垃圾文件夹中 + // if not synced, delete folder directly + DataUtils.batchDeleteNotes(mContentResolver, ids); + } else { + // in sync mode, we'll move the deleted folder into the trash folder + DataUtils.batchMoveToFolder(mContentResolver, ids, Notes.ID_TRASH_FOLER); + } + if (widgets != null) {//如果存在对应桌面挂件，那么判断挂件信息，如果挂件id有效且挂件类型有效，则更新挂件信息 + for (AppWidgetAttribute widget : widgets) { + if (widget.widgetId != AppWidgetManager.INVALID_APPWIDGET_ID + && widget.widgetType != Notes.TYPE_WIDGET_INVALIDE) { + updateWidget(widget.widgetId, widget.widgetType); + } + } + } + } + + private void openNode(NoteItemData data) {//打开便签 + Intent intent = new Intent(this, NoteEditActivity.class);//打开便签，创建新的活动，并且等待返回值 + intent.setAction(Intent.ACTION_VIEW); + intent.putExtra(Intent.EXTRA_UID, data.getId()); + this.startActivityForResult(intent, REQUEST_CODE_OPEN_NODE); + } + + private void openFolder(NoteItemData data) {//打开文件夹 + mCurrentFolderId = data.getId(); + startAsyncNotesListQuery(); + if (data.getId() == Notes.ID_CALL_RECORD_FOLDER) {//如果当前id是保存在文件夹的id，将列表编辑状态置为call文件夹，否则设置为镜像文件夹 + mState = ListEditState.CALL_RECORD_FOLDER; + mAddNewNote.setVisibility(View.GONE); + } else { + mState = ListEditState.SUB_FOLDER; + } + if (data.getId() == Notes.ID_CALL_RECORD_FOLDER) {//如果当前id是保存在文件夹的id，设置标题内容为文件夹名字，否则设置为文本的前部片段内容 + mTitleBar.setText(R.string.call_record_folder_name); + } else { + mTitleBar.setText(data.getSnippet()); + } + mTitleBar.setVisibility(View.VISIBLE); + } + + public void onClick(View v) {//响应一个点击操作，创建一个新的便签 + switch (v.getId()) {//得到我们所点击组件的ID号并进行判断 + case R.id.btn_new_note: + createNewNote(); + break; + default: + break; + } + } + + private void showSoftInput() {//.显示软键盘 + InputMethodManager inputMethodManager = (InputMethodManager) getSystemService(Context.INPUT_METHOD_SERVICE); + if (inputMethodManager != null) {//若输入为空，进行对应操作，使软键盘显示，第二个参数hideFlags（用来设置是否隐藏）等于0 + inputMethodManager.toggleSoftInput(InputMethodManager.SHOW_FORCED, 0); + } + } + + private void hideSoftInput(View view) {//关闭键盘 + InputMethodManager inputMethodManager = (InputMethodManager) getSystemService(Context.INPUT_METHOD_SERVICE); + inputMethodManager.hideSoftInputFromWindow(view.getWindowToken(), 0); + } + + private void showCreateOrModifyFolderDialog(final boolean create) {//创建或修改文件夹对话框 + final AlertDialog.Builder builder = new AlertDialog.Builder(this);//初始化对话框 + View view = LayoutInflater.from(this).inflate(R.layout.dialog_edit_text, null);//加载对话框的布局文件 + final EditText etName = (EditText) view.findViewById(R.id.et_foler_name);//获得et_foler_name这个组件并将其转化为EditText类 + showSoftInput(); + if (!create) {//如果create==false将对话框标题设置为 修改文件夹名称，否则设置为新建文件夹 + if (mFocusNoteDataItem != null) { + etName.setText(mFocusNoteDataItem.getSnippet()); + builder.setTitle(getString(R.string.menu_folder_change_name)); + } else { + Log.e(TAG, "The long click data item is null"); + return; + } + } else { + etName.setText(""); + builder.setTitle(this.getString(R.string.menu_create_folder)); + } + + builder.setPositiveButton(android.R.string.ok, null); + builder.setNegativeButton(android.R.string.cancel, new DialogInterface.OnClickListener() { + public void onClick(DialogInterface dialog, int which) { + //点击触发软键盘隐藏 + hideSoftInput(etName); + } + }); + + final Dialog dialog = builder.setView(view).show();//将上述对话框实例化并显示在屏幕上 + final Button positive = (Button)dialog.findViewById(android.R.id.button1);//加载确定按钮布局文件 + positive.setOnClickListener(new OnClickListener() {//设置点击监听器 + public void onClick(View v) {//响应一个点击操作 + hideSoftInput(etName); + String name = etName.getText().toString(); + if (DataUtils.checkVisibleFolderName(mContentResolver, name)) {//如果是可视文件，创建并显示对话框 + Toast.makeText(NotesListActivity.this, getString(R.string.folder_exist, name), + Toast.LENGTH_LONG).show(); + etName.setSelection(0, etName.length()); + return; + } + if (!create) {//当文件名字存在时，判断是否为创建操作，若不是，则更新values信息，若是，则插入values信息 + if (!TextUtils.isEmpty(name)) { + ContentValues values = new ContentValues(); + values.put(NoteColumns.SNIPPET, name); + values.put(NoteColumns.TYPE, Notes.TYPE_FOLDER); + values.put(NoteColumns.LOCAL_MODIFIED, 1); + mContentResolver.update(Notes.CONTENT_NOTE_URI, values, NoteColumns.ID + + "=?", new String[] { + String.valueOf(mFocusNoteDataItem.getId()) + }); + } + } else if (!TextUtils.isEmpty(name)) { + ContentValues values = new ContentValues(); + values.put(NoteColumns.SNIPPET, name); + values.put(NoteColumns.TYPE, Notes.TYPE_FOLDER); + mContentResolver.insert(Notes.CONTENT_NOTE_URI, values); + } + dialog.dismiss(); + } + }); + + if (TextUtils.isEmpty(etName.getText())) {//判断文件夹的内容是否为空 + positive.setEnabled(false); + } + /** + * When the name edit text is null, disable the positive button + */ + etName.addTextChangedListener(new TextWatcher() { + public void beforeTextChanged(CharSequence s, int start, int count, int after) {//判断是否在更改文本之前 + // TODO Auto-generated method stub + + } + + public void onTextChanged(CharSequence s, int start, int before, int count) {//当前文本改变触发，文本为空按键不可用，不为空则可用 + if(TextUtils.isEmpty(etName.getText())){//如果文件夹名称为空，那么便不可用 + positive.setEnabled(false); + } else { + positive.setEnabled(true); + } + } + + public void afterTextChanged(Editable s) {//判断是否在文本更改之后 + // TODO Auto-generated method stub + + } + }); + } + + @Override + public void onBackPressed() {//按返回键时根据情况更改类中的数据 + switch (mState) {//判断目前所处的状态 + case SUB_FOLDER: + mCurrentFolderId = Notes.ID_ROOT_FOLDER; + mState = ListEditState.NOTE_LIST; + startAsyncNotesListQuery(); + mTitleBar.setVisibility(View.GONE); + break; + case CALL_RECORD_FOLDER: + mCurrentFolderId = Notes.ID_ROOT_FOLDER; + mState = ListEditState.NOTE_LIST; + mAddNewNote.setVisibility(View.VISIBLE); + mTitleBar.setVisibility(View.GONE); + startAsyncNotesListQuery(); + break; + case NOTE_LIST: + super.onBackPressed(); + break; + default: + break; + } + } + + private void updateWidget(int appWidgetId, int appWidgetType) {//更新不同widget的插件 + Intent intent = new Intent(AppWidgetManager.ACTION_APPWIDGET_UPDATE); + if (appWidgetType == Notes.TYPE_WIDGET_2X) {//判断不同类型widget的操作并建立不同的类型 + intent.setClass(this, NoteWidgetProvider_2x.class); + } else if (appWidgetType == Notes.TYPE_WIDGET_4X) { + intent.setClass(this, NoteWidgetProvider_4x.class); + } else { + Log.e(TAG, "Unspported widget type"); + return; + } + + intent.putExtra(AppWidgetManager.EXTRA_APPWIDGET_IDS, new int[] {//putExtra中两个参数为键对值，第一个参数为键名 + appWidgetId + }); + + sendBroadcast(intent); + setResult(RESULT_OK, intent); + } + + private final OnCreateContextMenuListener mFolderOnCreateContextMenuListener = new OnCreateContextMenuListener() {//对文件夹进行操作的菜单 + public void onCreateContextMenu(ContextMenu menu, View v, ContextMenuInfo menuInfo) {//创建目录的视图 + if (mFocusNoteDataItem != null) {// 创建文件夹的菜单，下面包含四个选项 + menu.setHeaderTitle(mFocusNoteDataItem.getSnippet()); + menu.add(0, MENU_FOLDER_VIEW, 0, R.string.menu_folder_view); + menu.add(0, MENU_FOLDER_DELETE, 0, R.string.menu_folder_delete); + menu.add(0, MENU_FOLDER_CHANGE_NAME, 0, R.string.menu_folder_change_name); + } + } + }; + + @Override + public void onContextMenuClosed(Menu menu) {//内容菜单关闭 + if (mNotesListView != null) { + mNotesListView.setOnCreateContextMenuListener(null);//不设置监听事件 + } + super.onContextMenuClosed(menu); + } + + @Override + public boolean onContextItemSelected(MenuItem item) {//对菜单项进行选择对应的相应 + if (mFocusNoteDataItem == null) {//若笔记数据项为空,则返回错误日志信息 + Log.e(TAG, "The long click data item is null"); + return false; + } + switch (item.getItemId()) {//根据项目id判断要执行的功能，分别是打开文件、删除文件以及更改文件名 + case MENU_FOLDER_VIEW: + openFolder(mFocusNoteDataItem); + break; + case MENU_FOLDER_DELETE: + 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)); + builder.setPositiveButton(android.R.string.ok, + new DialogInterface.OnClickListener() { + public void onClick(DialogInterface dialog, int which) { + deleteFolder(mFocusNoteDataItem.getId()); + } + }); + builder.setNegativeButton(android.R.string.cancel, null); + builder.show(); + break; + case MENU_FOLDER_CHANGE_NAME: + showCreateOrModifyFolderDialog(false); + break; + default: + break; + } + + return true; + } + + @Override + public boolean onPrepareOptionsMenu(Menu menu) {//创建菜单这个方法在每一次调用菜单的时候都会执行 + menu.clear(); + if (mState == ListEditState.NOTE_LIST) {//如果是在便签列表的状态下，加载对应的菜单资源，下面同理 + getMenuInflater().inflate(R.menu.note_list, menu); + // set sync or sync_cancel + menu.findItem(R.id.menu_sync).setTitle( + GTaskSyncService.isSyncing() ? R.string.menu_sync_cancel : R.string.menu_sync); + } else if (mState == ListEditState.SUB_FOLDER) { + getMenuInflater().inflate(R.menu.sub_folder, menu); + } else if (mState == ListEditState.CALL_RECORD_FOLDER) { + getMenuInflater().inflate(R.menu.call_record_folder, menu); + } else { + Log.e(TAG, "Wrong state:" + mState); + } + return true; + } + + @Override + public boolean onOptionsItemSelected(MenuItem item) {//实现菜单项目的操作，通过case语句对各个菜单项目分别设置事件 + switch (item.getItemId()) {//五个菜单项的响应实现 + //调用不同方法实现不同菜单项 + case R.id.menu_new_folder: { + showCreateOrModifyFolderDialog(true); + break; + } + case R.id.menu_export_text: { + exportNoteToText(); + break; + } + case R.id.menu_sync: { + if (isSyncMode()) {//同步 + if (TextUtils.equals(item.getTitle(), getString(R.string.menu_sync))) {//如果项目title与菜单同步相同，则进行同步 + GTaskSyncService.startSync(this); + } else { + GTaskSyncService.cancelSync(this); + } + } else {//如果不是同步模式，则开始设置动作 + startPreferenceActivity(); + } + break; + } + case R.id.menu_setting: { + startPreferenceActivity(); + break; + } + case R.id.menu_new_note: { + createNewNote(); + break; + } + case R.id.menu_search: + onSearchRequested(); + break; + default: + break; + } + return true; + } + + @Override + public boolean onSearchRequested() {//根据关键字搜索便签（还未实现） + startSearch(null, false, null /* appData */, false); + return true; + } + + private void exportNoteToText() {//输出文本内容的方法实现 + final BackupUtils backup = BackupUtils.getInstance(NotesListActivity.this);//备份笔记信息 + new AsyncTask() { + + @Override + protected Integer doInBackground(Void... unused) { + //未被占用的话后台进行 + return backup.exportToText(); + } + + @Override + protected void onPostExecute(Integer result) {//设置备份的结果响应 + if (result == BackupUtils.STATE_SD_CARD_UNMOUONTED) {//根据结果为sd卡未装载、成功、系统错误三种进行处理，均是设置对话框、标题、信息以及确认按钮状态 + AlertDialog.Builder builder = new AlertDialog.Builder(NotesListActivity.this); + builder.setTitle(NotesListActivity.this + .getString(R.string.failed_sdcard_export)); + builder.setMessage(NotesListActivity.this + .getString(R.string.error_sdcard_unmounted)); + builder.setPositiveButton(android.R.string.ok, null); + builder.show(); + } else if (result == BackupUtils.STATE_SUCCESS) {//如果导出成功，则显示成功 + //并且会显示“Export text file 《便签名称》 to SD 《目录名称》 directory” + AlertDialog.Builder builder = new AlertDialog.Builder(NotesListActivity.this); + builder.setTitle(NotesListActivity.this + .getString(R.string.success_sdcard_export)); + builder.setMessage(NotesListActivity.this.getString( + R.string.format_exported_file_location, backup + .getExportedTextFileName(), backup.getExportedTextFileDir())); + builder.setPositiveButton(android.R.string.ok, null); + builder.show(); + } else if (result == BackupUtils.STATE_SYSTEM_ERROR) {//如果系统错误，则显示 导出失败，请检查SD卡 + AlertDialog.Builder builder = new AlertDialog.Builder(NotesListActivity.this); + builder.setTitle(NotesListActivity.this + .getString(R.string.failed_sdcard_export)); + builder.setMessage(NotesListActivity.this + .getString(R.string.error_sdcard_export)); + builder.setPositiveButton(android.R.string.ok, null); + builder.show(); + } + } + + }.execute(); + } + + private boolean isSyncMode() {//判断是否处于同步模式 + return NotesPreferenceActivity.getSyncAccountName(this).trim().length() > 0; + } + + 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) {//项目被点击的响应 + if (view instanceof NotesListItem) {//判断view是否是NotesListItem的一个实例，如果是就获取他的项目信息装入item中 + NoteItemData item = ((NotesListItem) view).getItemData(); + if (mNotesListAdapter.isInChoiceMode()) { + if (item.getType() == Notes.TYPE_NOTE) { + position = position - mNotesListView.getHeaderViewsCount(); + mModeCallBack.onItemCheckedStateChanged(null, position, id, + !mNotesListAdapter.isSelectedItem(position)); + } + return; + } + + switch (mState) {//根据状态作出不同动作，如果是便签列表，则根据项的类型分别打开文件或者控制器；如果是子文件并且是数据库并且是便签类型则打开控制器，否则报错 + case NOTE_LIST: + if (item.getType() == Notes.TYPE_FOLDER + || item.getType() == Notes.TYPE_SYSTEM) { + openFolder(item); + } else if (item.getType() == Notes.TYPE_NOTE) { + openNode(item); + } else { + Log.e(TAG, "Wrong note type in NOTE_LIST"); + } + break; + case SUB_FOLDER: + case CALL_RECORD_FOLDER: + if (item.getType() == Notes.TYPE_NOTE) { + openNode(item); + } else { + Log.e(TAG, "Wrong note type in SUB_FOLDER"); + } + break; + default: + break; + } + } + } + + } + + private void startQueryDestinationFolders() {//查询目标文件 + String selection = NoteColumns.TYPE + "=? AND " + NoteColumns.PARENT_ID + "<>? AND " + NoteColumns.ID + "<>?"; + selection = (mState == ListEditState.NOTE_LIST) ? selection: + "(" + selection + ") OR (" + NoteColumns.ID + "=" + Notes.ID_ROOT_FOLDER + ")"; + + mBackgroundQueryHandler.startQuery(FOLDER_LIST_QUERY_TOKEN, + null, + Notes.CONTENT_NOTE_URI, + FoldersListAdapter.PROJECTION, + selection, + new String[] {//新建字符列表 + String.valueOf(Notes.TYPE_FOLDER), + String.valueOf(Notes.ID_TRASH_FOLER), + String.valueOf(mCurrentFolderId) + }, + NoteColumns.MODIFIED_DATE + " DESC"); + } + + public boolean onItemLongClick(AdapterView parent, View view, int position, long id) { + //实现长按项目的点击事件。如果长按的是便签，则通过ActionMode菜单实现；如果长按的是文件夹，则通过ContextMenu菜单实现。 + if (view instanceof NotesListItem) { + mFocusNoteDataItem = ((NotesListItem) view).getItemData(); + if (mFocusNoteDataItem.getType() == Notes.TYPE_NOTE && !mNotesListAdapter.isInChoiceMode()) { + if (mNotesListView.startActionMode(mModeCallBack) != null) { + mModeCallBack.onItemCheckedStateChanged(null, position, id, true); + mNotesListView.performHapticFeedback(HapticFeedbackConstants.LONG_PRESS); + } else { + Log.e(TAG, "startActionMode fails"); + } + } else if (mFocusNoteDataItem.getType() == Notes.TYPE_FOLDER) { + mNotesListView.setOnCreateContextMenuListener(mFolderOnCreateContextMenuListener); + } + } + return false; + } +} diff --git a/other/07_210340161王宇航_代码标注/Note.java b/other/07_210340161王宇航_代码标注/Note.java new file mode 100644 index 0000000..975b9e5 --- /dev/null +++ b/other/07_210340161王宇航_代码标注/Note.java @@ -0,0 +1,253 @@ +/* + * 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.model; +import android.content.ContentProviderOperation; +import android.content.ContentProviderResult; +import android.content.ContentUris; +import android.content.ContentValues; +import android.content.Context; +import android.content.OperationApplicationException; +import android.net.Uri; +import android.os.RemoteException; +import android.util.Log; + +import net.micode.notes.data.Notes; +import net.micode.notes.data.Notes.CallNote; +import net.micode.notes.data.Notes.DataColumns; +import net.micode.notes.data.Notes.NoteColumns; +import net.micode.notes.data.Notes.TextNote; + +import java.util.ArrayList; + + +public class Note { + private ContentValues mNoteDiffValues;//ContentValues是用于给其他应用调用小米便签的内容的共享数据 + private NoteData mNoteData; + private static final String TAG = "Note"; + /** + * Create a new note id for adding a new note to databases + */ + public static synchronized long getNewNoteId(Context context, long folderId) { + // Create a new note in the database//获取新建便签的编号 + ContentValues values = new ContentValues(); + long createdTime = System.currentTimeMillis();//读取当前系统时间 + values.put(NoteColumns.CREATED_DATE, createdTime); + values.put(NoteColumns.MODIFIED_DATE, createdTime); + values.put(NoteColumns.TYPE, Notes.TYPE_NOTE); + values.put(NoteColumns.LOCAL_MODIFIED, 1); + values.put(NoteColumns.PARENT_ID, folderId); + Uri uri = context.getContentResolver().insert(Notes.CONTENT_NOTE_URI, values); +//外部应用对ContentProvider中的数据进行添加、删除、修改和查询操作 + long noteId = 0;//实现外部应用对数据的插入删除等操作 + try { + noteId = Long.valueOf(uri.getPathSegments().get(1)); + } catch (NumberFormatException e) { + Log.e(TAG, "Get note id error :" + e.toString()); + noteId = 0; + } + if (noteId == -1) { + throw new IllegalStateException("Wrong note id:" + noteId); + } + return noteId; + } + + public Note() {//定义两个变量用来存储便签的数据，一个是存储便签属性、一个是存储便签内容 + mNoteDiffValues = new ContentValues(); + mNoteData = new NoteData(); + } + + public void setNoteValue(String key, String value) {//设置数据库表格的标签属性数据 + mNoteDiffValues.put(key, value); + mNoteDiffValues.put(NoteColumns.LOCAL_MODIFIED, 1); + mNoteDiffValues.put(NoteColumns.MODIFIED_DATE, System.currentTimeMillis()); + } + + public void setTextData(String key, String value) { + mNoteData.setTextData(key, value); + } +//设置数据库表格的标签文本内容的数据 + public void setTextDataId(long id) { + mNoteData.setTextDataId(id); + } +//设置文本数据的ID + public long getTextDataId() { + return mNoteData.mTextDataId; + } +//获取文本数据的id + public void setCallDataId(long id) { + mNoteData.setCallDataId(id); + } +//设置电话号码数据的ID + public void setCallData(String key, String value) { + mNoteData.setCallData(key, value); + } +//得到电话号码数据的ID + public boolean isLocalModified() {//判断是否是本地修改 + return mNoteDiffValues.size() > 0 || mNoteData.isLocalModified(); + } + + public boolean syncNote(Context context, long noteId) {//判断便签是否同步 + if (noteId <= 0) { + throw new IllegalArgumentException("Wrong note id:" + noteId); + } + + if (!isLocalModified()) {//如果本地没有发现修改，直接返回1，指示已经同步到数据库中 + return true; + } + + /** + * In theory, once data changed, the note should be updated on {@link NoteColumns#LOCAL_MODIFIED} and + * {@link NoteColumns#MODIFIED_DATE}. For data safety, though update note fails, we also update the + * note data info + */ + if (context.getContentResolver().update(//发现更新错误时，及时反馈错误信息 + ContentUris.withAppendedId(Notes.CONTENT_NOTE_URI, noteId), mNoteDiffValues, null, + null) == 0) { + Log.e(TAG, "Update note error, should not happen"); + // Do not return, fall through + } + mNoteDiffValues.clear();//初始化便签特征值 + + if (mNoteData.isLocalModified()//判断未同步 + && (mNoteData.pushIntoContentResolver(context, noteId) == null)) { + return false; + } + + return true; + } + + private class NoteData {//定义一个基本的便签内容的数据类，主要包含文本数据和电话号码数据 + private long mTextDataId; + + private ContentValues mTextDataValues; + + private long mCallDataId; + + private ContentValues mCallDataValues; + + private static final String TAG = "NoteData"; + + public NoteData() {//NoteData的构造函数，初始化四个变量 + mTextDataValues = new ContentValues(); + mCallDataValues = new ContentValues(); + mTextDataId = 0; + mCallDataId = 0; + } + + boolean isLocalModified() {//下面是上述几个函数的具体实现 + return mTextDataValues.size() > 0 || mCallDataValues.size() > 0; + } + + void setTextDataId(long id) { + if(id <= 0) { + throw new IllegalArgumentException("Text data id should larger than 0"); + } + mTextDataId = id; + } + + void setCallDataId(long id) {//判断ID是否合法 + if (id <= 0) { + throw new IllegalArgumentException("Call data id should larger than 0"); + } + mCallDataId = id; + } + + void setCallData(String key, String value) {//设置电话号码数据内容，并且保存修改时间 + mCallDataValues.put(key, value); + mNoteDiffValues.put(NoteColumns.LOCAL_MODIFIED, 1); + mNoteDiffValues.put(NoteColumns.MODIFIED_DATE, System.currentTimeMillis()); + } + + void setTextData(String key, String value) {//设置文本数据 + mTextDataValues.put(key, value); + mNoteDiffValues.put(NoteColumns.LOCAL_MODIFIED, 1); + mNoteDiffValues.put(NoteColumns.MODIFIED_DATE, System.currentTimeMillis()); + } + + Uri pushIntoContentResolver(Context context, long noteId) {//下面函数的作用是将新的数据通过Uri的操作存储到数据库 + /** + * Check for safety + */ + if (noteId <= 0) { + throw new IllegalArgumentException("Wrong note id:" + noteId); + } + + ArrayList operationList = new ArrayList();//数据库操作链表 + ContentProviderOperation.Builder builder = null; + + if(mTextDataValues.size() > 0) {//把文本数据存入DataColumns + mTextDataValues.put(DataColumns.NOTE_ID, noteId); + if (mTextDataId == 0) {//uri插入文本数据 + mTextDataValues.put(DataColumns.MIME_TYPE, TextNote.CONTENT_ITEM_TYPE); + Uri uri = context.getContentResolver().insert(Notes.CONTENT_DATA_URI, + mTextDataValues); + try { + setTextDataId(Long.valueOf(uri.getPathSegments().get(1)));//尝试重新给它设置id + } catch (NumberFormatException e) { + Log.e(TAG, "Insert new text data fail with noteId" + noteId);//插入数据失败 + mTextDataValues.clear(); + return null; + } + } else { + builder = ContentProviderOperation.newUpdate(ContentUris.withAppendedId(//更新builder对象，追加uri数据和文本ID + Notes.CONTENT_DATA_URI, mTextDataId)); + builder.withValues(mTextDataValues); + operationList.add(builder.build()); + } + mTextDataValues.clear(); + } + + if(mCallDataValues.size() > 0) {//对于电话号码的数据也是和文本数据一样的同步处理 + mCallDataValues.put(DataColumns.NOTE_ID, noteId); + if (mCallDataId == 0) {//将电话号码的id设定为uri提供的id + mCallDataValues.put(DataColumns.MIME_TYPE, CallNote.CONTENT_ITEM_TYPE); + Uri uri = context.getContentResolver().insert(Notes.CONTENT_DATA_URI, + mCallDataValues); + try {/异常处理 + setCallDataId(Long.valueOf(uri.getPathSegments().get(1))); + } catch (NumberFormatException e) { + Log.e(TAG, "Insert new call data fail with noteId" + noteId); + mCallDataValues.clear(); + return null; + } + } else {// 当电话号码不为新建时，更新电话号码ID + builder = ContentProviderOperation.newUpdate(ContentUris.withAppendedId( + Notes.CONTENT_DATA_URI, mCallDataId)); + builder.withValues(mCallDataValues); + operationList.add(builder.build()); + } + mCallDataValues.clear(); + } +//把电话号码数据存入DataColumns + if (operationList.size() > 0) {//存储过程中如果遇到异常，通过如下进行处理 + try { + ContentProviderResult[] results = context.getContentResolver().applyBatch( + Notes.AUTHORITY, operationList); + return (results == null || results.length == 0 || results[0] == null) ? null + : ContentUris.withAppendedId(Notes.CONTENT_NOTE_URI, noteId); + } catch (RemoteException e) {//捕捉操作异常并写回日志 + Log.e(TAG, String.format("%s: %s", e.toString(), e.getMessage())); + return null; + } catch (OperationApplicationException e) { + Log.e(TAG, String.format("%s: %s", e.toString(), e.getMessage()));//异常日志 + return null; + } + } + return null; + } + } +} diff --git a/other/07_210340161王宇航_代码标注/data/MetaData.java b/other/07_210340161王宇航_代码标注/data/MetaData.java new file mode 100644 index 0000000..81f8b8a --- /dev/null +++ b/other/07_210340161王宇航_代码标注/data/MetaData.java @@ -0,0 +1,82 @@ +/* + * 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.gtask.data; + +import android.database.Cursor; +import android.util.Log; + +import net.micode.notes.tool.GTaskStringUtils; + +import org.json.JSONException; +import org.json.JSONObject; + + +public class MetaData extends Task //创建一个继承成Task类的类 + private final static String TAG = MetaData.class.getSimpleName();//实现过程：调用getSimpleName ()函数,得到类的简写名称存入字符串TAG中 + + private String mRelatedGid = null; + + public void setMeta(String gid, JSONObject metaInfo) {//获取相关联的Gid + try { + metaInfo.put(GTaskStringUtils.META_HEAD_GTASK_ID, gid);//将这对键值放入metaInfo这个jsonobject对象中 + } catch (JSONException e) { + Log.e(TAG, "failed to put related gid"); + } + setNotes(metaInfo.toString()); + setName(GTaskStringUtils.META_NOTE_NAME); + } + + public String getRelatedGid() { + return mRelatedGid; + }//判断当前数据是否为空，若为空则返回真即值得保存 + + @Override + public boolean isWorthSaving() { + return getNotes() != null; + }//调用父类Task中的setContentByRemoteJSON ()函数，使用远程json数据对象设置元数据内 + + @Override + public void setContentByRemoteJSON(JSONObject js) {//调用父类Task中的setContentByRemoteJSON ()函数，使用远程json数据对象设置元数据内容 + super.setContentByRemoteJSON(js); + if (getNotes() != null) { + try { + JSONObject metaInfo = new JSONObject(getNotes().trim());//trim():去掉字符串首尾的空格 + mRelatedGid = metaInfo.getString(GTaskStringUtils.META_HEAD_GTASK_ID); + } catch (JSONException e) { + Log.w(TAG, "failed to get related gid"); + mRelatedGid = null; + } + } + } + + @Override + public void setContentByLocalJSON(JSONObject js) {//使用本地json数据对象设置元数据内容，一般不会用到，若用到，则抛出异常 + // this function should not be called + throw new IllegalAccessError("MetaData:setContentByLocalJSON should not be called"); + } + + @Override + public JSONObject getLocalJSONFromContent() {//从元数据内容中获取本地json对象，抛出异常 + throw new IllegalAccessError("MetaData:getLocalJSONFromContent should not be called"); + } + + @Override + public int getSyncAction(Cursor c) {//获取同步动作状态 + throw new IllegalAccessError("MetaData:getSyncAction should not be called"); + } + +} diff --git a/other/07_210340161王宇航_代码标注/data/Node.java b/other/07_210340161王宇航_代码标注/data/Node.java new file mode 100644 index 0000000..8f958d3 --- /dev/null +++ b/other/07_210340161王宇航_代码标注/data/Node.java @@ -0,0 +1,101 @@ +/* + * 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.gtask.data; + +import android.database.Cursor; + +import org.json.JSONObject; + +public abstract class Node {//同步操作的基础数据类型，定义了相关指示同步操作的常量 + public static final int SYNC_ACTION_NONE = 0; +//定义了各种用于表征同步状态的常量，需要操作标识 + public static final int SYNC_ACTION_ADD_REMOTE = 1; + + public static final int SYNC_ACTION_ADD_LOCAL = 2; + + public static final int SYNC_ACTION_DEL_REMOTE = 3; + + public static final int SYNC_ACTION_DEL_LOCAL = 4; + + public static final int SYNC_ACTION_UPDATE_REMOTE = 5; + + public static final int SYNC_ACTION_UPDATE_LOCAL = 6; + + public static final int SYNC_ACTION_UPDATE_CONFLICT = 7; + + public static final int SYNC_ACTION_ERROR = 8; + + private String mGid; + //记录最后一次修改时间 + private String mName;//bool类型，表明表征是否被删除 + + private long mLastModified; + + private boolean mDeleted; + + public Node() {//构造函数，进行初始化，界面没有，名字为空，最后一次修改时间为0（没有修改），表征是否删除。 + mGid = null; + mName = ""; + mLastModified = 0; + mDeleted = false; + } + //函数：定义为一个抽象的函数，在TaskList子类中得到了实现 + public abstract JSONObject getCreateAction(int actionId); +//主要功能：声明JSONObject对象抽象类，获取初始行为，参数为GTASK_JSON_ACTION_ID + public abstract JSONObject getUpdateAction(int actionId); + + public abstract void setContentByRemoteJSON(JSONObject js); + + public abstract void setContentByLocalJSON(JSONObject js); + + public abstract JSONObject getLocalJSONFromContent(); + + public abstract int getSyncAction(Cursor c); + + public void setGid(String gid) { + this.mGid = gid; + } +//行到底部，都是一些赋值和返回值函数，即对构造函数中的对象进行赋值或者获取对象的具体内容。 + public void setName(String name) { + this.mName = name; + } +//设置删除标识 + public void setLastModified(long lastModified) { + this.mLastModified = lastModified; + } + + public void setDeleted(boolean deleted) { + this.mDeleted = deleted; + } + + public String getGid() { + return this.mGid; + } + + public String getName() { + return this.mName; + } + + public long getLastModified() { + return this.mLastModified; + } + + public boolean getDeleted() { + return this.mDeleted; + } +//获取删除标识 +} diff --git a/other/07_210340161王宇航_代码标注/data/SqlData.java b/other/07_210340161王宇航_代码标注/data/SqlData.java new file mode 100644 index 0000000..b81b51e --- /dev/null +++ b/other/07_210340161王宇航_代码标注/data/SqlData.java @@ -0,0 +1,189 @@ +/* + * 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.gtask.data; + +import android.content.ContentResolver; +import android.content.ContentUris; +import android.content.ContentValues; +import android.content.Context; +import android.database.Cursor; +import android.net.Uri; +import android.util.Log; + +import net.micode.notes.data.Notes; +import net.micode.notes.data.Notes.DataColumns; +import net.micode.notes.data.Notes.DataConstants; +import net.micode.notes.data.Notes.NoteColumns; +import net.micode.notes.data.NotesDatabaseHelper.TABLE; +import net.micode.notes.gtask.exception.ActionFailureException; + +import org.json.JSONException; +import org.json.JSONObject; + + +public class SqlData {//公开类， 数据库类 + private static final String TAG = SqlData.class.getSimpleName(); +//调用getSimpleName ()函数来得到类的简写名称存入字符串TAG中 + private static final int INVALID_ID = -99999; + + public static final String[] PROJECTION_DATA = new String[] {//新建一个字符串数组，集合了 interface DataColumns 中所有SF常量 + DataColumns.ID, DataColumns.MIME_TYPE, DataColumns.CONTENT, DataColumns.DATA1, + DataColumns.DATA3 + }; +//代码块：与sqlNote中定义的常量是相类似的，是一些列的序号 + public static final int DATA_ID_COLUMN = 0; +//数据列的这一行表示的项的mime类型 + public static final int DATA_MIME_TYPE_COLUMN = 1; + + public static final int DATA_CONTENT_COLUMN = 2; + + public static final int DATA_CONTENT_DATA_1_COLUMN = 3; + + public static final int DATA_CONTENT_DATA_3_COLUMN = 4; + + private ContentResolver mContentResolver; +//定义以下8个内部变量 + private boolean mIsCreate; +//判断是否直接用Content生成，是为true，否则为false + private long mDataId; + + private String mDataMimeType; +//数据mime类型 + private String mDataContent; +//数据内容 + private long mDataContentData1; + + private String mDataContentData3; + + private ContentValues mDiffDataValues; +//contenvalues只能存储基本类型的数据，像string，int之类的 + public SqlData(Context context) {//构造函数，初始化数据，参数类型为Context + mContentResolver = context.getContentResolver(); + mIsCreate = true;//mIsCreate为TRUE是这种构造方式的标志 + mDataId = INVALID_ID; + mDataMimeType = DataConstants.NOTE; + mDataContent = ""; + mDataContentData1 = 0; + mDataContentData3 = ""; + mDiffDataValues = new ContentValues(); + } +//第二种SqlData的构造方式，通过cursor来获取数据 + public SqlData(Context context, Cursor c) { + mContentResolver = context.getContentResolver(); + mIsCreate = false; + loadFromCursor(c); + mDiffDataValues = new ContentValues(); + } + + private void loadFromCursor(Cursor c) {//构造函数，初始化数据，参数类型分别为 Context 和 Cursor + mDataId = c.getLong(DATA_ID_COLUMN); + mDataMimeType = c.getString(DATA_MIME_TYPE_COLUMN); + mDataContent = c.getString(DATA_CONTENT_COLUMN); + mDataContentData1 = c.getLong(DATA_CONTENT_DATA_1_COLUMN); + mDataContentData3 = c.getString(DATA_CONTENT_DATA_3_COLUMN); + } + + public void setContent(JSONObject js) throws JSONException {//设置用于共享的数据，并提供异常抛出与处理机制，其中很多if 条件语句的判断，某些条件下某些特定的操作 + long dataId = js.has(DataColumns.ID) ? js.getLong(DataColumns.ID) : INVALID_ID; + if (mIsCreate || mDataId != dataId) { + mDiffDataValues.put(DataColumns.ID, dataId); + } + mDataId = dataId; + + String dataMimeType = js.has(DataColumns.MIME_TYPE) ? js.getString(DataColumns.MIME_TYPE)//如果传入的JSONObject对象有DataColumns.MIME_TYPE一项，则设置dataMimeType为这个，否则设为SqlData.java + : DataConstants.NOTE; + if (mIsCreate || !mDataMimeType.equals(dataMimeType)) { + mDiffDataValues.put(DataColumns.MIME_TYPE, dataMimeType); + } + mDataMimeType = dataMimeType; + + String dataContent = js.has(DataColumns.CONTENT) ? js.getString(DataColumns.CONTENT) : ""; + if (mIsCreate || !mDataContent.equals(dataContent)) { + mDiffDataValues.put(DataColumns.CONTENT, dataContent); + } + mDataContent = dataContent; +//以原有数据文本类型为基础，修改共享数据文本类型 + long dataContentData1 = js.has(DataColumns.DATA1) ? js.getLong(DataColumns.DATA1) : 0; + if (mIsCreate || mDataContentData1 != dataContentData1) { + mDiffDataValues.put(DataColumns.DATA1, dataContentData1); + } + mDataContentData1 = dataContentData1;//共享数据同步后，共享1类型数据等于该1类型数据 + + String dataContentData3 = js.has(DataColumns.DATA3) ? js.getString(DataColumns.DATA3) : ""; + if (mIsCreate || !mDataContentData3.equals(dataContentData3)) { + mDiffDataValues.put(DataColumns.DATA3, dataContentData3); + } + mDataContentData3 = dataContentData3; + } +//获取共享数据内容及提供异常抛出与处理机制 + public JSONObject getContent() throws JSONException { + if (mIsCreate) { + Log.e(TAG, "it seems that we haven't created this in database yet"); + return null; + } + JSONObject js = new JSONObject(); + js.put(DataColumns.ID, mDataId); + js.put(DataColumns.MIME_TYPE, mDataMimeType); + js.put(DataColumns.CONTENT, mDataContent); + js.put(DataColumns.DATA1, mDataContentData1); + js.put(DataColumns.DATA3, mDataContentData3); + return js; + } +//将当前数据提交到数据库 + public void commit(long noteId, boolean validateVersion, long version) { +//commit 函数用于把当前所做的修改保存到数据库 + if (mIsCreate) { + if (mDataId == INVALID_ID && mDiffDataValues.containsKey(DataColumns.ID)) { + mDiffDataValues.remove(DataColumns.ID);//更新共享数据，键为NOTE_ID，值为noteId + } + + mDiffDataValues.put(DataColumns.NOTE_ID, noteId); + Uri uri = mContentResolver.insert(Notes.CONTENT_DATA_URI, mDiffDataValues); + try { + mDataId = Long.valueOf(uri.getPathSegments().get(1)); + } catch (NumberFormatException e) { + Log.e(TAG, "Get note id error :" + e.toString()); + throw new ActionFailureException("create note failed"); + } + } else { + if (mDiffDataValues.size() > 0) { + int result = 0; + if (!validateVersion) {//如果版本还没确认，则结果记录下的只是data的ID，还有data内容 + result = mContentResolver.update(ContentUris.withAppendedId( + Notes.CONTENT_DATA_URI, mDataId), mDiffDataValues, null, null); + } else { + result = mContentResolver.update(ContentUris.withAppendedId(//若版本号确认，则对对应id进行更新， + Notes.CONTENT_DATA_URI, mDataId), mDiffDataValues, + " ? in (SELECT " + NoteColumns.ID + " FROM " + TABLE.NOTE + + " WHERE " + NoteColumns.VERSION + "=?)", new String[] { + String.valueOf(noteId), String.valueOf(version) + });//更新不存在，可能是用户在同步时已更新 + } + if (result == 0) { + Log.w(TAG, "there is no update. maybe user updates note when syncing"); + }//如果更新不存在（或许用户在同步时已经完成更新），则报错c + } + } + + mDiffDataValues.clear();//回到初始化，清空，表示已经更新 + mIsCreate = false; + } + + public long getId() { + return mDataId; + }//获取当前id +} diff --git a/other/07_210340161王宇航_代码标注/data/SqlNote.java b/other/07_210340161王宇航_代码标注/data/SqlNote.java new file mode 100644 index 0000000..6cc5814 --- /dev/null +++ b/other/07_210340161王宇航_代码标注/data/SqlNote.java @@ -0,0 +1,505 @@ +/* + * 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.gtask.data; + +import android.appwidget.AppWidgetManager; +import android.content.ContentResolver; +import android.content.ContentValues; +import android.content.Context; +import android.database.Cursor; +import android.net.Uri; +import android.util.Log; + +import net.micode.notes.data.Notes; +import net.micode.notes.data.Notes.DataColumns; +import net.micode.notes.data.Notes.NoteColumns; +import net.micode.notes.gtask.exception.ActionFailureException; +import net.micode.notes.tool.GTaskStringUtils; +import net.micode.notes.tool.ResourceParser; + +import org.json.JSONArray; +import org.json.JSONException; +import org.json.JSONObject; + +import java.util.ArrayList; + + +public class SqlNote {//调用getSimpleName ()函数得到类的简写名称存入字符串TAG中 + private static final String TAG = SqlNote.class.getSimpleName(); +//语句：调用getSimpleName()函数将类的简写名称存到字符串TAG中 + private static final int INVALID_ID = -99999; + + public static final String[] PROJECTION_NOTE = new String[] {//集合了interface NoteColumns中所有SF常量（17个） + NoteColumns.ID, NoteColumns.ALERTED_DATE, NoteColumns.BG_COLOR_ID, + NoteColumns.CREATED_DATE, NoteColumns.HAS_ATTACHMENT, NoteColumns.MODIFIED_DATE, + NoteColumns.NOTES_COUNT, NoteColumns.PARENT_ID, NoteColumns.SNIPPET, NoteColumns.TYPE, + NoteColumns.WIDGET_ID, NoteColumns.WIDGET_TYPE, NoteColumns.SYNC_ID, + NoteColumns.LOCAL_MODIFIED, NoteColumns.ORIGIN_PARENT_ID, NoteColumns.GTASK_ID, + NoteColumns.VERSION + }; +//定义每列的属性： + public static final int ID_COLUMN = 0; + + public static final int ALERTED_DATE_COLUMN = 1; + + public static final int BG_COLOR_ID_COLUMN = 2; + + public static final int CREATED_DATE_COLUMN = 3; + + public static final int HAS_ATTACHMENT_COLUMN = 4; + + public static final int MODIFIED_DATE_COLUMN = 5; + + public static final int NOTES_COUNT_COLUMN = 6; + + public static final int PARENT_ID_COLUMN = 7; + + public static final int SNIPPET_COLUMN = 8; + + public static final int TYPE_COLUMN = 9; + + public static final int WIDGET_ID_COLUMN = 10; + + public static final int WIDGET_TYPE_COLUMN = 11; + + public static final int SYNC_ID_COLUMN = 12; + + public static final int LOCAL_MODIFIED_COLUMN = 13; + + public static final int ORIGIN_PARENT_ID_COLUMN = 14; + + public static final int GTASK_ID_COLUMN = 15; + + public static final int VERSION_COLUMN = 16; + + private Context mContext;//以下定义了17个内部变量，其中12个可以由content获得，5个需要初始化为0或者new + + private ContentResolver mContentResolver; + + private boolean mIsCreate; + + private long mId; + + private long mAlertDate; + + private int mBgColorId; + + private long mCreatedDate; + + private int mHasAttachment; + + private long mModifiedDate; + + private long mParentId; + + private String mSnippet; + + private int mType; + + private int mWidgetId; + + private int mWidgetType; + + private long mOriginParent; + + private long mVersion; + + private ContentValues mDiffNoteValues; + + private ArrayList mDataList; +//SqlNote第一种构造方法，只通过上下文context构造 + public SqlNote(Context context) {//构造函数参数只有context，对所有的变量进行初始化 + mContext = context; + mContentResolver = context.getContentResolver(); + mIsCreate = true;//对象不存在，是要新建的 + mId = INVALID_ID;//无效用户 + mAlertDate = 0; + mBgColorId = ResourceParser.getDefaultBgId(context);//系统默认背景 + mCreatedDate = System.currentTimeMillis();//调用系统函数获取创建时间 + mHasAttachment = 0; + mModifiedDate = System.currentTimeMillis(); + mParentId = 0; + mSnippet = ""; + mType = Notes.TYPE_NOTE; + mWidgetId = AppWidgetManager.INVALID_APPWIDGET_ID;//控件Id初始化 + mWidgetType = Notes.TYPE_WIDGET_INVALIDE;//控件类型初始化 + mOriginParent = 0; + mVersion = 0; + mDiffNoteValues = new ContentValues();//新建一个NoteValues值，用来记录改变的values + mDataList = new ArrayList();// 新建一个data的列表 + } + + public SqlNote(Context context, Cursor c) {//构造函数有context和一个数据库的cursor两个参数，多数变量通过cursor指向的一条记录直接进行初始化 + mContext = context; + mContentResolver = context.getContentResolver(); + mIsCreate = false; + loadFromCursor(c); + mDataList = new ArrayList(); + if (mType == Notes.TYPE_NOTE)//如果是note类型，则调用下面的 loadDataContent()函数，加载数据内容 + loadDataContent(); + mDiffNoteValues = new ContentValues(); + } + + public SqlNote(Context context, long id) {//构造函数，两个参数 + mContext = context; + mContentResolver = context.getContentResolver(); + mIsCreate = false; + loadFromCursor(id);//调用下面的 loadFromCursor函数，通过ID从光标处加载数据 + mDataList = new ArrayList(); + if (mType == Notes.TYPE_NOTE)//如果是数据是便签类型，则加载数据内容 + loadDataContent(); + mDiffNoteValues = new ContentValues(); + + } +//通过id从cursor加载数据 + private void loadFromCursor(long id) {//通过id从光标处加载数据 + Cursor c = null; + try {//通过try避免异常 + c = mContentResolver.query(Notes.CONTENT_NOTE_URI, PROJECTION_NOTE, "(_id=?)", + new String[] { + String.valueOf(id) + }, null);//如果获取成功，则cursor移动到下一条记录，并加载该记录 + if (c != null) {//代码块：如果有内容就将移入文档，并再次等待光标的内容 + c.moveToNext(); + loadFromCursor(c); + } else { + Log.w(TAG, "loadFromCursor: cursor = null"); + } + } finally { + if (c != null) + c.close(); + } + } +//通过cursor从cursor处加载数据 + private void loadFromCursor(Cursor c) {//通过游标从光标处加载数据 + mId = c.getLong(ID_COLUMN);//直接从一条记录中的获得以下变量的初始值 + mAlertDate = c.getLong(ALERTED_DATE_COLUMN); + mBgColorId = c.getInt(BG_COLOR_ID_COLUMN); + mCreatedDate = c.getLong(CREATED_DATE_COLUMN); + mHasAttachment = c.getInt(HAS_ATTACHMENT_COLUMN); + mModifiedDate = c.getLong(MODIFIED_DATE_COLUMN); + mParentId = c.getLong(PARENT_ID_COLUMN); + mSnippet = c.getString(SNIPPET_COLUMN); + mType = c.getInt(TYPE_COLUMN); + mWidgetId = c.getInt(WIDGET_ID_COLUMN); + mWidgetType = c.getInt(WIDGET_TYPE_COLUMN); + mVersion = c.getLong(VERSION_COLUMN); + } +//取ID对应content内容，如果查询到该note的id确实有对应项，即cursor有对应，获取ID对应content内容 + private void loadDataContent() {//通过content机制获取共享数据并加载到数据库当前游标处 + Cursor c = null; + mDataList.clear(); + try {//获取ID对应content内容 + c = mContentResolver.query(Notes.CONTENT_DATA_URI, SqlData.PROJECTION_DATA,//获得该ID对应的数据内容 + "(note_id=?)", new String[] { + String.valueOf(mId) + }, null); + if (c != null) {//如果光标处无内容，提示note无数据warning + if (c.getCount() == 0) { + Log.w(TAG, "it seems that the note has not data"); + return; + } + while (c.moveToNext()) { + SqlData data = new SqlData(mContext, c);//将获取数据存入数据表 + mDataList.add(data); + } + } else { + Log.w(TAG, "loadDataContent: cursor = null"); + } + } finally { + if (c != null) + c.close(); + } + } + //设置content共享信息 + public boolean setContent(JSONObject js) {//设置通过content机制用于共享的数据信息 + try { + JSONObject note = js.getJSONObject(GTaskStringUtils.META_HEAD_NOTE); + if (note.getInt(NoteColumns.TYPE) == Notes.TYPE_SYSTEM) {//不能设置系统文件 + Log.w(TAG, "cannot set system folder"); + } else if (note.getInt(NoteColumns.TYPE) == Notes.TYPE_FOLDER) {//文件夹只能更新摘要和类型 + // for folder we can only update the snnipet and type + String snippet = note.has(NoteColumns.SNIPPET) ? note//如果共享数据存在摘要，则将其赋给声明的 snippet变量，否则变量为空 + .getString(NoteColumns.SNIPPET) : ""; + if (mIsCreate || !mSnippet.equals(snippet)) {/如果没有创建或者该摘要没有匹配原摘要则将其加入解析器 + mDiffNoteValues.put(NoteColumns.SNIPPET, snippet); + } + mSnippet = snippet; + + int type = note.has(NoteColumns.TYPE) ? note.getInt(NoteColumns.TYPE) + : Notes.TYPE_NOTE;//以下操作都和上面对snippet的操作一样，一起根据共享的数据设置SqlNote内容的上述17项 + if (mIsCreate || mType != type) { + mDiffNoteValues.put(NoteColumns.TYPE, type); + } + mType = type; + } else if (note.getInt(NoteColumns.TYPE) == Notes.TYPE_NOTE) { + JSONArray dataArray = js.getJSONArray(GTaskStringUtils.META_HEAD_DATA); + long id = note.has(NoteColumns.ID) ? note.getLong(NoteColumns.ID) : INVALID_ID; + if (mIsCreate || mId != id) { + mDiffNoteValues.put(NoteColumns.ID, id); + } + mId = id;//将该ID覆盖原ID + + long alertDate = note.has(NoteColumns.ALERTED_DATE) ? note//获取数据的提醒日期 + .getLong(NoteColumns.ALERTED_DATE) : 0; + if (mIsCreate || mAlertDate != alertDate) { + mDiffNoteValues.put(NoteColumns.ALERTED_DATE, alertDate); + } + mAlertDate = alertDate; + + int bgColorId = note.has(NoteColumns.BG_COLOR_ID) ? note//获取数据的背景颜色 + .getInt(NoteColumns.BG_COLOR_ID) : ResourceParser.getDefaultBgId(mContext); + if (mIsCreate || mBgColorId != bgColorId) { + mDiffNoteValues.put(NoteColumns.BG_COLOR_ID, bgColorId); + } + mBgColorId = bgColorId;/将该背景颜色覆盖原背景颜色 + + long createDate = note.has(NoteColumns.CREATED_DATE) ? note + .getLong(NoteColumns.CREATED_DATE) : System.currentTimeMillis(); + if (mIsCreate || mCreatedDate != createDate) { + mDiffNoteValues.put(NoteColumns.CREATED_DATE, createDate); + } + mCreatedDate = createDate; + + int hasAttachment = note.has(NoteColumns.HAS_ATTACHMENT) ? note//对附件操作 + .getInt(NoteColumns.HAS_ATTACHMENT) : 0; + if (mIsCreate || mHasAttachment != hasAttachment) { + mDiffNoteValues.put(NoteColumns.HAS_ATTACHMENT, hasAttachment); + } + mHasAttachment = hasAttachment; + + long modifiedDate = note.has(NoteColumns.MODIFIED_DATE) ? note//对最近修改日期操作 + .getLong(NoteColumns.MODIFIED_DATE) : System.currentTimeMillis(); + if (mIsCreate || mModifiedDate != modifiedDate) { + mDiffNoteValues.put(NoteColumns.MODIFIED_DATE, modifiedDate); + } + mModifiedDate = modifiedDate;//将该父节点ID覆盖原父节点ID + + long parentId = note.has(NoteColumns.PARENT_ID) ? note + .getLong(NoteColumns.PARENT_ID) : 0; + if (mIsCreate || mParentId != parentId) {//如果只是通过上下文对note进行数据库操作，或者该文本片段与原文本片段不相同， + mDiffNoteValues.put(NoteColumns.PARENT_ID, parentId); + } + mParentId = parentId; + + String snippet = note.has(NoteColumns.SNIPPET) ? note//如果只是通过上下文对note进行数据库操作，或者该文本片段与原文本片段不相同 + .getString(NoteColumns.SNIPPET) : ""; + if (mIsCreate || !mSnippet.equals(snippet)) { + mDiffNoteValues.put(NoteColumns.SNIPPET, snippet); + } + mSnippet = snippet; + + int type = note.has(NoteColumns.TYPE) ? note.getInt(NoteColumns.TYPE)//对类型操作 + : Notes.TYPE_NOTE; + if (mIsCreate || mType != type) {//如果只是通过上下文对note进行数据库操作，或者该文件类型与原文件类型不相同 + mDiffNoteValues.put(NoteColumns.TYPE, type); + } + mType = type; + + int widgetId = note.has(NoteColumns.WIDGET_ID) ? note.getInt(NoteColumns.WIDGET_ID)//对控件操作 + : AppWidgetManager.INVALID_APPWIDGET_ID; + if (mIsCreate || mWidgetId != widgetId) {//如果只是通过上下文对note进行数据库操作，或者该小部件ID与原小部件ID不相同 + mDiffNoteValues.put(NoteColumns.WIDGET_ID, widgetId); + } + mWidgetId = widgetId; + + int widgetType = note.has(NoteColumns.WIDGET_TYPE) ? note//获取数据的小部件种类 + .getInt(NoteColumns.WIDGET_TYPE) : Notes.TYPE_WIDGET_INVALIDE; + if (mIsCreate || mWidgetType != widgetType) { + mDiffNoteValues.put(NoteColumns.WIDGET_TYPE, widgetType); + } + mWidgetType = widgetType;//将该小部件种类覆盖原小部件种类 + + long originParent = note.has(NoteColumns.ORIGIN_PARENT_ID) ? note + .getLong(NoteColumns.ORIGIN_PARENT_ID) : 0; + if (mIsCreate || mOriginParent != originParent) { + mDiffNoteValues.put(NoteColumns.ORIGIN_PARENT_ID, originParent); + } + mOriginParent = originParent;//将该原始父文件夹ID覆盖原原始父文件夹ID + + for (int i = 0; i < dataArray.length(); i++) {//遍历 dataArray，查找 id 为 dataId 的数据 + JSONObject data = dataArray.getJSONObject(i); + SqlData sqlData = null; + if (data.has(DataColumns.ID)) {//该数据ID对应的数据如果存在，将对应的数据存在数据库中 + long dataId = data.getLong(DataColumns.ID); + for (SqlData temp : mDataList) { + if (dataId == temp.getId()) { + sqlData = temp; + } + } + } + + if (sqlData == null) { + sqlData = new SqlData(mContext); + mDataList.add(sqlData); + } + + sqlData.setContent(data);//最后为数据库数据进行设置 + } + } + } catch (JSONException e) {//出现JSONException时，日志显示错误，同时打印堆栈轨迹 + Log.e(TAG, e.toString()); + e.printStackTrace(); + return false; + } + return true; + } + + public JSONObject getContent() {//获取content机制提供的数据并加载到note中 + try { + JSONObject js = new JSONObject(); + + if (mIsCreate) { + Log.e(TAG, "it seems that we haven't created this in database yet"); + return null; + } + + JSONObject note = new JSONObject();//新建变量note用于传输共享数据 + if (mType == Notes.TYPE_NOTE) { + note.put(NoteColumns.ID, mId); + note.put(NoteColumns.ALERTED_DATE, mAlertDate); + note.put(NoteColumns.BG_COLOR_ID, mBgColorId); + note.put(NoteColumns.CREATED_DATE, mCreatedDate); + note.put(NoteColumns.HAS_ATTACHMENT, mHasAttachment); + note.put(NoteColumns.MODIFIED_DATE, mModifiedDate); + note.put(NoteColumns.PARENT_ID, mParentId); + note.put(NoteColumns.SNIPPET, mSnippet); + note.put(NoteColumns.TYPE, mType); + note.put(NoteColumns.WIDGET_ID, mWidgetId); + note.put(NoteColumns.WIDGET_TYPE, mWidgetType); + note.put(NoteColumns.ORIGIN_PARENT_ID, mOriginParent); + js.put(GTaskStringUtils.META_HEAD_NOTE, note); + + JSONArray dataArray = new JSONArray(); + for (SqlData sqlData : mDataList) {//将note中的data全部存入JSONArray中 + JSONObject data = sqlData.getContent(); + if (data != null) { + dataArray.put(data); + } + } + js.put(GTaskStringUtils.META_HEAD_DATA, dataArray); + } else if (mType == Notes.TYPE_FOLDER || mType == Notes.TYPE_SYSTEM) {//folder类型或system类型 + note.put(NoteColumns.ID, mId); + note.put(NoteColumns.TYPE, mType); + note.put(NoteColumns.SNIPPET, mSnippet); + js.put(GTaskStringUtils.META_HEAD_NOTE, note); + } + + return js; + } catch (JSONException e) {//捕获json类型异常，显示错误，打印堆栈痕迹 + Log.e(TAG, e.toString()); + e.printStackTrace(); + } + return null; + } + + public void setParentId(long id) {//给当前id设置父id + mParentId = id; + mDiffNoteValues.put(NoteColumns.PARENT_ID, id); + } + + public void setGtaskId(String gid) { + mDiffNoteValues.put(NoteColumns.GTASK_ID, gid); + } +//给当前id设置Gtaskid + public void setSyncId(long syncId) { + mDiffNoteValues.put(NoteColumns.SYNC_ID, syncId); + } +//给当前id设置同步id + public void resetLocalModified() { + mDiffNoteValues.put(NoteColumns.LOCAL_MODIFIED, 0); + } +//初始化本地修改，即撤销所有当前修改 + public long getId() { + return mId; + } +//获取当前 id + public long getParentId() { + return mParentId; + } +//获得当前id的父id + public String getSnippet() { + return mSnippet; + } +//获取小片段即用于显示的部分便签内容 + public boolean isNoteType() { + return mType == Notes.TYPE_NOTE; + } +//判断是否为便签类型 + public void commit(boolean validateVersion) {//commit函数用于把当前造作所做的修改保存到数据库 + if (mIsCreate) { + if (mId == INVALID_ID && mDiffNoteValues.containsKey(NoteColumns.ID)) { + mDiffNoteValues.remove(NoteColumns.ID); + } + + Uri uri = mContentResolver.insert(Notes.CONTENT_NOTE_URI, mDiffNoteValues);//内容解析器中插入该便签的uri + try { + mId = Long.valueOf(uri.getPathSegments().get(1)); + } catch (NumberFormatException e) { + Log.e(TAG, "Get note id error :" + e.toString()); + throw new ActionFailureException("create note failed"); + } + if (mId == 0) { + throw new IllegalStateException("Create thread id failed"); + } + + if (mType == Notes.TYPE_NOTE) { + for (SqlData sqlData : mDataList) { + sqlData.commit(mId, false, -1); + } + } + } else { + if (mId <= 0 && mId != Notes.ID_ROOT_FOLDER && mId != Notes.ID_CALL_RECORD_FOLDER) {//对无效id操作 + Log.e(TAG, "No such note"); + throw new IllegalStateException("Try to update note with invalid id");//尝试以无效 id 更新 note + } + if (mDiffNoteValues.size() > 0) { + mVersion ++; + int result = 0; + if (!validateVersion) { + result = mContentResolver.update(Notes.CONTENT_NOTE_URI, mDiffNoteValues, "(" + + NoteColumns.ID + "=?)", new String[] { + String.valueOf(mId) + }); + } else { + result = mContentResolver.update(Notes.CONTENT_NOTE_URI, mDiffNoteValues, "(" + + NoteColumns.ID + "=?) AND (" + NoteColumns.VERSION + "<=?)", + new String[] { + String.valueOf(mId), String.valueOf(mVersion) + }); + } + if (result == 0) {//如果内容解析器没有更新，那么报错：没有更新，或许用户在同步时进行更新 + Log.w(TAG, "there is no update. maybe user updates note when syncing"); + } + } + + if (mType == Notes.TYPE_NOTE) {//note 类型 + for (SqlData sqlData : mDataList) { + sqlData.commit(mId, validateVersion, mVersion); + } + } + } + + // refresh local info + loadFromCursor(mId);//通过 cursor 从当前 id 处加载数据 + if (mType == Notes.TYPE_NOTE) + loadDataContent(); + + mDiffNoteValues.clear(); + mIsCreate = false;//改变数据库构造模式 + } +} diff --git a/other/07_210340161王宇航_代码标注/data/Task.java b/other/07_210340161王宇航_代码标注/data/Task.java new file mode 100644 index 0000000..b071b95 --- /dev/null +++ b/other/07_210340161王宇航_代码标注/data/Task.java @@ -0,0 +1,351 @@ +/* + * 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.gtask.data; + +import android.database.Cursor; +import android.text.TextUtils; +import android.util.Log; + +import net.micode.notes.data.Notes; +import net.micode.notes.data.Notes.DataColumns; +import net.micode.notes.data.Notes.DataConstants; +import net.micode.notes.data.Notes.NoteColumns; +import net.micode.notes.gtask.exception.ActionFailureException; +import net.micode.notes.tool.GTaskStringUtils; + +import org.json.JSONArray; +import org.json.JSONException; +import org.json.JSONObject; + + +public class Task extends Node {//创建Task类（继承父类Node） + private static final String TAG = Task.class.getSimpleName(); +//调用 getSimpleName ()函数来得到类的简写名称并存入字符串TAG中 + private boolean mCompleted; + + private String mNotes; + + private JSONObject mMetaInfo; + + private Task mPriorSibling; + + private TaskList mParent; + + public Task() {//Task类的构造函数，对对象进行初始化 + super(); + mCompleted = false;//接下来是对类的变量进行初始化 + mNotes = null; + mPriorSibling = null; + mParent = null; + mMetaInfo = null; + } + + public JSONObject getCreateAction(int actionId) {//对操作号即actionId 进行一些操作的公用函数 + JSONObject js = new JSONObject(); + + try { + // action_type + js.put(GTaskStringUtils.GTASK_JSON_ACTION_TYPE, + GTaskStringUtils.GTASK_JSON_ACTION_TYPE_CREATE); + + // action_id + js.put(GTaskStringUtils.GTASK_JSON_ACTION_ID, actionId); + + // index + js.put(GTaskStringUtils.GTASK_JSON_INDEX, mParent.getChildTaskIndex(this)); + + // entity_delta + JSONObject entity = new JSONObject();//创建实体数据并将name，创建者id，实体类型存入数据 + entity.put(GTaskStringUtils.GTASK_JSON_NAME, getName()); + entity.put(GTaskStringUtils.GTASK_JSON_CREATOR_ID, "null"); + entity.put(GTaskStringUtils.GTASK_JSON_ENTITY_TYPE, + GTaskStringUtils.GTASK_JSON_TYPE_TASK); + if (getNotes() != null) {//如果存在 notes ，则将其也放入 entity 中 + entity.put(GTaskStringUtils.GTASK_JSON_NOTES, getNotes()); + } + js.put(GTaskStringUtils.GTASK_JSON_ENTITY_DELTA, entity); + + // parent_id + js.put(GTaskStringUtils.GTASK_JSON_PARENT_ID, mParent.getGid()); + + // dest_parent_type + js.put(GTaskStringUtils.GTASK_JSON_DEST_PARENT_TYPE, + GTaskStringUtils.GTASK_JSON_TYPE_GROUP); + + // list_id + js.put(GTaskStringUtils.GTASK_JSON_LIST_ID, mParent.getGid()); + + // prior_sibling_id + if (mPriorSibling != null) { + js.put(GTaskStringUtils.GTASK_JSON_PRIOR_SIBLING_ID, mPriorSibling.getGid()); + } + + } catch (JSONException e) {//抛出异常处理机制 + Log.e(TAG, e.toString()); + e.printStackTrace(); + throw new ActionFailureException("fail to generate task-create jsonobject"); + } + + return js; + } + + public JSONObject getUpdateAction(int actionId) {//接收更新action + JSONObject js = new JSONObject();//声明并初始化 + + try {//同样是使用try和catch进行异常处理操作 + // action_type + js.put(GTaskStringUtils.GTASK_JSON_ACTION_TYPE, + GTaskStringUtils.GTASK_JSON_ACTION_TYPE_UPDATE); + + // action_id + js.put(GTaskStringUtils.GTASK_JSON_ACTION_ID, actionId); + + // id + js.put(GTaskStringUtils.GTASK_JSON_ID, getGid()); + + // entity_delta + JSONObject entity = new JSONObject(); + entity.put(GTaskStringUtils.GTASK_JSON_NAME, getName()); + if (getNotes() != null) { + entity.put(GTaskStringUtils.GTASK_JSON_NOTES, getNotes()); + } + entity.put(GTaskStringUtils.GTASK_JSON_DELETED, getDeleted()); + js.put(GTaskStringUtils.GTASK_JSON_ENTITY_DELTA, entity); + + } catch (JSONException e) {//获取异常类型和异常详细消息 + Log.e(TAG, e.toString()); + e.printStackTrace(); + throw new ActionFailureException("fail to generate task-update jsonobject"); + } + + return js; + } + + public void setContentByRemoteJSON(JSONObject js) { + if (js != null) { + try { + // id + if (js.has(GTaskStringUtils.GTASK_JSON_ID)) { + setGid(js.getString(GTaskStringUtils.GTASK_JSON_ID)); + } + + // last_modified + if (js.has(GTaskStringUtils.GTASK_JSON_LAST_MODIFIED)) { + setLastModified(js.getLong(GTaskStringUtils.GTASK_JSON_LAST_MODIFIED)); + } + + // name + if (js.has(GTaskStringUtils.GTASK_JSON_NAME)) { + setName(js.getString(GTaskStringUtils.GTASK_JSON_NAME)); + } + + // notes + if (js.has(GTaskStringUtils.GTASK_JSON_NOTES)) { + setNotes(js.getString(GTaskStringUtils.GTASK_JSON_NOTES)); + } + + // deleted + if (js.has(GTaskStringUtils.GTASK_JSON_DELETED)) { + setDeleted(js.getBoolean(GTaskStringUtils.GTASK_JSON_DELETED)); + } + + // completed + if (js.has(GTaskStringUtils.GTASK_JSON_COMPLETED)) { + setCompleted(js.getBoolean(GTaskStringUtils.GTASK_JSON_COMPLETED)); + } + } catch (JSONException e) { + Log.e(TAG, e.toString()); + e.printStackTrace(); + throw new ActionFailureException("fail to get task content from jsonobject"); + } + } + } + + public void setContentByLocalJSON(JSONObject js) {//通过本地的json设置内容 + if (js == null || !js.has(GTaskStringUtils.META_HEAD_NOTE) + || !js.has(GTaskStringUtils.META_HEAD_DATA)) { + Log.w(TAG, "setContentByLocalJSON: nothing is avaiable");//那么反馈给用户出错信息 + } + + try {//否则进行try和catch的异常处理操作 + JSONObject note = js.getJSONObject(GTaskStringUtils.META_HEAD_NOTE); + JSONArray dataArray = js.getJSONArray(GTaskStringUtils.META_HEAD_DATA); + + if (note.getInt(NoteColumns.TYPE) != Notes.TYPE_NOTE) {//note 类型匹配失败 + Log.e(TAG, "invalid type");//错误，无效类型 + return; + } + + for (int i = 0; i < dataArray.length(); i++) {//遍历数据数组 + JSONObject data = dataArray.getJSONObject(i); + if (TextUtils.equals(data.getString(DataColumns.MIME_TYPE), DataConstants.NOTE)) { + setName(data.getString(DataColumns.CONTENT)); + break; + } + } + + } catch (JSONException e) { + Log.e(TAG, e.toString()); + e.printStackTrace(); + } + } + + public JSONObject getLocalJSONFromContent() {//从content获取本地json + String name = getName(); + try { + if (mMetaInfo == null) { + // new task created from web + if (name == null) { + Log.w(TAG, "the note seems to be an empty one"); + return null; + } + + JSONObject js = new JSONObject();//初始化四个指针 + JSONObject note = new JSONObject(); + JSONArray dataArray = new JSONArray(); + JSONObject data = new JSONObject(); + data.put(DataColumns.CONTENT, name); + dataArray.put(data); + js.put(GTaskStringUtils.META_HEAD_DATA, dataArray); + note.put(NoteColumns.TYPE, Notes.TYPE_NOTE); + js.put(GTaskStringUtils.META_HEAD_NOTE, note); + return js; + } else {//否则将元数据同步至数据中 + // synced task + JSONObject note = mMetaInfo.getJSONObject(GTaskStringUtils.META_HEAD_NOTE); + JSONArray dataArray = mMetaInfo.getJSONArray(GTaskStringUtils.META_HEAD_DATA); + + for (int i = 0; i < dataArray.length(); i++) {//遍历 dataArray 查找与数据库中DataConstants.NOTE 记录信息一致的 data + JSONObject data = dataArray.getJSONObject(i); + if (TextUtils.equals(data.getString(DataColumns.MIME_TYPE), DataConstants.NOTE)) { + data.put(DataColumns.CONTENT, getName()); + break; + } + } + + note.put(NoteColumns.TYPE, Notes.TYPE_NOTE); + return mMetaInfo; + } + } catch (JSONException e) { + Log.e(TAG, e.toString()); + e.printStackTrace(); + return null; + } + } + + public void setMetaInfo(MetaData metaData) {//设置元数据信息 + if (metaData != null && metaData.getNotes() != null) {//如果元数据存在且能够获取到文本信息 + try { + mMetaInfo = new JSONObject(metaData.getNotes()); + } catch (JSONException e) { + Log.w(TAG, e.toString()); + mMetaInfo = null; + } + } + } + + public int getSyncAction(Cursor c) {//设置同步action + try { + JSONObject noteInfo = null; + if (mMetaInfo != null && mMetaInfo.has(GTaskStringUtils.META_HEAD_NOTE)) {//代码块：元数据信息不为空并且元数据信息还含有“META_HEAD_NOTE”，说明便签存在 + noteInfo = mMetaInfo.getJSONObject(GTaskStringUtils.META_HEAD_NOTE); + } + + if (noteInfo == null) {//云端便签 id 已被删除，不存在，返回更新本地数据的同步行为 + Log.w(TAG, "it seems that note meta has been deleted"); + return SYNC_ACTION_UPDATE_REMOTE; + } + + if (!noteInfo.has(NoteColumns.ID)) {//匹配note的id + Log.w(TAG, "remote note id seems to be deleted"); + return SYNC_ACTION_UPDATE_LOCAL; + } + + // validate the note id now + if (c.getLong(SqlNote.ID_COLUMN) != noteInfo.getLong(NoteColumns.ID)) {//代码块：信息不匹配 + Log.w(TAG, "note id doesn't match"); + return SYNC_ACTION_UPDATE_LOCAL; + } + + if (c.getInt(SqlNote.LOCAL_MODIFIED_COLUMN) == 0) {//判断有无同步 + // there is no local update + if (c.getLong(SqlNote.SYNC_ID_COLUMN) == getLastModified()) {//最近一次修改的 id 匹配成功，返回无的同步行为 + // no update both side + return SYNC_ACTION_NONE; + } else { + // apply remote to local + return SYNC_ACTION_UPDATE_LOCAL; + } + } else { + // validate gtask id + if (!c.getString(SqlNote.GTASK_ID_COLUMN).equals(getGid())) {//判断gtask的id与获取的id是否匹配 + Log.e(TAG, "gtask id doesn't match"); + return SYNC_ACTION_ERROR; + } + if (c.getLong(SqlNote.SYNC_ID_COLUMN) == getLastModified()) {//本地id与云端id一致，即更新云端 + // local modification only + return SYNC_ACTION_UPDATE_REMOTE; + } else { + return SYNC_ACTION_UPDATE_CONFLICT; + } + } + } catch (Exception e) { + Log.e(TAG, e.toString()); + e.printStackTrace(); + } + + return SYNC_ACTION_ERROR; + } + + public boolean isWorthSaving() {//可以保存的情况 + return mMetaInfo != null || (getName() != null && getName().trim().length() > 0) + || (getNotes() != null && getNotes().trim().length() > 0); + } + + public void setCompleted(boolean completed) { + this.mCompleted = completed; + } +//接下来跟上面差不多，返回实例相关变量 + public void setNotes(String notes) { + this.mNotes = notes; + } +//设定是note成员变量 + public void setPriorSibling(Task priorSibling) { + this.mPriorSibling = priorSibling; + } +//设置优先兄弟 task 的优先级 + public void setParent(TaskList parent) { + this.mParent = parent; + } +//设置父节点列表 + public boolean getCompleted() { + return this.mCompleted; + } +//获取 task 是否修改完毕的记录 + public String getNotes() { + return this.mNotes; + } +//获取成员变量 mNotes 的信息 + public Task getPriorSibling() { + return this.mPriorSibling; + } +//获取优先兄弟 task + public TaskList getParent() { + return this.mParent; + } +//获取父节点列表 +} diff --git a/other/07_210340161王宇航_代码标注/data/TaskList.java b/other/07_210340161王宇航_代码标注/data/TaskList.java new file mode 100644 index 0000000..e6e58d9 --- /dev/null +++ b/other/07_210340161王宇航_代码标注/data/TaskList.java @@ -0,0 +1,344 @@ +/* + * 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.gtask.data; + +import android.database.Cursor; +import android.util.Log; + +import net.micode.notes.data.Notes; +import net.micode.notes.data.Notes.NoteColumns; +import net.micode.notes.gtask.exception.ActionFailureException; +import net.micode.notes.tool.GTaskStringUtils; + +import org.json.JSONException; +import org.json.JSONObject; + +import java.util.ArrayList; + + +public class TaskList extends Node {//创建继承 Node的任务表类 + private static final String TAG = TaskList.class.getSimpleName(); +//调用getSimplename（）函数获取名字并赋值给TAG作为标记 + private int mIndex; +//当前Tasklist的指针 + private ArrayList mChildren; +//类中主要的保存数据的单元，用来实现一个以Task为元素的ArrayList + public TaskList() {//TaskList 的构造函数 + super(); + mChildren = new ArrayList(); + mIndex = 1; + } + + public JSONObject getCreateAction(int actionId) {//生成并返回一个包含了一定数据的JSONObject实体 + JSONObject js = new JSONObject(); + + try { + // action_type + js.put(GTaskStringUtils.GTASK_JSON_ACTION_TYPE, + GTaskStringUtils.GTASK_JSON_ACTION_TYPE_CREATE); + + // action_id + js.put(GTaskStringUtils.GTASK_JSON_ACTION_ID, actionId); + + // index + js.put(GTaskStringUtils.GTASK_JSON_INDEX, mIndex); + + // entity_delta + JSONObject entity = new JSONObject(); + entity.put(GTaskStringUtils.GTASK_JSON_NAME, getName()); + entity.put(GTaskStringUtils.GTASK_JSON_CREATOR_ID, "null"); + entity.put(GTaskStringUtils.GTASK_JSON_ENTITY_TYPE, + GTaskStringUtils.GTASK_JSON_TYPE_GROUP); + js.put(GTaskStringUtils.GTASK_JSON_ENTITY_DELTA, entity); + + } catch (JSONException e) { + Log.e(TAG, e.toString()); + e.printStackTrace(); + throw new ActionFailureException("fail to generate tasklist-create jsonobject"); + } + + return js; + } + + public JSONObject getUpdateAction(int actionId) {//参考net.micode.notes.gtask.data.Node#getUpdateAction(int) + 生成并返回一个包含了一定数据的JSONObject实体 + JSONObject js = new JSONObject(); + + try {//初始化 js 中的数据 + // action_type + js.put(GTaskStringUtils.GTASK_JSON_ACTION_TYPE, + GTaskStringUtils.GTASK_JSON_ACTION_TYPE_UPDATE); + + // action_id + js.put(GTaskStringUtils.GTASK_JSON_ACTION_ID, actionId); + + // id + js.put(GTaskStringUtils.GTASK_JSON_ID, getGid()); + + // entity_delta + JSONObject entity = new JSONObject(); + entity.put(GTaskStringUtils.GTASK_JSON_NAME, getName()); + entity.put(GTaskStringUtils.GTASK_JSON_DELETED, getDeleted()); + js.put(GTaskStringUtils.GTASK_JSON_ENTITY_DELTA, entity); + + } catch (JSONException e) {//代码块：处理异常信息 + Log.e(TAG, e.toString()); + e.printStackTrace(); + throw new ActionFailureException("fail to generate tasklist-update jsonobject");//生成更新任务列表的 JSONObject 失败，抛出异常 + } + + return js; + } + + public void setContentByRemoteJSON(JSONObject js) {//通过云端 JSON 数据设置实例化对象 js 的内容 + if (js != null) {//判断js对象是否为空，如果为空即没有内容就不需要进行设置了 + try { + // id + if (js.has(GTaskStringUtils.GTASK_JSON_ID)) {//若 js 中存在 GTASK_JSON_NAME 信息 + setGid(js.getString(GTaskStringUtils.GTASK_JSON_ID)); + } + + // last_modified + if (js.has(GTaskStringUtils.GTASK_JSON_LAST_MODIFIED)) {//若 js 中存在 GTASK_JSON_NAME 信息 + setLastModified(js.getLong(GTaskStringUtils.GTASK_JSON_LAST_MODIFIED)); + } + + // name + if (js.has(GTaskStringUtils.GTASK_JSON_NAME)) {//语句块：对任务的name进行设置 + setName(js.getString(GTaskStringUtils.GTASK_JSON_NAME)); + } + + } catch (JSONException e) {//代码块：处理异常 + Log.e(TAG, e.toString()); + e.printStackTrace(); + throw new ActionFailureException("fail to get tasklist content from jsonobject"); + } + } + } + + public void setContentByLocalJSON(JSONObject js) {//通过本地 JSON 数据设置对象 js 内容 + if (js == null || !js.has(GTaskStringUtils.META_HEAD_NOTE)) { + Log.w(TAG, "setContentByLocalJSON: nothing is avaiable"); + } + + try { + JSONObject folder = js.getJSONObject(GTaskStringUtils.META_HEAD_NOTE); +//NullPointerException这个异常出现在处理对象时对象不存在但又没有捕捉到进行处理的时候 + if (folder.getInt(NoteColumns.TYPE) == Notes.TYPE_FOLDER) { + String name = folder.getString(NoteColumns.SNIPPET); + setName(GTaskStringUtils.MIUI_FOLDER_PREFFIX + name); + } else if (folder.getInt(NoteColumns.TYPE) == Notes.TYPE_SYSTEM) { + if (folder.getLong(NoteColumns.ID) == Notes.ID_ROOT_FOLDER) + setName(GTaskStringUtils.MIUI_FOLDER_PREFFIX + GTaskStringUtils.FOLDER_DEFAULT); + else if (folder.getLong(NoteColumns.ID) == Notes.ID_CALL_RECORD_FOLDER) + setName(GTaskStringUtils.MIUI_FOLDER_PREFFIX + + GTaskStringUtils.FOLDER_CALL_NOTE); + else + Log.e(TAG, "invalid system folder"); + } else { + Log.e(TAG, "error type"); + } + } catch (JSONException e) { + Log.e(TAG, e.toString()); + e.printStackTrace(); + } + } + + public JSONObject getLocalJSONFromContent() {//通过 Content 机制获取本地 JSON 数据 + try { + JSONObject js = new JSONObject(); + JSONObject folder = new JSONObject(); + + String folderName = getName(); + if (getName().startsWith(GTaskStringUtils.MIUI_FOLDER_PREFFIX))//代码块：如果获取的文件夹名称是以[MIUI_Notes]开头，则文件夹名称应删掉前缀 + folderName = folderName.substring(GTaskStringUtils.MIUI_FOLDER_PREFFIX.length(), + folderName.length()); + folder.put(NoteColumns.SNIPPET, folderName); + if (folderName.equals(GTaskStringUtils.FOLDER_DEFAULT)//代码块：这里与上一个函数setContentByRemoteJSON(JSONObject js)是一个逆过程，可以参看上一个函数是如何构造出foldername的 + || folderName.equals(GTaskStringUtils.FOLDER_CALL_NOTE)) + folder.put(NoteColumns.TYPE, Notes.TYPE_SYSTEM); + else + folder.put(NoteColumns.TYPE, Notes.TYPE_FOLDER); + + js.put(GTaskStringUtils.META_HEAD_NOTE, folder); + + return js; + } catch (JSONException e) { + Log.e(TAG, e.toString()); + e.printStackTrace(); + return null; + } + } + + public int getSyncAction(Cursor c) {//通过 cursor 获取同步信息 + try { + if (c.getInt(SqlNote.LOCAL_MODIFIED_COLUMN) == 0) { + // there is no local update + if (c.getLong(SqlNote.SYNC_ID_COLUMN) == getLastModified()) { + // no update both side + return SYNC_ACTION_NONE; + } else { + // apply remote to local + return SYNC_ACTION_UPDATE_LOCAL; + } + } else { + // validate gtask id + if (!c.getString(SqlNote.GTASK_ID_COLUMN).equals(getGid())) { + Log.e(TAG, "gtask id doesn't match"); + return SYNC_ACTION_ERROR; + } + if (c.getLong(SqlNote.SYNC_ID_COLUMN) == getLastModified()) { + // local modification only + return SYNC_ACTION_UPDATE_REMOTE; + } else { + // for folder conflicts, just apply local modification + return SYNC_ACTION_UPDATE_REMOTE; + } + } + } catch (Exception e) {//获取异常类型和异常详细消息 + Log.e(TAG, e.toString()); + e.printStackTrace(); + } + + return SYNC_ACTION_ERROR; + } + + public int getChildTaskCount() { + return mChildren.size(); + }//获得TaskList的大小，即mChildren的大小，mChildren 是TaskList 的一个实例 + + public boolean addChildTask(Task task) {//在当前任务表末尾添加新的任务。 + boolean ret = false; + if (task != null && !mChildren.contains(task)) { + ret = mChildren.add(task); + if (ret) { + // need to set prior sibling and parent + task.setPriorSibling(mChildren.isEmpty() ? null : mChildren + .get(mChildren.size() - 1)); + task.setParent(this); + } + } + return ret; + } + + public boolean addChildTask(Task task, int index) {//在当前任务表中的索引位置添加新的子任务 + if (index < 0 || index > mChildren.size()) {//任务非空且任务表中不存在该任务 + Log.e(TAG, "add child task: invalid index"); + return false; + } + + int pos = mChildren.indexOf(task);//获取要添加的任务在任务表中的位置 + if (task != null && pos == -1) { + mChildren.add(index, task); + + // update the task list + Task preTask = null; + Task afterTask = null; + if (index != 0) + preTask = mChildren.get(index - 1); + if (index != mChildren.size() - 1) + afterTask = mChildren.get(index + 1); + + task.setPriorSibling(preTask);//使得三个任务前后连在一块 + if (afterTask != null) + afterTask.setPriorSibling(task); + } + + return true; + } + + public boolean removeChildTask(Task task) {//删除TaskList中的一个Task + boolean ret = false; + int index = mChildren.indexOf(task); + if (index != -1) { + ret = mChildren.remove(task); + + if (ret) {//如果删除成功，就要将该任务的优先兄弟任务和父任务设置为空 + // reset prior sibling and parent + task.setPriorSibling(null); + task.setParent(null); + + // update the task list + if (index != mChildren.size()) {//代码块：删除成功后，要对任务列表进行更新 + mChildren.get(index).setPriorSibling( + index == 0 ? null : mChildren.get(index - 1)); + } + } + } + return ret; + } + + public boolean moveChildTask(Task task, int index) {//将当前TaskList中含有的某个Task移到index位置 + + if (index < 0 || index >= mChildren.size()) {//代码块：首先判断移动的位置是不是合法的 + Log.e(TAG, "move child task: invalid index"); + return false; + } + + int pos = mChildren.indexOf(task);//task不在列表中 + if (pos == -1) { + Log.e(TAG, "move child task: the task should in the list"); + return false; + } + + if (pos == index) + return true; + return (removeChildTask(task) && addChildTask(task, index)); + } + + public Task findChildTaskByGid(String gid) {//按gid寻找Task + for (int i = 0; i < mChildren.size(); i++) { + Task t = mChildren.get(i); + if (t.getGid().equals(gid)) { + return t; + } + } + return null; + } + + public int getChildTaskIndex(Task task) { + return mChildren.indexOf(task); + }//返回指定Task的index + + public Task getChildTaskByIndex(int index) {//返回指定index的Task + if (index < 0 || index >= mChildren.size()) { + Log.e(TAG, "getTaskByIndex: invalid index"); + return null; + } + return mChildren.get(index); + } +//返回指定gid的任务task + public Task getChilTaskByGid(String gid) { + for (Task task : mChildren) { + if (task.getGid().equals(gid)) + return task; + } + return null; + } + + public ArrayList getChildTaskList() { + return this.mChildren; + }//获取子任务列表 + + public void setIndex(int index) { + this.mIndex = index; + } +//设置任务索引 + public int getIndex() { + return this.mIndex; + } +}//获取任务索引 diff --git a/other/07_210340161王宇航_代码标注/exception/ActionFailureException.java b/other/07_210340161王宇航_代码标注/exception/ActionFailureException.java new file mode 100644 index 0000000..53bf37d --- /dev/null +++ b/other/07_210340161王宇航_代码标注/exception/ActionFailureException.java @@ -0,0 +1,34 @@ +/* + * 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.gtask.exception;//小米便签行为异常处理 + +public class ActionFailureException extends RuntimeException { + private static final long serialVersionUID = 4425249765923293627L; +//serialVersionUID相当于java类的身份证。 +//有版本控制的功能。 + public ActionFailureException() { + super(); + } +//如果一个类从另外一个类继承，我们new这个子类的实例对象的时候，这个子类对象里面会有一个父类对象。 + public ActionFailureException(String paramString) { + super(paramString); + } +//由于本类是extends的Exception类，所以super调用的是Exception的类，本语句相当于Exception（paramString） + public ActionFailureException(String paramString, Throwable paramThrowable) { + super(paramString, paramThrowable); + } +}//具有相同形参paramString和paramThrowable的构造方法来调用父类 diff --git a/other/07_210340161王宇航_代码标注/exception/NetworkFailureException.java b/other/07_210340161王宇航_代码标注/exception/NetworkFailureException.java new file mode 100644 index 0000000..9913732 --- /dev/null +++ b/other/07_210340161王宇航_代码标注/exception/NetworkFailureException.java @@ -0,0 +1,34 @@ +/* + * 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.gtask.exception;//小米便签网络异常处理 + +public class NetworkFailureException extends Exception { + private static final long serialVersionUID = 2107610287180234136L; +//serialVersionUID相当于java类的身份证。主要用于版本控制。 + public NetworkFailureException() { + super(); + } +//不带参数的构造函数，super指向父类 + public NetworkFailureException(String paramString)//调用父类具有相同形参paramString的构造方法，相当于Exception(paramString) { + super(paramString); + } + + public NetworkFailureException(String paramString, Throwable paramThrowable) { + super(paramString, paramThrowable); + } +}//带有两个参数的函数。 +调用父类具有相同形参paramString和paramThrowable的构造方法 \ No newline at end of file diff --git a/other/07_210340164温雍敬_代码标注/NotesListItem.java b/other/07_210340164温雍敬_代码标注/NotesListItem.java new file mode 100644 index 0000000..cccdb9a --- /dev/null +++ b/other/07_210340164温雍敬_代码标注/NotesListItem.java @@ -0,0 +1,124 @@ +/* + * 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; +import android.text.format.DateUtils; +import android.view.View; +import android.widget.CheckBox; +import android.widget.ImageView; +import android.widget.LinearLayout; +import android.widget.TextView; + +import net.micode.notes.R; +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;勾选框 + + public NotesListItem(Context context) {// 初始化基本信息 + super(context);//调用父类具有相同形参的函数 + inflate(context, R.layout.note_item, this);//inflate()作用就是将xml定义的一个布局找出来 + mAlert = (ImageView) findViewById(R.id.iv_alert_icon);//findViewById用于从contentView中查找指定ID的View，转换出来的形式根据需要而定 + 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);//获取复选框 + } + + public void bind(Context context, NoteItemData data, boolean choiceMode, boolean checked) {//根据data的属性对各个控件的属性的控制， + // 主要是可见性Visibility，内容setText，格式setTextAppearance + if (choiceMode && data.getType() == Notes.TYPE_NOTE) {//如果处于选择模式并且是便签类型时，设置为可见及勾选，否则设置为不可见。 + mCheckBox.setVisibility(View.VISIBLE); + mCheckBox.setChecked(checked);//设置勾选 + } else { + mCheckBox.setVisibility(View.GONE);//否则设置复选框不可见 + } + + mItemData = data;//把数据传给标签 + if (data.getId() == Notes.ID_CALL_RECORD_FOLDER) {//设置控件属性，通过判断保存到文件夹的ID、当前ID以及父ID之间关系决定 + mCallName.setVisibility(View.GONE);//设置setText 的style + mAlert.setVisibility(View.VISIBLE);//设置提醒闹钟可见 + mTitle.setTextAppearance(context, R.style.TextAppearancePrimaryItem);//设置外观风格 + 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);//设置图片来源 + } else if (data.getParentId() == Notes.ID_CALL_RECORD_FOLDER) {//闹钟设置 + mCallName.setVisibility(View.VISIBLE); + 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.setVisibility(View.VISIBLE);// + } else { + mAlert.setVisibility(View.GONE); + }//否则设置提醒图标不可见 + } else { + mCallName.setVisibility(View.GONE);//如果父类和当前id均与保存在文件夹中的id不同，设置联系人姓名不可见 + mTitle.setTextAppearance(context, R.style.TextAppearancePrimaryItem); + + if (data.getType() == Notes.TYPE_FOLDER) {//设置标题格式 + mTitle.setText(data.getSnippet()//设置便签标题内容为便签的前面部分的内容+文件数+便签数 + + context.getString(R.string.format_folder_files_count, + data.getNotesCount())); + mAlert.setVisibility(View.GONE); + } else { + mTitle.setText(DataUtils.getFormattedSnippet(data.getSnippet())); + //若没有设置标题，将标题设置为内容前面部分 + if (data.hasAlert()) {//若存在提醒时间 + mAlert.setImageResource(R.drawable.clock); + mAlert.setVisibility(View.VISIBLE); + } else { + mAlert.setVisibility(View.GONE);//否则设置威不可见 + } + } + } + mTime.setText(DateUtils.getRelativeTimeSpanString(data.getModifiedDate())); + + setBackground(data);//设置背景 + } + + private void setBackground(NoteItemData data) {//根据data的文件属性来设置背景 + int id = data.getBgColorId();//获取id，用此id用来获取背景颜色 + if (data.getType() == Notes.TYPE_NOTE) {//若是note型文件，则4种情况，对于4种不同情况的背景来源 + if (data.isSingle() || data.isOneFollowingFolder()) {//单个数据或只有一个文件夹 + setBackgroundResource(NoteItemBgResources.getNoteBgSingleRes(id));//设置背景颜色为单个便签背景 + } else if (data.isLast()) { + setBackgroundResource(NoteItemBgResources.getNoteBgLastRes(id)); + } else if (data.isFirst() || data.isMultiFollowingFolder()) { + setBackgroundResource(NoteItemBgResources.getNoteBgFirstRes(id)); + } else { + setBackgroundResource(NoteItemBgResources.getNoteBgNormalRes(id)); + } + } else { + setBackgroundResource(NoteItemBgResources.getFolderBgRes()); + } + } + + public NoteItemData getItemData() { + return mItemData; + }//返回当前便签的文件信息 +} diff --git a/other/07_210340164温雍敬_代码标注/NotesPreferenceActivity.java b/other/07_210340164温雍敬_代码标注/NotesPreferenceActivity.java new file mode 100644 index 0000000..b020aa8 --- /dev/null +++ b/other/07_210340164温雍敬_代码标注/NotesPreferenceActivity.java @@ -0,0 +1,396 @@ +/* + * 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.accounts.Account; +import android.accounts.AccountManager; +import android.app.ActionBar; +import android.app.AlertDialog; +import android.content.BroadcastReceiver; +import android.content.ContentValues; +import android.content.Context; +import android.content.DialogInterface; +import android.content.Intent; +import android.content.IntentFilter; +import android.content.SharedPreferences; +import android.os.Bundle; +import android.preference.Preference; +import android.preference.Preference.OnPreferenceClickListener; +import android.preference.PreferenceActivity; +import android.preference.PreferenceCategory; +import android.text.TextUtils; +import android.text.format.DateFormat; +import android.view.LayoutInflater; +import android.view.Menu; +import android.view.MenuItem; +import android.view.View; +import android.widget.Button; +import android.widget.TextView; +import android.widget.Toast; + +import net.micode.notes.R; +import net.micode.notes.data.Notes; +import net.micode.notes.data.Notes.NoteColumns; +import net.micode.notes.gtask.remote.GTaskSyncService; + + +public class NotesPreferenceActivity extends PreferenceActivity { + //NotesPreferenceActivity，在小米便签中主要实现的是对背景颜色和字体大小的数据储存。 + // 继承了PreferenceActivity主要功能为对系统信息和配置进行自动保存的Activity + 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_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 AUTHORITIES_FILTER_KEY = "authorities"; + //设置本地密码 + private PreferenceCategory mAccountCategory; + //设置账户分组 + private GTaskReceiver mReceiver; + //同步任务接收器 + private Account[] mOriAccounts; + //账户 + private boolean mHasAddedAccount; + // 账户的has标记 + @Override + protected void onCreate(Bundle icicle) {//创建一个activity，在函数里要完成所有的正常静态设置 + super.onCreate(icicle);//.执行父类创建函数 + + /* using the app icon for navigation */ + getActionBar().setDisplayHomeAsUpEnabled(true);//给左上角图标的左边加上一个返回的图标 + + addPreferencesFromResource(R.xml.preferences); + mAccountCategory = (PreferenceCategory) findPreference(PREFERENCE_SYNC_ACCOUNT_KEY); + //根据同步账户密码进行账户分组 + mReceiver = new GTaskReceiver();//设置同步任务接收器 + IntentFilter filter = new IntentFilter();//设置过滤项 + filter.addAction(GTaskSyncService.GTASK_SERVICE_BROADCAST_NAME); + registerReceiver(mReceiver, filter); + //注册监听器，和对应的filter绑定 + mOriAccounts = null; + View header = LayoutInflater.from(this).inflate(R.layout.settings_header, null); + getListView().addHeaderView(header, null, true); + //从xml获取Listview，获取listvivew，ListView的作用:用于列出所有选择 + } + + @Override + protected void onResume() {//activity交互功能的实现，用于接受用户的输入 + super.onResume();// + + // need to set sync account automatically if user has added a new + // account + 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); + break; + } + } + } + } + + refreshUI(); + } + + @Override + protected void onDestroy() {//销毁Activity + if (mReceiver != null) { + unregisterReceiver(mReceiver);//执行销毁操作 + } + super.onDestroy(); + } + + private void loadAccountPreference() {//设置账户信息 + mAccountCategory.removeAll();//移除所有分组 + + 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));//与google task同步便签记录 + accountPref.setOnPreferenceClickListener(new OnPreferenceClickListener() {//设置preference的的监听器 + public boolean onPreferenceClick(Preference preference) {//功能描述：响应偏好对应元素的点击 + //函数实现：判断是否处于同步模式和默认的数据，指向不同的操作 + if (!GTaskSyncService.isSyncing()) {//若不在同步状态 + 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.makeText(NotesPreferenceActivity.this, + R.string.preferences_toast_cannot_change_account, Toast.LENGTH_SHORT) + .show(); + }//不能切换处于同步的账号 + 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 { + syncButton.setText(getString(R.string.preferences_button_sync_immediately));//非同步状态下按键显示“立即同步”，设置相关监听器 + syncButton.setOnClickListener(new View.OnClickListener() { + public void onClick(View v) {//点击行为 + GTaskSyncService.startSync(NotesPreferenceActivity.this); + }//开始操作 + }); + } + syncButton.setEnabled(!TextUtils.isEmpty(getSyncAccountName(this))); + //如果没有账户，则不可选“立即同步”的按键 + // set last sync time + if (GTaskSyncService.isSyncing()) { + lastSyncTimeView.setText(GTaskSyncService.getProgressString()); + lastSyncTimeView.setVisibility(View.VISIBLE);//根据当前同步服务器设置时间显示框的文本以及可见性 + } 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 { + lastSyncTimeView.setVisibility(View.GONE); + }//最近同步时间为空设置同步时间不可见 + } + } + + private void refreshUI() { + loadAccountPreference(); + loadSyncButton(); + }//刷新标签界面 + + private void showSelectAccountAlertDialog() {//显示账户选择的对话框并进行账户的设置 + 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);//取消设置键按钮 + + Account[] accounts = getGoogleAccounts();//获得谷歌当前账户列表 + String defAccount = getSyncAccountName(this);//默认账户 + + mOriAccounts = accounts; + mHasAddedAccount = false;//获得账户同步信息 + + if (accounts.length > 0) {//如果有账户，则显示所有账户名称 + CharSequence[] items = new CharSequence[accounts.length]; + final CharSequence[] itemMapping = items; + int checkedItem = -1; + int index = 0; + for (Account account : accounts) {//for循环检查账户列表 + if (TextUtils.equals(account.name, defAccount)) { + checkedItem = index;//查询目标账户 + } + items[index++] = account.name; + } + dialogBuilder.setSingleChoiceItems(items, checkedItem, + new DialogInterface.OnClickListener() {//在对话框建立一个复选的对话框 + public void onClick(DialogInterface dialog, int which) {//添加点击监听器 + setSyncAccount(itemMapping[which].toString());//同步账户设置 + dialog.dismiss();//取消对话框 + refreshUI();//刷新界面 + } + }); + } + + View addAccountView = LayoutInflater.from(this).inflate(R.layout.add_account_text, null); + dialogBuilder.setView(addAccountView); + //添加新账户，并为账户添加对话框视图 + 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"); + intent.putExtra(AUTHORITIES_FILTER_KEY, new String[] { + "gmail-ls" + });//建立网络组件 + startActivityForResult(intent, -1);//返回上一选项 + dialog.dismiss(); + } + }); + } + + private void showChangeAccountConfirmAlertDialog() {//刷新标签界面 + 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_change_account_title, + 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); + + 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) { + if (which == 0) {//若改变账户，则可显示该账户信息 + showSelectAccountAlertDialog(); + } else if (which == 1) { + removeSyncAccount(); + refreshUI(); + } + } + });// + 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)) {//若该账户不在同步列表内 + 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();//提交数据 + + // clean up last sync time + setLastSyncTime(this, 0); + + // clean up local gtask related info + new Thread(new Runnable() { + public void run() {//清除本地的gtask关联的信息 将一些参数设置为0或NULL + ContentValues values = new ContentValues(); + values.put(NoteColumns.GTASK_ID, ""); + values.put(NoteColumns.SYNC_ID, 0); + 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)) {//若当前账户首选项存在数据，就删除 + editor.remove(PREFERENCE_SYNC_ACCOUNT_NAME); + } + if (settings.contains(PREFERENCE_LAST_SYNC_TIME)) {//删除当前账户存在时间 + editor.remove(PREFERENCE_LAST_SYNC_TIME); + } + editor.commit(); + + // clean up local gtask related info + new Thread(new Runnable() {// + public void run() {//清除本地的gtask关联的信息，将一些参数设置为0或NULL + ContentValues values = new ContentValues(); + values.put(NoteColumns.GTASK_ID, ""); + values.put(NoteColumns.SYNC_ID, 0); + 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); + } + + private class GTaskReceiver extends BroadcastReceiver { + //响应收到的广播情况 + @Override + public void onReceive(Context context, Intent intent) {//获取随广播而来的Intent中的同步服务的数据 + refreshUI(); + if (intent.getBooleanExtra(GTaskSyncService.GTASK_SERVICE_BROADCAST_IS_SYNCING, false)) { + TextView syncStatus = (TextView) findViewById(R.id.prefenerece_sync_status_textview); + syncStatus.setText(intent + .getStringExtra(GTaskSyncService.GTASK_SERVICE_BROADCAST_PROGRESS_MSG)); + }//如果在同步状态，改变同步按钮显示的文本 + + } + } + + public boolean onOptionsItemSelected(MenuItem item) {//处理菜单选项 + switch (item.getItemId()) { + case android.R.id.home://返回主界面 + Intent intent = new Intent(this, NotesListActivity.class); + //开始创建活动 + intent.addFlags(Intent.FLAG_ACTIVITY_CLEAR_TOP); + startActivity(intent);//开始活动 + return true; + default: + return false;//若出现错误则返回 + } + } +} diff --git a/other/07_210340164温雍敬_代码标注/ui/AlarmAlertActivity.java b/other/07_210340164温雍敬_代码标注/ui/AlarmAlertActivity.java new file mode 100644 index 0000000..0297e8c --- /dev/null +++ b/other/07_210340164温雍敬_代码标注/ui/AlarmAlertActivity.java @@ -0,0 +1,161 @@ +/* + * 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.app.Activity; +import android.app.AlertDialog; +import android.content.Context; +import android.content.DialogInterface; +import android.content.DialogInterface.OnClickListener; +import android.content.DialogInterface.OnDismissListener; +import android.content.Intent; +import android.media.AudioManager; +import android.media.MediaPlayer; +import android.media.RingtoneManager; +import android.net.Uri; +import android.os.Bundle; +import android.os.PowerManager; +import android.provider.Settings; +import android.view.Window; +import android.view.WindowManager; + +import net.micode.notes.R; +import net.micode.notes.data.Notes; +import net.micode.notes.tool.DataUtils; + +import java.io.IOException;//import iiii//im + +//import 各种文件 +public class AlarmAlertActivity extends Activity implements OnClickListener, OnDismissListener { + //6. 该类继承于Activity类，并实现了OnClickListener, OnDismissListener接口，主要实现的功能是对相关点击事件的侦听，里面实现了创建AlarmAlert的过程，在这个过程中，需要检查该闹铃是否显示即isScreenOn方法，并实现了对闹铃声音的控制，play以及stop两种方法实现了对闹铃的控制过程， + // OnClick, OnDisMiss方法实现了对闹铃设置相关数据的设置管理。对于停止闹铃的实现，主要是对mPlayer数据的stop以及release实现。 + private long mNoteId; //定义一个关于便签 的id号 + private String mSnippet;//闹钟提示时出现的字符串 + private static final int SNIPPET_PREW_MAX_LEN = 60; //定义字符串长度的最大值 + MediaPlayer mPlayer; // 定义一个媒体播放器 + + @Override// + protected void onCreate(Bundle savedInstanceState) { //重载onCreate的方法 + super.onCreate(savedInstanceState); + requestWindowFeature(Window.FEATURE_NO_TITLE);//要隐藏标题栏 + + final Window win = getWindow(); //获取窗口实例，由于上一行已经设置为无窗口类型，故final表示窗口已经无法改变 + win.addFlags(WindowManager.LayoutParams.FLAG_SHOW_WHEN_LOCKED); // 锁屏时出现的提示字符串 + + if (!isScreenOn()) { //定义一个1.定义了一个当前闹钟提醒窗口的临时变量,通过它为闹钟提醒窗口添加一项Flag，即将其设置成在能够锁屏界面上显示的窗口。 + win.addFlags(WindowManager.LayoutParams.FLAG_KEEP_SCREEN_ON //当闹钟时间到后，需要点亮屏幕 + | WindowManager.LayoutParams.FLAG_TURN_SCREEN_ON + | WindowManager.LayoutParams.FLAG_ALLOW_LOCK_WHILE_SCREEN_ON + | WindowManager.LayoutParams.FLAG_LAYOUT_INSET_DECOR); + } + + Intent intent = getIntent();// 获取本次操作数据 + + try { //try 里面的内容如果出现错误，或者是没有该变量也不会卡死程序，会跳过try继续运行 + mNoteId = Long.valueOf(intent.getData().getPathSegments().get(1));//通过intent临时变量获取事先存入的标签的id号，存入mNoteId + mSnippet = DataUtils.getSnippetById(this.getContentResolver(), mNoteId);//通过该id号，从DataUtils中获取所对应便签的摘要，存入mSnippet中 + mSnippet = mSnippet.length() > SNIPPET_PREW_MAX_LEN ? mSnippet.substring(0, + SNIPPET_PREW_MAX_LEN) + getResources().getString(R.string.notelist_string_info) + : mSnippet; //判断标签片段是否超过符合长度，超过就限制在最大长度 + } catch (IllegalArgumentException e) { + e.printStackTrace(); + return; + } //catch 捕获IllegalArgumentException e异常，若出现异常则输出 + + mPlayer = new MediaPlayer(); //新建一个媒体播放器 + if (DataUtils.visibleInNoteDatabase(getContentResolver(), mNoteId, Notes.TYPE_NOTE)) { + showActionDialog(); //由该便签的id从数据库中获取其类型，判断是否为需要提醒的便签，若是该类型便签，则显示对话框 + playAlarmSound(); //开始播放闹钟铃声 + } else { + finish(); //否则闹钟结束 + } + } + + private boolean isScreenOn() { //布尔函数 判断屏幕是否锁屏 + PowerManager pm = (PowerManager) getSystemService(Context.POWER_SERVICE); + return pm.isScreenOn(); // 1.创建android类PowerManager的一个实例对象，通过android函数getSystemService函数获取 + // 当前android系统的电源管理句柄 + } + + private void playAlarmSound() { //播放闹钟提示音 + Uri url = RingtoneManager.getActualDefaultRingtoneUri(this, RingtoneManager.TYPE_ALARM); + //使用了android的铃声管理器方法，获取当前默认的系统提醒铃声的Uri，并存入变量url中 + int silentModeStreams = Settings.System.getInt(getContentResolver(), + Settings.System.MODE_RINGER_STREAMS_AFFECTED, 0); + //setting.system获取全局变量，在此处是判断手机是否静音 + if ((silentModeStreams & (1 << AudioManager.STREAM_ALARM)) != 0) { + mPlayer.setAudioStreamType(silentModeStreams); //根据当前的设置是否为静音状态和当前的系统铃声来指定流媒体类型。 + } else { + mPlayer.setAudioStreamType(AudioManager.STREAM_ALARM); + } //是媒体播放器发出警报 + try { //使用相关的的闹钟信息，使用try避免异常 + mPlayer.setDataSource(this, url); + mPlayer.prepare(); //进行准备工作 + mPlayer.setLooping(true); // 设置闹钟循环 + mPlayer.start(); //播放开始 + } catch (IllegalArgumentException e) {/*使用catch来捕获异常，获取非法异常参数*/ + // TODO Auto-generated catch block + e.printStackTrace(); + } catch (SecurityException e) { //安全异常 + // TODO Auto-generated catch block + e.printStackTrace(); + } catch (IllegalStateException e) { //非法状态异常 + // TODO Auto-generated catch block + e.printStackTrace(); + } catch (IOException e) { // 输出异常 + // TODO Auto-generated catch block + e.printStackTrace(); + } + } + + private void showActionDialog() { //显示操作对话框 + AlertDialog.Builder dialog = new AlertDialog.Builder(this); // new对话框 + dialog.setTitle(R.string.app_name); //为对话框设置名称 + dialog.setMessage(mSnippet); //添加对话框内容 + dialog.setPositiveButton(R.string.notealert_ok, this); //为对话框设置开始按钮 + if (isScreenOn()) { + dialog.setNegativeButton(R.string.notealert_enter, this); + } + dialog.show().setOnDismissListener(this); + } /*显示设定好的提醒对话框，并附加一个解除监听器，在对话框解除时可执行onDismiss的功能*/ + + public void onClick(DialogInterface dialog, int which) { //不同的switch来确定接下来的操作 + switch (which) { + case DialogInterface.BUTTON_NEGATIVE: //进行取消操作 + Intent intent = new Intent(this, NoteEditActivity.class); + intent.setAction(Intent.ACTION_VIEW); + intent.putExtra(Intent.EXTRA_UID, mNoteId); + startActivity(intent); //开始活动 + break; + default: + break; + } + } + + public void onDismiss(DialogInterface dialog) { /*对话框取消时停止提醒*/ + stopAlarmSound();//结束闹钟铃声 + finish(); + } + + private void stopAlarmSound() {/*闹钟结束操作*/ + if (mPlayer != null) { //如果播放器的提示框仍存在 + mPlayer.stop(); //停止闹钟播放器 + mPlayer.release(); //释放播放器 + mPlayer = null; ///清空播放器内容 + } + } +} diff --git a/other/07_210340164温雍敬_代码标注/ui/AlarmInitReceiver.java b/other/07_210340164温雍敬_代码标注/ui/AlarmInitReceiver.java new file mode 100644 index 0000000..fa135d3 --- /dev/null +++ b/other/07_210340164温雍敬_代码标注/ui/AlarmInitReceiver.java @@ -0,0 +1,66 @@ +/* + * 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.app.AlarmManager; +import android.app.PendingIntent; +import android.content.BroadcastReceiver; +import android.content.ContentUris; +import android.content.Context; +import android.content.Intent; +import android.database.Cursor; + +import net.micode.notes.data.Notes; +import net.micode.notes.data.Notes.NoteColumns; + + +public class AlarmInitReceiver extends BroadcastReceiver { + //该类继承于BroadcastReceiver类，该类主要用于对闹铃信息的接受，相关的类会使用sendBroadcast()方法发送的意图， + // 该类重新实现了Onreceive（）方法，该方法实现对广播的侦听，由此实现对接受闹铃启动消息的功能。 + private static final String [] PROJECTION = new String [] { + NoteColumns.ID, + NoteColumns.ALERTED_DATE + };//声明PROJECTION，每个元素包括id和提醒日期 + + private static final int COLUMN_ID = 0; + private static final int COLUMN_ALERTED_DATE = 1; + //设置ID和默认时间初始值 + @Override + public void onReceive(Context context, Intent intent) { //接受广播后的处理过程 + long currentDate = System.currentTimeMillis(); + Cursor c = context.getContentResolver().query(Notes.CONTENT_NOTE_URI,//Cursor在这里的作用是通过查找数据库中的标签内容，找到和当前系统时间相等的标签 + PROJECTION, + NoteColumns.ALERTED_DATE + ">? AND " + NoteColumns.TYPE + "=" + Notes.TYPE_NOTE, + new String[] { String.valueOf(currentDate) },//获取当前时间大于设置时间的便签项 + null); + + if (c != null) { + if (c.moveToFirst()) { //移动到开始位置 + do { + long alertDate = c.getLong(COLUMN_ALERTED_DATE); //设置需要提醒的日期 + Intent sender = new Intent(context, AlarmReceiver.class);//向Alarmreceiver发送时间信息 + sender.setData(ContentUris.withAppendedId(Notes.CONTENT_NOTE_URI, c.getLong(COLUMN_ID))); + PendingIntent pendingIntent = PendingIntent.getBroadcast(context, 0, sender, 0); + AlarmManager alermManager = (AlarmManager) context + .getSystemService(Context.ALARM_SERVICE); + alermManager.set(AlarmManager.RTC_WAKEUP, alertDate, pendingIntent);//获得闹钟服务 + } while (c.moveToNext()); + } + c.close(); + } + } +} diff --git a/other/07_210340164温雍敬_代码标注/ui/DateTimePicker.java b/other/07_210340164温雍敬_代码标注/ui/DateTimePicker.java new file mode 100644 index 0000000..717eb55 --- /dev/null +++ b/other/07_210340164温雍敬_代码标注/ui/DateTimePicker.java @@ -0,0 +1,391 @@ +/* + * 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 java.text.DateFormatSymbols; +import java.util.Calendar; + +import net.micode.notes.R; + + +import android.content.Context; +import android.text.format.DateFormat; +import android.view.View; +import android.widget.FrameLayout; +import android.widget.NumberPicker; + +public class DateTimePicker extends FrameLayout { + + private static final boolean DEFAULT_ENABLE_STATE = true; + + private static final int HOURS_IN_HALF_DAY = 12;// 半天内的小时数 + private static final int HOURS_IN_ALL_DAY = 24;// 全天的小时数 + private static final int DAYS_IN_ALL_WEEK = 7;// 一周的天数 + private static final int DATE_SPINNER_MIN_VAL = 0;// 日期选择器的最小值 + private static final int DATE_SPINNER_MAX_VAL = DAYS_IN_ALL_WEEK - 1;// 日期选择器的最大值 + private static final int HOUR_SPINNER_MIN_VAL_24_HOUR_VIEW = 0;// 在24小时显示模式下，小时选择器的最小值 + private static final int HOUR_SPINNER_MAX_VAL_24_HOUR_VIEW = 23;// 在24小时显示模式下，小时选择器的最大值 + private static final int HOUR_SPINNER_MIN_VAL_12_HOUR_VIEW = 1;// 在12小时显示模式下，小时选择器的最小值 + private static final int HOUR_SPINNER_MAX_VAL_12_HOUR_VIEW = 12;// 在12小时显示模式下，小时选择器的最大值 + private static final int MINUT_SPINNER_MIN_VAL = 0;// 分钟选择器的最小值 + private static final int MINUT_SPINNER_MAX_VAL = 59;// 分钟选择器的最大值 + private static final int AMPM_SPINNER_MIN_VAL = 0;// 上下午选择器的最小值 + private static final int AMPM_SPINNER_MAX_VAL = 1;// 上下午选择器的最大值 + + private final NumberPicker mDateSpinner;// 日期选择器 + private final NumberPicker mHourSpinner;// 小时选择器 + private final NumberPicker mMinuteSpinner;// 分钟选择器 + private final NumberPicker mAmPmSpinner;// 上下午选择器 + private Calendar mDate;// 当前选择的日期 + + private String[] mDateDisplayValues = new String[DAYS_IN_ALL_WEEK];// 日期选择器的展示值，周一到周日 + + private boolean mIsAm;// 是否是上午，默认为true + private boolean mIs24HourView;// 是否使用24小时显示模式 + + private boolean mIsEnabled = DEFAULT_ENABLE_STATE;// 控件是否可用，默认为true + + private boolean mInitialising;// 是否还在初始化过程中 + + private OnDateTimeChangedListener mOnDateTimeChangedListener;// 选择时间后的回调接口 + + // 当日期改变时的监听器 + private NumberPicker.OnValueChangeListener mOnDateChangedListener = new NumberPicker.OnValueChangeListener() { + @Override + public void onValueChange(NumberPicker picker, int oldVal, int newVal) { + // 更新当前已选日期 + mDate.add(Calendar.DAY_OF_YEAR, newVal - oldVal); + // 更新日期选择器 + updateDateControl(); + // 回调选择时间后的接口方法 + onDateTimeChanged(); + } + }; + + // 当小时改变时的监听器 + private NumberPicker.OnValueChangeListener mOnHourChangedListener = new NumberPicker.OnValueChangeListener() { + @Override + public void onValueChange(NumberPicker picker, int oldVal, int newVal) { + boolean isDateChanged = false;// 是否需要改变日期的标识 + Calendar cal = Calendar.getInstance(); + if (!mIs24HourView) {// 使用12小时制 + if (!mIsAm && oldVal == HOURS_IN_HALF_DAY - 1 && newVal == HOURS_IN_HALF_DAY) { + // 如果从上午11点到下午12点，则需要向后加一整天 + cal.setTimeInMillis(mDate.getTimeInMillis()); + cal.add(Calendar.DAY_OF_YEAR, 1); + isDateChanged = true; + } else if (mIsAm && oldVal == HOURS_IN_HALF_DAY && newVal == HOURS_IN_HALF_DAY - 1) { + // 如果从下午12点到上午11点，则需要向前减一整天 + cal.setTimeInMillis(mDate.getTimeInMillis()); + cal.add(Calendar.DAY_OF_YEAR, -1); + isDateChanged = true; + } + if (oldVal == HOURS_IN_HALF_DAY - 1 && newVal == HOURS_IN_HALF_DAY || + oldVal == HOURS_IN_HALF_DAY && newVal == HOURS_IN_HALF_DAY - 1) { + // 切换上下午 + mIsAm = !mIsAm; + updateAmPmControl(); + } + } else {// 使用24小时制 + if (oldVal == HOURS_IN_ALL_DAY - 1 && newVal == 0) { + // 如果从23点到0点，则需要向后加一整天 + cal.setTimeInMillis(mDate.getTimeInMillis()); + cal.add(Calendar.DAY_OF_YEAR, 1); + isDateChanged = true; + } else if (oldVal == 0 && newVal == HOURS_IN_ALL_DAY - 1) { + // 如果从0点到23点，则需要向前减一整天 + cal.setTimeInMillis(mDate.getTimeInMillis()); + cal.add(Calendar.DAY_OF_YEAR, -1); + isDateChanged = true; + } + } + int newHour = mHourSpinner.getValue() % HOURS_IN_HALF_DAY + (mIsAm ? 0 : HOURS_IN_HALF_DAY); + mDate.set(Calendar.HOUR_OF_DAY, newHour); + onDateTimeChanged(); + if (isDateChanged) { + setCurrentYear(cal.get(Calendar.YEAR)); + setCurrentMonth(cal.get(Calendar.MONTH)); + setCurrentDay(cal.get(Calendar.DAY_OF_MONTH)); + } + } + }; + + // 当分钟改变时的监听器 + private NumberPicker.OnValueChangeListener mOnMinuteChangedListener = new NumberPicker.OnValueChangeListener() { + @Override + public void onValueChange(NumberPicker picker, int oldVal, int newVal) { + int minValue = mMinuteSpinner.getMinValue(); + int maxValue = mMinuteSpinner.getMaxValue(); + int offset = 0; + if (oldVal == maxValue && newVal == minValue) { + offset += 1;// 时间增加一小时 + } else if (oldVal == minValue && newVal == maxValue) { + offset -= 1;// 时间减少一小时 + } + if (offset != 0) { + mDate.add(Calendar.HOUR_OF_DAY, offset);// 根据偏移量调整时间 + mHourSpinner.setValue(getCurrentHour());// 更新当前的小时数 + updateDateControl();// 更新日期选择器 + int newHour = getCurrentHourOfDay(); + if (newHour >= HOURS_IN_HALF_DAY) {// 更新上下午选择器 + mIsAm = false; + updateAmPmControl(); + } else { + mIsAm = true; + updateAmPmControl(); + } + } + mDate.set(Calendar.MINUTE, newVal);// 更新分钟数 + onDateTimeChanged();// 回调接口方法 + } + }; + + // 当上下午改变时的监听器 + private NumberPicker.OnValueChangeListener mOnAmPmChangedListener = new NumberPicker.OnValueChangeListener() { + @Override + public void onValueChange(NumberPicker picker, int oldVal, int newVal) { + mIsAm = !mIsAm;// 切换上下午 + if (mIsAm) { + mDate.add(Calendar.HOUR_OF_DAY, -HOURS_IN_HALF_DAY); + } else { + mDate.add(Calendar.HOUR_OF_DAY, HOURS_IN_HALF_DAY); + } + updateAmPmControl();// 更新上下午选择器 + onDateTimeChanged();// 回调接口方法 + } + }; + + // 选择时间后的回调接口 + public interface OnDateTimeChangedListener { + void onDateTimeChanged(DateTimePicker view, int year, int month, + int dayOfMonth, int hourOfDay, int minute); + } + + public DateTimePicker(Context context) { + this(context, System.currentTimeMillis()); + } + + public DateTimePicker(Context context, long date) { + this(context, date, DateFormat.is24HourFormat(context)); + } + + public DateTimePicker(Context context, long date, boolean is24HourView) { + super(context); + mDate = Calendar.getInstance();// 初始化当前日期为系统当前日期 + mInitialising = true;// 开始初始化 + + // 加载布局文件 + inflate(context, R.layout.datetime_picker, this); + + // 初始化日期选择器 + mDateSpinner = (NumberPicker) findViewById(R.id.date); + mDateSpinner.setMinValue(DATE_SPINNER_MIN_VAL); + mDateSpinner.setMaxValue(DATE_SPINNER_MAX_VAL); + mDateSpinner.setOnValueChangedListener(mOnDateChangedListener); + + // 初始化小时选择器 + mHourSpinner = (NumberPicker) findViewById(R.id.hour); + mHourSpinner.setOnValueChangedListener(mOnHourChangedListener); + + // 初始化分钟选择器 + mMinuteSpinner = (NumberPicker) findViewById(R.id.minute); + mMinuteSpinner.setMinValue(MINUT_SPINNER_MIN_VAL); + mMinuteSpinner.setMaxValue(MINUT_SPINNER_MAX_VAL); + mMinuteSpinner.setOnLongPressUpdateInterval(100);// 设置快速滑动时的更新间隔 + mMinuteSpinner.setOnValueChangedListener(mOnMinuteChangedListener); + + // 初始化上下午选择器 + + String[] stringsForAmPm = new DateFormatSymbols().getAmPmStrings(); // 获取“上午”和“下午”字符串数组 +AmPmSpinner = (NumberPicker) findViewById(R.id.amPm); // 实例化一个NumberPicker，并通过ID获取布局中对应的视图 +mAmPmSpinner.setMinValue(AMPM_SPINNER_MIN_VAL); // 设置NumberPicker的最小值 +mAmPmSpinner.setMaxValue(AMPM_SPINNER_MAX_VAL); // 设置NumberPicker的最大值 +mAmPmSpinner.setDisplayedValues(stringsForAmPm); // 设置NumberPicker的展示值为“上午”和“下午” +mAmPmSpinner.setOnValueChangedListener(mOnAmPmChangedListener); // 设置当用户更改NumberPicker的值时应执行的回调侦听器 + +// update controls to initial state，更新控件的初始状态 +updateDateControl(); // 更新日期控件的状态 +updateHourControl(); // 更新小时控件的状态 +updateAmPmControl(); // 更新上午下午控件的状态 + +set24HourView(is24HourView); // 根据is24HourView变量设置控件为“24小时制”或“AM/PM模式” + +// set to current time，将控件设置为当前时间 +setCurrentDate(date); // 根据提供的时间设置当前时间 + +setEnabled(isEnabled()); // 根据isEnabled()方法返回的值设置控件是否启用 + +// set the content descriptions，设置控件的内容描述 +mInitialising = false; // 初始化完毕，将mInitialising变量设置为false +接下来是一组公共方法，定义了一系列可供外部调用的操作，例如设置当前时间、获取当前年月日等。 + +// 获取当前时间的毫秒数 +public long getCurrentDateInTimeMillis() { + return mDate.getTimeInMillis(); +} + +// 根据提供的时间设置当前时间 +public void setCurrentDate(long date) { + Calendar cal = Calendar.getInstance(); // 获取Calendar实例 + cal.setTimeInMillis(date); // 设置Calendar的时间为提供的时间 + setCurrentDate(cal.get(Calendar.YEAR), cal.get(Calendar.MONTH), cal.get(Calendar.DAY_OF_MONTH), + cal.get(Calendar.HOUR_OF_DAY), cal.get(Calendar.MINUTE)); // 根据Calendar的时间设置当前时间 +} + +// 根据提供的年月日时分设置当前时间 +public void setCurrentDate(int year, int month, + int dayOfMonth, int hourOfDay, int minute) { + setCurrentYear(year); // 设置当前年份 + setCurrentMonth(month); // 设置当前月份 + setCurrentDay(dayOfMonth); // 设置当前日 + setCurrentHour(hourOfDay); // 设置当前小时 + setCurrentMinute(minute); // 设置当前分钟 +} + +// 获取当前年份 +public int getCurrentYear() { + return mDate.get(Calendar.YEAR); +} + +// 设置当前年份 +public void setCurrentYear(int year) { + if (!mInitialising && year == getCurrentYear()) { + return; + } + mDate.set(Calendar.YEAR, year); + updateDateControl(); // 更新日期控件 + onDateTimeChanged(); // 调用回调方法告知“日期与时间”已更改 +} + +// 获取当前月份 +public int getCurrentMonth() { + return mDate.get(Calendar.MONTH); +} + +// 设置当前月份 +public void setCurrentMonth(int month) { + if (!mInitialising && month == getCurrentMonth()) { + return; + } + mDate.set(Calendar.MONTH, month); + updateDateControl(); // 更新日期控件 + onDateTimeChanged(); // 调用回调方法告知“日期与时间”已更改 +} + +// 获取当前日 +public int getCurrentDay() { + return mDate.get(Calendar.DAY_OF_MONTH); +} + +// 设置当前日 +public void setCurrentDay(int dayOfMonth) { + if (!mInitialising && dayOfMonth == getCurrentDay()) { + return; + } + mDate.set(Calendar.DAY_OF_MONTH, dayOfMonth); + updateDateControl(); // 更新日期控件 + onDateTimeChanged(); // 调用回调方法告知“日期与时间”已更改 +} + +// 获取当前小时（24小时制） +public int getCurrentHourOfDay() { + return mDate.get(Calendar.HOUR_OF_DAY); +} + +// 获取当前小时（12小时制） +private int getCurrentHour() { + if (mIs24HourView){ + return getCurrentHourOfDay(); + } else { + int hour = getCurrentHourOfDay(); + if (hour > HOURS_IN_HALF_DAY) { + return hour - HOURS_IN_HALF_DAY; + } else { + return hour == 0 ? HOURS_IN_HALF_DAY : hour; + } + } +} + +// 设置当前小时 +public void setCurrentHour(int hourOfDay) { + if (!mInitialising && hourOfDay == getCurrentHourOfDay()) { + return; + } + mDate.set(Calendar.HOUR_OF_DAY, hourOfDay); + if (!mIs24HourView) { + if (hourOfDay >= HOURS_IN_HALF_DAY) { + mIsAm = false; + if (hourOfDay > HOURS_IN_HALF_DAY) { + hourOfDay -= HOURS_IN_HALF_DAY; + } + } else { + mIsAm = true; + if (hourOfDay == 0) { + hourOfDay = HOURS_IN_HALF_DAY; + } + } + updateAmPmControl(); // 更新上午下午控件 + } + mHourSpinner.setValue(hourOfDay); // 更新小时控件 + onDateTimeChanged(); // 调用回调方法告知“日期与时间”已更改 +} + +// 获取当前分钟 +public int getCurrentMinute() { + return mDate.get(Calendar.MINUTE); +} + +// 设置当前分钟 +public void setCurrentMinute(int minute) { + if (!mInitialising && minute == getCurrentMinute()) { + return; + } + mMinuteSpinner.setValue(minute); // 更新分钟控件 + mDate.set(Calendar.MINUTE, minute); // 更新Calendar的分钟字段 + onDateTimeChanged(); // 调用回调方法告知“日期与时间”已更改 +} + +// 判断是否为24小时制 +public boolean is24HourView () { + return mIs24HourView; +} + +// 设置是否为24小时制 +public void set24HourView(boolean is24HourView) { + if (mIs24HourView == is24HourView) { + return; + } + mIs24HourView = is24HourView; + mAmPmSpinner.setVisibility(is24HourView ? View.GONE : View.VISIBLE); // 根据是否为24小时制设置上午下午控件的可见性 + int hour = getCurrentHourOfDay(); + updateHourControl(); // 更新小时控件 + setCurrentHour(hour); // 更新当前时间的小时字段 + updateAmPmControl(); // 更新上午下午控件 +} + +// 设置回调方法，当“设置”按钮被按下时调用 +public void setOnDateTimeChangedListener(OnDateTimeChangedListener callback) { + mOnDateTimeChangedListener = callback; +} + +// 回调方法，告知“日期与时间”已更改 +private void onDateTimeChanged() { + if (mOnDateTimeChangedListener != null) { + mOnDateTimeChangedListener.onDateTimeChanged(this, getCurrentYear(), + getCurrentMonth(), getCurrentDay(), getCurrentHourOfDay(), getCurrentMinute()); + } +} \ No newline at end of file diff --git a/other/07_210340164温雍敬_代码标注/ui/DateTimePickerDialog.java b/other/07_210340164温雍敬_代码标注/ui/DateTimePickerDialog.java new file mode 100644 index 0000000..7b0ba90 --- /dev/null +++ b/other/07_210340164温雍敬_代码标注/ui/DateTimePickerDialog.java @@ -0,0 +1,93 @@ +/* + * 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 java.util.Calendar; + +import net.micode.notes.R; +import net.micode.notes.ui.DateTimePicker; +import net.micode.notes.ui.DateTimePicker.OnDateTimeChangedListener; + +import android.app.AlertDialog; +import android.content.Context; +import android.content.DialogInterface; +import android.content.DialogInterface.OnClickListener; +import android.text.format.DateFormat; +import android.text.format.DateUtils; + +public class DateTimePickerDialog extends AlertDialog implements OnClickListener { +/*该类继承于AlertDialog类，实现了OnClickListener接口，主要功能是对设置提醒事件这个过程中的对话框界面进行设置，该类会弹出一个对话框，可以实现若干个按钮，对时间进行修改。该类实现了相关的方法有，对提醒时间的获取，以及时间的表现格式，set24HourView方法， + 并且实现了对对话中标题修改的方法，实现了对点击事件的侦听，主要的功能是对提醒事件相关属性进行修改的一个侦听。*/ + private Calendar mDate = Calendar.getInstance();//声明一个calendar类的对象，用于操作日期 + private boolean mIs24HourView;//设置判断当前设置是否为24小时模式 + private OnDateTimeSetListener mOnDateTimeSetListener;//声明一个日期设置监听控件 + private DateTimePicker mDateTimePicker;//声明时间选择器，可以让用户设置时间 + + public interface OnDateTimeSetListener {//设置接口时间监听器 + void OnDateTimeSet(AlertDialog dialog, long date); + } + + public DateTimePickerDialog(Context context, long date) { //对时间选择器进行实例化 + super(context); //超类是指向离自己最近的一个父类，创建一个新的时间选择器 + mDateTimePicker = new DateTimePicker(context); + setView(mDateTimePicker); //设置视图为时间选择器接口 + mDateTimePicker.setOnDateTimeChangedListener(new OnDateTimeChangedListener() { + //设置日期变化监听器 + public void onDateTimeChanged(DateTimePicker view, int year, int month, + int dayOfMonth, int hourOfDay, int minute) {//将视图中各选项设置为系统时间 + mDate.set(Calendar.YEAR, year); + mDate.set(Calendar.MONTH, month); + mDate.set(Calendar.DAY_OF_MONTH, dayOfMonth); + mDate.set(Calendar.HOUR_OF_DAY, hourOfDay); + mDate.set(Calendar.MINUTE, minute); //设置年、月、日、分钟 + updateTitle(mDate.getTimeInMillis());//更新时间 + } + }); + mDate.setTimeInMillis(date);//设置毫秒级时间显示 + mDate.set(Calendar.SECOND, 0);//设置秒数归零 + mDateTimePicker.setCurrentDate(mDate.getTimeInMillis());//设置当前时间 + setButton(context.getString(R.string.datetime_dialog_ok), this);//设置按钮‘set’ + setButton2(context.getString(R.string.datetime_dialog_cancel), (OnClickListener)null);//设置按钮‘cancel’ + set24HourView(DateFormat.is24HourFormat(this.getContext()));//设置24小时视图 + updateTitle(mDate.getTimeInMillis());//更新标题时间 + } + + public void set24HourView(boolean is24HourView) {//将时间日期滚动选择控件实例化 + mIs24HourView = is24HourView; + } + + public void setOnDateTimeSetListener(OnDateTimeSetListener callBack) {//设置一个时期时间设置的监听器 + mOnDateTimeSetListener = callBack; + } + + private void updateTitle(long date) {//将标题同步更新 + int flag = + DateUtils.FORMAT_SHOW_YEAR |//按照date形式更新年月日时间 + DateUtils.FORMAT_SHOW_DATE | + DateUtils.FORMAT_SHOW_TIME; + flag |= mIs24HourView ? DateUtils.FORMAT_24HOUR : DateUtils.FORMAT_24HOUR;//判断是否为24小时 + setTitle(DateUtils.formatDateTime(this.getContext(), date, flag));//设置标题 + } + + public void onClick(DialogInterface arg0, int arg1) {//第一个参数arg0是接收到点击事件的对话框 + //第二个参数arg1是该对话框上的按钮 + if (mOnDateTimeSetListener != null) {//若时间更新监视器不为空 + mOnDateTimeSetListener.OnDateTimeSet(this, mDate.getTimeInMillis());//设定日期时间 + } + } + +} \ No newline at end of file diff --git a/other/07_210340164温雍敬_代码标注/ui/DropdownMenu.java b/other/07_210340164温雍敬_代码标注/ui/DropdownMenu.java new file mode 100644 index 0000000..9f18f5f --- /dev/null +++ b/other/07_210340164温雍敬_代码标注/ui/DropdownMenu.java @@ -0,0 +1,62 @@ +/* + * 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; +import android.view.Menu; +import android.view.MenuItem; +import android.view.View; +import android.view.View.OnClickListener; +import android.widget.Button; +import android.widget.PopupMenu; +import android.widget.PopupMenu.OnMenuItemClickListener; + +import net.micode.notes.R; + +public class DropdownMenu {//声明一个下拉菜单类 + private Button mButton;/*按钮控件、下拉菜单按键、菜单*/ + private PopupMenu mPopupMenu; + private Menu mMenu; + + public DropdownMenu(Context context, Button button, int menuId) {//首先是公有类DropdownMenu的私有数据成员申明,其中包括了对象按钮mButton, + // 菜单对象mMenu和弹出菜单控件对象mPopupMenu + mButton = button; //设置下拉菜单的背景 + mButton.setBackgroundResource(R.drawable.dropdown_icon); // + mPopupMenu = new PopupMenu(context, mButton);//初始化下拉菜单由mButton触发 + mMenu = mPopupMenu.getMenu();//将menuId指向的菜单项目添加到mMenu中 + mPopupMenu.getMenuInflater().inflate(menuId, mMenu); + mButton.setOnClickListener(new OnClickListener() { + public void onClick(View v) { + mPopupMenu.show(); + } + }); + } + + public void setOnDropdownMenuItemClickListener(OnMenuItemClickListener listener) {//方法：对非空的菜单的具体条目设置监听。 + if (mPopupMenu != null) { + mPopupMenu.setOnMenuItemClickListener(listener); + } + } + + public MenuItem findItem(int id) {//对于菜单选项的初始化，根据索引搜索菜单需要的选项 + return mMenu.findItem(id); + } + + public void setTitle(CharSequence title) {//根据索引搜索菜单需要的选项 + mButton.setText(title); + } +} diff --git a/other/07_210340164温雍敬_代码标注/ui/NoteEditActivity.java b/other/07_210340164温雍敬_代码标注/ui/NoteEditActivity.java new file mode 100644 index 0000000..49cef3f --- /dev/null +++ b/other/07_210340164温雍敬_代码标注/ui/NoteEditActivity.java @@ -0,0 +1,914 @@ +/* + * 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.app.Activity; +import android.app.AlarmManager; +import android.app.AlertDialog; +import android.app.PendingIntent; +import android.app.SearchManager; +import android.appwidget.AppWidgetManager; +import android.content.ContentUris; +import android.content.Context; +import android.content.DialogInterface; +import android.content.Intent; +import android.content.SharedPreferences; +import android.graphics.Paint; +import android.os.Bundle; +import android.preference.PreferenceManager; +import android.text.Spannable; +import android.text.SpannableString; +import android.text.TextUtils; +import android.text.format.DateUtils; +import android.text.style.BackgroundColorSpan; +import android.util.Log; +import android.view.LayoutInflater; +import android.view.Menu; +import android.view.MenuItem; +import android.view.MotionEvent; +import android.view.View; +import android.view.View.OnClickListener; +import android.view.WindowManager; +import android.widget.CheckBox; +import android.widget.CompoundButton; +import android.widget.CompoundButton.OnCheckedChangeListener; +import android.widget.EditText; +import android.widget.ImageView; +import android.widget.LinearLayout; +import android.widget.TextView; +import android.widget.Toast; + +import net.micode.notes.R; +import net.micode.notes.data.Notes; +import net.micode.notes.data.Notes.TextNote; +import net.micode.notes.model.WorkingNote; +import net.micode.notes.model.WorkingNote.NoteSettingChangedListener; +import net.micode.notes.tool.DataUtils; +import net.micode.notes.tool.ResourceParser; +import net.micode.notes.tool.ResourceParser.TextAppearanceResources; +import net.micode.notes.ui.DateTimePickerDialog.OnDateTimeSetListener; +import net.micode.notes.ui.NoteEditText.OnTextViewChangeListener; +import net.micode.notes.widget.NoteWidgetProvider_2x; +import net.micode.notes.widget.NoteWidgetProvider_4x; + +import java.util.HashMap; +import java.util.HashSet; +import java.util.Map; +import java.util.regex.Matcher; +import java.util.regex.Pattern; + + +public class NoteEditActivity extends Activity implements OnClickListener, + NoteSettingChangedListener, OnTextViewChangeListener { + private class HeadViewHolder {//创建一个私有类HeadViewHolder用于对界面进行设置，包括文本内容，图片内容等 + public TextView tvModified; + + public ImageView ivAlertIcon; + + public TextView tvAlertDate; + + public ImageView ibSetBgColor; + }//该类实现了对当前便签界面进行编辑功能，继承了父类Activity并实现了接口，封装有方法39个 + //声明Hashmap类，将按钮和对应的资源解析器中的各个属性关联。 + private static final Map sBgSelectorBtnsMap = new HashMap(); + static {//对HashMap进行初始化，主要是颜色的对应 + sBgSelectorBtnsMap.put(R.id.iv_bg_yellow, ResourceParser.YELLOW); + sBgSelectorBtnsMap.put(R.id.iv_bg_red, ResourceParser.RED); + sBgSelectorBtnsMap.put(R.id.iv_bg_blue, ResourceParser.BLUE); + sBgSelectorBtnsMap.put(R.id.iv_bg_green, ResourceParser.GREEN); + sBgSelectorBtnsMap.put(R.id.iv_bg_white, ResourceParser.WHITE); + } + + private static final Map sBgSelectorSelectionMap = new HashMap(); + //代码块：运用Hashmap,将资源解析器中的对应颜色与已选择的颜色按钮关联起来。 + static { + sBgSelectorSelectionMap.put(ResourceParser.YELLOW, R.id.iv_bg_yellow_select); + sBgSelectorSelectionMap.put(ResourceParser.RED, R.id.iv_bg_red_select); + sBgSelectorSelectionMap.put(ResourceParser.BLUE, R.id.iv_bg_blue_select); + sBgSelectorSelectionMap.put(ResourceParser.GREEN, R.id.iv_bg_green_select); + sBgSelectorSelectionMap.put(ResourceParser.WHITE, R.id.iv_bg_white_select); + } + + private static final Map sFontSizeBtnsMap = new HashMap(); + //将字体的大小与相对应的选择相连接 + static {// 提供各种大小字体的选择 + sFontSizeBtnsMap.put(R.id.ll_font_large, ResourceParser.TEXT_LARGE); + sFontSizeBtnsMap.put(R.id.ll_font_small, ResourceParser.TEXT_SMALL); + sFontSizeBtnsMap.put(R.id.ll_font_normal, ResourceParser.TEXT_MEDIUM); + sFontSizeBtnsMap.put(R.id.ll_font_super, ResourceParser.TEXT_SUPER); + } + + private static final Map sFontSelectorSelectionMap = new HashMap(); + //常量，实现资源解析器中字号ID与字体大小按钮（已选择）对应 + static {//选择字体大小的界面 + sFontSelectorSelectionMap.put(ResourceParser.TEXT_LARGE, R.id.iv_large_select); + sFontSelectorSelectionMap.put(ResourceParser.TEXT_SMALL, R.id.iv_small_select); + sFontSelectorSelectionMap.put(ResourceParser.TEXT_MEDIUM, R.id.iv_medium_select); + sFontSelectorSelectionMap.put(ResourceParser.TEXT_SUPER, R.id.iv_super_select); + } + + private static final String TAG = "NoteEditActivity";//为本模块进行标签设置“NoteEditActivity" + + private HeadViewHolder mNoteHeaderHolder;//.头部布局 + + private View mHeadViewPanel;//操作表头 + + private View mNoteBgColorSelector;//背景颜色 + + private View mFontSizeSelector;//私有化一个界面操作mFontSizeSelector，对标签字体的操作 + + private EditText mNoteEditor;//文本操作 + + private View mNoteEditorPanel;//.文本编辑控制板 + + private WorkingNote mWorkingNote;//对模板WorkingNote的初始化 + + private SharedPreferences mSharedPrefs;//私有化SharedPreferences的数据存储方式 + private int mFontSizeId;//.操作字体大小 + + private static final String PREFERENCE_FONT_SIZE = "pref_font_size";//定义常量 字体大小设置 + + private static final int SHORTCUT_ICON_TITLE_MAX_LEN = 10;//设置标题最大长度为10 + + public static final String TAG_CHECKED = String.valueOf('\u221A');//定义字符串常量 已标记 + public static final String TAG_UNCHECKED = String.valueOf('\u25A1');//定义字符串常量 未标记 + + private LinearLayout mEditTextList;//线性布局 + + private String mUserQuery;//用户请求 + private Pattern mPattern;//正则表达式模式 + + @Override//重写Activity类的onCreate方法 + //@param savedInstanceState 已保存的便签实例状态 + protected void onCreate(Bundle savedInstanceState) {//创建该activity，然后对content进行设置。通过对State的相关信息判断是否返回 + super.onCreate(savedInstanceState); + this.setContentView(R.layout.note_edit); + + if (savedInstanceState == null && !initActivityState(getIntent())) { + finish(); + return; + } + initResources(); + } + + /** + * Current activity may be killed when the memory is low. Once it is killed, for another time + * user load this activity, we should restore the former state + */ + @Override //覆盖父类的onRestoreInstanceState函数 + protected void onRestoreInstanceState(Bundle savedInstanceState) { //在恢复Activity状态时调用，传入上一个活动销毁时保存的Bundle对象 + super.onRestoreInstanceState(savedInstanceState); //调用父类的onRestoreInstanceState方法来恢复视图层次结构中每个View的状态 + if (savedInstanceState != null && savedInstanceState.containsKey(Intent.EXTRA_UID)) { //如果保存的Bundle对象不为空且包含EXTRA_UID键 + Intent intent = new Intent(Intent.ACTION_VIEW); //创建一个Intent对象，指定操作为ACTION_VIEW + intent.putExtra(Intent.EXTRA_UID, savedInstanceState.getLong(Intent.EXTRA_UID)); //向Intent中添加EXTRA_UID键和值 + if (!initActivityState(intent)) { //调用initActivityState方法初始化Activity状态并判断是否成功 + finish(); //调用finish方法销毁当前Activity + return; //结束方法的执行 + } + Log.d(TAG, "Restoring from killed activity"); //调用Log.d方法向LogCat输出一条调试信息 + } +} + + + private boolean initActivityState(Intent intent) {//初始化Activity的状态 + /** + * If the user specified the {@link Intent#ACTION_VIEW} but not provided with id, + * then jump to the NotesListActivity + */ + mWorkingNote = null; + if (TextUtils.equals(Intent.ACTION_VIEW, intent.getAction())) {//判断初始化该Activity的Intent所包含的action是ACTION_VIEW还是ACTION_INSERT_OR_EDIT，然后进行不同的操作 + long noteId = intent.getLongExtra(Intent.EXTRA_UID, 0); + mUserQuery = ""; + + /** + * Starting from the searched result + */if (intent.hasExtra(SearchManager.EXTRA_DATA_KEY)) { //判断Intent是否包含EXTRA_DATA_KEY键 + noteId = Long.parseLong(intent.getStringExtra(SearchManager.EXTRA_DATA_KEY)); //获取EXTRA_DATA_KEY键所对应的Long类型值 + mUserQuery = intent.getStringExtra(SearchManager.USER_QUERY); //获取USER_QUERY键所对应的字符串类型值 + } + + if (!DataUtils.visibleInNoteDatabase(getContentResolver(), noteId, Notes.TYPE_NOTE)) { //判断指定noteId和Notes.TYPE_NOTE类型的笔记是否存在于NoteDatabase中 + Intent jump = new Intent(this, NotesListActivity.class); //创建一个Intent对象，跳转到NotesListActivity活动 + startActivity(jump); //启动Intent指定的活动 + showToast(R.string.error_note_not_exist); //显示一个Toast，提示“笔记不存在” + finish(); //结束当前Activity + return false; //直接返回false + } else { //如果NoteDatabase中存在指定的笔记，则加载该笔记 + mWorkingNote = WorkingNote.load(this, noteId); //通过WorkingNote类的load方法加载指定的笔记 + if (mWorkingNote == null) { //如果加载失败，则记录日志并结束Activity + Log.e(TAG, "load note failed with note id" + noteId); + finish(); + return false; + } + } + getWindow().setSoftInputMode( //设置软键盘的状态 + WindowManager.LayoutParams.SOFT_INPUT_STATE_HIDDEN //将软键盘隐藏 + | WindowManager.LayoutParams.SOFT_INPUT_ADJUST_RESIZE); //同时窗口大小会自动调整以适应新的软键盘状态 + } else if(TextUtils.equals(Intent.ACTION_INSERT_OR_EDIT, intent.getAction())) {//判断Intent的Action是否为ACTION_INSERT_OR_EDIT + // New note + long folderId = intent.getLongExtra(Notes.INTENT_EXTRA_FOLDER_ID, 0); //获取Intent的附加数据中名为INTENT_EXTRA_FOLDER_ID的Long类型值，如果不存在则返回默认值0 + int widgetId = intent.getIntExtra(Notes.INTENT_EXTRA_WIDGET_ID, + AppWidgetManager.INVALID_APPWIDGET_ID); //获取Intent的附加数据中名为INTENT_EXTRA_WIDGET_ID的整型值，如果不存在则返回无效的AppWidgetManager ID + int widgetType = intent.getIntExtra(Notes.INTENT_EXTRA_WIDGET_TYPE, + Notes.TYPE_WIDGET_INVALIDE); //获取Intent的附加数据中名为INTENT_EXTRA_WIDGET_TYPE的整型值，如果不存在则返回无效的widget类型 + int bgResId = intent.getIntExtra(Notes.INTENT_EXTRA_BACKGROUND_ID, + ResourceParser.getDefaultBgId(this)); //获取Intent的附加数据中名为INTENT_EXTRA_BACKGROUND_ID的整型值，如果不存在则返回当前主题的默认背景色ID + + // Parse call-record note + String phoneNumber = intent.getStringExtra(Intent.EXTRA_PHONE_NUMBER); //获取Intent的附加数据中名为EXTRA_PHONE_NUMBER的字符串类型值 + long callDate = intent.getLongExtra(Notes.INTENT_EXTRA_CALL_DATE, 0); //获取Intent的附加数据中名为INTENT_EXTRA_CALL_DATE的long类型值，如果该附加数据不存在，则返回默认值0 + if (callDate != 0 && phoneNumber != null) { //如果存在通话记录 + if (TextUtils.isEmpty(phoneNumber)) { //如果通话记录号码为空 + Log.w(TAG, "The call record number is null"); + } + long noteId = 0; //初始化noteId为0 + if ((noteId = DataUtils.getNoteIdByPhoneNumberAndCallDate(getContentResolver(), + phoneNumber, callDate)) > 0) { //通过电话号码和通话时间获取笔记的noteId + mWorkingNote = WorkingNote.load(this, noteId); //加载对应的笔记 + if (mWorkingNote == null) { //如果加载失败，则记录日志并结束Activity + Log.e(TAG, "load call note failed with note id" + noteId); + finish(); + return false; + } + } else { //如果不存在对应的笔记，则创建新笔记 + mWorkingNote = WorkingNote.createEmptyNote(this, folderId, widgetId, + widgetType, bgResId); //调用WorkingNote类的静态createEmptyNote方法创建新的笔记 + mWorkingNote.convertToCallNote(phoneNumber, callDate); //将笔记转换为通话记录类型 + } + } else { //如果不存在通话记录，则创建新笔记 + mWorkingNote = WorkingNote.createEmptyNote(this, folderId, widgetId, widgetType, + bgResId); //调用WorkingNote类的静态createEmptyNote方法创建新的笔记 + } + + getWindow().setSoftInputMode( //设置软键盘状态 + WindowManager.LayoutParams.SOFT_INPUT_ADJUST_RESIZE //窗口大小会自动调整以适应新的软键盘状态 + | WindowManager.LayoutParams.SOFT_INPUT_STATE_VISIBLE); //同时显示软键盘 + } else { //如果Intent的Action既不是ACTION_SEARCH，也不是ACTION_INSERT_OR_EDIT，则记录日志并结束Activity + Log.e(TAG, "Intent not specified action, should not support"); + finish(); + return false; + } + mWorkingNote.setOnSettingStatusChangedListener(this); //为WorkingNote设置状态变化的监听器 + return true; //返回true，表示初始化成功 + + @Override + protected void onResume() {//进行重新返回的函数 + super.onResume(); + initNoteScreen(); + } + + private void initNoteScreen() {//对界面进行初始化的操作 + mNoteEditor.setTextAppearance(this, TextAppearanceResources + .getTexAppearanceResource(mFontSizeId)); + if (mWorkingNote.getCheckListMode() == TextNote.MODE_CHECK_LIST) {//判断是否为清单列表界面，是则切换到清单列表的处理过程，否则继续执行 + switchToListMode(mWorkingNote.getContent()); + } else { + mNoteEditor.setText(getHighlightQueryResult(mWorkingNote.getContent(), mUserQuery)); + mNoteEditor.setSelection(mNoteEditor.getText().length()); + } + for (Integer id : sBgSelectorSelectionMap.keySet()) {//循环遍历所有sBgSelectorSelectionMap中id对应的资源文件，使其不可见且不占用空间 + findViewById(sBgSelectorSelectionMap.get(id)).setVisibility(View.GONE); + } + mHeadViewPanel.setBackgroundResource(mWorkingNote.getTitleBgResId()); + mNoteEditorPanel.setBackgroundResource(mWorkingNote.getBgColorResId()); + + mNoteHeaderHolder.tvModified.setText(DateUtils.formatDateTime(this, + mWorkingNote.getModifiedDate(), DateUtils.FORMAT_SHOW_DATE + | DateUtils.FORMAT_NUMERIC_DATE | DateUtils.FORMAT_SHOW_TIME + | DateUtils.FORMAT_SHOW_YEAR)); + + /** + * TODO: Add the menu for setting alert. Currently disable it because the DateTimePicker + * is not ready + */ + showAlertHeader(); + } + + private void showAlertHeader() { //定义一个名为showAlertHeader的无返回值函数 + if (mWorkingNote.hasClockAlert()) { //判断当前工作笔记是否包含闹钟提醒 + long time = System.currentTimeMillis(); //获取当前时间 + if (time > mWorkingNote.getAlertDate()) { //如果当前时间晚于闹钟提醒时间 + mNoteHeaderHolder.tvAlertDate.setText(R.string.note_alert_expired); //设置文本框显示“提醒已过期” + } else { //否则，设置文本框显示距离闹钟提醒时间还有多少时间 + mNoteHeaderHolder.tvAlertDate.setText(DateUtils.getRelativeTimeSpanString( + mWorkingNote.getAlertDate(), time, DateUtils.MINUTE_IN_MILLIS)); + } + mNoteHeaderHolder.tvAlertDate.setVisibility(View.VISIBLE); //设置文本框可见 + mNoteHeaderHolder.ivAlertIcon.setVisibility(View.VISIBLE); //设置图标可见 + } else { //如果当前工作笔记不包含闹钟提醒 + mNoteHeaderHolder.tvAlertDate.setVisibility(View.GONE); //设置文本框不可见 + mNoteHeaderHolder.ivAlertIcon.setVisibility(View.GONE); //设置图标不可见 + }; + } + + + @Override + protected void onNewIntent(Intent intent) {//新建一个传值对象 + super.onNewIntent(intent); + initActivityState(intent); + } + + @Override + protected void onSaveInstanceState(Bundle outState) {//用于保存数据 + super.onSaveInstanceState(outState); + /** + * For new note without note id, we should firstly save it to + * generate a id. If the editing note is not worth saving, there + * is no id which is equivalent to create new note + */ + if (!mWorkingNote.existInDatabase()) {//如果该workingnote实例无法在数据库中找到，即为新建的便签，则先将其存储 + saveNote(); + } + outState.putLong(Intent.EXTRA_UID, mWorkingNote.getNoteId()); + Log.d(TAG, "Save working note id: " + mWorkingNote.getNoteId() + " onSaveInstanceState"); + } + + @Override + public boolean dispatchTouchEvent(MotionEvent ev) {//通过触摸事件来分发事件 + if (mNoteBgColorSelector.getVisibility() == View.VISIBLE//如果笔记背景颜色选择器可见 + && !inRangeOfView(mNoteBgColorSelector, ev)) {//且当前触摸事件不在其范围内，则隐藏选择器并返回true + mNoteBgColorSelector.setVisibility(View.GONE); + return true; + } + + if (mFontSizeSelector.getVisibility() == View.VISIBLE//如果字体大小选择器可见 + && !inRangeOfView(mFontSizeSelector, ev)) {//且当前触摸事件不在其范围内，则隐藏选择器并返回true + mFontSizeSelector.setVisibility(View.GONE); + return true; + } + return super.dispatchTouchEvent(ev);//否则，调用父类的dispatchTouchEvent方法处理事件 + } + + private boolean inRangeOfView(View view, MotionEvent ev) {//判断给定的触摸事件是否在给定视图的范围内 + int []location = new int[2];//获取视图在屏幕中的坐标 + view.getLocationOnScreen(location); + int x = location[0];//获取视图左侧在屏幕中的横向坐标 + int y = location[1];//获取视图顶部在屏幕中的纵向坐标 + if (ev.getX() < x + || ev.getX() > (x + view.getWidth()) + || ev.getY() < y + || ev.getY() > (y + view.getHeight())) {//如果触摸事件坐标不在该视图的范围内，则返回false + return false; + } + return true;//否则，返回true + } + + private void initResources() {//对标签各项属性内容的初始化 + mHeadViewPanel = findViewById(R.id.note_title);//获取笔记标题栏的布局对象 + mNoteHeaderHolder = new HeadViewHolder();//创建一个新的笔记头部视图持有类 + mNoteHeaderHolder.tvModified = (TextView) findViewById(R.id.tv_modified_date);//获取最近编辑时间的文本框对象 + mNoteHeaderHolder.ivAlertIcon = (ImageView) findViewById(R.id.iv_alert_icon);//获取闹钟提醒图标对象 + mNoteHeaderHolder.tvAlertDate = (TextView) findViewById(R.id.tv_alert_date);//获取闹钟提醒时间文本框对象 + mNoteHeaderHolder.ibSetBgColor = (ImageView) findViewById(R.id.btn_set_bg_color);//获取设置背景颜色按钮对象并设置监听器 + mNoteHeaderHolder.ibSetBgColor.setOnClickListener(this); + mNoteEditor = (EditText) findViewById(R.id.note_edit_view);//获取笔记编辑器对象 + mNoteEditorPanel = findViewById(R.id.sv_note_edit);//获取笔记编辑器的滚动视图对象 + mNoteBgColorSelector = findViewById(R.id.note_bg_color_selector);//获取背景颜色选择器对象 + for (int id : sBgSelectorBtnsMap.keySet()) {//遍历背景颜色选择器中的所有颜色选择按钮，并为每个按钮设置点击监听器 + ImageView iv = (ImageView) findViewById(id); + iv.setOnClickListener(this); + } + + mFontSizeSelector = findViewById(R.id.font_size_selector);//获取字体大小选择器对象 + for (int id : sFontSizeBtnsMap.keySet()) {//遍历字体大小选择器中的所有字体大小选择按钮，并为每个按钮设置点击监听器 + View view = findViewById(id); + view.setOnClickListener(this); + }; + mSharedPrefs = PreferenceManager.getDefaultSharedPreferences(this);//获取默认的共享偏好设置 + mFontSizeId = mSharedPrefs.getInt(PREFERENCE_FONT_SIZE, ResourceParser.BG_DEFAULT_FONT_SIZE);//从偏好设置中获取字体大小的ID，默认值为1 + /** + * HACKME: Fix bug of store the resource id in shared preference. + * The id may larger than the length of resources, in this case, + * return the {@link ResourceParser#BG_DEFAULT_FONT_SIZE} + */ + if(mFontSizeId >= TextAppearanceResources.getResourcesSize()) {//如果获取到的字体大小ID大于资源文件应有长度，则将其设置为默认长度，缺省值为1. + mFontSizeId = ResourceParser.BG_DEFAULT_FONT_SIZE; + } + mEditTextList = (LinearLayout) findViewById(R.id.note_edit_list);//获取笔记编辑列表对象 + } + + @Override + protected void onPause() {//onPause()在activity退出前想保存用户重要数据的，必须在onPause中处理，调用父类的界面暂停操作，并输出对应信息。 + super.onPause(); + if(saveNote()) {//保存便签 + Log.d(TAG, "Note data was saved with length:" + mWorkingNote.getContent().length()); + } + clearSettingState(); + } + + private void updateWidget() {//更新窗口与桌面小窗口同步 + Intent intent = new Intent(AppWidgetManager.ACTION_APPWIDGET_UPDATE);//新建一个包含改变widget动作的intent实例 + if (mWorkingNote.getWidgetType() == Notes.TYPE_WIDGET_2X) {//根据workingnote的widget类型大小，设置intent中映射的类 + intent.setClass(this, NoteWidgetProvider_2x.class); + } else if (mWorkingNote.getWidgetType() == Notes.TYPE_WIDGET_4X) {//如果是4倍大小 + intent.setClass(this, NoteWidgetProvider_4x.class); + } else { + Log.e(TAG, "Unspported widget type");//Log输出error信息，不支持的widget类型 + return; + } + + intent.putExtra(AppWidgetManager.EXTRA_APPWIDGET_IDS, new int[] { + mWorkingNote.getWidgetId() + }); + + sendBroadcast(intent); + setResult(RESULT_OK, intent); + } + + public void onClick(View v) { + int id = v.getId(); //获取被点击视图的ID + + //如果点击的是“设置背景颜色”按钮，则显示背景颜色选择器，并显示当前活动笔记的背景颜色选项。 + if (id == R.id.btn_set_bg_color) { + mNoteBgColorSelector.setVisibility(View.VISIBLE); //显示背景颜色选择器 + //根据当前活动笔记的背景颜色ID显示相应的选项 + findViewById(sBgSelectorSelectionMap.get(mWorkingNote.getBgColorId())).setVisibility(View.VISIBLE); + } + + //如果点击的是背景颜色选择器中的背景颜色选项按钮，则执行下面的函数： + else if (sBgSelectorBtnsMap.containsKey(id)) { + //隐藏之前选中的颜色选项 + findViewById(sBgSelectorSelectionMap.get(mWorkingNote.getBgColorId())).setVisibility(View.GONE); + //将活动笔记的背景颜色ID设置为该按钮所代表的ID + mWorkingNote.setBgColorId(sBgSelectorBtnsMap.get(id)); + //隐藏背景颜色选择器 + mNoteBgColorSelector.setVisibility(View.GONE); + } + + //如果点击的是字体大小选择器中的文字大小选项按钮，则执行下面的函数： + else if (sFontSizeBtnsMap.containsKey(id)) { + //隐藏之前选中的大小选项 + findViewById(sFontSelectorSelectionMap.get(mFontSizeId)).setVisibility(View.GONE); + //将当前选择的字体大小ID保存到共享偏好设置中 + mFontSizeId = sFontSizeBtnsMap.get(id); + mSharedPrefs.edit().putInt(PREFERENCE_FONT_SIZE, mFontSizeId).commit(); + //显示当前选择的字体大小选项 + findViewById(sFontSelectorSelectionMap.get(mFontSizeId)).setVisibility(View.VISIBLE); + + //如果当前活动笔记是清单模式，则将文本转换为清单模式并显示列表项 + if (mWorkingNote.getCheckListMode() == TextNote.MODE_CHECK_LIST) { + getWorkingText(); + switchToListMode(mWorkingNote.getContent()); + } + + //否则仅改变编辑框的文本样式。 + else { + mNoteEditor.setTextAppearance(this, + TextAppearanceResources.getTexAppearanceResource(mFontSizeId)); + } + + //隐藏字体大小选择器 + mFontSizeSelector.setVisibility(View.GONE); + } +} + + + @Override + public void onBackPressed() {//监听按下返回键的操作。 + if(clearSettingState()) { + return; + } + + saveNote(); + super.onBackPressed(); + } + + private boolean clearSettingState() {//清除设置状态 + if (mNoteBgColorSelector.getVisibility() == View.VISIBLE) {//如果背景色选择器可见，设置为不可见 + mNoteBgColorSelector.setVisibility(View.GONE); + return true; + } else if (mFontSizeSelector.getVisibility() == View.VISIBLE) {//如果字体选择菜单可见，设置为不可见 + mFontSizeSelector.setVisibility(View.GONE); + return true; + } + return false; + } + + public void onBackgroundColorChanged() {//背景颜色改变 + findViewById(sBgSelectorSelectionMap.get(mWorkingNote.getBgColorId())).setVisibility( + View.VISIBLE); + mNoteEditorPanel.setBackgroundResource(mWorkingNote.getBgColorResId()); + mHeadViewPanel.setBackgroundResource(mWorkingNote.getTitleBgResId()); + } + + @Override + public boolean onPrepareOptionsMenu(Menu menu) {//准备菜单内容 + if (isFinishing()) {//如果窗口正在关闭，则不做处理 + return true; + } + clearSettingState();//清除设置状态 + menu.clear();//清除菜单项 + if (mWorkingNote.getFolderId() == Notes.ID_CALL_RECORD_FOLDER) {//如果便签所在的文件夹为便签的通话记录文件夹，执行下面函数 + getMenuInflater().inflate(R.menu.call_note_edit, menu); + } else { + getMenuInflater().inflate(R.menu.note_edit, menu); + } + if (mWorkingNote.getCheckListMode() == TextNote.MODE_CHECK_LIST) {//如果workingNote模式为核对列表模式，则执行下面函数 + menu.findItem(R.id.menu_list_mode).setTitle(R.string.menu_normal_mode); + } else { + menu.findItem(R.id.menu_list_mode).setTitle(R.string.menu_list_mode); + } + if (mWorkingNote.hasClockAlert()) {//如果workingNote对象中有时钟提醒事项，则执行下面函数。 + menu.findItem(R.id.menu_alert).setVisible(false); + } else { + menu.findItem(R.id.menu_delete_remind).setVisible(false); + } + return true; + } + + @Override + public boolean onOptionsItemSelected(MenuItem item) {//动态改变菜单选项内容 + switch (item.getItemId()) {//判断选择项 + case R.id.menu_new_note: + createNewNote(); + break; + case R.id.menu_delete: + 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_note)); + builder.setPositiveButton(android.R.string.ok, + new DialogInterface.OnClickListener() { + public void onClick(DialogInterface dialog, int which) { + deleteCurrentNote(); + finish(); + } + }); + builder.setNegativeButton(android.R.string.cancel, null); + builder.show(); + break; + case R.id.menu_font_size: + mFontSizeSelector.setVisibility(View.VISIBLE); + findViewById(sFontSelectorSelectionMap.get(mFontSizeId)).setVisibility(View.VISIBLE); + break; + case R.id.menu_list_mode: + mWorkingNote.setCheckListMode(mWorkingNote.getCheckListMode() == 0 ? + TextNote.MODE_CHECK_LIST : 0); + break; + case R.id.menu_share: + getWorkingText(); + sendTo(this, mWorkingNote.getContent()); + break; + case R.id.menu_send_to_desktop: + sendToDesktop(); + break; + case R.id.menu_alert: + setReminder(); + break; + case R.id.menu_delete_remind: + mWorkingNote.setAlertDate(0, false); + break; + default: + break; + } + return true; + } + + private void setReminder() {//建立事件提醒器 + DateTimePickerDialog d = new DateTimePickerDialog(this, System.currentTimeMillis()); + d.setOnDateTimeSetListener(new OnDateTimeSetListener() { + public void OnDateTimeSet(AlertDialog dialog, long date) { + mWorkingNote.setAlertDate(date , true); + } + }); + d.show(); + } + + /** + * Share note to apps that support {@link Intent#ACTION_SEND} action + * and {@text/plain} type + */ + private void sendTo(Context context, String info) {//共享便签 + Intent intent = new Intent(Intent.ACTION_SEND); + intent.putExtra(Intent.EXTRA_TEXT, info); + intent.setType("text/plain"); + context.startActivity(intent); + } + + private void createNewNote() {//创建新的便签 + // Firstly, save current editing notes + saveNote(); + + // For safety, start a new NoteEditActivity + finish(); + Intent intent = new Intent(this, NoteEditActivity.class); + intent.setAction(Intent.ACTION_INSERT_OR_EDIT); + intent.putExtra(Notes.INTENT_EXTRA_FOLDER_ID, mWorkingNote.getFolderId()); + startActivity(intent); + } + + private void deleteCurrentNote() {//删除当前便签 + if (mWorkingNote.existInDatabase()) {//先判断便签是否在数据库中 + HashSet ids = new HashSet(); + long id = mWorkingNote.getNoteId(); + if (id != Notes.ID_ROOT_FOLDER) {//如果不是头文件夹建立一个hash表把便签id存起来 + ids.add(id); + } else { + Log.d(TAG, "Wrong note id, should not happen"); + } + if (!isSyncMode()) {//如果不是同步模式，则执行下面函数 + if (!DataUtils.batchDeleteNotes(getContentResolver(), ids)) { + Log.e(TAG, "Delete Note error"); + } + } else { + if (!DataUtils.batchMoveToFolder(getContentResolver(), ids, Notes.ID_TRASH_FOLER)) { + Log.e(TAG, "Move notes to trash folder error, should not happens"); + } + } + } + mWorkingNote.markDeleted(true); + } + + private boolean isSyncMode() {//判断是否为同步模式 + return NotesPreferenceActivity.getSyncAccountName(this).trim().length() > 0; + } + + public void onClockAlertChanged(long date, boolean set) {//监听闹钟变化事件函数 + /** + * User could set clock to an unsaved note, so before setting the + * alert clock, we should save the note first + */ + if (!mWorkingNote.existInDatabase()) {//如果设置提醒的便签未保存，则先保存 + saveNote(); + } + if (mWorkingNote.getNoteId() > 0) {//数据库中有该提醒的id,执行下面操作。否则，报错。 + Intent intent = new Intent(this, AlarmReceiver.class); + intent.setData(ContentUris.withAppendedId(Notes.CONTENT_NOTE_URI, mWorkingNote.getNoteId())); + PendingIntent pendingIntent = PendingIntent.getBroadcast(this, 0, intent, 0); + AlarmManager alarmManager = ((AlarmManager) getSystemService(ALARM_SERVICE)); + showAlertHeader(); + if(!set) { + alarmManager.cancel(pendingIntent); + } else { + alarmManager.set(AlarmManager.RTC_WAKEUP, date, pendingIntent); + } + } else { + /** + * There is the condition that user has input nothing (the note is + * not worthy saving), we have no note id, remind the user that he + * should input something + */ + Log.e(TAG, "Clock alert setting error"); + showToast(R.string.error_note_empty_for_clock); + } + } + + public void onWidgetChanged() { + updateWidget(); + } + //当widget变化时，执行更新widget这个函数 + + public void onEditTextDelete(int index, String text) {//当删除编辑文本时，执行这个函数 + int childCount = mEditTextList.getChildCount(); + if (childCount == 1) {//当删除编辑文本时，执行这个函数 + return; + } + + for (int i = index + 1; i < childCount; i++) {//将index后面的每一个项覆盖前面的项，即将index的项删除，后面补上去 + ((NoteEditText) mEditTextList.getChildAt(i).findViewById(R.id.et_edit_text)) + .setIndex(i - 1); + } + + mEditTextList.removeViewAt(index); + NoteEditText edit = null; + if(index == 0) {//如果index为0，则将edit定位到第一个EditText项 + edit = (NoteEditText) mEditTextList.getChildAt(0).findViewById( + R.id.et_edit_text); + } else {//index不为0，则将edit定位到index-1对应的EditText项 + edit = (NoteEditText) mEditTextList.getChildAt(index - 1).findViewById( + R.id.et_edit_text); + } + int length = edit.length(); + edit.append(text); + edit.requestFocus(); + edit.setSelection(length); + } + + public void onEditTextEnter(int index, String text) {//当编辑便签中输入enter时执行该函数 + /** + * Should not happen, check for debug + */ + if(index > mEditTextList.getChildCount()) {//如果越界就报错 + Log.e(TAG, "Index out of mEditTextList boundrary, should not happen"); + } + + View view = getListItem(text, index); + mEditTextList.addView(view, index); + NoteEditText edit = (NoteEditText) view.findViewById(R.id.et_edit_text); + edit.requestFocus(); + edit.setSelection(0); + for (int i = index + 1; i < mEditTextList.getChildCount(); i++) {//遍历子文本框并设置对应对下标 + ((NoteEditText) mEditTextList.getChildAt(i).findViewById(R.id.et_edit_text)) + .setIndex(i); + } + } + + private void switchToListMode(String text) {//该函数转到列表模式 + mEditTextList.removeAllViews(); + String[] items = text.split("\n"); + int index = 0; + for (String item : items) {//清空所有视图，初始化下标 + if(!TextUtils.isEmpty(item)) { + mEditTextList.addView(getListItem(item, index)); + index++; + } + } + mEditTextList.addView(getListItem("", index)); + mEditTextList.getChildAt(index).findViewById(R.id.et_edit_text).requestFocus(); + + mNoteEditor.setVisibility(View.GONE); + mEditTextList.setVisibility(View.VISIBLE); + } + + private Spannable getHighlightQueryResult(String fullText, String userQuery) {//获取高亮效果的反馈结果 + SpannableString spannable = new SpannableString(fullText == null ? "" : fullText); + if (!TextUtils.isEmpty(userQuery)) {//将用户的询问进行解析，如果搜索结果不为空，执行下面函数 + mPattern = Pattern.compile(userQuery); + Matcher m = mPattern.matcher(fullText); + int start = 0; + while (m.find(start)) {//将匹配到的内容设置为高亮。 + spannable.setSpan( + new BackgroundColorSpan(this.getResources().getColor( + R.color.user_query_highlight)), m.start(), m.end(), + Spannable.SPAN_INCLUSIVE_EXCLUSIVE); + start = m.end(); + } + } + return spannable; + } + + private View getListItem(String item, int index) { + //从note_edit_list_item布局文件中获取视图，并对其进行初始化操作。 + View view = LayoutInflater.from(this).inflate(R.layout.note_edit_list_item, null); + + //从视图中查找 NoteEditText 控件并设置文本样式。 + final NoteEditText edit = (NoteEditText) view.findViewById(R.id.et_edit_text); + edit.setTextAppearance(this, TextAppearanceResources.getTexAppearanceResource(mFontSizeId)); + + //从视图中查找 CheckBox 控件，并对其设置勾选状态改变监听器。 + CheckBox cb = ((CheckBox) view.findViewById(R.id.cb_edit_item)); + cb.setOnCheckedChangeListener(new OnCheckedChangeListener() { + public void onCheckedChanged(CompoundButton buttonView, boolean isChecked) { + //如果CheckBox已勾选，则给NoteEditText添加文本样式，显示为删除线。 + if (isChecked) { + edit.setPaintFlags(edit.getPaintFlags() | Paint.STRIKE_THRU_TEXT_FLAG); + } + //否则将NoteEditText的文本样式重置为默认样式。 + else { + edit.setPaintFlags(Paint.ANTI_ALIAS_FLAG | Paint.DEV_KERN_TEXT_FLAG); + } + } + }); + + //返回经过初始化、设置文本样式和勾选状态监听器的视图。 + return view; +} + + + if (item.startsWith(TAG_CHECKED)) {//判断是否勾选 + cb.setChecked(true); + edit.setPaintFlags(edit.getPaintFlags() | Paint.STRIKE_THRU_TEXT_FLAG); + item = item.substring(TAG_CHECKED.length(), item.length()).trim(); + } else if (item.startsWith(TAG_UNCHECKED)) {//选择不勾选项 + cb.setChecked(false); + edit.setPaintFlags(Paint.ANTI_ALIAS_FLAG | Paint.DEV_KERN_TEXT_FLAG); + item = item.substring(TAG_UNCHECKED.length(), item.length()).trim(); + } + + edit.setOnTextViewChangeListener(this); + edit.setIndex(index); + edit.setText(getHighlightQueryResult(item, mUserQuery)); + return view; + } + + public void onTextChange(int index, boolean hasText) {//便签内容发生改变所 触发的事件 + if (index >= mEditTextList.getChildCount()) {//越界报错 + Log.e(TAG, "Wrong index, should not happen"); + return; + } + if(hasText) {//如果内容不为空则将其子编辑框可见性置为可见，否则不可见 + mEditTextList.getChildAt(index).findViewById(R.id.cb_edit_item).setVisibility(View.VISIBLE); + } else {//选择框不可见 + mEditTextList.getChildAt(index).findViewById(R.id.cb_edit_item).setVisibility(View.GONE); + } + } + + public void onCheckListModeChanged(int oldMode, int newMode) {//检查模式和列表模式的切换 + if (newMode == TextNote.MODE_CHECK_LIST) {// 如果是变为清单模式 + switchToListMode(mNoteEditor.getText().toString()); + } else { + if (!getWorkingText()) { + mWorkingNote.setWorkingText(mWorkingNote.getContent().replace(TAG_UNCHECKED + " ", + "")); + } + mNoteEditor.setText(getHighlightQueryResult(mWorkingNote.getContent(), mUserQuery)); + mEditTextList.setVisibility(View.GONE); + mNoteEditor.setVisibility(View.VISIBLE); + } + } + + private boolean getWorkingText() {//设置勾选选项表并返回是否勾选的标记 + boolean hasChecked = false; + if (mWorkingNote.getCheckListMode() == TextNote.MODE_CHECK_LIST) {//判断是否是清单模式 + StringBuilder sb = new StringBuilder(); + for (int i = 0; i < mEditTextList.getChildCount(); i++) {//for循环遍历EditTextList的项 + View view = mEditTextList.getChildAt(i); + NoteEditText edit = (NoteEditText) view.findViewById(R.id.et_edit_text); + if (!TextUtils.isEmpty(edit.getText())) { + if (((CheckBox) view.findViewById(R.id.cb_edit_item)).isChecked()) { + sb.append(TAG_CHECKED).append(" ").append(edit.getText()).append("\n"); + hasChecked = true; + } else { + sb.append(TAG_UNCHECKED).append(" ").append(edit.getText()).append("\n"); + } + } + } + mWorkingNote.setWorkingText(sb.toString()); + } else {//若不是该模式直接用编辑器中的内容设置运行中标签的内容 + mWorkingNote.setWorkingText(mNoteEditor.getText().toString()); + } + return hasChecked; + } + + private boolean saveNote() {//保存便签 + getWorkingText(); + boolean saved = mWorkingNote.saveNote(); + if (saved) {//如果workingNote已经保存，则将结果设置为ok。 + /** + * There are two modes from List view to edit view, open one note, + * create/edit a node. Opening node requires to the original + * position in the list when back from edit view, while creating a + * new node requires to the top of the list. This code + * {@link #RESULT_OK} is used to identify the create/edit state + */ + setResult(RESULT_OK); + } + return saved; + } + + private void sendToDesktop() {//将便签发送到桌面 + /** + * Before send message to home, we should make sure that current + * editing note is exists in databases. So, for new note, firstly + * save it + */ + if (!mWorkingNote.existInDatabase()) {//若不存在数据也就是新的标签就先保存 + saveNote(); + } + + if (mWorkingNote.getNoteId() > 0) {//若便签的id大于0，则执行以下程序 + Intent sender = new Intent(); + Intent shortcutIntent = new Intent(this, NoteEditActivity.class); + shortcutIntent.setAction(Intent.ACTION_VIEW); + shortcutIntent.putExtra(Intent.EXTRA_UID, mWorkingNote.getNoteId()); + sender.putExtra(Intent.EXTRA_SHORTCUT_INTENT, shortcutIntent); + sender.putExtra(Intent.EXTRA_SHORTCUT_NAME, + makeShortcutIconTitle(mWorkingNote.getContent())); + sender.putExtra(Intent.EXTRA_SHORTCUT_ICON_RESOURCE, + Intent.ShortcutIconResource.fromContext(this, R.drawable.icon_app)); + sender.putExtra("duplicate", true); + sender.setAction("com.android.launcher.action.INSTALL_SHORTCUT"); + showToast(R.string.info_note_enter_desktop); + sendBroadcast(sender); + } else {//如果便签的id错误，则保存提醒用户 + /** + * There is the condition that user has input nothing (the note is + * not worthy saving), we have no note id, remind the user that he + * should input something + */ + Log.e(TAG, "Send to desktop error"); + showToast(R.string.error_note_empty_for_send_to_desktop); + } + } + + private String makeShortcutIconTitle(String content) {//编辑小图标的标题 + content = content.replace(TAG_CHECKED, ""); + content = content.replace(TAG_UNCHECKED, ""); + return content.length() > SHORTCUT_ICON_TITLE_MAX_LEN ? content.substring(0, + SHORTCUT_ICON_TITLE_MAX_LEN) : content;//直接设置为content中的内容并返回，有勾选和未勾选2种 + } + + private void showToast(int resId) {//显示提示的视图 函数实现：根据下标显示对应的提示 + + showToast(resId, Toast.LENGTH_SHORT); + } + + private void showToast(int resId, int duration) { + //持续显示提示的视图 函数实现：根据下标和持续的时间（duration）编辑提示视图并显示 + Toast.makeText(this, resId, duration).show(); + } +} diff --git a/other/07_210340164温雍敬_代码标注/ui/NotesListAdapter.java b/other/07_210340164温雍敬_代码标注/ui/NotesListAdapter.java new file mode 100644 index 0000000..49a4070 --- /dev/null +++ b/other/07_210340164温雍敬_代码标注/ui/NotesListAdapter.java @@ -0,0 +1,184 @@ +/* + * 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; +import android.database.Cursor; +import android.util.Log; +import android.view.View; +import android.view.ViewGroup; +import android.widget.CursorAdapter; + +import net.micode.notes.data.Notes; + +import java.util.Collection; +import java.util.HashMap; +import java.util.HashSet; +import java.util.Iterator; + + +public class NotesListAdapter extends CursorAdapter {//继承了CursorAdapter + private static final String TAG = "NotesListAdapter"; + private Context mContext; + private HashMap mSelectedIndex;//HashMap是一个散列表，储存键值对的映射关系 + private int mNotesCount; + private boolean mChoiceMode;//选择模式标志 + + public static class AppWidgetAttribute {//桌面widget的属性，包括编号和类型 + public int widgetId; + public int widgetType; + };//父类对象置空 + + public NotesListAdapter(Context context) {//初始化便签链接 + super(context, null); + mSelectedIndex = new HashMap(); + mContext = context;//新建一个视图来存储光标所指向的数据 + mNotesCount = 0; + } + + @Override + public View newView(Context context, Cursor cursor, ViewGroup parent) {//利用NotesListLtem类创建新布局 + return new NotesListItem(context); + } + + @Override + public void bindView(View view, Context context, Cursor cursor) {//将已经存在的视图和鼠标指向的数据进行捆绑 + if (view instanceof NotesListItem) { + NoteItemData itemData = new NoteItemData(context, cursor);//新建一个项目选项并且用bind跟将view和鼠标，内容，便签数据捆绑在一起 + ((NotesListItem) view).bind(context, itemData, mChoiceMode, + isSelectedItem(cursor.getPosition())); + } + } + + public void setCheckedItem(final int position, final boolean checked) {//设置勾选框 + mSelectedIndex.put(position, checked);//根据定位和是否勾选设置下标 + notifyDataSetChanged(); + } + + public boolean isInChoiceMode() { + return mChoiceMode; + }//判断单选按钮是否勾选 + + public void setChoiceMode(boolean mode) {//重置下标，并根据参数mode设置选项 + mSelectedIndex.clear(); + mChoiceMode = mode; + } + + public void selectAll(boolean checked) {//选择全部选项，遍历所有光标可用的位置在判断为便签类型之后勾选单项框 + Cursor cursor = getCursor(); + for (int i = 0; i < getCount(); i++) {//历可用光标位置，如果光标移动且光标当前指向的便签项目类型为TYPE_NOTE则设置为勾选状态 + if (cursor.moveToPosition(i)) { + if (NoteItemData.getNoteType(cursor) == Notes.TYPE_NOTE) { + setCheckedItem(i, checked); + } + } + } + } + + public HashSet getSelectedItemIds() {//建立选择项目的ID的HASH表 + HashSet itemSet = new HashSet(); + for (Integer position : mSelectedIndex.keySet()) {//遍历所有的关键 + if (mSelectedIndex.get(position) == true) { + Long id = getItemId(position); + if (id == Notes.ID_ROOT_FOLDER) {//原文件不需要添加，则将id该下标假如选项集合中 + Log.d(TAG, "Wrong item id, should not happen"); + } else { + itemSet.add(id);//将该id加入到选项集合当中 + } + } + } + + return itemSet; + } + + public HashSet getSelectedWidget() {//建立桌面widget选项表 + HashSet itemSet = new HashSet(); + for (Integer position : mSelectedIndex.keySet()) {//遍历被选中的列表 + if (mSelectedIndex.get(position) == true) { + Cursor c = (Cursor) getItem(position);//获取条目 + if (c != null) { + AppWidgetAttribute widget = new AppWidgetAttribute(); + NoteItemData item = new NoteItemData(mContext, c);//新建widget并更新ID和类型，最后添加到选项表中 + widget.widgetId = item.getWidgetId(); + widget.widgetType = item.getWidgetType(); + itemSet.add(widget);//加入条目集合 + /** + * Don't close cursor here, only the adapter could close it + */ + } else { + Log.e(TAG, "Invalid cursor");//设置标签，无效的cursor + return null; + } + } + } + return itemSet; + } + + public int getSelectedCount() {//获取选项个数 + Collection values = mSelectedIndex.values(); + if (null == values) { + return 0; + } + Iterator iter = values.iterator();//初始化迭代器 + int count = 0; + while (iter.hasNext()) {//如果iter后面还有，则count加一 + if (true == iter.next()) { + 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; + } + return mSelectedIndex.get(position);//判断Item是否被选中的状态 + } + + @Override + protected void onContentChanged() {//activity内容变动时调用calcNotesCount计算便签数量 + super.onContentChanged();//执行父类函数 + calcNotesCount(); + } + + @Override + public void changeCursor(Cursor cursor) { + super.changeCursor(cursor);//重载父类函数 + calcNotesCount(); + } + + private void calcNotesCount() {//实现方式类似前面代码中的selectAll函数 + mNotesCount = 0; + for (int i = 0; i < getCount(); i++) {//获取总数同时遍历 + Cursor c = (Cursor) getItem(i); + if (c != null) {//判断语句，如果光标不是null，那么便得到信息，便签数目加1 + if (NoteItemData.getNoteType(c) == Notes.TYPE_NOTE) {//若选项的数据类型为便签类型，那么计数+1 + mNotesCount++; + } + } else { + Log.e(TAG, "Invalid cursor");//否则就将设置为无效的光标 + return; + } + } + } +} diff --git a/other/07_210340172杨馥银_代码标注/WorkingNote.java b/other/07_210340172杨馥银_代码标注/WorkingNote.java new file mode 100644 index 0000000..3e06929 --- /dev/null +++ b/other/07_210340172杨馥银_代码标注/WorkingNote.java @@ -0,0 +1,411 @@ +/* + * 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.model; + +import android.appwidget.AppWidgetManager; +import android.content.ContentUris; +import android.content.Context; +import android.database.Cursor; +import android.text.TextUtils; +import android.util.Log; + +import net.micode.notes.data.Notes; +import net.micode.notes.data.Notes.CallNote; +import net.micode.notes.data.Notes.DataColumns; +import net.micode.notes.data.Notes.DataConstants; +import net.micode.notes.data.Notes.NoteColumns; +import net.micode.notes.data.Notes.TextNote; +import net.micode.notes.tool.ResourceParser.NoteBgResources; + + +//声明WorkingNote类,创建小米便签的主要类，包括创建空便签，保存便签，加载小米便签内容，和设置小米便签的一些小部件之类的操作 +public class WorkingNote { + // Note for the working note + private Note mNote; + // Note Id + private long mNoteId; + // Note content + private String mContent; + // Note mode + private int mMode; + + private long mAlertDate; + + private long mModifiedDate; + + private int mBgColorId; + + private int mWidgetId; + + private int mWidgetType; + + private long mFolderId; + + private Context mContext; + + private static final String TAG = "WorkingNote"; + + private boolean mIsDeleted; + + private NoteSettingChangedListener mNoteSettingStatusListener; + + //声明 NOTE_PROJECTION字符串数组 + public static final String[] DATA_PROJECTION = new String[] { + DataColumns.ID, + DataColumns.CONTENT, + DataColumns.MIME_TYPE, + DataColumns.DATA1, + DataColumns.DATA2, + DataColumns.DATA3, + DataColumns.DATA4, + }; + + public static final String[] NOTE_PROJECTION = new String[] { + NoteColumns.PARENT_ID, + NoteColumns.ALERTED_DATE, + NoteColumns.BG_COLOR_ID, + NoteColumns.WIDGET_ID, + NoteColumns.WIDGET_TYPE, + NoteColumns.MODIFIED_DATE + }; + + private static final int DATA_ID_COLUMN = 0; + + private static final int DATA_CONTENT_COLUMN = 1; + + private static final int DATA_MIME_TYPE_COLUMN = 2; + + private static final int DATA_MODE_COLUMN = 3; + + private static final int NOTE_PARENT_ID_COLUMN = 0; + + private static final int NOTE_ALERTED_DATE_COLUMN = 1; + + private static final int NOTE_BG_COLOR_ID_COLUMN = 2; + + private static final int NOTE_WIDGET_ID_COLUMN = 3; + + private static final int NOTE_WIDGET_TYPE_COLUMN = 4; + + private static final int NOTE_MODIFIED_DATE_COLUMN = 5; + + // New note construct + //缺省noteID的构造函数，直接使用内容和文件号新建便签 + private WorkingNote(Context context, long folderId) { + mContext = context; + mAlertDate = 0; + mModifiedDate = System.currentTimeMillis(); + mFolderId = folderId; + mNote = new Note(); + mNoteId = 0; + mIsDeleted = false; + mMode = 0; + mWidgetType = Notes.TYPE_WIDGET_INVALIDE; + } + + // Existing note construct + //加载便签 + private WorkingNote(Context context, long noteId, long folderId) { + mContext = context; + mNoteId = noteId; + mFolderId = folderId; + mIsDeleted = false; + mNote = new Note(); + loadNote(); + } + + //输出mNoteId的所有属性值 + private void loadNote() { + Cursor cursor = mContext.getContentResolver().query( + ContentUris.withAppendedId(Notes.CONTENT_NOTE_URI, mNoteId), NOTE_PROJECTION, null, + null, null); + + if (cursor != null) { + if (cursor.moveToFirst()) { + mFolderId = cursor.getLong(NOTE_PARENT_ID_COLUMN); + mBgColorId = cursor.getInt(NOTE_BG_COLOR_ID_COLUMN); + mWidgetId = cursor.getInt(NOTE_WIDGET_ID_COLUMN); + mWidgetType = cursor.getInt(NOTE_WIDGET_TYPE_COLUMN); + mAlertDate = cursor.getLong(NOTE_ALERTED_DATE_COLUMN); + mModifiedDate = cursor.getLong(NOTE_MODIFIED_DATE_COLUMN); + } + cursor.close(); + } else { + Log.e(TAG, "No note with id:" + mNoteId); + throw new IllegalArgumentException("Unable to find note with id " + mNoteId); + } + loadNoteData(); + } + + //加载便签数据 + private void loadNoteData() { + Cursor cursor = mContext.getContentResolver().query(Notes.CONTENT_DATA_URI, DATA_PROJECTION, + DataColumns.NOTE_ID + "=?", new String[] { + String.valueOf(mNoteId) + }, null); + + if (cursor != null) { + if (cursor.moveToFirst()) { + do { + String type = cursor.getString(DATA_MIME_TYPE_COLUMN); + if (DataConstants.NOTE.equals(type)) { + mContent = cursor.getString(DATA_CONTENT_COLUMN); + mMode = cursor.getInt(DATA_MODE_COLUMN); + mNote.setTextDataId(cursor.getLong(DATA_ID_COLUMN)); + } else if (DataConstants.CALL_NOTE.equals(type)) { + mNote.setCallDataId(cursor.getLong(DATA_ID_COLUMN)); + } else { + Log.d(TAG, "Wrong note type with type:" + type); + } + } while (cursor.moveToNext()); + } + cursor.close(); + } else { + Log.e(TAG, "No data with id:" + mNoteId); + throw new IllegalArgumentException("Unable to find note's data with id " + mNoteId); + } + } + + //创建空的Note，传参：context，文件夹id，widget，背景颜色 + public static WorkingNote createEmptyNote(Context context, long folderId, int widgetId, + int widgetType, int defaultBgColorId) { + WorkingNote note = new WorkingNote(context, folderId); + note.setBgColorId(defaultBgColorId); + note.setWidgetId(widgetId); + note.setWidgetType(widgetType); + return note; + } + + //导入一个新的正在写入的便签 + public static WorkingNote load(Context context, long id) { + return new WorkingNote(context, id, 0); + } + + //保存note + public synchronized boolean saveNote() { + //判断是否有价值去保存 + if (isWorthSaving()) { + //当数据库中没有当前版本便签的时候才需要保存 + if (!existInDatabase()) { + if ((mNoteId = Note.getNewNoteId(mContext, mFolderId)) == 0) { + Log.e(TAG, "Create new note fail with id:" + mNoteId); + return false; + } + } + + mNote.syncNote(mContext, mNoteId); + + /** + * Update widget content if there exist any widget of this note + */ + //判断窗口大小是否变化，如果变化也要保存这个变化 + if (mWidgetId != AppWidgetManager.INVALID_APPWIDGET_ID + && mWidgetType != Notes.TYPE_WIDGET_INVALIDE + && mNoteSettingStatusListener != null) { + mNoteSettingStatusListener.onWidgetChanged(); + } + return true; + } else { + return false; + } + } + + //判断便签是否已经存在于数据库中 + public boolean existInDatabase() { + return mNoteId > 0; + } + + //判断是否有保存的必要性 + private boolean isWorthSaving() { + //如果是误删，或者是空的，或者在本地并没有修改，那么不需要保存 + if (mIsDeleted || (!existInDatabase() && TextUtils.isEmpty(mContent)) + || (existInDatabase() && !mNote.isLocalModified())) { + return false; + } else { + return true; + } + } + + //设置监听“设置状态改变” + public void setOnSettingStatusChangedListener(NoteSettingChangedListener l) { + mNoteSettingStatusListener = l; + } + + //设置提示日期 + public void setAlertDate(long date, boolean set) { + //若 mAlertDate与data不同，则更改mAlertDate并设定NoteValue + if (date != mAlertDate) { + mAlertDate = date; + mNote.setNoteValue(NoteColumns.ALERTED_DATE, String.valueOf(mAlertDate)); + } + if (mNoteSettingStatusListener != null) { + mNoteSettingStatusListener.onClockAlertChanged(date, set); + } + } + + //设定删除标记 + public void markDeleted(boolean mark) { + mIsDeleted = mark; + if (mWidgetId != AppWidgetManager.INVALID_APPWIDGET_ID + && mWidgetType != Notes.TYPE_WIDGET_INVALIDE && mNoteSettingStatusListener != null) { + mNoteSettingStatusListener.onWidgetChanged(); + } + } + + //设置背景颜色为第ID号颜色 + public void setBgColorId(int id) { + if (id != mBgColorId) { + mBgColorId = id; + //判断此id是否是背景颜色id，如果不是，则更新背景颜色 + if (mNoteSettingStatusListener != null) { + mNoteSettingStatusListener.onBackgroundColorChanged(); + } + mNote.setNoteValue(NoteColumns.BG_COLOR_ID, String.valueOf(id)); + } + } + + //设定检查列表模式 + public void setCheckListMode(int mode) { + //如果传入的模式与原模式不同，则更改原模式为当前模式 + if (mMode != mode) { + if (mNoteSettingStatusListener != null) { + mNoteSettingStatusListener.onCheckListModeChanged(mMode, mode); + } + mMode = mode; + mNote.setTextData(TextNote.MODE, String.valueOf(mMode)); + } + } + + //设置窗口类型 + public void setWidgetType(int type) { + //判断传入的类型是否与当前类型一样，否则更改为传入的类型并储存便签的窗口数据 + if (type != mWidgetType) { + mWidgetType = type; + mNote.setNoteValue(NoteColumns.WIDGET_TYPE, String.valueOf(mWidgetType)); + } + } + + //设置窗口编号 + public void setWidgetId(int id) { + // 判断传入是否与当前id一样，否则更改为传入id + if (id != mWidgetId) { + mWidgetId = id; + mNote.setNoteValue(NoteColumns.WIDGET_ID, String.valueOf(mWidgetId)); + } + } + + //设定编辑文本 + public void setWorkingText(String text) { + //判断文本内容是否相同，否则更新文本 + if (!TextUtils.equals(mContent, text)) { + mContent = text; + mNote.setTextData(DataColumns.CONTENT, mContent); + } + } + + //转换成电话提醒的便签 + public void convertToCallNote(String phoneNumber, long callDate) { + mNote.setCallData(CallNote.CALL_DATE, String.valueOf(callDate)); + mNote.setCallData(CallNote.PHONE_NUMBER, phoneNumber); + mNote.setNoteValue(NoteColumns.PARENT_ID, String.valueOf(Notes.ID_CALL_RECORD_FOLDER)); + } + + //判断是否有时钟提醒 + public boolean hasClockAlert() { + return (mAlertDate > 0 ? true : false); + } + + //获取便签内容 + public String getContent() { + return mContent; + } + + //获取待提醒日期 + public long getAlertDate() { + return mAlertDate; + } + + //获取修改之后的日期 + public long getModifiedDate() { + return mModifiedDate; + } + + //获取背景颜色资源ID + public int getBgColorResId() { + return NoteBgResources.getNoteBgResource(mBgColorId); + } + + //获取背景颜色ID + public int getBgColorId() { + return mBgColorId; + } + + //获取标题背景来源 + public int getTitleBgResId() { + return NoteBgResources.getNoteTitleBgResource(mBgColorId); + } + + //获取清单的模式 + public int getCheckListMode() { + return mMode; + } + + //获取便签ID + public long getNoteId() { + return mNoteId; + } + + //获取文件夹ID + public long getFolderId() { + return mFolderId; + } + + //获取窗口编号 + public int getWidgetId() { + return mWidgetId; + } + + //监听检测便签设置变化的接口 + public int getWidgetType() { + return mWidgetType; + } + + //监听便签内部所有属性改变，当便签的属性改变的时候，这个类里面会有相应的记录，但是这个类只有个框架。 + public interface NoteSettingChangedListener { + /** + * Called when the background color of current note has just changed + */ + void onBackgroundColorChanged(); + + /** + * Called when user set clock + */ + void onClockAlertChanged(long date, boolean set); + + /** + * Call when user create note from widget + */ + void onWidgetChanged(); + + /** + * Call when switch between check list mode and normal mode + * @param oldMode is previous mode before change + * @param newMode is new mode + */ + void onCheckListModeChanged(int oldMode, int newMode); + } +} diff --git a/other/07_210340172杨馥银_代码标注/remote/GTaskASyncTask.java b/other/07_210340172杨馥银_代码标注/remote/GTaskASyncTask.java new file mode 100644 index 0000000..fb3d284 --- /dev/null +++ b/other/07_210340172杨馥银_代码标注/remote/GTaskASyncTask.java @@ -0,0 +1,142 @@ + +/* + * 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.gtask.remote; + +import android.app.Notification; +import android.app.NotificationManager; +import android.app.PendingIntent; +import android.content.Context; +import android.content.Intent; +import android.os.AsyncTask; + +import net.micode.notes.R; +import net.micode.notes.ui.NotesListActivity; +import net.micode.notes.ui.NotesPreferenceActivity; + +//实现GTask的异步操作过程 +public class GTaskASyncTask extends AsyncTask { + + private static int GTASK_SYNC_NOTIFICATION_ID = 5234235; + + //通过interface实现多个接口，初始化异步的功能。 + public interface OnCompleteListener { + void onComplete(); + } + + //文本内容 + private Context mContext; + + //实例化通知管理器 + private NotificationManager mNotifiManager; + + //实例化任务管理器 + private GTaskManager mTaskManager; + + //实例化监听器 + private OnCompleteListener mOnCompleteListener; + + //GTaskASyncTask类的构造函数 + public GTaskASyncTask(Context context, OnCompleteListener listener) { + mContext = context; + mOnCompleteListener = listener; + mNotifiManager = (NotificationManager) mContext + .getSystemService(Context.NOTIFICATION_SERVICE); + mTaskManager = GTaskManager.getInstance(); + } + + //中断同步 + public void cancelSync() { + mTaskManager.cancelSync(); + } + + //调用onProgressUpdate方法来更新进度条 + public void publishProgess(String message) { + publishProgress(new String[] { + message + }); + } + + //向用户显示当前的同步状态 + private void showNotification(int tickerId, String content) { + PendingIntent pendingIntent; + // 如果同步失败，那么从系统取得一个用于启动一个NotesPreferenceActivity的PendingIntent对象 + if (tickerId != R.string.ticker_success) { + pendingIntent = PendingIntent.getActivity(mContext, 0, new Intent(mContext, + NotesPreferenceActivity.class), 0); + + } else { + pendingIntent = PendingIntent.getActivity(mContext, 0, new Intent(mContext, + NotesListActivity.class), 0); + } + + + Notification.Builder builder = new Notification.Builder(mContext) + .setAutoCancel(true) + .setContentTitle(mContext.getString(R.string.app_name)) + .setContentText(content) + .setContentIntent(pendingIntent) + .setWhen(System.currentTimeMillis()) + .setOngoing(true); + Notification notification=builder.getNotification(); + mNotifiManager.notify(GTASK_SYNC_NOTIFICATION_ID, notification); + } + + @Override + //异步执行后台线程将要完成的任务 + protected Integer doInBackground(Void... unused) { + publishProgess(mContext.getString(R.string.sync_progress_login, NotesPreferenceActivity + .getSyncAccountName(mContext))); + return mTaskManager.sync(mContext, this); + } + + @Override + //用于显示任务执行的进度 + protected void onProgressUpdate(String... progress) { + showNotification(R.string.ticker_syncing, progress[0]); + if (mContext instanceof GTaskSyncService) { + ((GTaskSyncService) mContext).sendBroadcast(progress[0]); + } + } + + @Override + //用于设置任务 + protected void onPostExecute(Integer result) { + //若同步成功，则显示成功并展示出同步的账户与最新同步时间，若同步出现网络错误，则显示相应错误 + if (result == GTaskManager.STATE_SUCCESS) { + showNotification(R.string.ticker_success, mContext.getString( + R.string.success_sync_account, mTaskManager.getSyncAccount())); + NotesPreferenceActivity.setLastSyncTime(mContext, System.currentTimeMillis()); + } else if (result == GTaskManager.STATE_NETWORK_ERROR) { + showNotification(R.string.ticker_fail, mContext.getString(R.string.error_sync_network)); + } else if (result == GTaskManager.STATE_INTERNAL_ERROR) { + showNotification(R.string.ticker_fail, mContext.getString(R.string.error_sync_internal)); + } else if (result == GTaskManager.STATE_SYNC_CANCELLED) { + showNotification(R.string.ticker_cancel, mContext + .getString(R.string.error_sync_cancelled)); + } + if (mOnCompleteListener != null) { + new Thread(new Runnable() { + + //执行完后调用然后返回主线程中 + public void run() { + mOnCompleteListener.onComplete(); + } + }).start(); + } + } +} diff --git a/other/07_210340172杨馥银_代码标注/remote/GTaskClient.java b/other/07_210340172杨馥银_代码标注/remote/GTaskClient.java new file mode 100644 index 0000000..1826e51 --- /dev/null +++ b/other/07_210340172杨馥银_代码标注/remote/GTaskClient.java @@ -0,0 +1,612 @@ +/* + * 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.gtask.remote; + +import android.accounts.Account; +import android.accounts.AccountManager; +import android.accounts.AccountManagerFuture; +import android.app.Activity; +import android.os.Bundle; +import android.text.TextUtils; +import android.util.Log; + +import net.micode.notes.gtask.data.Node; +import net.micode.notes.gtask.data.Task; +import net.micode.notes.gtask.data.TaskList; +import net.micode.notes.gtask.exception.ActionFailureException; +import net.micode.notes.gtask.exception.NetworkFailureException; +import net.micode.notes.tool.GTaskStringUtils; +import net.micode.notes.ui.NotesPreferenceActivity; + +import org.apache.http.HttpEntity; +import org.apache.http.HttpResponse; +import org.apache.http.client.ClientProtocolException; +import org.apache.http.client.entity.UrlEncodedFormEntity; +import org.apache.http.client.methods.HttpGet; +import org.apache.http.client.methods.HttpPost; +import org.apache.http.cookie.Cookie; +import org.apache.http.impl.client.BasicCookieStore; +import org.apache.http.impl.client.DefaultHttpClient; +import org.apache.http.message.BasicNameValuePair; +import org.apache.http.params.BasicHttpParams; +import org.apache.http.params.HttpConnectionParams; +import org.apache.http.params.HttpParams; +import org.apache.http.params.HttpProtocolParams; +import org.json.JSONArray; +import org.json.JSONException; +import org.json.JSONObject; + +import java.io.BufferedReader; +import java.io.IOException; +import java.io.InputStream; +import java.io.InputStreamReader; +import java.util.LinkedList; +import java.util.List; +import java.util.zip.GZIPInputStream; +import java.util.zip.Inflater; +import java.util.zip.InflaterInputStream; + + +//实现GTask的登录并进行GTASK任务的创建，创建任务列表，从网络上获取任务和任务列表的内容 +public class GTaskClient { + //设置本类的TAG，作用是日志的打印输出和标识此类。 + private static final String TAG = GTaskClient.class.getSimpleName(); + + //谷歌邮箱的URL + private static final String GTASK_URL = "https://mail.google.com/tasks/"; + + //传递URL + private static final String GTASK_GET_URL = "https://mail.google.com/tasks/ig"; + + //传递的url + private static final String GTASK_POST_URL = "https://mail.google.com/tasks/r/ig"; + + //后续使用的参数以及变量 + private static GTaskClient mInstance = null; + + //网络地址客户端 + private DefaultHttpClient mHttpClient; + + private String mGetUrl; + + private String mPostUrl; + + private long mClientVersion; + + private boolean mLoggedin; + + private long mLastLoginTime; + + private int mActionId; + + private Account mAccount; + + private JSONArray mUpdateArray; + + //GTaskClient的构造函数 + private GTaskClient() { + mHttpClient = null; + mGetUrl = GTASK_GET_URL; + mPostUrl = GTASK_POST_URL; + mClientVersion = -1; + mLoggedin = false; + mLastLoginTime = 0; + mActionId = 1; + mAccount = null; + mUpdateArray = null; + } + + //获取实例，如果当前没有示例，则新建一个登陆的Gtask，如果有直接返回 + public static synchronized GTaskClient getInstance() { + if (mInstance == null) { + mInstance = new GTaskClient(); + } + return mInstance; + } + + //用来实现登录操作的函数 + public boolean login(Activity activity) { + // we suppose that the cookie would expire after 5 minutes + // then we need to re-login + final long interval = 1000 * 60 * 5; + if (mLastLoginTime + interval < System.currentTimeMillis()) { + mLoggedin = false; + } + + // need to re-login after account switch + if (mLoggedin + && !TextUtils.equals(getSyncAccount().name, NotesPreferenceActivity + .getSyncAccountName(activity))) { + mLoggedin = false; + } + + if (mLoggedin) { + Log.d(TAG, "already logged in"); + return true; + } + + mLastLoginTime = System.currentTimeMillis(); + String authToken = loginGoogleAccount(activity, false); + if (authToken == null) { + Log.e(TAG, "login google account failed"); + return false; + } + + // login with custom domain if necessary + if (!(mAccount.name.toLowerCase().endsWith("gmail.com") || mAccount.name.toLowerCase() + .endsWith("googlemail.com"))) { + StringBuilder url = new StringBuilder(GTASK_URL).append("a/"); + int index = mAccount.name.indexOf('@') + 1; + String suffix = mAccount.name.substring(index); + url.append(suffix + "/"); + mGetUrl = url.toString() + "ig"; + mPostUrl = url.toString() + "r/ig"; + + if (tryToLoginGtask(activity, authToken)) { + mLoggedin = true; + } + } + + // try to login with google official url + if (!mLoggedin) { + mGetUrl = GTASK_GET_URL; + mPostUrl = GTASK_POST_URL; + if (!tryToLoginGtask(activity, authToken)) { + return false; + } + } + + mLoggedin = true; + return true; + } + + //用以具体实现登录Google账号的方法，方法返回账号令牌 + private String loginGoogleAccount(Activity activity, boolean invalidateToken) { + String authToken; + AccountManager accountManager = AccountManager.get(activity); + Account[] accounts = accountManager.getAccountsByType("com.google"); + + if (accounts.length == 0) { + Log.e(TAG, "there is no available google account"); + return null; + } + + String accountName = NotesPreferenceActivity.getSyncAccountName(activity); + Account account = null; + for (Account a : accounts) { + if (a.name.equals(accountName)) { + account = a; + break; + } + } + if (account != null) { + mAccount = account; + } else { + Log.e(TAG, "unable to get an account with the same name in the settings"); + return null; + } + + // get the token now + AccountManagerFuture accountManagerFuture = accountManager.getAuthToken(account, + "goanna_mobile", null, activity, null, null); + try { + Bundle authTokenBundle = accountManagerFuture.getResult(); + authToken = authTokenBundle.getString(AccountManager.KEY_AUTHTOKEN); + if (invalidateToken) { + accountManager.invalidateAuthToken("com.google", authToken); + loginGoogleAccount(activity, false); + } + } catch (Exception e) { + Log.e(TAG, "get auth token failed"); + authToken = null; + } + + return authToken; + } + + //判断令牌对于登陆gtask账号是否有效的函数 + private boolean tryToLoginGtask(Activity activity, String authToken) { + if (!loginGtask(authToken)) { + // maybe the auth token is out of date, now let's invalidate the + // token and try again + authToken = loginGoogleAccount(activity, true); + if (authToken == null) { + Log.e(TAG, "login google account failed"); + return false; + } + + if (!loginGtask(authToken)) { + Log.e(TAG, "login gtask failed"); + return false; + } + } + return true; + } + + //实现登录Gtask方法的函数 + private boolean loginGtask(String authToken) { + int timeoutConnection = 10000; + int timeoutSocket = 15000; + HttpParams httpParameters = new BasicHttpParams(); + HttpConnectionParams.setConnectionTimeout(httpParameters, timeoutConnection); + HttpConnectionParams.setSoTimeout(httpParameters, timeoutSocket); + mHttpClient = new DefaultHttpClient(httpParameters); + BasicCookieStore localBasicCookieStore = new BasicCookieStore(); + mHttpClient.setCookieStore(localBasicCookieStore); + HttpProtocolParams.setUseExpectContinue(mHttpClient.getParams(), false); + + // login gtask + try { + String loginUrl = mGetUrl + "?auth=" + authToken; + HttpGet httpGet = new HttpGet(loginUrl); + HttpResponse response = null; + response = mHttpClient.execute(httpGet); + + // get the cookie now + List cookies = mHttpClient.getCookieStore().getCookies(); + boolean hasAuthCookie = false; + for (Cookie cookie : cookies) { + if (cookie.getName().contains("GTL")) { + hasAuthCookie = true; + } + } + if (!hasAuthCookie) { + Log.w(TAG, "it seems that there is no auth cookie"); + } + + // get the client version + String resString = getResponseContent(response.getEntity()); + String jsBegin = "_setup("; + String jsEnd = ")}"; + int begin = resString.indexOf(jsBegin); + int end = resString.lastIndexOf(jsEnd); + String jsString = null; + if (begin != -1 && end != -1 && begin < end) { + jsString = resString.substring(begin + jsBegin.length(), end); + } + JSONObject js = new JSONObject(jsString); + mClientVersion = js.getLong("v"); + } catch (JSONException e) { + Log.e(TAG, e.toString()); + e.printStackTrace(); + return false; + } catch (Exception e) { + // simply catch all exceptions + Log.e(TAG, "httpget gtask_url failed"); + return false; + } + + return true; + } + + //得到用户的ID返回并加1 + private int getActionId() { + return mActionId++; + } + + //创建一个httpPost对象，用于向网络传输数据 + private HttpPost createHttpPost() { + HttpPost httpPost = new HttpPost(mPostUrl); + httpPost.setHeader("Content-Type", "application/x-www-form-urlencoded;charset=utf-8"); + httpPost.setHeader("AT", "1"); + return httpPost; + } + + //通过URL获取响应后返回的数据，使用getContentEncoding()获取网络上的资源和数据，返回值就是获取到的资源 + private String getResponseContent(HttpEntity entity) throws IOException { + String contentEncoding = null; + if (entity.getContentEncoding() != null) { + contentEncoding = entity.getContentEncoding().getValue(); + Log.d(TAG, "encoding: " + contentEncoding); + } + + InputStream input = entity.getContent(); + if (contentEncoding != null && contentEncoding.equalsIgnoreCase("gzip")) { + input = new GZIPInputStream(entity.getContent()); + } else if (contentEncoding != null && contentEncoding.equalsIgnoreCase("deflate")) { + Inflater inflater = new Inflater(true); + input = new InflaterInputStream(entity.getContent(), inflater); + } + + try { + InputStreamReader isr = new InputStreamReader(input); + BufferedReader br = new BufferedReader(isr); + StringBuilder sb = new StringBuilder(); + + while (true) { + String buff = br.readLine(); + if (buff == null) { + return sb.toString(); + } + sb = sb.append(buff); + } + } finally { + input.close(); + } + } + + //通过JSON发送请求,利用UrlEncodedFormEntity entity和httpPost.setEntity把js中的内容放置到httpPost中后将资源再次放入json后返回 + private JSONObject postRequest(JSONObject js) throws NetworkFailureException { + if (!mLoggedin) { + Log.e(TAG, "please login first"); + throw new ActionFailureException("not logged in"); + } + + HttpPost httpPost = createHttpPost(); + try { + LinkedList list = new LinkedList(); + list.add(new BasicNameValuePair("r", js.toString())); + UrlEncodedFormEntity entity = new UrlEncodedFormEntity(list, "UTF-8"); + httpPost.setEntity(entity); + + // execute the post + HttpResponse response = mHttpClient.execute(httpPost); + String jsString = getResponseContent(response.getEntity()); + return new JSONObject(jsString); + + } catch (ClientProtocolException e) { + Log.e(TAG, e.toString()); + e.printStackTrace(); + throw new NetworkFailureException("postRequest failed"); + } catch (IOException e) { + Log.e(TAG, e.toString()); + e.printStackTrace(); + throw new NetworkFailureException("postRequest failed"); + } catch (JSONException e) { + Log.e(TAG, e.toString()); + e.printStackTrace(); + throw new ActionFailureException("unable to convert response content to jsonobject"); + } catch (Exception e) { + Log.e(TAG, e.toString()); + e.printStackTrace(); + throw new ActionFailureException("error occurs when posting request"); + } + } + + //创建单个任务，通过json获取TASK中的内容并创建对应的jsPost，使用setGid方法设置task的new_id + public void createTask(Task task) throws NetworkFailureException { + commitUpdate(); + try { + JSONObject jsPost = new JSONObject(); + JSONArray actionList = new JSONArray(); + + // action_list + actionList.put(task.getCreateAction(getActionId())); + jsPost.put(GTaskStringUtils.GTASK_JSON_ACTION_LIST, actionList); + + // client_version + jsPost.put(GTaskStringUtils.GTASK_JSON_CLIENT_VERSION, mClientVersion); + + // post + JSONObject jsResponse = postRequest(jsPost); + JSONObject jsResult = (JSONObject) jsResponse.getJSONArray( + GTaskStringUtils.GTASK_JSON_RESULTS).get(0); + task.setGid(jsResult.getString(GTaskStringUtils.GTASK_JSON_NEW_ID)); + + } catch (JSONException e) { + Log.e(TAG, e.toString()); + e.printStackTrace(); + throw new ActionFailureException("create task: handing jsonobject failed"); + } + } + + //创建任务列表 + public void createTaskList(TaskList tasklist) throws NetworkFailureException { + commitUpdate(); + try { + JSONObject jsPost = new JSONObject(); + JSONArray actionList = new JSONArray(); + + // action_list + actionList.put(tasklist.getCreateAction(getActionId())); + jsPost.put(GTaskStringUtils.GTASK_JSON_ACTION_LIST, actionList); + + // client version + jsPost.put(GTaskStringUtils.GTASK_JSON_CLIENT_VERSION, mClientVersion); + + // post + JSONObject jsResponse = postRequest(jsPost); + JSONObject jsResult = (JSONObject) jsResponse.getJSONArray( + GTaskStringUtils.GTASK_JSON_RESULTS).get(0); + tasklist.setGid(jsResult.getString(GTaskStringUtils.GTASK_JSON_NEW_ID)); + + } catch (JSONException e) { + Log.e(TAG, e.toString()); + e.printStackTrace(); + throw new ActionFailureException("create tasklist: handing jsonobject failed"); + } + } + + //利用JSON提交更新数据 + public void commitUpdate() throws NetworkFailureException { + if (mUpdateArray != null) { + try { + JSONObject jsPost = new JSONObject(); + + // action_list + jsPost.put(GTaskStringUtils.GTASK_JSON_ACTION_LIST, mUpdateArray); + + // client_version + jsPost.put(GTaskStringUtils.GTASK_JSON_CLIENT_VERSION, mClientVersion); + + postRequest(jsPost); + mUpdateArray = null; + } catch (JSONException e) { + Log.e(TAG, e.toString()); + e.printStackTrace(); + throw new ActionFailureException("commit update: handing jsonobject failed"); + } + } + } + + //利用commitUpdate添加更新节点 + public void addUpdateNode(Node node) throws NetworkFailureException { + if (node != null) { + // too many update items may result in an error + // set max to 10 items + if (mUpdateArray != null && mUpdateArray.length() > 10) { + commitUpdate(); + } + + if (mUpdateArray == null) + mUpdateArray = new JSONArray(); + mUpdateArray.put(node.getUpdateAction(getActionId())); + } + } + + //移动任务 + public void moveTask(Task task, TaskList preParent, TaskList curParent) + throws NetworkFailureException { + commitUpdate(); + try { + JSONObject jsPost = new JSONObject(); + JSONArray actionList = new JSONArray(); + JSONObject action = new JSONObject(); + + // action_list + action.put(GTaskStringUtils.GTASK_JSON_ACTION_TYPE, + GTaskStringUtils.GTASK_JSON_ACTION_TYPE_MOVE); + action.put(GTaskStringUtils.GTASK_JSON_ACTION_ID, getActionId()); + action.put(GTaskStringUtils.GTASK_JSON_ID, task.getGid()); + if (preParent == curParent && task.getPriorSibling() != null) { + // put prioring_sibing_id only if moving within the tasklist and + // it is not the first one + action.put(GTaskStringUtils.GTASK_JSON_PRIOR_SIBLING_ID, task.getPriorSibling()); + } + action.put(GTaskStringUtils.GTASK_JSON_SOURCE_LIST, preParent.getGid()); + action.put(GTaskStringUtils.GTASK_JSON_DEST_PARENT, curParent.getGid()); + if (preParent != curParent) { + // put the dest_list only if moving between tasklists + action.put(GTaskStringUtils.GTASK_JSON_DEST_LIST, curParent.getGid()); + } + actionList.put(action); + jsPost.put(GTaskStringUtils.GTASK_JSON_ACTION_LIST, actionList); + + // client_version + jsPost.put(GTaskStringUtils.GTASK_JSON_CLIENT_VERSION, mClientVersion); + + postRequest(jsPost); + + } catch (JSONException e) { + Log.e(TAG, e.toString()); + e.printStackTrace(); + throw new ActionFailureException("move task: handing jsonobject failed"); + } + } + + //删除操作节点 + public void deleteNode(Node node) throws NetworkFailureException { + commitUpdate(); + try { + JSONObject jsPost = new JSONObject(); + JSONArray actionList = new JSONArray(); + + // action_list + node.setDeleted(true); + actionList.put(node.getUpdateAction(getActionId())); + jsPost.put(GTaskStringUtils.GTASK_JSON_ACTION_LIST, actionList); + + // client_version + jsPost.put(GTaskStringUtils.GTASK_JSON_CLIENT_VERSION, mClientVersion); + + postRequest(jsPost); + mUpdateArray = null; + } catch (JSONException e) { + Log.e(TAG, e.toString()); + e.printStackTrace(); + throw new ActionFailureException("delete node: handing jsonobject failed"); + } + } + + //获取任务列表，首先通过getURI在网上获取数据，在截取所需部分内容返回 + public JSONArray getTaskLists() throws NetworkFailureException { + if (!mLoggedin) { + Log.e(TAG, "please login first"); + throw new ActionFailureException("not logged in"); + } + + try { + HttpGet httpGet = new HttpGet(mGetUrl); + HttpResponse response = null; + response = mHttpClient.execute(httpGet); + + // get the task list + String resString = getResponseContent(response.getEntity()); + String jsBegin = "_setup("; + String jsEnd = ")}"; + int begin = resString.indexOf(jsBegin); + int end = resString.lastIndexOf(jsEnd); + String jsString = null; + if (begin != -1 && end != -1 && begin < end) { + jsString = resString.substring(begin + jsBegin.length(), end); + } + JSONObject js = new JSONObject(jsString); + return js.getJSONObject("t").getJSONArray(GTaskStringUtils.GTASK_JSON_LISTS); + } catch (ClientProtocolException e) { + Log.e(TAG, e.toString()); + e.printStackTrace(); + throw new NetworkFailureException("gettasklists: httpget failed"); + } catch (IOException e) { + Log.e(TAG, e.toString()); + e.printStackTrace(); + throw new NetworkFailureException("gettasklists: httpget failed"); + } catch (JSONException e) { + Log.e(TAG, e.toString()); + e.printStackTrace(); + throw new ActionFailureException("get task lists: handing jasonobject failed"); + } + } + + //获取任务列表 + public JSONArray getTaskList(String listGid) throws NetworkFailureException { + commitUpdate(); + try { + JSONObject jsPost = new JSONObject(); + JSONArray actionList = new JSONArray(); + JSONObject action = new JSONObject(); + + // action_list + action.put(GTaskStringUtils.GTASK_JSON_ACTION_TYPE, + GTaskStringUtils.GTASK_JSON_ACTION_TYPE_GETALL); + action.put(GTaskStringUtils.GTASK_JSON_ACTION_ID, getActionId()); + action.put(GTaskStringUtils.GTASK_JSON_LIST_ID, listGid); + action.put(GTaskStringUtils.GTASK_JSON_GET_DELETED, false); + actionList.put(action); + jsPost.put(GTaskStringUtils.GTASK_JSON_ACTION_LIST, actionList); + + // client_version + jsPost.put(GTaskStringUtils.GTASK_JSON_CLIENT_VERSION, mClientVersion); + + JSONObject jsResponse = postRequest(jsPost); + return jsResponse.getJSONArray(GTaskStringUtils.GTASK_JSON_TASKS); + } catch (JSONException e) { + Log.e(TAG, e.toString()); + e.printStackTrace(); + throw new ActionFailureException("get task list: handing jsonobject failed"); + } + } + + //获得同步账户 + public Account getSyncAccount() { + return mAccount; + } + + //重置更新内容 + public void resetUpdateArray() { + mUpdateArray = null; + } +} diff --git a/other/07_210340172杨馥银_代码标注/remote/GTaskManager.java b/other/07_210340172杨馥银_代码标注/remote/GTaskManager.java new file mode 100644 index 0000000..2de2547 --- /dev/null +++ b/other/07_210340172杨馥银_代码标注/remote/GTaskManager.java @@ -0,0 +1,852 @@ +/* + * 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.gtask.remote; + +import android.app.Activity; +import android.content.ContentResolver; +import android.content.ContentUris; +import android.content.ContentValues; +import android.content.Context; +import android.database.Cursor; +import android.util.Log; + +import net.micode.notes.R; +import net.micode.notes.data.Notes; +import net.micode.notes.data.Notes.DataColumns; +import net.micode.notes.data.Notes.NoteColumns; +import net.micode.notes.gtask.data.MetaData; +import net.micode.notes.gtask.data.Node; +import net.micode.notes.gtask.data.SqlNote; +import net.micode.notes.gtask.data.Task; +import net.micode.notes.gtask.data.TaskList; +import net.micode.notes.gtask.exception.ActionFailureException; +import net.micode.notes.gtask.exception.NetworkFailureException; +import net.micode.notes.tool.DataUtils; +import net.micode.notes.tool.GTaskStringUtils; + +import org.json.JSONArray; +import org.json.JSONException; +import org.json.JSONObject; + +import java.util.HashMap; +import java.util.HashSet; +import java.util.Iterator; +import java.util.Map; + +//声明GTask管理类，封装了对GTask进行管理的一些方法 +public class GTaskManager { + //通过 getSimpleName()得到类的简写名称。然后赋值给TAG + private static final String TAG = GTaskManager.class.getSimpleName(); + + //进程状态：用0、1、2、3、4分别表示成功、网络错误、内部错误、同步中、取消同步 + public static final int STATE_SUCCESS = 0; + + public static final int STATE_NETWORK_ERROR = 1; + + public static final int STATE_INTERNAL_ERROR = 2; + + public static final int STATE_SYNC_IN_PROGRESS = 3; + + public static final int STATE_SYNC_CANCELLED = 4; + + // private 定义一系列不可被外部的类访问的量 + private static GTaskManager mInstance = null; + + private Activity mActivity; + + private Context mContext; + + private ContentResolver mContentResolver; + + private boolean mSyncing; + + private boolean mCancelled; + + private HashMap mGTaskListHashMap; + + private HashMap mGTaskHashMap; + + private HashMap mMetaHashMap; + + private TaskList mMetaList; + + private HashSet mLocalDeleteIdMap; + + private HashMap mGidToNid; + + private HashMap mNidToGid; + + //该类的构造函数 + private GTaskManager() { + mSyncing = false; + mCancelled = false; + mGTaskListHashMap = new HashMap(); + mGTaskHashMap = new HashMap(); + mMetaHashMap = new HashMap(); + mMetaList = null; + mLocalDeleteIdMap = new HashSet(); + mGidToNid = new HashMap(); + mNidToGid = new HashMap(); + } + + //获取一个实例，通过GTaskManager()新建一个mInstance + public static synchronized GTaskManager getInstance() { + if (mInstance == null) { + mInstance = new GTaskManager(); + } + return mInstance; + } + + //setActivityContext()用于获取当前的操作并更新至GTask中 + public synchronized void setActivityContext(Activity activity) { + // used for getting authtoken + mActivity = activity; + } + + //同步的总控制，包括同步前设置环境，进行同步，处理异常，同步结束清空缓存 + public int sync(Context context, GTaskASyncTask asyncTask) { + if (mSyncing) { + Log.d(TAG, "Sync is in progress"); + return STATE_SYNC_IN_PROGRESS; + } + + mContext = context; + mContentResolver = mContext.getContentResolver(); + //初始化各种标志变量 + mSyncing = true; + mCancelled = false; + //对各种结构进行清空 + mGTaskListHashMap.clear(); + mGTaskHashMap.clear(); + mMetaHashMap.clear(); + mLocalDeleteIdMap.clear(); + mGidToNid.clear(); + mNidToGid.clear(); + + try { + GTaskClient client = GTaskClient.getInstance(); + client.resetUpdateArray(); + + // login google task + //登录谷歌账号 + if (!mCancelled) { + if (!client.login(mActivity)) { + throw new NetworkFailureException("login google task failed"); + } + } + + // get the task list from google + //从谷歌获取任务清单 + asyncTask.publishProgess(mContext.getString(R.string.sync_progress_init_list)); + initGTaskList(); + + // do content sync work + //获取Google上的JSONtasklist转为本地TaskList + asyncTask.publishProgess(mContext.getString(R.string.sync_progress_syncing)); + syncContent(); + } catch (NetworkFailureException e) { + Log.e(TAG, e.toString()); + return STATE_NETWORK_ERROR; + } catch (ActionFailureException e) { + Log.e(TAG, e.toString()); + return STATE_INTERNAL_ERROR; + } catch (Exception e) { + Log.e(TAG, e.toString()); + e.printStackTrace(); + return STATE_INTERNAL_ERROR; + } finally { + mGTaskListHashMap.clear(); + mGTaskHashMap.clear(); + mMetaHashMap.clear(); + mLocalDeleteIdMap.clear(); + mGidToNid.clear(); + mNidToGid.clear(); + mSyncing = false; + } + + return mCancelled ? STATE_SYNC_CANCELLED : STATE_SUCCESS; + } + + //初始化GTask列表，将google上的JSONTaskList转为本地任务列表 + private void initGTaskList() throws NetworkFailureException { + if (mCancelled) + return; + GTaskClient client = GTaskClient.getInstance(); + try { + JSONArray jsTaskLists = client.getTaskLists(); + + // init meta list first + mMetaList = null; + for (int i = 0; i < jsTaskLists.length(); i++) { + JSONObject object = jsTaskLists.getJSONObject(i); + String gid = object.getString(GTaskStringUtils.GTASK_JSON_ID); + String name = object.getString(GTaskStringUtils.GTASK_JSON_NAME); + + if (name + .equals(GTaskStringUtils.MIUI_FOLDER_PREFFIX + GTaskStringUtils.FOLDER_META)) { + mMetaList = new TaskList(); + mMetaList.setContentByRemoteJSON(object); + + // load meta data + JSONArray jsMetas = client.getTaskList(gid); + for (int j = 0; j < jsMetas.length(); j++) { + object = (JSONObject) jsMetas.getJSONObject(j); + MetaData metaData = new MetaData(); + metaData.setContentByRemoteJSON(object); + if (metaData.isWorthSaving()) { + mMetaList.addChildTask(metaData); + if (metaData.getGid() != null) { + mMetaHashMap.put(metaData.getRelatedGid(), metaData); + } + } + } + } + } + + // create meta list if not existed + if (mMetaList == null) { + mMetaList = new TaskList(); + mMetaList.setName(GTaskStringUtils.MIUI_FOLDER_PREFFIX + + GTaskStringUtils.FOLDER_META); + GTaskClient.getInstance().createTaskList(mMetaList); + } + + // init task list + for (int i = 0; i < jsTaskLists.length(); i++) { + JSONObject object = jsTaskLists.getJSONObject(i); + String gid = object.getString(GTaskStringUtils.GTASK_JSON_ID); + String name = object.getString(GTaskStringUtils.GTASK_JSON_NAME); + + if (name.startsWith(GTaskStringUtils.MIUI_FOLDER_PREFFIX) + && !name.equals(GTaskStringUtils.MIUI_FOLDER_PREFFIX + + GTaskStringUtils.FOLDER_META)) { + TaskList tasklist = new TaskList(); + tasklist.setContentByRemoteJSON(object); + mGTaskListHashMap.put(gid, tasklist); + mGTaskHashMap.put(gid, tasklist); + + // load tasks + JSONArray jsTasks = client.getTaskList(gid); + for (int j = 0; j < jsTasks.length(); j++) { + object = (JSONObject) jsTasks.getJSONObject(j); + gid = object.getString(GTaskStringUtils.GTASK_JSON_ID); + Task task = new Task(); + task.setContentByRemoteJSON(object); + if (task.isWorthSaving()) { + task.setMetaInfo(mMetaHashMap.get(gid)); + tasklist.addChildTask(task); + mGTaskHashMap.put(gid, task); + } + } + } + } + } catch (JSONException e) { + Log.e(TAG, e.toString()); + e.printStackTrace(); + throw new ActionFailureException("initGTaskList: handing JSONObject failed"); + } + } + + //选择同步操作的类型并做好相应准备 具体做法是对每一种情况都把所有的任务判断一次，一旦发现是该种情况，就立即执行任务，否则判断下个任务 + private void syncContent() throws NetworkFailureException { + int syncType; + Cursor c = null; + String gid; + Node node; + + mLocalDeleteIdMap.clear(); + + if (mCancelled) { + return; + } + + // for local deleted note + //处理本地删除的note + try { + c = mContentResolver.query(Notes.CONTENT_NOTE_URI, SqlNote.PROJECTION_NOTE, + "(type<>? AND parent_id=?)", new String[] { + String.valueOf(Notes.TYPE_SYSTEM), String.valueOf(Notes.ID_TRASH_FOLER) + }, null); + if (c != null) { + while (c.moveToNext()) { + gid = c.getString(SqlNote.GTASK_ID_COLUMN); + node = mGTaskHashMap.get(gid); + if (node != null) { + mGTaskHashMap.remove(gid); + doContentSync(Node.SYNC_ACTION_DEL_REMOTE, node, c); + } + + mLocalDeleteIdMap.add(c.getLong(SqlNote.ID_COLUMN)); + } + } else { + Log.w(TAG, "failed to query trash folder"); + } + } finally { + if (c != null) { + c.close(); + c = null; + } + } + + // sync folder first + syncFolder(); + + // for note existing in database + //对已经存在与数据库的节点进行同步 + try { + c = mContentResolver.query(Notes.CONTENT_NOTE_URI, SqlNote.PROJECTION_NOTE, + "(type=? AND parent_id<>?)", new String[] { + String.valueOf(Notes.TYPE_NOTE), String.valueOf(Notes.ID_TRASH_FOLER) + }, NoteColumns.TYPE + " DESC"); + if (c != null) { + while (c.moveToNext()) { + gid = c.getString(SqlNote.GTASK_ID_COLUMN); + node = mGTaskHashMap.get(gid); + if (node != null) { + mGTaskHashMap.remove(gid); + mGidToNid.put(gid, c.getLong(SqlNote.ID_COLUMN)); + mNidToGid.put(c.getLong(SqlNote.ID_COLUMN), gid); + syncType = node.getSyncAction(c); + } else { + if (c.getString(SqlNote.GTASK_ID_COLUMN).trim().length() == 0) { + // local add + syncType = Node.SYNC_ACTION_ADD_REMOTE; + } else { + // remote delete + syncType = Node.SYNC_ACTION_DEL_LOCAL; + } + } + doContentSync(syncType, node, c); + } + } else { + Log.w(TAG, "failed to query existing note in database"); + } + + } finally { + if (c != null) { + c.close(); + c = null; + } + } + + // go through remaining items + //访问保留的项目 + Iterator> iter = mGTaskHashMap.entrySet().iterator(); + while (iter.hasNext()) { + Map.Entry entry = iter.next(); + node = entry.getValue(); + doContentSync(Node.SYNC_ACTION_ADD_LOCAL, node, null); + } + + // mCancelled can be set by another thread, so we neet to check one by + // one + // clear local delete table + //清除本地删除的表格 + if (!mCancelled) { + if (!DataUtils.batchDeleteNotes(mContentResolver, mLocalDeleteIdMap)) { + throw new ActionFailureException("failed to batch-delete local deleted notes"); + } + } + + // refresh local sync id + if (!mCancelled) { + GTaskClient.getInstance().commitUpdate(); + refreshLocalSyncId(); + } + + } + + //对文件夹进行同步，具体操作与之前的同步操作一致 + private void syncFolder() throws NetworkFailureException { + Cursor c = null; + String gid; + Node node; + int syncType; + + if (mCancelled) { + return; + } + + // for root folder + //同步根目录 + try { + c = mContentResolver.query(ContentUris.withAppendedId(Notes.CONTENT_NOTE_URI, + Notes.ID_ROOT_FOLDER), SqlNote.PROJECTION_NOTE, null, null, null); + if (c != null) { + c.moveToNext(); + gid = c.getString(SqlNote.GTASK_ID_COLUMN); + node = mGTaskHashMap.get(gid); + if (node != null) { + mGTaskHashMap.remove(gid); + mGidToNid.put(gid, (long) Notes.ID_ROOT_FOLDER); + mNidToGid.put((long) Notes.ID_ROOT_FOLDER, gid); + // for system folder, only update remote name if necessary + if (!node.getName().equals( + GTaskStringUtils.MIUI_FOLDER_PREFFIX + GTaskStringUtils.FOLDER_DEFAULT)) + doContentSync(Node.SYNC_ACTION_UPDATE_REMOTE, node, c); + } else { + doContentSync(Node.SYNC_ACTION_ADD_REMOTE, node, c); + } + } else { + Log.w(TAG, "failed to query root folder"); + } + } finally { + if (c != null) { + c.close(); + c = null; + } + } + + // for call-note folder + //同步来电记录的文件夹 + try { + c = mContentResolver.query(Notes.CONTENT_NOTE_URI, SqlNote.PROJECTION_NOTE, "(_id=?)", + new String[] { + String.valueOf(Notes.ID_CALL_RECORD_FOLDER) + }, null); + if (c != null) { + if (c.moveToNext()) { + gid = c.getString(SqlNote.GTASK_ID_COLUMN); + node = mGTaskHashMap.get(gid); + if (node != null) { + mGTaskHashMap.remove(gid); + mGidToNid.put(gid, (long) Notes.ID_CALL_RECORD_FOLDER); + mNidToGid.put((long) Notes.ID_CALL_RECORD_FOLDER, gid); + // for system folder, only update remote name if + // necessary + if (!node.getName().equals( + GTaskStringUtils.MIUI_FOLDER_PREFFIX + + GTaskStringUtils.FOLDER_CALL_NOTE)) + doContentSync(Node.SYNC_ACTION_UPDATE_REMOTE, node, c); + } else { + doContentSync(Node.SYNC_ACTION_ADD_REMOTE, node, c); + } + } + } else { + Log.w(TAG, "failed to query call note folder"); + } + } finally { + if (c != null) { + c.close(); + c = null; + } + } + + // for local existing folders + //同步已经存在的文件夹 + try { + c = mContentResolver.query(Notes.CONTENT_NOTE_URI, SqlNote.PROJECTION_NOTE, + "(type=? AND parent_id<>?)", new String[] { + String.valueOf(Notes.TYPE_FOLDER), String.valueOf(Notes.ID_TRASH_FOLER) + }, NoteColumns.TYPE + " DESC"); + if (c != null) { + while (c.moveToNext()) { + gid = c.getString(SqlNote.GTASK_ID_COLUMN); + node = mGTaskHashMap.get(gid); + if (node != null) { + mGTaskHashMap.remove(gid); + mGidToNid.put(gid, c.getLong(SqlNote.ID_COLUMN)); + mNidToGid.put(c.getLong(SqlNote.ID_COLUMN), gid); + syncType = node.getSyncAction(c); + } else { + if (c.getString(SqlNote.GTASK_ID_COLUMN).trim().length() == 0) { + // local add + syncType = Node.SYNC_ACTION_ADD_REMOTE; + } else { + // remote delete + syncType = Node.SYNC_ACTION_DEL_LOCAL; + } + } + doContentSync(syncType, node, c); + } + } else { + Log.w(TAG, "failed to query existing folder"); + } + } finally { + if (c != null) { + c.close(); + c = null; + } + } + + // for remote add folders + //同步远程添加的文件夹 + Iterator> iter = mGTaskListHashMap.entrySet().iterator(); + while (iter.hasNext()) { + Map.Entry entry = iter.next(); + gid = entry.getKey(); + node = entry.getValue(); + if (mGTaskHashMap.containsKey(gid)) { + mGTaskHashMap.remove(gid); + doContentSync(Node.SYNC_ACTION_ADD_LOCAL, node, null); + } + } + + if (!mCancelled) + GTaskClient.getInstance().commitUpdate(); + } + + //在之前对于各方面的同步操作中多次调用了这个函数，作用是依据不同的同步类型去调用不同的函数，以达到本地与远程同步的实际操作 + private void doContentSync(int syncType, Node node, Cursor c) throws NetworkFailureException { + if (mCancelled) { + return; + } + + MetaData meta; + switch (syncType) { + case Node.SYNC_ACTION_ADD_LOCAL: + addLocalNode(node); + break; + case Node.SYNC_ACTION_ADD_REMOTE: + addRemoteNode(node, c); + break; + case Node.SYNC_ACTION_DEL_LOCAL: + meta = mMetaHashMap.get(c.getString(SqlNote.GTASK_ID_COLUMN)); + if (meta != null) { + GTaskClient.getInstance().deleteNode(meta); + } + mLocalDeleteIdMap.add(c.getLong(SqlNote.ID_COLUMN)); + break; + case Node.SYNC_ACTION_DEL_REMOTE: + meta = mMetaHashMap.get(node.getGid()); + if (meta != null) { + GTaskClient.getInstance().deleteNode(meta); + } + GTaskClient.getInstance().deleteNode(node); + break; + case Node.SYNC_ACTION_UPDATE_LOCAL: + updateLocalNode(node, c); + break; + case Node.SYNC_ACTION_UPDATE_REMOTE: + updateRemoteNode(node, c); + break; + case Node.SYNC_ACTION_UPDATE_CONFLICT: + // merging both modifications maybe a good idea + // right now just use local update simply + updateRemoteNode(node, c); + break; + case Node.SYNC_ACTION_NONE: + break; + case Node.SYNC_ACTION_ERROR: + default: + throw new ActionFailureException("unkown sync action type"); + } + } + + //增加本地节点的操作，传入参量为待增添的节点 + private void addLocalNode(Node node) throws NetworkFailureException { + if (mCancelled) { + return; + } + + SqlNote sqlNote; + //若待添加节点是任务列表中的节点，则进行操作，若待增添节点不是任务列表中的节点，进一步操作 + if (node instanceof TaskList) { + if (node.getName().equals( + GTaskStringUtils.MIUI_FOLDER_PREFFIX + GTaskStringUtils.FOLDER_DEFAULT)) { + sqlNote = new SqlNote(mContext, Notes.ID_ROOT_FOLDER); + } else if (node.getName().equals( + GTaskStringUtils.MIUI_FOLDER_PREFFIX + GTaskStringUtils.FOLDER_CALL_NOTE)) { + sqlNote = new SqlNote(mContext, Notes.ID_CALL_RECORD_FOLDER); + } else { + sqlNote = new SqlNote(mContext); + sqlNote.setContent(node.getLocalJSONFromContent()); + sqlNote.setParentId(Notes.ID_ROOT_FOLDER); + } + } else { + sqlNote = new SqlNote(mContext); + JSONObject js = node.getLocalJSONFromContent(); + try { + if (js.has(GTaskStringUtils.META_HEAD_NOTE)) { + JSONObject note = js.getJSONObject(GTaskStringUtils.META_HEAD_NOTE); + if (note.has(NoteColumns.ID)) { + long id = note.getLong(NoteColumns.ID); + if (DataUtils.existInNoteDatabase(mContentResolver, id)) { + // the id is not available, have to create a new one + note.remove(NoteColumns.ID); + } + } + } + + //以下为判断便签中的数据条目 + if (js.has(GTaskStringUtils.META_HEAD_DATA)) { + JSONArray dataArray = js.getJSONArray(GTaskStringUtils.META_HEAD_DATA); + for (int i = 0; i < dataArray.length(); i++) { + JSONObject data = dataArray.getJSONObject(i); + if (data.has(DataColumns.ID)) { + long dataId = data.getLong(DataColumns.ID); + if (DataUtils.existInDataDatabase(mContentResolver, dataId)) { + // the data id is not available, have to create + // a new one + data.remove(DataColumns.ID); + } + } + } + + } + } catch (JSONException e) { + Log.w(TAG, e.toString()); + e.printStackTrace(); + } + sqlNote.setContent(js); + + Long parentId = mGidToNid.get(((Task) node).getParent().getGid()); + if (parentId == null) { + Log.e(TAG, "cannot find task's parent id locally"); + throw new ActionFailureException("cannot add local node"); + } + sqlNote.setParentId(parentId.longValue()); + } + + // create the local node + //把getGid()获取的node节点Gid，用于设置本地Gtask的ID，然后更新本地便签 + sqlNote.setGtaskId(node.getGid()); + sqlNote.commit(false); + + // update gid-nid mapping + //更新gid与nid的映射表 + mGidToNid.put(node.getGid(), sqlNote.getId()); + mNidToGid.put(sqlNote.getId(), node.getGid()); + + // update meta + //更新本地节点 + updateRemoteMeta(node.getGid(), sqlNote); + } + + //更新本地节点，两个传入参数，一个是待更新的节点，一个是指向待增加位置的指针 + private void updateLocalNode(Node node, Cursor c) throws NetworkFailureException { + if (mCancelled) { + return; + } + + SqlNote sqlNote; + // update the note locally + sqlNote = new SqlNote(mContext, c); + sqlNote.setContent(node.getLocalJSONFromContent()); + + Long parentId = (node instanceof Task) ? mGidToNid.get(((Task) node).getParent().getGid()) + : new Long(Notes.ID_ROOT_FOLDER); + if (parentId == null) { + Log.e(TAG, "cannot find task's parent id locally"); + throw new ActionFailureException("cannot update local node"); + } + sqlNote.setParentId(parentId.longValue()); + sqlNote.commit(true); + + // update meta info + //升级meta + updateRemoteMeta(node.getGid(), sqlNote); + } + + //这个函数是添加远程结点，参数node是要添加远程结点的本地结点，c是数据库的指针 + private void addRemoteNode(Node node, Cursor c) throws NetworkFailureException { + if (mCancelled) { + return; + } + + SqlNote sqlNote = new SqlNote(mContext, c); + Node n; + + // update remotely + // 如果sqlNote是节点类型，则设置好它的参数以及更新哈希表，再把节点更新到远程数据里 + if (sqlNote.isNoteType()) { + Task task = new Task(); + task.setContentByLocalJSON(sqlNote.getContent()); + + String parentGid = mNidToGid.get(sqlNote.getParentId()); + if (parentGid == null) { + Log.e(TAG, "cannot find task's parent tasklist"); + throw new ActionFailureException("cannot add remote task"); + } + mGTaskListHashMap.get(parentGid).addChildTask(task); + + GTaskClient.getInstance().createTask(task); + n = (Node) task; + + // add meta + updateRemoteMeta(task.getGid(), sqlNote); + } else { + TaskList tasklist = null; + + // we need to skip folder if it has already existed + //当文件夹存在则跳过，若不存在则创建新的文件夹 + String folderName = GTaskStringUtils.MIUI_FOLDER_PREFFIX; + if (sqlNote.getId() == Notes.ID_ROOT_FOLDER) + folderName += GTaskStringUtils.FOLDER_DEFAULT; + else if (sqlNote.getId() == Notes.ID_CALL_RECORD_FOLDER) + folderName += GTaskStringUtils.FOLDER_CALL_NOTE; + else + folderName += sqlNote.getSnippet(); + + Iterator> iter = mGTaskListHashMap.entrySet().iterator(); + while (iter.hasNext()) { + Map.Entry entry = iter.next(); + String gid = entry.getKey(); + TaskList list = entry.getValue(); + + if (list.getName().equals(folderName)) { + tasklist = list; + if (mGTaskHashMap.containsKey(gid)) { + mGTaskHashMap.remove(gid); + } + break; + } + } + + // no match we can add now + //若没有匹配的任务列表，则创建一个新的任务列表 + if (tasklist == null) { + tasklist = new TaskList(); + tasklist.setContentByLocalJSON(sqlNote.getContent()); + GTaskClient.getInstance().createTaskList(tasklist); + mGTaskListHashMap.put(tasklist.getGid(), tasklist); + } + n = (Node) tasklist; + } + + // update local note + //进行本地节点的更新 + sqlNote.setGtaskId(n.getGid()); + sqlNote.commit(false); + sqlNote.resetLocalModified(); + sqlNote.commit(true); + + // gid-id mapping + //进行gid与nid映射关系的更新 + mGidToNid.put(n.getGid(), sqlNote.getId()); + mNidToGid.put(sqlNote.getId(), n.getGid()); + } + + //更新远程结点，node是要更新的结点，c是数据库的指针 + private void updateRemoteNode(Node node, Cursor c) throws NetworkFailureException { + if (mCancelled) { + return; + } + + SqlNote sqlNote = new SqlNote(mContext, c); + + // update remotely + //远程更新 + node.setContentByLocalJSON(sqlNote.getContent()); + GTaskClient.getInstance().addUpdateNode(node); + + // update meta + //更新元数据 + updateRemoteMeta(node.getGid(), sqlNote); + + // move task if necessary + //判断节点类型是否符合要求 + if (sqlNote.isNoteType()) { + Task task = (Task) node; + TaskList preParentList = task.getParent(); + + String curParentGid = mNidToGid.get(sqlNote.getParentId()); + if (curParentGid == null) { + Log.e(TAG, "cannot find task's parent tasklist"); + throw new ActionFailureException("cannot update remote task"); + } + TaskList curParentList = mGTaskListHashMap.get(curParentGid); + + if (preParentList != curParentList) { + preParentList.removeChildTask(task); + curParentList.addChildTask(task); + GTaskClient.getInstance().moveTask(task, preParentList, curParentList); + } + } + + // clear local modified flag + //清除本地修改标记 + sqlNote.resetLocalModified(); + sqlNote.commit(true); + } + + //更新远程的元数据节点 + private void updateRemoteMeta(String gid, SqlNote sqlNote) throws NetworkFailureException { + if (sqlNote != null && sqlNote.isNoteType()) { + MetaData metaData = mMetaHashMap.get(gid); + if (metaData != null) { + metaData.setMeta(gid, sqlNote.getContent()); + GTaskClient.getInstance().addUpdateNode(metaData); + } else { + metaData = new MetaData(); + metaData.setMeta(gid, sqlNote.getContent()); + mMetaList.addChildTask(metaData); + mMetaHashMap.put(gid, metaData); + GTaskClient.getInstance().createTask(metaData); + } + } + } + + //刷新本地便签ID，从远程同步 + private void refreshLocalSyncId() throws NetworkFailureException { + if (mCancelled) { + return; + } + + // get the latest gtask list + mGTaskHashMap.clear(); + mGTaskListHashMap.clear(); + mMetaHashMap.clear(); + initGTaskList(); + + Cursor c = null; + //query语句：五个参数，NoteColumns.TYPE + " DESC"-----为按类型递减顺序返回查询结果。 + // newString[{String.valueOf(Notes.TYPE_SYSTEM),String.valueOf(Notes.ID_TRASH_FOLER)} + //------ 为选择参数。"(type<>? AND parent_id<>?)"-------指明返回行过滤器。SqlNote.PROJECTION_NOTE + //-------- 应返回的数据列的名字。Notes.CONTENT_NOTE_URI--------contentProvider包含所有数据集所对应的uri + try { + c = mContentResolver.query(Notes.CONTENT_NOTE_URI, SqlNote.PROJECTION_NOTE, + "(type<>? AND parent_id<>?)", new String[] { + String.valueOf(Notes.TYPE_SYSTEM), String.valueOf(Notes.ID_TRASH_FOLER) + }, NoteColumns.TYPE + " DESC"); + if (c != null) { + while (c.moveToNext()) { + String gid = c.getString(SqlNote.GTASK_ID_COLUMN); + Node node = mGTaskHashMap.get(gid); + if (node != null) { + mGTaskHashMap.remove(gid); + ContentValues values = new ContentValues(); + values.put(NoteColumns.SYNC_ID, node.getLastModified()); + mContentResolver.update(ContentUris.withAppendedId(Notes.CONTENT_NOTE_URI, + c.getLong(SqlNote.ID_COLUMN)), values, null, null); + } else { + Log.e(TAG, "something is missed"); + throw new ActionFailureException( + "some local items don't have gid after sync"); + } + } + } else { + Log.w(TAG, "failed to query local note to refresh sync id"); + } + } finally { + if (c != null) { + c.close(); + c = null; + } + } + } + + //string类化getSyncAccount() + public String getSyncAccount() { + return GTaskClient.getInstance().getSyncAccount().name; + } + + //取消同步，置mCancelled为true + public void cancelSync() { + mCancelled = true; + } +} diff --git a/other/07_210340172杨馥银_代码标注/remote/GTaskSyncService.java b/other/07_210340172杨馥银_代码标注/remote/GTaskSyncService.java new file mode 100644 index 0000000..4af3e5e --- /dev/null +++ b/other/07_210340172杨馥银_代码标注/remote/GTaskSyncService.java @@ -0,0 +1,148 @@ +/* + * 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.gtask.remote; + +import android.app.Activity; +import android.app.Service; +import android.content.Context; +import android.content.Intent; +import android.os.Bundle; +import android.os.IBinder; + +//由Service组件扩展而来，作用是提供GTask的同步服务 +public class GTaskSyncService extends Service { + //定义了一系列静态变量，用来表示同步操作的状态。 + public final static String ACTION_STRING_NAME = "sync_action_type"; + + //用数字0、1、2分别表示开始同步、取消同步、同步无效 + public final static int ACTION_START_SYNC = 0; + + public final static int ACTION_CANCEL_SYNC = 1; + + public final static int ACTION_INVALID = 2; + + //服务广播的名称 + public final static String GTASK_SERVICE_BROADCAST_NAME = "net.micode.notes.gtask.remote.gtask_sync_service"; + + //表示广播正在同步 + public final static String GTASK_SERVICE_BROADCAST_IS_SYNCING = "isSyncing"; + + //GTask 广播服务消息 + public final static String GTASK_SERVICE_BROADCAST_PROGRESS_MSG = "progressMsg"; + + private static GTaskASyncTask mSyncTask = null; + + private static String mSyncProgress = ""; + + //开始一个同步工作 + private void startSync() { + //若当前没有同步工作，申请一个task并把指针指向新任务，广播后执行 + if (mSyncTask == null) { + mSyncTask = new GTaskASyncTask(this, new GTaskASyncTask.OnCompleteListener() { + public void onComplete() { + mSyncTask = null; + sendBroadcast(""); + stopSelf(); + } + }); + sendBroadcast(""); + mSyncTask.execute(); + } + } + + //取消同步 + private void cancelSync() { + // 如果有同步任务，则取消 + if (mSyncTask != null) { + mSyncTask.cancelSync(); + } + } + + @Override + //初始化任务，直接把mSyncTask指针的值置为空 + public void onCreate() { + mSyncTask = null; + } + + @Override + //onStartCommand会告诉系统如何重启服务，如判断是否异常终止后重新启动，在何种情况下异常终止。返回值是一个(int)整形，有四种返回值。参数的flags表示启动服务的方式 + public int onStartCommand(Intent intent, int flags, int startId) { + Bundle bundle = intent.getExtras(); + //判断当前的同步状态，根据开始或取消，执行对应操作 + if (bundle != null && bundle.containsKey(ACTION_STRING_NAME)) { + switch (bundle.getInt(ACTION_STRING_NAME, ACTION_INVALID)) { + case ACTION_START_SYNC: + startSync(); + break; + case ACTION_CANCEL_SYNC: + cancelSync(); + break; + default: + break; + } + return START_STICKY; + } + return super.onStartCommand(intent, flags, startId); + } + + @Override + //发送广播 + public void onLowMemory() { + if (mSyncTask != null) { + mSyncTask.cancelSync(); + } + } + + //用于绑定操作的函数 + public IBinder onBind(Intent intent) { + return null; + } + + //发送广播内容 + public void sendBroadcast(String msg) { + mSyncProgress = msg; + Intent intent = new Intent(GTASK_SERVICE_BROADCAST_NAME); + intent.putExtra(GTASK_SERVICE_BROADCAST_IS_SYNCING, mSyncTask != null); + intent.putExtra(GTASK_SERVICE_BROADCAST_PROGRESS_MSG, msg); + sendBroadcast(intent); + } + + //对变量activity事件进行同步操作 + public static void startSync(Activity activity) { + GTaskManager.getInstance().setActivityContext(activity); + Intent intent = new Intent(activity, GTaskSyncService.class); + intent.putExtra(GTaskSyncService.ACTION_STRING_NAME, GTaskSyncService.ACTION_START_SYNC); + activity.startService(intent); + } + + //取消同步 + public static void cancelSync(Context context) { + Intent intent = new Intent(context, GTaskSyncService.class); + intent.putExtra(GTaskSyncService.ACTION_STRING_NAME, GTaskSyncService.ACTION_CANCEL_SYNC); + context.startService(intent); + } + + //判断当前是否处于同步状态 + public static boolean isSyncing() { + return mSyncTask != null; + } + + //返回当前同步状态 + public static String getProgressString() { + return mSyncProgress; + } +} diff --git a/other/07_210340180张旭_代码标注/data/Contact.java b/other/07_210340180张旭_代码标注/data/Contact.java new file mode 100644 index 0000000..708ea9f --- /dev/null +++ b/other/07_210340180张旭_代码标注/data/Contact.java @@ -0,0 +1,76 @@ +/* + * 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.data; + +import android.content.Context; +import android.database.Cursor; +import android.provider.ContactsContract.CommonDataKinds.Phone; +import android.provider.ContactsContract.Data; +import android.telephony.PhoneNumberUtils; +import android.util.Log; + +import java.util.HashMap; + +public class Contact { + //联系人数据库 + /*hashmap是一系列的键-值队（以键查找值），hashmap的特点是：无序，键不重复 是泛型的概念，这里意思是，键是字符串，值也是字符串*/ + private static HashMap sContactCache;//创建实体类来存储所写联系人信息 + private static final String TAG = "Contact";//定义该类的名称 + private static final String CALLER_ID_SELECTION = "PHONE_NUMBERS_EQUAL(" + Phone.NUMBER + + ",?) AND " + Data.MIMETYPE + "='" + Phone.CONTENT_ITEM_TYPE + "'" + + " AND " + Data.RAW_CONTACT_ID + " IN " + + "(SELECT raw_contact_id " + + " FROM phone_lookup" + + " WHERE min_match = '+')";//在数据库中查找电话号码 + public static String getContact(Context context, String phoneNumber) { + if(sContactCache == null) { + //创建实体类缓存列表 + sContactCache = new HashMap(); + } + if(sContactCache.containsKey(phoneNumber)) { + //如果在数据库中包含此键值则返回电话号码 + return sContactCache.get(phoneNumber); + } + //toCallerIDMinMatch是安卓自带的号码匹配工具，截取查询号码的后7位作为匹配依据 + String selection = CALLER_ID_SELECTION.replace("+", + PhoneNumberUtils.toCallerIDMinMatch(phoneNumber)); + //cursor类是对数据库的操作，获取整行的数据，从数据库中查询联系人内容 + Cursor cursor = context.getContentResolver().query( + Data.CONTENT_URI,//数据储存的地址 + new String [] { Phone.DISPLAY_NAME }, + selection, + new String[] { phoneNumber }, + null); + if (cursor != null && cursor.moveToFirst()) { + //若数据库存在，则游标移动到游标所表示的信息元组的第一行开始 + try { + String name = cursor.getString(0); + sContactCache.put(phoneNumber, name);//把找到的联系人电话和名字移到缓存列表中 + return name; + } catch (IndexOutOfBoundsException e) { + Log.e(TAG, " Cursor get string error " + e.toString());//异常处理 + return null; + } finally { + cursor.close();//关闭数据库的访问 + } + } else { + //数据库不存在或没找到此联系电话 + Log.d(TAG, "No contact matched with number:" + phoneNumber); + return null; + } + } +} diff --git a/other/07_210340180张旭_代码标注/data/Notes.java b/other/07_210340180张旭_代码标注/data/Notes.java new file mode 100644 index 0000000..b3aa269 --- /dev/null +++ b/other/07_210340180张旭_代码标注/data/Notes.java @@ -0,0 +1,292 @@ +/* + * 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.data; +/*uri是统一资源标志符（Uniform Resource Identifier），而在这个类中定义了各种Uri常量， +以便在其他的类中调用。Uri用处很多，涉及到安卓权限，比如通过Uri可以： +直接拨打电话、调出拨打电话界面、调WEB浏览器、卸载、安装、播放、调用发邮件、直接发邮件等系统功能 +Android上可用的每种资源 -包括 图像、视频片段、音频资源等都可以用Uri来表示*/ +import android.net.Uri; +public class Notes { + /*便签数据库,该类主要实现了对便签的相关属性包括：Anthority, Tag，以及数据，联系人的信息进行保存管理， + 其中主要实现了对若干属性的定义，并创建了DataColumns，DataColumns接口的定义，该两个接口可用于其余类的实现， + 在便签管理中实现TextNote,CallNote两个类，用于对便签内容的保存。*/ + public static final String AUTHORITY = "micode_notes";//定义了一个权限名，这里是为了符合Uri的格式而定义的。 + public static final String TAG = "Notes";//定义该类的名称 + public static final int TYPE_NOTE = 0;//Note的类型，这里规定了三种；普通Note， + public static final int TYPE_FOLDER = 1;//文件夹Folder， + public static final int TYPE_SYSTEM = 2;//系统文件System + + /** + * Following IDs are system folders' identifiers（下列ID是系统文件的标识） + * {@link Notes#ID_ROOT_FOLDER } is default folder（根目录（默认文件夹）） + * {@link Notes#ID_TEMPARAY_FOLDER } is for notes belonging no folder（临时文件夹） + * {@link Notes#ID_CALL_RECORD_FOLDER} is to store call records（通话记录文件夹） + * {@link Notes#ID_TRASH_FOLER}（垃圾文件夹） + */ + public static final int ID_ROOT_FOLDER = 0; + public static final int ID_TEMPARAY_FOLDER = -1; + public static final int ID_CALL_RECORD_FOLDER = -2; + public static final int ID_TRASH_FOLER = -3; + //下列是各个文件夹名称标识，定义各种小部件（widget） + public static final String INTENT_EXTRA_ALERT_DATE = "net.micode.notes.alert_date"; + public static final String INTENT_EXTRA_BACKGROUND_ID = "net.micode.notes.background_color_id"; + public static final String INTENT_EXTRA_WIDGET_ID = "net.micode.notes.widget_id"; + public static final String INTENT_EXTRA_WIDGET_TYPE = "net.micode.notes.widget_type"; + public static final String INTENT_EXTRA_FOLDER_ID = "net.micode.notes.folder_id"; + public static final String INTENT_EXTRA_CALL_DATE = "net.micode.notes.call_date"; + + public static final int TYPE_WIDGET_INVALIDE = -1;//定义查询便签和文件夹的指针 + public static final int TYPE_WIDGET_2X = 0;//2*2小部件 + public static final int TYPE_WIDGET_4X = 1;//4*4小部件 + + public static class DataConstants { + //存放textnotes和callnotes地址 + public static final String NOTE = TextNote.CONTENT_ITEM_TYPE; + public static final String CALL_NOTE = CallNote.CONTENT_ITEM_TYPE; + } + + /** + * Uri to query all notes and folders（统一资源标识符查询便签和文件夹） + */ + public static final Uri CONTENT_NOTE_URI = Uri.parse("content://" + AUTHORITY + "/note"); + + /** + * Uri to query data（统一资源标识符查询数据） + */ + public static final Uri CONTENT_DATA_URI = Uri.parse("content://" + AUTHORITY + "/data"); + + public interface NoteColumns { + //定义NoteColumns的常量,用于后面创建数据库的表头，定义Note的一系列属性 + /** + * The unique ID for a row（主键） + *

Type: INTEGER (long)

+ */ + public static final String ID = "_id"; + + /** + * The parent's id for note or folder + *

Type: INTEGER (long)

+ */ + public static final String PARENT_ID = "parent_id";//父节点id + + /** + * Created data for note or folder + *

Type: INTEGER (long)

+ */ + public static final String CREATED_DATE = "created_date"; + + /** + * Latest modified date + *

Type: INTEGER (long)

+ */ + public static final String MODIFIED_DATE = "modified_date";//更新日期 + + + /** + * Alert date + *

Type: INTEGER (long)

+ */ + public static final String ALERTED_DATE = "alert_date";//更改日期 + + /** + * Folder's name or text content of note + *

Type: TEXT

+ */ + public static final String SNIPPET = "snippet"; + + /** + * Note's widget id + *

Type: INTEGER (long)

+ */ + public static final String WIDGET_ID = "widget_id"; + + /** + * Note's widget type + *

Type: INTEGER (long)

+ */ + public static final String WIDGET_TYPE = "widget_type"; + + /** + * Note's background color's id + *

Type: INTEGER (long)

+ */ + public static final String BG_COLOR_ID = "bg_color_id"; + + /** + * For text note, it doesn't has attachment, for multi-media + * note, it has at least one attachment + *

Type: INTEGER

+ */ + public static final String HAS_ATTACHMENT = "has_attachment";//是否有附件 + + /** + * Folder's count of notes + *

Type: INTEGER (long)

+ */ + public static final String NOTES_COUNT = "notes_count"; + + /** + * The file type: folder or note + *

Type: INTEGER

+ */ + public static final String TYPE = "type"; + + /** + * The last sync id + *

Type: INTEGER (long)

+ */ + public static final String SYNC_ID = "sync_id";//最后一次的同步id + + /** + * Sign to indicate（显示） local modified or not（本地是否修改过标识） + *

Type: INTEGER

+ */ + public static final String LOCAL_MODIFIED = "local_modified";//本地是否修改过 + + /** + * Original parent id before moving into temporary folder + *

Type : INTEGER

+ */ + public static final String ORIGIN_PARENT_ID = "origin_parent_id";//父节点id在移到临时文件夹之前 + + /** + * The gtask id + *

Type : TEXT

+ */ + public static final String GTASK_ID = "gtask_id";//后台任务的id + + /** + * The version code + *

Type : INTEGER (long)

+ */ + public static final String VERSION = "version";//版本号 + } + + public interface DataColumns { + //定义DataColumns的常量,用于后面创建数据库的表头。主要是定义存储便签数据内容 + /** + * The unique ID for a row + *

Type: INTEGER (long)

+ */ + public static final String ID = "_id";//每一行id + + /** + * The MIME type of the item represented by this row.（这行代表的mime类型） + *

Type: Text

+ */ + public static final String MIME_TYPE = "mime_type";//MIME类型能包含视频、图像、文本、音频、应用程序等数据 + + /** + * The reference id to note that this data belongs to + *

Type: INTEGER (long)

+ */ + public static final String NOTE_ID = "note_id";//标签id + + /** + * Created data for note or folder + *

Type: INTEGER (long)

+ */ + public static final String CREATED_DATE = "created_date";//创建时间 + + /** + * Latest modified date + *

Type: INTEGER (long)

+ */ + public static final String MODIFIED_DATE = "modified_date";//修改时间 + + /** + * Data's content + *

Type: TEXT

+ */ + public static final String CONTENT = "content";//内容 + + /*以下定义了五个常量*/ + /** + * Generic data column, the meaning is {@link #MIMETYPE} specific, used for + * integer data type + *

Type: INTEGER

+ */ + public static final String DATA1 = "data1"; + /** + * Generic data column, the meaning is {@link #MIMETYPE} specific, used for + * integer data type + *

Type: INTEGER

+ */ + public static final String DATA2 = "data2"; + + /** + * Generic data column, the meaning is {@link #MIMETYPE} specific, used for + * TEXT data type + *

Type: TEXT

+ */ + public static final String DATA3 = "data3"; + + /** + * Generic data column, the meaning is {@link #MIMETYPE} specific, used for + * TEXT data type + *

Type: TEXT

+ */ + public static final String DATA4 = "data4"; + + /** + * Generic data column, the meaning is {@link #MIMETYPE} specific, used for + * TEXT data type + *

Type: TEXT

+ */ + public static final String DATA5 = "data5"; + } + + public static final class TextNote implements DataColumns { + //文本标签实现DataColumns接口，继承上述所有常量 + /*模式指示文本是否处于检查列表模式 + 1：检查列表模式，0：正常模式*/ + /** + * Mode to indicate the text in check list mode or not + *

Type: Integer 1:check list mode 0: normal mode

+ */ + public static final String MODE = DATA1;//继承DATA1 + + public static final int MODE_CHECK_LIST = 1;//1：检查列表模式 + + public static final String CONTENT_TYPE = "vnd.android.cursor.dir/text_note";//内容类型 + + public static final String CONTENT_ITEM_TYPE = "vnd.android.cursor.item/text_note";//内容项目的类型 + + public static final Uri CONTENT_URI = Uri.parse("content://" + AUTHORITY + "/text_note");//content 的索引标识符 + } + + public static final class CallNote implements DataColumns { + //记录通话数据的表头 + /** + * Call date for this record + *

Type: INTEGER (long)

+ */ + public static final String CALL_DATE = DATA1;//通话日期 + + /** + * Phone number for this record + *

Type: TEXT

+ */ + public static final String PHONE_NUMBER = DATA3;//电话号码 + + public static final String CONTENT_TYPE = "vnd.android.cursor.dir/call_note";//内容类型 + + public static final String CONTENT_ITEM_TYPE = "vnd.android.cursor.item/call_note";//内容项目类型 + + public static final Uri CONTENT_URI = Uri.parse("content://" + AUTHORITY + "/call_note");//content 的索引标识符 + } +} diff --git a/other/07_210340180张旭_代码标注/data/NotesDatabaseHelper.java b/other/07_210340180张旭_代码标注/data/NotesDatabaseHelper.java new file mode 100644 index 0000000..02164f4 --- /dev/null +++ b/other/07_210340180张旭_代码标注/data/NotesDatabaseHelper.java @@ -0,0 +1,373 @@ +/* + * 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.data; + +import android.content.ContentValues; +import android.content.Context; +import android.database.sqlite.SQLiteDatabase; +import android.database.sqlite.SQLiteOpenHelper; +import android.util.Log; + +import net.micode.notes.data.Notes.DataColumns; +import net.micode.notes.data.Notes.DataConstants; +import net.micode.notes.data.Notes.NoteColumns; + +//数据库帮助类，用于辅助创建、处理数据库的条目 +public class NotesDatabaseHelper extends SQLiteOpenHelper { + private static final String DB_NAME = "note.db";//数据库名字 + + private static final int DB_VERSION = 4;//数据库版本 + + public interface TABLE { + //接口类，定义数据库表的便签和数据 + public static final String NOTE = "note"; + + public static final String DATA = "data"; + } + + private static final String TAG = "NotesDatabaseHelper";//定义该类的名称 + + private static NotesDatabaseHelper mInstance;//实例化对象 + //创建标签表表头并初始化 + private static final String CREATE_NOTE_TABLE_SQL = + "CREATE TABLE " + TABLE.NOTE + "(" + + NoteColumns.ID + " INTEGER PRIMARY KEY," + + NoteColumns.PARENT_ID + " INTEGER NOT NULL DEFAULT 0," + + NoteColumns.ALERTED_DATE + " INTEGER NOT NULL DEFAULT 0," + + NoteColumns.BG_COLOR_ID + " INTEGER NOT NULL DEFAULT 0," + + NoteColumns.CREATED_DATE + " INTEGER NOT NULL DEFAULT (strftime('%s','now') * 1000)," + + NoteColumns.HAS_ATTACHMENT + " INTEGER NOT NULL DEFAULT 0," + + NoteColumns.MODIFIED_DATE + " INTEGER NOT NULL DEFAULT (strftime('%s','now') * 1000)," + + NoteColumns.NOTES_COUNT + " INTEGER NOT NULL DEFAULT 0," + + NoteColumns.SNIPPET + " TEXT NOT NULL DEFAULT ''," + + NoteColumns.TYPE + " INTEGER NOT NULL DEFAULT 0," + + NoteColumns.WIDGET_ID + " INTEGER NOT NULL DEFAULT 0," + + NoteColumns.WIDGET_TYPE + " INTEGER NOT NULL DEFAULT -1," + + NoteColumns.SYNC_ID + " INTEGER NOT NULL DEFAULT 0," + + NoteColumns.LOCAL_MODIFIED + " INTEGER NOT NULL DEFAULT 0," + + NoteColumns.ORIGIN_PARENT_ID + " INTEGER NOT NULL DEFAULT 0," + + NoteColumns.GTASK_ID + " TEXT NOT NULL DEFAULT ''," + + NoteColumns.VERSION + " INTEGER NOT NULL DEFAULT 0" + + ")"; + //创建数据表表头并初始化 + private static final String CREATE_DATA_TABLE_SQL = + "CREATE TABLE " + TABLE.DATA + "(" + + DataColumns.ID + " INTEGER PRIMARY KEY," + + DataColumns.MIME_TYPE + " TEXT NOT NULL," + + DataColumns.NOTE_ID + " INTEGER NOT NULL DEFAULT 0," + + NoteColumns.CREATED_DATE + " INTEGER NOT NULL DEFAULT (strftime('%s','now') * 1000)," + + NoteColumns.MODIFIED_DATE + " INTEGER NOT NULL DEFAULT (strftime('%s','now') * 1000)," + + DataColumns.CONTENT + " TEXT NOT NULL DEFAULT ''," + + DataColumns.DATA1 + " INTEGER," + + DataColumns.DATA2 + " INTEGER," + + DataColumns.DATA3 + " TEXT NOT NULL DEFAULT ''," + + DataColumns.DATA4 + " TEXT NOT NULL DEFAULT ''," + + DataColumns.DATA5 + " TEXT NOT NULL DEFAULT ''" + + ")"; + //对数据表创建索引，以便签的ID作为数据库的ID，用来做数据库ID的索引 + private static final String CREATE_DATA_NOTE_ID_INDEX_SQL = + "CREATE INDEX IF NOT EXISTS note_id_index ON " + + TABLE.DATA + "(" + DataColumns.NOTE_ID + ");"; + + /** + * Increase folder's note count when move note to the folder + */ + //创建触发器当把便签移入文件夹时，文件夹的便签数量+1 + private static final String NOTE_INCREASE_FOLDER_COUNT_ON_UPDATE_TRIGGER = + "CREATE TRIGGER increase_folder_count_on_update "+ + " AFTER UPDATE OF " + NoteColumns.PARENT_ID + " ON " + TABLE.NOTE + + " BEGIN " + + " UPDATE " + TABLE.NOTE + + " SET " + NoteColumns.NOTES_COUNT + "=" + NoteColumns.NOTES_COUNT + " + 1" + + " WHERE " + NoteColumns.ID + "=new." + NoteColumns.PARENT_ID + ";" + + " END"; + + /** + * Decrease folder's note count when move note from folder + */ + //创建触发器当把便签移出文件夹时，减少文件夹的便签数量-1 + private static final String NOTE_DECREASE_FOLDER_COUNT_ON_UPDATE_TRIGGER = + "CREATE TRIGGER decrease_folder_count_on_update " + + " AFTER UPDATE OF " + NoteColumns.PARENT_ID + " ON " + TABLE.NOTE + + " BEGIN " + + " UPDATE " + TABLE.NOTE + + " SET " + NoteColumns.NOTES_COUNT + "=" + NoteColumns.NOTES_COUNT + "-1" + + " WHERE " + NoteColumns.ID + "=old." + NoteColumns.PARENT_ID + + " AND " + NoteColumns.NOTES_COUNT + ">0" + ";" + + " END"; + + /** + * Increase folder's note count when insert new note to the folder + */ + //创建触发器当把便签插入到文件夹时，文件夹的便签数量+1 + private static final String NOTE_INCREASE_FOLDER_COUNT_ON_INSERT_TRIGGER = + "CREATE TRIGGER increase_folder_count_on_insert " + + " AFTER INSERT ON " + TABLE.NOTE + + " BEGIN " + + " UPDATE " + TABLE.NOTE + + " SET " + NoteColumns.NOTES_COUNT + "=" + NoteColumns.NOTES_COUNT + " + 1" + + " WHERE " + NoteColumns.ID + "=new." + NoteColumns.PARENT_ID + ";" + + " END"; + + /** + * Decrease folder's note count when delete note from the folder + */ + //创建触发器当把便签从文件夹删除时，文件夹的便签数量-1 + private static final String NOTE_DECREASE_FOLDER_COUNT_ON_DELETE_TRIGGER = + "CREATE TRIGGER decrease_folder_count_on_delete " + + " AFTER DELETE ON " + TABLE.NOTE + + " BEGIN " + + " UPDATE " + TABLE.NOTE + + " SET " + NoteColumns.NOTES_COUNT + "=" + NoteColumns.NOTES_COUNT + "-1" + + " WHERE " + NoteColumns.ID + "=old." + NoteColumns.PARENT_ID + + " AND " + NoteColumns.NOTES_COUNT + ">0;" + + " END"; + + /** + * Update note's content when insert data with type {@link DataConstants#NOTE} + */ + //创建触发器，当向note插入数据时，更新note的内容，并更改表格内容 + private static final String DATA_UPDATE_NOTE_CONTENT_ON_INSERT_TRIGGER = + "CREATE TRIGGER update_note_content_on_insert " + + " AFTER INSERT ON " + TABLE.DATA + + " WHEN new." + DataColumns.MIME_TYPE + "='" + DataConstants.NOTE + "'" + + " BEGIN" + + " UPDATE " + TABLE.NOTE + + " SET " + NoteColumns.SNIPPET + "=new." + DataColumns.CONTENT + + " WHERE " + NoteColumns.ID + "=new." + DataColumns.NOTE_ID + ";" + + " END"; + + /** + * Update note's content when data with {@link DataConstants#NOTE} type has changed + */ + //创建触发器，当note数据改变时，更新note的内容，并更改表格内容 + private static final String DATA_UPDATE_NOTE_CONTENT_ON_UPDATE_TRIGGER = + "CREATE TRIGGER update_note_content_on_update " + + " AFTER UPDATE ON " + TABLE.DATA + + " WHEN old." + DataColumns.MIME_TYPE + "='" + DataConstants.NOTE + "'" + + " BEGIN" + + " UPDATE " + TABLE.NOTE + + " SET " + NoteColumns.SNIPPET + "=new." + DataColumns.CONTENT + + " WHERE " + NoteColumns.ID + "=new." + DataColumns.NOTE_ID + ";" + + " END"; + + /** + * Update note's content when data with {@link DataConstants#NOTE} type has deleted + */ + //创建触发器，当note数据被删除时，更新note的内容，并更改表格内容 + private static final String DATA_UPDATE_NOTE_CONTENT_ON_DELETE_TRIGGER = + "CREATE TRIGGER update_note_content_on_delete " + + " AFTER delete ON " + TABLE.DATA + + " WHEN old." + DataColumns.MIME_TYPE + "='" + DataConstants.NOTE + "'" + + " BEGIN" + + " UPDATE " + TABLE.NOTE + + " SET " + NoteColumns.SNIPPET + "=''" + + " WHERE " + NoteColumns.ID + "=old." + DataColumns.NOTE_ID + ";" + + " END"; + + /** + * Delete datas belong to note which has been deleted + */ + //创建触发器，删除已经被删除的便签的数据 + private static final String NOTE_DELETE_DATA_ON_DELETE_TRIGGER = + "CREATE TRIGGER delete_data_on_delete " + + " AFTER DELETE ON " + TABLE.NOTE + + " BEGIN" + + " DELETE FROM " + TABLE.DATA + + " WHERE " + DataColumns.NOTE_ID + "=old." + NoteColumns.ID + ";" + + " END"; + + /** + * Delete notes belong to folder which has been deleted + */ + //创建触发器，删除已经被删除的文件夹的便签 + private static final String FOLDER_DELETE_NOTES_ON_DELETE_TRIGGER = + "CREATE TRIGGER folder_delete_notes_on_delete " + + " AFTER DELETE ON " + TABLE.NOTE + + " BEGIN" + + " DELETE FROM " + TABLE.NOTE + + " WHERE " + NoteColumns.PARENT_ID + "=old." + NoteColumns.ID + ";" + + " END"; + + /** + * Move notes belong to folder which has been moved to trash folder + */ + //创建触发器，移出已近被移到垃圾文件夹中的便签 + private static final String FOLDER_MOVE_NOTES_ON_TRASH_TRIGGER = + "CREATE TRIGGER folder_move_notes_on_trash " + + " AFTER UPDATE ON " + TABLE.NOTE + + " WHEN new." + NoteColumns.PARENT_ID + "=" + Notes.ID_TRASH_FOLER + + " BEGIN" + + " UPDATE " + TABLE.NOTE + + " SET " + NoteColumns.PARENT_ID + "=" + Notes.ID_TRASH_FOLER + + " WHERE " + NoteColumns.PARENT_ID + "=old." + NoteColumns.ID + ";" + + " END"; + //构造函数，传入数据库的名称和版本 + public NotesDatabaseHelper(Context context) { + super(context, DB_NAME, null, DB_VERSION); + } + //创建数据库，并且自动执行create方法，并且定义了下面的属性。 + public void createNoteTable(SQLiteDatabase db) { + db.execSQL(CREATE_NOTE_TABLE_SQL); + reCreateNoteTableTriggers(db); + createSystemFolder(db); + Log.d(TAG, "note table has been created"); + } + //如果触发器存在则drop，然后再次创建触发器 + private void reCreateNoteTableTriggers(SQLiteDatabase db) { + db.execSQL("DROP TRIGGER IF EXISTS increase_folder_count_on_update"); + db.execSQL("DROP TRIGGER IF EXISTS decrease_folder_count_on_update"); + db.execSQL("DROP TRIGGER IF EXISTS decrease_folder_count_on_delete"); + db.execSQL("DROP TRIGGER IF EXISTS delete_data_on_delete"); + db.execSQL("DROP TRIGGER IF EXISTS increase_folder_count_on_insert"); + db.execSQL("DROP TRIGGER IF EXISTS folder_delete_notes_on_delete"); + db.execSQL("DROP TRIGGER IF EXISTS folder_move_notes_on_trash"); + + db.execSQL(NOTE_INCREASE_FOLDER_COUNT_ON_UPDATE_TRIGGER); + db.execSQL(NOTE_DECREASE_FOLDER_COUNT_ON_UPDATE_TRIGGER); + db.execSQL(NOTE_DECREASE_FOLDER_COUNT_ON_DELETE_TRIGGER); + db.execSQL(NOTE_DELETE_DATA_ON_DELETE_TRIGGER); + db.execSQL(NOTE_INCREASE_FOLDER_COUNT_ON_INSERT_TRIGGER); + db.execSQL(FOLDER_DELETE_NOTES_ON_DELETE_TRIGGER); + db.execSQL(FOLDER_MOVE_NOTES_ON_TRASH_TRIGGER); + } + //创建系统文件夹 + private void createSystemFolder(SQLiteDatabase db) { + ContentValues values = new ContentValues();//创建对象记录基本数据的值 + + /** + * call record foler for call notes（呼叫记录文件夹） + */ + values.put(NoteColumns.ID, Notes.ID_CALL_RECORD_FOLDER);//放入数据(NoteColumns的id,呼叫记录文件夹的ld） + values.put(NoteColumns.TYPE, Notes.TYPE_SYSTEM);//将note的文件夹类型，与要放入数据库记录的格式类型映射，形成values的键-值 + db.insert(TABLE.NOTE, null, values);//向数据库的note表中插入数据 + + /** + * root folder which is default folder（默认文件夹） + */ + values.clear();//清空值且以下步骤与上述相同 + values.put(NoteColumns.ID, Notes.ID_ROOT_FOLDER); + values.put(NoteColumns.TYPE, Notes.TYPE_SYSTEM); + db.insert(TABLE.NOTE, null, values); + + /** + * temporary folder which is used for moving note（为移动note而设置的临时文件夹） + */ + values.clear();//清空值且以下步骤与上述相同 + values.put(NoteColumns.ID, Notes.ID_TEMPARAY_FOLDER); + values.put(NoteColumns.TYPE, Notes.TYPE_SYSTEM); + db.insert(TABLE.NOTE, null, values); + + /** + * create trash folder（创建垃圾回收文件夹） + */ + values.clear();////清空值且以下步骤与上述相同 + values.put(NoteColumns.ID, Notes.ID_TRASH_FOLER); + values.put(NoteColumns.TYPE, Notes.TYPE_SYSTEM); + db.insert(TABLE.NOTE, null, values); + } + //创建数据库，并且自动执行create方法，并且定义了下面的属性。 + public void createDataTable(SQLiteDatabase db) { + db.execSQL(CREATE_DATA_TABLE_SQL); + reCreateDataTableTriggers(db); + db.execSQL(CREATE_DATA_NOTE_ID_INDEX_SQL); + Log.d(TAG, "data table has been created"); + } + //如果触发器存在则drop，然后再次创建触发器 + private void reCreateDataTableTriggers(SQLiteDatabase db) { + db.execSQL("DROP TRIGGER IF EXISTS update_note_content_on_insert"); + db.execSQL("DROP TRIGGER IF EXISTS update_note_content_on_update"); + db.execSQL("DROP TRIGGER IF EXISTS update_note_content_on_delete"); + + db.execSQL(DATA_UPDATE_NOTE_CONTENT_ON_INSERT_TRIGGER); + db.execSQL(DATA_UPDATE_NOTE_CONTENT_ON_UPDATE_TRIGGER); + db.execSQL(DATA_UPDATE_NOTE_CONTENT_ON_DELETE_TRIGGER); + } + /*如果NotesDatabaseHelper的实例创建失败，那就重新建一个，重新分配内从空间 + static synchronized限制线程同时访问该实例*/ + static synchronized NotesDatabaseHelper getInstance(Context context) { + if (mInstance == null) { + mInstance = new NotesDatabaseHelper(context); + } + return mInstance; + } + + //onCreat方法创建note和data表 + public void onCreate(SQLiteDatabase db) { + createNoteTable(db); + createDataTable(db); + } + + //当打开数据库时传入的版本号与当前的版本号不同时会调用该方法，更新版本 + public void onUpgrade(SQLiteDatabase db, int oldVersion, int newVersion) { + boolean reCreateTriggers = false;//是否重建 + boolean skipV2 = false;//是否从V2升级到V3 + + if (oldVersion == 1) {//版本是1 + upgradeToV2(db);//更新到2 + skipV2 = true; // this upgrade including the upgrade from v2 to v3 + oldVersion++; + } + + if (oldVersion == 2 && !skipV2) {//版本是2且没有跳过2号版本，就更新到3号版本 + upgradeToV3(db);//更新到3 + reCreateTriggers = true; + oldVersion++; + } + + if (oldVersion == 3) {//版本是3 + upgradeToV4(db);//更新到4 + oldVersion++; + } + + if (reCreateTriggers) {//如果重新创建触发器，则重新创建两个表的触发器 + reCreateNoteTableTriggers(db); + reCreateDataTableTriggers(db); + } + + if (oldVersion != newVersion) {//如果旧版本不等于新版本则抛出更新版本失败错误 + throw new IllegalStateException("Upgrade notes database to version " + newVersion + + "fails"); + } + } + //更新数据库到版本2 + private void upgradeToV2(SQLiteDatabase db) { + db.execSQL("DROP TABLE IF EXISTS " + TABLE.NOTE); + db.execSQL("DROP TABLE IF EXISTS " + TABLE.DATA); + createNoteTable(db); + createDataTable(db); + } + //更新数据库到版本3 + private void upgradeToV3(SQLiteDatabase db) { + // drop unused triggers + db.execSQL("DROP TRIGGER IF EXISTS update_note_modified_date_on_insert"); + db.execSQL("DROP TRIGGER IF EXISTS update_note_modified_date_on_delete"); + db.execSQL("DROP TRIGGER IF EXISTS update_note_modified_date_on_update"); + // add a column for gtask id + db.execSQL("ALTER TABLE " + TABLE.NOTE + " ADD COLUMN " + NoteColumns.GTASK_ID + + " TEXT NOT NULL DEFAULT ''"); + // add a trash system folder + ContentValues values = new ContentValues(); + values.put(NoteColumns.ID, Notes.ID_TRASH_FOLER); + values.put(NoteColumns.TYPE, Notes.TYPE_SYSTEM); + db.insert(TABLE.NOTE, null, values); + } + //更新数据库到版本4 + private void upgradeToV4(SQLiteDatabase db) { + db.execSQL("ALTER TABLE " + TABLE.NOTE + " ADD COLUMN " + NoteColumns.VERSION + + " INTEGER NOT NULL DEFAULT 0"); + } +} diff --git a/other/07_210340180张旭_代码标注/data/NotesProvider.java b/other/07_210340180张旭_代码标注/data/NotesProvider.java new file mode 100644 index 0000000..eac119f --- /dev/null +++ b/other/07_210340180张旭_代码标注/data/NotesProvider.java @@ -0,0 +1,320 @@ +/* + * 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.data; + + +import android.app.SearchManager; +import android.content.ContentProvider; +import android.content.ContentUris; +import android.content.ContentValues; +import android.content.Intent; +import android.content.UriMatcher; +import android.database.Cursor; +import android.database.sqlite.SQLiteDatabase; +import android.net.Uri; +import android.text.TextUtils; +import android.util.Log; + +import net.micode.notes.R; +import net.micode.notes.data.Notes.DataColumns; +import net.micode.notes.data.Notes.NoteColumns; +import net.micode.notes.data.NotesDatabaseHelper.TABLE; +/*1. 便签信息提供类，该类继承于ContentProvider类，由此可见该类主要用于数据的提供的功能，供其他模块实现，相当于对便签信息的管理，该类定义了相关的UriMathcher用于匹配Uri，使数据管理更加安全，并定义了一些列的方法，对该软件创建的数据库进行管理，例如,OnCreate, query，insert，update, parseSelection等方法，用于对被选中的数据对象进行相关的删除，插入，更新等操作，实现对数据库的管理，为上层的使用提供了一个较好的接口，对数据库信息进行抽象。*/ +public class NotesProvider extends ContentProvider { + private static final UriMatcher mMatcher;//UriMatcher是Android提供的用来操作Uri的工具类 + + private NotesDatabaseHelper mHelper;//创建数据库帮助类实体对象 + + private static final String TAG = "NotesProvider";//该类的自定义标签 + //1-6都是uri资源的id + private static final int URI_NOTE = 1; + private static final int URI_NOTE_ITEM = 2; + private static final int URI_DATA = 3; + private static final int URI_DATA_ITEM = 4; + + private static final int URI_SEARCH = 5; + private static final int URI_SEARCH_SUGGEST = 6; + //将以下这些变量放在static模块中，只初始化一次，提高运行速度以及减少空间浪费。将各个Uri与其代号关联在一起 + static { + mMatcher = new UriMatcher(UriMatcher.NO_MATCH);//创建uri工具类实例对象 + //注册URI路径的过程 + mMatcher.addURI(Notes.AUTHORITY, "note", URI_NOTE); + mMatcher.addURI(Notes.AUTHORITY, "note/#", URI_NOTE_ITEM); + mMatcher.addURI(Notes.AUTHORITY, "data", URI_DATA); + mMatcher.addURI(Notes.AUTHORITY, "data/#", URI_DATA_ITEM); + mMatcher.addURI(Notes.AUTHORITY, "search", URI_SEARCH); + //SUGGEST_URI_PATH_QUERY 并不属于URI的一部分，而应是用于指向此路径的常量 + mMatcher.addURI(Notes.AUTHORITY, SearchManager.SUGGEST_URI_PATH_QUERY, URI_SEARCH_SUGGEST); + mMatcher.addURI(Notes.AUTHORITY, SearchManager.SUGGEST_URI_PATH_QUERY + "/*", URI_SEARCH_SUGGEST); + } + + /** + * x'0A' represents the '\n' character in sqlite. For title and content in the search result, + * we will trim （装饰，整理）'\n' and white space in order to show more information. + */ + //声明 NOTES_SEARCH_PROJECTION，便签搜索映射，相当于搜索的信息 + private static final String NOTES_SEARCH_PROJECTION = NoteColumns.ID + "," + + NoteColumns.ID + " AS " + SearchManager.SUGGEST_COLUMN_INTENT_EXTRA_DATA + "," + + "TRIM(REPLACE(" + NoteColumns.SNIPPET + ", x'0A','')) AS " + SearchManager.SUGGEST_COLUMN_TEXT_1 + "," + + "TRIM(REPLACE(" + NoteColumns.SNIPPET + ", x'0A','')) AS " + SearchManager.SUGGEST_COLUMN_TEXT_2 + "," + + R.drawable.search_result + " AS " + SearchManager.SUGGEST_COLUMN_ICON_1 + "," + + "'" + Intent.ACTION_VIEW + "' AS " + SearchManager.SUGGEST_COLUMN_INTENT_ACTION + "," + + "'" + Notes.TextNote.CONTENT_TYPE + "' AS " + SearchManager.SUGGEST_COLUMN_INTENT_DATA; + //note搜索查询 + private static String NOTES_SNIPPET_SEARCH_QUERY = "SELECT " + NOTES_SEARCH_PROJECTION + + " FROM " + TABLE.NOTE + + " WHERE " + NoteColumns.SNIPPET + " LIKE ?" + + " AND " + NoteColumns.PARENT_ID + "<>" + Notes.ID_TRASH_FOLER + + " AND " + NoteColumns.TYPE + "=" + Notes.TYPE_NOTE; + + //创建一个便签数据库助手mHelper + public boolean onCreate() { + mHelper = NotesDatabaseHelper.getInstance(getContext()); + return true; + } + + //查询uri在数据库中对应的位置 + public Cursor query(Uri uri, String[] projection, String selection, String[] selectionArgs, + String sortOrder) { + Cursor c = null;//函数返回对象 + /*getReadableDatabase()方法是先以读写方式打开数据库，如果数据库的磁盘空间满了，就会打开失败，当打开失败后会继续尝试以只读方式打开数据库。如果该问题成功解决，则只读数据库对象就会关闭，然后返回一个可读写的数据库对象。*/ + SQLiteDatabase db = mHelper.getReadableDatabase();//向数据库读操作 + String id = null; + switch (mMatcher.match(uri)) { + case URI_NOTE://匹配到标签的uri + c = db.query(TABLE.NOTE, projection, selection, selectionArgs, null, null, + sortOrder);//查询的表返回列行如何分组过滤条件，数据库查询语句 + break; + case URI_NOTE_ITEM://匹配到标签条目 + id = uri.getPathSegments().get(1);//匹配到列表中便签项的路径中的1号字符 + c = db.query(TABLE.NOTE, projection, NoteColumns.ID + "=" + id + + parseSelection(selection), selectionArgs, null, null, sortOrder);//查询的表返回列行如何分组过滤条件，数据库查询语句 + break; + case URI_DATA://匹配到数据的uri + c = db.query(TABLE.DATA, projection, selection, selectionArgs, null, null, + sortOrder);//查询的表返回列行如何分组过滤条件，数据库查询语句 + break; + case URI_DATA_ITEM://匹配到数据条目 + id = uri.getPathSegments().get(1);//匹配到列表中数据项的路径中的1号字符 + c = db.query(TABLE.DATA, projection, DataColumns.ID + "=" + id + + parseSelection(selection), selectionArgs, null, null, sortOrder);//数据库查询语句 + break; + case URI_SEARCH://匹配到搜索 + case URI_SEARCH_SUGGEST://匹配到搜索建议 + if (sortOrder != null || projection != null) { + //如果sortOrder或projection不为空抛出错误 + throw new IllegalArgumentException( + "do not specify sortOrder, selection, selectionArgs, or projection" + "with this query"); + } + + String searchString = null; + if (mMatcher.match(uri) == URI_SEARCH_SUGGEST) {//匹配到搜索建议 + if (uri.getPathSegments().size() > 1) { + //如果如果该路径数组大小大于一则取第一个元素 + searchString = uri.getPathSegments().get(1); + } + } else { + //小于1则取第零个元素 + searchString = uri.getQueryParameter("pattern"); + } + + if (TextUtils.isEmpty(searchString)) { + //如果路径为空则返回空 + return null; + } + + try { + /*通过上文得到的搜索字符串，进行格式加工，而后通过rawQuery（）直接在“NOTES_SNIPPET_SEARCH_QUERY”数据库中搜索ID=searchString的对应信息串。*/ + searchString = String.format("%%%s%%", searchString); + /*cursor = db.rawQuery("select name from *** where id=?", new String[]{"1"});*/ + c = db.rawQuery(NOTES_SNIPPET_SEARCH_QUERY, + new String[] { searchString }); + } catch (IllegalStateException ex) { + Log.e(TAG, "got exception: " + ex.toString());//出错抛出异常 + } + break; + default: + throw new IllegalArgumentException("Unknown URI " + uri);//无法匹配上述的uri，抛出错误 + } + if (c != null) { + //若getContentResolver发生变化，就接收通知 + c.setNotificationUri(getContext().getContentResolver(), uri); + } + return c; + } + + //插入一个新的uri + public Uri insert(Uri uri, ContentValues values) { + SQLiteDatabase db = mHelper.getWritableDatabase();//向数据库写操作 + long dataId = 0, noteId = 0, insertedId = 0; + switch (mMatcher.match(uri)) { + case URI_NOTE: + insertedId = noteId = db.insert(TABLE.NOTE, null, values);//向note表插入一个uri + break; + case URI_DATA: + if (values.containsKey(DataColumns.NOTE_ID)) {//如果数据包含主键 + noteId = values.getAsLong(DataColumns.NOTE_ID);//转换为long型 + } else { + Log.d(TAG, "Wrong data format without note id:" + values.toString());//信息不含主键抛出异常错误 + } + insertedId = dataId = db.insert(TABLE.DATA, null, values);//向数据表插入一个uri + break; + default: + throw new IllegalArgumentException("Unknown URI " + uri);//不匹配的uri + } + // Notify the note uri（报告note id） + if (noteId > 0) { + getContext().getContentResolver().notifyChange( + ContentUris.withAppendedId(Notes.CONTENT_NOTE_URI, noteId), null); + } + + // Notify the data uri（报告data id） + if (dataId > 0) { + getContext().getContentResolver().notifyChange( + ContentUris.withAppendedId(Notes.CONTENT_DATA_URI, dataId), null); + } + + return ContentUris.withAppendedId(uri, insertedId);//返回插入uri的路径 + } + + //删除一个uri + public int delete(Uri uri, String selection, String[] selectionArgs) { + int count = 0; + String id = null; + SQLiteDatabase db = mHelper.getWritableDatabase(); + boolean deleteData = false; + switch (mMatcher.match(uri)) { + case URI_NOTE: + selection = "(" + selection + ") AND " + NoteColumns.ID + ">0 ";//要删除的note的信息 + count = db.delete(TABLE.NOTE, selection, selectionArgs);//删除且返回数量 + break; + case URI_NOTE_ITEM: + id = uri.getPathSegments().get(1); + /** + * ID that smaller than 0 is system folder which is not allowed to + * trash + */ + long noteId = Long.valueOf(id); + if (noteId <= 0) { + // ID小于0表示是系统文件夹，不能删除 + break; + } + count = db.delete(TABLE.NOTE, + NoteColumns.ID + "=" + id + parseSelection(selection), selectionArgs);//删除且返回数量 + break; + //以下两个与上两个相同 + case URI_DATA: + count = db.delete(TABLE.DATA, selection, selectionArgs); + deleteData = true; + break; + case URI_DATA_ITEM: + id = uri.getPathSegments().get(1); + count = db.delete(TABLE.DATA, + DataColumns.ID + "=" + id + parseSelection(selection), selectionArgs); + deleteData = true; + break; + default: + throw new IllegalArgumentException("Unknown URI " + uri);//不匹配的uri + } + if (count > 0) { + if (deleteData) {//如果真的删除了数据，则要求监听器对观察者发送通知 + getContext().getContentResolver().notifyChange(Notes.CONTENT_NOTE_URI, null); + } + getContext().getContentResolver().notifyChange(uri, null);//对所有修改进行通知 + } + return count;//返回删除数量 + } + + //更新一个uri + public int update(Uri uri, ContentValues values, String selection, String[] selectionArgs) { + int count = 0;//更新数量 + String id = null; + SQLiteDatabase db = mHelper.getWritableDatabase(); + boolean updateData = false; + switch (mMatcher.match(uri)) { + case URI_NOTE: + increaseNoteVersion(-1, selection, selectionArgs);//先升级版本再更新 + count = db.update(TABLE.NOTE, values, selection, selectionArgs);//更新且返回数量 + break; + case URI_NOTE_ITEM: + id = uri.getPathSegments().get(1);//获取该item的id + increaseNoteVersion(Long.valueOf(id), selection, selectionArgs); + count = db.update(TABLE.NOTE, values, NoteColumns.ID + "=" + id + + parseSelection(selection), selectionArgs); + break; + //与上述两个相同 + case URI_DATA: + count = db.update(TABLE.DATA, values, selection, selectionArgs); + updateData = true; + break; + case URI_DATA_ITEM: + id = uri.getPathSegments().get(1); + count = db.update(TABLE.DATA, values, DataColumns.ID + "=" + id + + parseSelection(selection), selectionArgs); + updateData = true; + break; + default: + throw new IllegalArgumentException("Unknown URI " + uri);//不匹配uri + } + + if (count > 0) { + if (updateData) {//如果对数据进行了更新，则要求监听器对观察者发送通知 + getContext().getContentResolver().notifyChange(Notes.CONTENT_NOTE_URI, null); + } + getContext().getContentResolver().notifyChange(uri, null);//对所有更新进行通知 + } + return count;//返回更新的数量 + } + + private String parseSelection(String selection) { + //如果selection不是空字符，那么返回" AND (" + selection + ')'如果是空字符，返回"" + return (!TextUtils.isEmpty(selection) ? " AND (" + selection + ')' : ""); + } + private void increaseNoteVersion(long id, String selection, String[] selectionArgs) { + //在数据库中升级版本 + StringBuilder sql = new StringBuilder(120); + sql.append("UPDATE "); + sql.append(TABLE.NOTE); + sql.append(" SET "); + sql.append(NoteColumns.VERSION); + sql.append("=" + NoteColumns.VERSION + "+1 "); + + if (id > 0 || !TextUtils.isEmpty(selection)) { + sql.append(" WHERE "); + } + if (id > 0) {//id>0就将其写入数据库 + sql.append(NoteColumns.ID + "=" + String.valueOf(id)); + } + if (!TextUtils.isEmpty(selection)) { + //如果输入的字符串是非空的就将其写入数据库 + String selectString = id > 0 ? parseSelection(selection) : selection; + for (String args : selectionArgs) { + selectString = selectString.replaceFirst("\\?", args); + } + sql.append(selectString); + } + // execSQL()方法可以执行insert、delete、update和CREATE TABLE之类有更改行为的SQL语句 + mHelper.getWritableDatabase().execSQL(sql.toString()); + } + + @Override + public String getType(Uri uri) {//获取uri的数据类型，实际永远返回null + // TODO Auto-generated method stub + return null; + } + +} diff --git a/other/07_210340180张旭_代码标注/tool/BackupUtils.java b/other/07_210340180张旭_代码标注/tool/BackupUtils.java new file mode 100644 index 0000000..1a46d58 --- /dev/null +++ b/other/07_210340180张旭_代码标注/tool/BackupUtils.java @@ -0,0 +1,352 @@ +/* + * 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.tool; + +import android.content.Context; +import android.database.Cursor; +import android.os.Environment; +import android.text.TextUtils; +import android.text.format.DateFormat; +import android.util.Log; + +import net.micode.notes.R; +import net.micode.notes.data.Notes; +import net.micode.notes.data.Notes.DataColumns; +import net.micode.notes.data.Notes.DataConstants; +import net.micode.notes.data.Notes.NoteColumns; + +import java.io.File; +import java.io.FileNotFoundException; +import java.io.FileOutputStream; +import java.io.IOException; +import java.io.PrintStream; + +/*备份工具类，用于数据备份读取和显示*/ +public class BackupUtils { + private static final String TAG = "BackupUtils";//定义类的名字标识 + // Singleton stuff + private static BackupUtils sInstance;//定义实体对象 + + public static synchronized BackupUtils getInstance(Context context) { + //获取实体对象 + if (sInstance == null) { + sInstance = new BackupUtils(context); + } + return sInstance; + } + + /** + * Following states are signs to represents backup or restore（以下是表示备份或恢复的符号） + * status（状态） + */ + // Currently, the sdcard is not mounted（当前sd卡未安装） + public static final int STATE_SD_CARD_UNMOUONTED = 0; + // The backup file not exist（备份文件不存在） + public static final int STATE_BACKUP_FILE_NOT_EXIST = 1; + // The data is not well formated, may be changed by other programs（数据格式不正确可能被其他程序更改） + public static final int STATE_DATA_DESTROIED = 2; + // Some run-time exception which causes restore or backup fails（导致备份或还原失败的默写运行异常） + public static final int STATE_SYSTEM_ERROR = 3; + // Backup or restore success（备份或还原成功） + public static final int STATE_SUCCESS = 4; + + private TextExport mTextExport;//实例化对象 + //构造函数 + private BackupUtils(Context context) { + mTextExport = new TextExport(context); + } + //判断外部存储功能是否可用 + private static boolean externalStorageAvailable() { + return Environment.MEDIA_MOUNTED.equals(Environment.getExternalStorageState()); + } + //返回输出到文本后的状态 + public int exportToText() { + return mTextExport.exportToText(); + } + //返回输出文本文件名字 + public String getExportedTextFileName() { + return mTextExport.mFileName; + } + //返回输出文本文件路径 + public String getExportedTextFileDir() { + return mTextExport.mFileDirectory; + } + //文本输出类 + private static class TextExport { + //note映射数组，存储note信息 + private static final String[] NOTE_PROJECTION = { + NoteColumns.ID, + NoteColumns.MODIFIED_DATE, + NoteColumns.SNIPPET, + NoteColumns.TYPE + }; + //以下几行定义note数组里的属性值 + private static final int NOTE_COLUMN_ID = 0; + + private static final int NOTE_COLUMN_MODIFIED_DATE = 1; + + private static final int NOTE_COLUMN_SNIPPET = 2; + //数据映射数组，存储数据信息 + private static final String[] DATA_PROJECTION = { + DataColumns.CONTENT, + DataColumns.MIME_TYPE, + DataColumns.DATA1, + DataColumns.DATA2, + DataColumns.DATA3, + DataColumns.DATA4, + }; + //数据内容属性 + private static final int DATA_COLUMN_CONTENT = 0; + //媒体类型属性 + private static final int DATA_COLUMN_MIME_TYPE = 1; + //访问日期属性 + private static final int DATA_COLUMN_CALL_DATE = 2; + //电话号码属性 + private static final int DATA_COLUMN_PHONE_NUMBER = 4; + //文本格式数组 + private final String [] TEXT_FORMAT; + //文件命名格式 + private static final int FORMAT_FOLDER_NAME = 0; + //便签日期格式 + private static final int FORMAT_NOTE_DATE = 1; + //便签内容格式 + private static final int FORMAT_NOTE_CONTENT = 2; + + private Context mContext;//定义上下文类 + private String mFileName;//定义文件名 + private String mFileDirectory;//定义文件路径 + + public TextExport(Context context) { + //从context类实例中获取信息，给对应的属性赋初始值 + TEXT_FORMAT = context.getResources().getStringArray(R.array.format_for_exported_note); + mContext = context; + mFileName = ""; + mFileDirectory = ""; + } + //获取文本格式内容 + private String getFormat(int id) { + return TEXT_FORMAT[id]; + } + + /** + * Export the folder identified by folder id to text（通过文件夹id向文本输出文件夹） + */ + private void exportFolderToText(String folderId, PrintStream ps) { + // Query notes belong to this folder（查询该notes是否属于这个文件夹） + Cursor notesCursor = mContext.getContentResolver().query(Notes.CONTENT_NOTE_URI, + NOTE_PROJECTION, NoteColumns.PARENT_ID + "=?", new String[] { + folderId + }, null); + + if (notesCursor != null) { + if (notesCursor.moveToFirst()) { + do { + // Print note's last modified date（打印标签的最后一次更改日期） + ps.println(String.format(getFormat(FORMAT_NOTE_DATE), DateFormat.format( + mContext.getString(R.string.format_datetime_mdhm), + notesCursor.getLong(NOTE_COLUMN_MODIFIED_DATE)))); + // Query data belong to this note（查询该note的数据） + String noteId = notesCursor.getString(NOTE_COLUMN_ID); + exportNoteToText(noteId, ps); + } while (notesCursor.moveToNext());//对该note所有的数据 + } + notesCursor.close();//关闭游标 + } + } + + /** + * Export note identified by id to a print stream（输出note id向一个打印流） + */ + private void exportNoteToText(String noteId, PrintStream ps) { + Cursor dataCursor = mContext.getContentResolver().query(Notes.CONTENT_DATA_URI, + DATA_PROJECTION, DataColumns.NOTE_ID + "=?", new String[] { + noteId + }, null); + + if (dataCursor != null) { + if (dataCursor.moveToFirst()) { + do { + String mimeType = dataCursor.getString(DATA_COLUMN_MIME_TYPE); + if (DataConstants.CALL_NOTE.equals(mimeType)) { + // Print phone number（打印电话号码） + String phoneNumber = dataCursor.getString(DATA_COLUMN_PHONE_NUMBER); + long callDate = dataCursor.getLong(DATA_COLUMN_CALL_DATE); + String location = dataCursor.getString(DATA_COLUMN_CONTENT); + + if (!TextUtils.isEmpty(phoneNumber)) { + ps.println(String.format(getFormat(FORMAT_NOTE_CONTENT), + phoneNumber)); + } + // Print call date（打印访问日期） + ps.println(String.format(getFormat(FORMAT_NOTE_CONTENT), DateFormat + .format(mContext.getString(R.string.format_datetime_mdhm), + callDate))); + // Print call attachment location（打印位置） + if (!TextUtils.isEmpty(location)) { + ps.println(String.format(getFormat(FORMAT_NOTE_CONTENT), + location)); + } + } else if (DataConstants.NOTE.equals(mimeType)) { + String content = dataCursor.getString(DATA_COLUMN_CONTENT); + if (!TextUtils.isEmpty(content)) { + ps.println(String.format(getFormat(FORMAT_NOTE_CONTENT), + content)); + } + } + } while (dataCursor.moveToNext());//对所有数据 + } + dataCursor.close();//关闭游标 + } + // print a line separator between note（打印一个线分隔两个note） + try { + ps.write(new byte[] { + Character.LINE_SEPARATOR, Character.LETTER_NUMBER + }); + } catch (IOException e) { + Log.e(TAG, e.toString());//错误报告 + } + } + + /** + * Note will be exported as text which is user readable（以text形式输出到外部设备SDcard） + */ + public int exportToText() { + if (!externalStorageAvailable()) { + Log.d(TAG, "Media was not mounted"); + return STATE_SD_CARD_UNMOUONTED;//sd卡未安装 + } + + PrintStream ps = getExportToTextPrintStream(); + if (ps == null) { + Log.e(TAG, "get print stream error"); + return STATE_SYSTEM_ERROR;//系统状态错误 + } + // First export folder and its notes（第一次输出文件夹和他的note） + Cursor folderCursor = mContext.getContentResolver().query( + Notes.CONTENT_NOTE_URI, + NOTE_PROJECTION, + "(" + NoteColumns.TYPE + "=" + Notes.TYPE_FOLDER + " AND " + + NoteColumns.PARENT_ID + "<>" + Notes.ID_TRASH_FOLER + ") OR " + + NoteColumns.ID + "=" + Notes.ID_CALL_RECORD_FOLDER, null, null); + + if (folderCursor != null) { + if (folderCursor.moveToFirst()) { + do { + // Print folder's name（打印文件夹名字） + String folderName = ""; + if(folderCursor.getLong(NOTE_COLUMN_ID) == Notes.ID_CALL_RECORD_FOLDER) { + folderName = mContext.getString(R.string.call_record_folder_name); + } else { + folderName = folderCursor.getString(NOTE_COLUMN_SNIPPET); + } + if (!TextUtils.isEmpty(folderName)) { + ps.println(String.format(getFormat(FORMAT_FOLDER_NAME), folderName)); + } + String folderId = folderCursor.getString(NOTE_COLUMN_ID); + exportFolderToText(folderId, ps); + } while (folderCursor.moveToNext());//对所有文件夹 + } + folderCursor.close();//关闭游标 + } + + // Export notes in root's folder（输出notes到系统文件夹） + Cursor noteCursor = mContext.getContentResolver().query( + Notes.CONTENT_NOTE_URI, + NOTE_PROJECTION, + NoteColumns.TYPE + "=" + +Notes.TYPE_NOTE + " AND " + NoteColumns.PARENT_ID + + "=0", null, null); + + if (noteCursor != null) { + if (noteCursor.moveToFirst()) { + do { + ps.println(String.format(getFormat(FORMAT_NOTE_DATE), DateFormat.format( + mContext.getString(R.string.format_datetime_mdhm), + noteCursor.getLong(NOTE_COLUMN_MODIFIED_DATE)))); + // Query data belong to this note（查询这个note的数据） + String noteId = noteCursor.getString(NOTE_COLUMN_ID); + exportNoteToText(noteId, ps); + } while (noteCursor.moveToNext()); + } + noteCursor.close(); + } + ps.close(); + + return STATE_SUCCESS; + } + + /** + * Get a print stream pointed to the file {@generateExportedTextFile} + */ + private PrintStream getExportToTextPrintStream() { + //create file to exported failed + File file = generateFileMountedOnSDcard(mContext, R.string.file_path, + R.string.file_name_txt_format); + if (file == null) { + Log.e(TAG, "create file to exported failed");//异常报告 + return null; + } + mFileName = file.getName();//文件名字 + mFileDirectory = mContext.getString(R.string.file_path);//文件路径 + PrintStream ps = null; + try { + FileOutputStream fos = new FileOutputStream(file); + ps = new PrintStream(fos);//创建一个打印流指向这个创建的文件 + } catch (FileNotFoundException e) { + e.printStackTrace(); + return null; + } catch (NullPointerException e) { + e.printStackTrace(); + return null; + } + return ps;//返回新文件的打印流 + } + } + + /** + * Generate the text file to store imported data（生成文件存储在外部存储器上） + */ + //产生用于存储输入信息的文件 + private static File generateFileMountedOnSDcard(Context context, int filePathResId, int fileNameFormatResId) { + StringBuilder sb = new StringBuilder(); + sb.append(Environment.getExternalStorageDirectory());//外部（SD卡）的存储路径 + sb.append(context.getString(filePathResId));//文件的存储路径 + File filedir = new File(sb.toString());//存储路径信息 + sb.append(context.getString( + fileNameFormatResId, + DateFormat.format(context.getString(R.string.format_date_ymd), + System.currentTimeMillis())));//将当前的系统时间以预定的格式输出 + File file = new File(sb.toString());//将输出连接到一个文件里 + + try { + if (!filedir.exists()) { + filedir.mkdir();//创建新文件夹 + } + if (!file.exists()) { + file.createNewFile();//创建新文件 + } + return file; + } catch (SecurityException e) { + e.printStackTrace();//错误抛出异常 + } catch (IOException e) { + e.printStackTrace();////错误抛出异常 + } + + return null; + } +} + + diff --git a/other/07_210340180张旭_代码标注/tool/DataUtils.java b/other/07_210340180张旭_代码标注/tool/DataUtils.java new file mode 100644 index 0000000..831bb1f --- /dev/null +++ b/other/07_210340180张旭_代码标注/tool/DataUtils.java @@ -0,0 +1,308 @@ +/* + * 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.tool; + +import android.content.ContentProviderOperation; +import android.content.ContentProviderResult; +import android.content.ContentResolver; +import android.content.ContentUris; +import android.content.ContentValues; +import android.content.OperationApplicationException; +import android.database.Cursor; +import android.os.RemoteException; +import android.util.Log; + +import net.micode.notes.data.Notes; +import net.micode.notes.data.Notes.CallNote; +import net.micode.notes.data.Notes.NoteColumns; +import net.micode.notes.ui.NotesListAdapter.AppWidgetAttribute; + +import java.util.ArrayList; +import java.util.HashSet; + +/*数据的集成工具类*/ +public class DataUtils { + public static final String TAG = "DataUtils";//定义该自定义类标识 + public static boolean batchDeleteNotes(ContentResolver resolver, HashSet ids) { + //处理批量删除便签的方法 + if (ids == null) { + Log.d(TAG, "the ids is null");//输出debug调试，无note删除 + return true; + } + if (ids.size() == 0) { + Log.d(TAG, "no id is in the hashset");//无note删除 + return true; + } + //提供一个任务列表 + ArrayList operationList = new ArrayList(); + for (long id : ids) { + if(id == Notes.ID_ROOT_FOLDER) { + Log.e(TAG, "Don't delete system folder root");//检测当前id是不是指向根目录，若是返回一个异常信息 + continue; + } + //使用newDelete实现删除操作 + ContentProviderOperation.Builder builder = ContentProviderOperation + .newDelete(ContentUris.withAppendedId(Notes.CONTENT_NOTE_URI, id)); + //将操作添加至列表 + operationList.add(builder.build()); + } + try { + ContentProviderResult[] results = resolver.applyBatch(Notes.AUTHORITY, operationList); + if (results == null || results.length == 0 || results[0] == null) { + Log.d(TAG, "delete notes failed, ids:" + ids.toString());//删除失败 + return false; + } + return true; + } catch (RemoteException e) { + Log.e(TAG, String.format("%s: %s", e.toString(), e.getMessage()));//返回异常错误 + } catch (OperationApplicationException e) { + Log.e(TAG, String.format("%s: %s", e.toString(), e.getMessage()));//返回错误异常 + } + return false; + } + //移动note到文件夹 + public static void moveNoteToFoler(ContentResolver resolver, long id, long srcFolderId, long desFolderId) { + ContentValues values = new ContentValues();//获取note信息 + values.put(NoteColumns.PARENT_ID, desFolderId);//设置父节点为目标文件夹id + values.put(NoteColumns.ORIGIN_PARENT_ID, srcFolderId);//设置原本的父节点为原本的文件夹的id + values.put(NoteColumns.LOCAL_MODIFIED, 1);//设置修改符号为1 + resolver.update(ContentUris.withAppendedId(Notes.CONTENT_NOTE_URI, id), values, null, null);//对移动过的便签进行数据的更新 + } + //与上述批量删除note相同，批量移到指定文件夹 + public static boolean batchMoveToFolder(ContentResolver resolver, HashSet ids, + long folderId) { + if (ids == null) { + Log.d(TAG, "the ids is null"); + return true; + } + + ArrayList operationList = new ArrayList(); + for (long id : ids) { + ContentProviderOperation.Builder builder = ContentProviderOperation + .newUpdate(ContentUris.withAppendedId(Notes.CONTENT_NOTE_URI, id)); + builder.withValue(NoteColumns.PARENT_ID, folderId); + builder.withValue(NoteColumns.LOCAL_MODIFIED, 1); + operationList.add(builder.build()); + } + + try { + //对于一些异常进行处理与汇报，applyBatch一次性处理一个操作列表 + ContentProviderResult[] results = resolver.applyBatch(Notes.AUTHORITY, operationList); + if (results == null || results.length == 0 || results[0] == null) { + Log.d(TAG, "delete notes failed, ids:" + ids.toString()); + return false; + } + return true; + } catch (RemoteException e) { + Log.e(TAG, String.format("%s: %s", e.toString(), e.getMessage())); + } catch (OperationApplicationException e) { + Log.e(TAG, String.format("%s: %s", e.toString(), e.getMessage())); + } + return false; + } + + /** + * Get the all folder count except system folders {@link Notes#TYPE_SYSTEM}}（获取除了系统文件夹的所有文件夹数量） + */ + public static int getUserFolderCount(ContentResolver resolver) { + Cursor cursor =resolver.query(Notes.CONTENT_NOTE_URI, + new String[] { "COUNT(*)" }, + NoteColumns.TYPE + "=? AND " + NoteColumns.PARENT_ID + "<>?", + new String[] { String.valueOf(Notes.TYPE_FOLDER), String.valueOf(Notes.ID_TRASH_FOLER)}, + null);//在数据库中查询并用游标指向它 + + int count = 0; + if(cursor != null) { + if(cursor.moveToFirst()) { + try { + count = cursor.getInt(0); + } catch (IndexOutOfBoundsException e) { + Log.e(TAG, "get folder count failed:" + e.toString());//失败报告 + } finally { + cursor.close(); + } + } + } + return count;//返回数量 + } + + public static boolean visibleInNoteDatabase(ContentResolver resolver, long noteId, int type) { + //在数据库中是否可见 + Cursor cursor = resolver.query(ContentUris.withAppendedId(Notes.CONTENT_NOTE_URI, noteId), + null, + NoteColumns.TYPE + "=? AND " + NoteColumns.PARENT_ID + "<>" + Notes.ID_TRASH_FOLER, + new String [] {String.valueOf(type)}, + null);//查询note是否可以找到 + + boolean exist = false; + if (cursor != null) { + if (cursor.getCount() > 0) { + exist = true;//找到 + } + cursor.close(); + } + return exist;//可见 + } + + public static boolean existInNoteDatabase(ContentResolver resolver, long noteId) { + //在数据库中note是否存在 + Cursor cursor = resolver.query(ContentUris.withAppendedId(Notes.CONTENT_NOTE_URI, noteId), + null, null, null, null);//查询数据是否存在 + + boolean exist = false; + if (cursor != null) { + if (cursor.getCount() > 0) { + exist = true;///找到 + } + cursor.close(); + } + return exist;//存在 + } + + public static boolean existInDataDatabase(ContentResolver resolver, long dataId) { + //在数据库中数据是否存在 + Cursor cursor = resolver.query(ContentUris.withAppendedId(Notes.CONTENT_DATA_URI, dataId), + null, null, null, null);//查找数据 + + boolean exist = false; + if (cursor != null) { + if (cursor.getCount() > 0) { + exist = true;//找到 + } + cursor.close(); + } + return exist;//存在 + } + + public static boolean checkVisibleFolderName(ContentResolver resolver, String name) { + //检查文件夹名字是否可见 + Cursor cursor = resolver.query(Notes.CONTENT_NOTE_URI, null, + NoteColumns.TYPE + "=" + Notes.TYPE_FOLDER + + " AND " + NoteColumns.PARENT_ID + "<>" + Notes.ID_TRASH_FOLER + + " AND " + NoteColumns.SNIPPET + "=?", + new String[] { name }, null);//查询 + boolean exist = false; + if(cursor != null) { + if(cursor.getCount() > 0) { + exist = true;//找到 + } + cursor.close(); + } + return exist;//可见 + } + + public static HashSet getFolderNoteWidget(ContentResolver resolver, long folderId) { + //使用hashset来存储不同窗口的id和type并且建立对应关系 + Cursor c = resolver.query(Notes.CONTENT_NOTE_URI, + new String[] { NoteColumns.WIDGET_ID, NoteColumns.WIDGET_TYPE }, + NoteColumns.PARENT_ID + "=?", + new String[] { String.valueOf(folderId) }, + null);//父ID是否为传入的folderId + + HashSet set = null; + if (c != null) { + if (c.moveToFirst()) { + set = new HashSet(); + do { + try { + AppWidgetAttribute widget = new AppWidgetAttribute(); + widget.widgetId = c.getInt(0); + widget.widgetType = c.getInt(1); + set.add(widget);//存储不同窗口的id和type + } catch (IndexOutOfBoundsException e) { + Log.e(TAG, e.toString()); + } + } while (c.moveToNext()); + } + c.close(); + } + return set; + } + + public static String getCallNumberByNoteId(ContentResolver resolver, long noteId) { + //通过noteid获取呼叫号码 + Cursor cursor = resolver.query(Notes.CONTENT_DATA_URI, + new String [] { CallNote.PHONE_NUMBER }, + CallNote.NOTE_ID + "=? AND " + CallNote.MIME_TYPE + "=?", + new String [] { String.valueOf(noteId), CallNote.CONTENT_ITEM_TYPE }, + null);//在数据库查询 + + if (cursor != null && cursor.moveToFirst()) { + try { + return cursor.getString(0);//找到 + } catch (IndexOutOfBoundsException e) { + Log.e(TAG, "Get call number fails " + e.toString());//没找到 + } finally { + cursor.close(); + } + } + return ""; + } + + public static long getNoteIdByPhoneNumberAndCallDate(ContentResolver resolver, String phoneNumber, long callDate) { + //通过映射关系，通过号码和日期获取ID + Cursor cursor = resolver.query(Notes.CONTENT_DATA_URI, + new String [] { CallNote.NOTE_ID }, + CallNote.CALL_DATE + "=? AND " + CallNote.MIME_TYPE + "=? AND PHONE_NUMBERS_EQUAL(" + + CallNote.PHONE_NUMBER + ",?)", + new String [] { String.valueOf(callDate), CallNote.CONTENT_ITEM_TYPE, phoneNumber }, + null);//在数据库查询 + + if (cursor != null) { + if (cursor.moveToFirst()) { + try { + return cursor.getLong(0);//找到 + } catch (IndexOutOfBoundsException e) { + Log.e(TAG, "Get call note id fails " + e.toString());//失败 + } + } + cursor.close();//关闭游标 + } + return 0; + } + + public static String getSnippetById(ContentResolver resolver, long noteId) { + //进入清单模式后，note会分为若干段，该函数将每一个段返回对应的字符串 + Cursor cursor = resolver.query(Notes.CONTENT_NOTE_URI, + new String [] { NoteColumns.SNIPPET }, + NoteColumns.ID + "=?", + new String [] { String.valueOf(noteId)}, + null);//查找 + + if (cursor != null) { + String snippet = ""; + if (cursor.moveToFirst()) { + snippet = cursor.getString(0);//找到 + } + cursor.close();//关闭游标 + return snippet; + } + throw new IllegalArgumentException("Note is not found with id: " + noteId);//失败 + } + + public static String getFormattedSnippet(String snippet) { + //将文件名标准化 + if (snippet != null) { + snippet = snippet.trim(); + int index = snippet.indexOf('\n'); + if (index != -1) { + snippet = snippet.substring(0, index); + } + } + return snippet; + } +} diff --git a/other/07_210340180张旭_代码标注/tool/GTaskStringUtils.java b/other/07_210340180张旭_代码标注/tool/GTaskStringUtils.java new file mode 100644 index 0000000..cd4c10b --- /dev/null +++ b/other/07_210340180张旭_代码标注/tool/GTaskStringUtils.java @@ -0,0 +1,113 @@ +/* + * 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.tool; +/*定义了很多的静态常量字符串，目的就是为了提供jsonObject中相应字符串的"key"。把这些静态的定义单独写到了一个类里面，方便查找和更改*/ +public class GTaskStringUtils { + + public final static String GTASK_JSON_ACTION_ID = "action_id";//任务id + + public final static String GTASK_JSON_ACTION_LIST = "action_list";//任务列表 + + public final static String GTASK_JSON_ACTION_TYPE = "action_type";//任务类型 + + public final static String GTASK_JSON_ACTION_TYPE_CREATE = "create";//新建 + + public final static String GTASK_JSON_ACTION_TYPE_GETALL = "get_all";//获取所有的任务类型 + + public final static String GTASK_JSON_ACTION_TYPE_MOVE = "move";//移动 + + public final static String GTASK_JSON_ACTION_TYPE_UPDATE = "update";//更新 + + public final static String GTASK_JSON_CREATOR_ID = "creator_id";//创建id + + public final static String GTASK_JSON_CHILD_ENTITY = "child_entity";//子实体 + + public final static String GTASK_JSON_CLIENT_VERSION = "client_version";//客户端 + + public final static String GTASK_JSON_COMPLETED = "completed";//完成 + + public final static String GTASK_JSON_CURRENT_LIST_ID = "current_list_id";//当前列表id + + public final static String GTASK_JSON_DEFAULT_LIST_ID = "default_list_id";//默认列表id + + public final static String GTASK_JSON_DELETED = "deleted";//删除 + + public final static String GTASK_JSON_DEST_LIST = "dest_list"; + + public final static String GTASK_JSON_DEST_PARENT = "dest_parent"; + + public final static String GTASK_JSON_DEST_PARENT_TYPE = "dest_parent_type"; + + public final static String GTASK_JSON_ENTITY_DELTA = "entity_delta"; + + public final static String GTASK_JSON_ENTITY_TYPE = "entity_type"; + + public final static String GTASK_JSON_GET_DELETED = "get_deleted"; + + public final static String GTASK_JSON_ID = "id";//id + + public final static String GTASK_JSON_INDEX = "index";//索引 + + public final static String GTASK_JSON_LAST_MODIFIED = "last_modified";//最后一次更改 + + public final static String GTASK_JSON_LATEST_SYNC_POINT = "latest_sync_point";//最后一次同步 + + public final static String GTASK_JSON_LIST_ID = "list_id";//列表id + + public final static String GTASK_JSON_LISTS = "lists";//列表 + + public final static String GTASK_JSON_NAME = "name";//名字 + + public final static String GTASK_JSON_NEW_ID = "new_id";//新id + + public final static String GTASK_JSON_NOTES = "notes";//便签 + + public final static String GTASK_JSON_PARENT_ID = "parent_id";//父id + + public final static String GTASK_JSON_PRIOR_SIBLING_ID = "prior_sibling_id"; + + public final static String GTASK_JSON_RESULTS = "results";//结果 + + public final static String GTASK_JSON_SOURCE_LIST = "source_list";//源列表 + + public final static String GTASK_JSON_TASKS = "tasks";//任务 + + public final static String GTASK_JSON_TYPE = "type";//类型 + + public final static String GTASK_JSON_TYPE_GROUP = "GROUP";//组类型 + + public final static String GTASK_JSON_TYPE_TASK = "TASK";//任务类型 + + public final static String GTASK_JSON_USER = "user";//使用者 + + public final static String MIUI_FOLDER_PREFFIX = "[MIUI_Notes]";//小米便签 + + public final static String FOLDER_DEFAULT = "Default";//默认 + + public final static String FOLDER_CALL_NOTE = "Call_Note";//呼叫标签 + + public final static String FOLDER_META = "METADATA"; + + public final static String META_HEAD_GTASK_ID = "meta_gid"; + + public final static String META_HEAD_NOTE = "meta_note"; + + public final static String META_HEAD_DATA = "meta_data"; + + public final static String META_NOTE_NAME = "[META INFO] DON'T UPDATE AND DELETE"; + +} diff --git a/other/07_210340180张旭_代码标注/tool/ResourceParser.java b/other/07_210340180张旭_代码标注/tool/ResourceParser.java new file mode 100644 index 0000000..d90f65f --- /dev/null +++ b/other/07_210340180张旭_代码标注/tool/ResourceParser.java @@ -0,0 +1,197 @@ +/* + * 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.tool; + +import android.content.Context; +import android.preference.PreferenceManager; + +import net.micode.notes.R; +import net.micode.notes.ui.NotesPreferenceActivity; +/*1. 简介：字面意义是资源分析器，实际上就是获取资源并且在程序中使用，比如颜色图片等 + 实现方法：主要利用R.java这个类，其中包括 + R.id 组件资源引用 + R.drawable 图片资源 （被使用） + R.layout 布局资源 + R.menu 菜单资源 + R.String 文字资源 + R.style 主题资源 （被使用） + 在按顺序设置好相应的id后，就可以编写简单的getXXX函数获取需要的资源 + + 特殊的变量 ： + @BG_DEFAULT_COLOR 默认背景颜色（黄） + BG_DEFAULT_FONT_SIZE 默认文本大小（中）*/ +public class ResourceParser { + //以下五个为颜色常量赋值 + public static final int YELLOW = 0; + public static final int BLUE = 1; + public static final int WHITE = 2; + public static final int GREEN = 3; + public static final int RED = 4; + //为默认背景颜色常量赋值 + public static final int BG_DEFAULT_COLOR = YELLOW; + //为文本大小常量赋值 + public static final int TEXT_SMALL = 0; + public static final int TEXT_MEDIUM = 1; + public static final int TEXT_LARGE = 2; + public static final int TEXT_SUPER = 3; + //为默认文字大小常量赋值 + public static final int BG_DEFAULT_FONT_SIZE = TEXT_MEDIUM; + //便签背景资源 + public static class NoteBgResources { + //便签编辑背景颜色数组 + private final static int [] BG_EDIT_RESOURCES = new int [] { + R.drawable.edit_yellow, + R.drawable.edit_blue, + R.drawable.edit_white, + R.drawable.edit_green, + R.drawable.edit_red + }; + //便签编辑标题颜色数组 + private final static int [] BG_EDIT_TITLE_RESOURCES = new int [] { + R.drawable.edit_title_yellow, + R.drawable.edit_title_blue, + R.drawable.edit_title_white, + R.drawable.edit_title_green, + R.drawable.edit_title_red + }; + //获取便签背景资源 + public static int getNoteBgResource(int id) { + return BG_EDIT_RESOURCES[id]; + } + //获取便签标题背景资源 + public static int getNoteTitleBgResource(int id) { + return BG_EDIT_TITLE_RESOURCES[id]; + } + } + //如果没有要求就获取默认背景id + public static int getDefaultBgId(Context context) { + if (PreferenceManager.getDefaultSharedPreferences(context).getBoolean( + NotesPreferenceActivity.PREFERENCE_SET_BG_COLOR_KEY, false)) { + return (int) (Math.random() * NoteBgResources.BG_EDIT_RESOURCES.length); + } else { + return BG_DEFAULT_COLOR; + } + } + //便签项目背景颜色设置 + public static class NoteItemBgResources { + //背景上方颜色设置 + private final static int [] BG_FIRST_RESOURCES = new int [] { + R.drawable.list_yellow_up, + R.drawable.list_blue_up, + R.drawable.list_white_up, + R.drawable.list_green_up, + R.drawable.list_red_up + }; + //背景默认颜色设置 + private final static int [] BG_NORMAL_RESOURCES = new int [] { + R.drawable.list_yellow_middle, + R.drawable.list_blue_middle, + R.drawable.list_white_middle, + R.drawable.list_green_middle, + R.drawable.list_red_middle + }; + //背景下方颜色设置 + private final static int [] BG_LAST_RESOURCES = new int [] { + R.drawable.list_yellow_down, + R.drawable.list_blue_down, + R.drawable.list_white_down, + R.drawable.list_green_down, + R.drawable.list_red_down, + }; + //背景单一颜色设置 + private final static int [] BG_SINGLE_RESOURCES = new int [] { + R.drawable.list_yellow_single, + R.drawable.list_blue_single, + R.drawable.list_white_single, + R.drawable.list_green_single, + R.drawable.list_red_single + }; + //获取背景上方颜色 + public static int getNoteBgFirstRes(int id) { + return BG_FIRST_RESOURCES[id]; + } + //获取背景下方颜色 + public static int getNoteBgLastRes(int id) { + return BG_LAST_RESOURCES[id]; + } + //获取背景单一颜色 + public static int getNoteBgSingleRes(int id) { + return BG_SINGLE_RESOURCES[id]; + } + //获取背景默认颜色 + public static int getNoteBgNormalRes(int id) { + return BG_NORMAL_RESOURCES[id]; + } + //获取文件夹背景颜色 + public static int getFolderBgRes() { + return R.drawable.list_folder; + } + } + //此类设置widget（窗口）背景颜色 + public static class WidgetBgResources { + //设置2*2窗口背景颜色 + private final static int [] BG_2X_RESOURCES = new int [] { + R.drawable.widget_2x_yellow, + R.drawable.widget_2x_blue, + R.drawable.widget_2x_white, + R.drawable.widget_2x_green, + R.drawable.widget_2x_red, + }; + //获取2*2窗口背景颜色 + public static int getWidget2xBgResource(int id) { + return BG_2X_RESOURCES[id]; + } + //设置4*4窗口背景颜色 + private final static int [] BG_4X_RESOURCES = new int [] { + R.drawable.widget_4x_yellow, + R.drawable.widget_4x_blue, + R.drawable.widget_4x_white, + R.drawable.widget_4x_green, + R.drawable.widget_4x_red + }; + //获取4*4窗口背景颜色 + public static int getWidget4xBgResource(int id) { + return BG_4X_RESOURCES[id]; + } + } + //此类设置文本显示字体大小 + public static class TextAppearanceResources { + //设置文本显示字体大小 + private final static int [] TEXTAPPEARANCE_RESOURCES = new int [] { + R.style.TextAppearanceNormal, + R.style.TextAppearanceMedium, + R.style.TextAppearanceLarge, + R.style.TextAppearanceSuper + }; + //获取文本显示文字字体大小，如果id大于显示的长度则返回默认字体大小 + public static int getTexAppearanceResource(int id) { + /** + * HACKME: Fix bug of store the resource id in shared preference. + * The id may larger than the length of resources, in this case, + * return the {@link ResourceParser#BG_DEFAULT_FONT_SIZE} + */ + if (id >= TEXTAPPEARANCE_RESOURCES.length) { + return BG_DEFAULT_FONT_SIZE; + } + return TEXTAPPEARANCE_RESOURCES[id]; + } + //获取文本显示的长度 + public static int getResourcesSize() { + return TEXTAPPEARANCE_RESOURCES.length; + } + } +} diff --git a/other/07_210340180张旭_代码标注/widget/NoteWidgetProvider.java b/other/07_210340180张旭_代码标注/widget/NoteWidgetProvider.java new file mode 100644 index 0000000..a133555 --- /dev/null +++ b/other/07_210340180张旭_代码标注/widget/NoteWidgetProvider.java @@ -0,0 +1,143 @@ +/* + * 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.widget; +import android.app.PendingIntent; +import android.appwidget.AppWidgetManager; +import android.appwidget.AppWidgetProvider; +import android.content.ContentValues; +import android.content.Context; +import android.content.Intent; +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; +import net.micode.notes.tool.ResourceParser; +import net.micode.notes.ui.NoteEditActivity; +import net.micode.notes.ui.NotesListActivity; + +public abstract class NoteWidgetProvider extends AppWidgetProvider { + //note小部件类继承app小部件类且为抽象类待继承 + public static final String [] PROJECTION = new String [] {//设置便签挂饰数据的表头 + NoteColumns.ID, + 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_SNIPPET = 2; + + private static final String TAG = "NoteWidgetProvider";//定义该类的名称 + + @Override + public void onDeleted(Context context, int[] appWidgetIds) { + //调用AppWidgetManager中的INVALID_APPWIDGET_ID将挂件ID设置为无效，以达到删除挂件的目的 + ContentValues values = new ContentValues(); + values.put(NoteColumns.WIDGET_ID, AppWidgetManager.INVALID_APPWIDGET_ID);//将新的widget信息存入数据库 + for (int i = 0; i < appWidgetIds.length; i++) { + //遍历并修改所有的URI值 + context.getContentResolver().update(Notes.CONTENT_NOTE_URI, + values, + NoteColumns.WIDGET_ID + "=?", + new String[] { String.valueOf(appWidgetIds[i])}); + } + } + + private Cursor getNoteWidgetInfo(Context context, int widgetId) { + //得到NoteWidget信息 + 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) }, + null); + } + + protected void update(Context context, AppWidgetManager appWidgetManager, int[] appWidgetIds) { + //小米便签挂件appWidgetlds信息的返回与更新 + update(context, appWidgetManager, appWidgetIds, false); + } + + private void update(Context context, AppWidgetManager appWidgetManager, int[] appWidgetIds, + boolean privacyMode) { + //更新widget的信息方法 + for (int i = 0; i < appWidgetIds.length; i++) {//对每一个appwidget遍历 + if (appWidgetIds[i] != AppWidgetManager.INVALID_APPWIDGET_ID) {//不是被删除的widget + int bgId = ResourceParser.getDefaultBgId(context); + String snippet = ""; + Intent intent = new Intent(context, NoteEditActivity.class);//创建Intent对象以用于Activity之间传递参数 + intent.setFlags(Intent.FLAG_ACTIVITY_SINGLE_TOP); + intent.putExtra(Notes.INTENT_EXTRA_WIDGET_ID, appWidgetIds[i]);//附加组件id + intent.putExtra(Notes.INTENT_EXTRA_WIDGET_TYPE, getWidgetType());//附加组件类型 + + 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(); + return; + } + 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设置一个行为 + } else { + ////若无关联内容则新建便签 + snippet = context.getResources().getString(R.string.widget_havenot_content); + intent.setAction(Intent.ACTION_INSERT_OR_EDIT);//为intent设置一个行为 + } + + if (c != null) { + c.close();//关闭游标 + } + //主要是获取对应视图 + 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 = 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);//更新widget的信息 + } + } + } + + protected abstract int getBgResourceId(int bgId);//从背景资源中获取当前应用ID + + protected abstract int getLayoutId();//获取布局ID + + protected abstract int getWidgetType();//获取widget类型 +} diff --git a/other/07_210340180张旭_代码标注/widget/NoteWidgetProvider_2x.java b/other/07_210340180张旭_代码标注/widget/NoteWidgetProvider_2x.java new file mode 100644 index 0000000..945574c --- /dev/null +++ b/other/07_210340180张旭_代码标注/widget/NoteWidgetProvider_2x.java @@ -0,0 +1,47 @@ +/* + * 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.widget; + +import android.appwidget.AppWidgetManager; +import android.content.Context; + +import net.micode.notes.R; +import net.micode.notes.data.Notes; +import net.micode.notes.tool.ResourceParser; + + +public class NoteWidgetProvider_2x extends NoteWidgetProvider { + //2*2窗口大小 + public void onUpdate(Context context, AppWidgetManager appWidgetManager, int[] appWidgetIds) { + super.update(context, appWidgetManager, appWidgetIds); + } + + //获取布局id + protected int getLayoutId() { + return R.layout.widget_2x; + } + + //获取背景资源id + protected int getBgResourceId(int bgId) { + return ResourceParser.WidgetBgResources.getWidget2xBgResource(bgId); + } + + //获取窗口类型id + protected int getWidgetType() { + return Notes.TYPE_WIDGET_2X; + } +} diff --git a/other/07_210340180张旭_代码标注/widget/NoteWidgetProvider_4x.java b/other/07_210340180张旭_代码标注/widget/NoteWidgetProvider_4x.java new file mode 100644 index 0000000..1b516b6 --- /dev/null +++ b/other/07_210340180张旭_代码标注/widget/NoteWidgetProvider_4x.java @@ -0,0 +1,46 @@ +/* + * 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.widget; + +import android.appwidget.AppWidgetManager; +import android.content.Context; + +import net.micode.notes.R; +import net.micode.notes.data.Notes; +import net.micode.notes.tool.ResourceParser; + + +public class NoteWidgetProvider_4x extends NoteWidgetProvider { + //4*4窗口大小 + public void onUpdate(Context context, AppWidgetManager appWidgetManager, int[] appWidgetIds) { + super.update(context, appWidgetManager, appWidgetIds); + } + //获取布局信息 + protected int getLayoutId() { + return R.layout.widget_4x; + } + + //获取背景资源信息 + protected int getBgResourceId(int bgId) { + return ResourceParser.WidgetBgResources.getWidget4xBgResource(bgId); + } + + //获取窗口类型信息 + protected int getWidgetType() { + return Notes.TYPE_WIDGET_4X; + } +} diff --git a/other/08_210340161孙庆斌_实践总结报告.docx b/other/08_210340161孙庆斌_实践总结报告.docx new file mode 100644 index 0000000..67d4c38 Binary files /dev/null and b/other/08_210340161孙庆斌_实践总结报告.docx differ diff --git a/other/08_210340163王宇航_实践总结报告.docx b/other/08_210340163王宇航_实践总结报告.docx new file mode 100644 index 0000000..aae3cf2 Binary files /dev/null and b/other/08_210340163王宇航_实践总结报告.docx differ diff --git a/other/08_210340164温雍敬_实践总结报告.docx b/other/08_210340164温雍敬_实践总结报告.docx new file mode 100644 index 0000000..039b093 Binary files /dev/null and b/other/08_210340164温雍敬_实践总结报告.docx differ diff --git a/other/08_210340172杨馥银_实践总结报告.docx b/other/08_210340172杨馥银_实践总结报告.docx new file mode 100644 index 0000000..38085a9 Binary files /dev/null and b/other/08_210340172杨馥银_实践总结报告.docx differ diff --git a/other/08_210340180张旭-实践总结报告.docx b/other/08_210340180张旭-实践总结报告.docx new file mode 100644 index 0000000..cf39862 Binary files /dev/null and b/other/08_210340180张旭-实践总结报告.docx differ